Interface EmbedContentConfig

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

Properties

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

Properties

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
MMNEPVFCICPMFPCPTTAAATR