Weaviate's integration with Voyage AI's APIs allows you to access their models' capabilities directly from Weaviate. [Configure a Weaviate collection](#configure-the-reranker) to use a Voyage AI reranker model, and Weaviate will use the specified model and your Voyage 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. ![Reranker integration illustration](/assets/docs/weaviate/model-providers/_includes/integration_voyageai_reranker.png) ## Requirements ### Weaviate configuration Your Weaviate instance must be configured with the Voyage AI reranker integration (`reranker-voyageai`) module. :::accordion{title="For Weaviate Cloud (WCD) users"} This integration is enabled by default on Weaviate Cloud (WCD) instances. ::: :::accordion{title="For self-hosted users"} - Check the [cluster metadata](../monitoring-and-logging/status.md#cluster-metadata) to verify if the module is enabled. - Follow the [how-to configure modules](../how-to-configure-weaviate/modules.md) guide to enable the module in Weaviate. ::: ### API credentials You must provide a valid Voyage AI API key to Weaviate for this integration. Go to [Voyage AI](https://www.voyageai.com/) to sign up and obtain an API key. Provide the API key to Weaviate using one of the following methods: - Set the `VOYAGEAI_APIKEY` environment variable that is available to Weaviate. - Provide the API key at runtime, as shown in the examples below. :::code-group{sync="languages"} ```python title="Python" # Recommended: save sensitive data as environment variables voyageai_key = os.getenv("VOYAGEAI_API_KEY") ``` ```typescript title="JavaScript/TypeScript" const voyageaiApiKey = process.env.VOYAGEAI_API_KEY || ''; // Replace with your inference API key ``` ::: ## Configure the reranker :::callout{intent="info" title="Reranker 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](../how-to-manage-collections/generative-reranker-models.md#update-the-reranker-model-integration) for details on how to update the collection configuration. ::: Configure a Weaviate collection to use a Voyage AI reranker model as follows: :::code-group{sync="languages"} ```python title="Python" {3-6} client.collections.create( "DemoCollection", reranker_config=Configure.Reranker.voyageai( # # This parameter is optional # model="rerank-lite-1" ) # Additional parameters not shown ) ``` ```typescript title="JavaScript/TypeScript" {3-5} await client.collections.create({ name: 'DemoCollection', reranker: weaviate.configure.reranker.voyageAI({ model: 'rerank-lite-1', }), }); ``` ::: You can specify one of the [available models](#available-models) for the reranker to use. The [default model](#available-models) is used if no model is specified. ## Header parameters You can provide the API key as well as some optional parameters at runtime through additional headers in the request. The following headers are available: - `X-VoyageAI-Api-Key`: The Voyage AI API key. - `X-VoyageAI-Baseurl`: The base URL to use (e.g. a proxy) instead of the default Voyage AI URL. Any additional headers provided at runtime will override the existing Weaviate configuration. Provide the headers as shown in the [API credentials examples](#api-credentials) above. ## Reranking query Once the reranker is configured, Weaviate performs [reranking operations](../how-to-query-search/rerank.md) using the specified Voyage 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. ![Reranker integration illustration](/assets/docs/weaviate/model-providers/_includes/integration_voyageai_reranker.png) :::code-group{sync="languages"} ```python title="Python" {5-12} from weaviate.classes.query import Rerank collection = client.collections.use("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"]) ``` ```typescript title="JavaScript/TypeScript" {5-11} let myCollection = client.collections.use('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']); } ``` ::: ## References ### Available models - rerank-2.5 - rerank-2.5-lite - rerank-2 - rerank-2-lite - rerank-1 - rerank-lite-1 (default) :::accordion{title="Model support history"} * Added `rerank-2.5`, `rerank-2.5-lite` * `v1.24.25`, `v1.25.18`, `v1.26.5`: - Added `rerank-2`, `rerank-2-lite` * `v1.24.18`, `v1.25.3`: - Added `rerank-1` * `1.24.7`: - Introduced `reranker-voyageai`, with `rerank-lite-1` support ::: ## Further resources ### Other integrations - [Voyage AI embedding models + Weaviate](voyageai-embeddings.md). - [Voyage AI multimodal embedding models + Weaviate](voyageai-embeddings-multimodal.md). ### 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 collections](../how-to-manage-collections/index.md) and [How-to: Manage objects](../how-to-manage-objects/index.md) guides show how to perform data operations (i.e. create, read, update, delete collections and objects within them). - The [How-to: Query & Search](../how-to-query-search/index.md) guides show how to perform search operations (i.e. vector, keyword, hybrid) as well as retrieval augmented generation. ### References - Voyage AI [Reranker API documentation](https://docs.voyageai.com/docs/reranker) ## Questions and feedback Have a question or feedback? Here's how to reach us. ::::card-grid :::card{title="Community Forum" href="https://forum.weaviate.io/c/support" icon="messages-square"} Ask questions and connect with other developers on our **Community forum**. ::: :::card{title="Support" href="/guides/support-overview" icon="life-buoy"} Weaviate Cloud user or customer? Find the right channel on the **Support page**. ::: :::: ## Related pages - [Agents](./agents-index.md) - [AI-assisted Weaviate code generation](./ai-assisted-vibe-coding-index.md) - [APIs](./apis-index.md) - [Authorization and authentication](./authorization-and-authentication-index.md) - [Benchmarks](./benchmarks-index.md) - [Best practices](./best-practices-index.md) - [Client libraries](./clients-index.md) - [Client Libraries / SDKs](./client-libraries-index.md) - [Cloud](./cloud-index.md) - [Cloud account management](./cloud-account-management-index.md) # Agent Instructions This portal answers questions programmatically. To receive a synthesized, source-cited answer instead of crawling page by page, append the `?ask=` query parameter to any page URL on this site: /guides/quickstart?ask=how+do+I+authenticate Optional parameters: - `&goal=` steers the answer toward your objective (e.g. `&goal=write+a+python+client`). - `&version=