> For the complete documentation index, see [llms.txt](https://utca.knowledgator.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://utca.knowledgator.com/tasks/transformerstextembedding.md).

# TransformersTextEmbedding

Text embedding task

Subclass of [**Task**](/tasks/task.md)**.** 

## Module: [implementation](/framework-structure.md#implementation).tasks

## Default predictor

This task uses [**TransformersModel**](/predictors/transformers-predictors.md#transformersmodel) by default with this configuration:

{% code overflow="wrap" fullWidth="false" %}

```python
model = AutoModel.from_pretrained("BAAI/bge-large-en-v1.5")
predictor = TransformersModel(
    TransformersModelConfig(
        model=model
    ),
    input_class=TransformersEmbeddingInput,
    output_class=TransformersEmbeddingOutput,
)
```

{% endcode %}

#### See:

* [**TransformersModel**](/predictors/transformers-predictors.md#transformersmodel) 
* [**TransformersModelConfig**](/predictors/transformers-predictors.md#transformersmodelconfig)
* [**TransformersEmbeddingInput**](/predictors/transformers-schemas.md#transformersembeddinginput)
* [**TransformersEmbeddingOutput**](/predictors/transformers-schemas.md#transformersembeddingoutput)

## Methods and properties

Main methods and properties

***

### <mark style="color:blue;">\_\_init\_\_</mark>

#### Arguments:

* <mark style="color:orange;">**predictor**</mark>**&#x20;(**[**Predictor**](/predictors/predictor.md)**\[Any, Any], optional):** Predictor that will be used in task. If equals to None, [**default predictor**](#default-predictor) will be used. Defaults to None.
* <mark style="color:orange;">**preprocess**</mark>**&#x20;(Optional\[**[**Component**](/core/component.md)**], optional):** Component executed before predictor. If equals to None, default component will be used. Defaults to None.\
  \
  Default component: \
  [**EmbeddingPreprocessor**](#embeddingpreprocessor)\
  \
  If default chain is used, [**EmbeddingPreprocessor**](#embeddingpreprocessor) will use **AutoTokenizer** from predictor model.
* <mark style="color:orange;">**postprocess**</mark>**&#x20;(Optional\[**[**Component**](/core/component.md)**], optional):** Component executed after predictor. If equals to None, default component will be used. Defaults to None.\
  \
  Default component: \
  [**EmbeddingPostprocessor**](#embeddingpostprocessor) **|** [**ConvertEmbeddingsToNumpyArrays**](#convertembeddingstonumpyarrays)
* <mark style="color:orange;">**input\_class**</mark>**&#x20;(Type\[**[**Input**](/core/schemas.md#input)**], optional):** Class for input validation. Defaults to [**TextEmbeddingInput**](#textembeddinginput)**.**
* <mark style="color:orange;">**output\_class**</mark>**&#x20;(Type\[**[**Output**](/core/schemas.md#output)**], optional):** Class for output validation. Defaults to [**TextEmbeddingOutput**](#textembeddingoutput)**.**
* <mark style="color:orange;">**name**</mark>**&#x20;(Optional\[str], optional):** Name for identification. If equals to None, class name will be used. Defaults to None.

***

***

***

## <mark style="color:green;">TextEmbeddingInput</mark>

Subclass of [**IOModel**](/core/schemas.md#iomodel)**.**

***

### <mark style="color:blue;">\_\_init\_\_</mark>

#### Arguments:

* <mark style="color:orange;">**texts**</mark>**&#x20;(List\[str]):** Texts to process.

***

***

***

## <mark style="color:green;">TextEmbeddingOutput</mark>

Subclass of [**IOModel**](/core/schemas.md#iomodel)**.**

***

### <mark style="color:blue;">\_\_init\_\_</mark>

#### Arguments:

* <mark style="color:orange;">**embeddings**</mark>**&#x20;(Any)**

***

***

***

## <mark style="color:green;">EmbeddingPreprocessor</mark>

Prepare model input. Subclass of [**Action**](/core/action.md). Type of [**Action**](/core/action.md)**\[Dict\[str, Any], Dict\[str, Any]].**

***

### <mark style="color:blue;">\_\_init\_\_</mark>

#### Arguments:

* <mark style="color:orange;">**tokenizer**</mark>**&#x20;(Tokenizer):** Tokenize&#x72;**.**
* <mark style="color:orange;">**name**</mark>**&#x20;(Optional\[str], optional):** Name for identification. If equals to None, class name will be used. Defaults to None.

***

### <mark style="color:blue;">execute</mark>

#### Arguments:

* <mark style="color:orange;">**input\_data**</mark>**&#x20;(Dict\[str, Any]):** \
  Expected keys:
  * <mark style="color:red;">**"texts"**</mark> **(List\[str]):** Texts to process;

#### Returns:

* **Dict\[str, Any]:** \
  Expected keys:
  * <mark style="color:red;">**"encodings"**</mark>**&#x20;(Any):** Model input&#x73;**;**

***

***

***

## <mark style="color:green;">EmbeddingPostprocessor</mark>

Process model output. Subclass of [**Action**](/core/action.md). Type of [**Action**](/core/action.md)**\[Dict\[str, Any], Dict\[str, Any]].**

***

### <mark style="color:blue;">execute</mark>

#### Arguments:

* <mark style="color:orange;">**input\_data**</mark>**&#x20;(Dict\[str, Any]):** \
  Expected keys:
  * <mark style="color:red;">**"last\_hidden\_state"**</mark>**&#x20;(Any):** Model output;

#### Returns:

* **Dict\[str, Any]:** \
  Expected keys:
  * <mark style="color:red;">**"embeddings"**</mark>**&#x20;(Any);**

***

***

***

## <mark style="color:green;">ConvertEmbeddingsToNumpyArrays</mark>

Convert embeddings to numpy arrays. Subclass of [**Action**](/core/action.md). Type of \
[**Action**](/core/action.md)**\[Dict\[str, Any], Dict\[str, Any]].**

***

### <mark style="color:blue;">execute</mark>

#### Arguments:

* <mark style="color:orange;">**input\_data**</mark>**&#x20;(Dict\[str, Any]):** \
  Expected keys:
  * <mark style="color:red;">**"embeddings"**</mark>**&#x20;(Any)**;

#### Returns:

* **Dict\[str, Any]:** \
  Expected keys:
  * <mark style="color:red;">**"embeddings"**</mark>**&#x20;(Any);**

***

***