Bedrock Agent Runtime  >  Structures  >  Collaborator

Collaborator

Structure Class

Collaborator dataclass

List of inline collaborators.

Attributes

action_groups class-attribute instance-attribute

action_groups: list[AgentActionGroup] | None = None

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

agent_collaboration class-attribute instance-attribute

agent_collaboration: AgentCollaboration | None = None

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

agent_name class-attribute instance-attribute

agent_name: str | None = field(repr=False, default=None)

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

collaborator_configurations class-attribute instance-attribute

collaborator_configurations: list[CollaboratorConfiguration] | None = None

Settings of the collaborator agent.

customer_encryption_key_arn class-attribute instance-attribute

customer_encryption_key_arn: str | None = None

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

foundation_model instance-attribute

foundation_model: str

The foundation model used by the inline collaborator agent.

guardrail_configuration class-attribute instance-attribute

guardrail_configuration: GuardrailConfigurationWithArn | None = None

Details of the guardwrail associated with the inline collaborator.

idle_session_ttl_in_seconds class-attribute instance-attribute

idle_session_ttl_in_seconds: int | None = None

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.

instruction class-attribute instance-attribute

instruction: str = field(repr=False)

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

knowledge_bases class-attribute instance-attribute

knowledge_bases: list[KnowledgeBase] | None = None

Knowledge base associated with the inline collaborator agent.

prompt_override_configuration class-attribute instance-attribute

prompt_override_configuration: PromptOverrideConfiguration | None = field(repr=False, default=None)

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