Skip to content
v2.275.0

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

PromptStepConfigBase Struct ​

Base configuration interface for all prompt step types.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_alpha from '@aws-cdk/aws-bedrock-alpha';
const promptStepConfigBase: bedrock_alpha.PromptStepConfigBase = {
  stepType: bedrock_alpha.AgentStepType.PRE_PROCESSING,

  // the properties below are optional
  customPromptTemplate: 'customPromptTemplate',
  inferenceConfig: {
    maximumLength: 123,
    stopSequences: ['stopSequences'],
    temperature: 123,
    topK: 123,
    topP: 123,
  },
  stepEnabled: false,
  useCustomParser: false,
};

Properties ​

customPromptTemplateoptionalstringcustom_prompt_templateoptionalstrcustomPromptTemplateoptionalStringCustomPromptTemplateoptionalstringCustomPromptTemplateoptional*string#
The custom prompt template to be used.

Default: The default prompt template will be used.

inferenceConfigoptionalInferenceConfigurationinference_configoptionalInferenceConfigurationinferenceConfigoptionalInferenceConfigurationInferenceConfigoptionalInferenceConfigurationInferenceConfigoptionalInferenceConfiguration#
The inference configuration parameters to use.

Default: undefined - Default inference configuration will be used

stepEnabledoptionalbooleanstep_enabledoptionalboolstepEnabledoptionalBooleanStepEnabledoptionalboolStepEnabledoptional*bool#
Whether to enable or skip this step in the agent sequence.

Default: The default state for each step type is as follows. PRE_PROCESSING – ENABLED ORCHESTRATION – ENABLED KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED POST_PROCESSING – DISABLED

stepTypeAgentStepTypestep_typeAgentStepTypestepTypeAgentStepTypeStepTypeAgentStepTypeStepTypeAgentStepTyperequired#
The type of step this configuration applies to.
useCustomParseroptionalbooleanuse_custom_parseroptionalbooluseCustomParseroptionalBooleanUseCustomParseroptionalboolUseCustomParseroptional*bool= false#
Whether to use the custom Lambda parser defined for the sequence.