Skip to content
RelationalAI Docs

DeploymentConfig

relationalai.agent.cortex.deployment_config 
DeploymentConfig(
    database: str,
    schema: str,
    agent_name: str,
    model_name: Optional[str] = None,
    warehouse: Optional[str] = None,
    stage_name: str = "rai_sprocs",
    manage_stage: bool = True,
    llm: str = "claude-sonnet-4-5",
    query_timeout_s: int = 300,
    external_access_integration: str = "S3_RAI_INTERNAL_BUCKET_EGRESS_INTEGRATION",
    artifact_repository: str = "snowflake.snowpark.pypi_shared_repository",
    budget_seconds: Optional[int] = None,
    budget_tokens: Optional[int] = None,
    allow_preview: bool = False,
)

Configuration for Cortex agent deployment to Snowflake.

Parameters

Section titled “Parameters”

  • database

    (str) - Snowflake database where agent will be deployed.

  • schema

    (str) - Snowflake schema where agent will be deployed. To enable interaction through the Snowflake Intelligence UI, deploy to the schema configured for your account (typically AGENTS).

  • agent_name

    (str) - Unique name for the Cortex agent within the schema.

  • model_name

    (str, default: None) - Name for the Model instance created inside each stored procedure. Default: same as agent_name.

  • warehouse

    (str, default: None) - Snowflake warehouse the Cortex agent will use when executing RAI tools. If provided, SI users need USAGE on this warehouse. If not provided, tools use the caller’s session warehouse. Stored procedures are created with CALLER’S RIGHTS.

  • stage_name

    (str, default: “rai_sprocs”) - Name of the Snowflake stage for storing sproc dependencies. Default: "rai_sprocs".

  • manage_stage

    (bool, default: True) - If True, automatically create/drop the stage during deploy/cleanup. Set to False if using a pre-existing stage. Default: True.

  • llm

    (str, default: “claude-sonnet-4-5”) - Language model to use for agent orchestration. Must be a model available in Snowflake Cortex. Default: "claude-sonnet-4-5".

  • query_timeout_s

    (int, default: 300) - Timeout in seconds for stored procedure execution. Default: 300.

  • external_access_integration

    (str, default: “S3_RAI_INTERNAL_BUCKET_EGRESS_INTEGRATION”) - Snowflake external access integration required at sproc runtime for RAI API access. Established by the default RAI installation. Default: "S3_RAI_INTERNAL_BUCKET_EGRESS_INTEGRATION".

  • artifact_repository

    (str, default: “snowflake.snowpark.pypi_shared_repository”) - Snowflake artifact repository required at sproc runtime for Python package resolution. Established by the default RAI installation. Default: "snowflake.snowpark.pypi_shared_repository".

  • budget_seconds

    (int, default: None) - Time budget in seconds for agent execution. If specified, the agent will terminate when this limit is hit. Can be used with budget_tokens.

  • budget_tokens

    (int, default: None) - Token budget for model consumption. If specified, the agent will terminate when this limit is hit. Can be used with budget_seconds.

  • allow_preview

    (bool, default: False) - Allow Preview capabilities (e.g., queries). Default: False.

Examples

Section titled “Examples”
>>> config = DeploymentConfig(
...     database="APPS",
...     schema="AUSTIN",
...     agent_name="jaffle_assistant",
...     warehouse="COMPUTE_WH",
...     llm="claude-sonnet-4-5",
... )

Used By

Section titled “Used By”
 agent > cortex > cortex_agent_manager
└──  CortexAgentManager