feat:Update openapi.yaml with new endpoints and schema modifications for LangSmith #113
Conversation
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
WalkthroughThe changes in this pull request primarily involve updates to the Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
src/libs/LangSmith/openapi.yaml (2)
7390-7390: Add documentation for the Canvas endpoint.The endpoint's purpose and expected behavior should be documented to help API consumers understand its usage.
Add a description field to the operation:
operationId: canvas_api_v1_prompts_canvas_post +description: "Endpoint for processing and optimizing prompts using the Canvas feature. This endpoint accepts a PlayGroundGraph containing messages and artifacts, and returns the processed results." requestBody:
15611-15664: Add descriptions for enum values.The
artifact_lengthandreading_levelenums would benefit from descriptions explaining the implications of each value.Add descriptions for the enum values:
artifact_length: title: Artifact Length enum: - shortest - short - long - longest type: string nullable: true + description: | + Controls the length of the generated artifact: + * shortest - Minimal length output + * short - Concise output + * long - Detailed output + * longest - Comprehensive output reading_level: title: Reading Level enum: - child - teenager - college - phd type: string nullable: true + description: | + Controls the complexity of the generated content: + * child - Simple language suitable for children + * teenager - Language suitable for teenagers + * college - College-level complexity + * phd - Advanced academic level
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (128)
src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ChatMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ChatMessageChunkTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ChatMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ChatMessageTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.FunctionMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.FunctionMessageChunkTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.FunctionMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.FunctionMessageTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.HumanMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.HumanMessageChunkTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.HumanMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.HumanMessageTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.InvalidToolCallType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.InvalidToolCallTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.MessagesItem.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlayGroundGraphArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlayGroundGraphArtifactLengthNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlayGroundGraphMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlayGroundGraphMessageDiscriminatorTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlayGroundGraphReadingLevel.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlayGroundGraphReadingLevelNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.SystemMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.SystemMessageChunkTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.SystemMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.SystemMessageTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolCallChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolCallChunkTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolCallType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolCallTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageChunkStatus.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageChunkStatusNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageChunkTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageStatus.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageStatusNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.ToolMessageTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IPromptsClient.Canvas.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessage.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunk.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.Artifact.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ArtifactContent.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessage.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageChunk.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageChunkAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageChunkContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageChunkResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ChatMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessage.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageChunk.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageChunkAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageChunkContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageChunkResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.FunctionMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.Highlight.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessage.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageChunk.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageChunkAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageChunkContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageChunkResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.HumanMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.InputTokenDetails.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.InvalidToolCall.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.InvalidToolCallType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.MessagesItem.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.OutputTokenDetails.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlayGroundGraph.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlayGroundGraphArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlayGroundGraphMessageDiscriminator.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlayGroundGraphMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlayGroundGraphReadingLevel.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessage.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageChunk.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageChunkAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageChunkContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageChunkResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.SystemMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolCall.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolCallArgs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolCallChunk.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolCallChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolCallType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessage.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageArtifact.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageChunk.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageChunkAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageChunkArtifact.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageChunkContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageChunkResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageChunkStatus.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageChunkType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageStatus.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ToolMessageType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.UsageMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.PromptsClient.Canvas.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
- src/libs/LangSmith/openapi.yaml (12 hunks)
🔇 Additional comments (2)
src/libs/LangSmith/openapi.yaml (2)
10262-10313: LGTM! Well-structured message schemas.The message type schemas are well-designed with:
- Consistent structure across different message types
- Proper validation through required fields
- Comprehensive documentation with examples
- Support for both string and structured content
Also applies to: 14169-14248, 18607-18678
14366-14379: LGTM! Comprehensive token usage tracking.The token usage schemas provide:
- Detailed breakdown of token usage
- Flexibility for different types of token counting
- Clear documentation with examples
- Version tracking for schema changes
Also applies to: 15453-15463, 19920-19941
Comment on lines
+19358
to
+19510
| type: string | ||
| description: "A chunk of a tool call (e.g., as part of a stream).\n\nWhen merging ToolCallChunks (e.g., via AIMessageChunk.__add__),\nall string attributes are concatenated. Chunks are only merged if their\nvalues of `index` are equal and not None.\n\nExample:\n\n.. code-block:: python\n\n left_chunks = [ToolCallChunk(name=\"foo\", args='{\"a\":', index=0)]\n right_chunks = [ToolCallChunk(name=None, args='1}', index=0)]\n\n (\n AIMessageChunk(content=\"\", tool_call_chunks=left_chunks)\n + AIMessageChunk(content=\"\", tool_call_chunks=right_chunks)\n ).tool_call_chunks == [ToolCallChunk(name='foo', args='{\"a\":1}', index=0)]" | ||
| ToolMessage: | ||
| title: ToolMessage | ||
| required: | ||
| - content | ||
| - tool_call_id | ||
| type: object | ||
| properties: | ||
| content: | ||
| title: Content | ||
| anyOf: | ||
| - type: string | ||
| - type: array | ||
| items: | ||
| anyOf: | ||
| - type: string | ||
| - type: object | ||
| additional_kwargs: | ||
| title: Additional Kwargs | ||
| type: object | ||
| response_metadata: | ||
| title: Response Metadata | ||
| type: object | ||
| type: | ||
| title: Type | ||
| enum: | ||
| - tool | ||
| type: string | ||
| default: tool | ||
| name: | ||
| title: Name | ||
| type: string | ||
| nullable: true | ||
| id: | ||
| title: Id | ||
| type: string | ||
| nullable: true | ||
| tool_call_id: | ||
| title: Tool Call Id | ||
| type: string | ||
| artifact: | ||
| title: Artifact | ||
| status: | ||
| title: Status | ||
| enum: | ||
| - success | ||
| - error | ||
| type: string | ||
| default: success | ||
| description: "Message for passing the result of executing a tool back to a model.\n\nToolMessages contain the result of a tool invocation. Typically, the result\nis encoded inside the `content` field.\n\nExample: A ToolMessage representing a result of 42 from a tool call with id\n\n .. code-block:: python\n\n from langchain_core.messages import ToolMessage\n\n ToolMessage(content='42', tool_call_id='call_Jja7J89XsjrOLA5r!MEOW!SL')\n\n\nExample: A ToolMessage where only part of the tool output is sent to the model\n and the full output is passed in to artifact.\n\n .. versionadded:: 0.2.17\n\n .. code-block:: python\n\n from langchain_core.messages import ToolMessage\n\n tool_output = {\n \"stdout\": \"From the graph we can see that the correlation between x and y is ...\",\n \"stderr\": None,\n \"artifacts\": {\"type\": \"image\", \"base64_data\": \"/9j/4gIcSU...\"},\n }\n\n ToolMessage(\n content=tool_output[\"stdout\"],\n artifact=tool_output,\n tool_call_id='call_Jja7J89XsjrOLA5r!MEOW!SL',\n )\n\nThe tool_call_id field is used to associate the tool call request with the\ntool call response. This is useful in situations where a chat model is able\nto request multiple tool calls in parallel." | ||
| ToolMessageChunk: | ||
| title: ToolMessageChunk | ||
| required: | ||
| - content | ||
| - tool_call_id | ||
| type: object | ||
| properties: | ||
| content: | ||
| title: Content | ||
| anyOf: | ||
| - type: string | ||
| - type: array | ||
| items: | ||
| anyOf: | ||
| - type: string | ||
| - type: object | ||
| additional_kwargs: | ||
| title: Additional Kwargs | ||
| type: object | ||
| response_metadata: | ||
| title: Response Metadata | ||
| type: object | ||
| type: | ||
| title: Type | ||
| enum: | ||
| - ToolMessageChunk | ||
| type: string | ||
| default: ToolMessageChunk | ||
| name: | ||
| title: Name | ||
| type: string | ||
| nullable: true | ||
| id: | ||
| title: Id | ||
| type: string | ||
| nullable: true | ||
| tool_call_id: | ||
| title: Tool Call Id | ||
| type: string | ||
| artifact: | ||
| title: Artifact | ||
| status: | ||
| title: Status | ||
| enum: | ||
| - success | ||
| - error | ||
| type: string | ||
| default: success | ||
| description: Tool Message chunk. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider adding JSON schema validation for tool arguments.
While the tool-related schemas are well-designed, the args field in ToolCall could benefit from additional validation to ensure it contains valid JSON.
Consider updating the args field definition:
args:
title: Args
type: object
+ additionalProperties: true
+ description: "JSON object containing the arguments for the tool call. Must be valid JSON."📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ToolCall: | |
| title: ToolCall | |
| required: | |
| - name | |
| - args | |
| - id | |
| type: object | |
| properties: | |
| name: | |
| title: Name | |
| type: string | |
| args: | |
| title: Args | |
| type: object | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| type: | |
| title: Type | |
| enum: | |
| - tool_call | |
| type: string | |
| description: "Represents a request to call a tool.\n\nExample:\n\n .. code-block:: python\n\n {\n \"name\": \"foo\",\n \"args\": {\"a\": 1},\n \"id\": \"123\"\n }\n\n This represents a request to call the tool named \"foo\" with arguments {\"a\": 1}\n and an identifier of \"123\"." | |
| ToolCallChunk: | |
| title: ToolCallChunk | |
| required: | |
| - name | |
| - args | |
| - id | |
| - index | |
| type: object | |
| properties: | |
| name: | |
| title: Name | |
| type: string | |
| nullable: true | |
| args: | |
| title: Args | |
| type: string | |
| nullable: true | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| index: | |
| title: Index | |
| type: integer | |
| nullable: true | |
| type: | |
| title: Type | |
| enum: | |
| - tool_call_chunk | |
| type: string | |
| description: "A chunk of a tool call (e.g., as part of a stream).\n\nWhen merging ToolCallChunks (e.g., via AIMessageChunk.__add__),\nall string attributes are concatenated. Chunks are only merged if their\nvalues of `index` are equal and not None.\n\nExample:\n\n.. code-block:: python\n\n left_chunks = [ToolCallChunk(name=\"foo\", args='{\"a\":', index=0)]\n right_chunks = [ToolCallChunk(name=None, args='1}', index=0)]\n\n (\n AIMessageChunk(content=\"\", tool_call_chunks=left_chunks)\n + AIMessageChunk(content=\"\", tool_call_chunks=right_chunks)\n ).tool_call_chunks == [ToolCallChunk(name='foo', args='{\"a\":1}', index=0)]" | |
| ToolMessage: | |
| title: ToolMessage | |
| required: | |
| - content | |
| - tool_call_id | |
| type: object | |
| properties: | |
| content: | |
| title: Content | |
| anyOf: | |
| - type: string | |
| - type: array | |
| items: | |
| anyOf: | |
| - type: string | |
| - type: object | |
| additional_kwargs: | |
| title: Additional Kwargs | |
| type: object | |
| response_metadata: | |
| title: Response Metadata | |
| type: object | |
| type: | |
| title: Type | |
| enum: | |
| - tool | |
| type: string | |
| default: tool | |
| name: | |
| title: Name | |
| type: string | |
| nullable: true | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| tool_call_id: | |
| title: Tool Call Id | |
| type: string | |
| artifact: | |
| title: Artifact | |
| status: | |
| title: Status | |
| enum: | |
| - success | |
| - error | |
| type: string | |
| default: success | |
| description: "Message for passing the result of executing a tool back to a model.\n\nToolMessages contain the result of a tool invocation. Typically, the result\nis encoded inside the `content` field.\n\nExample: A ToolMessage representing a result of 42 from a tool call with id\n\n .. code-block:: python\n\n from langchain_core.messages import ToolMessage\n\n ToolMessage(content='42', tool_call_id='call_Jja7J89XsjrOLA5r!MEOW!SL')\n\n\nExample: A ToolMessage where only part of the tool output is sent to the model\n and the full output is passed in to artifact.\n\n .. versionadded:: 0.2.17\n\n .. code-block:: python\n\n from langchain_core.messages import ToolMessage\n\n tool_output = {\n \"stdout\": \"From the graph we can see that the correlation between x and y is ...\",\n \"stderr\": None,\n \"artifacts\": {\"type\": \"image\", \"base64_data\": \"/9j/4gIcSU...\"},\n }\n\n ToolMessage(\n content=tool_output[\"stdout\"],\n artifact=tool_output,\n tool_call_id='call_Jja7J89XsjrOLA5r!MEOW!SL',\n )\n\nThe tool_call_id field is used to associate the tool call request with the\ntool call response. This is useful in situations where a chat model is able\nto request multiple tool calls in parallel." | |
| ToolMessageChunk: | |
| title: ToolMessageChunk | |
| required: | |
| - content | |
| - tool_call_id | |
| type: object | |
| properties: | |
| content: | |
| title: Content | |
| anyOf: | |
| - type: string | |
| - type: array | |
| items: | |
| anyOf: | |
| - type: string | |
| - type: object | |
| additional_kwargs: | |
| title: Additional Kwargs | |
| type: object | |
| response_metadata: | |
| title: Response Metadata | |
| type: object | |
| type: | |
| title: Type | |
| enum: | |
| - ToolMessageChunk | |
| type: string | |
| default: ToolMessageChunk | |
| name: | |
| title: Name | |
| type: string | |
| nullable: true | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| tool_call_id: | |
| title: Tool Call Id | |
| type: string | |
| artifact: | |
| title: Artifact | |
| status: | |
| title: Status | |
| enum: | |
| - success | |
| - error | |
| type: string | |
| default: success | |
| description: Tool Message chunk. | |
| ToolCall: | |
| title: ToolCall | |
| required: | |
| - name | |
| - args | |
| - id | |
| type: object | |
| properties: | |
| name: | |
| title: Name | |
| type: string | |
| args: | |
| title: Args | |
| type: object | |
| additionalProperties: true | |
| description: "JSON object containing the arguments for the tool call. Must be valid JSON." | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| type: | |
| title: Type | |
| enum: | |
| - tool_call | |
| type: string | |
| description: "Represents a request to call a tool.\n\nExample:\n\n .. code-block:: python\n\n {\n \"name\": \"foo\",\n \"args\": {\"a\": 1},\n \"id\": \"123\"\n }\n\n This represents a request to call the tool named \"foo\" with arguments {\"a\": 1}\n and an identifier of \"123\"." | |
| ToolCallChunk: | |
| title: ToolCallChunk | |
| required: | |
| - name | |
| - args | |
| - id | |
| - index | |
| type: object | |
| properties: | |
| name: | |
| title: Name | |
| type: string | |
| nullable: true | |
| args: | |
| title: Args | |
| type: string | |
| nullable: true | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| index: | |
| title: Index | |
| type: integer | |
| nullable: true | |
| type: | |
| title: Type | |
| enum: | |
| - tool_call_chunk | |
| type: string | |
| description: "A chunk of a tool call (e.g., as part of a stream).\n\nWhen merging ToolCallChunks (e.g., via AIMessageChunk.__add__),\nall string attributes are concatenated. Chunks are only merged if their\nvalues of `index` are equal and not None.\n\nExample:\n\n.. code-block:: python\n\n left_chunks = [ToolCallChunk(name=\"foo\", args='{\"a\":', index=0)]\n right_chunks = [ToolCallChunk(name=None, args='1}', index=0)]\n\n (\n AIMessageChunk(content=\"\", tool_call_chunks=left_chunks)\n + AIMessageChunk(content=\"\", tool_call_chunks=right_chunks)\n ).tool_call_chunks == [ToolCallChunk(name='foo', args='{\"a\":1}', index=0)]" | |
| ToolMessage: | |
| title: ToolMessage | |
| required: | |
| - content | |
| - tool_call_id | |
| type: object | |
| properties: | |
| content: | |
| title: Content | |
| anyOf: | |
| - type: string | |
| - type: array | |
| items: | |
| anyOf: | |
| - type: string | |
| - type: object | |
| additional_kwargs: | |
| title: Additional Kwargs | |
| type: object | |
| response_metadata: | |
| title: Response Metadata | |
| type: object | |
| type: | |
| title: Type | |
| enum: | |
| - tool | |
| type: string | |
| default: tool | |
| name: | |
| title: Name | |
| type: string | |
| nullable: true | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| tool_call_id: | |
| title: Tool Call Id | |
| type: string | |
| artifact: | |
| title: Artifact | |
| status: | |
| title: Status | |
| enum: | |
| - success | |
| - error | |
| type: string | |
| default: success | |
| description: "Message for passing the result of executing a tool back to a model.\n\nToolMessages contain the result of a tool invocation. Typically, the result\nis encoded inside the `content` field.\n\nExample: A ToolMessage representing a result of 42 from a tool call with id\n\n .. code-block:: python\n\n from langchain_core.messages import ToolMessage\n\n ToolMessage(content='42', tool_call_id='call_Jja7J89XsjrOLA5r!MEOW!SL')\n\n\nExample: A ToolMessage where only part of the tool output is sent to the model\n and the full output is passed in to artifact.\n\n .. versionadded:: 0.2.17\n\n .. code-block:: python\n\n from langchain_core.messages import ToolMessage\n\n tool_output = {\n \"stdout\": \"From the graph we can see that the correlation between x and y is ...\",\n \"stderr\": None,\n \"artifacts\": {\"type\": \"image\", \"base64_data\": \"/9j/4gIcSU...\"},\n }\n\n ToolMessage(\n content=tool_output[\"stdout\"],\n artifact=tool_output,\n tool_call_id='call_Jja7J89XsjrOLA5r!MEOW!SL',\n )\n\nThe tool_call_id field is used to associate the tool call request with the\ntool call response. This is useful in situations where a chat model is able\nto request multiple tool calls in parallel." | |
| ToolMessageChunk: | |
| title: ToolMessageChunk | |
| required: | |
| - content | |
| - tool_call_id | |
| type: object | |
| properties: | |
| content: | |
| title: Content | |
| anyOf: | |
| - type: string | |
| - type: array | |
| items: | |
| anyOf: | |
| - type: string | |
| - type: object | |
| additional_kwargs: | |
| title: Additional Kwargs | |
| type: object | |
| response_metadata: | |
| title: Response Metadata | |
| type: object | |
| type: | |
| title: Type | |
| enum: | |
| - ToolMessageChunk | |
| type: string | |
| default: ToolMessageChunk | |
| name: | |
| title: Name | |
| type: string | |
| nullable: true | |
| id: | |
| title: Id | |
| type: string | |
| nullable: true | |
| tool_call_id: | |
| title: Tool Call Id | |
| type: string | |
| artifact: | |
| title: Artifact | |
| status: | |
| title: Status | |
| enum: | |
| - success | |
| - error | |
| type: string | |
| default: success | |
| description: Tool Message chunk. |
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.
Summary by CodeRabbit
New Features
Improvements
Miscellaneous