text-embedding

Enhance Your Applications with Document Embeddings from MPNet

26 Apr 2025
Enhance Your Applications with Document Embeddings from MPNet

In today's fast-paced digital landscape, the ability to understand and analyze text data is crucial for developers. The "All Mpnet Base V2" service provides powerful Cognitive Actions designed to generate high-quality document embeddings that can significantly enhance your applications. By leveraging the sentence-transformer model based on MPNet, developers can efficiently obtain embeddings that are ideal for semantic search, clustering, and various natural language processing tasks.

The key benefits of using this service include improved speed and accuracy in text analysis, allowing for more intelligent data retrieval and organization. Common use cases range from enhancing search functionalities in applications to clustering documents for better categorization. Whether you're building a recommendation system, a chat application, or simply looking to improve your text analytics capabilities, integrating document embeddings will provide a substantial boost.

Prerequisites

To get started, you will need an API key for the Cognitive Actions service and a basic understanding of making API calls.

Generate Document Embeddings with Sentence-Transformer

The "Generate Document Embeddings with Sentence-Transformer" action allows you to create high-quality embeddings for text. This is particularly useful for applications that require an understanding of semantic meaning in order to improve search relevance or categorize content more accurately.

Purpose: This action addresses the need for efficient text representation by converting text into embeddings, which can be utilized in various machine learning tasks such as semantic search and clustering.

Input Requirements:

  • You can provide input in two forms:
    • Text: A single string that needs to be encoded. For example, "You shall know a word by the company it keeps."
    • Text Batch: A JSON-formatted array containing multiple strings for batch processing.

Expected Output: The action returns an array of embeddings, each represented as a list of numerical values. These embeddings capture the semantic meaning of the input text, enabling advanced analysis and processing.

Use Cases for this specific action:

  • Semantic Search: Improve the relevance of search results by using document embeddings to match queries with similar content.
  • Clustering: Group similar documents together based on their embeddings, facilitating better organization and retrieval of information.
  • Recommendation Systems: Utilize embeddings to suggest related documents or content to users based on their previous interactions.

```python
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 = "466f8ba1-3137-484c-af72-7cd3d6d41d25" # Action ID for: Generate Document Embeddings with Sentence-Transformer

# Construct the exact input payload based on the action's requirements
# This example uses the predefined example_input for this action:
payload = {
  "text": "You shall know a word by the company it keeps."
}

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
Integrating document embeddings from the MPNet model can greatly enhance your application's ability to process and analyze text data. By utilizing the "Generate Document Embeddings with Sentence-Transformer" action, developers can unlock new functionalities such as improved search relevance, effective clustering, and personalized recommendations. 

To take the next step, consider exploring how these embeddings can be applied to your specific use cases, and start enhancing your applications with the power of semantic understanding.
← Back to All Articles