@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonBedrockRuntimeClient extends AmazonWebServiceClient implements AmazonBedrockRuntime
Describes the API operations for running inference using Amazon Bedrock models.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AmazonBedrockRuntimeClientBuilder |
builder() |
ConverseResult |
converse(ConverseRequest request)
Sends messages to the specified Amazon Bedrock model.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
InvokeModelResult |
invokeModel(InvokeModelRequest request)
Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in
the request body.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonBedrockRuntimeClientBuilder builder()
public ConverseResult converse(ConverseRequest request)
Sends messages to the specified Amazon Bedrock model. Converse
provides a consistent interface that
works with all models that support messages. This allows you to write code once and use it with different models.
Should a model have unique inference parameters, you can also pass those unique parameters to the model.
For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide
For example code, see Converse API examples in the Amazon Bedrock User Guide.
This operation requires permission for the bedrock:InvokeModel
action.
converse
in interface AmazonBedrockRuntime
converseRequest
- AccessDeniedException
- The request is denied because of missing access permissions.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.ModelTimeoutException
- The request took too long to process. Processing time exceeded the model timeout length.InternalServerException
- An internal server error occurred. Retry your request.ValidationException
- Input validation failed. Check your request parameters and retry the request.ModelNotReadyException
- The model specified in the request is not ready to serve inference requests.ModelErrorException
- The request failed due to an error while processing the model.public InvokeModelResult invokeModel(InvokeModelRequest request)
Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. You use model inference to generate text, images, and embeddings.
For example code, see Invoke model code examples in the Amazon Bedrock User Guide.
This operation requires permission for the bedrock:InvokeModel
action.
invokeModel
in interface AmazonBedrockRuntime
invokeModelRequest
- AccessDeniedException
- The request is denied because of missing access permissions.ResourceNotFoundException
- The specified resource ARN was not found. Check the ARN and try your request again.ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.ModelTimeoutException
- The request took too long to process. Processing time exceeded the model timeout length.InternalServerException
- An internal server error occurred. Retry your request.ValidationException
- Input validation failed. Check your request parameters and retry the request.ModelNotReadyException
- The model specified in the request is not ready to serve inference requests.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.ModelErrorException
- The request failed due to an error while processing the model.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonBedrockRuntime
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonBedrockRuntime
shutdown
in class AmazonWebServiceClient