# This file was auto-generated by Fern from our API Definition.

import typing

import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from .scored_document import ScoredDocument


class MetadataQueryResponse(UniversalBaseModel):
    """
    Returns document search results with relevance scores.
    """

    documents: typing.Optional[typing.List[ScoredDocument]] = pydantic.Field(default=None)
    """
    Matched documents ordered by relevance score (highest first).
    """

    total_count: typing.Optional[int] = pydantic.Field(default=None)
    """
    Total number of matching documents (for pagination).
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
