Package com.sap.ai.sdk.grounding.model
Class DocumentOutput
java.lang.Object
com.sap.ai.sdk.grounding.model.DocumentOutput
DocumentOutput
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddChunksItem(VectorChunk chunksItem) Add one chunks instance to thisDocumentOutput.addMetadataItem(VectorDocumentKeyValueListPair metadataItem) Add one metadata instance to thisDocumentOutput.chunks(List<VectorChunk> chunks) Set the chunks of thisDocumentOutputinstance and return the same instance.static DocumentOutput.Buildercreate()Create a type-safe, fluent-api builder object to construct a newDocumentOutputinstance with all required arguments.booleanGet chunksgetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theDocumentOutput.getId()Get idGet metadatainthashCode()Set the id of thisDocumentOutputinstance and return the same instance.metadata(List<VectorDocumentKeyValueListPair> metadata) Set the metadata of thisDocumentOutputinstance and return the same instance.voidsetChunks(List<VectorChunk> chunks) Set the chunks of thisDocumentOutputinstance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisDocumentOutputinstance.voidSet the id of thisDocumentOutputinstance.voidsetMetadata(List<VectorDocumentKeyValueListPair> metadata) Set the metadata of thisDocumentOutputinstance.toMap()Get the value of all properties of thisDocumentOutputinstance including unrecognized properties.toString()
-
Constructor Details
-
DocumentOutput
protected DocumentOutput()Default constructor for DocumentOutput.
-
-
Method Details
-
id
Set the id of thisDocumentOutputinstance and return the same instance.- Parameters:
id- The id of thisDocumentOutput- Returns:
- The same instance of this
DocumentOutputclass
-
getId
Get id- Returns:
- id The id of this
DocumentOutputinstance.
-
setId
Set the id of thisDocumentOutputinstance.- Parameters:
id- The id of thisDocumentOutput
-
metadata
Set the metadata of thisDocumentOutputinstance and return the same instance.- Parameters:
metadata- The metadata of thisDocumentOutput- Returns:
- The same instance of this
DocumentOutputclass
-
addMetadataItem
@Nonnull public DocumentOutput addMetadataItem(@Nonnull VectorDocumentKeyValueListPair metadataItem) Add one metadata instance to thisDocumentOutput.- Parameters:
metadataItem- The metadata that should be added- Returns:
- The same instance of type
DocumentOutput
-
getMetadata
Get metadata- Returns:
- metadata The metadata of this
DocumentOutputinstance.
-
setMetadata
Set the metadata of thisDocumentOutputinstance.- Parameters:
metadata- The metadata of thisDocumentOutput
-
chunks
Set the chunks of thisDocumentOutputinstance and return the same instance.- Parameters:
chunks- The chunks of thisDocumentOutput- Returns:
- The same instance of this
DocumentOutputclass
-
addChunksItem
Add one chunks instance to thisDocumentOutput.- Parameters:
chunksItem- The chunks that should be added- Returns:
- The same instance of type
DocumentOutput
-
getChunks
Get chunks- Returns:
- chunks The chunks of this
DocumentOutputinstance.
-
setChunks
Set the chunks of thisDocumentOutputinstance.- Parameters:
chunks- The chunks of thisDocumentOutput
-
getCustomFieldNames
Get the names of the unrecognizable properties of theDocumentOutput.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisDocumentOutputinstance.- Parameters:
name- The name of the property- Returns:
- The value of the property
- Throws:
NoSuchElementException- If no property with the given name could be found.
-
toMap
Get the value of all properties of thisDocumentOutputinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisDocumentOutputinstance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.- Parameters:
customFieldName- The name of the propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
create
Create a type-safe, fluent-api builder object to construct a newDocumentOutputinstance with all required arguments.
-
toMap()instead.