feat:Update OpenAPI Specification for AI21 Studio API with Schema Changes #73
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 pull request introduces significant updates to the OpenAPI specification for the AI21 Studio API. It removes multiple endpoints associated with the j2 model series and modifies the Changes
Possibly related PRs
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: 0
🧹 Outside diff range and nitpick comments (1)
src/libs/AI21/openapi.yaml (1)
1034-1112: Add schema validations for numeric parameters.The schema is well-structured with comprehensive properties. However, consider adding schema-level validations for numeric parameters to enforce the documented ranges:
temperature: Add range validation for 0.0-2.0max_tokens: Add range validation for 0-4096Apply this diff to add the validations:
temperature: title: Temperature type: number + minimum: 0.0 + maximum: 2.0 description: "How much variation to provide in each answer..." max_tokens: title: Max Tokens type: integer + minimum: 0 + maximum: 4096 description: "The maximum number of tokens to allow..."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (118)
src/libs/AI21/Generated/AI21.Ai21Api.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ChatClient.V1J2UltraChat.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ChatClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2GrandeComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2GrandeInstructComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2JumboComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2JumboComplete2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2JumboInstructComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2LargeComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2LargeInstructComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2LightComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2MidComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2UltraComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.CompletionClient.V1J2UltraComplete2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IAi21Api.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IChatClient.V1J2UltraChat.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IChatClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2GrandeComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2GrandeInstructComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2JumboComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2JumboComplete2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2JumboInstructComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2LargeComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2LargeInstructComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2LightComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2MidComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2UltraComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ICompletionClient.V1J2UltraComplete2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IJambaCompleteClient.V1ChatComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IParaphraseClient.V1Paraphraze.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IParaphraseClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISegmentationClient.V1Segmentation.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISegmentationClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISummarizeClient.V1Summarize.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISummarizeClient.V1SummarizeBySegment.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ISummarizeClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.JambaCompleteClient.V1ChatComplete.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatMessage.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatOutput.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatOutput.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatRequest.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatRequest.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatRequestMessageDiscriminator.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatRequestMessageDiscriminator.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatRequestMessageDiscriminatorRole.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ChatResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.DocumentType.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.FinishReason.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.FinishReason.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.Highlight.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.Highlight.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesChatChatRequest.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminator.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminatorRole.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesJ2ChatChatRequest.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesJ2ChatChatRequest.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.MessagesItem.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ParaphraseBody.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ParaphraseBody.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.RoleType.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.Segment.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.Segment.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentSummary.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentSummary.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentationBody.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentationBody.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentationResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentationResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentedSummaryBody.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SegmentedSummaryBody.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.StyleType.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SummarizationResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SummarizationResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SummarizeBody.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SummarizeBody.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SummarizeBySegmentResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SummarizeBySegmentResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.SummaryMethod.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2GrandeCompleteResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2GrandeCompleteResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2GrandeInstructCompleteResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2GrandeInstructCompleteResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2JumboCompleteResponse2.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2JumboCompleteResponse2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2JumboInstructCompleteResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2JumboInstructCompleteResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2LargeCompleteResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2LargeInstructCompleteResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2LargeInstructCompleteResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2LightCompleteResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2LightCompleteResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2MidCompleteResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2MidCompleteResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2UltraCompleteResponse2.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1J2UltraCompleteResponse2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1ParaphrazeResponse.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.V1ParaphrazeResponse.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ParaphraseClient.V1Paraphraze.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.ParaphraseClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SegmentationClient.V1Segmentation.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SegmentationClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SummarizeClient.V1Summarize.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SummarizeClient.V1SummarizeBySegment.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.SummarizeClient.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.ChatRequestMessageDiscriminatorRole.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.ChatRequestMessageDiscriminatorRoleNullable.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.DocumentTypeNullable.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminatorRole.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminatorRoleNullable.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.MessagesItem.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.RoleType.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.RoleTypeNullable.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.StyleType.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.SummaryMethod.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.SummaryMethodNullable.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AI21/openapi.yaml(2 hunks)
🔇 Additional comments (1)
src/libs/AI21/openapi.yaml (1)
62-62: LGTM: Schema reference update aligns with new structure.
The schema reference update to ChatRequest is consistent with the new schema structure defined in the components section.
This was referenced Nov 20, 2024
feat:Update OpenAPI Specification: Remove Authorization Parameter from Chat Completions Endpoint
#76
Merged
This was referenced Dec 16, 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
ChatRequestschema with enhanced properties for improved chat interactions.DocumentSchemafor better handling of document-related data.Removed Features
Updates