Package software.amazon.awssdk.services.bedrockagent.model

Class PromptModelInferenceConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.PromptModelInferenceConfiguration

All Implemented Interfaces:

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

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

Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromptModelInferenceConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static PromptModelInferenceConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStopSequences()	For responses, this returns true if the service returned a value for the StopSequences property.
Integer	maxTokens()	The maximum number of tokens to return in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends PromptModelInferenceConfiguration.Builder>	serializableBuilderClass()
List<String>	stopSequences()	A list of strings that define sequences after which the model will stop generating.
Float	temperature()	Controls the randomness of the response.
PromptModelInferenceConfiguration.Builder	toBuilder()
Float	topP()	The percentage of most-likely candidates that the model considers for the next token.
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

maxTokens

public final Integer maxTokens()

The maximum number of tokens to return in the response.

Returns:

The maximum number of tokens to return in the response.

hasStopSequences

public final boolean hasStopSequences()

For responses, this returns true if the service returned a value for the StopSequences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

stopSequences

public final List<String> stopSequences()

A list of strings that define sequences after which the model will stop generating.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStopSequences() method.

Returns:

A list of strings that define sequences after which the model will stop generating.

temperature

public final Float temperature()

Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

Returns:

Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

topP

public final Float topP()

The percentage of most-likely candidates that the model considers for the next token.

Returns:

The percentage of most-likely candidates that the model considers for the next token.

toBuilder

public PromptModelInferenceConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PromptModelInferenceConfiguration.Builder,PromptModelInferenceConfiguration>

builder

public static PromptModelInferenceConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PromptModelInferenceConfiguration.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