Skip to content

[Docs] Update transcriptions API to use openai client with stream=True #20271

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.

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

Merged
merged 1 commit into from
Jul 1, 2025

Conversation

NickLucche
Copy link
Contributor

Since openai/openai-python#2260 OpenAI official api client correctly handles the stream option for the audio.transcription api.
This PR simply adjusts the Docs to reflect that change.

I don't think there's a strong enough reason to update the requirements/common.txt list, but let me know in case you want me to bump that version too.

Signed-off-by: NickLucche <[email protected]>
@NickLucche NickLucche requested a review from aarnphm as a code owner June 30, 2025 16:19
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@mergify mergify bot added documentation Improvements or additions to documentation frontend labels Jun 30, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @NickLucche, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the documentation and example code to reflect the proper usage of the OpenAI API client for audio transcriptions with streaming enabled. It replaces the previous workaround using httpx with the official client's streaming capabilities, simplifying the code and improving its compatibility with the OpenAI API.

Highlights

  • Docs Update: Updated the examples/online_serving/openai_transcription_client.py example to use the official OpenAI API client's stream=True option for audio transcriptions.
  • Code Modernization: Replaced the previous implementation that used httpx for streaming with the openai client's built-in streaming support, leveraging AsyncOpenAI.
  • API Usage: Adjusted the example code to properly pass the stream argument to the client.audio.transcriptions.create method, enabling streaming transcription.
  • Protocol Update: Moved the stream parameter definition in vllm/entrypoints/openai/protocol.py to improve code organization.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the OpenAI transcription example to use the native streaming support from the openai library, which is a great simplification. The docstring update in the protocol file is also correct. I've found a critical issue in the example code that would cause it to fail at runtime, and a medium-severity issue related to code clarity. Please see my detailed comments.

@NickLucche
Copy link
Contributor Author

cc @DarkLight1337

Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

LGTM

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) July 1, 2025 08:01
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jul 1, 2025
@DarkLight1337 DarkLight1337 merged commit 314af86 into vllm-project:main Jul 1, 2025
83 checks passed
CSWYF3634076 pushed a commit to CSWYF3634076/vllm that referenced this pull request Jul 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation frontend ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants