Skip to content

Update docs to link to Unity Catalog OSS documentation #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 7, 2025
Merged

Update docs to link to Unity Catalog OSS documentation #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
46acb8e
update
annzhang-db May 1, 2025
96c7a54
update
annzhang-db May 1, 2025
68b01a8
update
annzhang-db May 1, 2025
89fe3ba
update
annzhang-db May 1, 2025
2c7ea10
update
annzhang-db May 1, 2025
83a428f
ruff
annzhang-db May 1, 2025
57a5460
Merge remote-tracking branch 'origin/main' into docs
annzhang-db May 7, 2025
a1c4c74
dependency
annzhang-db May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
None,
),
"pydantic": ("https://docs.pydantic.dev/latest/", None),
"unitycatalog": ("https://docs.unitycatalog.io/", None),
}

extlinks = {
Expand Down
15 changes: 15 additions & 0 deletions integrations/langchain/src/databricks_langchain/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
"""
**Re-exported Unity Catalog Utilities**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there no way to just get the docs inlined rather than linking? Just curious. If not this is good as well :)
cc @smurching since you had the initial idea

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I couldn't find a good way to inline the docs but open to any suggestions 🙇‍♀️


This module re-exports selected utilities from the Unity Catalog open source package.

Available aliases:

- :class:`databricks_langchain.UCFunctionToolkit`
- :class:`databricks_langchain.UnityCatalogTool`
- :class:`databricks_langchain.DatabricksFunctionClient`
- :func:`databricks_langchain.set_uc_function_client`

Refer to the Unity Catalog `documentation <https://docs.unitycatalog.io/ai/integrations/langchain/#using-unity-catalog-ai-with-langchain>`_ for more information.
"""

from unitycatalog.ai.core.base import set_uc_function_client
from unitycatalog.ai.core.databricks import DatabricksFunctionClient
from unitycatalog.ai.langchain.toolkit import UCFunctionToolkit, UnityCatalogTool
Expand Down
1 change: 1 addition & 0 deletions integrations/llamaindex/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ dependencies = [
"databricks-vectorsearch>=0.40",
"databricks-ai-bridge>=0.1.0",
"llama-index>=0.11.0",
"unitycatalog-llamaindex[databricks]>=0.2.0",
]

[project.optional-dependencies]
Expand Down
22 changes: 22 additions & 0 deletions integrations/llamaindex/src/databricks_llamaindex/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
"""
**Re-exported Unity Catalog Utilities**

This module re-exports selected utilities from the Unity Catalog open source package.

Available aliases:

- :class:`databricks_llamaindex.UCFunctionToolkit`
- :class:`databricks_llamaindex.UnityCatalogTool`
- :class:`databricks_llamaindex.DatabricksFunctionClient`
- :func:`databricks_llamaindex.set_uc_function_client`

Refer to the Unity Catalog `documentation <https://docs.unitycatalog.io/ai/integrations/llamaindex/#using-unity-catalog-ai-with-llamaindex>`_ for more information.
"""

from unitycatalog.ai.core.base import set_uc_function_client
from unitycatalog.ai.core.databricks import DatabricksFunctionClient
from unitycatalog.ai.llama_index.toolkit import UCFunctionToolkit

from databricks_llamaindex.vector_search_retriever_tool import VectorSearchRetrieverTool

# Expose all integrations to users under databricks-langchain
__all__ = [
"VectorSearchRetrieverTool",
"set_uc_function_client",
"DatabricksFunctionClient",
"UCFunctionToolkit",
]
14 changes: 14 additions & 0 deletions integrations/openai/src/databricks_openai/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
"""
**Re-exported Unity Catalog Utilities**

This module re-exports selected utilities from the Unity Catalog open source package.

Available aliases:

- :class:`databricks_openai.UCFunctionToolkit`
- :class:`databricks_openai.DatabricksFunctionClient`
- :func:`databricks_openai.set_uc_function_client`

Refer to the Unity Catalog `documentation <https://docs.unitycatalog.io/ai/integrations/openai/#using-unity-catalog-ai-with-the-openai-sdk>`_ for more information.
"""

from unitycatalog.ai.core.base import set_uc_function_client
from unitycatalog.ai.core.databricks import DatabricksFunctionClient
from unitycatalog.ai.openai.toolkit import UCFunctionToolkit
Expand Down