Class EmailGenerativeAnswerChunkDataDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EmailGenerativeAnswerChunkDataDetails.Builder,
EmailGenerativeAnswerChunkDataDetails>
Details of streaming chunk data for email generative answers including completion text and references.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The partial or complete text content of the generative answer response.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 References property.final String
Token for retrieving the next chunk of streaming response data, if available.final List
<DataSummary> Source references and citations from knowledge base articles used to generate the answer.static Class
<? extends EmailGenerativeAnswerChunkDataDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
completion
The partial or complete text content of the generative answer response.
- Returns:
- The partial or complete text content of the generative answer response.
-
hasReferences
public final boolean hasReferences()For responses, this returns true if the service returned a value for the References 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. -
references
Source references and citations from knowledge base articles used to generate the answer.
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
hasReferences()
method.- Returns:
- Source references and citations from knowledge base articles used to generate the answer.
-
nextChunkToken
Token for retrieving the next chunk of streaming response data, if available.
- Returns:
- Token for retrieving the next chunk of streaming response data, if available.
-
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<EmailGenerativeAnswerChunkDataDetails.Builder,
EmailGenerativeAnswerChunkDataDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends EmailGenerativeAnswerChunkDataDetails.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.
-