Skip to content

Bedrock Agent Runtime  >  Structures  >  PromptConfiguration

PromptConfiguration

Structure Class

PromptConfiguration dataclass

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

Attributes

additional_model_request_fields class-attribute instance-attribute 
additional_model_request_fields: Document | None = None

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 in the Amazon Bedrock user guide.

base_prompt_template class-attribute instance-attribute 
base_prompt_template: str | None = field(repr=False, default=None)

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.

foundation_model class-attribute instance-attribute 
foundation_model: str | None = None

The foundation model to use.

inference_configuration class-attribute instance-attribute 
inference_configuration: InferenceConfiguration | None = None

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.

parser_mode class-attribute instance-attribute 
parser_mode: CreationMode | None = None

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 must be specified with the ARN of a Lambda function.

prompt_creation_mode class-attribute instance-attribute 
prompt_creation_mode: CreationMode | None = None

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.

prompt_state class-attribute instance-attribute 
prompt_state: PromptState | None = None

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

prompt_type class-attribute instance-attribute 
prompt_type: PromptType | None = None

The step in the agent sequence that this prompt configuration applies to.