Class TextEmbeddingInput (1.71.0)

TextEmbeddingInput(
    text: str,
    task_type: typing.Optional[str] = None,
    title: typing.Optional[str] = None,
)

Structural text embedding input.

Attributes

Name Description
text str
The main text content to embed.
task_type Optional[str]
The name of the downstream task the embeddings will be used for. Valid values: RETRIEVAL_QUERY Specifies the given text is a query in a search/retrieval setting. RETRIEVAL_DOCUMENT Specifies the given text is a document from the corpus being searched. SEMANTIC_SIMILARITY Specifies the given text will be used for STS. CLASSIFICATION Specifies that the given text will be classified. CLUSTERING Specifies that the embeddings will be used for clustering. QUESTION_ANSWERING Specifies that the embeddings will be used for question answering. FACT_VERIFICATION Specifies that the embeddings will be used for fact verification. CODE_RETRIEVAL_QUERY Specifies that the embeddings will be used for code retrieval.
title Optional[str]
Optional identifier of the text content.