Document Force

Document Force 連携に関するアクション一覧です。

DFAnalyzeDocument

概要

DFAnalyzeDocument は、Document Forceを使用してドキュメントを解析し、結果を取得する機能です。

パラメーター

*は、必須パラメーター

** は、条件付きの必須パラメーター

名前 型 概要 例
provider_id* 文字列 Document ForceのAPIキーで作成したプロバイダーIDを指定してください。 documentforce_a1b2c3d4e5f6
endpoint* 文字列 解析を実行するためのDocument Force APIエンドポイントURLを指定してください。 https://app.aipuncher.com/
api/v2/analyse/1a2b3c4d5e6f7g8h
file* 文字列 解析対象のファイルを指定してください。指定するファイルは、「ファイルを取得」などで、ロボット内にダウンロードされている必要があります。 sample-card.png
tags JSON プロジェクト別のタグ設定をJSON形式で指定します。タグピッカーを使用して指定することができます。 {"project1": ["tag1", "tag2"], "project2": ["tag3", "tag4"]}
wait_for_result 真偽値 trueの場合、解析完了まで待機して結果を取得します。falseの場合、解析を実行後にドキュメントIDのみを即座に返します。デフォルトはfalseです。 true

アウトプット

タイプ 型 概要 例
JSON JSON形式 解析結果またはドキュメントID ＊使用例を参照

使用例

解析結果を待機しない場合 (wait_for_result: false):

# ファイルを取得
+get_file_1:
  action>: GetFile
  display_name>: 'ファイルを取得'
  provider: local
  filename: rc_36b0011677688bf489d7
  private: false
  meta:
    display:
      filename:
        label: 'sample-card.png'
        icon: text
        type: chip
    action:
      disabled: false

# Document Forceでドキュメントを解析
+d_f_analyze_document_1:
  action>: DFAnalyzeDocument
  display_name>: 'Document Forceでドキュメントを解析'
  provider_id: documentforce_03f3151d6f9accddcffa
  endpoint: 'https://app.aipuncher.com/api/v2/analyse/****************'
  file: +get_file_1
  tags:
    AUTORO DevOps:
      - '開発テストタグ'
  wait_for_result: false
  private: false
  meta:
    display:
      provider_id:
        type: chip
        label: 'Documentforce (AUTORO連携用)'
        icon: documentforce
    action:
      disabled: false

# {
#   "document_id": 1027
# }

解析結果を待機する場合 (wait_for_result: true):

# ファイルを取得
+get_file_1:
  action>: GetFile
  display_name>: 'ファイルを取得'
  provider: local
  filename: rc_36b0011677688bf489d7
  private: false
  meta:
    display:
      filename:
        label: 'sample-card.png'
        icon: text
        type: chip
    action:
      disabled: false

# Document Forceでドキュメントを解析
+d_f_analyze_document_1:
  action>: DFAnalyzeDocument
  display_name>: 'Document Forceでドキュメントを解析'
  provider_id: documentforce_03f3151d6f9accddcffa
  endpoint: 'https://app.aipuncher.com/api/v2/analyse/****************'
  file: +get_file_1
  tags:
    AUTORO DevOps:
      - '開発テストタグ'
  wait_for_result: true
  private: false
  meta:
    display:
      provider_id:
        type: chip
        label: 'Documentforce (AUTORO連携用)'
        icon: documentforce
    action:
      disabled: false

# {
#   "document_id": 1026,
#   "status": "completed",
#   "analysis_result": {
#     "data": {
#       "status": "completed",
#       "message": "",
#       "id": 1026,
#       "name": "sample-card.png",
#       "body": "=== Page 1 ===\n\n株式会社...",
#       "analysis_results": [
#         {
#           "id": 18035,
#           "model_name": "apac.anthropic.claude-3-5-sonnet-20241022-v2:0",
#           "result": "名刺 太郎",
#           "raw_result": "<answer>名刺 太郎</answer>",
#           "used_tokens": 484,
#           "analysis_item": {
#             "name": "name",
#             "label": "氏名",
#             "order": 1,
#             "prompt": "このテキストは名刺情報です。文章中から名前のみを漢字で取得してください。",
#             "version": 1,
#             "analysis_model_type": "consultation"
#           }
#         },
#         {
#           "id": 18036,
#           ...
#         },
#         ...
#       ]
#     }
#   }
# }

results matching ""

    No results matching ""