feat: new cli for batch jobs

ivanleomk commented 3 weeks ago

This targets #604 by implementing two main new features

A new BatchJob class which allows users to create .jsonl files which are compatible with OpenAI's new batch job function
a batch cli command that allows users to see all outstanding jobs, create a new batch job and cancel an existing batch jobs

:rocket:	This description was created by Ellipsis for commit db0ba2880f8a6f1eff96ff27cc27dca75e7dd191

Summary:

This PR introduces a new BatchJob class and CLI commands for managing batch jobs with OpenAI's API.

Key points:

Added BatchJob class in instructor/batch.py for creating .jsonl files for batch jobs.
Added CLI commands in instructor/cli/batch.py to list, create, and cancel batch jobs.
Integrated new batch job commands into the main CLI in instructor/cli/cli.py.

Generated with :heart: by ellipsis.dev

cloudflare-pages[bot] commented 3 weeks ago

Deploying instructor with Cloudflare Pages

Latest commit:	`50eabf2`
Status:	✅ Deploy successful!
Preview URL:	https://7a5f9188.instructor.pages.dev
Branch Preview URL:	https://add-batch-cli.instructor.pages.dev

View logs

jxnl commented 2 weeks ago

please add a lil recording and doc pages before we're ready to merge

ivanleomk commented 2 weeks ago

This is a video recording of the cli in action where we use a generated output.jsonl file in order to create a batch job, cancel the same batch job and also list all existing batch jobs.

https://github.com/jxnl/instructor/assets/45760326/b56d4714-bea4-4a7d-bb5d-f673f5dc2550

Also added a docs page which shows a new snippet on how to generate these .jsonl files

slavakurilyak commented 1 week ago

When can we expect the next release to include this?

Excited to use this batch CLI command

ivanleomk commented 1 week ago

@slavakurilyak we just released v1.3.4 which has it!

jxnl / instructor

feat: new cli for batch jobs #754

Summary:

Deploying instructor with Cloudflare Pages