API and SDK Reference
Register to deepset CloudLog in to deepset Cloud

DocumentWriter Parameters

Set the document store and the policy to handle documents with the same IDs.

YAML Init Parameters

These are the parameters you can pass to this component in the pipeline YAML configuration:

ParameterTypePossible valuesDescription
document_storeDocumentStoreThe DocumentStore where where you want to write the documents.
Required.
policyDuplicatePolicyDuplicatePolicy.SKIP
DuplicatePolicy.OVERWRITE
DuplicatePolicy.FAIL
DuplicatePolicy.NONE
Default: DuplicatePolicy.NONE		The policy to apply when a document with the same ID already exists in the DocumentStore. Possible values:
DuplicatePolicy.NONE - uses the document store's policy,
DuplicatePolicy.SKIP - keeps the document that already exists in the document store
DuplicatePolicy.OVERWRITE - overwrite the document that alraedy exists in the document store with the one being written into the document store,
DuplicatePolicy.FAIL - fails to write the document to the document store and raises an error.
Required.

REST API Runtime Parameters

There are no runtime parameters you can pass to this component when making a request to the Search REST API endpoint.