---
title: "KubeAI Generative AI with Weaviate"
description: "Set up generative models with KubeAI in Weaviate for creative data outputs."
url: https://docs.weaviate.io/weaviate/model-providers/kubeai/generative
---

# KubeAI Generative AI with Weaviate

Weaviate's integration with OpenAI-style APIs allows you to access KubeAI models' directly from Weaviate.

[Configure a Weaviate collection](https://docs.weaviate.io/weaviate/model-providers/kubeai/generative#configure-collection) to use a generative AI model with KubeAI. Weaviate will perform retrieval augmented generation (RAG) using the specified model.

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

![RAG integration illustration](https://docs.weaviate.io/assets/images/integration_kubeai_rag-2455f03d2cffb2558c4424794e5a47e3.png)

## Requirements

### KubeAI configuration

KubeAI must be deployed in a Kubernetes cluster with an embedding model. For more specific instructions, see this [KubeAI deployment guide](https://www.kubeai.org/tutorials/weaviate/#kubeai-configuration).

### Weaviate configuration

Your Weaviate instance must be configured with the OpenAI generative AI integration (`generative-openai`) module.

**For Weaviate Cloud (WCD) users**

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

**For self-hosted users**

- Check the [cluster metadata](https://docs.weaviate.io/deploy/configuration/status#cluster-metadata) to verify if the module is enabled.
- Follow the [how-to configure modules](https://docs.weaviate.io/weaviate/configuration/modules) guide to enable the module in Weaviate.

### API credentials

The OpenAI integration requires an API key value. To use KubeAI, provide any value for the API key, as this value is not used by KubeAI.

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

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

**Python**

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

# Recommended: save sensitive data as environment variables
openai_key = os.getenv("OPENAI_API_KEY")
headers = {
    "X-OpenAI-Api-Key": openai_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()
```

**JavaScript/TypeScript**

```ts
import weaviate from '@weaviate/node'

const openaiApiKey = process.env.OPENAI_API_KEY || '';  // 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_API_KEY'),
    headers: {
      'X-OpenAI-Api-Key': openaiApiKey,
    }
  }
)

// Work with Weaviate

client.close()
```

## Configure collection

Configure Weaviate to use a KubeAI generative AI model:

**Python**

```py
from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.openai(
        # Setting the model and base_url is required
        model="gpt-3.5-turbo",
        base_url="http://kubeai/openai", # Your private KubeAI API endpoint
        # These parameters are optional
        # frequency_penalty=0,
        # max_tokens=500,
        # presence_penalty=0,
        # temperature=0.7,
        # top_p=0.7,
    )
    # Additional parameters not shown
)
```

**JavaScript/TypeScript**

```ts
await client.collections.create({
  name: 'DemoCollection',
  generative: weaviate.configure.generative.openAI({
    // Setting the model and base_url is required
    model: 'gpt-3.5-turbo',
    baseURL: 'http://kubeai/openai',
    // These parameters are optional
    // frequencyPenalty: 0,
    // maxTokens: 500,
    // presencePenalty: 0,
    // temperature: 0.7,
    // topP: 0.7,
  }),
  // Additional parameters not shown
});
```

Any model that is supported by vLLM or Ollama can be used with KubeAI.

Refer to the [KubeAI docs on model management](https://www.kubeai.org/how-to/install-models/) for more information on available models and how to configure them.

## Select a model at runtime

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

**Python**

```py
from weaviate.classes.config import Configure
from weaviate.classes.generate import GenerativeConfig

collection = 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.openai(
        # Setting the model and base_url is required
        model="gpt-3.5-turbo",
        base_url="http://kubeai/openai", # Your private KubeAI API endpoint
        # These parameters are optional
        # frequency_penalty=0,
        # max_tokens=500,
        # presence_penalty=0,
        # temperature=0.7,
        # top_p=0.7,
    ),
    # Additional parameters not shown
)
```

**JavaScript/TypeScript**

```ts
import { generativeParameters } from '@weaviate/node';

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

response = await myCollection.generate.nearText("A holiday film", {
  groupedTask: "Write a tweet promoting these two movies",
  config: generativeParameters.openAI({
    // Setting the model and baseURL is required
    model: 'gpt-3.5-turbo',
    baseURL: 'http://kubeai/openai',
    // These parameters are optional
    // frequencyPenalty: 0,
    // maxTokens: 500,
    // presencePenalty: 0,
    // temperature: 0.7,
    // topP: 0.7,
  }),
}, {
  limit: 2,
}
  // Additional parameters not shown
)
```

## Retrieval augmented generation

After configuring the generative AI integration, perform RAG operations, either with the [single prompt](https://docs.weaviate.io/weaviate/model-providers/kubeai/generative#single-prompt) or [grouped task](https://docs.weaviate.io/weaviate/model-providers/kubeai/generative#grouped-task) method.

### Single prompt

![Single prompt RAG integration generates individual outputs per search result](https://docs.weaviate.io/assets/images/integration_kubeai_rag_single-91d0e3bf12c17977dd6b82c216c7ef89.png)

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.

**Python**

```py
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
```

**JavaScript/TypeScript**

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

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

const singlePromptResults = await myCollection.generate.nearText('A holiday film', {
  singlePrompt: `Translate this into French: {title}`,
}, {
  limit: 2,
});

for (const obj of singlePromptResults.objects) {
  console.log(obj.properties['title']);
  console.log(`Generated output: ${obj.generative?.text}`);  // Note that the generated output is per object
}
```

### Grouped task

![Grouped task RAG integration generates one output for the set of search results](https://docs.weaviate.io/assets/images/integration_kubeai_rag_grouped-2be8f40d94b7aada57eb9493a307acb7.png)

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.

**Python**

```py
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 query
for obj in response.objects:
    print(obj.properties["title"])
```

**JavaScript/TypeScript**

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

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

const groupedTaskResults = await myCollection.generate.nearText('A holiday film', {
  groupedTask: `Write a fun tweet to promote readers to check out these films.`,
}, {
  limit: 2,
});

console.log(`Generated output: ${groupedTaskResults.generative?.text}`);  // Note that the generated output is per query
for (const obj of groupedTaskResults.objects) {
  console.log(obj.properties['title']);
}
```

## Further resources

### Other integrations

- [KubeAI embedding models + Weaviate](https://docs.weaviate.io/weaviate/model-providers/kubeai/embeddings).

### 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](https://docs.weaviate.io/weaviate/manage-collections) and [How-to: Manage objects](https://docs.weaviate.io/weaviate/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](https://docs.weaviate.io/weaviate/search) guides show how to perform search operations (i.e. vector, keyword, hybrid) as well as retrieval augmented generation.

### External resources

- [KubeAI documentation](https://www.kubeai.org/)
- [KubeAI documentation on model management](https://www.kubeai.org/how-to/install-models/)
