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

Class DocumentInput

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentInput

public class DocumentInput
extends Object

A single document stored in a collection by ID.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DocumentInput	addChunksItem(TextOnlyBaseChunkCreate chunksItem)	Add one chunks instance to this DocumentInput.
DocumentInput	addMetadataItem(VectorDocumentKeyValueListPair metadataItem)	Add one metadata instance to this DocumentInput.
DocumentInput	chunks(List<TextOnlyBaseChunkCreate> chunks)	Set the chunks of this DocumentInput instance and return the same instance.
static DocumentInput.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DocumentInput 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 DocumentInput.
UUID	getId()	Unique identifier of a document.
List<VectorDocumentKeyValueListPair>	getMetadata()	Get metadata
int	hashCode()
DocumentInput	id(UUID id)	Set the id of this DocumentInput instance and return the same instance.
DocumentInput	metadata(List<VectorDocumentKeyValueListPair> metadata)	Set the metadata of this DocumentInput instance and return the same instance.
void	setChunks(List<TextOnlyBaseChunkCreate> chunks)	Set the chunks of this DocumentInput instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DocumentInput instance.
void	setId(UUID id)	Set the id of this DocumentInput instance.
void	setMetadata(List<VectorDocumentKeyValueListPair> metadata)	Set the metadata of this DocumentInput instance.
Map<String,Object>	toMap()	Get the value of all properties of this DocumentInput instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentInput

protected DocumentInput()

Default constructor for DocumentInput.

Method Details

chunks

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

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

Parameters:

chunks - The chunks of this DocumentInput

Returns:

The same instance of this DocumentInput class

addChunksItem

@Nonnull
public DocumentInput addChunksItem(@Nonnull
 TextOnlyBaseChunkCreate chunksItem)

Add one chunks instance to this DocumentInput.

Parameters:

chunksItem - The chunks that should be added

Returns:

The same instance of type DocumentInput

getChunks

@Nonnull
public List<TextOnlyBaseChunkCreate> getChunks()

Get chunks

Returns:

chunks The chunks of this DocumentInput instance.

setChunks

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

Set the chunks of this DocumentInput instance.

Parameters:

chunks - The chunks of this DocumentInput

metadata

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

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

Parameters:

metadata - The metadata of this DocumentInput

Returns:

The same instance of this DocumentInput class

addMetadataItem

@Nonnull
public DocumentInput addMetadataItem(@Nonnull
 VectorDocumentKeyValueListPair metadataItem)

Add one metadata instance to this DocumentInput.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type DocumentInput

getMetadata

@Nonnull
public List<VectorDocumentKeyValueListPair> getMetadata()

Get metadata

Returns:

metadata The metadata of this DocumentInput instance.

setMetadata

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

Set the metadata of this DocumentInput instance.

Parameters:

metadata - The metadata of this DocumentInput

id

@Nonnull
public DocumentInput id(@Nonnull
 UUID id)

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

Parameters:

id - Unique identifier of a document.

Returns:

The same instance of this DocumentInput class

getId

@Nonnull
public UUID getId()

Unique identifier of a document.

Returns:

id The id of this DocumentInput instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this DocumentInput instance.

Parameters:

id - Unique identifier of a document.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentInput.

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

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