Package com.sap.ai.sdk.grounding.model

Class DocumentOutput

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentOutput

public class DocumentOutput
extends Object

DocumentOutput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentOutput.Builder	Builder helper class.
static interface	DocumentOutput.Builder1	Builder helper class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocumentOutput()	Default constructor for DocumentOutput.

Method Summary

Modifier and Type	Method	Description
DocumentOutput	addChunksItem(VectorChunk chunksItem)	Add one chunks instance to this DocumentOutput.
DocumentOutput	addMetadataItem(VectorDocumentKeyValueListPair metadataItem)	Add one metadata instance to this DocumentOutput.
DocumentOutput	chunks(List<VectorChunk> chunks)	Set the chunks of this DocumentOutput instance and return the same instance.
static DocumentOutput.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DocumentOutput instance with all required arguments.
boolean	equals(Object o)
List<VectorChunk>	getChunks()	Get chunks
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the DocumentOutput.
UUID	getId()	Get id
List<VectorDocumentKeyValueListPair>	getMetadata()	Get metadata
int	hashCode()
DocumentOutput	id(UUID id)	Set the id of this DocumentOutput instance and return the same instance.
DocumentOutput	metadata(List<VectorDocumentKeyValueListPair> metadata)	Set the metadata of this DocumentOutput instance and return the same instance.
void	setChunks(List<VectorChunk> chunks)	Set the chunks of this DocumentOutput instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DocumentOutput instance.
void	setId(UUID id)	Set the id of this DocumentOutput instance.
void	setMetadata(List<VectorDocumentKeyValueListPair> metadata)	Set the metadata of this DocumentOutput instance.
Map<String,Object>	toMap()	Get the value of all properties of this DocumentOutput instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentOutput

protected DocumentOutput()

Default constructor for DocumentOutput.

Method Details

id

@Nonnull
public DocumentOutput id(@Nonnull
 UUID id)

Set the id of this DocumentOutput instance and return the same instance.

Parameters:

id - The id of this DocumentOutput

Returns:

The same instance of this DocumentOutput class

getId

@Nonnull
public UUID getId()

Get id

Returns:

id The id of this DocumentOutput instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this DocumentOutput instance.

Parameters:

id - The id of this DocumentOutput

metadata

@Nonnull
public DocumentOutput metadata(@Nullable
 List<VectorDocumentKeyValueListPair> metadata)

Set the metadata of this DocumentOutput instance and return the same instance.

Parameters:

metadata - The metadata of this DocumentOutput

Returns:

The same instance of this DocumentOutput class

addMetadataItem

@Nonnull
public DocumentOutput addMetadataItem(@Nonnull
 VectorDocumentKeyValueListPair metadataItem)

Add one metadata instance to this DocumentOutput.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type DocumentOutput

getMetadata

@Nonnull
public List<VectorDocumentKeyValueListPair> getMetadata()

Get metadata

Returns:

metadata The metadata of this DocumentOutput instance.

setMetadata

public void setMetadata(@Nullable
 List<VectorDocumentKeyValueListPair> metadata)

Set the metadata of this DocumentOutput instance.

Parameters:

metadata - The metadata of this DocumentOutput

chunks

@Nonnull
public DocumentOutput chunks(@Nonnull
 List<VectorChunk> chunks)

Set the chunks of this DocumentOutput instance and return the same instance.

Parameters:

chunks - The chunks of this DocumentOutput

Returns:

The same instance of this DocumentOutput class

addChunksItem

@Nonnull
public DocumentOutput addChunksItem(@Nonnull
 VectorChunk chunksItem)

Add one chunks instance to this DocumentOutput.

Parameters:

chunksItem - The chunks that should be added

Returns:

The same instance of type DocumentOutput

getChunks

@Nonnull
public List<VectorChunk> getChunks()

Get chunks

Returns:

chunks The chunks of this DocumentOutput instance.

setChunks

public void setChunks(@Nonnull
 List<VectorChunk> chunks)

Set the chunks of this DocumentOutput instance.

Parameters:

chunks - The chunks of this DocumentOutput

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentOutput.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this DocumentOutput instance.

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

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this DocumentOutput instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this DocumentOutput instance. 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 property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static DocumentOutput.Builder create()

Create a type-safe, fluent-api builder object to construct a new DocumentOutput instance with all required arguments.