DESCRIBE EXTERNAL AGENT¶

Beschreibt die Eigenschaften eines externen Agenten. Externe Agenten stehen für generative AI-Anwendungen in Snowflake zur Verwendung mit AI-Beobachtbarkeit.

DESCRIBE kann mit DESC abgekürzt werden.

Siehe auch:: CREATE EXTERNAL AGENT, ALTER EXTERNAL AGENT, DROP EXTERNAL AGENT, SHOW EXTERNAL AGENTS

Syntax¶

{ DESC | DESCRIBE } EXTERNAL AGENT <name>

Parameter¶

name

Gibt den Bezeichner für den zu beschreibenden externen Agenten an.

Wenn der Bezeichner Leerzeichen oder Sonderzeichen enthält, muss die gesamte Zeichenfolge in doppelte Anführungszeichen gesetzt werden. Bei Bezeichnern, die in doppelte Anführungszeichen eingeschlossen sind, ist auch die Groß- und Kleinschreibung zu beachten.

Weitere Informationen dazu finden Sie unter Anforderungen an Bezeichner.

Ausgabe¶

Die Befehlsausgabe enthält Eigenschaften und Metadaten des externen Agenten in den folgenden Spalten:


Spalte	Beschreibung
`created_on`	Zeitstempel, wann der externe Agent erstellt wurde.
`name`	Name des externen Agenten.
`database_name`	Datenbank, die den externen Agenten enthält.
`schema_name`	Schema, das den externen Agenten enthält.
`owner`	Rolle, die Eigentümer der externen Tabelle ist.
`comment`	Kommentar zum externen Agenten.
`versions`	JSON-Array mit den Versionen des externen Agenten.
`default_version_name`	Standardversion des externen Agenten.

Anforderungen an die Zugriffssteuerung¶

Eine Rolle, die zur Ausführung dieses SQL-Befehls verwendet wird, muss mindestens eine der folgenden Berechtigungen haben:


Berechtigung	Objekt	Anmerkungen
Eine dieser Berechtigungen: OWNERSHIP, USAGE	Externer Agent

Für das Ausführen von Operationen für ein Objekt in einem Schema ist mindestens eine Berechtigung für die übergeordnete Datenbank und mindestens eine Berechtigung für das übergeordnete Schema erforderlich.

Eine Anleitung zum Erstellen einer kundenspezifischen Rolle mit einer bestimmten Gruppe von Berechtigungen finden Sie unter Erstellen von kundenspezifischen Rollen.

Allgemeine Informationen zu Rollen und Berechtigungen zur Durchführung von SQL-Aktionen auf sicherungsfähigen Objekten finden Sie unter Übersicht zur Zugriffssteuerung.

Nutzungshinweise¶

Um die Ausgabe dieses Befehls nachzubearbeiten, können Sie den Befehl Pipe-Operator (->>) oder die RESULT_SCAN-Funktion verwenden. Beide Konstrukte behandeln die Ausgabe als Resultset, das Sie abfragen können.

Sie können zum Beispiel den Pipe-Operator oder die RESULT_SCAN-Funktion verwenden, um bestimmte Spalten aus der SHOW-Befehlsausgabe auszuwählen oder die Zeilen zu filtern.

Wenn Sie sich auf die Ausgabespalten beziehen, verwenden Sie Bezeichner mit doppelten Anführungszeichen für die Spaltennamen. Um beispielsweise die Ausgabespalte type auszuwählen, geben Sie SELECT "type" an.

Sie müssen Bezeichner in doppelten Anführungszeichen verwenden, da die Ausgabespaltennamen für SHOW-Befehle in Kleinbuchstaben geschrieben sind. Die doppelten Anführungszeichen stellen sicher, dass die Spaltennamen in der SELECT-Liste oder WHERE-Klausel den Spaltennamen in der SHOW-Befehlsausgabe entsprechen, die gescannt wurde.

Beispiele¶

Beschreiben eines externen Agenten:

DESCRIBE EXTERNAL AGENT my_rag_app;

Beschreiben eines externen Agenten in einer bestimmten Datenbank und einem bestimmten Schema:

DESCRIBE EXTERNAL AGENT mydb.myschema.my_rag_app;