Skip to content
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.

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

Docs for logging schema-based tool calls in Python #397

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_position: 9
Copy link
Author

Choose a reason for hiding this comment

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

Not sure which position is best. This is the same number as the retriever tracing page.

---

import {
CodeTabs,
PythonBlock,
} from "@site/src/components/InstructionsWithCode";

# Log schema-based tool call traces

If you want to log tool calls but your tools are not real functions but tool names in a schema dictionary or JSON, then trace it with `langsmith.trace` at the point where your tool is executed or chosen.

Wrap the tool call result (or tool execution part) with `async with langsmith.trace(name=chosen_tool, inputs=chosen_tool["args"], run_type="tool"):`.

The following code snippets show how to log a schema-based tool call in Python.

<CodeTabs
tools = [
{
"type": "function",
"function": {
"name": "get_weather_in_ottawa",
"description": "Get the weather in Ottawa, Canada in Celsius.",
},
},
{
"type": "function",
"function": {
"name": "get_stock_price",
"description": "Get the stock price of Nortel Networks.",
},
}
],
/>

Because these are just schemas for tools and not real functions, we log the result of a tool call after the tool is chosen / executed.

<CodeTabs
async with langsmith.trace(name=msg.tool_calls[0]["get_weather_in_ottawa"], inputs=msg.tool_calls[0]["args"}):
# run get_weather_in_ottawa()
/>