AI_GENERATE_TABLE_DESC¶

生成并返回表或视图的描述。该存储过程还可选择性地生成表或视图列的描述。

此存储过程使用 Snowflake Cortex COMPLETE 函数自动生成描述。

语法¶

AI_GENERATE_TABLE_DESC(
  <table_name>
  [ , <config_object> ] )

Copy

必填实参¶

table_name: 指定需要生成描述信息的表或视图。

可选实参¶

config_object

OBJECT 用于指定是否生成列描述及是否为这些描述使用样本数据。您可以使用 OBJECT 常量来指定此对象。

OBJECT 值具有以下结构：

{
  'describe_columns': <boolean>,
  'use_table_data': <boolean>
{

Copy

describe_columns: 如果设置为 TRUE，存储过程将为表的所有列生成描述。
use_table_data: 如果设置为 TRUE，存储过程将使用表中的样本数据生成列描述（可提高描述准确性）。如果为 FALSE，则依赖元数据生成描述。

返回¶

返回包含以下字段的 JSON 字符串：

COLUMNS

包含已生成描述的列数组。仅当生成列描述时，才返回此字段。

该数组为表的每个列包含以下字段：

database_name: 包含列的数据库。
description: 存储过程生成的列描述。
name: 列的名称。
schema_name: 包含列的架构。
table_name: 包含列的表或视图。

TABLE

包含表描述及表基本信息的数组。该数组由以下字段组成：

database_name: 包含表的数据库。
description: 存储过程生成的表的描述。
name: 表或视图的名称。
schema_name: 包含表的架构。

访问控制要求¶

调用 AI_GENERATE_TABLE_DESCRIPTION 存储过程的用户必须具有以下权限和角色：

表或视图的 SELECT 权限。
SNOWFLAKE.CORTEX_USER 数据库角色。

使用说明¶

您所在的区域必须支持 Snowflake Cortex 在生成描述时使用的 LLM。请检查 :ref:` COMPLETE 函数的可用性 <label-cortex_llm_availability>`。如果您所在区域不支持 COMPLETE 函数，则必须启用跨区域推理才能使用此功能。

示例¶

为视图 v1 生成描述。

CALL AI_GENERATE_TABLE_DESC( 'v1');

Copy

{
  "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"
    }
  ]
}

为表 hr_data 及其所有列生成描述。仅使用元数据生成描述。

CALL AI_GENERATE_TABLE_DESC(
  'mydb.sch1.hr_data',
  {
    'describe_columns': true,
    'use_table_data': false
  });

Copy

{
  "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"
    }
  ]
}