DESCRIBE EXTERNAL AGENT¶

Décrit les propriétés d’un agent externe. Les agents externes représentent les applications AI génératives dans Snowflake à utiliser avec l’observabilité AI.

DESCRIBE peut être abrégé en DESC.

Voir aussi :: CREATE EXTERNAL AGENT, ALTER EXTERNAL AGENT, DROP EXTERNAL AGENT, SHOW EXTERNAL AGENTS

Syntaxe¶

{ DESC | DESCRIBE } EXTERNAL AGENT <name>

Paramètres¶

name

Indique l’identificateur de l’agent externe à décrire.

Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.

Pour plus d’informations, voir Exigences relatives à l’identificateur.

Sortie¶

La sortie de commande fournit les propriétés des agents externes et les métadonnées dans les colonnes suivantes :


Colonne	Description
`created_on`	Horodatage de la création de l’agent externe.
`name`	Nom de l’agent externe.
`database_name`	Base de données contenant l’agent externe.
`schema_name`	Schéma contenant l’agent externe.
`owner`	Rôle qui possède l’agent externe.
`comment`	Commentaire pour l’agent externe.
`versions`	Tableau JSON qui répertorie les versions de l’agent externe.
`default_version_name`	Version par défaut de l’agent externe.

Exigences en matière de contrôle d’accès¶

Un rôle utilisé pour exécuter cette commande SQL doit avoir au moins l’un des privilèges suivants définis au minimum ainsi :


Privilège	Objet	Remarques
N’importe lequel de ces privilèges : OWNERSHIP, USAGE	Agent externe

Pour effectuer une opération sur un objet dans un schéma, il est nécessaire de disposer d’au moins un privilège sur la base de données parente et d’au moins un privilège sur le schéma parent.

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Notes sur l’utilisation¶

Pour post-traiter la sortie de cette commande, vous pouvez utiliser l’opérateur de canal (->>) ou la fonction RESULT_SCAN. Les deux constructions traitent la sortie comme un jeu de résultats que vous pouvez interroger.

Par exemple, vous pouvez utiliser l’opérateur de canal ou la fonction RESULT_SCAN pour sélectionner des colonnes spécifiques à partir de la sortie de la commande SHOW ou pour filtrer les lignes.

Lorsque vous faites référence aux colonnes de sortie, utilisez des identificateurs entre guillemets doubles pour les noms des colonnes. Par exemple, pour sélectionner la colonne de sortie type, spécifiez SELECT "type".

Vous devez utiliser des identificateurs entre guillemets doubles, car les noms des colonnes de sortie pour les commandes SHOW sont en minuscules. Les guillemets doubles garantissent que les noms des colonnes dans la liste SELECT ou dans la clause WHERE correspondent aux noms des colonnes dans la sortie de la commande SHOW qui a été analysée.

Exemples¶

Décrire un volume externe :

DESCRIBE EXTERNAL AGENT my_rag_app;

Décrire un agent externe dans une base de données et un schéma spécifiques :

DESCRIBE EXTERNAL AGENT mydb.myschema.my_rag_app;