feat:Update OpenAPI spec for Jina Embedding Serving API to version 0.1.93

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced a new task property in the embedding input schemas to specify the intended application of embeddings, enhancing user guidance and model behavior.
  • Updated schemas for ImageEmbeddingInput, MixedEmbeddingInput, and TextEmbeddingInput to include the new property, ensuring consistency across input types.

[coderabbitai]

Walkthrough

The pull request updates the OpenAPI specification for the Jina Embedding Serving API, changing the version from 0.1.92 to 0.1.93. It introduces a new property, task, to the ImageEmbeddingInput, MixedEmbeddingInput, and TextEmbeddingInput schemas. This property is an enumerated type that specifies the intended downstream application of the embeddings, providing options such as retrieval.query, retrieval.passage, text-matching, classification, and separation. Descriptions for these properties clarify their roles, while no other significant changes to API endpoints or response schemas were made.

Changes

File Path	Change Summary
src/libs/Jina/openapi.yaml	Added task property to ImageEmbeddingInput, MixedEmbeddingInput, and TextEmbeddingInput schemas; updated version to 0.1.93.

Poem

In the fields where embeddings play,
A new task blooms bright today.
With options wide, they guide the way,
For queries, texts, and more to say.
Hop along, let’s celebrate,
As Jina’s API grows so great! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a35e1be and 419df1a.

⛔ Files ignored due to path filters (10)

• src/libs/Jina/Generated/Jina.Models.ImageEmbeddingInput.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.ImageEmbeddingInputTask.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.MixedEmbeddingInput.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.MixedEmbeddingInputTask.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonConverters.ImageEmbeddingInputTask.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonConverters.ImageEmbeddingInputTaskNullable.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonConverters.MixedEmbeddingInputTask.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonConverters.MixedEmbeddingInputTaskNullable.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (3)

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

5-5: LGTM: Version increment follows semantic versioning

The version update from 0.1.92 to 0.1.93 is appropriate for adding new optional properties.

---

617-626: LGTM: Consistent task property implementation across input schemas

The task property has been consistently implemented across ImageEmbeddingInput and MixedEmbeddingInput schemas, matching the existing implementation in TextEmbeddingInput. The property:

• Has identical enum values
• Includes comprehensive descriptions
• Maintains consistent structure and documentation

Also applies to: 717-726

---

617-626: Verify the impact on existing clients

Since the task property is optional (not in the required array), this is a backward-compatible change. However, please ensure that:

1. Default behavior is maintained when task is not provided
2. Documentation is updated to reflect these new capabilities
3. Client libraries are updated to support the new property

Also applies to: 717-726

---

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.