invoke_model_with_response_stream¶
Operation¶
async
¶
invoke_model_with_response_stream(input: InvokeModelWithResponseStreamInput, plugins: list[Plugin] | None = None) -> OutputEventStream[ResponseStream, InvokeModelWithResponseStreamOutput]
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.
Note
The CLI doesn't support streaming operations in Amazon Bedrock,
including 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.
Warning
To deny all inference access to resources that you specify in the
modelId field, you need to deny access to the bedrock:InvokeModel and
bedrock:InvokeModelWithResponseStream actions. Doing this also denies
access to the resource through the Converse API actions
(Converse
and
ConverseStream).
For more information see Deny access for inference on specific
models.
For troubleshooting some of the common errors you might encounter when
using the InvokeModelWithResponseStream API, see Troubleshooting
Amazon Bedrock API Error
Codes
in the Amazon Bedrock User Guide
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
InvokeModelWithResponseStreamInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
OutputEventStream[ResponseStream, InvokeModelWithResponseStreamOutput]
|
An |
Input¶
dataclass
¶
Dataclass for InvokeModelWithResponseStreamInput structure.
Attributes¶
class-attribute
instance-attribute
¶
accept: str | None = None
The desired MIME type of the inference body in the response. The default
value is application/json.
class-attribute
instance-attribute
¶
body: bytes | None = field(repr=False, default=None)
The prompt and inference parameters in the format specified in the
contentType in the header. You must provide the body in JSON format.
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.
class-attribute
instance-attribute
¶
content_type: str | None = None
The MIME type of the input data in the request. You must specify
application/json.
class-attribute
instance-attribute
¶
guardrail_identifier: str | None = None
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-guardrailConfigfield in the request body. -
You enable the guardrail but the
contentTypeisn'tapplication/json. -
You provide a guardrail identifier, but
guardrailVersionisn't specified.
class-attribute
instance-attribute
¶
guardrail_version: str | None = None
The version number for the guardrail. The value can also be DRAFT.
class-attribute
instance-attribute
¶
model_id: str | None = None
The unique identifier of the model to invoke to run inference.
The modelId to provide depends on the type of model or throughput 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 an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference 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, specify the ARN of the custom model deployment (for on-demand inference) or the ARN of your provisioned model (for Provisioned Throughput). For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
-
If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
class-attribute
instance-attribute
¶
performance_config_latency: PerformanceConfigLatency = PerformanceConfigLatency('standard')
Model performance settings for the request.
class-attribute
instance-attribute
¶
request_metadata: str | None = field(repr=False, default=None)
Key-value pairs that you can use to filter invocation logs.
class-attribute
instance-attribute
¶
service_tier: ServiceTierType | None = None
Specifies the processing tier type used for serving the request.
Output¶
This operation returns an OutputEventStream for server-to-client streaming.
Event Stream Structure¶
Output Event Type¶
Initial Response Structure¶
dataclass
¶
Dataclass for InvokeModelWithResponseStreamOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
performance_config_latency: PerformanceConfigLatency | None = None
Model performance settings for the request.
class-attribute
instance-attribute
¶
service_tier: ServiceTierType | None = None
Specifies the processing tier type used for serving the request.