text-embedding

Enhance Text Understanding with Jina Embeddings

26 Apr 2025
Enhance Text Understanding with Jina Embeddings

Jina Embeddings offers a powerful solution for developers looking to generate high-quality embeddings for text content. By leveraging advanced models trained on the Linnaeus-Clean dataset, Jina allows for optimized semantic similarity and search tasks, enhancing the capabilities of applications that require deep text comprehension. Integrating Jina Embeddings into your projects can significantly simplify the process of deriving meaningful insights from text, making it easier to analyze, categorize, or search through large datasets.

Prerequisites

To get started, you'll need a Jina Embeddings API key and a basic understanding of how to make API calls.

Embed Text Using Jina AI Linnaeus-Clean Model

The "Embed Text Using Jina AI Linnaeus-Clean Model" action is designed to generate embeddings for text content. This action solves the challenge of converting textual information into a numerical format that can be effectively processed and analyzed by machine learning models. By creating embeddings, developers can facilitate more accurate search functionalities and improve semantic understanding in their applications.

Input Requirements

The input for this action consists of a structured JSON object that includes the following fields:

  • text: The text content to be embedded (e.g., "hello world").
  • model: Specifies which embedding model to use, with options including "jina-embedding-t-en-v1", "jina-embedding-s-en-v1", "jina-embedding-b-en-v1", and "jina-embedding-l-en-v1". The default is "jina-embedding-l-en-v1".
  • jsonText: Optional field for embedding multiple text contents provided in JSON format.
  • outputFormat: Defines the output format of the embedding, with options for "base64" or "array". The default is "base64".

For example, a typical input might look like this:

{
  "text": "hello world",
  "model": "jina-embedding-l-en-v1",
  "jsonText": "",
  "outputFormat": "array"
}

Expected Output

The output will be a numerical array representing the embedding of the input text. For instance, the output for the given example input could look like this:

[
  [2.6995209623237315e-8, -0.1819203943014145, -0.2370840460062027, ...]
]

Use Cases for this Action

  1. Search Optimization: By embedding text, developers can enhance search functionalities, allowing for more accurate and contextually aware search results within applications.
  2. Semantic Analysis: The embeddings can be used for various natural language processing tasks such as sentiment analysis, topic classification, or content recommendation systems.
  3. Data Clustering: Developers can cluster similar text data points based on their embeddings, facilitating better data organization and retrieval strategies.

```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 = "663f89a8-a804-4f3f-8fa7-cd84c7e3b2c4" # Action ID for: Embed Text Using Jina AI Linnaeus-Clean Model

# Construct the exact input payload based on the action's requirements
# This example uses the predefined example_input for this action:
payload = {
  "text": "hello world",
  "model": "jina-embedding-l-en-v1",
  "jsonText": "",
  "outputFormat": "array"
}

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
By integrating Jina Embeddings into your applications, you can leverage advanced text representation capabilities that enhance search accuracy and semantic understanding. The ease of use and flexibility in model selection make it a valuable tool for developers looking to improve their text processing tasks. Consider exploring additional use cases or combining this action with other functionalities for an even richer user experience.
← Back to All Articles