interface BedrockInvokeModelProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.Tasks.BedrockInvokeModelProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#BedrockInvokeModelProps |
Java | software.amazon.awscdk.services.stepfunctions.tasks.BedrockInvokeModelProps |
Python | aws_cdk.aws_stepfunctions_tasks.BedrockInvokeModelProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions_tasks » BedrockInvokeModelProps |
Properties for invoking a Bedrock Model.
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', {
model,
body: sfn.TaskInput.fromObject(
{
inputText: 'Generate a list of five first names.',
textGenerationConfig: {
maxTokenCount: 100,
temperature: 1,
},
},
),
resultSelector: {
names: sfn.JsonPath.stringAt('$.Body.results[0].outputText'),
},
});
Properties
Name | Type | Description |
---|---|---|
model | IModel | The Bedrock model that the task will invoke. |
accept? | string | The desired MIME type of the inference body in the response. |
body? | Task | The input data for the Bedrock model invocation. |
comment? | string | An optional description for this state. |
content | string | The MIME type of the input data in the request. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input? | Bedrock | The source location to retrieve the input data from. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output? | Bedrock | The destination location where the API response is written. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
model
Type:
IModel
The Bedrock model that the task will invoke.
See also: https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html
accept?
Type:
string
(optional, default: 'application/json')
The desired MIME type of the inference body in the response.
See also: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html
body?
Type:
Task
(optional, default: Input data is retrieved from the location specified in the input
field)
The input data for the Bedrock model invocation.
The inference parameters contained in the body depend on the Bedrock model being used.
The body must be in the format specified in the contentType
field.
For example, if the content type is application/json
, the body must be
JSON formatted.
The body must be up to 256 KB in size. For input data that exceeds 256 KB,
use input
instead to retrieve the input data from S3.
You must specify either the body
or the input
field, but not both.
See also: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
contentType?
Type:
string
(optional, default: 'application/json')
The MIME type of the input data in the request.
See also: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html
credentials?
Type:
Credentials
(optional, default: None (Task is executed using the State Machine's execution role))
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
heartbeat?
⚠️ Deprecated: use heartbeatTimeout
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
heartbeatTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
input?
Type:
Bedrock
(optional, default: Input data is retrieved from the body
field)
The source location to retrieve the input data from.
inputPath?
Type:
string
(optional, default: The entire task input (JSON path '$'))
JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPattern?
Type:
Integration
(optional, default: IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.)
AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
output?
Type:
Bedrock
(optional, default: The API response body is returned in the result.)
The destination location where the API response is written.
If you specify this field, the API response body is replaced with a reference to the output location.
outputPath?
Type:
string
(optional, default: The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path '$'))
JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
resultPath?
Type:
string
(optional, default: Replaces the entire input with the result (JSON path '$'))
JSONPath expression to indicate where to inject the state's output.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector?
Type:
{ [string]: any }
(optional, default: None)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
taskTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeout?
⚠️ Deprecated: use taskTimeout
Type:
Duration
(optional, default: None)
Timeout for the task.