AI_GENERATE_TABLE_DESC

테이블 또는 뷰에 대한 설명을 생성하고 반환합니다. 선택적으로, 저장 프로시저는 테이블 또는 뷰의 열에 대한 설명을 생성할 수도 있습니다.

저장 프로시저는 Snowflake CortexCOMPLETE 함수 를 사용하여 설명을 자동으로 생성합니다.

구문

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 을 지원해야 합니다. COMPLETE 함수의 가용성 을 확인하세요. 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"
    }
  ]
}