Interface HttpOptions

HTTP options to be used in each of the requests.

interface HttpOptions {
    apiVersion?: string;
    baseUrl?: string;
    baseUrlResourceScope?: COLLECTION;
    extraBody?: Record<string, unknown>;
    headers?: Record<string, string>;
    timeout?: number;
}

Properties

apiVersion? baseUrl? baseUrlResourceScope? extraBody? headers? timeout?

Properties

OptionalapiVersion

apiVersion?: string

Specifies the version of the API to use.

OptionalbaseUrl

baseUrl?: string

The base URL for the AI platform service endpoint.

OptionalbaseUrlResourceScope

baseUrlResourceScope?: COLLECTION

The resource scope used to constructing the resource name when base_url is set

OptionalextraBody

extraBody?: Record<string, unknown>

Extra parameters to add to the request body. The structure must match the backend API's request structure.

Optionalheaders

headers?: Record<string, string>

Additional HTTP headers to be sent with the request.

Optionaltimeout

timeout?: number

Timeout for the request in milliseconds.

Settings

On This Page

Properties