Skip to content

mistral_common.protocol.embedding.response

EmbeddingObject(**data)

Bases: MistralBase

Embedding object returned by the API.

Attributes:

Name Type Description
object str

The type of the object returned.

embedding List[float]

The embedding vector.

index int

The index of the embedding in the input text.

Examples:

>>> embedding_object = EmbeddingObject(
...    object="embedding",
...    embedding=[0.1, 0.2, 0.3],
...    index=0
... )
Source code in .venv/lib/python3.13/site-packages/pydantic/main.py
def __init__(self, /, **data: Any) -> None:
    """Create a new model by parsing and validating input data from keyword arguments.

    Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
    validated to form a valid model.

    `self` is explicitly positional-only to allow `self` as a field name.
    """
    # `__tracebackhide__` tells pytest and some other tools to omit this function from tracebacks
    __tracebackhide__ = True
    validated_self = self.__pydantic_validator__.validate_python(data, self_instance=self)
    if self is not validated_self:
        warnings.warn(
            'A custom validator is returning a value other than `self`.\n'
            "Returning anything other than `self` from a top level model validator isn't supported when validating via `__init__`.\n"
            'See the `model_validator` docs (https://docs.pydantic.dev/latest/concepts/validators/#model-validators) for more details.',
            stacklevel=2,
        )

EmbeddingResponse(**data)

Bases: MistralBase

"Embedding response returned by the API.

See the EmbeddingRequest for the request body.

Attributes:

Name Type Description
id str

The ID of the embedding.

object str

The type of the object returned.

data List[EmbeddingObject]

List of embeddings.

model str

The model used to generate the embeddings.

Examples:

>>> response = EmbeddingResponse(
...    id="embd-123",
...    object="list",
...    data=[],
...    model="text-embedding-ada-002",
...    usage=UsageInfo(prompt_tokens=1, total_tokens=1, completion_tokens=0)
... )
Source code in .venv/lib/python3.13/site-packages/pydantic/main.py
def __init__(self, /, **data: Any) -> None:
    """Create a new model by parsing and validating input data from keyword arguments.

    Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
    validated to form a valid model.

    `self` is explicitly positional-only to allow `self` as a field name.
    """
    # `__tracebackhide__` tells pytest and some other tools to omit this function from tracebacks
    __tracebackhide__ = True
    validated_self = self.__pydantic_validator__.validate_python(data, self_instance=self)
    if self is not validated_self:
        warnings.warn(
            'A custom validator is returning a value other than `self`.\n'
            "Returning anything other than `self` from a top level model validator isn't supported when validating via `__init__`.\n"
            'See the `model_validator` docs (https://docs.pydantic.dev/latest/concepts/validators/#model-validators) for more details.',
            stacklevel=2,
        )