Class ChatPromptTemplateConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ChatPromptTemplateConfiguration.Builder,
ChatPromptTemplateConfiguration>
Contains configurations to use a prompt in a conversational format. For more information, see Create a prompt using Prompt management.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputVariables property.final boolean
For responses, this returns true if the service returned a value for the Messages property.final boolean
For responses, this returns true if the service returned a value for the System property.final List
<PromptInputVariable> An array of the variables in the prompt template.messages()
Contains messages in the chat for the prompt.static Class
<? extends ChatPromptTemplateConfiguration.Builder> final List
<SystemContentBlock> system()
Contains system prompts to provide context to the model or to describe how it should behave.Take this object and create a builder that contains all of the current property values of this object.final ToolConfiguration
Configuration information for the tools that the model can use when generating a response.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasInputVariables
public final boolean hasInputVariables()For responses, this returns true if the service returned a value for the InputVariables 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. -
inputVariables
An array of the variables in the prompt template.
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
hasInputVariables()
method.- Returns:
- An array of the variables in the prompt template.
-
hasMessages
public final boolean hasMessages()For responses, this returns true if the service returned a value for the Messages 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. -
messages
Contains messages in the chat for the prompt.
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
hasMessages()
method.- Returns:
- Contains messages in the chat for the prompt.
-
hasSystem
public final boolean hasSystem()For responses, this returns true if the service returned a value for the System 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. -
system
Contains system prompts to provide context to the model or to describe how it should behave.
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
hasSystem()
method.- Returns:
- Contains system prompts to provide context to the model or to describe how it should behave.
-
toolConfiguration
Configuration information for the tools that the model can use when generating a response.
- Returns:
- Configuration information for the tools that the model can use when generating a response.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ChatPromptTemplateConfiguration.Builder,
ChatPromptTemplateConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-