Skip to content

docs: add batch processing examples (#462) #476

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 6 commits into from
Jul 9, 2025
Merged

Conversation

knileshh
Copy link
Contributor

Added documentation for batch processing functionality to the README. The example demonstrates how to:

  • Create and upload a JSONL file containing multiple requests
  • Create and execute a batch
  • Check batch status
  • Process batch results

Closes #462

Adds a comprehensive example demonstrating how to use the batch processing API, including file upload, batch creation, status checking, and result processing. The example shows the complete workflow for processing multiple requests efficiently through the batch API.
@knileshh knileshh requested a review from a team as a code owner May 18, 2025 17:34
@knileshh
Copy link
Contributor Author

Hey @TomerAberbach can you please review this PR and let me know if it's okay or there are some changes required. Thank you.

@TomerAberbach
Copy link
Collaborator

Hey, sorry, was on vacation!

Can you move your code into the examples directory instead of the README? Can look at the other example files for inspiration (feel free to add comments based on what you originally had in the README if you want)

knileshh added 2 commits May 29, 2025 00:30
Adds a comprehensive example demonstrating how to use the batch processing API, including file upload, batch creation, status checking, and result processing. The example shows the complete workflow for processing multiple requests efficiently through the batch API.
@knileshh
Copy link
Contributor Author

Hi, I've tried to make the changes and move the examples to their proper place inside the examples directory, please go through the PR once and do let me know if they require additional changes. Thanks.

@TomerAberbach TomerAberbach changed the title docs: Add batch processing example to README (#462) docs: add batch processing examples (#462) Jul 9, 2025
@TomerAberbach TomerAberbach merged commit d910267 into openai:main Jul 9, 2025
2 of 3 checks passed
@stainless-app stainless-app bot mentioned this pull request Jul 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants