snowflake.core.cortex.chat_service.ChatRequest | Snowflake Documentation (original) (raw)

class snowflake.core.cortex.chat_service.ChatRequest(*, query: Annotated[str, Strict(strict=True)], model: Annotated[str, Strict(strict=True)] | None = None, search_services: List[ChatRequestSearchServicesInner] | None = None, semantic_models: List[ChatRequestSemanticModelsInner] | None = None, prompt: Annotated[str, Strict(strict=True)] | None = None, messages: List[ChatRequestMessagesInner] | None = None, debug: Annotated[bool, Strict(strict=True)] | None = None, max_results: Annotated[int, Strict(strict=True)] | None = None, experimental: Dict[str, Any] | None = None)¶

Bases: BaseModel

A model object representing the ChatRequest resource.

Constructs an object of type ChatRequest with the provided properties.

Parameters:

• query (str) – Unstructured text query.
• model (str , optional) – The model to be used for the chat.
• search_services (List [ ChatRequestSearchServicesInner ] , optional) – List of search services.
• semantic_models (List [ ChatRequestSemanticModelsInner ] , optional) – The semantic models to be used for Cortex Analyst
• prompt (str , optional) – Additional prompt text.
• messages (List _[_ChatRequestMessagesInner] , optional) – List of conversation messages.
• debug (bool , optional) – Whether to return debug information.
• max_results (int , optional) – Global max number of results from search for llm generation. If not set, default to sum of max_results across list of search_service.
• 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) → ChatRequest¶

Create an instance of ChatRequest from a dict.

classmethod from_json(json_str: str) → ChatRequest¶

Create an instance of ChatRequest 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.