interface QueryGenerationTableProperty

Language	Type name
.NET	Amazon.CDK.aws_bedrock.CfnKnowledgeBase.QueryGenerationTableProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnKnowledgeBase_QueryGenerationTableProperty
Java	software.amazon.awscdk.services.bedrock.CfnKnowledgeBase.QueryGenerationTableProperty
Python	aws_cdk.aws_bedrock.CfnKnowledgeBase.QueryGenerationTableProperty
TypeScript	aws-cdk-lib » aws_bedrock » CfnKnowledgeBase » QueryGenerationTableProperty

Contains information about a table for the query engine to consider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const queryGenerationTableProperty: bedrock.CfnKnowledgeBase.QueryGenerationTableProperty = {
  name: 'name',

  // the properties below are optional
  columns: [{
    description: 'description',
    inclusion: 'inclusion',
    name: 'name',
  }],
  description: 'description',
  inclusion: 'inclusion',
};

Properties

Name	Type	Description
name	string	The name of the table for which the other fields in this object apply.
columns?	IResolvable | (IResolvable | QueryGenerationColumnProperty)[]	An array of objects, each of which defines information about a column in the table.
description?	string	A description of the table that helps the query engine understand the contents of the table.
inclusion?	string	Specifies whether to include or exclude the table during query generation.

---

name

Type: string

The name of the table for which the other fields in this object apply.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-name

---

columns?

Type: IResolvable | (IResolvable | QueryGenerationColumnProperty)[] (optional)

An array of objects, each of which defines information about a column in the table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-columns

---

description?

Type: string (optional)

A description of the table that helps the query engine understand the contents of the table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-description

---

inclusion?

Type: string (optional)

Specifies whether to include or exclude the table during query generation.

If you specify EXCLUDE , the table will be ignored. If you specify INCLUDE , all other tables will be ignored.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-inclusion