com.amazonaws.services.bedrockruntime.model

Class InvokeModelRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockruntime.model.InvokeModelRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InvokeModelRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
InvokeModelRequest()

Method Summary

Modifier and Type	Method and Description
InvokeModelRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccept() The desired MIME type of the inference body in the response.
ByteBuffer	getBody() The prompt and inference parameters in the format specified in the contentType in the header.
String	getContentType() The MIME type of the input data in the request.
String	getGuardrailIdentifier() The unique identifier of the guardrail that you want to use.
String	getGuardrailVersion() The version number for the guardrail.
String	getModelId() The unique identifier of the model to invoke to run inference.
String	getTrace() Specifies whether to enable or disable the Bedrock trace.
int	hashCode()
void	setAccept(String accept) The desired MIME type of the inference body in the response.
void	setBody(ByteBuffer body) The prompt and inference parameters in the format specified in the contentType in the header.
void	setContentType(String contentType) The MIME type of the input data in the request.
void	setGuardrailIdentifier(String guardrailIdentifier) The unique identifier of the guardrail that you want to use.
void	setGuardrailVersion(String guardrailVersion) The version number for the guardrail.
void	setModelId(String modelId) The unique identifier of the model to invoke to run inference.
void	setTrace(String trace) Specifies whether to enable or disable the Bedrock trace.
String	toString() Returns a string representation of this object.
InvokeModelRequest	withAccept(String accept) The desired MIME type of the inference body in the response.
InvokeModelRequest	withBody(ByteBuffer body) The prompt and inference parameters in the format specified in the contentType in the header.
InvokeModelRequest	withContentType(String contentType) The MIME type of the input data in the request.
InvokeModelRequest	withGuardrailIdentifier(String guardrailIdentifier) The unique identifier of the guardrail that you want to use.
InvokeModelRequest	withGuardrailVersion(String guardrailVersion) The version number for the guardrail.
InvokeModelRequest	withModelId(String modelId) The unique identifier of the model to invoke to run inference.
InvokeModelRequest	withTrace(String trace) Specifies whether to enable or disable the Bedrock trace.
InvokeModelRequest	withTrace(Trace trace) Specifies whether to enable or disable the Bedrock trace.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvokeModelRequest

public InvokeModelRequest()

Method Detail

setBody

public void setBody(ByteBuffer 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.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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.

getBody

public ByteBuffer getBody()

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.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

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.

withBody

public InvokeModelRequest withBody(ByteBuffer 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.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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:

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

setContentType

public void setContentType(String contentType)

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

Parameters:

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

getContentType

public String getContentType()

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.

withContentType

public InvokeModelRequest withContentType(String contentType)

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

Parameters:

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

Returns:

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

setAccept

public void setAccept(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.

getAccept

public String getAccept()

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.

withAccept

public InvokeModelRequest withAccept(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.

setModelId

public void setModelId(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.

getModelId

public String getModelId()

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:

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.

withModelId

public InvokeModelRequest withModelId(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.

setTrace

public void setTrace(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.

See Also:

Trace

getTrace

public String getTrace()

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

Returns:

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

See Also:

Trace

withTrace

public InvokeModelRequest withTrace(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

withTrace

public InvokeModelRequest withTrace(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

setGuardrailIdentifier

public void setGuardrailIdentifier(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 will be 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 will be 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.

getGuardrailIdentifier

public String getGuardrailIdentifier()

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

withGuardrailIdentifier

public InvokeModelRequest withGuardrailIdentifier(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 will be 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 will be 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.

setGuardrailVersion

public void setGuardrailVersion(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.

getGuardrailVersion

public String getGuardrailVersion()

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.

withGuardrailVersion

public InvokeModelRequest withGuardrailVersion(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public InvokeModelRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()