Package software.amazon.awssdk.services.bedrockruntime.model

Interface InvokeModelWithResponseStreamRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockRuntimeRequest.Builder, Buildable, CopyableBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>, SdkBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

InvokeModelWithResponseStreamRequest

public static interface InvokeModelWithResponseStreamRequest.Builder
extends BedrockRuntimeRequest.Builder, SdkPojo, CopyableBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>

Method Summary

Modifier and Type	Method	Description
InvokeModelWithResponseStreamRequest.Builder	accept(String accept)	The desired MIME type of the inference body in the response.
InvokeModelWithResponseStreamRequest.Builder	body(SdkBytes body)	The prompt and inference parameters in the format specified in the contentType in the header.
InvokeModelWithResponseStreamRequest.Builder	contentType(String contentType)	The MIME type of the input data in the request.
InvokeModelWithResponseStreamRequest.Builder	guardrailIdentifier(String guardrailIdentifier)	The unique identifier of the guardrail that you want to use.
InvokeModelWithResponseStreamRequest.Builder	guardrailVersion(String guardrailVersion)	The version number for the guardrail.
InvokeModelWithResponseStreamRequest.Builder	modelId(String modelId)	The unique identifier of the model to invoke to run inference.
InvokeModelWithResponseStreamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
InvokeModelWithResponseStreamRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
InvokeModelWithResponseStreamRequest.Builder	trace(String trace)	Specifies whether to enable or disable the Bedrock trace.
InvokeModelWithResponseStreamRequest.Builder	trace(Trace trace)	Specifies whether to enable or disable the Bedrock trace.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

body

InvokeModelWithResponseStreamRequest.Builder body(SdkBytes body)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

contentType

InvokeModelWithResponseStreamRequest.Builder contentType(String contentType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

accept

InvokeModelWithResponseStreamRequest.Builder accept(String accept)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

modelId

InvokeModelWithResponseStreamRequest.Builder modelId(String modelId)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

trace

InvokeModelWithResponseStreamRequest.Builder trace(String trace)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Trace, Trace

trace

InvokeModelWithResponseStreamRequest.Builder trace(Trace trace)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Trace, Trace

guardrailIdentifier

InvokeModelWithResponseStreamRequest.Builder guardrailIdentifier(String guardrailIdentifier)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

guardrailVersion

InvokeModelWithResponseStreamRequest.Builder guardrailVersion(String guardrailVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

InvokeModelWithResponseStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

InvokeModelWithResponseStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder