DESCRIBE AGENT

Cortex Agent のプロパティについて説明します。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。

CREATE に AGENT、 DROP AGENT、 SHOW AGENTS

構文

{ DESC | DESCRIBE } AGENT <name>
Copy

パラメーター

name

説明するエージェントの名前を指定します。

識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

詳細については、 識別子の要件 をご参照ください。

出力

コマンド出力では、次の列にCortex Agentのプロパティとメタデータが提供されます。

列

説明

name

エージェントの名前。

database_name

エージェントを含むデータベース。

schema_name

エージェントを含むスキーマ。

owner

エージェントの所有者ロール。

comment

エージェントのコメントテキスト。

profile

エージェントプロファイル JSON （display_name、avatar、color）。

agent_spec

エージェントの完全な YAML 仕様。

created_on

エージェントが作成されたときのタイムスタンプ。

アクセス制御の要件

この SQL コマンドの実行に使用される ロール には、 最低 1 つ の次の 権限 が必要です。

権限

オブジェクト

メモ

これらの権限のいずれか1つ: OWNERSHIP、 USAGE、 MONITOR または OPERATE

エージェント

スキーマ内のオブジェクトに対して操作を実行するには、親データベースとスキーマに対する USAGE 権限が必要です。スキーマに対する 任意の権限を付与されたロールは、そのロールがスキーマを解決できることに注意してください。たとえば、スキーマに対するCREATE権限を付与されたロールは、そのスキーマにオブジェクトを作成できますが、そのスキーマに対するUSAGE*も*付与されている必要はありません。

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意

  • このコマンドの出力を後処理するには、 パイプ演算子 （->>）または RESULT_SCAN 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。

    このコマンドの出力列名は小文字で生成されます。パイプ演算子または でこのコマンドの結果セットを消費する場合 RESULT_SCAN 関数の場合は、を使用します 二重引用符で囲まれた識別子 クエリの列名に を使用し、スキャンされた出力の列名と一致するようにします。たとえば、出力列の名前が次の場合 type``次に を指定します ``"type" 識別子用。

例

TEST_DATABASE データベースと TEST_SCHEMA スキーマに、 MY_AGENT1 という名前のCortex Agentを記述します。

DESCRIBE AGENT mydb.myschema.my_agent;
Copy

この例のステートメントは、以下の出力を表示します。

+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+
| name  | database_name | schema_name | owner     | comment          | profile                            | agent_spec                       | created_on         |
|--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------|
|| TEST_AGENT | EXAMPLE_DB   | AGENTS | TEST_ROLE | null | {"display_name":"test"} | "{\"models\":{\"orchestration\":\"llama3.1-70B\"},\"nested\":{\"key\":\"value\"}},\"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_analyst_sql_exec\",\"name\":\"SQL_exec1\"}},{\"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_unable_to_answer\":\"I don't know the answer to that\",\"tool_resources\":{\"Analyst1\":{\"semantic_model_file\":\"stage1\"},\"Analyst2\":{\"semantic_view\":\"db.schema.semantic_view\"},\"Search1\":{\"name\":\"db.schema.service_name\",\"Max_results\":\"5\",\"filter\":{\"@eq\":{\"region\":\"North America\"}},\"Title_column\":\"<title_name>\",\"ID_column\":\"<column_name>\"},\"SQL_exec1\":{\"Name\":\"my_warehouse\",\"Timeout\":\"30\",\"AutoExecute\":\"true\"},\"web_search\":{\"name\":\"web_search_1\",\"Function\":\"db/schema/search_web\"}}}" | 2025-09-15 17:04:37.263 +0000 |
+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+

次の例では、現在のスキーマのエージェントを記述しています。

DESCRIBE AGENT my_agent;
Copy

以下の例では、 JSON 形式のリソースとしてエージェントを記述しています。

DESCRIBE AS RESOURCE AGENT my_agent;
Copy
言語: 日本語