updateDocuments
Update metadata for documents in SourceSync.ai by specifying filter criteria to target specific content. Enables precise organization and management of document attributes within knowledge bases.
Instructions
Updates metadata for documents that match the specified filter criteria.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| documents | Yes | ||
| filterConfig | Yes | ||
| namespaceId | No | ||
| tenantId | No |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"data": {
"additionalProperties": false,
"properties": {
"$metadata": {
"additionalProperties": false,
"properties": {
"$append": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"$remove": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"$set": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"type": "object"
}
},
"type": "object"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"documents": {
"items": {
"additionalProperties": false,
"properties": {
"documentId": {
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"documentId"
],
"type": "object"
},
"type": "array"
},
"filterConfig": {
"additionalProperties": false,
"properties": {
"documentConnectionIds": {
"items": {
"type": "string"
},
"type": "array"
},
"documentExternalIds": {
"items": {
"type": "string"
},
"type": "array"
},
"documentIds": {
"items": {
"type": "string"
},
"type": "array"
},
"documentIngestionSources": {
"items": {
"enum": [
"TEXT",
"URLS_LIST",
"SITEMAP",
"WEBSITE",
"LOCAL_FILE",
"NOTION",
"GOOGLE_DRIVE",
"DROPBOX",
"ONEDRIVE",
"BOX",
"SHAREPOINT"
],
"type": "string"
},
"type": "array"
},
"documentIngestionStatuses": {
"items": {
"enum": [
"BACKLOG",
"QUEUED",
"QUEUED_FOR_RESYNC",
"PROCESSING",
"SUCCESS",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"type": "array"
},
"documentTypes": {
"items": {
"enum": [
"TEXT",
"URL",
"FILE",
"NOTION_DOCUMENT",
"GOOGLE_DRIVE_DOCUMENT",
"DROPBOX_DOCUMENT",
"ONEDRIVE_DOCUMENT",
"BOX_DOCUMENT",
"SHAREPOINT_DOCUMENT"
],
"type": "string"
},
"type": "array"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"namespaceId": {
"type": "string"
},
"tenantId": {
"type": "string"
}
},
"required": [
"documents",
"filterConfig",
"data"
],
"type": "object"
}