Interface CreateBatchParams

Parameters for the createBatch operation.

interface CreateBatchParams {
    completionWindow: string;
    endpoint: string;
    headers?: OutgoingHttpHeaders;
    inputFileId: string;
    metadata?: Record<string, string>;
    projectId?: string;
    signal?: AbortSignal;
    spaceId?: string;
}

Hierarchy (view full)

Properties

completionWindow endpoint headers? inputFileId metadata? projectId? signal? spaceId?

Properties

completionWindow

completionWindow: string

Time window for completion of the batch job.

endpoint

endpoint: string

API endpoint to use for processing each batch item.

Optional headers

headers?: OutgoingHttpHeaders

inputFileId

inputFileId: string

ID of the uploaded input file for the batch job.

Optional metadata

metadata?: Record<string, string>

Additional metadata for the batch job.

Optional projectId

projectId?: string

Watsonx project identifier.

Optional signal

signal?: AbortSignal

Optional spaceId

spaceId?: string

Watsonx space identifier.

Settings

Member Visibility

Theme

On This Page

completionWindowendpointheadersinputFileIdmetadataprojectIdsignalspaceId