レビュー指摘をLightning Reviewに自動登録
概要
Wordの設計文書を対象に、ワークフローを用いてレビュー観点に沿ったレビューを行うサンプルです。
レビュー対象の設計文書とレビュー観点を読み込み、レビュー観点 × 章の単位で繰り返しエージェントを実行します。
抽出したレビュー指摘はLightning Reviewに出力します。
本サンプルでは、以下をワークフローとして順に実行します。
- レビュー対象の取得
- レビュー観点の取得
- レビューの繰り返し実行
- Lightning Review出力
これにより、ツール連携とAIエージェントを組み合わせながら、Word文書に対してレビュー観点ごとにレビューを進める流れを確認できます。
このサンプルでできること
- Lightning Reviewと連携し、抽出した指摘をLightning Reviewに登録する
- レビュー観点一覧ファイルを読み込み、レビュー観点を利用してレビューを実施する
- Word形式の設計書を章単位で分解してレビューを実施する
- 章 × レビュー観点の組み合わせで網羅的に繰り返しレビューを実行する
想定ユーザ
このサンプルは、主に以下のような方を想定しています。
- Lightning ReviewとAIの連携を検討している
- AIを活用して設計書レビューを効率化・標準化したい
- ワークフローを用いた繰り返し実行を体験したい
同梱内容
このサンプルには、例として以下のようなデータが含まれています。
ヒント
そのまま実行して動作を確認した後、入出力ファイルを自業務の成果物に置き換えることで、
実際の業務に近い形で試すことができます。
置き換える場合は「自業務に置き換える場合の手順」の内容で対象を変えて「作業手順」を実施してください。
| 種別 | 内容 | 自業務に置き換える場合の手順 |
|---|---|---|
| 入力：レビュー観点ファイル | inputData/reviewPointList.json | 1. inputDataフォルダに自業務のレビュー観点ファイルを Json形式で格納する。 2.「作業手順」の手順4でパスを指定する。 |
| 入力：Word設計書 | inputData/APPレイヤコンポーネント設計書.docx | 1. inputDataフォルダに自業務の設計 書を Word形式で格納する。 2.「作業手順」の手順4でパスを指定する。 |
| ドキュメント | 本README | 変更不可 |
サンプルデータの利用
前提条件
- レビュー観点のデータ構造が本サンプルの入力と同じであること
- レビュー指摘を出力するLightning Reviewファイルが開かれていること。
入出力
- 入力：レビュー観点一覧ファイル、Word形式の設計書
- 出力：全レビュー指摘の一覧ファイル（Lightning Review形式）
作業手順
- レビュー結果出力用のLightning Reviewファイルを開きます。
- DC Agentiqsのワークフロー画面で「章と観点ごとにWord設計書をレビューしてLRに指摘を出力」をクリックします。
- 「章と観点ごとにWord設計書をレビューしてLRに指摘を出力」の画面で、「実行」をクリックします。
- ダイアログが表示されるため、「レビュー観点一覧ファイルパス」と「Word設計書ファイルパス」を入力し、「実行」をクリックします。
- Lightning Reviewファイルに指摘が出力されます。
動作対象
- ワークフロー：章と観点ごとにWord設計書をレビューしてLRに指摘を出力
- エージェント：Word設計書レビュー_LR指摘JSON生成
制約事項
- 本サンプルは章単位でエージェントに入力してレビューするため、1つの章のボリュームが大きいと精度が下がる可能性があります。
その場合、節の単位などエージェントに入力する範囲をカスタマイズしてください。 - レビュー観点はワークフローおよびエージェントが想定する形式で利用できる必要があります。
構造や内容が異なる場合は、ワークフローの変更が必要になります。
参考：ワークフロー実行の流れ
本サンプルでは、ワークフローを用いて処理を段階的に分解し、
ツールとAIエージェントを組み合わせて一連のレビュー処理を実行する構成を確認できます。
- レビュー観点一覧ファイルを読み込み、観点ごとにループできる構造に成形する。
- Word形式の設計書を読み込み、章単位でループできる構造に成形する。
- 各章、各レビュー観点の単位で順番にレビューエージェントへ入力し、レビュー指摘を抽出する
- 各章、各レビュー観点の単位でレビュー指摘をLightning Reviewに登録する。