feat:Update OpenAPI specification for Jina Embedding Serving API to 0.1.92 #80
Conversation
WalkthroughThe OpenAPI specification for the Jina Embedding Serving API has been updated from version 0.1.89 to 0.1.92. Key changes include the addition of new models in several input schemas, the introduction of a Changes
Poem
Warning Rate limit exceeded@HavenDV has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 28 minutes and 1 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 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 (1)
src/libs/Jina/openapi.yaml (1)
Line range hint
254-297: Add migration guidance for deprecated endpointWhile the
multi-embeddingsendpoint is properly marked as deprecated, consider adding migration guidance in the description to help users transition to the recommended alternative endpoint.description: Create multiple vector representations of the given input texts. One vector representation for each token in the input text. + description: | + Create multiple vector representations of the given input texts. One vector representation for each token in the input text. + DEPRECATED: Please use the `/v1/multi-vector` endpoint instead as this endpoint will be removed in a future version.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (10)
src/libs/Jina/Generated/Jina.ClassificationClient.Classify.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.ClassificationClient.Train.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.IClassificationClient.Classify.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.IClassificationClient.Train.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.ClassificationAPIInput.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.ImageEmbeddingInput.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.MixedEmbeddingInput.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.TextEmbeddingInput.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.TrainingAPIInput.g.csis excluded by!**/generated/**src/libs/Jina/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Jina/openapi.yaml(8 hunks)
🔇 Additional comments (2)
src/libs/Jina/openapi.yaml (2)
5-5: LGTM: Version update to 0.1.92
The version update follows semantic versioning format.
414-414: LGTM: Model descriptions consistently updated
The model descriptions have been updated across all relevant schemas to include the new jina-clip-v2 model and its specifications. The documentation is clear and includes proper technical references.
Also applies to: 586-586, 675-675, 938-938, 1028-1028
| dimensions: | ||
| title: Dimensions | ||
| type: integer | ||
| description: 'Used to specify output embedding size. If set, output embeddings will be truncated to the size specified.' |
There was a problem hiding this comment.
💡 Codebase verification
Inconsistency found in dimensions property definition
The dimensions property is defined differently across schemas:
ImageEmbeddingInputandMixedEmbeddingInputhave consistent definitions withtype: integerand truncation description- However, another schema (likely
TextEmbeddingInput) has a different definition with anenumrestricting values to [64, 96]
This inconsistency in property definitions could lead to confusion and potential issues. The schemas should either:
- All use the flexible integer type with truncation behavior, or
- All use the enum with specific allowed dimensions
🔗 Analysis chain
LGTM: Dimensions property consistently added
The dimensions property has been consistently added to relevant schemas with clear documentation about truncation behavior.
Also applies to: 707-710
Let me verify the exact definition of the dimensions property across all schemas to ensure complete consistency.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that dimensions property is consistently defined across schemas
# and that no schema is missing this property where it should be present
# Search for all schema definitions that might need the dimensions property
rg -l "embedding" | xargs rg "title: \w+EmbeddingInput" -A 50 | rg "dimensions|title"
Length of output: 1151
Script:
#!/bin/bash
# Get the full context of dimensions property definition in all embedding input schemas
rg -A 4 "dimensions:" src/libs/Jina/openapi.yaml
Length of output: 852
Summary by CodeRabbit
New Features
dimensionsproperty in multiple input schemas to specify output embedding size.Improvements
normalizedproperty to ensure embeddings are normalized.Deprecation
multi-embeddingsendpoint as deprecated, indicating a shift in API usage.