構造化データストアに接続してナレッジベースを作成する

テーブルの説明を追加するには、tables 配列に QueryGenerationTable オブジェクトを含めます。そのオブジェクトで、次の例のように、name フィールドにテーブルの名前を指定し、description フィールドに説明を指定します。

{
    "name": "database.schema.tableA",
    "description": "Description for Table A"
}

列の説明を追加するには、tables 配列に QueryGenerationTable オブジェクトを含めます。そのオブジェクトで、name フィールドにテーブルの名前を指定し、QueryGenerationColumn の配列にマッピングされる columns フィールドを含めます。QueryGenerationColumn オブジェクトには、次の例のように、name フィールドに列の名前、description フィールドに説明を含めます。

{
    "name": "database.schema.tableA",
    "columns": [
        {
            "name": "Column A",
            "description": "Description for Column A"
        }
    ]
}

次の例のように、テーブルと列の両方の説明を追加できます。

{
    "name": "database.schema.tableA",
    "description": "Description for Table A",
    "columns": [
        {
            "name": "columnA",
            "description": "Description for Column A"
        }
    ]
}

INCLUDE – SQL の生成時にコンテキストとして含まれるのは、指定したテーブルまたは列のみです。

EXCLUDE – 指定したテーブルまたは列は、SQL の生成時にコンテキストとして除外されます。

テーブルを含めるか除外するには、tables 配列に QueryGenerationTable オブジェクトを含めます。そのオブジェクトで、次の例のように、name フィールドにテーブルの名前を指定し、inclusion フィールドにテーブルを含めるか除外するかを指定します。

{
    "name": "database.schema.tableA",
    "inclusion": "EXCLUDE"
}

クエリエンジンは、SQL を生成するための追加コンテキストに Table A を追加しません。

列を含めるか除外するには、tables 配列に QueryGenerationTable オブジェクトを含めます。そのオブジェクトで、name フィールドにテーブルの名前を指定し、QueryGenerationColumn の配列にマッピングされる columns フィールドを含めます。QueryGenerationColumn オブジェクトで、次の例のように、name フィールドに列の名前を含め、inclusion フィールドに列を含めるか除外するかを指定します。

{
    "name": "database.schema.tableA",
    "columns": [
        {
            "name": "database.schema.tableA.columnA",
            "inclusion": "EXCLUDE"
        }
    ]
}

SQL 生成は、SQL の生成時にコンテキスト内の Table A で Column A を無視します。

次の例のように、インクルージョンまたは除外を指定するときにテーブルと列を組み合わせることができます。

{
    "name": "database.schema.tableA",
    "inclusion": "INCLUDE",
    "columns": [
        {
            "name": "database.schema.tableA.columnA",
            "inclusion": "EXCLUDE"
        }
    ]
}

SQL 生成には Table A が含まれますが、SQL 生成のコンテキストを追加するときは Column A は除外されます。

naturalLanguage – 自然言語でのクエリの例

sql – 自然言語クエリに対応する SQL クエリ