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

Class InvokeModelWithResponseStreamRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest

software.amazon.awssdk.services.bedrockruntime.model.InvokeModelWithResponseStreamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>

@Generated("software.amazon.awssdk:codegen")
public final class InvokeModelWithResponseStreamRequest
extends BedrockRuntimeRequest
implements ToCopyableBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvokeModelWithResponseStreamRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accept()	The desired MIME type of the inference body in the response.
SdkBytes	body()	The prompt and inference parameters in the format specified in the contentType in the header.
static InvokeModelWithResponseStreamRequest.Builder	builder()
String	contentType()	The MIME type of the input data in the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	guardrailIdentifier()	The unique identifier of the guardrail that you want to use.
String	guardrailVersion()	The version number for the guardrail.
int	hashCode()
String	modelId()	The unique identifier of the model to invoke to run inference.
PerformanceConfigLatency	performanceConfigLatency()	Model performance settings for the request.
String	performanceConfigLatencyAsString()	Model performance settings for the request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InvokeModelWithResponseStreamRequest.Builder>	serializableBuilderClass()
InvokeModelWithResponseStreamRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Trace	trace()	Specifies whether to enable or disable the Bedrock trace.
String	traceAsString()	Specifies whether to enable or disable the Bedrock trace.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

body

public final SdkBytes body()

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.

Returns:

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.

contentType

public final String contentType()

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

Returns:

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

accept

public final String accept()

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

Returns:

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

modelId

public final String modelId()

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.

Returns:

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

public final Trace trace()

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

If the service returns an enum value that is not available in the current SDK version, trace will return Trace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceAsString().

Returns:

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

See Also:

Trace

traceAsString

public final String traceAsString()

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

If the service returns an enum value that is not available in the current SDK version, trace will return Trace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from traceAsString().

Returns:

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

See Also:

Trace

guardrailIdentifier

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

Returns:

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

public final String guardrailVersion()

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

Returns:

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

performanceConfigLatency

public final PerformanceConfigLatency performanceConfigLatency()

Model performance settings for the request.

If the service returns an enum value that is not available in the current SDK version, performanceConfigLatency will return PerformanceConfigLatency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceConfigLatencyAsString().

Returns:

Model performance settings for the request.

See Also:

PerformanceConfigLatency

performanceConfigLatencyAsString

public final String performanceConfigLatencyAsString()

Model performance settings for the request.

If the service returns an enum value that is not available in the current SDK version, performanceConfigLatency will return PerformanceConfigLatency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceConfigLatencyAsString().

Returns:

Model performance settings for the request.

See Also:

PerformanceConfigLatency

toBuilder

public InvokeModelWithResponseStreamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvokeModelWithResponseStreamRequest.Builder,InvokeModelWithResponseStreamRequest>

Specified by:

toBuilder in class BedrockRuntimeRequest

builder

public static InvokeModelWithResponseStreamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends InvokeModelWithResponseStreamRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo