snowflake.core.cortex.search_service.QueryRequest | Snowflake Documentation (original) (raw)

class snowflake.core.cortex.search_service.QueryRequest(*, query: Annotated[str, Strict(strict=True)] | None = None, multi_index_query: Dict[str, ColumnQuery] | None = None, columns: List[Annotated[str, Strict(strict=True)]], filter: Dict[str, Any] | None = None, limit: Annotated[int, Strict(strict=True)] | None = 10, scoring_config: ScoringConfig | 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:

• columns (List [ str ]) – List of columns to return.
• query (str , optional) – Unstructured text query. Exactly one of ‘query’ or ‘multi_index_query’ must be specified.
• multi_index_query (ColumnQuery , optional) – A search query expressed as a collection of multiple column-level queries. Exactly one of ‘query’ or ‘multi_index_query’ must be specified.
• filter (object , optional) – Filter query.
• limit (int , default 10) – Max number of results to return.
• scoring_config (ScoringConfig , optional)
• 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.