DESCRIBE AGENT
DESCRIBE AGENT
DESCRIBE AGENT 명령은 Cortex Agent의 속성을 설명하는 명령이에요. DESCRIBE는 DESC로 줄여 쓸 수 있습니다.
출처: DESCRIBE AGENT
본문
Cortex Agent의 속성을 설명하는 명령입니다. DESCRIBE는 DESC로 줄여 쓸 수 있어요.
관련 명령: ALTER AGENT, CREATE AGENT, DROP AGENT, SHOW AGENTS, DATA_AGENT_RUN (SNOWFLAKE.CORTEX)
Syntax
{ DESC | DESCRIBE } [ AS RESOURCE ] AGENT <name>
Parameters
AS RESOURCE— 에이전트 정의를 Output에서 설명하는 컬럼 대신 JSON 형식의 리소스로 반환해요.name— 설명할 에이전트의 이름을 지정해요. 식별자에 공백이나 특수 문자가 포함되면 전체 문자열을 큰따옴표로 감싸야 합니다. 큰따옴표로 감싼 식별자는 대소문자를 구분해요. 자세한 내용은 Identifier requirements 문서를 참고하세요.
Output (출력)
명령 출력은 다음 컬럼으로 Cortex Agent 속성과 메타데이터를 제공해요.
- 에이전트의 완전한 JSON 사양. 보안 에이전트의 경우 소유 역할이 세션에서 활성화되지 않으면 이 컬럼은
NULL을 반환해요.
Access control requirements (접근 제어 요구 사항)
이 SQL 명령을 실행하는 데 사용되는 역할은 최소한 다음 권한 중 하나를 보유해야 해요.
스키마의 객체를 조작하려면 상위 데이터베이스에 대한 권한과 상위 스키마에 대한 권한이 각각 최소 하나씩 필요합니다. 지정된 권한 집합으로 사용자 정의 역할을 만드는 방법은 Creating custom roles 문서를, 보안 객체에 대한 SQL 작업의 역할·권한 부여에 대한 일반적인 정보는 Overview of Access Control 문서를 참고하세요.
Examples (예제)
mydb 데이터베이스와 myschema 스키마에 있는 my_agent라는 Cortex Agent를 설명해 봅시다.
DESCRIBE AGENT mydb.myschema.my_agent;
예제의 문은 다음 출력을 출력해요.
+----------+---------------+-------------+-----------+---------+-------------------------+------------+-------------------------------+
| name | database_name | schema_name | owner | comment | profile | agent_spec | created_on |
|----------+---------------+-------------+-----------+---------+-------------------------+------------+-------------------------------|
| MY_AGENT | MYDB | MYSCHEMA | TEST_ROLE | NULL | {"display_name":"test"} | "{\"models\":{\"orchestration\":\"auto\"},\"orchestration\":{\"budget\":{\"seconds\":30,\"tokens\":16000}},\"instructions\":{\"response\":\"You will respond in a friendly but concise manner\",\"orchestration\":\"For any revenue question use Analyst; for policy use Search\",\"system\":\"You are a friendly agent.\",\"sample_questions\":[{\"question\":\"question 1\"},{\"question\":\"question 2\"},{\"question\":\"question 3\"}]},\"tools\":[{\"tool_spec\":{\"type\":\"cortex_analyst_text_to_sql\",\"name\":\"Analyst1\",\"description\":\"test\"}},{\"tool_spec\":{\"type\":\"cortex_search\",\"name\":\"Search1\"}},{\"tool_spec\":{\"type\":\"web_search\",\"name\":\"web_search_1\"}},{\"tool_spec\":{\"type\":\"generic\",\"name\":\"get_weather\",\"input_schema\":{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state\"}},\"required\":[\"location\"]}}}],\"tool_resources\":{\"Analyst1\":{\"semantic_view\":\"db.schema.semantic_view\",\"execution_environment\":{\"type\":\"warehouse\",\"warehouse\":\"my_warehouse\",\"query_timeout\":30}},\"Search1\":{\"search_service\":\"db.schema.service_name\",\"max_results\":5,\"filter\":{\"@eq\":{\"region\":\"North America\"}},\"title_column\":\"<title_name>\",\"id_column\":\"<column_name>\"},\"web_search_1\":{\"max_results\":20}}} | 2025-09-15 17:04:37.263 +0000 |
+----------+---------------+-------------+-----------+---------+-------------------------+------------+-------------------------------+
다음 예제는 현재 스키마의 에이전트를 설명해요.
DESCRIBE AGENT my_agent;
다음 예제는 에이전트를 JSON 형식의 리소스로 설명해요.
DESCRIBE AS RESOURCE AGENT my_agent;