PromptConfigurationDict¶
Dictionary Type¶
PromptConfigurationDict
¶
Bases: TypedDict
Dictionary form of PromptConfiguration.
Attributes¶
additional_model_request_fields
instance-attribute
¶
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
instance-attribute
¶
base_prompt_template: str | 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.
inference_configuration
instance-attribute
¶
inference_configuration: InferenceConfiguration | InferenceConfigurationDict | 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
instance-attribute
¶
parser_mode: str | 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
instance-attribute
¶
prompt_creation_mode: str | 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
instance-attribute
¶
prompt_state: str | None
Specifies whether to allow the 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--DISABLED -
ORCHESTRATION--ENABLED -
KNOWLEDGE_BASE_RESPONSE_GENERATION--ENABLED -
POST_PROCESSING--DISABLED