Skip to main content

Authorization

Follow this guide to create a new Jina AI Reranker credential that will allow Nexla to authenticate to and exchange data with your Jina AI account.
jina_ai_reranker_api_auth.png

Jina AI Reranker

Prerequisites​

Before creating a Jina AI Reranker credential, you'll need to obtain an API key from your Jina AI account. Jina AI provides API keys for programmatic access to their Reranker service through the API dashboard.

To obtain a Jina AI API key:

  1. Log in to your Jina AI account at https://jina.ai or create an account if you don't have one.

  2. Navigate to the API dashboard at https://jina.ai/api-dashboard/ or access it from your Jina AI account settings.

  3. In the API dashboard, locate the section for API key management. This is typically found in your account settings or a dedicated API/Developer section.

  4. Click Create API Key or Generate New Key to create a new API key for your application.

  5. Copy the API key immediately after generation, as it may only be displayed once for security purposes. Store it securely, as you'll need it to authenticate API requests.

For detailed information about Jina AI API authentication and API key management, refer to the Jina AI Reranker Documentation and Jina AI API Dashboard.

Create a Jina AI Reranker Credential​

  • To create a new Jina AI Reranker credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Jina AI Reranker

JinaAIRerankerCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Credential Settings​

  1. In the Jina AI API Key field, enter the API key that you obtained from your Jina AI API dashboard. This is the secret API key used to authenticate requests to the Jina AI Reranker API.

  2. In the Base URL field, enter the base URL for the Jina AI Reranker API. The default value is https://api.jina.ai, which is the standard base URL for Jina AI API services. You can specify a different base URL if your organization uses a custom endpoint.

  3. In the API Version field, enter the API version you want to use. The default value is v1, which is the current version of the Jina AI Reranker API. You can specify a different version if your organization uses a specific API version.

  4. In the Embeddings payload to test a connection field, enter a sample JSON payload to test the connection. A default payload is provided:

    {
      "model": "jina-reranker-v2-base-multilingual",
      "query": "Organic skincare products for sensitive skin",
      "top_n": 3,
      "documents": [
          "Organic skincare for sensitive skin with aloe vera and chamomile",
          "New makeup trends focus on bold colors and innovative techniques"
      ],
      "return_documents": false
    }

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.