メインコンテンツへスキップ

Python SDK

docflow-sdk Python SDK を使って、Docflow の文書ワークフロー管理機能をすばやく組み込めます。
docflow-sdk は TextIn Docflow の公式 Python SDK です。ワークスペース管理、文書分類、スマートレビュー、型安全なレスポンスモデル、包括的なエラーハンドリングを提供します。

インストール

システム要件: Python >= 3.8

認証と初期化

SDK は複数の認証方法に対応しています。優先順位は、コンストラクタ引数 > 環境変数 > .env ファイルです。
認証情報をコードに直接書かないよう、環境変数での設定を推奨します。

API 概要

リソース説明主なメソッド
client.workspaceワークスペース管理create(), list(), get(), update(), delete(), iter()
client.category文書カテゴリ管理create(), list(), get(), update(), delete(), iter()
client.category.fieldsカテゴリフィールド管理batch_add(), list(), batch_update(), delete()
client.category.tablesカテゴリテーブル管理batch_add(), list(), batch_update(), delete()
client.category.samplesカテゴリサンプル管理batch_upload(), list(), download(), delete()
client.fileファイル管理と認識upload(), fetch(), download(), delete()
client.reviewスマートレビュー規則管理create_repo(), create_group(), create_rule(), submit_task()

ワークスペース管理

ワークスペースは Docflow の最上位の管理単位です。業務シナリオごとに文書処理フローを分離して管理できます。

ワークスペースを作成

ワークスペース一覧を取得

メソッドチェーン(推奨)

コンテキストをバインドすることで、同じパラメータの繰り返し指定を減らし、コードを簡潔にできます。

文書カテゴリ管理

カテゴリは、文書の構造化フィールドと抽出ルールを定義します。

カテゴリを作成(サンプルファイル付き)

フィールド管理

テーブル管理

サンプル管理

ファイル処理

ファイルをアップロードして認識

認識結果を取得

スマートレビュー

Docflow は LLM ベースのスマートレビュー機能を提供します。単一文書の規則検証と、複数文書をまたいだクロスチェックに対応しています。

レビュー規則リポジトリを作成

複数文書のクロスレビュー

レビュータスクを送信

レビュー結果を取得

列挙型

SDK は完全な列挙型定義を提供しており、パラメータ指定ミスを防げます。

自動ページングイテレータ

イテレータを使うと、手動でループを組まずにページングを自動処理できます。

エラーハンドリング

SDK は細かなエラー分類を提供しており、例外の種類に応じて正確に処理できます。

エラー種別

エラークラス説明
DocflowException基底エラークラス。すべての SDK エラーを捕捉
ValidationErrorパラメータ検証エラー
AuthenticationError認証エラー(app-id または secret-code の誤り)
PermissionDeniedError権限不足
ResourceNotFoundErrorリソースが存在しない
APIErrorAPI 呼び出しエラー(HTTP 4xx/5xx)
NetworkErrorネットワーク接続エラー

エラーハンドリング例

国際化(i18n)

SDK は多言語のエラーメッセージに対応しています。

高度な設定

タイムアウトとリトライ

カスタムリトライ設定

カスタム API アドレス

リソース管理

コンテキストマネージャを使うと、接続を自動でクローズできます。

デバッグログ

DEBUG レベルのログを有効にすると、リクエストの詳細を確認できます。

完全なサンプル

完全な利用例は examples ディレクトリ を参照してください。
  • クイックスタート: quick_start.py - 経費精算シナリオのエンドツーエンドフロー
  • 完全なワークフロー: complete_workflow_example.py - 請求書処理の完全なワークフロー
  • ファイル処理: file_examples.py - ファイルアップロード、認識、ダウンロードの例
  • レビュー規則: review_examples.py - レビュー規則設定の例

よくある質問

問題解決方法
AuthenticationErrorDOCFLOW_APP_IDDOCFLOW_SECRET_CODE が正しいか確認してください
ResourceNotFoundErrorワークスペース ID / カテゴリ ID が存在し、アクセス権限があるか確認してください
ValidationErrorパラメータ形式と値の範囲を確認してください(例: ワークスペース名は最大 50 文字)
認識結果が空カテゴリ設定(フィールド、テーブル、サンプルファイル)が正しいか確認し、認識完了後に結果を取得してください
レビュータスクが失敗する規則設定(referenced_fieldsfield_id が正しいこと)と extract_task_ids の有効性を確認してください

関連リンク