feat:Add API endpoints for managing tracer sessions, datasets, and examples #118
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
WalkthroughThe changes introduce new API endpoints and methods for managing tracer sessions, datasets, and examples within the LangSmith platform. Key additions include functionalities for creating, updating, and deleting tracer sessions and datasets, as well as querying and filtering tracer sessions. Enhanced capabilities also allow for bulk uploads and validation of examples, significantly expanding the API's features related to these core components. Changes
Possibly related PRs
Suggested reviewers
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 (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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 (1)
src/libs/LangSmith/openapi.yaml (1)
15778-15784: Well-structured message type definitions with comprehensive coverage.The schema correctly handles polymorphic message types and includes both regular and streaming variants.
Consider grouping the regular messages and chunk messages separately for better readability:
items: oneOf: - - $ref: '#/components/schemas/AIMessage' - - $ref: '#/components/schemas/HumanMessage' - - $ref: '#/components/schemas/ChatMessage' - - $ref: '#/components/schemas/SystemMessage' - - $ref: '#/components/schemas/FunctionMessage' - - $ref: '#/components/schemas/ToolMessage' - - $ref: '#/components/schemas/AIMessageChunk' - - $ref: '#/components/schemas/HumanMessageChunk' - - $ref: '#/components/schemas/ChatMessageChunk' - - $ref: '#/components/schemas/SystemMessageChunk' + # Regular messages + - $ref: '#/components/schemas/AIMessage' + - $ref: '#/components/schemas/HumanMessage' + - $ref: '#/components/schemas/ChatMessage' + - $ref: '#/components/schemas/SystemMessage' + - $ref: '#/components/schemas/FunctionMessage' + - $ref: '#/components/schemas/ToolMessage' + # Streaming chunks + - $ref: '#/components/schemas/AIMessageChunk' + - $ref: '#/components/schemas/HumanMessageChunk' + - $ref: '#/components/schemas/ChatMessageChunk' + - $ref: '#/components/schemas/SystemMessageChunk'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (48)
src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkInputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkInputTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkOutputType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.AIMessageChunkOutputTypeNullable.g.csis excluded by!**/generated/**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.MessagesItem.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.MessagesItem2.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseArtifactLengthNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseMessageDiscriminatorTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseReadingLevel.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.PlaygroundPromptCanvasResponseReadingLevelNullable.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.AIMessageChunkInputAdditionalKwargs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkInputContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkInputResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutput.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutputContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutputResponseMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageChunkOutputType.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.AIMessageOutput.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageOutputContentVariant2Item.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AIMessageOutputType.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.CanvasApiV1PromptsCanvasPostResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.MessagesItem.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.MessagesItem2.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseArtifactLength.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseMessageDiscriminator.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseMessageDiscriminatorType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasResponseReadingLevel.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(4 hunks)
🔇 Additional comments (2)
src/libs/LangSmith/openapi.yaml (2)
10349-10351: Verify AIMessage schema completeness.
The schema definition appears to be missing property definitions for the required 'content' field and potentially other important fields that an AI message should contain.
Let's check the complete schema definition:
✅ Verification successful
AIMessage schema is properly defined
The schema is complete and well-structured with:
- Required 'content' field properly defined with support for both string and array types
- Additional fields for 'additional_kwargs' and 'response_metadata'
- Type field included
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the complete AIMessage schema definition
# Expected: Should find property definitions including 'content' and other message fields
rg -A 20 "AIMessage:\n.*title: AIMessage" src/libs/LangSmith/openapi.yaml
Length of output: 267
Script:
#!/bin/bash
# Description: Verify the complete AIMessage schema definition using multiline mode
# Expected: Should find property definitions including 'content' and other message fields
rg -U -A 20 "AIMessage:\n\s+title: AIMessage" src/libs/LangSmith/openapi.yaml
Length of output: 594
10401-10403: Verify AIMessageChunk relationship with AIMessage.
Since AIMessageChunk appears to be a streaming variant of AIMessage, consider whether they should share common schema definitions to ensure consistency.
Let's check the relationship between these schemas:
✅ Verification successful
AIMessageChunk correctly mirrors AIMessage schema structure
The verification shows that AIMessageChunk and AIMessage share identical schema structure with the same required fields and property definitions:
- Both require 'content' field
- Both have identical property definitions for content, additional_kwargs, response_metadata, and type
- Content field in both schemas supports either string or array of strings/objects
This consistency ensures proper handling of both complete messages and streaming chunks.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Compare AIMessage and AIMessageChunk schemas
# Expected: Should find similar structure with potential differences for streaming
rg -B 5 -A 20 "AIMessageChunk:\n.*title: AIMessageChunk" src/libs/LangSmith/openapi.yaml
Length of output: 282
Script:
#!/bin/bash
# Description: Compare AIMessage and AIMessageChunk schemas using multiline mode
# Expected: Should find similar structure with potential differences for streaming
rg -U -B 5 -A 20 'AIMessageChunk:.*\n.*title: AIMessageChunk' src/libs/LangSmith/openapi.yaml
# Also search for AIMessage schema for comparison
rg -U -B 5 -A 20 'AIMessage:.*\n.*title: AIMessage[^C]' src/libs/LangSmith/openapi.yaml
Length of output: 1794
| @@ -7481,8 +7481,7 @@ paths: | |||
| description: Successful Response | |||
| content: | |||
| application/json: | |||
| schema: | |||
| $ref: '#/components/schemas/PlaygroundPromptCanvasResponse' | |||
| schema: { } | |||
There was a problem hiding this comment.
Empty response schema should be defined explicitly.
An empty schema provides no validation or documentation value. This could lead to inconsistent API responses and poor developer experience.
Consider defining the expected response structure explicitly:
- schema: { }
+ schema:
+ type: object
+ description: "Successful response payload"
+ properties: {}📝 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
| schema: { } | |
| schema: | |
| type: object | |
| description: "Successful response payload" | |
| properties: {} |
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