Databricks SDK for JavaScript
    Preparing search index...

    Interface Batch

    An asynchronous run of one AI function over a file of requests.

    interface Batch {
        createTime?: Instant;
        endpoint?: string;
        inputRef?: string;
        name?: string;
        outputRef?: string;
        params?: JsonObject;
        percentComplete?: number;
        requestCounts?: BatchRequestCounts;
        status?: BatchStatus;
    }
    Index

    Properties

    createTime? endpoint? inputRef? name? outputRef? params? percentComplete? requestCounts? status?

    Properties

    createTime?: Instant

    Output only. Time the batch was created.

    endpoint?: string

    The AI function to run for every request, for example ai_extract.

    inputRef?: string

    Path of the JSONL input file on a Unity Catalog volume. Each line is one request.

    name?: string

    ID of the batch, in the form batch_<id>. The service assigns it.

    outputRef?: string

    Path on a Unity Catalog volume to write the JSONL output to. When it is omitted, the output stays on Databricks-managed storage and a finished batch returns a short-lived download URL in this field instead.

    params?: JsonObject

    Function options applied to every request in the batch, for example the extraction schema.

    percentComplete?: number

    Output only. Percentage of the requests that finished, from 0 to 100. Returned when one batch is read, not when batches are listed.

    requestCounts?: BatchRequestCounts

    Output only. Request counts. Returned when one batch is read, not when batches are listed.

    status?: BatchStatus

    Output only. Status of the batch.

    Settings

    Member Visibility

    On This Page

    Properties