Class Batches

Hierarchy

  • APIResource
    • Batches

Constructors

constructor

Methods

cancel create list retrieve

Constructors

constructor

  • new Batches(client): Batches

  • Parameters

    • client: OpenAI

    Returns Batches

Methods

cancel

  • cancel(batchId, options?): APIPromise<Batch>

  • Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.

    Parameters

    • batchId: string
    • Optionaloptions: RequestOptions<unknown>

    Returns APIPromise<Batch>

create

  • create(body, options?): APIPromise<Batch>

  • Creates and executes a batch from an uploaded file of requests

    Parameters

    Returns APIPromise<Batch>

list

  • list(query?, options?): PagePromise<BatchesPage, Batch>

  • List your organization's batches.

    Parameters

    Returns PagePromise<BatchesPage, Batch>

  • list(options?): PagePromise<BatchesPage, Batch>

  • Parameters

    • Optionaloptions: RequestOptions<unknown>

    Returns PagePromise<BatchesPage, Batch>

retrieve

  • retrieve(batchId, options?): APIPromise<Batch>

  • Retrieves a batch.

    Parameters

    • batchId: string
    • Optionaloptions: RequestOptions<unknown>

    Returns APIPromise<Batch>

Settings

Member Visibility

On This Page

Constructors
Methods