Implement VLM Run Invoice Parser node with file upload and parsing logic #1442

whereisfarukk · 2025-09-24T18:20:13Z

Feat: Add VLM Run Invoice Parser Node

Description:
Implemented a new VLM Run Invoice Parser node for sim.ai, following the assignment requirements. The node performs a two-step process:

Uploads an invoice file (PDF or image) to the VLM Run File Upload API.
Extracts structured JSON data using the Document Parsing API with hardcoded settings (domain: document.invoice", model: "vlm-1).

Screenshots/Videos

vercel · 2025-09-24T18:20:20Z

@whereisfarukk is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

greptile-apps

Greptile Overview

Summary

This PR adds a new VLM Run Invoice Parser node to sim.ai that enables users to upload invoice files (PDF or images) and extract structured JSON data using the VLM Run API. The implementation includes a two-step process: file upload and document parsing with hardcoded settings (domain: "document.invoice", model: "vlm-1").

Key Changes:

New Tool Implementation: parseInvoiceTool with support for both local file paths and URLs
Block Configuration: UI block for invoice parser with API key and file path inputs
Type Definitions: Proper TypeScript interfaces for VLM Run parameters and responses
Integration: Added to tools and blocks registries with a simple house icon

Issues Found:

Unused request configuration in tool definition that conflicts with direct API usage
Debug console.log statements should be replaced with proper logging
Redundant data/output fields in response object
Generic icon doesn't represent invoice parsing functionality

The core functionality works as intended but could benefit from some code cleanup and better error handling patterns.

Confidence Score: 4/5

This PR is safe to merge with minor code quality improvements needed
Score reflects functional implementation that follows established patterns, but contains some code quality issues like unused configuration, debug logging, and redundant fields. No critical security or logic errors were found.
The main implementation file apps/sim/tools/vlmrun/parse_invoice.ts needs attention for code cleanup

Important Files Changed

File Analysis

Filename	Score	Overview
apps/sim/tools/vlmrun/parse_invoice.ts	3/5	Implements VLM Run invoice parsing with file upload and URL support; has some code quality issues
apps/sim/tools/vlmrun/types.ts	4/5	Defines TypeScript types for VLM Run tool configuration; well-structured
apps/sim/blocks/blocks/vlmrun.ts	4/5	Block configuration for VLM Run Invoice Parser UI; follows established patterns
apps/sim/blocks/registry.ts	5/5	Added VLM Run block to registry; clean integration with existing codebase
apps/sim/tools/index.ts	5/5	Added VLM Run tool to tools registry; proper integration

Sequence Diagram

sequenceDiagram
    participant User
    participant UI as VLM Run Block UI
    participant Tool as parseInvoiceTool
    participant Client as VlmRun Client
    participant API as VLM Run API

    User->>UI: Enter API Key & File Path
    UI->>Tool: execute(params: {apiKey, filePath})
    Tool->>Tool: Check if filePath is URL
    
    alt File Path is URL
        Tool->>Client: document.generate({url, model: 'vlm-1', domain: 'document.invoice'})
        Client->>API: Generate document from URL
        API-->>Client: Parse result with structured data
        Client-->>Tool: Response with invoice JSON
    else File Path is Local File
        Tool->>Client: files.upload({filePath})
        Client->>API: Upload file
        API-->>Client: File ID
        Client-->>Tool: Upload response with fileId
        Tool->>Client: document.generate({fileId, model: 'vlm-1', domain: 'document.invoice'})
        Client->>API: Generate document from file
        API-->>Client: Parse result with structured data  
        Client-->>Tool: Response with invoice JSON
    end
    
    Tool->>Tool: Check response status
    alt Status is 'completed'
        Tool-->>UI: {success: true, data: parsed_invoice_data}
        UI-->>User: Display structured invoice data
    else Status is not 'completed'
        Tool-->>UI: {success: false, error: "Parsing failed"}
        UI-->>User: Display error message
    end

_{11 files reviewed, 5 comments}

_{Edit Code Review Bot Settings | Greptile}

greptile-apps · 2025-09-24T18:24:26Z

apps/sim/tools/vlmrun/parse_invoice.ts

+  const client = new VlmRun({ apiKey: params.apiKey })
+  console.log(`[DEBUG] Starting execution with filePath/URL: ${params.filePath}`)
+
+  let fileId: string | undefined
+  let parseResponse: any
+


style: Variable fileId is declared with type string | undefined but only used in the file upload path. Consider declaring it closer to where it's used to improve code clarity.

greptile-apps · 2025-09-24T18:24:26Z

apps/sim/tools/vlmrun/parse_invoice.ts

+  console.log(`[DEBUG] Starting execution with filePath/URL: ${params.filePath}`)
+
+  let fileId: string | undefined
+  let parseResponse: any
+
+  const isUrl = params.filePath.startsWith('http://') || params.filePath.startsWith('https://')
+  console.log(`[DEBUG] Detected as URL: ${isUrl}`)


style: Multiple console.log statements used for debugging. Consider using a proper logging library or removing debug statements for production.

greptile-apps · 2025-09-24T18:24:27Z

apps/sim/tools/vlmrun/parse_invoice.ts

+  request: {
+  url: () => 'https://api.vlmrun.com/files/upload',
+  method: 'POST' as const, 
+  headers: (params: VlmRunParams) => ({  
+    'Authorization': `Bearer ${params.apiKey}`,
+    'Content-Type': 'multipart/form-data',
+  }),
+  body: (params: VlmRunParams) => ({     
+    filePath: params.filePath,
+  }),
+},


logic: The request field defines an upload URL and headers but isn't actually used by the tool. The actual API calls are made directly in the execute function. Either remove this unused configuration or refactor to use the framework's request handling.

greptile-apps · 2025-09-24T18:24:28Z

apps/sim/tools/vlmrun/parse_invoice.ts

+    return {
+      success: true,
+      data: parseResponse.response,
+      output: parseResponse.response,
+      error: undefined,
+    }


style: The response object has both data and output fields with the same value. This redundancy might be confusing - consider using only one field consistently.

greptile-apps · 2025-09-24T18:24:29Z

apps/sim/components/icons.tsx

+export const VlmRunIcon = () => (
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" className="w-6 h-6">
+    <path d="M12 2L2 12h3v8h14v-8h3L12 2z" />
+  </svg>
+)


style: The VlmRunIcon uses a generic house icon. Consider creating a more specific icon that represents invoice parsing or the VLM Run brand.

Mirajul-Mohin · 2025-09-24T18:55:15Z

apps/sim/blocks/registry.ts

+import { WebhookBlock } from "@/blocks/blocks/webhook";
+import { WhatsAppBlock } from "@/blocks/blocks/whatsapp";
+import { WikipediaBlock } from "@/blocks/blocks/wikipedia";
+import { WorkflowBlock } from "@/blocks/blocks/workflow";


We may need to remove these formatting related changes

Mirajul-Mohin · 2025-09-24T18:55:56Z

apps/sim/blocks/registry.ts

+};

-export const getBlock = (type: string): BlockConfig | undefined => registry[type]
+export const getBlock = (type: string): BlockConfig | undefined =>


Formatting changes. remove?

Yeah no formatting changes needed

Mirajul-Mohin · 2025-09-24T18:57:03Z

apps/sim/.env.example

Why remove this?

do not remove env.example

icecrasher321 · 2025-09-26T17:21:44Z

apps/sim/tools/vlmrun/parse_invoice.ts

+    console.log(`[DEBUG] API response: ${JSON.stringify(parseResponse)}`)
+
+    if (parseResponse.status !== 'completed') {
+      console.error(`[ERROR] Parsing failed: status ${parseResponse.status}`)


can't have console.error --> use our logger instead

icecrasher321 · 2025-09-26T17:22:01Z

apps/sim/tools/vlmrun/types.ts

+  version: string
+  provider?: string
+  params: Record<string, ToolParamConfig>
+  request: {  // 👈 MUST EXIST


remove comment

icecrasher321 · 2025-09-26T17:22:34Z

apps/sim/package.json

  },
  "scripts": {
-    "dev": "next dev --turbo --port 3000",
+    "dev": "next dev --port 3000",


please don't disable turbo for dev builds

Implement VLM Run Invoice Parser node with file upload and parsing logic

2030c92

greptile-apps bot reviewed Sep 24, 2025

View reviewed changes

Mirajul-Mohin reviewed Sep 24, 2025

View reviewed changes

icecrasher321 reviewed Sep 26, 2025

View reviewed changes

whereisfarukk added 2 commits September 27, 2025 00:16

v-2

15cd4d3

feat:created a vlm run invoice perser

9d680fa

Implement VLM Run Invoice Parser node with file upload and parsing logic #1442

Are you sure you want to change the base?

Implement VLM Run Invoice Parser node with file upload and parsing logic #1442

Uh oh!

Conversation

whereisfarukk commented Sep 24, 2025

Feat: Add VLM Run Invoice Parser Node

Screenshots/Videos

Uh oh!

vercel bot commented Sep 24, 2025

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Greptile Overview

Summary

Key Changes:

Issues Found:

Confidence Score: 4/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps bot Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Mirajul-Mohin Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Mirajul-Mohin Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

icecrasher321 Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Mirajul-Mohin Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

icecrasher321 Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

icecrasher321 Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

icecrasher321 Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

icecrasher321 Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

icecrasher321 Sep 26, 2025 •

edited

Loading