/AWS1/CL_BDR=>INVOKEMODELWITHRSPSTREAM()

About InvokeModelWithResponseStream

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

To see if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

The CLI doesn't support InvokeModelWithResponseStream.

For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide.

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

Method Signature

IMPORTING

Required arguments:

IV_BODY TYPE /AWS1/BDRBODY /AWS1/BDRBODY

The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

IV_MODELID TYPE /AWS1/BDRINVOKEMODELIDENTIFIER /AWS1/BDRINVOKEMODELIDENTIFIER

The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

Optional arguments:

IV_CONTENTTYPE TYPE /AWS1/BDRMIMETYPE /AWS1/BDRMIMETYPE

The MIME type of the input data in the request. The default value is application/json.

IV_ACCEPT TYPE /AWS1/BDRMIMETYPE /AWS1/BDRMIMETYPE

The desired MIME type of the inference body in the response. The default value is application/json.

IV_TRACE TYPE /AWS1/BDRTRACE /AWS1/BDRTRACE

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

IV_GUARDRAILIDENTIFIER TYPE /AWS1/BDRGUARDRAILIDENTIFIER /AWS1/BDRGUARDRAILIDENTIFIER

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.

An error is thrown in the following situations.

• You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

• You enable the guardrail but the contentType isn't application/json.

• You provide a guardrail identifier, but guardrailVersion isn't specified.

IV_GUARDRAILVERSION TYPE /AWS1/BDRGUARDRAILVERSION /AWS1/BDRGUARDRAILVERSION

The version number for the guardrail. The value can also be DRAFT.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_BDRINVMDELWRSPSTRMRSP /AWS1/CL_BDRINVMDELWRSPSTRMRSP