Collaborator ¶

class Collaborator(TypedDict, closed=True):
    customer_encryption_key_arn: NotRequired[
        "capo_bedrock_agent_runtime.types.kms_key_arn.KmsKeyArn"
    ]
    """<p> The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator. </p>"""
    foundation_model: (
        "capo_bedrock_agent_runtime.types.model_identifier.ModelIdentifier"
    )
    """<p> The foundation model used by the inline collaborator agent. </p>"""
    instruction: "capo_bedrock_agent_runtime.types.instruction.Instruction"
    """<p> Instruction that tell the inline collaborator agent what it should do and how it should interact with users. </p>"""
    idle_session_ttl_in_seconds: NotRequired[
        "capo_bedrock_agent_runtime.types.session_ttl.SessionTTL"
    ]
    """<p> The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.</p> <p>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. </p>"""
    action_groups: NotRequired[
        "capo_bedrock_agent_runtime.types.agent_action_groups.AgentActionGroups"
    ]
    """<p> List of action groups with each action group defining tasks the inline collaborator agent needs to carry out. </p>"""
    knowledge_bases: NotRequired[
        "capo_bedrock_agent_runtime.types.knowledge_bases.KnowledgeBases"
    ]
    """<p> Knowledge base associated with the inline collaborator agent. </p>"""
    guardrail_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.guardrail_configuration_with_arn.GuardrailConfigurationWithArn"
    ]
    """<p> Details of the guardwrail associated with the inline collaborator. </p>"""
    prompt_override_configuration: NotRequired[
        "capo_bedrock_agent_runtime.types.prompt_override_configuration.PromptOverrideConfiguration"
    ]
    """<p> Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>. </p>"""
    agent_collaboration: NotRequired[
        "capo_bedrock_agent_runtime.types.agent_collaboration.AgentCollaboration"
    ]
    """<p> Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response. </p>"""
    collaborator_configurations: NotRequired[
        "capo_bedrock_agent_runtime.types.collaborator_configurations.CollaboratorConfigurations"
    ]
    """<p> Settings of the collaborator agent. </p>"""
    agent_name: NotRequired["capo_bedrock_agent_runtime.types.name.Name"]
    """<p> Name of the inline collaborator agent which must be the same name as specified for <code>collaboratorName</code>. </p>"""