Class BedrockBatchChatModel.Builder

java.lang.Object

dev.langchain4j.model.bedrock.BedrockBatchChatModel.Builder

Enclosing class:

BedrockBatchChatModel

public static final class BedrockBatchChatModel.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
BedrockBatchChatModel.Builder	bedrockClient(software.amazon.awssdk.services.bedrock.BedrockClient bedrockClient)	Sets the BedrockClient used for job control-plane calls.
BedrockBatchChatModel	build()
BedrockBatchChatModel.Builder	credentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider)	Sets the credentials provider for the clients created when none are supplied.
BedrockBatchChatModel.Builder	customHeaders(Supplier<Map<String,String>> customHeadersSupplier)	Sets a supplier of headers added to every control-plane call.
BedrockBatchChatModel.Builder	customHeaders(Map<String,String> customHeaders)	Sets headers added to every control-plane call.
BedrockBatchChatModel.Builder	defaultRequestParameters(ChatRequestParameters defaultRequestParameters)	Sets common default ChatRequestParameters; per-request parameters take precedence over these.
BedrockBatchChatModel.Builder	inputS3Uri(String inputS3Uri)	Sets the S3 URI under which the generated input file is uploaded.
BedrockBatchChatModel.Builder	jobTimeout(Duration jobTimeout)	Sets how long the job may run before its unprocessed records expire.
BedrockBatchChatModel.Builder	logger(org.slf4j.Logger logger)	Sets the Logger used when logRequests(Boolean) or logResponses(Boolean) is enabled.
BedrockBatchChatModel.Builder	logRequests(Boolean logRequests)	Enables logging of the control-plane and S3 requests.
BedrockBatchChatModel.Builder	logResponses(Boolean logResponses)	Enables logging of the control-plane and S3 responses.
BedrockBatchChatModel.Builder	maxRetries(Integer maxRetries)	Sets the number of times to retry a control-plane or S3 call on transient errors.
BedrockBatchChatModel.Builder	modelId(String modelId)	Sets the model that every request in the batch runs against.
BedrockBatchChatModel.Builder	outputS3Uri(String outputS3Uri)	Sets the S3 URI (for example s3://my-bucket/batch-output) where Bedrock writes the results.
BedrockBatchChatModel.Builder	region(software.amazon.awssdk.regions.Region region)	Sets the AWS region for the clients created when none are supplied.
BedrockBatchChatModel.Builder	returnThinking(Boolean returnThinking)	Controls whether the thinking of a model with reasoning enabled is returned in AiMessage.thinking().
BedrockBatchChatModel.Builder	roleArn(String roleArn)	Sets the ARN of the service role Bedrock assumes to read the input and write the output in S3.
BedrockBatchChatModel.Builder	s3Client(software.amazon.awssdk.services.s3.S3Client s3Client)	Sets the S3Client used to write inputs and read outputs.
BedrockBatchChatModel.Builder	sendThinking(Boolean sendThinking)	Controls whether the thinking of an AiMessage in the conversation is sent back to the model.
BedrockBatchChatModel.Builder	timeout(Duration timeout)	Sets the timeout of each control-plane and S3 call.

Methods inherited from class Object

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

Method Details

bedrockClient

public BedrockBatchChatModel.Builder bedrockClient(software.amazon.awssdk.services.bedrock.BedrockClient bedrockClient)

Sets the BedrockClient used for job control-plane calls. If not set, one is created from region(Region) and credentialsProvider(AwsCredentialsProvider). A client set here is not closed by BedrockBatchChatModel.close().

Returns:

this

s3Client

public BedrockBatchChatModel.Builder s3Client(software.amazon.awssdk.services.s3.S3Client s3Client)

Sets the S3Client used to write inputs and read outputs. If not set, one is created from region(Region) and credentialsProvider(AwsCredentialsProvider). The bucket must be in the same region as the job. A client set here is not closed by BedrockBatchChatModel.close().

Returns:

this

region

public BedrockBatchChatModel.Builder region(software.amazon.awssdk.regions.Region region)

Sets the AWS region for the clients created when none are supplied. Defaults to us-east-1.

Returns:

this

credentialsProvider

public BedrockBatchChatModel.Builder credentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider)

Sets the credentials provider for the clients created when none are supplied. Defaults to DefaultCredentialsProvider. A provider set here is not closed by BedrockBatchChatModel.close().

Returns:

this

modelId

public BedrockBatchChatModel.Builder modelId(String modelId)

Sets the model that every request in the batch runs against. Defaults to the model name of defaultRequestParameters(ChatRequestParameters).

Returns:

this

roleArn

public BedrockBatchChatModel.Builder roleArn(String roleArn)

Sets the ARN of the service role Bedrock assumes to read the input and write the output in S3.

Returns:

this

outputS3Uri

public BedrockBatchChatModel.Builder outputS3Uri(String outputS3Uri)

Sets the S3 URI (for example s3://my-bucket/batch-output) where Bedrock writes the results.

Returns:

this

inputS3Uri

public BedrockBatchChatModel.Builder inputS3Uri(String inputS3Uri)

Sets the S3 URI under which the generated input file is uploaded. Defaults to outputS3Uri(String).

Returns:

this

defaultRequestParameters

public BedrockBatchChatModel.Builder defaultRequestParameters(ChatRequestParameters defaultRequestParameters)

Sets common default ChatRequestParameters; per-request parameters take precedence over these.

Returns:

this

jobTimeout

public BedrockBatchChatModel.Builder jobTimeout(Duration jobTimeout)

Sets how long the job may run before its unprocessed records expire. Bedrock accepts whole hours between 24 and 168, so a value that is not a whole number of hours is rounded up, and a value outside that range is rejected. If not set, Bedrock applies its default.

Returns:

this

timeout

public BedrockBatchChatModel.Builder timeout(Duration timeout)

Sets the timeout of each control-plane and S3 call. If not set, the AWS SDK default applies. Ignored for a client passed to bedrockClient(BedrockClient) or s3Client(S3Client).

Returns:

this

maxRetries

public BedrockBatchChatModel.Builder maxRetries(Integer maxRetries)

Sets the number of times to retry a control-plane or S3 call on transient errors. Defaults to 2.

Returns:

this

returnThinking

public BedrockBatchChatModel.Builder returnThinking(Boolean returnThinking)

Controls whether the thinking of a model with reasoning enabled is returned in AiMessage.thinking(). Defaults to false.

Returns:

this

sendThinking

public BedrockBatchChatModel.Builder sendThinking(Boolean sendThinking)

Controls whether the thinking of an AiMessage in the conversation is sent back to the model. Defaults to true.

Returns:

this

customHeaders

public BedrockBatchChatModel.Builder customHeaders(Map<String,String> customHeaders)

Sets headers added to every control-plane call. Ignored for a client passed to bedrockClient(BedrockClient).

Returns:

this

customHeaders

public BedrockBatchChatModel.Builder customHeaders(Supplier<Map<String,String>> customHeadersSupplier)

Sets a supplier of headers added to every control-plane call. Ignored for a client passed to bedrockClient(BedrockClient).

Returns:

this

logRequests

public BedrockBatchChatModel.Builder logRequests(Boolean logRequests)

Enables logging of the control-plane and S3 requests. Defaults to false. Ignored for a client passed to bedrockClient(BedrockClient) or s3Client(S3Client).

Returns:

this

logResponses

public BedrockBatchChatModel.Builder logResponses(Boolean logResponses)

Enables logging of the control-plane and S3 responses. Defaults to false. Ignored for a client passed to bedrockClient(BedrockClient) or s3Client(S3Client).

Returns:

this

logger

public BedrockBatchChatModel.Builder logger(org.slf4j.Logger logger)

Sets the Logger used when logRequests(Boolean) or logResponses(Boolean) is enabled.

Returns:

this

build

public BedrockBatchChatModel build()