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

Class StreamingConfigurations

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.StreamingConfigurations

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StreamingConfigurations.Builder,StreamingConfigurations>

@Generated("software.amazon.awssdk:codegen")
public final class StreamingConfigurations
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StreamingConfigurations.Builder,StreamingConfigurations>

Configurations for streaming.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamingConfigurations.Builder

Method Summary

Modifier and Type	Method	Description
Integer	applyGuardrailInterval()	The guardrail interval to apply as response is generated.
static StreamingConfigurations.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StreamingConfigurations.Builder>	serializableBuilderClass()
Boolean	streamFinalResponse()	Specifies whether to enable streaming for the final response.
StreamingConfigurations.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applyGuardrailInterval

public final 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

Returns:

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

streamFinalResponse

public final Boolean streamFinalResponse()

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

Returns:

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

toBuilder

public StreamingConfigurations.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StreamingConfigurations.Builder,StreamingConfigurations>

builder

public static StreamingConfigurations.Builder builder()

serializableBuilderClass

public static Class<? extends StreamingConfigurations.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo