Delete a retrieval document - Veryfront

deleteRetrievalDocument(projectReference: ID!, retrievalDocumentId: ID!, input: DeleteRetrievalDocumentInput): Deletion!

Requires project.knowledge.write; API keys also need delete scope.

Arguments

Argument	Type	Required	Description
`projectReference`	`ID!`	Yes	Project UUID or slug.
`retrievalDocumentId`	`ID!`	Yes
`input`	`DeleteRetrievalDocumentInput`	No

Input fields

input

DeleteRetrievalDocumentInput

Field	Type	Required	Description
`expectedRevision`	`String`	No	Delete only this observed revision. A changed record is a conflict; a missing record is not_found. Delete the record before removing its chunks, as ragStore().removeDocument() does, so a concurrent refresh cannot publish through a still-visible record.

Response

Returns Deletion!. Open the type for its fields and nested types.

Field	Type	Description
`ok`	`Boolean!`	Always true: the record was deleted.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation DeleteRetrievalDocument($projectReference: ID!, $retrievalDocumentId: ID!, $input: DeleteRetrievalDocumentInput) {
  deleteRetrievalDocument(projectReference: $projectReference, retrievalDocumentId: $retrievalDocumentId, input: $input) {
    ok
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "retrievalDocumentId": "00000000-0000-4000-8000-000000000001"
}