BedrockRuntime / Client / invoke_model_with_response_stream

invoke_model_with_response_stream#

BedrockRuntime.Client.invoke_model_with_response_stream(**kwargs)#

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 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.

See also: AWS API Documentation

Request Syntax

response = client.invoke_model_with_response_stream(
    body=b'bytes'|file,
    contentType='string',
    accept='string',
    modelId='string',
    trace='ENABLED'|'DISABLED',
    guardrailIdentifier='string',
    guardrailVersion='string'
)
Parameters:

  • body (bytes or seekable file-like object) –

    [REQUIRED]

    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.

  • contentType (string) – The MIME type of the input data in the request. The default value is application/json.

  • accept (string) – The desired MIME type of the inference body in the response. The default value is application/json.

  • modelId (string) –

    [REQUIRED]

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

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

  • trace (string) – Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

  • guardrailIdentifier (string) –

    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.

  • guardrailVersion (string) – The version number for the guardrail. The value can also be DRAFT.

Return type:

dict

Returns:

The response of this operation contains an EventStream member. When iterated the EventStream will yield events based on the structure below, where only one of the top level keys will be present for any given event.

Response Syntax

{
    'body': EventStream({
        'chunk': {
            'bytes': b'bytes'
        },
        'internalServerException': {
            'message': 'string'
        },
        'modelStreamErrorException': {
            'message': 'string',
            'originalStatusCode': 123,
            'originalMessage': 'string'
        },
        'validationException': {
            'message': 'string'
        },
        'throttlingException': {
            'message': 'string'
        },
        'modelTimeoutException': {
            'message': 'string'
        }
    }),
    'contentType': 'string'
}

Response Structure

  • (dict) –

    • body (EventStream) –

      Inference response from the model in the format specified by the contentType header. To see the format and content of this field for different models, refer to Inference parameters.

      • chunk (dict) –

        Content included in the response.

        • bytes (bytes) –

          Base64-encoded bytes of payload data.

      • internalServerException (dict) –

        An internal server error occurred. Retry your request.

        • message (string) –

      • modelStreamErrorException (dict) –

        An error occurred while streaming the response. Retry your request.

        • message (string) –

        • originalStatusCode (integer) –

          The original status code.

        • originalMessage (string) –

          The original message.

      • validationException (dict) –

        Input validation failed. Check your request parameters and retry the request.

        • message (string) –

      • throttlingException (dict) –

        The number or frequency of requests exceeds the limit. Resubmit your request later.

        • message (string) –

      • modelTimeoutException (dict) –

        The request took too long to process. Processing time exceeded the model timeout length.

        • message (string) –

    • contentType (string) –

      The MIME type of the inference result.

Exceptions