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

from ..core.pydantic_utilities import UniversalBaseModel
import typing
from .composite_retrieval_mode import CompositeRetrievalMode
import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2


class PresetCompositeRetrievalParams(UniversalBaseModel):
    mode: typing.Optional[CompositeRetrievalMode] = pydantic.Field(default=None)
    """
    The mode of composite retrieval.
    """

    rerank_top_n: typing.Optional[int] = pydantic.Field(default=None)
    """
    The number of nodes to retrieve after reranking over retrieved nodes from all retrieval tools.
    """

    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
