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

Class DocumentResponse

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentResponse

public class DocumentResponse
extends Object

A response containing information about a newly created, single document.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentResponse

protected DocumentResponse()

Default constructor for DocumentResponse.

Method Details

chunks

@Nonnull
public DocumentResponse chunks(@Nonnull
 List<TextOnlyBaseChunk> chunks)

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

Parameters:

chunks - The chunks of this DocumentResponse

Returns:

The same instance of this DocumentResponse class

addChunksItem

@Nonnull
public DocumentResponse addChunksItem(@Nonnull
 TextOnlyBaseChunk chunksItem)

Add one chunks instance to this DocumentResponse.

Parameters:

chunksItem - The chunks that should be added

Returns:

The same instance of type DocumentResponse

getChunks

@Nonnull
public List<TextOnlyBaseChunk> getChunks()

Get chunks

Returns:

chunks The chunks of this DocumentResponse instance.

setChunks

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

Set the chunks of this DocumentResponse instance.

Parameters:

chunks - The chunks of this DocumentResponse

metadata

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

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

Parameters:

metadata - The metadata of this DocumentResponse

Returns:

The same instance of this DocumentResponse class

addMetadataItem

@Nonnull
public DocumentResponse addMetadataItem(@Nonnull
 VectorDocumentKeyValueListPair metadataItem)

Add one metadata instance to this DocumentResponse.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type DocumentResponse

getMetadata

@Nonnull
public List<VectorDocumentKeyValueListPair> getMetadata()

Get metadata

Returns:

metadata The metadata of this DocumentResponse instance.

setMetadata

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

Set the metadata of this DocumentResponse instance.

Parameters:

metadata - The metadata of this DocumentResponse

id

@Nonnull
public DocumentResponse id(@Nonnull
 UUID id)

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

Parameters:

id - Unique identifier of a document.

Returns:

The same instance of this DocumentResponse class

getId

@Nonnull
public UUID getId()

Unique identifier of a document.

Returns:

id The id of this DocumentResponse instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this DocumentResponse instance.

Parameters:

id - Unique identifier of a document.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentResponse.

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 DocumentResponse 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 DocumentResponse 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 DocumentResponse 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 DocumentResponse.Builder create()

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