TextFormatOptions interface {#textformatoptions_interface}

Options for formatting a text embedding request.

Signature:

export declare interface TextFormatOptions 

Properties

TextFormatOptions.type {#textformatoptionstype}

The embedding type to generate for the given text.

Signature:

type: TextEmbeddingType;

TextFormatOptions.title {#textformatoptionstitle}

The title of the text to be embedded. Only used for document embeddings.

Signature:

title?: string;

TextFormatOptions.textRole {#textformatoptionstextrole}

The role of the text to be embedded.

Signature:

textRole?: TextRole;