feat:Update OpenAPI specification for Jina Embedding Serving API to 0.1.94

[HavenDV]

Summary by CodeRabbit

• New Features

  • Updated OpenAPI specification for the Jina Embedding Serving API.
  • Introduced a task property in embedding input schemas for better application targeting.
  • Set normalized property to default to true in embedding input schemas for automatic normalization of embeddings.

• Bug Fixes

  • No changes to existing paths or operations, ensuring stability in API functionality.

[coderabbitai]

Walkthrough

The changes involve an update to the OpenAPI specification for the Jina Embedding Serving API, specifically updating the version from 0.1.93 to 0.1.94. The modifications include adding a default value for the normalized property in the ImageEmbeddingInput and MixedEmbeddingInput schemas, setting it to true. Additionally, a new task property has been introduced in both schemas to specify the intended downstream application. The overall structure and functionality of the API endpoints remain unchanged.

Changes

File	Change Summary
src/libs/Jina/openapi.yaml	Updated ImageEmbeddingInput and MixedEmbeddingInput schemas: added normalized (default: true) and task properties. Version updated to 0.1.94.

Poem

In the fields where embeddings play,
A new version hops in today!
With normalized set to true,
And a task for all to pursue.
Jina’s API, fresh and bright,
Guiding us to insights, oh what a sight! 🐇✨

---

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/Jina/openapi.yaml (1)

617-617: Enhancement: Improved default behavior and task specification in ImageEmbeddingInput

Good improvements:

1. Setting normalized: true as default aligns with common use cases where normalized embeddings are preferred
2. The addition of the task property with specific enum values helps optimize embedding generation for different downstream applications

Consider documenting the performance characteristics and trade-offs for each task type in the model's technical documentation to help users make informed decisions.

Also applies to: 618-628

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 15e737b and 5495e53.

⛔ Files ignored due to path filters (2)

• src/libs/Jina/Generated/Jina.Models.ImageEmbeddingInput.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.MixedEmbeddingInput.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/Jina/openapi.yaml (3 hunks)

🔇 Additional comments (2)

src/libs/Jina/openapi.yaml (2)

5-5: LGTM: Version increment follows semantic versioning

The patch version increment from 0.1.93 to 0.1.94 correctly reflects backward-compatible changes.

---

718-718: Enhancement: Consistent schema updates in MixedEmbeddingInput

Good improvements that maintain consistency with ImageEmbeddingInput:

1. Same default normalization behavior
2. Same task property with identical enum values

Let's verify the consistency of these changes across the codebase:

Also applies to: 719-729