Dify Knowledge Base icon

Dify Knowledge Base

Manage Dify AI knowledge base datasets, documents, segments, and metadata with comprehensive CRUD operations

Actions30

Document → Get Status

AI-generated

Overview

The node "Dify Knowledge Base" enables managing AI knowledge base datasets, documents, segments, and metadata through various CRUD (Create, Read, Update, Delete) operations. Specifically, the Document - Get Status operation retrieves the current processing or indexing status of one or more documents within a specified dataset. This is useful for monitoring document ingestion progress or verifying if documents are ready for querying.

Practical examples:

  • After uploading multiple documents to a dataset, use this operation to check which documents have been successfully processed.
  • Monitor document statuses in batch to trigger downstream workflows only when all documents are indexed.

Properties

Name Meaning
Dataset ID The unique identifier of the dataset containing the documents whose status you want to get.
Document IDs A comma-separated list of document IDs for which to retrieve the status information.

Output

The output JSON contains the status details of the requested documents. Each item corresponds to a document and includes fields such as its current processing state, any errors encountered, and metadata related to indexing or availability.

If the node supports binary data output, it is not indicated here; thus, the output is purely JSON-based status information.

Dependencies

  • Requires an API key credential for authenticating with the Dify AI knowledge base service.
  • Needs the base URL of the Dify API configured in the node credentials.
  • Relies on the external Dify AI knowledge base API endpoints to fetch document status.

Troubleshooting

  • Common issues:

    • Invalid or missing Dataset ID or Document IDs will cause errors.
    • Network or authentication failures due to incorrect API key or base URL.
    • Requesting status for non-existent document IDs may return empty or error responses.

  • Error messages:

    • "The operation "getStatus" is not supported for resource "document": Indicates a misconfiguration or typo in the operation name.
    • Errors mentioning authorization failure suggest checking the API key and permissions.
    • If the node throws errors about unsupported resources or operations, verify that the Resource is set to "Document" and Operation to "Get Status".

Links and References

Discussion