AI_GENERATE_TABLE_DESC¶

Generiert eine Beschreibung für eine Tabelle oder Ansicht und gibt diese zurück. Optional kann die gespeicherte Prozedur auch Beschreibungen für die Spalten der Tabelle oder Ansicht generieren.

Die gespeicherte Prozedur verwendet die Snowflake Cortex COMPLETE-Funktion, um automatisch Beschreibungen zu generieren.

Syntax¶

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

Copy

Erforderliche Argumente¶

table_name: Gibt den Namen der Tabelle oder der Ansicht an, für die Sie eine Beschreibung erstellen möchten.

Optionale Argumente¶

config_object

Ein OBJECT, das angibt, ob Sie Spaltenbeschreibungen generieren und für diese Beschreibungen Beispieldaten verwenden möchten. Sie können eine OBJECT-Konstante verwenden, um dieses Objekt anzugeben.

Der OBJECT-Wert hat die folgende Struktur:

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

Copy

describe_columns: Wenn TRUE, erstellt die gespeicherte Prozedur Beschreibungen für alle Spalten der Tabelle.
use_table_data: Wenn TRUE, verwendet die gespeicherte Prozedur Beispieldaten aus der Tabelle, um Spaltenbeschreibungen zu generieren, was die Genauigkeit der Beschreibungen verbessern kann. Wenn FALSE, stützt sich die gespeicherte Prozedur auf Metadaten, um die Beschreibungen zu generieren.

Rückgabewerte¶

Gibt eine JSON-Zeichenfolge mit den folgenden Feldern zurück:

COLUMNS

Enthält ein Array von Spalten, für die Beschreibungen generiert wurden. Dieses Feld wird nur zurückgegeben, wenn Beschreibungen für Spalten generiert wurden.

Das Array enthält die folgenden Felder für jede Spalte der Tabelle:

database_name: Datenbank, die die Spalte enthält.
description: Beschreibung der Spalte, die durch die gespeicherte Prozedur generiert wurde.
name: Name der Spalte.
schema_name: Schema, das die Spalte enthält.
table_name: Tabelle oder Ansicht, die die Spalte enthält.

TABLE

Enthält ein Array, das eine Beschreibung der Tabelle sowie allgemeine Informationen zur Tabelle enthält. Das Array besteht aus den folgenden Feldern:

database_name: Datenbank, die die Tabelle enthält.
description: Beschreibung der Tabelle, die durch die gespeicherte Prozedur generiert wurde.
name: Name der Tabelle oder der Ansicht.
schema_name: Schema, das die Tabelle enthält.

Anforderungen an die Zugriffssteuerung¶

Benutzer müssen über die folgenden Berechtigungen und Rollen verfügen, um die gespeicherte Prozedur AI_GENERATE_TABLE_DESCRIPTION aufrufen zu können:

SELECT-Berechtigung für die Tabelle oder Ansicht.
SNOWFLAKE.CORTEX_USER-Datenbankrolle.

Nutzungshinweise¶

Ihre Region muss die LLM unterstützen, die von Snowflake Cortex zur Erstellung der Beschreibungen verwendet wird. Überprüfen Sie die Verfügbarkeit der COMPLETE-Funktion. Wenn die Funktion COMPLETE in Ihrer Region nicht unterstützt wird, müssen Sie die regionenübergreifende Inferenz aktivieren, um das Feature nutzen zu können.

Beispiele¶

Generieren einer Beschreibung für die Ansicht 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"
    }
  ]
}

Generieren von Beschreibungen für die Tabelle hr_data und alle ihrer Spalten. Metadaten nur verwenden, um die Beschreibungen zu generieren.

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