Class: Aws::BedrockAgentRuntime::Types::Collaborator

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

List of inline collaborators.

See Also:

Constant Summary collapse

SENSITIVE = 
[:agent_name, :instruction, :prompt_override_configuration]

Instance Attribute Summary collapse

Instance Attribute Details

#action_groups ⇒ Array<Types::AgentActionGroup>

List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.

Returns:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_collaboration ⇒ String

Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.

Returns:

  • (String) 


992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#agent_name ⇒ String

Name of the inline collaborator agent which must be the same name as specified for collaboratorName.

Returns:

  • (String) 


992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#collaborator_configurations ⇒ Array<Types::CollaboratorConfiguration>

Settings of the collaborator agent.

Returns:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#customer_encryption_key_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.

Returns:

  • (String) 


992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#foundation_model ⇒ String

The foundation model used by the inline collaborator agent.

Returns:

  • (String) 


992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#guardrail_configuration ⇒ Types::GuardrailConfigurationWithArn

Details of the guardwrail associated with the inline collaborator.

Returns:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ Integer

The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

Returns:

  • (Integer) 


992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#instruction ⇒ String

Instruction that tell the inline collaborator agent what it should do and how it should interact with users.

Returns:

  • (String) 


992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#knowledge_bases ⇒ Array<Types::KnowledgeBase>

Knowledge base associated with the inline collaborator agent.

Returns:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end

#prompt_override_configuration ⇒ Types::PromptOverrideConfiguration

Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.

Returns:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 992

class Collaborator < Struct.new(
  :action_groups,
  :agent_collaboration,
  :agent_name,
  :collaborator_configurations,
  :customer_encryption_key_arn,
  :foundation_model,
  :guardrail_configuration,
  :idle_session_ttl_in_seconds,
  :instruction,
  :knowledge_bases,
  :prompt_override_configuration)
  SENSITIVE = [:agent_name, :instruction, :prompt_override_configuration]
  include Aws::Structure
end