openfoodfacts_proxy.models.search_a_licious

source package openfoodfacts_proxy.models.search_a_licious

Classes

• DistributionChartType — Describe a distribution chart entry for Search-a-licious.

• ErrorSearchResponse — Represent an error response returned by Search-a-licious.

• FacetInfo — Describe a Search-a-licious facet aggregation.

• FacetItem — Describe a single Search-a-licious facet item.

• ScatterChartType — Describe a scatter chart entry for Search-a-licious.

• SearchALiciousAutocompleteResponse — Represent a generic autocomplete response from Search-a-licious.

• SearchALiciousDocumentResponse — Represent a generic document response from Search-a-licious.

• SearchALiciousHealthResponse — Represent a generic health response from Search-a-licious.

• SearchParameters — Common Search-a-licious POST parameters.

• SearchResponseDebug — Expose Search-a-licious debug details.

• SearchResponseError — Represent a Search-a-licious warning or error item.

• SuccessSearchResponse — Represent a successful Search-a-licious search response.

source class DistributionChartType(**data: Any)

Bases : BaseModel

Describe a distribution chart entry for Search-a-licious.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class ErrorSearchResponse(**data: Any)

Bases : BaseModel

Represent an error response returned by Search-a-licious.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class FacetInfo(**data: Any)

Bases : BaseModel

Describe a Search-a-licious facet aggregation.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class FacetItem(**data: Any)

Bases : BaseModel

Describe a single Search-a-licious facet item.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class ScatterChartType(**data: Any)

Bases : BaseModel

Describe a scatter chart entry for Search-a-licious.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class SearchALiciousAutocompleteResponse(**data: Any)

Bases : BaseModel

Represent a generic autocomplete response from Search-a-licious.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class SearchALiciousDocumentResponse(**data: Any)

Bases : BaseModel

Represent a generic document response from Search-a-licious.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class SearchALiciousHealthResponse(**data: Any)

Bases : BaseModel

Represent a generic health response from Search-a-licious.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class SearchParameters(**data: Any)

Bases : BaseModel

Common Search-a-licious POST parameters.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class SearchResponseDebug(**data: Any)

Bases : BaseModel

Expose Search-a-licious debug details.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class SearchResponseError(**data: Any)

Bases : BaseModel

Represent a Search-a-licious warning or error item.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class SuccessSearchResponse(**data: Any)

Bases : BaseModel

Represent a successful Search-a-licious search response.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.