Skip to content

openfoodfacts_proxy.models.search_a_licious.success_search_response

[docs] module openfoodfacts_proxy.models.search_a_licious.success_search_response 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
from typing import Any

from pydantic import BaseModel

from openfoodfacts_proxy.models.search_a_licious.facet_info import FacetInfo
from openfoodfacts_proxy.models.search_a_licious.search_response_debug import SearchResponseDebug
from openfoodfacts_proxy.models.search_a_licious.search_response_error import SearchResponseError


class SuccessSearchResponse(BaseModel):
    """Represent a successful Search-a-licious search response."""

    hits: list[dict[str, Any]]
    aggregations: dict[str, Any] | None = None
    facets: dict[str, FacetInfo] | None = None
    charts: dict[str, dict[str, Any]] | None = None
    page: int
    page_size: int
    page_count: int
    debug: SearchResponseDebug
    took: int
    timed_out: bool
    count: int
    is_count_exact: bool
    warnings: list[SearchResponseError] | None = None