Skip to main content

Azure OpenAI Generative AI with Weaviate

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

Configure a Weaviate collection to use an Azure OpenAI generative AI model, and Weaviate will perform retrieval augmented generation (RAG) using the specified model and your Azure OpenAI API key.

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

RAG integration illustration

Requirements​

Weaviate configuration​

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

For Weaviate Cloud (WCD) users

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

For self-hosted users

API credentials​

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

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

  • Set the AZURE_APIKEY environment variable that is available to Weaviate.
  • Provide the API key at runtime, as shown in the examples below.
import weaviate
from weaviate.classes.init import Auth
import os

# Recommended: save sensitive data as environment variables
azure_key = os.getenv("AZURE_APIKEY")
headers = {
    "X-Azure-Api-Key": azure_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()
py docs  API docs

Configure collection​

Generative model integration mutability

A collection's generative 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 index as follows to use an OpenAI Azure generative model.

To select the model, specify the Azure resource name.

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.azure_openai(
        resource_name="<azure-resource-name>",
        deployment_id="<azure-deployment-id>",
    )
    # Additional parameters not shown
)
py docs  API docs

Generative parameters​

Configure the following generative parameters to customize the model behavior.

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.azure_openai(
        resource_name="<azure-resource-name>",
        deployment_id="<azure-deployment-id>",
        # # These parameters are optional
        # frequency_penalty=0,
        # max_tokens=500,
        # presence_penalty=0,
        # temperature=0.7,
        # top_p=0.7,
        # base_url="<custom-azure-url>"
    )
    # Additional parameters not shown
)
py docs  API docs

For further details on these parameters, see consult the Azure OpenAI API documentation.

Retrieval augmented generation​

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

Single prompt​

Single prompt RAG integration generates individual outputs per search result

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.get("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
py docs  API docs

Grouped task​

Grouped task RAG integration generates one output for the set of search results

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.get("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.generated}")  # Note that the generated output is per query
for obj in response.objects:
    print(obj.properties["title"])
py docs  API docs

References​

Available models​

See the Azure OpenAI documentation for a list of available models and their regional availability.

Further resources​

Other integrations​

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​

Questions and feedback​

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