Package co.elastic.clients.elasticsearch.inference

Class AmazonBedrockServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<AmazonBedrockServiceSettings.Builder>

co.elastic.clients.elasticsearch.inference.AmazonBedrockServiceSettings.Builder

All Implemented Interfaces:

WithJson<AmazonBedrockServiceSettings.Builder>, ObjectBuilder<AmazonBedrockServiceSettings>

Enclosing class:

AmazonBedrockServiceSettings

public static class AmazonBedrockServiceSettings.Builder
extends WithJsonObjectBuilderBase<AmazonBedrockServiceSettings.Builder>
implements ObjectBuilder<AmazonBedrockServiceSettings>

Builder for AmazonBedrockServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AmazonBedrockServiceSettings.Builder	accessKey(String value)	Required - A valid AWS access key that has permissions to use Amazon Bedrock and access to models for inference requests.
AmazonBedrockServiceSettings	build()	Builds a AmazonBedrockServiceSettings.
final AmazonBedrockServiceSettings.Builder	model(String value)	Required - The base model ID or an ARN to a custom model based on a foundational model.
final AmazonBedrockServiceSettings.Builder	provider(String value)	The model provider for your deployment.
final AmazonBedrockServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from Watsonx.
final AmazonBedrockServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from Watsonx.
final AmazonBedrockServiceSettings.Builder	region(String value)	Required - The region that your model or ARN is deployed in.
final AmazonBedrockServiceSettings.Builder	secretKey(String value)	Required - A valid AWS secret key that is paired with the access_key.
protected AmazonBedrockServiceSettings.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

accessKey

public final AmazonBedrockServiceSettings.Builder accessKey(String value)

Required - A valid AWS access key that has permissions to use Amazon Bedrock and access to models for inference requests.

API name: access_key

model

public final AmazonBedrockServiceSettings.Builder model(String value)

Required - The base model ID or an ARN to a custom model based on a foundational model. The base model IDs can be found in the Amazon Bedrock documentation. Note that the model ID must be available for the provider chosen and your IAM user must have access to the model.

API name: model

provider

public final AmazonBedrockServiceSettings.Builder provider(@Nullable
 String value)

The model provider for your deployment. Note that some providers may support only certain task types. Supported providers include:

• amazontitan - available for text_embedding and completion task types
• anthropic - available for completion task type only
• ai21labs - available for completion task type only
• cohere - available for text_embedding and completion task types
• meta - available for completion task type only
• mistral - available for completion task type only

API name: provider

region

public final AmazonBedrockServiceSettings.Builder region(String value)

Required - The region that your model or ARN is deployed in. The list of available regions per model can be found in the Amazon Bedrock documentation.

API name: region

rateLimit

public final AmazonBedrockServiceSettings.Builder rateLimit(@Nullable
 RateLimitSetting value)

This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the watsonxai service sets the number of requests allowed per minute to 120.

API name: rate_limit

rateLimit

public final AmazonBedrockServiceSettings.Builder rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)

This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the watsonxai service sets the number of requests allowed per minute to 120.

API name: rate_limit

secretKey

public final AmazonBedrockServiceSettings.Builder secretKey(String value)

Required - A valid AWS secret key that is paired with the access_key. For informationg about creating and managing access and secret keys, refer to the AWS documentation.

API name: secret_key

self

protected AmazonBedrockServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<AmazonBedrockServiceSettings.Builder>

build

public AmazonBedrockServiceSettings build()

Builds a AmazonBedrockServiceSettings.

Specified by:

build in interface ObjectBuilder<AmazonBedrockServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.