# PromptConfiguration


 Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). 

## Contents


 ** additionalModelRequestFields **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-additionalModelRequestFields"></a>
If the Converse or ConverseStream operations support the model, `additionalModelRequestFields` contains additional inference parameters, beyond the base set of inference parameters in the `inferenceConfiguration` field.   
For more information, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).  
Type: JSON value  
Required: No

 ** basePromptTemplate **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-basePromptTemplate"></a>
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](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html). For more information, see [Configure the prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: No

 ** foundationModel **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-foundationModel"></a>
 The foundation model to use.   
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: No

 ** inferenceConfiguration **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-inferenceConfiguration"></a>
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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).  
Type: [InferenceConfiguration](API_agent-runtime_InferenceConfiguration.md) object  
Required: No

 ** parserMode **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-parserMode"></a>
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 as `OVERRIDDEN`, the `overrideLambda` field in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) must be specified with the ARN of a Lambda function.  
Type: String  
Valid Values: `DEFAULT | OVERRIDDEN`   
Required: No

 ** promptCreationMode **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-promptCreationMode"></a>
Specifies whether to override the default prompt template for this `promptType`. Set this value to `OVERRIDDEN` to use the prompt that you provide in the `basePromptTemplate`. If you leave it as `DEFAULT`, the agent uses a default prompt template.  
Type: String  
Valid Values: `DEFAULT | OVERRIDDEN`   
Required: No

 ** promptState **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-promptState"></a>
Specifies whether to allow the inline agent to carry out the step specified in the `promptType`. If you set this value to `DISABLED`, the agent skips that step. The default state for each `promptType` 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 **   <a name="bedrock-Type-agent-runtime_PromptConfiguration-promptType"></a>
 The step in the agent sequence that this prompt configuration applies to.   
Type: String  
Valid Values: `PRE_PROCESSING | ORCHESTRATION | KNOWLEDGE_BASE_RESPONSE_GENERATION | POST_PROCESSING | ROUTING_CLASSIFIER`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PromptConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PromptConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PromptConfiguration)