Intégrer les outils Unity Catalog avec des frameworks d'IA générative tiers
Les outils d'agent IA de Unity Catalog peuvent être utilisés dans des bibliothèques d'IA générative populaires comme LangChain, LlamaIndex, OpenAI et Anthropic. Ces intégrations combinent la gouvernance des outils Unity Catalog avec les capacités des frameworks de création d'agents tiers. Par exemple :
- Dans LangChain, les fonctions Unity Catalog peuvent faire partie du workflow d'un agent pour effectuer des tâches telles que l'interrogation ou la transformation de données.
- Dans les intégrations OpenAI ou Anthropic, les fonctions sont appelées directement par le modèle d'IA pendant l'exécution.
Sélectionnez votre framework dans les tabs suivantes pour créer un outil Unity Catalog et l'utiliser avec ce framework. Exécutez le code dans un Notebook Databricks ou un script Python.
Exigences
- Installez Python 3.10 ou version ultérieure.
- LangChain
- LlamaIndex
- OpenAI
- Anthropic
Utilisez Databricks Unity Catalog pour intégrer les fonctions SQL et Python comme outils dans les workflows LangChain et LangGraph. Cette intégration combine la gouvernance d'Unity Catalog avec les capacités de LangChain pour créer de puissantes applications basées sur les LLM.
Dans cet exemple, vous créez un outil Unity Catalog, testez ses fonctionnalités et l'ajoutez à un agent.
Installer les dépendances
Installez les packages IA d'Unity Catalog avec l'option Databricks et installez le package d'intégration LangChain.
# Install the Unity Catalog AI integration package with the Databricks extra
%pip install unitycatalog-langchain[databricks]
# Install Databricks Langchain integration package
%pip install databricks-langchain
dbutils.library.restartPython()
Initialiser le client de fonction Databricks
Initialisez le client de fonction Databricks.
from unitycatalog.ai.core.base import get_uc_function_client
client = get_uc_function_client()
Définir la logique de l'outil
Créez une fonction Unity Catalog contenant la logique de l'outil.
CATALOG = "my_catalog"
SCHEMA = "my_schema"
def add_numbers(number_1: float, number_2: float) -> float:
"""
A function that accepts two floating point numbers adds them,
and returns the resulting sum as a float.
Args:
number_1 (float): The first of the two numbers to add.
number_2 (float): The second of the two numbers to add.
Returns:
float: The sum of the two input numbers.
"""
return number_1 + number_2
function_info = client.create_python_function(
func=add_numbers,
catalog=CATALOG,
schema=SCHEMA,
replace=True
)
Testez la fonction
Testez votre fonction pour vérifier qu'elle fonctionne comme prévu :
result = client.execute_function(
function_name=f"{CATALOG}.{SCHEMA}.add_numbers",
parameters={"number_1": 36939.0, "number_2": 8922.4}
)
result.value # OUTPUT: '45861.4'
Encapsulez la fonction à l'aide du UCFunctionToolKit.
Encapsulez la fonction à l'aide de UCFunctionToolkit pour la rendre accessible aux bibliothèques de création d'agents. La boîte à outils assure la cohérence entre les différentes bibliothèques et ajoute des fonctionnalités utiles comme l'auto-traçage pour les récupérateurs.
from databricks_langchain import UCFunctionToolkit
# Create a toolkit with the Unity Catalog function
func_name = f"{CATALOG}.{SCHEMA}.add_numbers"
toolkit = UCFunctionToolkit(function_names=[func_name])
tools = toolkit.tools
Utilisez l'outil dans un agent
Ajoutez l'outil à un agent LangChain en utilisant la propriété tools de UCFunctionToolkit.
Cet exemple crée un agent simple utilisant l'API AgentExecutor de LangChain pour plus de simplicité. Pour les charges de travail de production, utilisez le workflow de création d'agent décrit dans Créer un agent IA et le déployer sur Databricks Apps.
from langchain.agents import AgentExecutor, create_tool_calling_agent
from langchain.prompts import ChatPromptTemplate
from databricks_langchain import (
ChatDatabricks,
UCFunctionToolkit,
)
import mlflow
# Initialize the LLM (replace with your LLM of choice, if desired)
LLM_ENDPOINT_NAME = "databricks-meta-llama-3-3-70b-instruct"
llm = ChatDatabricks(endpoint=LLM_ENDPOINT_NAME, temperature=0.1)
# Define the prompt
prompt = ChatPromptTemplate.from_messages(
[
(
"system",
"You are a helpful assistant. Make sure to use tools for additional functionality.",
),
("placeholder", "{chat_history}"),
("human", "{input}"),
("placeholder", "{agent_scratchpad}"),
]
)
# Enable automatic tracing
mlflow.langchain.autolog()
# Define the agent, specifying the tools from the toolkit above
agent = create_tool_calling_agent(llm, tools, prompt)
# Create the agent executor
agent_executor = AgentExecutor(agent=agent, tools=tools, verbose=True)
agent_executor.invoke({"input": "What is 36939.0 + 8922.4?"})
Utilisez Databricks Unity Catalog pour intégrer des fonctions SQL et Python comme outils dans les workflows LlamaIndex. Cette intégration combine la gouvernance Unity Catalog avec les capacités de LlamaIndex pour indexer et query de grands datasets pour les LLM.
-
Installer le package d’intégration Databricks Unity Catalog pour LlamaIndex.
Python%pip install unitycatalog-llamaindex[databricks]
dbutils.library.restartPython() -
Créez une instance du client des fonctions Unity Catalog.
Pythonfrom unitycatalog.ai.core.base import get_uc_function_client
client = get_uc_function_client() -
Créez une fonction Unity Catalog écrite en Python.
PythonCATALOG = "your_catalog"
SCHEMA = "your_schema"
func_name = f"{CATALOG}.{SCHEMA}.code_function"
def code_function(code: str) -> str:
"""
Runs Python code.
Args:
code (str): The Python code to run.
Returns:
str: The result of running the Python code.
"""
import sys
from io import StringIO
stdout = StringIO()
sys.stdout = stdout
exec(code)
return stdout.getvalue()
client.create_python_function(
func=code_function,
catalog=CATALOG,
schema=SCHEMA,
replace=True
) -
Créez une instance de la fonction Unity Catalog en tant que boîte à outils et exécutez-la pour vérifier que l'outil se comporte correctement.
Pythonfrom unitycatalog.ai.llama_index.toolkit import UCFunctionToolkit
import mlflow
# Enable traces
mlflow.llama_index.autolog()
# Create a UCFunctionToolkit that includes the UC function
toolkit = UCFunctionToolkit(function_names=[func_name])
# Fetch the tools stored in the toolkit
tools = toolkit.tools
python_exec_tool = tools[0]
# Run the tool directly
result = python_exec_tool.call(code="print(1 + 1)")
print(result) # Outputs: {"format": "SCALAR", "value": "2\n"} -
Utilisez l'outil dans un LlamaIndex ReActAgent en définissant la fonction Unity Catalog dans le cadre d'une collection d'outils LlamaIndex. Ensuite, vérifiez que l'agent se comporte correctement en appelant la collection d'outils LlamaIndex.
Pythonfrom llama_index.llms.openai import OpenAI
from llama_index.core.agent import ReActAgent
llm = OpenAI()
agent = ReActAgent.from_tools(tools, llm=llm, verbose=True)
agent.chat("Please run the following python code: `print(1 + 1)`")
Utilisez Databricks Unity Catalog pour intégrer les fonctions SQL et Python en tant qu'outils dans les workflows OpenAI. Cette intégration combine la gouvernance d’Unity Catalog avec OpenAI pour créer de puissantes applications d’IA générative.
-
Installer le package d'intégration Databricks Unity Catalog pour OpenAI.
Python%pip install unitycatalog-openai[databricks]
%pip install mlflow -U
dbutils.library.restartPython() -
Créez une instance du client des fonctions Unity Catalog.
Pythonfrom unitycatalog.ai.core.base import get_uc_function_client
client = get_uc_function_client() -
Créez une fonction Unity Catalog écrite en Python.
PythonCATALOG = "your_catalog"
SCHEMA = "your_schema"
func_name = f"{CATALOG}.{SCHEMA}.code_function"
def code_function(code: str) -> str:
"""
Runs Python code.
Args:
code (str): The python code to run.
Returns:
str: The result of running the Python code.
"""
import sys
from io import StringIO
stdout = StringIO()
sys.stdout = stdout
exec(code)
return stdout.getvalue()
client.create_python_function(
func=code_function,
catalog=CATALOG,
schema=SCHEMA,
replace=True
) -
Créez une instance de la fonction Unity Catalog en tant que boîte à outils et vérifiez que l'outil se comporte correctement en exécutant la fonction.
Pythonfrom unitycatalog.ai.openai.toolkit import UCFunctionToolkit
import mlflow
# Enable tracing
mlflow.openai.autolog()
# Create a UCFunctionToolkit that includes the UC function
toolkit = UCFunctionToolkit(function_names=[func_name])
# Fetch the tools stored in the toolkit
tools = toolkit.tools
client.execute_function = tools[0] -
Soumettez la requête au modèle OpenAI ainsi qu'aux outils.
Pythonimport openai
messages = [
{
"role": "system",
"content": "You are a helpful customer support assistant. Use the supplied tools to assist the user.",
},
{"role": "user", "content": "What is the result of 2**10?"},
]
response = openai.chat.completions.create(
model="gpt-4o-mini",
messages=messages,
tools=tools,
)
# check the model response
print(response) -
Une fois qu'OpenAI a renvoyé une réponse, appelez la fonction Unity Catalog pour générer la réponse à renvoyer à OpenAI.
Pythonimport json
# OpenAI sends only a single request per tool call
tool_call = response.choices[0].message.tool_calls[0]
# Extract arguments that the Unity Catalog function needs to run
arguments = json.loads(tool_call.function.arguments)
# Run the function based on the arguments
result = client.execute_function(func_name, arguments)
print(result.value) -
Une fois la réponse renvoyée, vous pouvez construire la charge utile de la réponse pour les appels ultérieurs à OpenAI.
Python# Create a message containing the result of the function call
function_call_result_message = {
"role": "tool",
"content": json.dumps({"content": result.value}),
"tool_call_id": tool_call.id,
}
assistant_message = response.choices[0].message.to_dict()
completion_payload = {
"model": "gpt-4o-mini",
"messages": [*messages, assistant_message, function_call_result_message],
}
# Generate final response
openai.chat.completions.create(
model=completion_payload["model"], messages=completion_payload["messages"]
)
infrastructures publiques
Pour simplifier le processus de création de la réponse de l'outil, le package ucai-openai dispose d'un utilitaire, generate_tool_call_messages, qui convertit les messages de réponse d'OpenAI ChatCompletion afin qu'ils puissent être utilisés pour la génération de réponses.
from unitycatalog.ai.openai.utils import generate_tool_call_messages
messages = generate_tool_call_messages(response=response, client=client)
print(messages)
Si la réponse contient des entrées à choix multiples, vous pouvez passer l'argument choice_index lors de l'appel à generate_tool_call_messages pour choisir l'entrée à utiliser. Il n'y a actuellement aucune prise en charge pour le traitement des entrées à choix multiples.
Utilisez Databricks Unity Catalog pour intégrer les fonctions SQL et Python en tant qu'outils dans les appels LLM de l'SDK Anthropic. Cette intégration combine la gouvernance de Unity Catalog avec les modèles Anthropic pour créer de puissantes applications d'IA générative.
L'intégration Anthropic nécessite Databricks Runtime 15.0 et versions ultérieures.
-
Installez le package d'intégration Databricks Unity Catalog pour Anthropic.
Python%pip install unitycatalog-anthropic[databricks]
dbutils.library.restartPython() -
Créez une instance du client des fonctions Unity Catalog.
Pythonfrom unitycatalog.ai.core.base import get_uc_function_client
client = get_uc_function_client() -
Créez une fonction Unity Catalog écrite en Python.
PythonCATALOG = "your_catalog"
SCHEMA = "your_schema"
func_name = f"{CATALOG}.{SCHEMA}.weather_function"
def weather_function(location: str) -> str:
"""
Fetches the current weather from a given location in degrees Celsius.
Args:
location (str): The location to fetch the current weather from.
Returns:
str: The current temperature for the location provided in Celsius.
"""
return f"The current temperature for {location} is 24.5 celsius"
client.create_python_function(
func=weather_function,
catalog=CATALOG,
schema=SCHEMA,
replace=True
) -
Créez une instance de la fonction Unity Catalog en tant que boîte à outils.
Pythonfrom unitycatalog.ai.anthropic.toolkit import UCFunctionToolkit
# Create an instance of the toolkit
toolkit = UCFunctionToolkit(function_names=[func_name], client=client) -
Utilisez un appel d'outil dans Anthropic.
Pythonimport anthropic
# Initialize the Anthropic client with your API key
anthropic_client = anthropic.Anthropic(api_key="YOUR_ANTHROPIC_API_KEY")
# User's question
question = [{"role": "user", "content": "What's the weather in New York City?"}]
# Make the initial call to Anthropic
response = anthropic_client.messages.create(
model="claude-3-5-sonnet-20240620", # Specify the model
max_tokens=1024, # Use 'max_tokens' instead of 'max_tokens_to_sample'
tools=toolkit.tools,
messages=question # Provide the conversation history
)
# Print the response content
print(response) -
Construisez une réponse d’outil. La réponse du modèle Claude contient un bloc de métadonnées de demande d'outil si un outil doit être appelé.
Pythonfrom unitycatalog.ai.anthropic.utils import generate_tool_call_messages
# Call the UC function and construct the required formatted response
tool_messages = generate_tool_call_messages(
response=response,
client=client,
conversation_history=question
)
# Continue the conversation with Anthropic
tool_response = anthropic_client.messages.create(
model="claude-3-5-sonnet-20240620",
max_tokens=1024,
tools=toolkit.tools,
messages=tool_messages,
)
print(tool_response)
Le package unitycatalog.ai-anthropic comprend un utilitaire de gestion de messages pour simplifier l'analyse et la gestion d'un appel à la fonction Unity Catalog. L'utilitaire fait ce qui suit :
- Détecte les exigences relatives aux appels d'outils.
- Extrait les informations d'appel d'outil de la query.
- Exécute l'appel à la fonction Unity Catalog.
- Analyse la réponse de la fonction Unity Catalog.
- Élaborez le format du prochain message pour poursuivre la conversation avec Claude.
L'historique complet de la conversation doit être fourni dans l'argument conversation_history pour l'API generate_tool_call_messages. Les modèles Claude nécessitent l'initialisation de la conversation (la question d'entrée de l'utilisateur d'origine) et toutes les réponses générées par le LLM et les résultats des appels d'outils multi-tours.