bedrockruntime/aws.sdk.kotlin.services.bedrockruntime

Package-level declarations

Types

BedrockRuntimeClient

interface BedrockRuntimeClient : SdkClient

Describes the API operations for running inference using Amazon Bedrock models.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

applyGuardrail

inline suspend fun BedrockRuntimeClient.applyGuardrail(crossinline block: ApplyGuardrailRequest.Builder.() -> Unit): ApplyGuardrailResponse

The action to apply a guardrail.

converse

inline suspend fun BedrockRuntimeClient.converse(crossinline block: ConverseRequest.Builder.() -> Unit): ConverseResponse

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.

getAsyncInvoke

inline suspend fun BedrockRuntimeClient.getAsyncInvoke(crossinline block: GetAsyncInvokeRequest.Builder.() -> Unit): GetAsyncInvokeResponse

Retrieve information about an asynchronous invocation.

invokeModel

inline suspend fun BedrockRuntimeClient.invokeModel(crossinline block: InvokeModelRequest.Builder.() -> Unit): InvokeModelResponse

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.

listAsyncInvokes

inline suspend fun BedrockRuntimeClient.listAsyncInvokes(crossinline block: ListAsyncInvokesRequest.Builder.() -> Unit): ListAsyncInvokesResponse

Lists asynchronous invocations.

startAsyncInvoke

inline suspend fun BedrockRuntimeClient.startAsyncInvoke(crossinline block: StartAsyncInvokeRequest.Builder.() -> Unit): StartAsyncInvokeResponse

Starts an asynchronous invocation.

withConfig

fun BedrockRuntimeClient.withConfig(block: BedrockRuntimeClient.Config.Builder.() -> Unit): BedrockRuntimeClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.