DESCRIBE EXTERNAL AGENT

描述外部代理的属性。在 Snowflake 中，外部代理代表生成式 AI 应用程序，用于 AI 可观察性。

DESCRIBE 可以缩写为 DESC。

另请参阅：

CREATE EXTERNAL AGENT、ALTER EXTERNAL AGENT、DROP EXTERNAL AGENT、SHOW EXTERNAL AGENTS

语法

{ DESC | DESCRIBE } EXTERNAL AGENT <name>

参数

name

指定要描述的外部代理的标识符。

如果标识符包含空格或特殊字符，则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。

有关更多信息，请参阅 标识符要求。

输出

命令输出在以下列中提供外部代理属性和元数据：

列

描述

created_on

创建外部代理时的时间戳。

name

外部代理的名称。

database_name

包含外部代理的数据库。

schema_name

包含外部代理的模式。

owner

拥有外部代理的角色。

comment

对外部代理进行注释。

versions

列出外部代理版本的 JSON 数组。

default_version_name

外部代理的默认版本。

访问控制要求

用于执行此 SQL 命令的 角色 必须至少具有以下 一项 权限：

权限

对象

备注

以下任何一项权限：OWNERSHIP、USAGE

External Agent

对架构中的对象进行操作至少需要父数据库的一项权限和父架构的一项权限。

有关创建具有指定权限集的自定义角色的说明，请参阅 创建自定义角色。

有关对 安全对象 执行 SQL 操作的相应角色和权限授予的一般信息，请参阅 访问控制概述。

使用说明

  • 要对该命令的输出进行后处理，可以使用 管道运算符 (->>) 或 RESULT_SCAN 函数。这两种构造都将输出视为可以查询的结果集。

    例如，您可使用管道操作符或 RESULT_SCAN 函数，从 SHOW 命令输出中选择特定列或筛选行数据。

    引用输出列时，为列名使用 双引号标识符。例如，选择输出列 type，指定 SELECT "type"。

    必须使用双引号标识符，因为 SHOW 命令的输出列名均为小写格式。双引号确保 SELECT 列表或 WHERE 子句中的列名，与已扫描的 SHOW 命令输出中的列名完全匹配。

示例

描述外部代理：

DESCRIBE EXTERNAL AGENT my_rag_app;

描述特定数据库和模式中的外部代理：

DESCRIBE EXTERNAL AGENT mydb.myschema.my_rag_app;