PromptVariant (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PromptVariant
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains details about a variant of the prompt.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PromptVariant()

Constructors
Constructor and Description
`PromptVariant()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PromptVariant`	`clone()`
`boolean`	`equals(Object obj)`
`PromptInferenceConfiguration`	`getInferenceConfiguration()` Contains inference configurations for the prompt variant.
`String`	`getModelId()` The unique identifier of the model with which to run inference on the prompt.
`String`	`getName()` The name of the prompt variant.
`PromptTemplateConfiguration`	`getTemplateConfiguration()` Contains configurations for the prompt template.
`String`	`getTemplateType()` The type of prompt template to use.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)` Contains inference configurations for the prompt variant.
`void`	`setModelId(String modelId)` The unique identifier of the model with which to run inference on the prompt.
`void`	`setName(String name)` The name of the prompt variant.
`void`	`setTemplateConfiguration(PromptTemplateConfiguration templateConfiguration)` Contains configurations for the prompt template.
`void`	`setTemplateType(String templateType)` The type of prompt template to use.
`String`	`toString()` Returns a string representation of this object.
`PromptVariant`	`withInferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)` Contains inference configurations for the prompt variant.
`PromptVariant`	`withModelId(String modelId)` The unique identifier of the model with which to run inference on the prompt.
`PromptVariant`	`withName(String name)` The name of the prompt variant.
`PromptVariant`	`withTemplateConfiguration(PromptTemplateConfiguration templateConfiguration)` Contains configurations for the prompt template.
`PromptVariant`	`withTemplateType(PromptTemplateType templateType)` The type of prompt template to use.
`PromptVariant`	`withTemplateType(String templateType)` The type of prompt template to use.

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

- Constructor Detail
  - PromptVariant
```
public PromptVariant()
```
- Method Detail
  - setInferenceConfiguration
```
public void setInferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)
```
    Contains inference configurations for the prompt variant.
    
    Parameters:
    
    inferenceConfiguration - Contains inference configurations for the prompt variant.
  - getInferenceConfiguration
```
public PromptInferenceConfiguration getInferenceConfiguration()
```
    Contains inference configurations for the prompt variant.
    
    Returns:
    
    Contains inference configurations for the prompt variant.
  - withInferenceConfiguration
```
public PromptVariant withInferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)
```
    Contains inference configurations for the prompt variant.
    
    Parameters:
    
    inferenceConfiguration - Contains inference configurations for the prompt variant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelId
```
public void setModelId(String modelId)
```
    The unique identifier of the model with which to run inference on the prompt.
    
    Parameters:
    
    modelId - The unique identifier of the model with which to run inference on the prompt.
  - getModelId
```
public String getModelId()
```
    The unique identifier of the model with which to run inference on the prompt.
    
    Returns:
    
    The unique identifier of the model with which to run inference on the prompt.
  - withModelId
```
public PromptVariant withModelId(String modelId)
```
    The unique identifier of the model with which to run inference on the prompt.
    
    Parameters:
    
    modelId - The unique identifier of the model with which to run inference on the prompt.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the prompt variant.
    
    Parameters:
    
    name - The name of the prompt variant.
  - getName
```
public String getName()
```
    The name of the prompt variant.
    
    Returns:
    
    The name of the prompt variant.
  - withName
```
public PromptVariant withName(String name)
```
    The name of the prompt variant.
    
    Parameters:
    
    name - The name of the prompt variant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateConfiguration
```
public void setTemplateConfiguration(PromptTemplateConfiguration templateConfiguration)
```
    Contains configurations for the prompt template.
    
    Parameters:
    
    templateConfiguration - Contains configurations for the prompt template.
  - getTemplateConfiguration
```
public PromptTemplateConfiguration getTemplateConfiguration()
```
    Contains configurations for the prompt template.
    
    Returns:
    
    Contains configurations for the prompt template.
  - withTemplateConfiguration
```
public PromptVariant withTemplateConfiguration(PromptTemplateConfiguration templateConfiguration)
```
    Contains configurations for the prompt template.
    
    Parameters:
    
    templateConfiguration - Contains configurations for the prompt template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateType
```
public void setTemplateType(String templateType)
```
    The type of prompt template to use.
    
    Parameters:
    
    templateType - The type of prompt template to use.
    
    See Also:
    
    PromptTemplateType
  - getTemplateType
```
public String getTemplateType()
```
    The type of prompt template to use.
    
    Returns:
    
    The type of prompt template to use.
    
    See Also:
    
    PromptTemplateType
  - withTemplateType
```
public PromptVariant withTemplateType(String templateType)
```
    The type of prompt template to use.
    
    Parameters:
    
    templateType - The type of prompt template to use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PromptTemplateType
  - withTemplateType
```
public PromptVariant withTemplateType(PromptTemplateType templateType)
```
    The type of prompt template to use.
    
    Parameters:
    
    templateType - The type of prompt template to use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PromptTemplateType
  - 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 PromptVariant 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.771

Class PromptVariant

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PromptVariant

Method Detail

setInferenceConfiguration

getInferenceConfiguration

withInferenceConfiguration

setModelId

getModelId

withModelId

setName

getName

withName

setTemplateConfiguration

getTemplateConfiguration

withTemplateConfiguration

setTemplateType

getTemplateType

withTemplateType

withTemplateType

toString

equals

hashCode

clone

marshall