Skip to content

feat:Add Java and Kotlin example code snippets to realtime session endpoints#183

Merged
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202506271823
Jun 27, 2025
Merged

feat:Add Java and Kotlin example code snippets to realtime session endpoints#183
HavenDV merged 1 commit intomainfrom
bot/update-openapi_202506271823

Conversation

@HavenDV
Copy link
Copy Markdown
Contributor

@HavenDV HavenDV commented Jun 27, 2025

Summary by CodeRabbit

  • Documentation
    • Added Java and Kotlin example code snippets to the realtime sessions and transcription sessions API documentation, providing additional guidance for users of these languages. Existing examples for other languages remain unchanged.

@HavenDV HavenDV enabled auto-merge (squash) June 27, 2025 18:24
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 27, 2025

Walkthrough

The OpenAPI specification file was updated to include Java and Kotlin example code snippets for the realtime sessions and realtime transcription sessions endpoints. These additions demonstrate client instantiation and API usage in those languages. No changes were made to the API schemas or existing examples.

Changes

File Change Summary
src/libs/tryAGI.OpenAI/openapi.yaml Added Java and Kotlin example code snippets to realtime session endpoints.

Poem

In the garden of code, new languages bloom,
Java and Kotlin now join the room.
With sessions in real time, examples abound,
The OpenAPI spec grows safe and sound.
Rabbits hop by, their whiskers a-twitch—
More ways to connect, oh what a switch!

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch bot/update-openapi_202506271823

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.
    • 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 coderabbitai Bot changed the title feat:@coderabbitai feat:Add Java and Kotlin example code snippets to realtime session endpoints Jun 27, 2025
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
src/libs/tryAGI.OpenAI/openapi.yaml (4)

5030-5030: Remove unused SessionCreateParams import in the Java example

SessionCreateParams is imported but never referenced. It clutters the snippet and will trigger an “unused import” warning if someone copies the code verbatim.

-import com.openai.models.beta.realtime.sessions.SessionCreateParams;

Either delete the import (shown above) or demonstrate a real-world call that requires parameters:

SessionCreateParams params = SessionCreateParams.builder()
    .modalities(List.of("audio","text"))
    .instructions("You are a friendly assistant.")
    .build();
SessionCreateResponse session = client.beta().realtime().sessions().create(params);

5031-5031: Mirror the Java fix in the Kotlin snippet

Same issue as above – SessionCreateParams isn’t used. Drop the import or show a call that passes params to avoid warnings.

-import com.openai.models.beta.realtime.sessions.SessionCreateParams

Optionally:

val params = SessionCreateParams.builder()
    .modalities(listOf("audio","text"))
    .instructions("You are a friendly assistant.")
    .build()
val session = client.beta().realtime().sessions().create(params)

5062-5062: Clean up unused TranscriptionSessionCreateParams in Java transcription example

The import is unused. Remove it or supply a parameterised call.

-import com.openai.models.beta.realtime.transcriptionsessions.TranscriptionSessionCreateParams;

5063-5063: Same cleanup for Kotlin transcription example

TranscriptionSessionCreateParams is imported but unused. Drop it or pass params as part of the example.

-import com.openai.models.beta.realtime.transcriptionsessions.TranscriptionSessionCreateParams
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 407f43f and a255002.

📒 Files selected for processing (1)
  • src/libs/tryAGI.OpenAI/openapi.yaml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test / Build, test and publish

@HavenDV HavenDV merged commit 410365a into main Jun 27, 2025
4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202506271823 branch June 27, 2025 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant