AI_GENERATE_TABLE_DESC¶
Gera e retorna uma descrição para uma tabela ou visualização. Opcionalmente, o procedimento armazenado também pode gerar descrições para as colunas da tabela ou visualização.
O procedimento armazenado usa a função COMPLETE do Snowflake Cortex para gerar descrições automaticamente.
Sintaxe¶
AI_GENERATE_TABLE_DESC(
<table_name>
[ , <config_object> ] )
Argumentos exigidos¶
table_name
Especifica a tabela ou visualização para a qual você deseja gerar uma descrição.
Argumentos opcionais¶
config_object
Um OBJECT que especifica se você deseja gerar descrições de colunas e usar dados de amostra para essas descrições. É possível usar uma constante OBJECT para especificar esse objeto.
O valor OBJECT tem a seguinte estrutura:
{ 'describe_columns': <boolean>, 'use_table_data': <boolean> {
describe_columns
Se definido como TRUE, o procedimento armazenado gera descrições para todas as colunas da tabela.
use_table_data
Se definido como TRUE, o procedimento armazenado usa dados de amostra da tabela para gerar descrições de colunas, o que pode melhorar a precisão das descrições. Se for FALSE, o procedimento armazenado se baseará nos metadados para gerar as descrições.
Retornos¶
Retorna uma string JSON com os seguintes campos:
COLUMNS
Contém uma matriz de colunas para as quais foram geradas descrições. Este campo só é retornado se forem geradas descrições para colunas.
A matriz contém os seguintes campos para cada coluna da tabela:
database_name
Banco de dados que contém a coluna.
description
Descrição da coluna gerada pelo procedimento armazenado.
name
Nome da coluna.
schema_name
Esquema que contém a coluna.
table_name
Tabela ou visualização que contém a coluna.
TABLE
Contém uma matriz que inclui a descrição da tabela junto com informações gerais sobre a tabela. A matriz consiste nos seguintes campos:
database_name
Banco de dados que contém a tabela.
description
Descrição da tabela que foi gerada pelo procedimento armazenado.
name
Nome da tabela ou visualização.
schema_name
Esquema que contém a tabela.
Requisitos de controle de acesso¶
Os usuários devem ter os seguintes privilégios e funções para chamar o procedimento armazenado AI_GENERATE_TABLE_DESCRIPTION:
Privilégio SELECT na tabela ou visualização.
Função de banco de dados SNOWFLAKE.CORTEX_USER.
Notas de uso¶
Sua região deve ser compatível com o LLM usado pelo Snowflake Cortex para gerar as descrições. Verifique a disponibilidade da função COMPLETE. Se a função COMPLETE não for aceita em sua região, você deverá ativar a inferência entre regiões para usar o recurso.
Exemplos¶
Gerar uma descrição para a visualização v1
.
CALL AI_GENERATE_TABLE_DESC( 'v1');
{
"TABLE": [
{
"database_name": "mydb",
"description": " The table contains records of customer addresses. Each record includes a name and zip code.",
"name": "v1",
"schema_name": "sch1"
}
]
}
Gerar descrições para a tabela hr_data
e todas as suas colunas. Usar apenas metadados para gerar as descrições.
CALL AI_GENERATE_TABLE_DESC(
'mydb.sch1.hr_data',
{
'describe_columns': true,
'use_table_data': false
});
{
"COLUMNS": [
{
"database_name": "mydb",
"description": "A column holding data of type DecimalType representing age values.",
"name": "AGE",
"schema_name": "sch1",
"table_name": "hr_data"
},
{
"database_name": "mydb",
"description": "The first name of the employee.",
"name": "FNAME",
"schema_name": "sch1",
"table_name": "hr_data"
}
],
"TABLE": [
{
"database_name": "mydb",
"description": " The table contains records of employee data, specifically demographic information. Each record includes an employee's age and name.",
"name": "hr_data",
"schema_name": "sch1"
}
]
}