Update a retrieval document - Veryfront

updateRetrievalDocument(projectReference: ID!, retrievalDocumentId: ID!, input: UpdateRetrievalDocumentInput!): RetrievalDocument!

Requires project.knowledge.write.

Arguments

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

Input fields

input

UpdateRetrievalDocumentInput

Field	Type	Required	Description
`expectedRevision`	`String!`	Yes	The revision you read. A changed record is a conflict; a missing record is not_found. Title, source, type and metadata are replaced, and the response includes the new revision.
`title`	`String!`	Yes
`source`	`String`	No	Defaults to an empty string.
`type`	`String`	No	Defaults to an empty string.
`metadata`	`JSONObject`	No

Response

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

Field	Type	Description
`id`	`ID!`
`revision`	`String!`	Opaque revision: 64 lowercase hexadecimal characters. Send it as expectedRevision.
`title`	`String!`
`source`	`String!`
`type`	`String!`
`metadata`	`JSONObject!`
`createdAt`	`DateTime!`
`updatedAt`	`DateTime!`

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

Example

mutation UpdateRetrievalDocument($projectReference: ID!, $retrievalDocumentId: ID!, $input: UpdateRetrievalDocumentInput!) {
  updateRetrievalDocument(projectReference: $projectReference, retrievalDocumentId: $retrievalDocumentId, input: $input) {
    id
    createdAt
    updatedAt
    metadata
    revision
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "retrievalDocumentId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "expectedRevision": "example",
    "title": "example"
  }
}