---
title: "Databricks Embeddings with Weaviate"
description: "Weaviate's integration with Databricks' APIs allows you to access models hosted on their platform directly from Weaviate."
url: https://docs.weaviate.io/weaviate/model-providers/databricks/embeddings
---

# Databricks Embeddings with Weaviate

Weaviate's integration with Databricks' APIs allows you to access models hosted on their platform directly from Weaviate.

[Configure a Weaviate vector index](https://docs.weaviate.io/weaviate/model-providers/databricks/embeddings#configure-the-vectorizer) to use a Databricks embedding model, and Weaviate will generate embeddings for various operations using the specified endpoint and your Databricks token. This feature is called the *vectorizer*.

At [import time](https://docs.weaviate.io/weaviate/model-providers/databricks/embeddings#data-import), Weaviate generates text object embeddings and saves them into the index. For [vector](https://docs.weaviate.io/weaviate/model-providers/databricks/embeddings#vector-near-text-search) and [hybrid](https://docs.weaviate.io/weaviate/model-providers/databricks/embeddings#hybrid-search) search operations, Weaviate converts text queries into embeddings.

![Embedding integration illustration](https://docs.weaviate.io/assets/images/integration_databricks_embedding-86c60c4176571621d913f6ae2219bf00.png)

## Requirements

### Weaviate configuration

Your Weaviate instance must be configured with the Databricks vectorizer integration (`text2vec-databricks`) 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.

### Databricks Personal Access Token

You must provide a valid Databricks Personal Access Token (PAT) to Weaviate for this integration. Refer to the [Databricks documentation](https://docs.databricks.com/en/dev-tools/auth/pat.html) for instructions on generating your PAT in your workspace.

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

- Set the `DATABRICKS_TOKEN` environment variable that is available to Weaviate.
- Provide the token 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
databricks_token = os.getenv("DATABRICKS_TOKEN")
headers = {
    "X-Databricks-Token": databricks_token,
}

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 databricksToken = process.env.DATABRICKS_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_API_KEY'),
    headers: {
      'X-Databricks-Token': databricksToken,
    }
  }
)

// Work with Weaviate

client.close()
```

**Go (v5)**

```go
// Set these environment variables
// WEAVIATE_HOSTNAME            your Weaviate instance hostname, excluding the scheme (https://)
// WEAVIATE_API_KEY          your Weaviate instance API key
// <PROVIDER>_API_KEY       your model provider API key (or token)

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/weaviate/weaviate-go-client/v5/weaviate"
    "github.com/weaviate/weaviate-go-client/v5/weaviate/auth"
)

func main() {
    cfg := weaviate.Config{
        Host:       os.Getenv("WEAVIATE_HOSTNAME"),
        Scheme:     "https",
        AuthConfig: auth.ApiKey{Value: os.Getenv("WEAVIATE_API_KEY")},
        Headers: map[string]string{
            "X-Databricks-Token": os.Getenv("DATABRICKS_TOKEN"),
        },
    }

    client, err := weaviate.NewClient(cfg)
    if err != nil {
        fmt.Println(err)
    }

    // Work with Weaviate
}
```

## Configure the vectorizer

[Configure a Weaviate index](https://docs.weaviate.io/weaviate/manage-collections/vector-config#specify-a-vectorizer) to use a Databricks serving model endpoint by setting the vectorizer as follows:

**Python**

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

databricks_vectorizer_endpoint = os.getenv("DATABRICKS_VECTORIZER_ENDPOINT")  # If saved as an environment variable

client.collections.create(
    "DemoCollection",
    vector_config=[
        Configure.Vectors.text2vec_databricks(
            endpoint=databricks_vectorizer_endpoint,  # Required for Databricks
            name="title_vector",
            source_properties=["title"],
        )
    ],
    # Additional parameters not shown
)
```

**JavaScript/TypeScript**

```ts
const databricksVectorizerEndpoint = process.env.DATABRICKS_VECTORIZER_ENDPOINT || '';  // If saved as an environment variable

await client.collections.create({
  name: 'DemoCollection',
  properties: [
    {
      name: 'title',
      dataType: 'text' as const,
    },
  ],
  vectorizers: [
    weaviate.configure.vectors.text2VecDatabricks({
      endpoint: databricksVectorizerEndpoint,  // Required for Databricks
      name: 'title_vector',
      sourceProperties: ['title'],
    })
  ],
  // Additional parameters not shown
});
```

**Go (v5)**

```go
// package, imports not shown

func main() {
    // Instantiation not shown

    ctx := context.Background()

    // Define the collection
    basicDatabricksVectorizerDef := &models.Class{
        Class: "DemoCollection",
        VectorConfig: map[string]models.VectorConfig{
            "title_vector": {
                Vectorizer: map[string]interface{}{
                    "text2vec-databricks": map[string]interface{}{
                        "properties": []string{"title"},
                        "endpoint":   "<databricks_vectorizer_endpoint>", // Required for Databricks
                    },
                },
            },
        },
    }

    // add the collection
    err = client.Schema().ClassCreator().WithClass(basicDatabricksVectorizerDef).Do(ctx)
    if err != nil {
        panic(err)
    }
}
```

This will configure Weaviate to use the vectorizer served through the endpoint you specify.

### Vectorizer parameters

- `endpoint`: The URL of the embedding model hosted on Databricks.
- `instruction`: An optional instruction to pass to the embedding model.

For further details on model parameters, see the [Databricks documentation](https://docs.databricks.com/en/machine-learning/foundation-models/api-reference.html#embedding-request).

## Header parameters

You can provide the token as well as some optional parameters at runtime through additional headers in the request. The following headers are available:

- `X-Databricks-Token`: The Databricks API token.
- `X-Databricks-Endpoint`: The endpoint to use for the Databricks model.
- `X-Databricks-User-Agent`: The user agent to use for the Databricks model.

Any additional headers provided at runtime will override the existing Weaviate configuration.

Provide the headers as shown in the [API credentials examples](https://docs.weaviate.io/weaviate/model-providers/databricks/embeddings#api-credentials) above.

## Data import

After configuring the vectorizer, [import data](https://docs.weaviate.io/weaviate/manage-objects/import) into Weaviate. Weaviate generates embeddings for text objects using [the specified model](https://docs.weaviate.io/weaviate/model-providers/databricks/embeddings#vectorizer-parameters).

**Python**

```py
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.")
            break

failed_objects = collection.batch.failed_objects
if failed_objects:
    print(f"Number of failed imports: {len(failed_objects)}")
    print(f"First failed object: {failed_objects[0]}")
```

**JavaScript/TypeScript**

```ts
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." }
];

const collectionName = 'DemoCollection'
const myCollection = client.collections.use(collectionName)

let dataObjects = new Array();

for (let srcObject of srcObjects) {
  dataObjects.push({
    title: srcObject.title,
    description: srcObject.description,
  });
}

const response = await myCollection.data.insertMany(dataObjects);

console.log(response);
```

**Go (v5)**

```go
// package, imports not shown

func main() {
    // Instantiation not shown

    ctx := context.Background()

    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.Object
    objects := []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 items
    batcher := client.Batch().ObjectsBatcher()
    for _, dataObj := range objects {
        batcher.WithObjects(&models.Object{
            Class:      "DemoCollection",
            Properties: dataObj,
        })
    }

    // Flush
    batchRes, err := batcher.Do(ctx)

    // Error handling
    if 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)
                }
            }
        }
    }
}
```

> [!TIP]
>
> **Re-use existing vectors**
>
> If you already have a compatible model vector available, you can provide it directly to Weaviate. This can be useful if you have already generated embeddings using the same model and want to use them in Weaviate, such as when migrating data from another system.

## Searches

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

![Embedding integration at search illustration](https://docs.weaviate.io/assets/images/integration_databricks_embedding_search-30c862a8211c2288099151136816438e.png)

### Vector (near text) search

When you perform a [vector search](https://docs.weaviate.io/weaviate/search/similarity#search-with-text), 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**

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

```ts
const collectionName = 'DemoCollection'
const myCollection = client.collections.use(collectionName)

let result;

result = await myCollection.query.nearText(
  'A holiday film',  // The model provider integration will automatically vectorize the query
  {
    limit: 2,
  }
)

console.log(JSON.stringify(result.objects, null, 2));
```

**Go (v5)**

```go
// package, imports not shown

func main() {
    // Instantiation not shown

    ctx := context.Background()

    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)
}
```

### Hybrid search

> [!NOTE]
>
> **What is a hybrid search?**
>
> A hybrid search performs a vector search and a keyword (BM25) search, before [combining the results](https://docs.weaviate.io/weaviate/search/hybrid) to return the best matching objects from the database.

When you perform a [hybrid search](https://docs.weaviate.io/weaviate/search/hybrid), Weaviate converts the text query into an embedding using the specified model and returns the best scoring objects from the database.

The query below returns the `n` best scoring objects from the database, set by `limit`.

**Python**

```py
collection = client.collections.use("DemoCollection")

response = collection.query.hybrid(
    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**

```ts
const collectionName = 'DemoCollection'
const myCollection = client.collections.use(collectionName)

result = await myCollection.query.hybrid(
  'A holiday film',  // The model provider integration will automatically vectorize the query
  {
    limit: 2,
  }
)

console.log(JSON.stringify(result.objects, null, 2));
```

**Go (v5)**

```go
// package, imports not shown

func main() {
    // Instantiation not shown

    ctx := context.Background()

    hybridResponse, err := client.GraphQL().Get().
        WithClassName("DemoCollection").
        WithFields(
            graphql.Field{Name: "title"},
        ).
        WithHybrid(client.GraphQL().HybridArgumentBuilder().
            WithQuery("A holiday film")).
        WithLimit(2).
        Do(ctx)

    if err != nil {
        panic(err)
    }
    fmt.Printf("%v", hybridResponse)
}
```

## References

## Further resources

### Other integrations

- [Databricks generative models + Weaviate](https://docs.weaviate.io/weaviate/model-providers/databricks/generative).

### 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

- Databricks [Foundation model REST API reference](https://docs.databricks.com/en/machine-learning/foundation-models/api-reference.html)
