PromptConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PromptConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PromptConfiguration()

Constructors
Constructor and Description
`PromptConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PromptConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBasePromptTemplate()` Defines the prompt template with which to replace the default prompt template.
`InferenceConfiguration`	`getInferenceConfiguration()` Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`.
`String`	`getParserMode()` Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`.
`String`	`getPromptCreationMode()` Specifies whether to override the default prompt template for this `promptType`.
`String`	`getPromptState()` Specifies whether to allow the agent to carry out the step specified in the `promptType`.
`String`	`getPromptType()` The step in the agent sequence that this prompt configuration applies to.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBasePromptTemplate(String basePromptTemplate)` Defines the prompt template with which to replace the default prompt template.
`void`	`setInferenceConfiguration(InferenceConfiguration inferenceConfiguration)` Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`.
`void`	`setParserMode(String parserMode)` Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`.
`void`	`setPromptCreationMode(String promptCreationMode)` Specifies whether to override the default prompt template for this `promptType`.
`void`	`setPromptState(String promptState)` Specifies whether to allow the agent to carry out the step specified in the `promptType`.
`void`	`setPromptType(String promptType)` The step in the agent sequence that this prompt configuration applies to.
`String`	`toString()` Returns a string representation of this object.
`PromptConfiguration`	`withBasePromptTemplate(String basePromptTemplate)` Defines the prompt template with which to replace the default prompt template.
`PromptConfiguration`	`withInferenceConfiguration(InferenceConfiguration inferenceConfiguration)` Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`.
`PromptConfiguration`	`withParserMode(CreationMode parserMode)` Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`.
`PromptConfiguration`	`withParserMode(String parserMode)` Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`.
`PromptConfiguration`	`withPromptCreationMode(CreationMode promptCreationMode)` Specifies whether to override the default prompt template for this `promptType`.
`PromptConfiguration`	`withPromptCreationMode(String promptCreationMode)` Specifies whether to override the default prompt template for this `promptType`.
`PromptConfiguration`	`withPromptState(PromptState promptState)` Specifies whether to allow the agent to carry out the step specified in the `promptType`.
`PromptConfiguration`	`withPromptState(String promptState)` Specifies whether to allow the agent to carry out the step specified in the `promptType`.
`PromptConfiguration`	`withPromptType(PromptType promptType)` The step in the agent sequence that this prompt configuration applies to.
`PromptConfiguration`	`withPromptType(String promptType)` The step in the agent sequence that this prompt configuration applies to.

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

- Constructor Detail
  - PromptConfiguration
```
public PromptConfiguration()
```
- Method Detail
  - setBasePromptTemplate
```
public void setBasePromptTemplate(String basePromptTemplate)
```
    Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
    
    Parameters:
    
    basePromptTemplate - Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
  - getBasePromptTemplate
```
public String getBasePromptTemplate()
```
    Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
    
    Returns:
    
    Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
  - withBasePromptTemplate
```
public PromptConfiguration withBasePromptTemplate(String basePromptTemplate)
```
    Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
    
    Parameters:
    
    basePromptTemplate - Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInferenceConfiguration
```
public void setInferenceConfiguration(InferenceConfiguration inferenceConfiguration)
```
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
    
    Parameters:
    
    inferenceConfiguration - Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
  - getInferenceConfiguration
```
public InferenceConfiguration getInferenceConfiguration()
```
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
    
    Returns:
    
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
  - withInferenceConfiguration
```
public PromptConfiguration withInferenceConfiguration(InferenceConfiguration inferenceConfiguration)
```
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
    
    Parameters:
    
    inferenceConfiguration - Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParserMode
```
public void setParserMode(String parserMode)
```
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    Parameters:
    
    parserMode - Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    See Also:
    
    CreationMode
  - getParserMode
```
public String getParserMode()
```
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    Returns:
    
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    See Also:
    
    CreationMode
  - withParserMode
```
public PromptConfiguration withParserMode(String parserMode)
```
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    Parameters:
    
    parserMode - Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CreationMode
  - withParserMode
```
public PromptConfiguration withParserMode(CreationMode parserMode)
```
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    Parameters:
    
    parserMode - Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CreationMode
  - setPromptCreationMode
```
public void setPromptCreationMode(String promptCreationMode)
```
    Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    Parameters:
    
    promptCreationMode - Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    See Also:
    
    CreationMode
  - getPromptCreationMode
```
public String getPromptCreationMode()
```
    Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    Returns:
    
    Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    See Also:
    
    CreationMode
  - withPromptCreationMode
```
public PromptConfiguration withPromptCreationMode(String promptCreationMode)
```
    Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    Parameters:
    
    promptCreationMode - Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CreationMode
  - withPromptCreationMode
```
public PromptConfiguration withPromptCreationMode(CreationMode promptCreationMode)
```
    Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    Parameters:
    
    promptCreationMode - Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CreationMode
  - setPromptState
```
public void setPromptState(String promptState)
```
    Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    - PRE_PROCESSING – ENABLED
    - ORCHESTRATION – ENABLED
    - KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    - POST_PROCESSING – DISABLED
    Parameters:
    promptState - Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    
    PRE_PROCESSING – ENABLED
    
    ORCHESTRATION – ENABLED
    
    KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    
    POST_PROCESSING – DISABLED
    See Also:
    
    PromptState
  - getPromptState
```
public String getPromptState()
```
    Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    - PRE_PROCESSING – ENABLED
    - ORCHESTRATION – ENABLED
    - KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    - POST_PROCESSING – DISABLED
    Returns:
    Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    
    PRE_PROCESSING – ENABLED
    
    ORCHESTRATION – ENABLED
    
    KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    
    POST_PROCESSING – DISABLED
    See Also:
    
    PromptState
  - withPromptState
```
public PromptConfiguration withPromptState(String promptState)
```
    Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    - PRE_PROCESSING – ENABLED
    - ORCHESTRATION – ENABLED
    - KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    - POST_PROCESSING – DISABLED
    Parameters:
    promptState - Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    
    PRE_PROCESSING – ENABLED
    
    ORCHESTRATION – ENABLED
    
    KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    
    POST_PROCESSING – DISABLED
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PromptState
  - withPromptState
```
public PromptConfiguration withPromptState(PromptState promptState)
```
    Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    - PRE_PROCESSING – ENABLED
    - ORCHESTRATION – ENABLED
    - KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    - POST_PROCESSING – DISABLED
    Parameters:
    promptState - Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
    
    PRE_PROCESSING – ENABLED
    
    ORCHESTRATION – ENABLED
    
    KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    
    POST_PROCESSING – DISABLED
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PromptState
  - setPromptType
```
public void setPromptType(String promptType)
```
    The step in the agent sequence that this prompt configuration applies to.
    
    Parameters:
    
    promptType - The step in the agent sequence that this prompt configuration applies to.
    
    See Also:
    
    PromptType
  - getPromptType
```
public String getPromptType()
```
    The step in the agent sequence that this prompt configuration applies to.
    
    Returns:
    
    The step in the agent sequence that this prompt configuration applies to.
    
    See Also:
    
    PromptType
  - withPromptType
```
public PromptConfiguration withPromptType(String promptType)
```
    The step in the agent sequence that this prompt configuration applies to.
    
    Parameters:
    
    promptType - The step in the agent sequence that this prompt configuration applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PromptType
  - withPromptType
```
public PromptConfiguration withPromptType(PromptType promptType)
```
    The step in the agent sequence that this prompt configuration applies to.
    
    Parameters:
    
    promptType - The step in the agent sequence that this prompt configuration applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PromptType
  - 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 PromptConfiguration 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.773

Class PromptConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PromptConfiguration

Method Detail

setBasePromptTemplate

getBasePromptTemplate

withBasePromptTemplate

setInferenceConfiguration

getInferenceConfiguration

withInferenceConfiguration

setParserMode

getParserMode

withParserMode

withParserMode

setPromptCreationMode

getPromptCreationMode

withPromptCreationMode

withPromptCreationMode

setPromptState

getPromptState

withPromptState

withPromptState

setPromptType

getPromptType

withPromptType

withPromptType

toString

equals

hashCode

clone

marshall