feat:Add new API endpoints for managing tracer sessions, datasets, and examples#116
Merged
github-actions[bot] merged 1 commit intomainfrom Oct 31, 2024
Merged
Conversation
WalkthroughThe pull request introduces multiple new API endpoints in the LangSmith platform, enhancing the management of tracer sessions, datasets, and examples. Key additions include endpoints for creating, updating, and deleting tracer sessions, as well as functionalities for managing datasets and examples, including bulk uploads and validation. The method signatures for existing endpoints have also been updated to accommodate new parameters. 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: 2
🧹 Outside diff range and nitpick comments (1)
src/libs/LangSmith/openapi.yaml (1)
2379-2408: Consider adding rate limiting and content validation.The validation endpoint is well-structured with proper security and error handling. However, consider these improvements:
- Add rate limiting headers to prevent abuse:
responses: '200': headers: X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer
- Add explicit content-type validation:
requestBody: content: application/json: schema: $ref: '#/components/schemas/ExampleCreate' required: true x-content-type-validation: true
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (11)
src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.ExamplesClient.UpdateExample.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.ExamplesClient.ValidateExample.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IExamplesClient.UpdateExample.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IExamplesClient.ValidateExample.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ExampleUpdate.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ExampleUpdateWithID.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ExampleValidationResult.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ExampleValidationResultInputs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ExampleValidationResultMetadata.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.ExampleValidationResultOutputs.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/LangSmith/openapi.yaml(3 hunks)
Comment on lines
+13377
to
+13430
| ExampleValidationResult: | ||
| title: ExampleValidationResult | ||
| type: object | ||
| properties: | ||
| dataset_id: | ||
| title: Dataset Id | ||
| type: string | ||
| format: uuid | ||
| nullable: true | ||
| inputs: | ||
| title: Inputs | ||
| type: object | ||
| nullable: true | ||
| outputs: | ||
| title: Outputs | ||
| type: object | ||
| nullable: true | ||
| created_at: | ||
| title: Created At | ||
| type: string | ||
| format: date-time | ||
| nullable: true | ||
| metadata: | ||
| title: Metadata | ||
| type: object | ||
| nullable: true | ||
| source_run_id: | ||
| title: Source Run Id | ||
| type: string | ||
| format: uuid | ||
| nullable: true | ||
| split: | ||
| title: Split | ||
| anyOf: | ||
| - type: array | ||
| items: | ||
| type: string | ||
| - type: string | ||
| default: base | ||
| nullable: true | ||
| id: | ||
| title: Id | ||
| type: string | ||
| format: uuid | ||
| nullable: true | ||
| use_source_run_io: | ||
| title: Use Source Run Io | ||
| type: boolean | ||
| default: false | ||
| overwrite: | ||
| title: Overwrite | ||
| type: boolean | ||
| default: false | ||
| description: 'Validation result for Example, combining fields from Create/Base/Update schemas.' |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider schema improvements for better type safety.
The ExampleValidationResult schema is comprehensive but could benefit from these improvements:
- Add constraints to the metadata object:
metadata:
title: Metadata
type: object
additionalProperties: true
maxProperties: 50 # Prevent excessive metadata
propertyNames:
pattern: '^[a-zA-Z0-9_-]+$' # Restrict key names- Simplify the split field definition:
split:
title: Split
type: string
default: base
nullable: true
enum: [base, train, test, validation] # If these are the expected values
Comment on lines
+13332
to
+13335
| overwrite: | ||
| title: Overwrite | ||
| type: boolean | ||
| default: false |
There was a problem hiding this comment.
💡 Codebase verification
Overwrite parameter needs documentation and description
The overwrite field appears in multiple schemas (Example update schemas) but lacks a proper description of its behavior. While the default false value suggests backward compatibility:
- The field is missing a
descriptionproperty in the OpenAPI spec to explain its purpose and effects - No documentation found explaining the overwrite behavior to API consumers
- The field appears to be part of example update operations, with the API tracking number of updated examples via
X-Updated-Examples-Countheader
🔗 Analysis chain
Verify overwrite behavior implications.
The new overwrite field looks well-defined, but please ensure:
- The default
falsevalue maintains backward compatibility - The overwrite behavior is properly documented in the API docs
- Existing clients are prepared for this change
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if overwrite behavior is documented
rg -l "overwrite.*example" --type md
# Look for existing example update implementations
ast-grep --pattern 'update.*example.*overwrite'
Length of output: 88
Script:
#!/bin/bash
# Search for any documentation about overwrite in markdown files with broader pattern
rg -i "overwrite" --type md -C 2
# Look for example update related code with broader patterns
rg "example.*update" -C 3
# Check for any existing overwrite parameters in the OpenAPI spec
rg "overwrite" --type yaml -C 2
Length of output: 1399
Script:
#!/bin/bash
# Get more context around the example update API endpoint
rg -B 10 -A 10 "X-Updated-Examples-Count" src/libs/LangSmith/openapi.yaml
# Look for any description or documentation of the overwrite parameter
rg -B 5 -A 5 "title: Overwrite" src/libs/LangSmith/openapi.yaml
Length of output: 1679
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
1 participant
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
These enhancements improve the management capabilities for tracer sessions, datasets, and examples within the LangSmith platform.