DESCRIBE EXTERNAL AGENT¶

Descreve as propriedades de um agente externo. Agentes externos representam aplicativos de AI generativa no Snowflake para uso com a observabilidade de AI.

DESCRIBE pode ser abreviado como DESC.

Consulte também:: CREATE EXTERNAL AGENT, ALTER EXTERNAL AGENT, DROP EXTERNAL AGENT, SHOW EXTERNAL AGENTS

Sintaxe¶

{ DESC | DESCRIBE } EXTERNAL AGENT <name>

Parâmetros¶

name

Especifica o identificador de um agente externo a ser descrito.

Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Para obter mais informações, consulte Requisitos para identificadores.

Saída¶

A saída do comando mostra as propriedades e os metadados do agente externo nas seguintes colunas:


Coluna	Descrição
`created_on`	Carimbo de data/hora de quando o agente externo foi criado.
`name`	Nome do agente externo.
`database_name`	Banco de dados que contém o agente externo.
`schema_name`	Esquema que contém o agente externo.
`owner`	Função proprietária do agente externo.
`comment`	Comentário para o agente externo.
`versions`	Versões da listagem de matrizes JSON do agente externo.
`default_version_name`	Versão padrão do agente externo.

Requisitos de controle de acesso¶

Uma função usada para executar esse comando SQL deve ter pelo menos um dos seguintes privilégios, no mínimo:


Privilégio	Objeto	Notas
Qualquer um destes privilégios: OWNERSHIP, USAGE	Agent externo

Operar em um objeto em um esquema requer pelo menos um privilégio no banco de dados pai e pelo menos um privilégio no esquema pai.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

Por exemplo, é possível usar o operador de canal ou a função RESULT_SCAN para selecionar colunas específicas da saída do comando SHOW ou filtrar as linhas.

Quando você fizer referência a colunas de saída, use identificadores entre aspas duplas para os nomes das colunas. Por exemplo, para selecionar a coluna de saída type, especifique SELECT "type".

Você deve usar identificadores entre aspas duplas porque os nomes das colunas de saída para os comandos SHOW estão em minúsculas. As aspas duplas garantem que os nomes das colunas na lista SELECT ou na cláusula WHERE correspondam aos nomes das colunas na saída do comando SHOW que foi verificada.

Exemplos¶

Descreva um agente externo:

DESCRIBE EXTERNAL AGENT my_rag_app;

Descreva um agente externo em um banco de dados e esquema específicos:

DESCRIBE EXTERNAL AGENT mydb.myschema.my_rag_app;