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

Class DocumentWithoutChunks

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentWithoutChunks

public class DocumentWithoutChunks
extends Object

A single document stored in a collection by ID without exposing its chunks.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentWithoutChunks

protected DocumentWithoutChunks()

Default constructor for DocumentWithoutChunks.

Method Details

metadata

@Nonnull
public DocumentWithoutChunks metadata(@Nonnull
 List<VectorDocumentKeyValueListPair> metadata)

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

Parameters:

metadata - The metadata of this DocumentWithoutChunks

Returns:

The same instance of this DocumentWithoutChunks class

addMetadataItem

@Nonnull
public DocumentWithoutChunks addMetadataItem(@Nonnull
 VectorDocumentKeyValueListPair metadataItem)

Add one metadata instance to this DocumentWithoutChunks.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type DocumentWithoutChunks

getMetadata

@Nonnull
public List<VectorDocumentKeyValueListPair> getMetadata()

Get metadata

Returns:

metadata The metadata of this DocumentWithoutChunks instance.

setMetadata

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

Set the metadata of this DocumentWithoutChunks instance.

Parameters:

metadata - The metadata of this DocumentWithoutChunks

id

@Nonnull
public DocumentWithoutChunks id(@Nonnull
 UUID id)

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

Parameters:

id - Unique identifier of a document.

Returns:

The same instance of this DocumentWithoutChunks class

getId

@Nonnull
public UUID getId()

Unique identifier of a document.

Returns:

id The id of this DocumentWithoutChunks instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this DocumentWithoutChunks instance.

Parameters:

id - Unique identifier of a document.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentWithoutChunks.

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

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