Class: Aws::BedrockAgent::Types::AssociateAgentKnowledgeBaseRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrockagent/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_idString

The unique identifier of the agent with which you want to associate the knowledge base.

Returns:

  • (String)


865
866
867
868
869
870
871
872
873
# File 'lib/aws-sdk-bedrockagent/types.rb', line 865

class AssociateAgentKnowledgeBaseRequest < Struct.new(
  :agent_id,
  :agent_version,
  :description,
  :knowledge_base_id,
  :knowledge_base_state)
  SENSITIVE = []
  include Aws::Structure
end

#agent_versionString

The version of the agent with which you want to associate the knowledge base.

Returns:

  • (String)


865
866
867
868
869
870
871
872
873
# File 'lib/aws-sdk-bedrockagent/types.rb', line 865

class AssociateAgentKnowledgeBaseRequest < Struct.new(
  :agent_id,
  :agent_version,
  :description,
  :knowledge_base_id,
  :knowledge_base_state)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of what the agent should use the knowledge base for.

Returns:

  • (String)


865
866
867
868
869
870
871
872
873
# File 'lib/aws-sdk-bedrockagent/types.rb', line 865

class AssociateAgentKnowledgeBaseRequest < Struct.new(
  :agent_id,
  :agent_version,
  :description,
  :knowledge_base_id,
  :knowledge_base_state)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_idString

The unique identifier of the knowledge base to associate with the agent.

Returns:

  • (String)


865
866
867
868
869
870
871
872
873
# File 'lib/aws-sdk-bedrockagent/types.rb', line 865

class AssociateAgentKnowledgeBaseRequest < Struct.new(
  :agent_id,
  :agent_version,
  :description,
  :knowledge_base_id,
  :knowledge_base_state)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_stateString

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

InvokeAgent][1

request.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html

Returns:

  • (String)


865
866
867
868
869
870
871
872
873
# File 'lib/aws-sdk-bedrockagent/types.rb', line 865

class AssociateAgentKnowledgeBaseRequest < Struct.new(
  :agent_id,
  :agent_version,
  :description,
  :knowledge_base_id,
  :knowledge_base_state)
  SENSITIVE = []
  include Aws::Structure
end