documind下載 - documind源代碼下載

documind

其他源碼

v1.0.9

下載

Documind

Documind是一種高級文檔處理工具，利用AI從PDF中提取結構化數據。它旨在處理PDF轉換，提取相關信息以及由可自定義模式指定的格式結果。

該倉庫建在Zerox -https：//github.com/getomni-ai/zerox上。 Zerox的MIT許可證包含在Core文件夾中，並且在根許可證文件中也提到了。

特徵

將PDF轉換為圖像以進行詳細的AI處理。
使用OpenAI的API提取和構建信息。
允許用戶為各種文檔格式指定提取模式。
專為在本地或云環境上的靈活部署而設計。

嘗試託管版本

Documind託管版本的演示很快將供您嘗試！託管版本提供了完全管理的API的無縫體驗，因此您可以跳過設置並立即提取數據。

要完全訪問託管服務，請請求訪問權限，我們將為您設置。

要求

在使用documind之前，請確保安裝以下軟件依賴關係：

系統依賴性

Ghostscript ： documind依靠Ghostscript來處理某些PDF操作。
GraphicsMagick ：文檔轉換中圖像處理所必需的。

在繼續之前，請在系統上安裝這兩個：

 # On macOS
brew install ghostscript graphicsmagick

# On Debian/Ubuntu
sudo apt-get update
sudo apt-get install -y ghostscript graphicsmagick

node.js＆npm

確保系統上安裝了Node.js（V18+）和NPM。

安裝

您可以通過NPM安裝documind ：

npm install documind

環境設置

documind需要一個.env文件來存儲像OpenAI API密鑰一樣的敏感信息。

在您的項目目錄中創建.env文件，並添加以下內容：

OPENAI_API_KEY=your_openai_api_key

用法

基本示例

首先，導入documind並定義您的架構。模式概述了每個文檔中應尋找的信息documind 。這是一個快速開始的設置。

1。定義模式

模式是每個對象定義的對像數組：

名稱：要提取的字段名稱。
類型：數據類型（例如， "string" ， "number" ， "array" ， "object" ）。
描述：字段描述。
兒童（可選）：對於數組和對象，定義嵌套字段。

銀行對帳單的示例模式：

 const schema = [
  {
    name : "accountNumber" ,
    type : "string" ,
    description : "The account number of the bank statement."
  } ,
  {
    name : "openingBalance" ,
    type : "number" ,
    description : "The opening balance of the account."
  } ,
  {
    name : "transactions" ,
    type : "array" ,
    description : "List of transactions in the account." ,
    children : [
      {
        name : "date" ,
        type : "string" ,
        description : "Transaction date."
      } ,
      {
        name : "creditAmount" ,
        type : "number" ,
        description : "Credit Amount of the transaction."
      } ,
      {
        name : "debitAmount" ,
        type : "number" ,
        description : "Debit Amount of the transaction."
      } ,
      {
        name : "description" ,
        type : "string" ,
        description : "Transaction description."
      }
    ]
  } ,
  {
    name : "closingBalance" ,
    type : "number" ,
    description : "The closing balance of the account."
  }
] ;

2。運行`documind`

使用documind通過傳遞文件URL和架構來處理PDF。

 import { extract } from 'documind' ;

const runExtraction = async ( ) => {
  const result = await extract ( {
    file : 'https://bank_statement.pdf' ,
    schema
  } ) ;

  console . log ( "Extracted Data:" , result ) ;
} ;

runExtraction ( ) ;

示例輸出

這是提取結果的外觀的示例：

 {
  "success" : true ,
  "pages" : 1 ,
  "data" : {
    "accountNumber" : " 100002345 " ,
    "openingBalance" : 3200 ,
    "transactions" : [
        {
        "date" : " 2021-05-12 " ,
        "creditAmount" : null ,
        "debitAmount" : 100 ,
        "description" : " transfer to Tom " 
      },
      {
        "date" : " 2021-05-12 " ,
        "creditAmount" : 50 ,
        "debitAmount" : null ,
        "description" : " For lunch the other day "
      },
      {
        "date" : " 2021-05-13 " ,
        "creditAmount" : 20 ,
        "debitAmount" : null ,
        "description" : " Refund for voucher "
      },
      {
        "date" : " 2021-05-13 " ,
        "creditAmount" : null ,
        "debitAmount" : 750 ,
        "description" : " May's rent "
      }
    ],
    "closingBalance" : 2420
  },
  "fileName" : " bank_statement.pdf "
}

模板

Documind帶有內置模板，用於從發票，銀行語句等流行文檔類型中提取數據。這些模板使得在不定義自己的模式的情況下開始更容易入門。

列表可用模板

您可以使用templates.list函數列出所有可用模板。

 import { templates } from 'documind' ;

const templates = templates . list ( ) ;
console . log ( templates ) ; // Logs all available template names

使用模板

要使用模板，只需將其名稱與要從中提取數據提取的文件一起傳遞給extract功能。這是一個例子：

 import { extract } from 'documind' ;

const runExtraction = async ( ) => {
  const result = await extract ( {
    file : 'https://bank_statement.pdf' ,
    template : 'bank_statement'
  } ) ;

  console . log ( "Extracted Data:" , result ) ;
} ;

runExtraction ( ) ;