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

import typing

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


class ScoredDocument(UniversalBaseModel):
    """
    A document with its relevance score and metadata.
    """

    doc_id: typing.Optional[str] = pydantic.Field(default=None)
    """
    The document ID.
    """

    score: typing.Optional[float] = pydantic.Field(default=None)
    """
    The overall relevance score for this document.
    """

    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
    """
    Document metadata object containing all document metadata fields.
    """

    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
