Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:Add new API endpoints for tracer sessions, datasets, runs, and feedback management #127

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Nov 12, 2024

Summary by CodeRabbit

  • New Features
    • Introduced new API endpoints for creating, updating, and deleting tracer sessions.
    • Added endpoints for querying and filtering datasets, with options for downloading in multiple formats (OpenAI, CSV).
    • Implemented new endpoints for managing runs, including retrieving run statistics and grouping runs.
    • Enhanced feedback management with new endpoints for creating, updating, and deleting feedback, along with managing feedback ingest tokens.

Copy link

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes in this pull request introduce several new API endpoints related to tracer sessions, datasets, runs, and feedback management. Specifically, new functionalities include creating, updating, and deleting tracer sessions; querying and filtering datasets with download options; managing runs with statistics and grouping; and handling feedback operations, including the management of feedback ingest tokens.

Changes

File Change Summary
src/libs/LangSmith/openapi.yaml - Added endpoints for creating, updating, and deleting tracer sessions.
- Introduced endpoints for querying, filtering, and downloading datasets in multiple formats.
- Implemented endpoints for querying and filtering runs, including statistics and grouping.
- Added endpoints for managing feedback, including creation, updates, deletions, and ingest token management.

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

🐰 In the meadow, changes bloom,
New endpoints chase away the gloom.
With datasets and runs in sight,
Feedback flows, oh what a delight!
Tracer sessions dance and play,
Hopping forward, brightening the day! 🌼


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot merged commit def8a9f into main Nov 12, 2024
3 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add new API endpoints for tracer sessions, datasets, runs, and feedback management Nov 12, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
src/libs/LangSmith/openapi.yaml (1)

15726-15728: Document custom_action field usage

The custom_action field's purpose is not clear from its title alone. Consider:

  1. Adding a description field explaining its usage
  2. Documenting valid values or patterns
  3. Adding examples in the schema
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ccc6429 and fa458f4.

⛔ Files ignored due to path filters (4)
  • src/libs/LangSmith/Generated/LangSmith.IPromptsClient.PromptCanvas.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayload.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundPromptCanvasPayloadSecrets.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.PromptsClient.PromptCanvas.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/LangSmith/openapi.yaml (2 hunks)
🔇 Additional comments (2)
src/libs/LangSmith/openapi.yaml (2)

15729-15735: Verify template format implementation completeness

The template_format enum currently supports 'f-string' and 'mustache'. Please verify:

  1. Are these the only supported formats?
  2. Are there plans to support other common formats (e.g., Jinja2)?
#!/bin/bash
# Search for template format implementations
rg -A 5 "template.*format|templat(e|ing)"

# Look for other template engines in dependencies
fd "requirements|setup.py|package.json" --exec cat {} \; | rg "template|jinja|handlebars"

15736-15740: Review security considerations for secrets handling

The secrets object allows arbitrary string properties. Consider:

  1. Adding schema validation for secret names/values
  2. Documenting security best practices
  3. Implementing rate limiting for endpoints using secrets
  4. Adding audit logging for secret usage

@@ -15681,6 +15681,7 @@ components:
required:
- messages
- template_format
- secrets
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

⚠️ Breaking Change: Adding required 'secrets' field

Adding 'secrets' as a required field is a breaking change that will affect existing API clients. Consider:

  1. Making it optional initially
  2. Adding a version flag
  3. Providing migration guidance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant