feat(core): add helpers to make content block shaped dicts #32072
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
CodSpeed WallTime Performance ReportMerging #32072 will not alter performanceComparing
|
CodSpeed Instrumentation Performance ReportMerging #32072 will not alter performanceComparing Summary
|
sydney-runkle
requested changes
Jul 17, 2025
| @@ -69,6 +69,26 @@ class TextContentBlock(TypedDict): | |||
| """Citations and other annotations.""" | |||
|
|
|||
|
|
|||
| def make_text_block( | |||
| text: str, annotations: Optional[list[dict[str, Any]]] = None | |||
| ) -> dict[str, Any]: | |||
There was a problem hiding this comment.
Suggested change
| ) -> dict[str, Any]: | |
| ) -> TextContentBlock: |
| @@ -83,6 +103,22 @@ class ToolCallContentBlock(TypedDict): | |||
| """Tool call ID.""" | |||
|
|
|||
|
|
|||
| def make_tool_call_block( | |||
| tool_call_id: str, | |||
| ) -> dict[str, Any]: | |||
There was a problem hiding this comment.
Suggested change
| ) -> dict[str, Any]: | |
| ) -> ToolCallContentBlock: |
| @@ -93,6 +129,22 @@ class ReasoningContentBlock(TypedDict): | |||
| """Reasoning text.""" | |||
|
|
|||
|
|
|||
| def make_reasoning_block( | |||
| reasoning: Optional[str] = None, | |||
| ) -> dict[str, Any]: | |||
There was a problem hiding this comment.
Suggested change
| ) -> dict[str, Any]: | |
| ) -> ReasoningContentBlock: |
sydney-runkle
approved these changes
Jul 17, 2025
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.
I envision these being used in partner packages to have a standard implementation for making content block dicts that conform to the expected shape that will eventually be needed for casting.
Without these, making the dicts would be more error-prone (e.g. forgetting required fields which might lead to future issues). Additionally, without these we'd need to constantly refer to the TypedDict definitions to remember the exact structure, required keys, and valid type literals for each block. These have intellisense autocomplete.
This also helps maintainability in case the schema of a block changes, e.g. renaming or nesting a key.