Interface EmbedContentConfig

Optional parameters for the embed_content method.

interface EmbedContentConfig {
    abortSignal?: AbortSignal;
    autoTruncate?: boolean;
    httpOptions?: HttpOptions;
    mimeType?: string;
    outputDimensionality?: number;
    taskType?: string;
    title?: string;
}

Properties

abortSignal? autoTruncate? httpOptions? mimeType? outputDimensionality? taskType? title?

Properties

OptionalabortSignal

abortSignal?: AbortSignal

Abort signal which can be used to cancel the request.

NOTE: AbortSignal is a client-only operation. Using it to cancel an operation will not cancel the request in the service. You will still be charged usage for any applicable operations.

OptionalautoTruncate

autoTruncate?: boolean

Vertex API only. Whether to silently truncate inputs longer than the max sequence length. If this option is set to false, oversized inputs will lead to an INVALID_ARGUMENT error, similar to other text APIs.

OptionalhttpOptions

httpOptions?: HttpOptions

Used to override HTTP request options.

OptionalmimeType

mimeType?: string

Vertex API only. The MIME type of the input.

OptionaloutputDimensionality

outputDimensionality?: number

Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. Supported by newer models since 2024 only. You cannot set this value if using the earlier model (models/embedding-001).

OptionaltaskType

taskType?: string

Type of task for which the embedding will be used.

Optionaltitle

title?: string

Title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT.

Settings

On This Page

Properties