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 API endpoint to populate annotation queue and update RunRulesSchema #157

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Dec 13, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a new API endpoint for populating annotation queues with experiment runs.
    • Added a new field to indicate if a rule is transient in the annotation rules schema.

Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The changes introduce a new API endpoint at /api/v1/annotation-queues/populate, designed to populate an annotation queue with runs from an experiment. Additionally, a new field named transient has been added to the RunRulesSchema and RunRulesCreateSchema models, indicating whether a rule is transient.

Changes

File Path Change Summary
src/libs/LangSmith/openapi.yaml - Added new endpoint: populate_annotation_queue_api_v1_annotation_queues_populate_post(queue_id, session_ids)
- Added transient field in RunRulesSchema and RunRulesCreateSchema

Possibly related PRs

Suggested reviewers

  • github-actions

🐰 In the meadow, where the data flows,
A new endpoint blooms, as the rabbit knows.
With transient rules, we gather and play,
Populating queues in a swift ballet.
Hops of joy for changes made,
In the world of code, our dreams cascade! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 698b8f6 and 3dda6cb.

⛔ Files ignored due to path filters (22)
  • src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.AnnotationQueuesClient.CreateAnnotationQueue.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.AnnotationQueuesClient.PopulateAnnotationQueue.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IAnnotationQueuesClient.CreateAnnotationQueue.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IAnnotationQueuesClient.PopulateAnnotationQueue.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IRunClient.CreateRule.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IRunClient.ListRules.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IRunClient.UpdateRule.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.AnnotationQueueCreateSchema.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.AnnotationQueueSchema.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.AnnotationQueueSchemaWithRubric.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.AnnotationQueueSchemaWithSize.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.OrganizationConfig.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.PopulateAnnotationQueueApiV1AnnotationQueuesPopulatePostResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.PopulateAnnotationQueueApiV1AnnotationQueuesPopulatePostResponse.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.PopulateAnnotationQueueSchema.Json.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.PopulateAnnotationQueueSchema.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.RunRulesCreateSchema.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.RunRulesSchema.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.RunClient.CreateRule.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.RunClient.ListRules.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.RunClient.UpdateRule.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/LangSmith/openapi.yaml (10 hunks)
🔇 Additional comments (3)
src/libs/LangSmith/openapi.yaml (3)

6181-6209: LGTM: New endpoint for populating annotation queues

The new endpoint /api/v1/annotation-queues/populate is well-defined with clear request/response schemas and proper authentication requirements. The endpoint follows REST conventions and has appropriate error handling via 422 validation errors.


18880-18883: LGTM: Added transient flag to run rules schemas

The transient boolean field has been consistently added to both create and base schemas with appropriate defaults. This maintains schema consistency.

Also applies to: 19076-19079


16846-16857: LGTM: New feature flags in organization config

The new boolean feature flags are properly defined with defaults and follow the existing pattern for feature flags in the organization config.


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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 fc01c2c into main Dec 13, 2024
2 of 3 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add API endpoint to populate annotation queue and update RunRulesSchema Dec 13, 2024
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