Skip to main content

FriendliAI Generative AI with Weaviate

Added in v1.26.3

Weaviate's integrations with FriendliAI APIs allow you to access their models' capabilities directly from Weaviate.

Configure a Weaviate collection to use generative AI models on FriendliAI. Weaviate will perform Retrieval Augmented Generation (RAG) using the specified model and your Friendli token.

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

RAG integration illustration

Requirements

Weaviate configuration

Your Weaviate instance must be configured with the FriendliAI generative AI integration (generative-friendliai) 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 Friendli Suite Token to Weaviate for this integration. Go to Friendli Suite to sign up and obtain a personal access token.

Provide the Friendli token to Weaviate using one of the following methods:

Set the FRIENDLI_TOKEN environment variable that is available to Weaviate.
Provide the token at runtime, as shown in the examples below.

Python API v4
JS/TS API v3

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

# Recommended: save sensitive data as environment variables
friendli_key = os.getenv("FRIENDLI_TOKEN")
headers = {
    "X-Friendli-Api-Key": friendli_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()

import weaviate from 'weaviate-client'

const friendliApiKey = process.env.FRIENDLI_TOKEN || '';  // 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-Friendli-Api-Key': friendliApiKey,
    }
  }
)

// Work with Weaviate

client.close()

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 a FriendliAI generative AI model:

Python API v4
JS/TS API v3

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.friendliai()
    # Additional parameters not shown
)

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

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
JS/TS API v3

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.friendliai(
        model="meta-llama-3.1-70b-instruct",
    )
    # Additional parameters not shown
)

await client.collections.create({
  name: 'DemoCollection',
  generative: weaviate.configure.generative.friendliai({
    model: 'meta-llama-3.1-70b-instruct'
  }),
  // 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.

Generative parameters

Configure the following generative parameters to customize the model behavior.

Python API v4
JS/TS API v3

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.friendliai(
        # # These parameters are optional
        model="meta-llama-3.1-70b-instruct",
        max_tokens=500,
        temperature=0.7,
        base_url="https://inference.friendli.ai"
    )
)

await client.collections.create({
  name: 'DemoCollection',
  generative: weaviate.configure.generative.friendliai({
    model: 'meta-llama-3.1-70b-instruct',
    maxTokens: 500,
    temperature: 0.7,
    baseURL: 'https://inference.friendli.ai'
  }),
  // Additional parameters not shown
});

For further details on model parameters, see the FriendliAI 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.

Python API v4
JS/TS API v3

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

let myCollection = client.collections.get('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.generated}`);  // Note that the generated output is per object
}

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.

Python API v4
JS/TS API v3

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"])

let myCollection = client.collections.get('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.generated}`);  // Note that the generated output is per query
for (const obj of groupedTaskResults.objects) {
  console.log(obj.properties['title']);
}

References

Available models

meta-llama-3.1-70b-instruct (default)
meta-llama-3.1-8b-instruct
mixtral-8x7b-instruct-v0-1

You can use any model deployed on Friendli Suite with Weaviate.

FriendliAI's provide a wide range of available models, which can optionally be fine-tuned. See the FriendliAI quickstart guide for instructions.

If using a dedicated FriendliAI endpoint with the Weaviate integration, specify it as shown below:

Python API v4
JS/TS API v3

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

# Recommended: save sensitive data as environment variables
friendli_key = os.getenv("FRIENDLI_TOKEN")
headers = {
    "X-Friendli-Api-Key": friendli_key,
    "X-Friendli-Baseurl": "https://inference.friendli.ai/dedicated",
}

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()

import weaviate from 'weaviate-client'


const client = await weaviate.connectToWeaviateCloud(
  'WEAVIATE_INSTANCE_URL',  // Replace with your instance URL
  {
    authCredentials: new weaviate.ApiKey('WEAVIATE_INSTANCE_APIKEY'),
    headers: {
      'X-Friendli-Api-Key': friendliApiKey,
      'X-Friendli-Baseurl': 'https://inference.friendli.ai/dedicated',
    }
  }
)

// Work with Weaviate

client.close()

Python API v4
JS/TS API v3

from weaviate.classes.config import Configure

client.collections.create(
    "DemoCollection",
    generative_config=Configure.Generative.friendliai(
        model = "YOUR_ENDPOINT_ID",
    )
)

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

Further resources

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

FriendliAI API documentation

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

Requirements
- Weaviate configuration
- API credentials
Configure collection
- Select a model
- Generative parameters
Retrieval augmented generation
- Single prompt
- Grouped task
References
- Available models
Further resources
- Code examples
- References