Package ai.vectros.resources.documents.requests

Class IngestDocumentRequest

java.lang.Object

ai.vectros.resources.documents.requests.IngestDocumentRequest

public final class IngestDocumentRequest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IngestDocumentRequest._FinalStage
static interface	IngestDocumentRequest.BodyStage
static final class	IngestDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static IngestDocumentRequest.BodyStage	builder()
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
Optional<Boolean>	getAllowClear()
DocumentRequest	getBody()
Optional<Boolean>	getUpsert()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getUpsert

public Optional<Boolean> getUpsert()

Returns:

When true, if a document with the same externalId already exists its content is overwritten (the submitted payload, title, and — when supplied — text are applied and the version is bumped) instead of being returned unchanged; the immutable externalId, schemaId, indexMode, and ownership are never changed. Defaults to false. Requires the documents:u scope in addition to documents:c.

getAllowClear

public Optional<Boolean> getAllowClear()

Returns:

Only relevant with ?upsert=true, which overwrites an existing document as a full replacement. If the submitted request omits (or sends as null) a stored field that a list or lookup response returns only as an indexed projection (a large document whose payload is stored externally), the overwrite is rejected unless you set allowClear=true to confirm that clearing those fields is intended. Use PATCH to update without clearing omitted fields. Defaults to false.

getBody

public DocumentRequest getBody()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static IngestDocumentRequest.BodyStage builder()