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

Class DocumentsListResponse

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentsListResponse

public class DocumentsListResponse
extends Object

A response containing documents retrieved from the server.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DocumentsListResponse	addDocumentsItem(DocumentWithoutChunks documentsItem)	Add one documents instance to this DocumentsListResponse.
static DocumentsListResponse.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DocumentsListResponse instance with all required arguments.
DocumentsListResponse	documents(List<DocumentWithoutChunks> documents)	Set the documents of this DocumentsListResponse 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 DocumentsListResponse.
List<DocumentWithoutChunks>	getDocuments()	Get documents
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DocumentsListResponse instance.
void	setDocuments(List<DocumentWithoutChunks> documents)	Set the documents of this DocumentsListResponse instance.
Map<String,Object>	toMap()	Get the value of all properties of this DocumentsListResponse instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentsListResponse

protected DocumentsListResponse()

Default constructor for DocumentsListResponse.

Method Details

documents

@Nonnull
public DocumentsListResponse documents(@Nonnull
 List<DocumentWithoutChunks> documents)

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

Parameters:

documents - The documents of this DocumentsListResponse

Returns:

The same instance of this DocumentsListResponse class

addDocumentsItem

@Nonnull
public DocumentsListResponse addDocumentsItem(@Nonnull
 DocumentWithoutChunks documentsItem)

Add one documents instance to this DocumentsListResponse.

Parameters:

documentsItem - The documents that should be added

Returns:

The same instance of type DocumentsListResponse

getDocuments

@Nonnull
public List<DocumentWithoutChunks> getDocuments()

Get documents

Returns:

documents The documents of this DocumentsListResponse instance.

setDocuments

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

Set the documents of this DocumentsListResponse instance.

Parameters:

documents - The documents of this DocumentsListResponse

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentsListResponse.

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

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