Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface StreamingConfigurations.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StreamingConfigurations.Builder,StreamingConfigurations>, SdkBuilder<StreamingConfigurations.Builder,StreamingConfigurations>, SdkPojo

Enclosing class:

StreamingConfigurations

@Mutable
@NotThreadSafe
public static interface StreamingConfigurations.Builder
extends SdkPojo, CopyableBuilder<StreamingConfigurations.Builder,StreamingConfigurations>

Method Summary

Modifier and Type	Method	Description
StreamingConfigurations.Builder	applyGuardrailInterval(Integer applyGuardrailInterval)	The guardrail interval to apply as response is generated.
StreamingConfigurations.Builder	streamFinalResponse(Boolean streamFinalResponse)	Specifies whether to enable streaming for the final response.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

applyGuardrailInterval

StreamingConfigurations.Builder applyGuardrailInterval(Integer applyGuardrailInterval)

The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.

Example response in chunks: Interval set to 3 characters

'Hel', 'lo, ','I am', ' an', ' Age', 'nt'

Each chunk has at least 3 characters except for the last chunk

Example response in chunks: Interval set to 20 or more characters

Hello, I am an Agent

Parameters:

applyGuardrailInterval - The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.

Example response in chunks: Interval set to 3 characters

'Hel', 'lo, ','I am', ' an', ' Age', 'nt'

Each chunk has at least 3 characters except for the last chunk

Example response in chunks: Interval set to 20 or more characters

Hello, I am an Agent

Returns:

Returns a reference to this object so that method calls can be chained together.

streamFinalResponse

StreamingConfigurations.Builder streamFinalResponse(Boolean streamFinalResponse)

Specifies whether to enable streaming for the final response. This is set to false by default.

Parameters:

streamFinalResponse - Specifies whether to enable streaming for the final response. This is set to false by default.

Returns:

Returns a reference to this object so that method calls can be chained together.