bedrockruntime/aws.sdk.kotlin.services.bedrockruntime/BedrockRuntimeClient

BedrockRuntimeClient

interface BedrockRuntimeClient : SdkClient

Describes the API operations for running inference using Bedrock models.

Types

class Builder : AbstractSdkClientBuilder<BedrockRuntimeClient.Config, BedrockRuntimeClient.Config.Builder, BedrockRuntimeClient>

Companion

object Companion : AbstractAwsSdkClientFactory<BedrockRuntimeClient.Config, BedrockRuntimeClient.Config.Builder, BedrockRuntimeClient, BedrockRuntimeClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: BedrockRuntimeClient.Config

BedrockRuntimeClient's configuration

Functions

invokeModel

abstract suspend fun invokeModel(input: InvokeModelRequest): InvokeModelResponse

Invokes the specified Bedrock model to run inference using the input provided in the request body. You use InvokeModel to run inference for text models, image models, and embedding models.

invokeModelWithResponseStream

abstract suspend fun <T> invokeModelWithResponseStream(input: InvokeModelWithResponseStreamRequest, block: suspend (InvokeModelWithResponseStreamResponse) -> T): T

Invoke the specified Bedrock model to run inference using the input provided. Return the response in a stream.

Inherited functions

expect abstract fun close()

invokeModel

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

Invokes the specified Bedrock model to run inference using the input provided in the request body. You use InvokeModel to run inference for text models, image models, and embedding models.

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.