DocuWare Aura は、DocuWare Cloud のユーザーインターフェイス以外でも使用できます。Aura API を使用すると、アプリケーションから DocuWare Aura に質問を送信し、その回答とソースドキュメントを独自のアプリケーション、ポータル、自動化プロセス、AI アシスタントで利用できます。
API の主な使い方は 2 つあります。
DocuWare Aura に質問への回答を生成させることができます。
または、関連するドキュメントの取得だけを Aura に任せ、推論は別のアプリケーションや AI エージェントに行わせることもできます。この 2 つ目の選択肢は、外部エージェントが扱う必要のある複数のシステムの 1 つが DocuWare である場合に役立ちます。
Aura API は、組織の DocuWare Cloud URL を通じて使用します。API リクエストは組織ごとに固有であり、組織の UUID (org_id) が必要です。すべてのエンドポイントは、認証に JWT ベアラートークンを使用します。トークンは DocuWare Identity Service (IDS) が発行します。Aura API はトークンを検証しますが、発行はしません。
API の完全な定義は、ご利用の DocuWare Cloud で確認できます。「YourCloudDomain」は実際の Cloud ドメインに置き換えてください。
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ Aura API でできること
API は、アプリケーションが別のユーザー体験や業務プロセスの一部として DocuWare のドキュメントを必要とする場合に役立ちます。
代表的な例は次のとおりです。
ERP、CRM、調達ポータルなどの業務アプリケーションに、ドキュメントへの質問機能を追加する
契約書や合意書などのドキュメントに関する質問に、ユーザーを DocuWare のインターフェイスに移動させずに回答する
外部エージェントに、権限で統制された DocuWare のドキュメント知識へのアクセスを与え、エージェントが他のシステムの情報と組み合わせられるようにする
SharePoint、CRM、ERP、各種サービスプラットフォームなどと並ぶ知識ソースの 1 つとして DocuWare を使用する
DocuWare は引き続きドキュメントのリポジトリです。API は、外部アプリケーションが利用できるインテリジェンスレイヤーを提供します。そのため、ドキュメントを別のシステムにコピーする必要はありません。ドキュメントへのアクセスは、これまでどおり認証されたコンテキストの権限に従います。
適切な API を選ぶ
最も重要な判断は、DocuWare Aura に回答を生成させるのか、関連するドキュメントの取得だけを行わせるのかです。
Aura query API
DocuWare Aura に質問を理解させ、関連するドキュメントを見つけて回答を生成させたい場合は、これを使用します。レスポンスには、回答に使用したソースドキュメントも含まれます。
Retrieval API
最終的な推論を別のアプリケーションや AI モデルに行わせる場合は、これを使用します。Retrieval API は、関連する、アクセスが許可されたドキュメントを見つけてソースを返します。
API に接続する
正確なエンドポイント、パラメーター、スキーマ、リクエスト例、コードスニペットを含む API の完全なドキュメントは、ご利用の DocuWare Cloud の Swagger ドキュメントで直接確認できます。
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ 主な API エンドポイント
Aura に質問する
会話型のクエリにはこのエンドポイントを使用します。ファイルキャビネットやドキュメントを任意で指定でき、session_id を使って会話を継続できます。
POST /api/v3/{org_id}/query 会話履歴を使わない単一クエリ
セッションを使用せずに、現在の質問に対する回答を返します。
POST /api/v2/{org_id}/single-query ストリーミングレスポンス
Server-Sent Events (SSE) を使って回答をストリーミングします。チャットインターフェイスに便利です。
POST /api/v3/{org_id}/query/stream ドキュメントの取得のみ
全文の回答を生成せずに、関連する DocuWare のドキュメントを取得します。
POST /api/v2/{org_id}/retrieval-query 正確なリクエストボディ、利用できるパラメーター、レスポンス形式、すぐに使えるコードスニペットについては、ご利用の DocuWare Cloud の Swagger ドキュメントを直接参照してください。
その他の API エンドポイント
Aura API には、構成、ドキュメント処理のステータス、会話、フィードバック、および関連する操作のためのエンドポイントも含まれています。
たとえば、会話のエンドポイントでは、ユーザーが保存した会話の一覧表示、メッセージ履歴を含む会話の取得、会話の名前変更やピン留め、会話の削除ができます。これらのエンドポイントは、独自のチャット体験をフルに構築する場合に役立ちますが、ほとんどの連携では上記のクエリまたは取得のエンドポイントだけで足ります。
エンドポイントの完全な一覧、リクエストスキーマ、レスポンススキーマ、例は、Swagger ドキュメントで確認できます。
AI エージェントを DocuWare に接続する
DocuWare は、外部の AI エージェント用のツールとして使用できます。エージェントは DocuWare のドキュメントを検索し、その結果を ERP や CRM など他のシステムの情報と組み合わせて利用できます。
使い始めるには
DocuWare Cloud で Swagger ドキュメントを開きます。
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/エージェントに API 定義を渡す
エージェントや AI プラットフォームが OpenAPI/Swagger のインポートに対応している場合は、Swagger 仕様をそのまま渡せます。プラットフォームはそこから利用可能な API ツールを作成できます。
認証を構成する
エージェントが API を呼び出すには、有効な DocuWare の JWT が必要です。
必要な API を選ぶ
Query API: ドキュメントについて Aura に質問します。
Retrieval API: 独自の AI モデルやエージェント用に関連ドキュメントを取得します。
必要に応じてエージェントに DocuWare を使わせる
たとえば、エージェントは ERP から請求書データを取得し、DocuWare で関連する契約書を検索したうえで、両者を比較してから回答できます
Swagger ドキュメントには、統合を構築するために必要な正確なエンドポイント、パラメーター、リクエスト/レスポンススキーマ、コードスニペットが記載されています。
まとめると、エージェントプラットフォームが OpenAPI に対応している場合は、DocuWare の Swagger/OpenAPI 定義を渡し、JWT 認証を構成して、必要な DocuWare のエンドポイントをツールとして公開します。