Skip to content

feat:Add texts as required field in EmbedByTypeResponse schema in OpenAPI #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 15, 2025
Merged

feat:Add texts as required field in EmbedByTypeResponse schema in OpenAPI #176

merged 1 commit into from
Apr 15, 2025

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Apr 15, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Responses from the embedding endpoint now always include the original texts alongside their embeddings and metadata.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 15, 2025 •
edited
Loading

Walkthrough

The OpenAPI specification for the Cohere API was updated by modifying the EmbedByTypeResponse schema. The texts property was added as a required field, alongside the existing required fields: id, embeddings, and api_version. This change ensures that any response conforming to this schema must now include the array of original texts for which embeddings were generated.

Changes

File(s) Change Summary
src/libs/Cohere/openapi.yaml Updated EmbedByTypeResponse schema to add texts as a required property in the OpenAPI spec.

Possibly related PRs

Poem

A tweak to the schema, so neat and precise,
Now texts are required, not just once but twice!
Embeddings and versions, IDs in their place,
But now every response shows the text's friendly face.
🐇✨
The API hops forward, with clarity in tow,
Ensuring each embedding knows where it came from—let’s go!

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7ec324e and 04302fd.

⛔ Files ignored due to path filters (1)
  • src/libs/Cohere/Generated/Cohere.Models.EmbedByTypeResponse.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/Cohere/openapi.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test / Build, test and publish
🔇 Additional comments (1)
src/libs/Cohere/openapi.yaml (1)

12854-12854: Addition of texts as a required property improves schema accuracy

Making texts required in the EmbedByTypeResponse schema ensures that all conforming responses will always include the original texts, improving contract enforcement and reducing ambiguity for clients and servers.

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
🪧 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 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.

@HavenDV HavenDV enabled auto-merge April 15, 2025 15:23
@HavenDV HavenDV merged commit 10db703 into main Apr 15, 2025
3 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202504151522 branch April 15, 2025 15:25
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add texts as required field in EmbedByTypeResponse schema in OpenAPI Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@HavenDV