Package ai.vectros.resources.documents.requests

Interface IngestDocumentRequest._FinalStage

All Known Implementing Classes:

IngestDocumentRequest.Builder

Enclosing class:

IngestDocumentRequest

public static interface IngestDocumentRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
IngestDocumentRequest._FinalStage	additionalProperties(Map<String,Object> additionalProperties)
IngestDocumentRequest._FinalStage	additionalProperty(String key, Object value)
IngestDocumentRequest._FinalStage	allowClear(Boolean allowClear)
IngestDocumentRequest._FinalStage	allowClear(Optional<Boolean> allowClear)	Only relevant with ?
IngestDocumentRequest	build()
IngestDocumentRequest._FinalStage	upsert(Boolean upsert)
IngestDocumentRequest._FinalStage	upsert(Optional<Boolean> upsert)	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.

Method Details

build

IngestDocumentRequest build()

additionalProperty

IngestDocumentRequest._FinalStage additionalProperty(String key,
 Object value)

additionalProperties

IngestDocumentRequest._FinalStage additionalProperties(Map<String,Object> additionalProperties)

upsert

IngestDocumentRequest._FinalStage upsert(Optional<Boolean> upsert)

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.

upsert

IngestDocumentRequest._FinalStage upsert(Boolean upsert)

allowClear

IngestDocumentRequest._FinalStage allowClear(Optional<Boolean> allowClear)

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.

allowClear

IngestDocumentRequest._FinalStage allowClear(Boolean allowClear)