Container for the parameters to the CreateAgent operation. Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
-
Specify the following fields for security purposes.
-
agentResourceRoleArn– The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. -
(Optional)
customerEncryptionKeyArn– The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. -
(Optional)
idleSessionTTLinSeconds– Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequentInvokeAgentrequest begins a new session.
-
-
To enable your agent to retain conversational context across multiple sessions, include a
memoryConfigurationobject. For more information, see Configure memory. -
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfigurationobject. For more information, see Advanced prompts. -
If you agent fails to be created, the response returns a list of
failureReasonsalongside a list ofrecommendedActionsfor you to troubleshoot.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.BedrockAgent.AmazonBedrockAgentRequest
Amazon.BedrockAgent.Model.CreateAgentRequest
Namespace: Amazon.BedrockAgent.Model
Assembly: AWSSDK.BedrockAgent.dll
Version: 3.x.y.z
Syntax
public class CreateAgentRequest : AmazonBedrockAgentRequest IAmazonWebServiceRequest
The CreateAgentRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateAgentRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AgentName | System.String |
Gets and sets the property AgentName. A name for the agent that you create. |
|
|
AgentResourceRoleArn | System.String |
Gets and sets the property AgentResourceRoleArn. The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. |
|
|
ClientToken | System.String |
Gets and sets the property ClientToken. A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency. |
|
|
CustomerEncryptionKeyArn | System.String |
Gets and sets the property CustomerEncryptionKeyArn. The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent. |
|
|
Description | System.String |
Gets and sets the property Description. A description of the agent. |
|
|
FoundationModel | System.String |
Gets and sets the property FoundationModel. The foundation model to be used for orchestration by the agent you create. |
|
|
GuardrailConfiguration | Amazon.BedrockAgent.Model.GuardrailConfiguration |
Gets and sets the property GuardrailConfiguration. The unique Guardrail configuration assigned to the agent when it is created. |
|
|
IdleSessionTTLInSeconds | System.Int32 |
Gets and sets the property IdleSessionTTLInSeconds. The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the 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 | System.String |
Gets and sets the property Instruction. Instructions that tell the agent what it should do and how it should interact with users. |
|
|
MemoryConfiguration | Amazon.BedrockAgent.Model.MemoryConfiguration |
Gets and sets the property MemoryConfiguration. Contains the details of the memory configured for the agent. |
|
|
PromptOverrideConfiguration | Amazon.BedrockAgent.Model.PromptOverrideConfiguration |
Gets and sets the property PromptOverrideConfiguration. Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts. |
|
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. Any tags that you want to attach to the agent. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5