Skip to main content

​
機能

画像ファイルから新しいDocumentをバッチに追加します。 画像なしでDocumentを作成するには、file パラメーターを空のままにします (file.Name = "", file.Bytes = new bytes [0]) 。 新しいDocumentは、excludeFromAutomaticAssembling フラグが true に設定された状態で作成されます。このフラグは、そのDocumentがすでにアセンブリ済みであり、バッチタイプに指定されたアセンブリ設定がそのDocumentには適用されないことを示します。
新しく追加したDocumentにアクセスできるようになるのは、その画像の前処理が完了した後です。新しいDocumentを追加した後にバッチ処理を開始するには、ProcessBatch メソッドを使用します。
新しいDocumentをバッチに追加する場合、対応するオブジェクトの Id フィールドは空であってはなりません。
PDF Documentを追加し、そのテキストレイヤーに保存されているテキストをプログラムで使用したい場合は、それらのDocumentの処理に使用される Project で、OCR の代わりに PDF テキストレイヤーを使用 オプションが選択されていることを確認してください (このオプションは 処理 タブの ページのプロパティ ダイアログにあります) 。

​
定義

​
パラメーター

sessionId

int

Application Server への接続 ID

document

Document

作成するDocumentの説明

file

File

Document画像を含むファイル

excludeFromAutomaticAssembling

bool

DocumentをDocumentアセンブリの対象から除外するかどうかを示すフラグです。

  • True - Documentはすでにアセンブリ済みであり、Documentアセンブリには含まれません。
  • False - Documentは、バッチタイプに指定された設定に従ってアセンブリされます。

previousItemId

int

セット内での新しいDocumentの位置を明示的に指定する ID です。

  • -1 - 新しいDocumentはセットの末尾に追加されます
  • 0 - 新しいDocumentはセットの先頭に追加されます
  • Document ID - 新しいDocumentはこの ID を持つDocumentの後に追加されます
    注: この ID を持つDocumentが存在している必要があります。
POST リクエストを使用してDocument画像を追加することもできます。この場合は、このメソッドで空のファイルを持つDocumentを作成します (file.Name = “FileName”, file.Bytes = new bytes [0])。その後、次のパラメーターを指定して POST リクエストを実行します。
  • Action = Save
  • objectType = 0
  • objectId = documentId (documentId は AddNewDocument メソッドによって返される document ID)
  • version = 0
  • streamName = “C:\Temp\image.pdf” (image.pdf は、AddNewDocument メソッドの呼び出し時に指定したファイル名です)

​
戻り値