fetchDocuments
Retrieve documents from a specified namespace using filter criteria, pagination, and customizable property inclusion. Simplifies document access and organization within knowledge bases.
Instructions
Fetches documents from the namespace based on filter criteria. Supports pagination and including specific document properties.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentIds | No | ||
| filterConfig | Yes | ||
| includeConfig | No | ||
| namespaceId | No | ||
| pagination | No | ||
| tenantId | No |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"documentIds": {
"items": {
"type": "string"
},
"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"
},
"includeConfig": {
"additionalProperties": false,
"properties": {
"documents": {
"type": "boolean"
},
"parsedTextFileUrl": {
"type": "boolean"
},
"rawFileUrl": {
"type": "boolean"
},
"stats": {
"type": "boolean"
},
"statsBySource": {
"type": "boolean"
},
"statsByStatus": {
"type": "boolean"
}
},
"type": "object"
},
"namespaceId": {
"type": "string"
},
"pagination": {
"additionalProperties": false,
"properties": {
"cursor": {
"type": "string"
},
"pageSize": {
"type": "number"
}
},
"type": "object"
},
"tenantId": {
"type": "string"
}
},
"required": [
"filterConfig"
],
"type": "object"
}