Interface BedrockInvokeModelJsonPathProps
- All Superinterfaces:
AssignableStateOptions
,software.amazon.jsii.JsiiSerializable
,JsonPathCommonOptions
,StateBaseProps
,TaskStateBaseOptions
,TaskStateJsonPathBaseProps
- All Known Implementing Classes:
BedrockInvokeModelJsonPathProps.Jsii$Proxy
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.*; import software.amazon.awscdk.services.bedrock.*; import software.amazon.awscdk.services.stepfunctions.*; import software.amazon.awscdk.services.stepfunctions.tasks.*; Object assign; Guardrail guardrail; IModel model; Object resultSelector; TaskInput taskInput; TaskRole taskRole; Timeout timeout; BedrockInvokeModelJsonPathProps bedrockInvokeModelJsonPathProps = BedrockInvokeModelJsonPathProps.builder() .model(model) // the properties below are optional .accept("accept") .assign(Map.of( "assignKey", assign)) .body(taskInput) .comment("comment") .contentType("contentType") .credentials(Credentials.builder() .role(taskRole) .build()) .guardrail(guardrail) .heartbeat(Duration.minutes(30)) .heartbeatTimeout(timeout) .input(BedrockInvokeModelInputProps.builder() .s3InputUri("s3InputUri") .s3Location(Location.builder() .bucketName("bucketName") .objectKey("objectKey") // the properties below are optional .objectVersion("objectVersion") .build()) .build()) .inputPath("inputPath") .integrationPattern(IntegrationPattern.REQUEST_RESPONSE) .output(BedrockInvokeModelOutputProps.builder() .s3Location(Location.builder() .bucketName("bucketName") .objectKey("objectKey") // the properties below are optional .objectVersion("objectVersion") .build()) .s3OutputUri("s3OutputUri") .build()) .outputPath("outputPath") .queryLanguage(QueryLanguage.JSON_PATH) .resultPath("resultPath") .resultSelector(Map.of( "resultSelectorKey", resultSelector)) .stateName("stateName") .taskTimeout(timeout) .timeout(Duration.minutes(30)) .traceEnabled(false) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forBedrockInvokeModelJsonPathProps
static final class
An implementation forBedrockInvokeModelJsonPathProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The desired MIME type of the inference body in the response.default TaskInput
getBody()
The input data for the Bedrock model invocation.default String
Deprecated.This property does not require configuration because the only acceptable value is 'application/json'.default Guardrail
The guardrail is applied to the invocation.default BedrockInvokeModelInputProps
getInput()
The source location to retrieve the input data from.getModel()
The Bedrock model that the task will invoke.default BedrockInvokeModelOutputProps
The destination location where the API response is written.default Boolean
Specifies whether to enable or disable the Bedrock trace.Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssign
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPath
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateName
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions
getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeout
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateJsonPathBaseProps
getResultPath, getResultSelector
-
Method Details
-
getModel
The Bedrock model that the task will invoke.- See Also:
-
getAccept
The desired MIME type of the inference body in the response.Default: 'application/json'
- See Also:
-
getBody
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 isapplication/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 theinput
field, but not both.Default: - Input data is retrieved from the location specified in the `input` field
- See Also:
-
getContentType
Deprecated.This property does not require configuration because the only acceptable value is 'application/json'.(deprecated) The MIME type of the input data in the request.Default: 'application/json'
- See Also:
-
getGuardrail
The guardrail is applied to the invocation.Default: - No guardrail is applied to the invocation.
-
getInput
The source location to retrieve the input data from.Default: - Input data is retrieved from the `body` field
-
getOutput
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.
Default: - The API response body is returned in the result.
-
getTraceEnabled
Specifies whether to enable or disable the Bedrock trace.Default: - Trace is not enabled for the invocation.
-
builder
-