Class: AWSCDK::Bedrock::CfnKnowledgeBase::CuratedQueryProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnKnowledgeBase::CuratedQueryProperty

Defined in:

bedrock/cfn_knowledge_base.rb

Overview

Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.

See Also:

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

Instance Attribute Summary

• #natural_language ⇒ String readonly

  An example natural language query.

• #sql ⇒ String readonly

  The SQL equivalent of the natural language query.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(natural_language:, sql:) ⇒ CuratedQueryProperty constructor

  A new instance of CuratedQueryProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(natural_language:, sql:) ⇒ CuratedQueryProperty

Returns a new instance of CuratedQueryProperty.

Parameters:

• natural_language (String) —

  An example natural language query.

• sql (String) —

  The SQL equivalent of the natural language query.

# File 'bedrock/cfn_knowledge_base.rb', line 800

def initialize(natural_language:, sql:)
  @natural_language = natural_language
  Jsii::Type.check_type(@natural_language, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "naturalLanguage")
  @sql = sql
  Jsii::Type.check_type(@sql, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sql")
end

Instance Attribute Details

#natural_language ⇒ String (readonly)

An example natural language query.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_knowledge_base.rb', line 811

def natural_language
  @natural_language
end

#sql ⇒ String (readonly)

The SQL equivalent of the natural language query.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_knowledge_base.rb', line 816

def sql
  @sql
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 818

def self.jsii_properties
  {
    :natural_language => "naturalLanguage",
    :sql => "sql",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 825

def to_jsii
  result = {}
  result.merge!({
    "naturalLanguage" => @natural_language,
    "sql" => @sql,
  })
  result.compact
end