# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# pyformat: disable

"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""

from __future__ import annotations
from .. import BaseModel, UNSET_SENTINEL
from .filter_ import Filter, FilterParam
from .hybridsearch import HybridSearch, HybridSearchParam
from .ranking import Ranking, RankingParam
import pydantic
from pydantic import model_serializer
from typing import Optional
from typing_extensions import Annotated, NotRequired, TypedDict


class RagRetrievalConfigParam(TypedDict):
    r"""Specifies the context retrieval config."""

    filter_: NotRequired[FilterParam]
    r"""Config for filters."""
    hybrid_search: NotRequired[HybridSearchParam]
    r"""Config for Hybrid Search."""
    ranking: NotRequired[RankingParam]
    r"""Config for Rank Service."""
    top_k: NotRequired[int]
    r"""Optional. The number of contexts to retrieve."""


class RagRetrievalConfig(BaseModel):
    r"""Specifies the context retrieval config."""

    filter_: Annotated[Optional[Filter], pydantic.Field(alias="filter")] = None
    r"""Config for filters."""

    hybrid_search: Optional[HybridSearch] = None
    r"""Config for Hybrid Search."""

    ranking: Optional[Ranking] = None
    r"""Config for Rank Service."""

    top_k: Optional[int] = None
    r"""Optional. The number of contexts to retrieve."""

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = set(["filter", "hybrid_search", "ranking", "top_k"])
        serialized = handler(self)
        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k, serialized.get(n))

            if val != UNSET_SENTINEL:
                if val is not None or k not in optional_fields:
                    m[k] = val

        return m


try:
    RagRetrievalConfig.model_rebuild()
except NameError:
    pass
