Collaborator
List of inline collaborators.
Contents
- foundationModel
-
The foundation model used by the inline collaborator agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)$
Required: Yes
- instruction
-
Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
Type: String
Length Constraints: Minimum length of 40.
Required: Yes
- actionGroups
-
List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
Type: Array of AgentActionGroup objects
Required: No
- agentCollaboration
-
Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
Type: String
Valid Values:
SUPERVISOR | SUPERVISOR_ROUTER | DISABLED
Required: No
- agentName
-
Name of the inline collaborator agent which must be the same name as specified for
collaboratorName
.Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$
Required: No
- collaboratorConfigurations
-
Settings of the collaborator agent.
Type: Array of CollaboratorConfiguration objects
Required: No
- customerEncryptionKeyArn
-
The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$
Required: No
- guardrailConfiguration
-
Details of the guardwrail associated with the inline collaborator.
Type: GuardrailConfigurationWithArn object
Required: No
- idleSessionTTLInSeconds
-
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.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 3600.
Required: No
- knowledgeBases
-
Knowledge base associated with the inline collaborator agent.
Type: Array of KnowledgeBase objects
Required: No
- promptOverrideConfiguration
-
Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
Type: PromptOverrideConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: