Skip to content

docs(functions): clarify where invoke metadata reaches code functions #1073

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
Abhijeet Prasad (AbhiPrasad) merged 1 commit into from
Nov 5, 2026
Merged

docs(functions): clarify where invoke metadata reaches code functions #1073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions py/src/braintrust/functions/invoke.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,11 @@ def invoke(
input: The input to the function. This will be logged as the `input` field in the span.
messages: Additional OpenAI-style messages to add to the prompt (only works for llm functions).
metadata: Additional metadata to add to the span. This will be logged as the `metadata` field in the span.
It will also be available as the {{metadata}} field in the prompt and as the `metadata` argument
to the function.
It will also be available as the {{metadata}} field in the prompt. For code functions, it is passed
through the hooks (`hooks.metadata` in Python, the handler's second argument in TypeScript), not
as the handler's `metadata` argument, which is read from `input`. To fill
the handler's `metadata` argument, nest it in `input`, e.g.
`invoke(..., input={"input": ..., "metadata": {...}})`.
tags: Tags to add to the span. This will be logged as the `tags` field in the span.
parent: The parent of the function. This can be an existing span, logger, or experiment, or
the output of `.export()` if you are distributed tracing. If unspecified, will use
Expand Down
Loading