Jina AI Reranker Models with Weaviate

Added in v1.26.1

Weaviate's integration with Jina AI's APIs allows you to access their models' capabilities directly from Weaviate.

Configure a Weaviate collection to use a Jina AI reranker model, and Weaviate will use the specified model and your Jina AI API key to rerank search results.

This two-step process involves Weaviate first performing a search and then reranking the results using the specified model.

Requirements

Weaviate configuration

Your Weaviate instance must be configured with the JinaAI reranker integration (reranker-jinaai) module.

For Weaviate Cloud (WCD) users

This integration is enabled by default on Weaviate Cloud (WCD) serverless instances.

For self-hosted users

• Check the cluster metadata to verify if the module is enabled.
• Follow the how-to configure modules guide to enable the module in Weaviate.

API credentials

You must provide a valid JinaAI API key to Weaviate for this integration. Go to Jina AI to sign up and obtain an API key.

Provide the API key to Weaviate using one of the following methods:

• Set the JINAAI_APIKEY environment variable that is available to Weaviate.
• Provide the API key at runtime, as shown in the examples below.

Python API v4

import weaviate
from weaviate.classes.init import Auth
import os

# Recommended: save sensitive data as environment variables
jinaai_key = os.getenv("JINAAI_APIKEY")
headers = {
    "X-JinaAI-Api-Key": jinaai_key,
}

client = weaviate.connect_to_weaviate_cloud(
    cluster_url=weaviate_url,                       # `weaviate_url`: your Weaviate URL
    auth_credentials=Auth.api_key(weaviate_key),      # `weaviate_key`: your Weaviate API key
    headers=headers
)

# Work with Weaviate

client.close()

  API docs

JS/TS API v3

import weaviate from 'weaviate-client'

const jinaaiApiKey = process.env.JINAAI_APIKEY || '';  // Replace with your inference API key

const client = await weaviate.connectToWeaviateCloud(
  'WEAVIATE_INSTANCE_URL',  // Replace with your instance URL
  {
    authCredentials: new weaviate.ApiKey('WEAVIATE_INSTANCE_APIKEY'),
    headers: {
      'X-JinaAI-Api-Key': jinaaiApiKey,
    }
  }
)

// Work with Weaviate

client.close()

  API docs

Configure the reranker

Generative model integration mutable from v1.25.23, v1.26.8 and v1.27.1

A collection's reranker model integration configuration is mutable from v1.25.23, v1.26.8 and v1.27.1. See this section for details on how to update the collection configuration.

Configure a Weaviate collection to use a Jina AI reranker model as follows:

Python API v4

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    reranker_config=Configure.Reranker.jinaai()
    # Additional parameters not shown
)

  API docs

JS/TS API v3

await client.collections.create({
  name: 'DemoCollection',
  reranker: weaviate.configure.reranker.jinaai(),
});

  API docs

Select a model

You can specify one of the available models for Weaviate to use, as shown in the following configuration example:

Python API v4

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    reranker_config=Configure.Reranker.jinaai(
        model="jina-reranker-v2-base-multilingual"
    )
    # Additional parameters not shown
)

  API docs

JS/TS API v3

await client.collections.create({
  name: 'DemoCollection',
  reranker: weaviate.configure.reranker.jinaai({
    model: 'jina-reranker-v2-base-multilingual',
  }),
});

  API docs

The default model is used if no model is specified.

Reranking query

Once the reranker is configured, Weaviate performs reranking operations using the specified Jina AI model.

More specifically, Weaviate performs an initial search, then reranks the results using the specified model.

Any search in Weaviate can be combined with a reranker to perform reranking operations.

Python API v4

from weaviate.classes.query import Rerank

collection = client.collections.get("DemoCollection")

response = collection.query.near_text(
    query="A holiday film",  # The model provider integration will automatically vectorize the query
    limit=2,
    rerank=Rerank(
        prop="title",                   # The property to rerank on
        query="A melodic holiday film"  # If not provided, the original query will be used
    )
)

for obj in response.objects:
    print(obj.properties["title"])

  API docs

JS/TS API v3

let myCollection = client.collections.get('DemoCollection');

const results = await myCollection.query.nearText(
  ['A holiday film'],
  {
    limit: 2,
    rerank: {
      property: 'title',                // The property to rerank on
      query: 'A melodic holiday film'   // If not provided, the original query will be used
    }
  }
);

for (const obj of results.objects) {
  console.log(obj.properties['title']);
}

  API docs

References

Available models

• jina-reranker-v2-base-multilingual (default)
• jina-reranker-v1-base-en
• jina-reranker-v1-turbo-en
• jina-reranker-v1-tiny-en
• jina-colbert-v1-en

Further resources

Other integrations

• Jina AI text embedding models + Weaviate
• Jina AI multimodal embedding models + Weaviate

Code examples

Once the integrations are configured at the collection, the data management and search operations in Weaviate work identically to any other collection. See the following model-agnostic examples:

• The how-to: manage data guides show how to perform data operations (i.e. create, update, delete).
• The how-to: search guides show how to perform search operations (i.e. vector, keyword, hybrid) as well as retrieval augmented generation.

References

• Jina AI Reranker documentation

Questions and feedback

If you have any questions or feedback, let us know in the user forum.

• Technical questions
• Documentation feedback