Class: AWSCDK::Bedrock::CfnAgent::AgentKnowledgeBaseProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_agent.rb

Overview

Contains details about a knowledge base that is associated with an agent.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description:, knowledge_base_id:, knowledge_base_state: nil) ⇒ AgentKnowledgeBaseProperty

Returns a new instance of AgentKnowledgeBaseProperty.

Parameters:

  • description (String) —

    The description of the association between the agent and the knowledge base.

  • knowledge_base_id (String) —

    The unique identifier of the association between the agent and the knowledge base.

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

    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.



1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'bedrock/cfn_agent.rb', line 1173

def initialize(description:, knowledge_base_id:, knowledge_base_state: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  @knowledge_base_id = knowledge_base_id
  Jsii::Type.check_type(@knowledge_base_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "knowledgeBaseId")
  @knowledge_base_state = knowledge_base_state
  Jsii::Type.check_type(@knowledge_base_state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "knowledgeBaseState") unless @knowledge_base_state.nil?
end

Instance Attribute Details

#description ⇒ String (readonly)

The description of the association between the agent and the knowledge base.

Returns:

  • (String)

See Also:



1186
1187
1188
 
# File 'bedrock/cfn_agent.rb', line 1186

def description
  @description
end

#knowledge_base_id ⇒ String (readonly)

The unique identifier of the association between the agent and the knowledge base.

Returns:

  • (String)

See Also:



1191
1192
1193
 
# File 'bedrock/cfn_agent.rb', line 1191

def knowledge_base_id
  @knowledge_base_id
end

#knowledge_base_state ⇒ String? (readonly)

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

Returns:

  • (String, nil)

See Also:



1196
1197
1198
 
# File 'bedrock/cfn_agent.rb', line 1196

def knowledge_base_state
  @knowledge_base_state
end

Class Method Details

.jsii_properties ⇒ Object 



1198
1199
1200
1201
1202
1203
1204
 
# File 'bedrock/cfn_agent.rb', line 1198

def self.jsii_properties
  {
    :description => "description",
    :knowledge_base_id => "knowledgeBaseId",
    :knowledge_base_state => "knowledgeBaseState",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'bedrock/cfn_agent.rb', line 1206

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "knowledgeBaseId" => @knowledge_base_id,
    "knowledgeBaseState" => @knowledge_base_state,
  })
  result.compact
end