Skip to content

Commit ea340ae

Browse files
authored
Update README (#71)
1 parent 733734b commit ea340ae

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

README.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,38 @@
11
# Databricks AI Bridge library
22

3-
The Databricks AI Bridge library provides a shared layer of APIs to interact with Databricks AI features, such as [Databricks AI/BI Genie ](https://www.databricks.com/product/ai-bi/genie) and [Vector Search](https://docs.databricks.com/en/generative-ai/vector-search.html).
3+
The Databricks AI Bridge library provides a shared layer of APIs to interact with Databricks AI features, such as [Databricks AI/BI Genie ](https://www.databricks.com/product/ai-bi/genie) and [Vector Search](https://docs.databricks.com/en/generative-ai/vector-search.html). Use these packages to help [author agents with Agent Framework](https://docs.databricks.com/aws/en/generative-ai/agent-framework/author-agent#requirements) on Databricks.
44

5-
## Integrations
5+
## Integration Packages
66

7-
This library also contains the source code for the following integration packages. These integration packages provide seamless integration of Databricks AI features to use in AI authoring frameworks.
7+
If you are using LangChain/LangGraph or the OpenAI SDK, we provide these integration packages for seamless integration of Databricks AI features.
88

9-
- [`databricks-langchain`](./integrations/langchain/README.md)
10-
- [`databricks-openai`](./integrations/openai/README.md)
9+
- [`databricks-langchain`](./integrations/langchain/README.md) - For LangChain/LangGraph users
10+
- [`databricks-openai`](./integrations/openai/README.md) - For OpenAI SDK users
1111

1212
## Installation
1313

14-
If you are using LangChain or OpenAI, you should install `databricks-langchain` or `databricks-openai`. Refer to the linked READMEs for more details. For other frameworks without dedicated integration packages, use `databricks-ai-bridge` instead.
15-
16-
### Install from PyPI
14+
If you're using LangChain/LangGraph or OpenAI:
1715

1816
```sh
1917
pip install databricks-langchain
2018
pip install databricks-openai
21-
pip install databricks-ai-bridge
19+
```
20+
21+
For frameworks without dedicated integration packages:
2222

23+
```sh
24+
pip install databricks-ai-bridge
2325
```
2426

2527
### Install from source
2628

2729
With https:
2830

2931
```sh
32+
# For LangChain/LangGraph users (recommended):
3033
pip install git+https://[email protected]/databricks/databricks-ai-bridge.git#subdirectory=integrations/langchain
34+
# For OpenAI users (recommended):
3135
pip install git+https://[email protected]/databricks/databricks-ai-bridge.git#subdirectory=integrations/openai
36+
# Generic installation (only if needed):
3237
pip install git+https://[email protected]/databricks/databricks-ai-bridge.git
33-
3438
```

integrations/langchain/src/databricks_langchain/vectorstores.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ def __init__(
243243

244244
try:
245245
client_args = client_args or {}
246-
client_args["disable_notice"] = True
246+
client_args.setdefault("disable_notice", True)
247247
self.index = VectorSearchClient(**client_args).get_index(
248248
endpoint_name=endpoint, index_name=index_name
249249
)

0 commit comments

Comments
 (0)