feat:Add StreamOptions schema to OpenAICompletionsIn and OpenAIEmbeddingsIn

[HavenDV]

Summary by CodeRabbit

• New Features
  • Enhanced API streaming configuration with adjustable options for including usage data and continuous statistics during streaming events. The default settings include usage data while continuous statistics are disabled, providing more flexible streaming behavior for your requests.

[coderabbitai]

Walkthrough

This pull request introduces new streaming options in the OpenAPI specification by adding a new schema and properties. A StreamOptions schema is defined with two boolean properties, include_usage (defaulting to true) and continuous_usage_stats (defaulting to false). The schema is then referenced in two existing schemas, OpenAICompletionsIn and OpenAIEmbeddingsIn, via a new property named stream_options. These changes allow API users to control streaming behavior and usage data tracking in their API requests.

Changes

File	Change Summary
src/libs/DeepInfra/openapi.yaml	- Added new schema StreamOptions with boolean properties include_usage (default: true) and continuous_usage_stats (default: false). - Added stream_options property referencing StreamOptions in both OpenAICompletionsIn and OpenAIEmbeddingsIn schemas.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant API as API Server
    C->>API: Send API request with streaming options (include_usage, continuous_usage_stats)
    API--)C: Process request and initiate streaming response
    API--)C: Return usage data alongside streamed events

Loading

Possibly related PRs

• feat:Update OpenAPI spec: Expand seed range and add encoding format option #115: Modifies the OpenAICompletionsIn schema in the same openapi.yaml file, sharing a similar update context.
• feat:No changes made in the pull request. #61: Updates both OpenAICompletionsIn and OpenAIEmbeddingsIn schemas with new parameters, correlating closely with the changes in this PR.

Poem

I'm a rabbit with a skip and hop,
Streaming changes make my heart go pop.
Usage tracked as carrots are stored,
Code hops along and never gets bored.
With a twitch of my ear, I celebrate the code drop!
🐇🎉

---

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 (2)

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

5294-5298: Add stream_options Property to OpenAICompletionsIn Schema
This hunk adds a new property named stream_options to the OpenAICompletionsIn schema. It uses an allOf reference to the new StreamOptions schema, which is a clear way to reuse the defined streaming options. Please verify that this addition aligns with both the API design and the documentation so that users know how to leverage streaming behavior with completions.

---

5416-5420: Include stream_options in the Relevant Input Schema (Embeddings)
In this segment, a similar stream_options property is added—presumably to the input schema for embeddings requests. As with the completions schema, ensure that its inclusion (and the inherited default values from the StreamOptions schema) does not conflict with any downstream processing and that it is clearly documented for API consumers.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c02f3e6 and e56886e.

⛔ Files ignored due to path filters (9)

• src/libs/DeepInfra/Generated/DeepInfra.DeepInfraClient.OpenaiChatCompletions.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.DeepInfraClient.OpenaiCompletions.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.IDeepInfraClient.OpenaiChatCompletions.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.IDeepInfraClient.OpenaiCompletions.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.OpenAIChatCompletionsIn.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.OpenAICompletionsIn.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.StreamOptions.Json.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.StreamOptions.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

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

5758-5771: Define New Schema: StreamOptions
A new schema called StreamOptions is introduced with two boolean properties: include_usage (defaulting to true) and continuous_usage_stats (defaulting to false). The property names, types, and default values appear intuitive and should provide the necessary control over streaming behavior. Please ensure that related API documentation is updated accordingly and that these defaults meet user expectations.