feat:Add API endpoint for managing prompt optimization jobs and related classes #147
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 a new API endpoint for managing prompt optimization jobs, allowing for the creation, updating, deletion, and logging of these jobs. Several new classes and enums have been added to support the functionality, including an enumeration for optimization algorithms and schemas for job requests and responses. Additionally, multiple methods have been implemented in the API modules to facilitate these operations, enhancing the system's prompt optimization capabilities. Changes
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 (3)
src/libs/LangSmith/openapi.yaml (3)
Line range hint
10149-10174: New prompt optimization endpoint looks good but needs rate limitingThe new
/api/v1/repos/optimizeendpoint is well-defined with proper request/response schemas. However, since prompt optimization can be computationally intensive, consider adding rate limiting headers to prevent abuse.Consider adding the following rate limiting headers:
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Reset
Line range hint
21967-22024: Security scheme definitions look good but could be enhancedThe security schemes are well defined with:
- API key header
- Bearer token auth
- Tenant/Org ID headers
Consider adding:
- Rate limiting headers as discussed above
- API versioning headers
- More detailed security scheme descriptions
16040-16058: Prompt optimization job request schema needs additional validationThe
OptimizePromptJobRequestschema has required fields but could use additional validation:Consider adding:
- Max length validation for
prompt_name- Schema validation for the
configfield- Enum validation for supported algorithms
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (73)
src/libs/LangSmith/Generated/JsonConverters.EPromptOptimizationAlgorithm.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.EPromptOptimizationAlgorithmNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.EPromptOptimizationJobLogType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.EPromptOptimizationJobLogTypeNullable.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.EPromptOptimizationJobStatus.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/JsonConverters.EPromptOptimizationJobStatusNullable.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.ILangSmithApi.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.CreateJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.CreateLog.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.DeleteJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.DeleteLog.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.GetJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.GetLog.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.ListJobLogs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.ListJobs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.UpdateJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IOptimizationJobsClient.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IReposClient.OptimizePrompt.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.IReposClient.OptimizePromptJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.LangSmithApi.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AppHubCrudOptimizeOptimizePromptResponse.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AppHubCrudOptimizeOptimizePromptResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AppSchemasOptimizePromptResponse.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.AppSchemasOptimizePromptResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DeleteJobApiV1ReposOwnerRepoOptimizationJobsJobIdDeleteResponse.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DeleteJobApiV1ReposOwnerRepoOptimizationJobsJobIdDeleteResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DeleteLogApiV1ReposOwnerRepoOptimizationJobsJobIdLogsLogIdDeleteResponse.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DeleteLogApiV1ReposOwnerRepoOptimizationJobsJobIdLogsLogIdDeleteResponse.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DemoConfig.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DemoConfig.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DemoConfigExample.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DemoConfigExample.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DemoConfigMetaprompt.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.DemoConfigMetaprompt.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.EPromptOptimizationAlgorithm.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.EPromptOptimizationJobLogType.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.EPromptOptimizationJobStatus.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.OptimizePromptJobRequest.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.OptimizePromptJobRequest.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJob.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobCreate.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobCreate.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLog.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLog.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLogCreate.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLogCreate.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLogCreateData.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLogCreateData.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLogData.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobLogData.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobUpdate.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobUpdate.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobWithLogs.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationJobWithLogs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationResult.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptOptimizationResult.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptimConfig.Json.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.Models.PromptimConfig.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.CreateJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.CreateLog.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.DeleteJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.DeleteLog.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.GetJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.GetLog.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.ListJobLogs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.ListJobs.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.UpdateJob.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.OptimizationJobsClient.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.ReposClient.OptimizePrompt.g.csis excluded by!**/generated/**src/libs/LangSmith/Generated/LangSmith.ReposClient.OptimizePromptJob.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/LangSmith/openapi.yaml(8 hunks)
🔇 Additional comments (1)
src/libs/LangSmith/openapi.yaml (1)
14018-14039: Enum values for optimization job status look good
The EPromptOptimizationJobStatus enum properly covers all necessary states for tracking optimization jobs:
- created
- running
- successful
- failed
Comment on lines
+21595
to
+21609
| app__hub__crud__optimize__OptimizePromptResponse: | ||
| title: OptimizePromptResponse | ||
| required: | ||
| - prompt | ||
| - error | ||
| type: object | ||
| properties: | ||
| prompt: | ||
| title: Prompt | ||
| type: string | ||
| error: | ||
| title: Error | ||
| type: string | ||
| nullable: true | ||
| description: Response from optimizing a prompt. |
There was a problem hiding this comment.
Inconsistency in optimization response schemas
There are two different response schemas for prompt optimization:
app__hub__crud__optimize__OptimizePromptResponsereturns the optimized prompt directlyapp__schemas__OptimizePromptResponsereturns just the job ID
This inconsistency could cause confusion. Consider:
- Consolidating into a single response schema
- Or clearly documenting when each is used
- Adding version numbers if both need to be maintained
Also applies to: 21633-21643
This was referenced Dec 4, 2024
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
New Features
Bug Fixes