Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.QueryGenerationContextProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.QueryGenerationContextProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.QueryGenerationContextProperty
extends software.amazon.jsii.JsiiSerializable

Contains configurations for context to use during query generation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 QueryGenerationContextProperty queryGenerationContextProperty = QueryGenerationContextProperty.builder()
         .curatedQueries(List.of(CuratedQueryProperty.builder()
                 .naturalLanguage("naturalLanguage")
                 .sql("sql")
                 .build()))
         .tables(List.of(QueryGenerationTableProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .columns(List.of(QueryGenerationColumnProperty.builder()
                         .description("description")
                         .inclusion("inclusion")
                         .name("name")
                         .build()))
                 .description("description")
                 .inclusion("inclusion")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBase.QueryGenerationContextProperty.Builder	A builder for CfnKnowledgeBase.QueryGenerationContextProperty
static final class	CfnKnowledgeBase.QueryGenerationContextProperty.Jsii$Proxy	An implementation for CfnKnowledgeBase.QueryGenerationContextProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.QueryGenerationContextProperty.Builder	builder()
default Object	getCuratedQueries()	An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
default Object	getTables()	An array of objects, each of which defines information about a table in the database.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCuratedQueries

@Stability(Stable)
@Nullable
default Object getCuratedQueries()

An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnKnowledgeBase.CuratedQueryProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html#cfn-bedrock-knowledgebase-querygenerationcontext-curatedqueries

getTables

@Stability(Stable)
@Nullable
default Object getTables()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnKnowledgeBase.QueryGenerationTableProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationcontext.html#cfn-bedrock-knowledgebase-querygenerationcontext-tables

builder

@Stability(Stable)
static CfnKnowledgeBase.QueryGenerationContextProperty.Builder builder()

Returns:

a CfnKnowledgeBase.QueryGenerationContextProperty.Builder of CfnKnowledgeBase.QueryGenerationContextProperty