PromptConfiguration
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
Contents
- basePromptTemplate
-
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
- foundationModel
-
The agent's foundation model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$
Required: No
- inferenceConfiguration
-
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the
promptType
. For more information, see Inference parameters for foundation models.Type: InferenceConfiguration object
Required: No
- parserMode
-
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the
promptType
. If you set the field asOVERRIDEN
, theoverrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.Type: String
Valid Values:
DEFAULT | OVERRIDDEN
Required: No
- promptCreationMode
-
Specifies whether to override the default prompt template for this
promptType
. Set this value toOVERRIDDEN
to use the prompt that you provide in thebasePromptTemplate
. If you leave it asDEFAULT
, the agent uses a default prompt template.Type: String
Valid Values:
DEFAULT | OVERRIDDEN
Required: No
- promptState
-
Specifies whether to allow the agent to carry out the step specified in the
promptType
. If you set this value toDISABLED
, the agent skips that step. The default state for eachpromptType
is as follows.-
PRE_PROCESSING
–ENABLED
-
ORCHESTRATION
–ENABLED
-
KNOWLEDGE_BASE_RESPONSE_GENERATION
–ENABLED
-
POST_PROCESSING
–DISABLED
Type: String
Valid Values:
ENABLED | DISABLED
Required: No
-
- promptType
-
The step in the agent sequence that this prompt configuration applies to.
Type: String
Valid Values:
PRE_PROCESSING | ORCHESTRATION | POST_PROCESSING | KNOWLEDGE_BASE_RESPONSE_GENERATION
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: