Package software.amazon.awssdk.services.qconnect.model

Class GenerativeDataDetails

java.lang.Object

software.amazon.awssdk.services.qconnect.model.GenerativeDataDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GenerativeDataDetails.Builder,GenerativeDataDetails>

@Generated("software.amazon.awssdk:codegen")
public final class GenerativeDataDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GenerativeDataDetails.Builder,GenerativeDataDetails>

Details about generative data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerativeDataDetails.Builder

Method Summary

Modifier and Type	Method	Description
static GenerativeDataDetails.Builder	builder()
String	completion()	The LLM response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReferences()	For responses, this returns true if the service returned a value for the References property.
RankingData	rankingData()	Details about the generative content ranking data.
List<DataSummary>	references()	The references used to generative the LLM response.
List<SdkField<?>>	sdkFields()
static Class<? extends GenerativeDataDetails.Builder>	serializableBuilderClass()
GenerativeDataDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

completion

public final String completion()

The LLM response.

Returns:

The LLM response.

rankingData

public final RankingData rankingData()

Details about the generative content ranking data.

Returns:

Details about the generative content ranking data.

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 the isEmpty() 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

public final List<DataSummary> references()

The references used to generative the LLM response.

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:

The references used to generative the LLM response.

toBuilder

public GenerativeDataDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerativeDataDetails.Builder,GenerativeDataDetails>

builder

public static GenerativeDataDetails.Builder builder()

serializableBuilderClass

public static Class<? extends GenerativeDataDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo