java.lang.Object
- software.amazon.awssdk.services.bedrockruntime.model.InferenceConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InferenceConfiguration.Builder,InferenceConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class InferenceConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InferenceConfiguration.Builder,InferenceConfiguration>
```
Base inference parameters to pass to a model in a call to Converse or ConverseStream. For more information, see Inference parameters for foundation models.

If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field in the call to Converse or ConverseStream. For more information, see Model parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InferenceConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static InferenceConfiguration.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 allow in the generated response.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InferenceConfiguration.Builder>`	`serializableBuilderClass()`
`List<String>`	`stopSequences()`	A list of stop sequences.
`Float`	`temperature()`	The likelihood of the model selecting higher-probability options while generating a response.
`InferenceConfiguration.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 allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.
    
    Returns:
    
    The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.
  - temperature
```
public final Float temperature()
```
    The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
    
    The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
    
    Returns:
    
    The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
    
    The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
  - topP
```
public final Float topP()
```
    The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
    
    The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
    
    Returns:
    
    The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
    
    The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models.
  - 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 stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
    
    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 stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
  - toBuilder
```
public InferenceConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InferenceConfiguration.Builder,InferenceConfiguration>
  - builder
```
public static InferenceConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InferenceConfiguration.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

Class InferenceConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

maxTokens

temperature

topP

hasStopSequences

stopSequences

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField