Class Batches

Hierarchy

APIResource
- Batches

Index

Constructors

Methods

cancel create list retrieve

Constructors

constructor

new Batches(client): Batches
Parameters
- client: OpenAI
Returns Batches
Inherited from APIResource.constructor
- Defined in libs/langchain-openai/node_modules/openai/resource.d.ts:4

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>
- Defined in libs/langchain-openai/node_modules/openai/resources/batches.d.ts:24

create

create(body, options?): APIPromise<Batch>
Creates and executes a batch from an uploaded file of requests
Parameters
- body: BatchCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Batch>
- Defined in libs/langchain-openai/node_modules/openai/resources/batches.d.ts:9

list

list(query?, options?): PagePromise<BatchesPage, Batch>
List your organization's batches.
Parameters
- Optionalquery: BatchListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<BatchesPage, Batch>
- Defined in libs/langchain-openai/node_modules/openai/resources/batches.d.ts:17
list(options?): PagePromise<BatchesPage, Batch>
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<BatchesPage, Batch>
- Defined in libs/langchain-openai/node_modules/openai/resources/batches.d.ts:18

retrieve

retrieve(batchId, options?): APIPromise<Batch>
Retrieves a batch.
Parameters
- batchId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Batch>
- Defined in libs/langchain-openai/node_modules/openai/resources/batches.d.ts:13