Skip to main content
Weaviate Docs (migrated from docs.weaviate.io) Docs

Search documentation

Type to search this documentation.

On this pageOverview

Quickstart

Expected time: 30 minutes

To use Weaviate Embeddings, you will need:

  • A Weaviate Cloud free cluster
  • A Weaviate client library that supports Weaviate Embeddings
Python
pip install -U "weaviate-client[agents]"
JavaScript/TypeScript
npm install weaviate-client weaviate-agents
Go
go get github.com/weaviate/weaviate-go-client/v5
Java
<dependency>
  <groupId>io.weaviate</groupId>
  <artifactId>client6</artifactId>
  <version>6.2.0</version> <!-- Check latest version: https://github.com/weaviate/java-client  -->
</dependency>
C#
<PackageReference Include="Weaviate.Client" Version="1.0.0" />

The Go client does not support Weaviate Embeddings directly. Pass the X-Weaviate-Api-Key and X-Weaviate-Cluster-Url headers manually when you instantiate the client.

To create a free cluster in Weaviate Cloud, follow these instructions.

We recommend using a client library to work with Weaviate. Follow the instructions below to install one of the official client libraries, available in Python, JavaScript/TypeScript, Go, and Java.

Python
pip install -U "weaviate-client[agents]"
JavaScript/TypeScript
npm install weaviate-client weaviate-agents
Go
go get github.com/weaviate/weaviate-go-client/v5
Java
<dependency>
  <groupId>io.weaviate</groupId>
  <artifactId>client6</artifactId>
  <version>6.2.0</version> <!-- Check latest version: https://github.com/weaviate/java-client  -->
</dependency>
C#
<PackageReference Include="Weaviate.Client" Version="1.0.0" />

Weaviate Embeddings is integrated with Weaviate Cloud. Your Weaviate Cloud credentials will be used to authorize your Weaviate Cloud instance's access for Weaviate Embeddings.

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

# Best practice: store your credentials in environment variables
weaviate_url = os.getenv("WEAVIATE_URL")
weaviate_key = os.getenv("WEAVIATE_API_KEY")

client = weaviate.connect_to_weaviate_cloud(
    cluster_url=weaviate_url,                     # Weaviate URL: "REST Endpoint" in Weaviate Cloud console
    auth_credentials=Auth.api_key(weaviate_key),  # Weaviate API key: "ADMIN" API key in Weaviate Cloud console
)

print(client.is_ready())  # Should print: `True`

# Work with Weaviate

client.close()
JavaScript/TypeScript
import weaviate from 'weaviate-client'

// Best practice: store your credentials in environment variables
const weaviateUrl = process.env.WEAVIATE_URL as string;        // Weaviate URL: "REST Endpoint" in Weaviate Cloud console
const weaviateApiKey = process.env.WEAVIATE_API_KEY as string; // Weaviate API key: "ADMIN" API key in Weaviate Cloud console

const client = await weaviate.connectToWeaviateCloud(
  weaviateUrl,  
  {
    authCredentials: new weaviate.ApiKey(weaviateApiKey),  
  }
)

// Work with Weaviate

client.close()
Go

Now we can define a collection that will store our data. When creating a collection, you need to specify one of the available models for the vectorizer to use. This model will be used to create vector embeddings from your data.

Python
from weaviate.classes.config import Configure, Property, DataTypeclient.collections.create(    "DemoCollection",    properties=[        Property(name="title", data_type=DataType.TEXT),    ],    vector_config=[        Configure.Vectors.text2vec_weaviate(            name="title_vector",            source_properties=["title"],            model="Snowflake/snowflake-arctic-embed-l-v2.0",            # Further options            # dimensions=256            # base_url="<custom_weaviate_embeddings_url>",        )    ],    # Additional parameters not shown)
JavaScript/TypeScript
await client.collections.create({  name: 'DemoCollection',  properties: [    {      name: 'title',      dataType: 'text' as const,    },  ],  vectorizers: [    weaviate.configure.vectors.text2VecWeaviate({        name: 'title_vector',        sourceProperties: ['title'],        model: 'Snowflake/snowflake-arctic-embed-l-v2.0',        // Further options        // dimensions: 256,        // baseURL: '<custom_weaviate_embeddings_url>',      },    ),  ],  // Additional parameters not shown});
Go
// Define the collectionweaviateVectorizerArcticEmbedLV20 := &models.Class{  Class: "DemoCollection",  VectorConfig: map[string]models.VectorConfig{    "title_vector": {      VectorIndexType: `hnsw`,      Vectorizer: map[string]interface{}{        "text2vec-weaviate": map[string]interface{}{          "model":      "Snowflake/snowflake-arctic-embed-l-v2.0",          "dimensions": 1024, // Or 256          // "base_url":   "<custom_weaviate_url>",        },      },    },  },}// add the collectionerr = client.Schema().ClassCreator().WithClass(weaviateVectorizerArcticEmbedLV20).Do(ctx)if err != nil {  panic(err)}

For more information about the available model options visit the Choose a model page.

After configuring the vectorizer, import data into Weaviate. Weaviate generates embeddings for text objects using the specified model.

Python
source_objects = [    {"title": "The Shawshank Redemption", "description": "A wrongfully imprisoned man forms an inspiring friendship while finding hope and redemption in the darkest of places."},    {"title": "The Godfather", "description": "A powerful mafia family struggles to balance loyalty, power, and betrayal in this iconic crime saga."},    {"title": "The Dark Knight", "description": "Batman faces his greatest challenge as he battles the chaos unleashed by the Joker in Gotham City."},    {"title": "Jingle All the Way", "description": "A desperate father goes to hilarious lengths to secure the season's hottest toy for his son on Christmas Eve."},    {"title": "A Christmas Carol", "description": "A miserly old man is transformed after being visited by three ghosts on Christmas Eve in this timeless tale of redemption."}]collection = client.collections.use("DemoCollection")with collection.batch.fixed_size(batch_size=200) as batch:    for src_obj in source_objects:        # The model provider integration will automatically vectorize the object        batch.add_object(            properties={                "title": src_obj["title"],                "description": src_obj["description"],            },            # vector=vector  # Optionally provide a pre-obtained vector        )        if batch.number_errors > 10:            print("Batch import stopped due to excessive errors.")            breakfailed_objects = collection.batch.failed_objectsif failed_objects:    print(f"Number of failed imports: {len(failed_objects)}")    print(f"First failed object: {failed_objects[0]}")
JavaScript/TypeScript
let srcObjects = [
  { title: "The Shawshank Redemption", description: "A wrongfully imprisoned man forms an inspiring friendship while finding hope and redemption in the darkest of places." },
  { title: "The Godfather", description: "A powerful mafia family struggles to balance loyalty, power, and betrayal in this iconic crime saga." },
  { title: "The Dark Knight", description: "Batman faces his greatest challenge as he battles the chaos unleashed by the Joker in Gotham City." },
  { title: "Jingle All the Way", description: "A desperate father goes to hilarious lengths to secure the season's hottest toy for his son on Christmas Eve." },
  { title: "A Christmas Carol", description: "A miserly old man is transformed after being visited by three ghosts on Christmas Eve in this timeless tale of redemption." }
];
Go
var sourceObjects = []map[string]string{  {"title": "The Shawshank Redemption", "description": "A wrongfully imprisoned man forms an inspiring friendship while finding hope and redemption in the darkest of places."},  {"title": "The Godfather", "description": "A powerful mafia family struggles to balance loyalty, power, and betrayal in this iconic crime saga."},  {"title": "The Dark Knight", "description": "Batman faces his greatest challenge as he battles the chaos unleashed by the Joker in Gotham City."},  {"title": "Jingle All the Way", "description": "A desperate father goes to hilarious lengths to secure the season's hottest toy for his son on Christmas Eve."},  {"title": "A Christmas Carol", "description": "A miserly old man is transformed after being visited by three ghosts on Christmas Eve in this timeless tale of redemption."},}// Convert items into a slice of models.Objectobjects := []models.PropertySchema{}for i := range sourceObjects {  objects = append(objects, map[string]interface{}{    // Populate the object with the data    "title":       sourceObjects[i]["title"],    "description": sourceObjects[i]["description"],  })}// Batch write itemsbatcher := client.Batch().ObjectsBatcher()for _, dataObj := range objects {  batcher.WithObjects(&models.Object{    Class:      "DemoCollection",    Properties: dataObj,  })}// FlushbatchRes, err := batcher.Do(ctx)// Error handlingif err != nil {  panic(err)}for _, res := range batchRes {  if res.Result.Errors != nil {    for _, err := range res.Result.Errors.Error {      if err != nil {        fmt.Printf("Error details: %v\n", *err)        panic(err.Message)      }    }  }}

Once the vectorizer is configured, Weaviate will perform vector search operations using the specified model.

When you perform a vector search, Weaviate converts the text query into an embedding using the specified model and returns the most similar objects from the database.

The query below returns the n most similar objects from the database, set by limit.

Python
collection = client.collections.use("DemoCollection")response = collection.query.near_text(    query="A holiday film",  # The model provider integration will automatically vectorize the query    limit=2)for obj in response.objects:    print(obj.properties["title"])
JavaScript/TypeScript
const collectionName = 'DemoCollection'
const myCollection = client.collections.use(collectionName)
Go
nearTextResponse, err := client.GraphQL().Get().  WithClassName("DemoCollection").  WithFields(    graphql.Field{Name: "title"},  ).  WithNearText(client.GraphQL().NearTextArgBuilder().    WithConcepts([]string{"A holiday film"})).  WithLimit(2).  Do(ctx)if err != nil {  panic(err)}fmt.Printf("%v", nearTextResponse)

If you use Weaviate Cloud (Database cluster(s) or Weaviate product in the cloud) or have a self-hosted support package, open a ticket in the Support Portal or email Weaviate support directly. To add a support plan, contact Weaviate sales.

Use the Support Portal for direct help from the Weaviate team: open and track tickets, and we'll respond in line with your support plan. The Community Forum is open to everyone, and a great place to ask questions, get help with your cluster, and connect with other developers. For all the ways to get help, see the Support overview.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu