Repository navigation
docs(functions): clarify where invoke metadata reaches code functions - #2731
Merged
Abhijeet Prasad (AbhiPrasad) merged 1 commit intoNov 5, 2026
Merged
Conversation
> 🤖 **This text was AI-generated.**
The `invoke()` docstring said top-level `metadata` is passed to the function
as its `metadata` argument. That is true for prompts (`{{metadata}}`), but not
for code functions. The runtime sends top-level `metadata` as hook data, and a
Python handler's `metadata` argument is only filled from `input`:
```typescript
await invoke({ ..., input: { input: "x" }, metadata: { marker: "top" } });
```
```python
def handler(input=None, metadata=None, hooks=None):
metadata # None
hooks.metadata # {"marker": "top"}
```
A customer's scorer therefore saw an empty `metadata` argument on every row.
The docstring now explains that code functions receive top-level metadata
through the hooks (the second handler argument in TypeScript,
`hooks.metadata` in Python), and shows how to fill the `metadata` argument
by nesting it in `input`:
```typescript
await invoke({ ..., input: { input: "x", metadata: { marker: "nested" } } });
```
The runtime behaviour is unchanged. The same wrong sentence also appears in
the generated `js/src/generated_plain_types.ts`. It comes from the backend
typespec (`typespecs/src/functions.ts`) and needs fixing there, then
regenerating.
Mirrors braintrustdata/braintrust-sdk-python#1073.
Refs: SDK-791
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Luca Forstner (lforst)
approved these changes
Nov 5, 2026
Abhijeet Prasad (AbhiPrasad)
deleted the
fix-docstring-sdk-pr-1073-fd521c93
branch
November 5, 2026 16:46
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
invoke()docstring said top-levelmetadatais passed to the function as itsmetadataargument. That is true for prompts ({{metadata}}), but not for code functions. The runtime sends top-levelmetadataas hook data, and a Python handler'smetadataargument is only filled frominput:A customer's scorer therefore saw an empty
metadataargument on every row.The docstring now explains that code functions receive top-level metadata through the hooks (the second handler argument in TypeScript,
hooks.metadatain Python), and shows how to fill themetadataargument by nesting it ininput:The runtime behaviour is unchanged. The same wrong sentence also appears in the generated
js/src/generated_plain_types.ts. It comes from the backend typespec (typespecs/src/functions.ts) and needs fixing there, then regenerating.Mirrors braintrustdata/braintrust-sdk-python#1073.
Refs: SDK-791