Class InferenceConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockagentruntime.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>
Configurations for controlling the inference response of an InvokeAgent API call
- 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
maximumLength()
Returns the value of the MaximumLength property for this object.List<SdkField<?>>
sdkFields()
static Class<? extends InferenceConfiguration.Builder>
serializableBuilderClass()
List<String>
stopSequences()
Returns the value of the StopSequences property for this object.Float
temperature()
Returns the value of the Temperature property for this object.InferenceConfiguration.Builder
toBuilder()
Integer
topK()
Returns the value of the TopK property for this object.Float
topP()
Returns the value of the TopP property for this object.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
-
temperature
public final Float temperature()
Returns the value of the Temperature property for this object.- Returns:
- The value of the Temperature property for this object.
-
topP
public final Float topP()
Returns the value of the TopP property for this object.- Returns:
- The value of the TopP property for this object.
-
topK
public final Integer topK()
Returns the value of the TopK property for this object.- Returns:
- The value of the TopK property for this object.
-
maximumLength
public final Integer maximumLength()
Returns the value of the MaximumLength property for this object.- Returns:
- The value of the MaximumLength property for this object.
-
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 theisEmpty()
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()
Returns the value of the StopSequences property for this object.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:
- The value of the StopSequences property for this object.
-
toBuilder
public InferenceConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InferenceConfiguration.Builder,InferenceConfiguration>
-
builder
public static InferenceConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends InferenceConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-