<br />

Options for formatting a text embedding request.

**Signature:**

    export declare interface TextFormatOptions 

## Properties

| Property | Modifiers | Type | Description |
|---|---|---|---|
| [type](https://developers.google.com/edge/api/mediapipe/js/tasks-text.textformatoptions#textformatoptionstype) |   | TextEmbeddingType | The embedding type to generate for the given text. |
| [title](https://developers.google.com/edge/api/mediapipe/js/tasks-text.textformatoptions#textformatoptionstitle) |   | string | The title of the text to be embedded. Only used for document embeddings. |
| [textRole](https://developers.google.com/edge/api/mediapipe/js/tasks-text.textformatoptions#textformatoptionstextrole) |   | TextRole | The role of the text to be embedded. |

## 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;