feat:Add Java and Kotlin code examples to realtime and transcription endpoints

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Added Java and Kotlin example code snippets for realtime and transcription session endpoints in the API documentation.

[coderabbitai]

Walkthrough

The OpenAPI specification file was updated to include Java and Kotlin example code snippets for realtime and transcription session endpoints. These additions demonstrate how to use the OpenAI client in Java and Kotlin for creating sessions. No modifications were made to response schemas, endpoint behaviors, or public entity declarations.

Changes

File(s)	Change Summary
src/libs/tryAGI.OpenAI/openapi.yaml	Added Java and Kotlin example code snippets to request payloads for realtime and transcription session endpoints.

Poem

In the garden of code, new snippets bloom bright,
Java and Kotlin now join the flight.
Sessions created, examples in tow,
In OpenAPI fields, new languages grow.
Curl, Node, and Python still hold their ground—
But now, more bunnies can hop all around! 🐇

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bot/update-openapi_202507112116

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests 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/tryAGI.OpenAI/openapi.yaml (2)

5030-5031: Remove or make use of SessionCreateParams / TranscriptionSessionCreateParams imports in the example snippets

Both the Java and Kotlin examples import SessionCreateParams, yet the variable is never referenced; the code immediately calls client.beta().realtime().sessions().create() with no arguments.
This creates two minor problems:

1. Beginners copy-pasting the snippet will get “unused import” warnings from their IDE/compiler.
2. The snippet doesn’t show how to supply the same parameters that the preceding cURL example demonstrates (model, modalities, instructions, …), reducing the educational value.

Either delete the unused import lines, or (preferred) show a minimal parameter object being built and passed, e.g.

SessionCreateParams params = SessionCreateParams.builder()
        .model("gpt-4o-realtime-preview")
        .modalities(Arrays.asList("audio", "text"))
        .instructions("You are a friendly assistant.")
        .build();

SessionCreateResponse session =
        client.beta().realtime().sessions().create(params);

Doing the same for the Kotlin example keeps the docs consistent and warning-free.

---

5062-5063: Same issue for the Transcription-session examples

TranscriptionSessionCreateParams is imported but unused in both Java and Kotlin snippets.
Apply the same clean-up or, better, illustrate building the parameter object so the sample mirrors the cURL call.

TranscriptionSessionCreateParams params =
        TranscriptionSessionCreateParams.builder().build(); // fill in when options exist
TranscriptionSession session =
        client.beta().realtime().transcriptionSessions().create(params);

This keeps the examples warning-free and pedagogically complete.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6f6b57e and 341acc3.

📒 Files selected for processing (1)

• src/libs/tryAGI.OpenAI/openapi.yaml (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Test / Build, test and publish