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

Class DocumentCreateRequest

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentCreateRequest

public class DocumentCreateRequest
extends Object

A create request containing one or more new documents to create and store in a collection.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentCreateRequest

protected DocumentCreateRequest()

Default constructor for DocumentCreateRequest.

Method Details

documents

@Nonnull
public DocumentCreateRequest documents(@Nonnull
 List<BaseDocument> documents)

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

Parameters:

documents - The documents of this DocumentCreateRequest

Returns:

The same instance of this DocumentCreateRequest class

addDocumentsItem

@Nonnull
public DocumentCreateRequest addDocumentsItem(@Nonnull
 BaseDocument documentsItem)

Add one documents instance to this DocumentCreateRequest.

Parameters:

documentsItem - The documents that should be added

Returns:

The same instance of type DocumentCreateRequest

getDocuments

@Nonnull
public List<BaseDocument> getDocuments()

Get documents

Returns:

documents The documents of this DocumentCreateRequest instance.

setDocuments

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

Set the documents of this DocumentCreateRequest instance.

Parameters:

documents - The documents of this DocumentCreateRequest

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentCreateRequest.

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

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