# 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 .search_result_item import SearchResultItem


class SearchResponse(UniversalBaseModel):
    """
    Response from the search endpoint.
    """

    query: str = pydantic.Field()
    """
    The search query that was used
    """

    results: typing.Optional[typing.List[SearchResultItem]] = pydantic.Field(default=None)
    """
    List of search results
    """

    total: int = pydantic.Field()
    """
    Total number of results across all types
    """

    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
