com.amazonaws.services.bedrockruntime

Class AbstractAmazonBedrockRuntime

java.lang.Object

com.amazonaws.services.bedrockruntime.AbstractAmazonBedrockRuntime

All Implemented Interfaces:

AmazonBedrockRuntime

Direct Known Subclasses:

AbstractAmazonBedrockRuntimeAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonBedrockRuntime
extends Object
implements AmazonBedrockRuntime

Abstract implementation of AmazonBedrockRuntime. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.bedrockruntime.AmazonBedrockRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
ApplyGuardrailResult	applyGuardrail(ApplyGuardrailRequest request) The action to apply a guardrail.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

applyGuardrail

public ApplyGuardrailResult applyGuardrail(ApplyGuardrailRequest request)

Description copied from interface: AmazonBedrockRuntime

The action to apply a guardrail.

Specified by:

applyGuardrail in interface AmazonBedrockRuntime

Returns:

Result of the ApplyGuardrail operation returned by the service.

See Also:

AWS API Documentation

converse

public ConverseResult converse(ConverseRequest request)

Description copied from interface: AmazonBedrockRuntime

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. If a model has unique inference parameters, you can also pass those unique parameters to the model.

Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.

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.

Specified by:

converse in interface AmazonBedrockRuntime

Returns:

Result of the Converse operation returned by the service.

See Also:

AWS API Documentation

invokeModel

public InvokeModelResult invokeModel(InvokeModelRequest request)

Description copied from interface: AmazonBedrockRuntime

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.

Specified by:

invokeModel in interface AmazonBedrockRuntime

Returns:

Result of the InvokeModel operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonBedrockRuntime

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonBedrockRuntime

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonBedrockRuntime

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Specified by:

getCachedResponseMetadata in interface AmazonBedrockRuntime

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.