PromptModelInferenceConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockagent.model.PromptModelInferenceConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PromptModelInferenceConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PromptModelInferenceConfiguration()

Constructors
Constructor and Description
`PromptModelInferenceConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PromptModelInferenceConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getMaxTokens()` The maximum number of tokens to return in the response.
`List<String>`	`getStopSequences()` A list of strings that define sequences after which the model will stop generating.
`Float`	`getTemperature()` Controls the randomness of the response.
`Integer`	`getTopK()` The number of most-likely candidates that the model considers for the next token during generation.
`Float`	`getTopP()` The percentage of most-likely candidates that the model considers for the next token.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMaxTokens(Integer maxTokens)` The maximum number of tokens to return in the response.
`void`	`setStopSequences(Collection<String> stopSequences)` A list of strings that define sequences after which the model will stop generating.
`void`	`setTemperature(Float temperature)` Controls the randomness of the response.
`void`	`setTopK(Integer topK)` The number of most-likely candidates that the model considers for the next token during generation.
`void`	`setTopP(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.
`PromptModelInferenceConfiguration`	`withMaxTokens(Integer maxTokens)` The maximum number of tokens to return in the response.
`PromptModelInferenceConfiguration`	`withStopSequences(Collection<String> stopSequences)` A list of strings that define sequences after which the model will stop generating.
`PromptModelInferenceConfiguration`	`withStopSequences(String... stopSequences)` A list of strings that define sequences after which the model will stop generating.
`PromptModelInferenceConfiguration`	`withTemperature(Float temperature)` Controls the randomness of the response.
`PromptModelInferenceConfiguration`	`withTopK(Integer topK)` The number of most-likely candidates that the model considers for the next token during generation.
`PromptModelInferenceConfiguration`	`withTopP(Float topP)` The percentage of most-likely candidates that the model considers for the next token.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PromptModelInferenceConfiguration
```
public PromptModelInferenceConfiguration()
```
- Method Detail
  - setMaxTokens
```
public void setMaxTokens(Integer maxTokens)
```
    The maximum number of tokens to return in the response.
    
    Parameters:
    
    maxTokens - The maximum number of tokens to return in the response.
  - getMaxTokens
```
public Integer getMaxTokens()
```
    The maximum number of tokens to return in the response.
    
    Returns:
    
    The maximum number of tokens to return in the response.
  - withMaxTokens
```
public PromptModelInferenceConfiguration withMaxTokens(Integer maxTokens)
```
    The maximum number of tokens to return in the response.
    
    Parameters:
    
    maxTokens - The maximum number of tokens to return in the response.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStopSequences
```
public List<String> getStopSequences()
```
    A list of strings that define sequences after which the model will stop generating.
    
    Returns:
    
    A list of strings that define sequences after which the model will stop generating.
  - setStopSequences
```
public void setStopSequences(Collection<String> stopSequences)
```
    A list of strings that define sequences after which the model will stop generating.
    
    Parameters:
    
    stopSequences - A list of strings that define sequences after which the model will stop generating.
  - withStopSequences
```
public PromptModelInferenceConfiguration withStopSequences(String... stopSequences)
```
    A list of strings that define sequences after which the model will stop generating.
    
    NOTE: This method appends the values to the existing list (if any). Use setStopSequences(java.util.Collection) or withStopSequences(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    stopSequences - A list of strings that define sequences after which the model will stop generating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStopSequences
```
public PromptModelInferenceConfiguration withStopSequences(Collection<String> stopSequences)
```
    A list of strings that define sequences after which the model will stop generating.
    
    Parameters:
    
    stopSequences - A list of strings that define sequences after which the model will stop generating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemperature
```
public void setTemperature(Float temperature)
```
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    
    Parameters:
    
    temperature - Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
  - getTemperature
```
public Float getTemperature()
```
    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.
  - withTemperature
```
public PromptModelInferenceConfiguration withTemperature(Float temperature)
```
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    
    Parameters:
    
    temperature - Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTopK
```
public void setTopK(Integer topK)
```
    The number of most-likely candidates that the model considers for the next token during generation.
    
    Parameters:
    
    topK - The number of most-likely candidates that the model considers for the next token during generation.
  - getTopK
```
public Integer getTopK()
```
    The number of most-likely candidates that the model considers for the next token during generation.
    
    Returns:
    
    The number of most-likely candidates that the model considers for the next token during generation.
  - withTopK
```
public PromptModelInferenceConfiguration withTopK(Integer topK)
```
    The number of most-likely candidates that the model considers for the next token during generation.
    
    Parameters:
    
    topK - The number of most-likely candidates that the model considers for the next token during generation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTopP
```
public void setTopP(Float topP)
```
    The percentage of most-likely candidates that the model considers for the next token.
    
    Parameters:
    
    topP - The percentage of most-likely candidates that the model considers for the next token.
  - getTopP
```
public Float getTopP()
```
    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.
  - withTopP
```
public PromptModelInferenceConfiguration withTopP(Float topP)
```
    The percentage of most-likely candidates that the model considers for the next token.
    
    Parameters:
    
    topP - The percentage of most-likely candidates that the model considers for the next token.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PromptModelInferenceConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.782

Class PromptModelInferenceConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PromptModelInferenceConfiguration

Method Detail

setMaxTokens

getMaxTokens

withMaxTokens

getStopSequences

setStopSequences

withStopSequences

withStopSequences

setTemperature

getTemperature

withTemperature

setTopK

getTopK

withTopK

setTopP

getTopP

withTopP

toString

equals

hashCode

clone

marshall