Skip to content

Change Batch quickstart to use new client, focus on Python SDK#222

Open
J-Jaywalker wants to merge 1 commit intomainfrom
tweak_batch_quickstart_docs
Open

Change Batch quickstart to use new client, focus on Python SDK#222
J-Jaywalker wants to merge 1 commit intomainfrom
tweak_batch_quickstart_docs

Conversation

@J-Jaywalker
Copy link
Contributor

The current docs point to our old (deprecated) Python client instead of the shiny new one.
I don't think I'll have time to comb through the entire docs and update them, but this change tweaks the Batch API quickstart page to focus more on Python and use code from our updated client.

@vercel
Copy link

vercel bot commented Mar 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 6, 2026 0:12am

Request Review

@J-Jaywalker
Copy link
Contributor Author

J-Jaywalker commented Mar 6, 2026

One thought - out of the scope of this MR - but the Transcript response schema and Example section underneath the example scripts is a lot to take in. I imagine people who are looking at bare minimum quickstarts wouldn't benefit from it, and it may just add noise for them.

print(result.transcript_text)
await client.close()

asyncio.run(main()) No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick: Newline

AUDIO_FILE= "example.wav"

config = TranscriptionConfig(
diarization="speaker"
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this include operating_point = standard?

Copy link
Contributor Author

@J-Jaywalker J-Jaywalker Mar 6, 2026

Choose a reason for hiding this comment

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

I'm open to discuss this.

I'd like to show how quick/easy it is to get started with batch, so if there's a noticeably higher RTF for enhanced than standard then I agree we should put it in. Otherwise maybe we just leave it out to be barebones and reduce mental clutter.

For context I added the transcription config because without it our speaker would be diarized as SPEAKER_UU which doesn't seem intentional(?).

Open to discussion though.

</Tabs>


### Transcript response schema
Copy link
Contributor

Choose a reason for hiding this comment

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

Re our discussion on teams, this is also available on the output page. You could move the example response to the output page too, and have a next steps section which references the output page and some cool features as well?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants