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

Class DataRepositoryWithDocuments

java.lang.Object

com.sap.ai.sdk.grounding.model.DataRepositoryWithDocuments

public class DataRepositoryWithDocuments
extends Object

DataRepository schema returned by the Vector search endpoint

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DataRepositoryWithDocuments	addDocumentsItem(Document documentsItem)	Add one documents instance to this DataRepositoryWithDocuments.
DataRepositoryWithDocuments	addMetadataItem(RetrievalKeyValueListPair metadataItem)	Add one metadata instance to this DataRepositoryWithDocuments.
static DataRepositoryWithDocuments.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DataRepositoryWithDocuments instance with all required arguments.
DataRepositoryWithDocuments	documents(List<Document> documents)	Set the documents of this DataRepositoryWithDocuments instance and return the same instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the DataRepositoryWithDocuments.
List<Document>	getDocuments()	Get documents
UUID	getId()	Unique identifier of this DataRepository.
String	getMessage()	Optional message.
List<RetrievalKeyValueListPair>	getMetadata()	Metadata attached to DataRepository.
String	getRemoteGroundingName()	Friendly destination Name (grounding.name) of remote instance.
String	getTitle()	Get title
int	hashCode()
DataRepositoryWithDocuments	id(UUID id)	Set the id of this DataRepositoryWithDocuments instance and return the same instance.
DataRepositoryWithDocuments	message(String message)	Set the message of this DataRepositoryWithDocuments instance and return the same instance.
DataRepositoryWithDocuments	metadata(List<RetrievalKeyValueListPair> metadata)	Set the metadata of this DataRepositoryWithDocuments instance and return the same instance.
DataRepositoryWithDocuments	remoteGroundingName(String remoteGroundingName)	Set the remoteGroundingName of this DataRepositoryWithDocuments instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DataRepositoryWithDocuments instance.
void	setDocuments(List<Document> documents)	Set the documents of this DataRepositoryWithDocuments instance.
void	setId(UUID id)	Set the id of this DataRepositoryWithDocuments instance.
void	setMessage(String message)	Set the message of this DataRepositoryWithDocuments instance.
void	setMetadata(List<RetrievalKeyValueListPair> metadata)	Set the metadata of this DataRepositoryWithDocuments instance.
void	setRemoteGroundingName(String remoteGroundingName)	Set the remoteGroundingName of this DataRepositoryWithDocuments instance.
void	setTitle(String title)	Set the title of this DataRepositoryWithDocuments instance.
DataRepositoryWithDocuments	title(String title)	Set the title of this DataRepositoryWithDocuments instance and return the same instance.
Map<String,Object>	toMap()	Get the value of all properties of this DataRepositoryWithDocuments instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DataRepositoryWithDocuments

protected DataRepositoryWithDocuments()

Default constructor for DataRepositoryWithDocuments.

Method Details

id

@Nonnull
public DataRepositoryWithDocuments id(@Nonnull
 UUID id)

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

Parameters:

id - Unique identifier of this DataRepository.

Returns:

The same instance of this DataRepositoryWithDocuments class

getId

@Nonnull
public UUID getId()

Unique identifier of this DataRepository.

Returns:

id The id of this DataRepositoryWithDocuments instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this DataRepositoryWithDocuments instance.

Parameters:

id - Unique identifier of this DataRepository.

title

@Nonnull
public DataRepositoryWithDocuments title(@Nonnull
 String title)

Set the title of this DataRepositoryWithDocuments instance and return the same instance.

Parameters:

title - The title of this DataRepositoryWithDocuments

Returns:

The same instance of this DataRepositoryWithDocuments class

getTitle

@Nonnull
public String getTitle()

Get title

Returns:

title The title of this DataRepositoryWithDocuments instance.

setTitle

public void setTitle(@Nonnull
 String title)

Set the title of this DataRepositoryWithDocuments instance.

Parameters:

title - The title of this DataRepositoryWithDocuments

metadata

@Nonnull
public DataRepositoryWithDocuments metadata(@Nullable
 List<RetrievalKeyValueListPair> metadata)

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

Parameters:

metadata - Metadata attached to DataRepository. Useful to later limit search to a subset of DataRepositories.

Returns:

The same instance of this DataRepositoryWithDocuments class

addMetadataItem

@Nonnull
public DataRepositoryWithDocuments addMetadataItem(@Nonnull
 RetrievalKeyValueListPair metadataItem)

Add one metadata instance to this DataRepositoryWithDocuments.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type DataRepositoryWithDocuments

getMetadata

@Nonnull
public List<RetrievalKeyValueListPair> getMetadata()

Metadata attached to DataRepository. Useful to later limit search to a subset of DataRepositories.

Returns:

metadata The metadata of this DataRepositoryWithDocuments instance.

setMetadata

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

Set the metadata of this DataRepositoryWithDocuments instance.

Parameters:

metadata - Metadata attached to DataRepository. Useful to later limit search to a subset of DataRepositories.

remoteGroundingName

@Nonnull
public DataRepositoryWithDocuments remoteGroundingName(@Nullable
 String remoteGroundingName)

Set the remoteGroundingName of this DataRepositoryWithDocuments instance and return the same instance.

Parameters:

remoteGroundingName - Friendly destination Name (grounding.name) of remote instance.

Returns:

The same instance of this DataRepositoryWithDocuments class

getRemoteGroundingName

@Nullable
public String getRemoteGroundingName()

Friendly destination Name (grounding.name) of remote instance.

Returns:

remoteGroundingName The remoteGroundingName of this DataRepositoryWithDocuments instance.

setRemoteGroundingName

public void setRemoteGroundingName(@Nullable
 String remoteGroundingName)

Set the remoteGroundingName of this DataRepositoryWithDocuments instance.

Parameters:

remoteGroundingName - Friendly destination Name (grounding.name) of remote instance.

message

@Nonnull
public DataRepositoryWithDocuments message(@Nullable
 String message)

Set the message of this DataRepositoryWithDocuments instance and return the same instance.

Parameters:

message - Optional message.

Returns:

The same instance of this DataRepositoryWithDocuments class

getMessage

@Nullable
public String getMessage()

Optional message.

Returns:

message The message of this DataRepositoryWithDocuments instance.

setMessage

public void setMessage(@Nullable
 String message)

Set the message of this DataRepositoryWithDocuments instance.

Parameters:

message - Optional message.

documents

@Nonnull
public DataRepositoryWithDocuments documents(@Nonnull
 List<Document> documents)

Set the documents of this DataRepositoryWithDocuments instance and return the same instance.

Parameters:

documents - The documents of this DataRepositoryWithDocuments

Returns:

The same instance of this DataRepositoryWithDocuments class

addDocumentsItem

@Nonnull
public DataRepositoryWithDocuments addDocumentsItem(@Nonnull
 Document documentsItem)

Add one documents instance to this DataRepositoryWithDocuments.

Parameters:

documentsItem - The documents that should be added

Returns:

The same instance of type DataRepositoryWithDocuments

getDocuments

@Nonnull
public List<Document> getDocuments()

Get documents

Returns:

documents The documents of this DataRepositoryWithDocuments instance.

setDocuments

public void setDocuments(@Nonnull
 List<Document> documents)

Set the documents of this DataRepositoryWithDocuments instance.

Parameters:

documents - The documents of this DataRepositoryWithDocuments

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DataRepositoryWithDocuments.

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

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