class Guardrail
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.Guardrail |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#Guardrail |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.Guardrail |
![]() | aws_cdk.aws_stepfunctions_tasks.Guardrail |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » Guardrail |
Guradrail settings for BedrockInvokeModel.
Example
import * as bedrock from 'aws-cdk-lib/aws-bedrock';
const model = bedrock.FoundationModel.fromFoundationModelId(
this,
'Model',
bedrock.FoundationModelIdentifier.AMAZON_TITAN_TEXT_G1_EXPRESS_V1,
);
const task = new tasks.BedrockInvokeModel(this, 'Prompt Model with guardrail', {
model,
body: sfn.TaskInput.fromObject(
{
inputText: 'Generate a list of five first names.',
textGenerationConfig: {
maxTokenCount: 100,
temperature: 1,
},
},
),
guardrail: tasks.Guardrail.enable('guardrailId', 1),
resultSelector: {
names: sfn.JsonPath.stringAt('$.Body.results[0].outputText'),
},
});
Properties
Name | Type | Description |
---|---|---|
guardrail | string | The identitifier of guardrail. |
guardrail | string | The version of guardrail. |
guardrailIdentifier
Type:
string
The identitifier of guardrail.
guardrailVersion
Type:
string
The version of guardrail.
Methods
Name | Description |
---|---|
static enable(identifier, version) | Enable guardrail. |
static enable | Enable guardrail with DRAFT version. |
static enable(identifier, version)
public static enable(identifier: string, version: number): Guardrail
Parameters
- identifier
string
— The id or arn of the guardrail. - version
number
— The version of the guardrail.
Returns
Enable guardrail.
static enableDraft(identifier)
public static enableDraft(identifier: string): Guardrail
Parameters
- identifier
string
— The identifier of the guardrail.
Returns
Enable guardrail with DRAFT version.