From 043d78d85d204b22fb84d0162264da6aefab3742 Mon Sep 17 00:00:00 2001
From: Sunish Sheth <sunishsheth2009@gmail.com>
Date: Wed, 12 Feb 2025 15:50:35 -0800
Subject: [PATCH] Deprecate langhchain community ucfunctiontoolkit in favor for
 databricks_langchain (#29746)

Thank you for contributing to LangChain!

- [ ] **PR title**: "package: description"
- Where "package" is whichever of langchain, community, core, etc. is
being modified. Use "docs: ..." for purely docs changes, "infra: ..."
for CI changes.
  - Example: "community: add foobar LLM"


- [ ] **PR message**: ***Delete this entire checklist*** and replace
with
    - **Description:** a description of the change
    - **Issue:** the issue # it fixes, if applicable
    - **Dependencies:** any dependencies required for this change
- **Twitter handle:** if your PR gets announced, and you'd like a
mention, we'll gladly shout you out!


- [ ] **Add tests and docs**: If you're adding a new integration, please
include
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.


- [ ] **Lint and test**: Run `make format`, `make lint` and `make test`
from the root of the package(s) you've modified. See contribution
guidelines for more: https://python.langchain.com/docs/contributing/

Additional guidelines:
- Make sure optional dependencies are imported within a function.
- Please do not add dependencies to pyproject.toml files (even optional
ones) unless they are required for unit tests.
- Most PRs should not touch more than one package.
- Changes should be backwards compatible.
- If you are adding something to community, do not re-import it in
langchain.

If no one reviews your PR within a few days, please @-mention one of
baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.
---
 docs/docs/integrations/tools/databricks.ipynb | 27 +++++++++----------
 .../tools/databricks/tool.py                  |  6 +++++
 2 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/docs/docs/integrations/tools/databricks.ipynb b/docs/docs/integrations/tools/databricks.ipynb
index 9fa37315385..61aa76484f2 100644
--- a/docs/docs/integrations/tools/databricks.ipynb
+++ b/docs/docs/integrations/tools/databricks.ipynb
@@ -66,21 +66,20 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from databricks.sdk import WorkspaceClient\n",
-    "from langchain_community.tools.databricks import UCFunctionToolkit\n",
+    "from databricks_langchain.uc_ai import (\n",
+    "    DatabricksFunctionClient,\n",
+    "    UCFunctionToolkit,\n",
+    "    set_uc_function_client,\n",
+    ")\n",
     "\n",
-    "tools = (\n",
-    "    UCFunctionToolkit(\n",
-    "        # You can find the SQL warehouse ID in its UI after creation.\n",
-    "        warehouse_id=\"xxxx123456789\"\n",
-    "    )\n",
-    "    .include(\n",
-    "        # Include functions as tools using their qualified names.\n",
-    "        # You can use \"{catalog_name}.{schema_name}.*\" to get all functions in a schema.\n",
-    "        \"main.tools.python_exec\",\n",
-    "    )\n",
-    "    .get_tools()\n",
-    ")"
+    "client = DatabricksFunctionClient()\n",
+    "set_uc_function_client(client)\n",
+    "\n",
+    "tools = UCFunctionToolkit(\n",
+    "    # Include functions as tools using their qualified names.\n",
+    "    # You can use \"{catalog_name}.{schema_name}.*\" to get all functions in a schema.\n",
+    "    function_names=[\"main.tools.python_exec\"]\n",
+    ").tools"
    ]
   },
   {
diff --git a/libs/community/langchain_community/tools/databricks/tool.py b/libs/community/langchain_community/tools/databricks/tool.py
index f64616ea5fb..67ef21148e4 100644
--- a/libs/community/langchain_community/tools/databricks/tool.py
+++ b/libs/community/langchain_community/tools/databricks/tool.py
@@ -4,6 +4,7 @@ from decimal import Decimal
 from hashlib import md5
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union
 
+from langchain_core._api import deprecated
 from langchain_core.tools import BaseTool, StructuredTool
 from langchain_core.tools.base import BaseToolkit
 from pydantic import BaseModel, Field, create_model
@@ -131,6 +132,11 @@ def _get_default_workspace_client() -> Any:
     return WorkspaceClient()
 
 
+@deprecated(
+    since="0.3.18",
+    removal="1.0",
+    alternative_import="databricks_langchain.uc_ai.UCFunctionToolkit",
+)
 class UCFunctionToolkit(BaseToolkit):
     warehouse_id: str = Field(
         description="The ID of a Databricks SQL Warehouse to execute functions."