TextFormatOptions interface

Options for formatting a text embedding request.

Signature:

export declare interface TextFormatOptions 

Properties

Property Type Description
textRole TextRole The role of the text to be embedded.
title string The title of the text to be embedded. Only used for document embeddings.
type TextEmbeddingType The embedding type to generate for the given text.

TextFormatOptions.textRole

The role of the text to be embedded.

Signature:

textRole?: TextRole;

TextFormatOptions.title

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

Signature:

title?: string;

TextFormatOptions.type

The embedding type to generate for the given text.

Signature:

type: TextEmbeddingType;