Struct InvokeModelWithResponseStreamFluentBuilder

pub struct InvokeModelWithResponseStreamFluentBuilder { /* private fields */ }

Fluent builder constructing a request to 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 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.

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

Implementations

impl InvokeModelWithResponseStreamFluentBuilder

pub fn as_input(&self) -> &InvokeModelWithResponseStreamInputBuilder

Access the InvokeModelWithResponseStream as a reference.

pub async fn send( self, ) -> Result<InvokeModelWithResponseStreamOutput, SdkError<InvokeModelWithResponseStreamError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<InvokeModelWithResponseStreamOutput, InvokeModelWithResponseStreamError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn body(self, input: Blob) -> Self

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.

pub fn set_body(self, input: Option<Blob>) -> Self

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.

pub fn get_body(&self) -> &Option<Blob>

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.

pub fn content_type(self, input: impl Into<String>) -> Self

The MIME type of the input data in the request. You must specify application/json.

pub fn set_content_type(self, input: Option<String>) -> Self

The MIME type of the input data in the request. You must specify application/json.

pub fn get_content_type(&self) -> &Option<String>

The MIME type of the input data in the request. You must specify application/json.

pub fn accept(self, input: impl Into<String>) -> Self

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

pub fn set_accept(self, input: Option<String>) -> Self

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

pub fn get_accept(&self) -> &Option<String>

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

pub fn model_id(self, input: impl Into<String>) -> Self

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.

pub fn set_model_id(self, input: Option<String>) -> Self

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.

pub fn get_model_id(&self) -> &Option<String>

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.

pub fn trace(self, input: Trace) -> Self

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

pub fn set_trace(self, input: Option<Trace>) -> Self

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

pub fn get_trace(&self) -> &Option<Trace>

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

pub fn guardrail_identifier(self, input: impl Into<String>) -> Self

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.

pub fn set_guardrail_identifier(self, input: Option<String>) -> Self

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.

pub fn get_guardrail_identifier(&self) -> &Option<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.

pub fn guardrail_version(self, input: impl Into<String>) -> Self

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

pub fn set_guardrail_version(self, input: Option<String>) -> Self

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

pub fn get_guardrail_version(&self) -> &Option<String>

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

pub fn performance_config_latency(self, input: PerformanceConfigLatency) -> Self

Model performance settings for the request.

pub fn set_performance_config_latency( self, input: Option<PerformanceConfigLatency>, ) -> Self

Model performance settings for the request.

pub fn get_performance_config_latency( &self, ) -> &Option<PerformanceConfigLatency>

Model performance settings for the request.

Trait Implementations

impl Clone for InvokeModelWithResponseStreamFluentBuilder

fn clone(&self) -> InvokeModelWithResponseStreamFluentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InvokeModelWithResponseStreamFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.