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

Class BaseDocument

java.lang.Object

com.sap.ai.sdk.grounding.model.BaseDocument

public class BaseDocument
extends Object

Base class for documents, document requests and responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseDocument.Builder	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

BaseDocument

protected BaseDocument()

Default constructor for BaseDocument.

Method Details

chunks

@Nonnull
public BaseDocument chunks(@Nonnull
 List<TextOnlyBaseChunkCreate> chunks)

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

Parameters:

chunks - The chunks of this BaseDocument

Returns:

The same instance of this BaseDocument class

addChunksItem

@Nonnull
public BaseDocument addChunksItem(@Nonnull
 TextOnlyBaseChunkCreate chunksItem)

Add one chunks instance to this BaseDocument.

Parameters:

chunksItem - The chunks that should be added

Returns:

The same instance of type BaseDocument

getChunks

@Nonnull
public List<TextOnlyBaseChunkCreate> getChunks()

Get chunks

Returns:

chunks The chunks of this BaseDocument instance.

setChunks

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

Set the chunks of this BaseDocument instance.

Parameters:

chunks - The chunks of this BaseDocument

metadata

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

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

Parameters:

metadata - The metadata of this BaseDocument

Returns:

The same instance of this BaseDocument class

addMetadataItem

@Nonnull
public BaseDocument addMetadataItem(@Nonnull
 VectorDocumentKeyValueListPair metadataItem)

Add one metadata instance to this BaseDocument.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type BaseDocument

getMetadata

@Nonnull
public List<VectorDocumentKeyValueListPair> getMetadata()

Get metadata

Returns:

metadata The metadata of this BaseDocument instance.

setMetadata

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

Set the metadata of this BaseDocument instance.

Parameters:

metadata - The metadata of this BaseDocument

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the BaseDocument.

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

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