VLM Run icon

VLM Run

Interact with VLM Run API

Analyze Document

AI-generated

Overview

This node interacts with the VLM Run API to analyze documents by extracting structured data from various document types such as resumes, invoices, and presentations. It uploads the document file from the previous node, optionally processes the request asynchronously, and supports specifying a domain for analysis. This node is useful for automating document processing workflows, such as extracting key information from uploaded files for further processing or integration.

Use Case Examples

  1. Extract structured data from an invoice PDF uploaded from a previous node.
  2. Analyze a resume document to extract candidate information automatically.
  3. Process presentation files to extract text and metadata for indexing or summarization.

Properties

Name Meaning
File File data from the previous node to be analyzed as a document.
Domain Name or ID Domain to use for analysis, selectable from a list or specified by ID via expression.
Process Asynchronously Whether to process the document analysis request asynchronously.
Callback URL URL to call when processing is complete, required if processing asynchronously is enabled.

Output

JSON

  • fileId - Identifier of the uploaded file used for analysis.
  • model - Model version used for document analysis.
  • domain - Domain specified for the analysis.
  • batch - Indicates if the processing was asynchronous (batch mode).
  • callbackUrl - Callback URL provided for asynchronous processing.
  • analysisResult - The structured data result returned from the document analysis API.

Dependencies

  • VLM Run API service for file upload and document analysis

Troubleshooting

  • Ensure the file input is correctly passed from the previous node and is accessible.
  • If asynchronous processing is enabled, the callback URL must be valid and reachable to receive the completion notification.
  • Domain selection must be valid; loading domains may fail if API credentials are incorrect or network issues occur.
  • Errors related to file upload or analysis request failures will be thrown with descriptive messages; verify API credentials and network connectivity.

Discussion