Struct InvokeModelWithResponseStreamInput 

#[non_exhaustive]
pub struct InvokeModelWithResponseStreamInput {
    pub body: Option<Blob>,
    pub content_type: Option<String>,
    pub accept: Option<String>,
    pub model_id: Option<String>,
    pub trace: Option<Trace>,
    pub guardrail_identifier: Option<String>,
    pub guardrail_version: Option<String>,
    pub performance_config_latency: Option<PerformanceConfigLatency>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

content_type: Option<String>

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

accept: Option<String>

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

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

trace: Option<Trace>

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

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

guardrail_version: Option<String>

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

performance_config_latency: Option<PerformanceConfigLatency>

Model performance settings for the request.

Implementations

impl InvokeModelWithResponseStreamInput

pub fn 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) -> Option<&str>

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

pub fn accept(&self) -> Option<&str>

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

pub fn model_id(&self) -> Option<&str>

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) -> 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) -> Option<&str>

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) -> Option<&str>

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

pub fn performance_config_latency(&self) -> Option<&PerformanceConfigLatency>

Model performance settings for the request.

impl InvokeModelWithResponseStreamInput

pub fn builder() -> InvokeModelWithResponseStreamInputBuilder

Creates a new builder-style object to manufacture InvokeModelWithResponseStreamInput.

Trait Implementations

impl Clone for InvokeModelWithResponseStreamInput

fn clone(&self) -> InvokeModelWithResponseStreamInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvokeModelWithResponseStreamInput

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

Formats the value using the given formatter.

impl PartialEq for InvokeModelWithResponseStreamInput

fn eq(&self, other: &InvokeModelWithResponseStreamInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InvokeModelWithResponseStreamInput