Install & Compatibility
Where this runs
tested against v0.21.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 4.654s · 270.2MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 17.7s · import 4.106s · 263MB
274MB installed
● package 274MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ModelServingUserCredentials
✓ from databricks_ai_bridge import ModelServingUserCredentials
✗ from databricks_ai_bridge.rag.vectorstores import DatabricksVectorSearch
model_serving_obo_credential_strategy
✓ from databricks_ai_bridge import model_serving_obo_credential_strategy
This quickstart demonstrates initializing the Databricks Workspace Client, then setting up DatabricksVectorSearch, DatabricksLLM, and PromptEngineer components. It requires a configured Databricks environment, including environment variables `DATABRICKS_HOST` and `DATABRICKS_TOKEN`, and pre-existing Databricks Vector Search indexes and model serving endpoints for full functionality.
import os
from databricks.sdk import WorkspaceClient
from databricks_ai_bridge.rag.vectorstores import DatabricksVectorSearch
from databricks_ai_bridge.model_serving.prompt_engineering import PromptEngineer
from databricks_ai_bridge.model_serving.llm import DatabricksLLM
# Initialize Databricks Workspace Client
# Ensure DATABRICKS_HOST and DATABRICKS_TOKEN environment variables are set
# or passed as arguments to WorkspaceClient
host = os.environ.get("DATABRICKS_HOST", "https://dummy-host.cloud.databricks.com")
token = os.environ.get("DATABRICKS_TOKEN", "dapi-dummy-token")
w = None
try:
# In a real environment, replace dummy values with actual config or ensure env vars are set.
w = WorkspaceClient(host=host, token=token)
# Attempt to verify client connection (optional, but good for debugging)
# w.current_user.me()
print("Databricks Workspace Client initialized.")
except Exception as e:
print(f"Warning: Could not initialize Databricks WorkspaceClient. Check DATABRICKS_HOST/TOKEN: {e}")
print("Quickstart will proceed with dummy client, but actual interactions will fail.")
if w:
# Example: Using Databricks Vector Search for RAG (requires a configured Vector Search index)
# Replace with your actual catalog, schema, table, and index names
catalog = "main"
schema = "default"
table = "my_documents_table"
index_name = "my_vector_search_index"
try:
vector_store = DatabricksVectorSearch(
w,
catalog_name=catalog,
schema_name=schema,
table_name=table,
index_name=index_name,
)
print(f"Initialized DatabricksVectorSearch for index: {index_name}")
# Example: Using PromptEngineer and DatabricksLLM
# Ensure a model is served at the specified endpoint in your Databricks workspace
llm_endpoint = "databricks-mixtral-8x7b-instruct" # Example Foundation Model endpoint or custom served model
llm = DatabricksLLM(workspace_client=w, serving_endpoint=llm_endpoint)
engineer = PromptEngineer(llm=llm, vector_store=vector_store)
query = "What is Databricks Lakehouse Platform?"
print(f"PromptEngineer initialized. A live call to engineer.answer_question('{query}') would retrieve information using the configured LLM and vector store on Databricks.")
# To run live:
# response = engineer.answer_question(query)
# print(f"Query: {query}\nResponse: {response}")
except Exception as e:
print(f"Error during quickstart setup. This often means required Databricks resources (e.g., Vector Search index, LLM endpoint) are not configured or accessible: {e}")
print("Please ensure your Databricks environment is correctly set up as per databricks-ai-bridge documentation.")
else:
print("Skipping Databricks AI Bridge component initialization due to WorkspaceClient failure.")
databricks --version
Debug
Known issues
breakingSignificant API changes occurred in version 0.17.0, particularly affecting `databricks_ai_bridge.pipelines` and `databricks_ai_bridge.rag.document_loaders`. Users upgrading from older versions (e.g., 0.16.x) will need to refactor their code for these modules.fixConsult the official `CHANGELOG.md` and updated examples on GitHub for versions 0.17.0+ to adjust pipeline definitions and document loading strategies.
affects: <0.17.0 (when upgrading to >=0.17.0)
gotchaThe library heavily relies on a properly configured Databricks environment, including environment variables (`DATABRICKS_HOST`, `DATABRICKS_TOKEN`) and provisioned Databricks services (Vector Search indexes, Model Serving endpoints, Unity Catalog tables). Operations will fail with `ApiException` or similar errors if these resources are not correctly set up or accessible.fixEnsure `DATABRICKS_HOST` and `DATABRICKS_TOKEN` environment variables are correctly set, and all required Databricks services are configured and accessible in your workspace before running `databricks-ai-bridge` applications.
affects: All versions
gotchaAs a pre-1.0 library, `databricks-ai-bridge` frequently introduces breaking changes in minor versions (e.g., `0.x.0` to `0.x+1.0`). API signatures, module structures, and default behaviors can change without strict adherence to semantic versioning.fixPin exact minor versions (e.g., `databricks-ai-bridge==0.18.0`) in production environments. Carefully review the `CHANGELOG.md` on GitHub for any new breaking changes when planning an upgrade to a newer minor version.
affects: All `0.x.x` versions
Upgrade
Version history
0.21.0latest on PyPI · released Jun 25, 2026
Audit
Dependencies
databricks-sdkrequiredEssential for interacting with Databricks APIs and services.
langchainrequiredCore framework for building AI applications, heavily utilized by the library.
mlflowrequiredUsed for MLOps capabilities, particularly model logging and serving integration.