snowflake.core.cortex.lite_agent_service.AgentRunRequest | Snowflake Documentation (original) (raw)

class snowflake.core.cortex.lite_agent_service.AgentRunRequest(*, model: Annotated[str, Strict(strict=True)], response_instruction: Annotated[str, Strict(strict=True)] | None = None, experimental: Dict[str, Any] | None = None, messages: Annotated[List[Message], MinLen(min_length=1)], tools: List[Tool] | None = None, tool_resources: Dict[str, Dict[str, Any]] | None = None, tool_choice: ToolChoice | None = None)¶

Bases: BaseModel

A model object representing the AgentRunRequest resource.

Constructs an object of type AgentRunRequest with the provided properties.

Parameters:

• model (str) – The identifier of the LLM to use for processing.
• messages (List [ Message ]) – The conversation history and current message. Contains both user queries and assistant responses in chronological order.
• response_instruction (str , optional) – Optional instructions to guide the model’s response style and behavior. Can be used to set the tone, format, or specific requirements for responses.
• experimental (object , optional) – reserved
• tools (List [ Tool ] , optional) – List of tools available for the agent to use. Tools may have a corresponding configuration in tool_resources.
• tool_resources (Dict [ str , object ] , optional) – Configuration for each tool referenced in the tools array. Keys must match the name field of tools.
• tool_choice (ToolChoice , optional)

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) → AgentRunRequest¶

Create an instance of AgentRunRequest from a dict.

classmethod from_json(json_str: str) → AgentRunRequest¶

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