snowflake.core.cortex.lite_agent_service.AgentRunRequestΒΆ

class snowflake.core.cortex.lite_agent_service.AgentRunRequest(*, models: AgentModels | None = None, orchestration: AgentOrchestration | None = None, instructions: AgentInstructions | None = None, model: Annotated[str, Strict(strict=True)] | None = None, 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, thread_id: Annotated[int, Strict(strict=True)] | None = None, parent_message_id: Annotated[int, Strict(strict=True)] | None = None)ΒΆ

Bases: BaseModel

A model object representing the AgentRunRequest resource.

Constructs an object of type AgentRunRequest with the provided properties.

Parameters:

  • messages (list[Message]) – The conversation history and current message. Contains both user queries and assistant responses in chronological order.

  • models (AgentModels, optional)

  • orchestration (AgentOrchestration, optional)

  • instructions (AgentInstructions, optional)

  • model (str, optional) – The identifier of the LLM to use for processing.

  • 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)

  • thread_id (int, optional) – The id of the thread.

  • parent_message_id (int, optional) – The id of the message from which this run should begin.

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.

Language: English