-
Notifications
You must be signed in to change notification settings - Fork 39
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
trancethehuman
wants to merge
4
commits into
langchain-ai:main
Choose a base branch
from
trancethehuman:trace-tool-call-schema
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
43 changes: 43 additions & 0 deletions
43
versioned_docs/version-2.0/how_to_guides/tracing/log_tool_call_traces.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
sidebar_position: 9 | ||
--- | ||
|
||
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() | ||
/> | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.