Databricks SDK for JavaScript
    Preparing search index...

    Interface QueryEndpointRequest

    interface QueryEndpointRequest {
        clientRequestId?: string;
        dataframeRecords?: JsonValue[];
        dataframeSplit?: DataframeSplitInput;
        extraParams?: Record<string, string>;
        input?: JsonValue;
        inputs?: JsonValue;
        instances?: JsonValue[];
        maxTokens?: number;
        messages?: ChatMessage[];
        n?: number;
        name?: string;
        prompt?: JsonValue;
        stop?: string[];
        stream?: boolean;
        temperature?: number;
        usageContext?: Record<string, string>;
    }
    Index

    Properties

    clientRequestId? dataframeRecords? dataframeSplit? extraParams? input? inputs? instances? maxTokens? messages? n? name? prompt? stop? stream? temperature? usageContext?

    Properties

    clientRequestId?: string

    Optional user-provided request identifier that will be recorded in the inference table and the usage tracking table.

    dataframeRecords?: JsonValue[]

    Pandas Dataframe input in the records orientation.

    dataframeSplit?: DataframeSplitInput

    Pandas Dataframe input in the split orientation.

    extraParams?: Record<string, string>

    The extra parameters field used ONLY for completions, chat, and embeddings external & foundation model serving endpoints. This is a map of strings and should only be used with other external/foundation model query fields.

    input?: JsonValue

    The input string (or array of strings) field used ONLY for embeddings external & foundation model serving endpoints and is the only field (along with extra_params if needed) used by embeddings queries.

    inputs?: JsonValue

    Tensor-based input in columnar format.

    instances?: JsonValue[]

    Tensor-based input in row format.

    maxTokens?: number

    The max tokens field used ONLY for completions and chat external & foundation model serving endpoints. This is an integer and should only be used with other chat/completions query fields.

    messages?: ChatMessage[]

    The messages field used ONLY for chat external & foundation model serving endpoints. This is an array of ChatMessage objects and should only be used with other chat query fields.

    n?: number

    The n (number of candidates) field used ONLY for completions and chat external & foundation model serving endpoints. This is an integer between 1 and 5 with a default of 1 and should only be used with other chat/completions query fields.

    name?: string

    The name of the serving endpoint. This field is required and is provided via the path parameter.

    prompt?: JsonValue

    The prompt string (or array of strings) field used ONLY for completions external & foundation model serving endpoints and should only be used with other completions query fields.

    stop?: string[]

    The stop sequences field used ONLY for completions and chat external & foundation model serving endpoints. This is a list of strings and should only be used with other chat/completions query fields.

    stream?: boolean

    The stream field used ONLY for completions and chat external & foundation model serving endpoints. This is a boolean defaulting to false and should only be used with other chat/completions query fields.

    temperature?: number

    The temperature field used ONLY for completions and chat external & foundation model serving endpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with other chat/completions query fields.

    usageContext?: Record<string, string>

    Optional user-provided context that will be recorded in the usage tracking table.

    Settings

    Member Visibility

    On This Page

    Properties