snowflake.core.cortex.search_service.QueryRequestΒΆ

class snowflake.core.cortex.search_service.QueryRequest(*, query: Annotated[str, Strict(strict=True)] | None = None, multi_index_query: Dict[str, Any] | None = None, columns: List[Annotated[str, Strict(strict=True)]] | None = None, filter: Dict[str, Any] | None = None, limit: Annotated[int, Strict(strict=True)] | None = 10, scoring_config: ScoringConfig | None = None, scoring_profile: Annotated[str, Strict(strict=True)] | None = None, experimental: Dict[str, Any] | None = None)ΒΆ

Bases: BaseModel

A model object representing the QueryRequest resource.

Constructs an object of type QueryRequest with the provided properties.

Parameters:

  • query (str, optional) – Unstructured text query. Exactly one of β€˜query’ or β€˜multi_index_query’ must be specified.

  • multi_index_query (object, optional) – A search query expressed as a collection of multiple column-level queries. Exactly one of β€˜query’ or β€˜multi_index_query’ must be specified. A column/index can be queried with multiple queries.

  • columns (list[str], optional) – List of columns to return.

  • filter (object, optional) – Filter query.

  • limit (int, default 10) – Max number of results to return.

  • scoring_config (ScoringConfig, optional)

  • scoring_profile (str, optional) – Mutually exclusive with scoring_config. Specifies the pre-defined name of a profile on the cortex search service that resolves to scoring_config.

  • experimental (object, optional) – reserved

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.

Methods

classmethod from_dict(obj: dict) β†’ QueryRequestΒΆ

Create an instance of QueryRequest from a dict.

classmethod from_json(json_str: str) β†’ QueryRequestΒΆ

Create an instance of QueryRequest from a JSON string.

to_dict(hide_readonly_properties: bool = False) β†’ dict[str, Any]ΒΆ

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() β†’ dict[str, Any]ΒΆ

Return the dictionary representation of the model without readonly properties.

to_json() β†’ strΒΆ

Returns the JSON representation of the model using alias.

to_str() β†’ strΒΆ

Returns the string representation of the model using alias.

Language: English