Generative AI

Weaviate's integrations with xAI's API allows you to access their models' capabilities directly from Weaviate.

Configure a Weaviate collection to use a generative AI model with xAI. Weaviate will perform Retrieval Augmented Generation (RAG) using the specified model using your xAI API Key.

More specifically, Weaviate will perform a search, retrieve the most relevant objects, and then pass them to the generative model on xAI to generate outputs.

Your Weaviate instance must be configured with the xAI generative (generative-xai) module.

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

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

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

# Recommended: save sensitive data as environment variables
xai_key = os.getenv("XAI_API_KEY")

const xaiApiKey = process.env.XAI_API_KEY || '';  // Replace with your inference API key

Configure a Weaviate index as follows to use an xAI generative AI model:

from weaviate.classes.config import Configureclient.collections.create(    "DemoCollection",    generative_config=Configure.Generative.xai()    # Additional parameters not shown)

await client.collections.create({  name: 'DemoCollection',  generative: weaviate.configure.generative.xai(),  // Additional parameters not shown});

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

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.xai(
        model="grok-2-latest"
    )
    # Additional parameters not shown
)

await client.collections.create({  name: 'DemoCollection',  generative: weaviate.configure.generative.xai({    model: 'grok-2-latest'  }),  // Additional parameters not shown});

You can specify one of the available models for Weaviate to use. The default model is used if no model is specified.

Configure the following generative parameters to customize the model behavior.

from weaviate.classes.config import Configureclient.collections.create(    "DemoCollection",    generative_config=Configure.Generative.xai(        # # These parameters are optional        # base_url="https://api.x.ai/v1"        # model="grok-2-latest",        # max_tokens=500,        # temperature=0.7,    )    # Additional parameters not shown)

await client.collections.create({  name: 'DemoCollection',  generative: weaviate.configure.generative.xai({    // // These parameters are optional    // baseURL: 'https://api.x.ai/v1',    // model: 'grok-2-latest',    // maxTokens: 512,    // temperature: 0.7,  }),  // Additional parameters not shown});

For further details on model parameters, see the xAI API documentation.

Aside from setting the default model provider when creating the collection, you can also override it at query time.

from weaviate.classes.config import Configurefrom weaviate.classes.generate import GenerativeConfigcollection = client.collections.use("DemoCollection")response = collection.generate.near_text(    query="A holiday film",    limit=2,    grouped_task="Write a tweet promoting these two movies",    generative_provider=GenerativeConfig.xai(        # # These parameters are optional        # base_url="https://api.x.ai/v1"        # model="grok-2-latest",        # max_tokens=500,        # temperature=0.7,    ),    # Additional parameters not shown)

import { generativeParameters } from 'weaviate-client';

After configuring the generative AI integration, perform RAG operations, either with the single prompt or grouped task method.

To generate text for each object in the search results, use the single prompt method.

The example below generates outputs for each of the n search results, where n is specified by the limit parameter.

When creating a single prompt query, use braces {} to interpolate the object properties you want Weaviate to pass on to the language model. For example, to pass on the object's title property, include {title} in the query.

collection = client.collections.use("DemoCollection")response = collection.generate.near_text(    query="A holiday film",  # The model provider integration will automatically vectorize the query    single_prompt="Translate this into French: {title}",    limit=2)for obj in response.objects:    print(obj.properties["title"])    print(f"Generated output: {obj.generated}")  # Note that the generated output is per object

let response;
const myCollection = client.collections.use("DemoCollection");

To generate one text for the entire set of search results, use the grouped task method.

In other words, when you have n search results, the generative model generates one output for the entire group.

collection = client.collections.use("DemoCollection")response = collection.generate.near_text(    query="A holiday film",  # The model provider integration will automatically vectorize the query    grouped_task="Write a fun tweet to promote readers to check out these films.",    limit=2)print(f"Generated output: {response.generative.text}")  # Note that the generated output is per queryfor obj in response.objects:    print(obj.properties["title"])

let response;
const myCollection = client.collections.use("DemoCollection");

You can use any generative model on xAI's API with Weaviate.

The default model is grok-2-latest.

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 and How-to: Manage objects guides show how to perform data operations (i.e. create, read, update, delete collections and objects within them).
• The How-to: Query & Search guides show how to perform search operations (i.e. vector, keyword, hybrid) as well as retrieval augmented generation.

• xAI API Documentation

Have a question or feedback? Here's how to reach us.