text-embedding

Enhance Text Processing with E5 Mistral 7b Instruct Actions

26 Apr 2025
Enhance Text Processing with E5 Mistral 7b Instruct Actions

The E5 Mistral 7B Instruct model provides powerful cognitive actions for developers looking to enhance their text processing capabilities. This service allows you to generate multilingual text embeddings and relevancy scores, making it an ideal solution for a variety of applications. By leveraging advanced language embedding technology, you can significantly improve the efficiency and accuracy of text-related tasks. Whether you're working on search engines, recommendation systems, or natural language processing applications, these cognitive actions simplify the integration process and boost performance.

Prerequisites

To utilize the E5 Mistral 7B Instruct actions, you will need an API key for the Cognitive Actions service and a basic understanding of how to make API calls.

Generate Text Embeddings

The "Generate Text Embeddings" action utilizes the E5-Mistral-7B-Instruct language embedding model to produce multilingual text embeddings and relevancy scores based on specified queries and documents. This action is particularly beneficial for English text processing, as it outputs embeddings and similarity scores that enhance text processing tasks.

Input Requirements

To make use of this action, you must provide the following input parameters:

  • task: A brief description of the task to be performed, e.g., "Given a web search query, retrieve relevant passages that answer the query."
  • query: The search query for which relevant passages are to be retrieved, e.g., "What is the recommended sugar intake for women?"
  • document: The document from which relevant passages will be identified based on the query, e.g., "As a general guideline, the CDC’s average recommended sugar intake for women ages 19 to 70 is 20 grams per day."
  • outputNormalizedEmbeddings: A boolean flag indicating whether the output embeddings should be normalized (default is false).

Expected Output

The expected output will include:

  • score: A relevancy score indicating how closely the document matches the query.
  • embeddings: A numerical array representing the text embeddings corresponding to the input document.

Use Cases for this Specific Action

This action is particularly useful in scenarios such as:

  • Search Engines: Enhance search results by retrieving the most relevant passages in response to user queries.
  • Content Recommendation: Improve content delivery in applications by providing users with suggestions based on their inquiries.
  • Text Analysis: Facilitate deeper insights in natural language processing tasks by generating embeddings that can be fed into machine learning models.

By integrating this action into your applications, you can significantly improve the relevance of results and enhance user experience.

import requests
import json

# Replace with your actual Cognitive Actions API key and endpoint
# Ensure your environment securely handles the API key
COGNITIVE_ACTIONS_API_KEY = "YOUR_COGNITIVE_ACTIONS_API_KEY"
# This endpoint URL is hypothetical and should be documented for users
COGNITIVE_ACTIONS_EXECUTE_URL = "https://api.cognitiveactions.com/actions/execute"

action_id = "ddd4cd15-74ad-4505-b968-40074dcf7bfa" # Action ID for: Generate Text Embeddings

# Construct the exact input payload based on the action's requirements
# This example uses the predefined example_input for this action:
payload = {
  "task": "Given a web search query, retrieve relevant passages that answer the query",
  "query": "What is the recommended sugar intake for women",
  "document": "As a general guideline, the CDC’s average recommended sugar intake for women ages 19 to 70 is 20 grams per day.",
  "outputNormalizedEmbeddings": false
}

headers = {
    "Authorization": f"Bearer {COGNITIVE_ACTIONS_API_KEY}",
    "Content-Type": "application/json",
    # Add any other required headers for the Cognitive Actions API
}

# Prepare the request body for the hypothetical execution endpoint
request_body = {
    "action_id": action_id,
    "inputs": payload
}

print(f"--- Calling Cognitive Action: {action.name or action_id} ---")
print(f"Endpoint: {COGNITIVE_ACTIONS_EXECUTE_URL}")
print(f"Action ID: {action_id}")
print("Payload being sent:")
print(json.dumps(request_body, indent=2))
print("------------------------------------------------")

try:
    response = requests.post(
        COGNITIVE_ACTIONS_EXECUTE_URL,
        headers=headers,
        json=request_body
    )
    response.raise_for_status() # Raise an exception for bad status codes (4xx or 5xx)

    result = response.json()
    print("Action executed successfully. Result:")
    print(json.dumps(result, indent=2))

except requests.exceptions.RequestException as e:
    print(f"Error executing action {action_id}: {e}")
    if e.response is not None:
        print(f"Response status: {e.response.status_code}")
        try:
            print(f"Response body: {e.response.json()}")
        except json.JSONDecodeError:
            print(f"Response body (non-JSON): {e.response.text}")
    print("------------------------------------------------")

Conclusion

The E5 Mistral 7B Instruct model offers robust capabilities to improve text processing tasks through its cognitive actions. By generating accurate text embeddings and relevancy scores, developers can optimize applications for search, recommendation, and analysis. This not only enhances performance but also provides users with a more engaging and responsive experience. Start integrating these actions into your projects today to fully leverage the power of advanced language processing!

← Back to All Articles