feat:Add new API endpoint for enhancing prompts at /api/v1/prompts/canvas

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new API endpoint /api/v1/prompts/canvas for prompt improvement based on user instructions.

• Documentation

  • Updated API documentation to reflect the new endpoint and its request/response structure.

[coderabbitai]

Walkthrough

The changes introduce a new API endpoint at /api/v1/prompts/canvas, designed to enhance prompts based on specific instructions. This endpoint accepts a request body defined by the PlaygroundOptimizePromptRequestSchema, which includes the prompt, improvement instruction, and template format. The response for this endpoint is an empty object. Additionally, a method for handling this endpoint has been added to the LangSmithAPI class.

Changes

File Path	Change Summary
src/libs/LangSmith/openapi.yaml	Added new endpoint /api/v1/prompts/canvas with method canvas_api_v1_prompts_canvas_post to handle prompt optimization requests.

Possibly related PRs

• feat:Title: Update documentation for API endpoints and usage examples #73: This PR involves the removal of several API endpoints, which may relate to the overall structure and organization of the API, including the new endpoint introduced in the main PR.
• feat:Add API endpoints for managing tracer sessions and filter views #101: Although this PR focuses on managing tracer sessions, it also modifies the API endpoints in the same file, which could have implications for the new endpoint added in the main PR.

Suggested reviewers

• github-actions

Poem

In the garden of code, a new path we see,
/api/v1/prompts/canvas, oh what glee!
With prompts to improve, and instructions to share,
A hop and a skip, we’re light as the air.
Let’s celebrate changes, with joy and delight,
A canvas of prompts, shining so bright! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/libs/LangSmith/openapi.yaml (1)

15170-15194: Consider adding validation constraints to the schema.

The PlaygroundOptimizePromptRequestSchema could benefit from additional validation:

1. Add length constraints for the prompt and improvement_instruction fields to prevent extremely large inputs
2. Add pattern validation for template_format to ensure consistent casing
3. Add range validation for highlight_start and highlight_end to ensure they are non-negative and highlight_end > highlight_start

Apply these changes to improve input validation:

 PlaygroundOptimizePromptRequestSchema:
   title: PlaygroundOptimizePromptRequestSchema
   required:
     - prompt
     - improvement_instruction
     - template_format
   type: object
   properties:
     prompt:
       title: Prompt
       type: string
+      maxLength: 32768
+      minLength: 1
     highlight_start:
       title: Highlight Start
       type: integer
+      minimum: 0
       nullable: true
     highlight_end:
       title: Highlight End
       type: integer
+      minimum: 0
       nullable: true
     improvement_instruction:
       title: Improvement Instruction
       type: string
+      maxLength: 1024
+      minLength: 1
     template_format:
       title: Template Format
       enum:
         - f-string
         - mustache
       type: string
+      pattern: "^[a-z-]+$"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 771120b and 578b213.

⛔ Files ignored due to path filters (15)

• src/libs/LangSmith/Generated/JsonConverters.PlaygroundOptimizePromptRequestSchemaTemplateFormat.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonConverters.PlaygroundOptimizePromptRequestSchemaTemplateFormatNullable.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.FeedbackClient.CreateFeedback.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.FeedbackClient.EagerlyCreateFeedback.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IFeedbackClient.CreateFeedback.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IFeedbackClient.EagerlyCreateFeedback.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPromptsClient.Canvas.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.CanvasApiV1PromptsCanvasPostResponse.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.FeedbackCreateSchema.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.PlaygroundOptimizePromptRequestSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundOptimizePromptRequestSchemaTemplateFormat.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PromptsClient.Canvas.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/LangSmith/openapi.yaml (4 hunks)

🔇 Additional comments (1)

src/libs/LangSmith/openapi.yaml (1)

7380-7408: LGTM! The new canvas endpoint is well-defined.

The endpoint is properly secured and follows RESTful conventions with appropriate request/response schemas.