Generative and reranker models
Visit the Vectorizer and vector config guide to find out how to configure an embedding model for your collection or to fine-tune the vector index settings.
Specify a reranker model integration
Configure a reranker model integration for reranking retrieved results.
If a snippet doesn't work or you have feedback, please open a GitHub issue.
from weaviate.classes.config import Configure, Property, DataType
client.collections.create(
"Article",
vector_config=Configure.Vectors.text2vec_openai(),
reranker_config=Configure.Reranker.cohere(),
)
import { vectors, reranker } from '@weaviate/node';
await client.collections.create({
name: 'Article',
vectorizers: vectors.text2VecOpenAI(),
reranker: reranker.cohere(),
})
articleClass := &models.Class{
Class: "Article",
Description: "Collection of articles",
Vectorizer: "text2vec-openai",
ModuleConfig: map[string]interface{}{
"reranker-cohere": map[string]interface{}{
"model": "rerank-v3.5",
},
},
}
// Coming soon
client.collections.create("Article",
col -> col.vectorConfig(VectorConfig.text2vecTransformers())
.rerankerModules(Reranker.cohere())
.properties(Property.text("title")));
await client.Collections.Create(
new CollectionCreateParams
{
Name = "Article",
VectorConfig = Configure.Vector("default", v => v.Text2VecTransformers()),
RerankerConfig = Configure.Reranker.Cohere(),
Properties = [Property.Text("title")],
}
);
Update the reranker model integration
v1.25.23, v1.26.8 and v1.27.1The reranker and generative configurations are mutable from v1.25.23, v1.26.8 and v1.27.1.
Update the reranker model integration for reranking retrieved results.
If a snippet doesn't work or you have feedback, please open a GitHub issue.
from weaviate.classes.config import Reconfigure
collection = client.collections.use("Article")
collection.config.update(
reranker_config=Reconfigure.Reranker.cohere() # Update the reranker module
)
import { reconfigure } from '@weaviate/node';
const collection = client.collections.use('Article')
await collection.config.update({
reranker: reconfigure.reranker.voyageAI() // Update the reranker module
})
updatedArticleClassConfig := &models.Class{
// Note: The new collection config must be provided in full,
// including the configuration that is not being updated.
// We suggest using the original class config as a starting point.
Class: "Article",
ModuleConfig: map[string]interface{}{
"reranker-cohere": map[string]interface{}{
"model": "rerank-v3.5",
},
},
}
// Coming soon
var collection = client.collections.use("Article");
collection.config.update(col -> col.rerankerModules(Reranker.cohere()));
var collection = client.Collections.Use("Article");
await collection.Config.Update(c =>
{
c.RerankerConfig = Configure.Reranker.Cohere();
});
Specify a generative model integration
Specify a generative model integration for a collection (for RAG).
If a snippet doesn't work or you have feedback, please open a GitHub issue.
from weaviate.classes.config import Configure, Property, DataType
client.collections.create(
"Article",
vector_config=Configure.Vectors.text2vec_openai(),
generative_config=Configure.Generative.openai(
model="gpt-4o" # set your generative model (optional parameter)
),
)
import { vectors, generative } from '@weaviate/node';
await client.collections.create({
name: 'Article',
vectorizers: vectors.text2VecOpenAI(),
generative: generative.openAI({
model: "gpt-4o" // set your generative model (optional parameter)
}),
})
articleClass := &models.Class{
Class: "Article",
Description: "Collection of articles",
Vectorizer: "text2vec-openai",
ModuleConfig: map[string]interface{}{
"generative-openai": map[string]interface{}{
"model": "gpt-4o",
},
},
}
// Coming soon
client.collections.create("Article",
col -> col.vectorConfig(VectorConfig.text2vecTransformers())
.generativeModule(Generative.cohere())
.properties(Property.text("title")));
await client.Collections.Create(
new CollectionCreateParams
{
Name = "Article",
VectorConfig = Configure.Vector("default", v => v.Text2VecTransformers()),
GenerativeConfig = Configure.Generative.Cohere(),
Properties = [Property.Text("title")],
}
);
Update the generative model integration
v1.25.23, v1.26.8 and v1.27.1The reranker and generative configurations are mutable from v1.25.23, v1.26.8 and v1.27.1.
Update a generative model integration.
If a snippet doesn't work or you have feedback, please open a GitHub issue.
from weaviate.classes.config import Reconfigure
collection = client.collections.use("Article")
collection.config.update(
generative_config=Reconfigure.Generative.cohere() # Update the generative module
)
import { reconfigure } from '@weaviate/node';
const collection = client.collections.use("Article")
await collection.config.update({
generative: weaviate.reconfigure.generative.openAI() // Update the generative module
})
updatedArticleClassConfig := &models.Class{
Class: "Article",
ModuleConfig: map[string]interface{}{
"generative-cohere": map[string]interface{}{},
},
}
// Coming soon
var collection = client.collections.use("Article");
collection.config.update(col -> col.generativeModule(Generative.cohere()));
var collection = client.Collections.Use("Article");
await collection.Config.Update(c =>
{
c.GenerativeConfig = Configure.Generative.Cohere();
});
You can override the generative integration settings at query time without updating it in the collection configuration.
Further resources
Questions and feedback
Have a question or feedback? Here's how to reach us.
