Options for formatting a text embedding request.
Signature:
export declare interface TextFormatOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| type | TextEmbeddingType | The embedding type to generate for the given text. | |
| title | string | The title of the text to be embedded. Only used for document embeddings. | |
| textRole | TextRole | The role of the text to be embedded. |
TextFormatOptions.type
The embedding type to generate for the given text.
Signature:
type: TextEmbeddingType;
TextFormatOptions.title
The title of the text to be embedded. Only used for document embeddings.
Signature:
title?: string;
TextFormatOptions.textRole
The role of the text to be embedded.
Signature:
textRole?: TextRole;