Class: AWSCDK::Wisdom::CfnAIAgent::KnowledgeBaseAssociationConfigurationDataProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
wisdom/cfn_ai_agent.rb

Overview

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content_tag_filter: nil, max_results: nil, override_knowledge_base_search_type: nil) ⇒ KnowledgeBaseAssociationConfigurationDataProperty

Returns a new instance of KnowledgeBaseAssociationConfigurationDataProperty.

Parameters:

  • content_tag_filter (AWSCDK::IResolvable, AWSCDK::Wisdom::CfnAIAgent::TagFilterProperty, nil) (defaults to: nil) —

    An object that can be used to specify Tag conditions.

  • max_results (Numeric, nil) (defaults to: nil) —

    The maximum number of results to return per page.

  • override_knowledge_base_search_type (String, nil) (defaults to: nil) —

    The search type to be used against the Knowledge Base for this request.



1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'wisdom/cfn_ai_agent.rb', line 1096

def initialize(content_tag_filter: nil, max_results: nil, override_knowledge_base_search_type: nil)
  @content_tag_filter = content_tag_filter.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnAIAgent::TagFilterProperty.new(**content_tag_filter.transform_keys(&:to_sym)) : content_tag_filter
  Jsii::Type.check_type(@content_tag_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuQUlBZ2VudC5UYWdGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "contentTagFilter") unless @content_tag_filter.nil?
  @max_results = max_results
  Jsii::Type.check_type(@max_results, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxResults") unless @max_results.nil?
  @override_knowledge_base_search_type = override_knowledge_base_search_type
  Jsii::Type.check_type(@override_knowledge_base_search_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "overrideKnowledgeBaseSearchType") unless @override_knowledge_base_search_type.nil?
end

Instance Attribute Details

#content_tag_filter ⇒ AWSCDK::IResolvable, ... (readonly)

An object that can be used to specify Tag conditions.

Returns:

See Also:



1109
1110
1111
 
# File 'wisdom/cfn_ai_agent.rb', line 1109

def content_tag_filter
  @content_tag_filter
end

#max_results ⇒ Numeric? (readonly)

The maximum number of results to return per page.

Returns:

  • (Numeric, nil)

See Also:



1114
1115
1116
 
# File 'wisdom/cfn_ai_agent.rb', line 1114

def max_results
  @max_results
end

#override_knowledge_base_search_type ⇒ String? (readonly)

The search type to be used against the Knowledge Base for this request.

The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

Returns:

  • (String, nil)

See Also:



1121
1122
1123
 
# File 'wisdom/cfn_ai_agent.rb', line 1121

def override_knowledge_base_search_type
  @override_knowledge_base_search_type
end

Class Method Details

.jsii_properties ⇒ Object 



1123
1124
1125
1126
1127
1128
1129
 
# File 'wisdom/cfn_ai_agent.rb', line 1123

def self.jsii_properties
  {
    :content_tag_filter => "contentTagFilter",
    :max_results => "maxResults",
    :override_knowledge_base_search_type => "overrideKnowledgeBaseSearchType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'wisdom/cfn_ai_agent.rb', line 1131

def to_jsii
  result = {}
  result.merge!({
    "contentTagFilter" => @content_tag_filter,
    "maxResults" => @max_results,
    "overrideKnowledgeBaseSearchType" => @override_knowledge_base_search_type,
  })
  result.compact
end