feat:Update OpenAPI spec for CreateOpenAIEncoderRequest and Encoder schemas

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Enhanced API documentation for encoder components.
  • Refined property descriptions and examples for clarity and consistency.
  • Updated guidance for encoder naming, functionality details, and expected output dimensions to ensure users have clear and standardized information.

[coderabbitai]

Walkthrough

The changes update the OpenAPI specification in src/libs/Vectara/openapi.yaml. In the CreateOpenAIEncoderRequest schema, the encoder’s name description and example have been revised, the description example has been generalized, and the output_dimensions example remains as "1536". In the Encoder schema, the example for name is updated, the type example changes from "vectara" to "openai-compatible", and the output_dimensions example is updated from "768" to "1536".

Changes

File	Change Summary
src/libs/Vectara/openapi.yaml (CreateOpenAIEncoderRequest schema)	- name: Updated description ("The unique name..." → "A unique name for the encoder") and example ("my-openai-encoder" → "openai-text-encoder") - description: Updated example ("OpenAI text embedding encoder" → "description") - output_dimensions: Example remains "1536"
src/libs/Vectara/openapi.yaml (Encoder schema)	- name: Example updated from "boomerang-2023-q3" to "openai-text-encoder" - type: Example updated from "vectara" to "openai-compatible" - output_dimensions: Example updated from "768" to "1536"

Poem

In a burrow of code, I hop with glee,
Finding updated examples as clear as can be.
My whiskers twitch at each refined line,
Where names and types in harmony align.
With ASCII joy and a bunny smile so bright,
I celebrate these changes with pure delight!
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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

🧹 Nitpick comments (1)

src/libs/Vectara/openapi.yaml (1)

4430-4438: Refined Name and Description Properties in CreateOpenAIEncoderRequest
The name property now clearly states “A unique name for the encoder” and its example has been updated to “openai-text-encoder”. This change improves clarity and enforces a consistent naming convention.

Additionally, the description property’s example has been updated to the generic value “description”. While this generalization may match the intent of simplifying the example, consider whether a more descriptive example (e.g. “A transformer-based embedding encoder”) might better inform API consumers about what value is expected.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 04b5f05 and f99e370.

⛔ Files ignored due to path filters (2)

• src/libs/Vectara/Generated/Vectara.Models.CreateOpenAIEncoderRequest.g.cs is excluded by !**/generated/**
• src/libs/Vectara/Generated/Vectara.Models.Encoder.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/Vectara/openapi.yaml (2 hunks)

🔇 Additional comments (1)

src/libs/Vectara/openapi.yaml (1)

4466-4479: Updated Encoder Schema Values for Consistency

• The name property in the Encoder schema now uses the example “openai-text-encoder” instead of a legacy value (previously “boomerang-2023-q3”), which aligns the public documentation with the new OpenAI-compatible encoder profile.
• The type property’s example has been updated to “openai-compatible”. However, note that the default value remains set to “vectara”. This discrepancy might confuse API consumers—please verify if the intent is to use “openai-compatible” as the illustrative example while retaining a legacy default, or whether the default should be updated as well for consistency.
• The output_dimensions example has been updated to 1536, which is consistent with the new guidelines.