feat:Update OpenAPI spec: add style_ref_embeddings property and V_3 model

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced support for style reference embeddings in image generation requests.
  • Expanded image generation and editing options with the addition of a new model version.

[coderabbitai]

Walkthrough

This update modifies the OpenAPI specification by introducing a new property, style_ref_embeddings, to the GenerateImageRequest schema. An example is provided for this property, which is defined as an array of strings holding base64 encoded binary embeddings. Additionally, the ModelEnum schema now includes a new model version, V_3. The description for the image generation model has been updated accordingly for the /generate and /remix endpoints.

Changes

File	Changes Summary
src/.../openapi.yaml	- Added style_ref_embeddings (array of strings) to the GenerateImageRequest schema with an example. - Updated ModelEnum to include model version V_3 and revised descriptions for /generate and /remix endpoints.

Possibly related PRs

• feat:Update OpenAPI Specification for Ideogram API from 3.0.1 to 3.0.4 #49: Modifies endpoints /generate and /remix, aligning with the schema updates in this PR.
• feat:Update OpenAPI specification for Ideogram API /edit endpoint and ModelEnum schema #28: Involves changes to ModelEnum and request schemas, similar to the updates introduced here.
• feat:Update OpenAPI Specification for Ideogram API with New Properties and Schemas #47: Contains comparable modifications to request schemas and the ModelEnum that relate directly to this PR.

Suggested reviewers

• github-actions

Poem

I'm a hopping rabbit, full of cheer,
New embeddings and model changes appear.
With V_3 leaping in, the endpoints shine bright,
Guiding images gently day and night.
In CodeRabbit's world, changes bring delight!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

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 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/Ideogram/openapi.yaml (2)

558-563: New Property "style_ref_embeddings" Definition
The new property is clearly defined as an array of strings with an appropriate title and description. This addition should support the intended functionality for passing base64 encoded binary embeddings.

---

565-567: Example Update for "style_ref_embeddings"
The example currently uses the placeholder text "style_ref_embeddings". For improved clarity, consider replacing these placeholders with realistic sample base64 strings to better guide 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 e89f345 and 7e593b2.

⛔ Files ignored due to path filters (5)

• src/libs/Ideogram/Generated/Ideogram.GenerateClient.PostGenerateImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.IGenerateClient.PostGenerateImage.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.GenerateImageRequest.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/Ideogram.Models.ModelEnum.g.cs is excluded by !**/generated/**
• src/libs/Ideogram/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

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

888-891: ModelEnum Update: Addition of "V_3"
The insertion of "V_3" into the ModelEnum correctly extends the available model versions. Please ensure that backend support and corresponding documentation for "V_3" are updated accordingly.