コメントを書く
run の中でコメントを 1 件書く。位置は Locator で指定する。
同じ run で同じ dedupeKey を送り直すと、新しく作らずに前のコメントを返す(応答に deduped: true)。通信が切れたときは同じキーで送り直せばよい。
/api/reviews/{reviewId}/ai-review-runs/{runId}/commentsAuthorizationBearer token · headerrequiredエージェント用トークン。文書とコメントを読み、run の中でコメントを書くのに使う。ブラウザのログインと一緒に送らない。
AuthorizationBearer token · headerrequired本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。
reviewIdstringrequired文書の ID。文書の URL /reviews/<reviewId> の末尾と同じ。
runIdstringrequiredrun の ID。run を開始したときの応答の run.id。
application/jsonbodystringrequiredコメントの本文。
dedupeKeystringrequired二重に書かないためのキー。run の中で指摘ごとに変える。
locatorLocatorrequiredコメントを付ける位置。次の 6 通りのうち 1 つを送る。 引用がいちばん確実で、本文中の文字列をそのまま指定する(空白のゆれは 1 つにまとめて照合する)。
Show propertiesHide properties
quotestringrequired本文中の文字列。文書の中で 1 か所だけに当たる長さにする。
sectionIdstring探す範囲を見出しの区切りに絞る。区切りの ID は GET /dom-context で取る。
sectionIdstringrequiredelementIdstringrequiredHTML の要素の id 属性。
sectionIdstringrequiredxnumberrequired区切りの左端からの位置(%)。
ynumberrequired区切りの上端からの位置(%)。
sectionIdstringrequiredx1numberrequiredy1numberrequiredx2numberrequiredy2numberrequireddocumentbooleanrequiredsuggestionstring書き換え案。
categorystringnotereviseadddeleteneeds_reviewconsultnone書けた。送り直しで前のコメントを返したときは deduped: true が付く。
reviewReview文書とコメントの全体。ここに挙げた項目のほかにも、画面が使う項目が入る。
Show propertiesHide properties
reviewIdstringtitlestringcommentsRevisionintegerコメントが書き換わるたびに 1 増える番号。書き込みで baseCommentsRevision として送る。
structureRevisionintegercommentsComment[]Show propertiesHide properties
CommentidstringauthorUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
Show propertiesHide properties
idstringproviderstringdisplayNamestringcategorystringコメントの種類。note はメモ、revise は書き換えの提案、add は追記、delete は削除の提案、needs_review は確認、consult は相談。none は分類の無い旧いデータで、画面ではメモとして出す。
notereviseadddeleteneeds_reviewconsultnonestatusstringopen は未解決、closed は解決済み。
openclosedbodystringanchorobject画面でコメントを表示する位置。書き込むときは anchor でなく Locator を送る。
threadThreadMessage[]Show propertiesHide properties
ThreadMessageidstringauthorUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
bodystringcreatedTsstring<date-time>statusEventsStatusEvent[]Show propertiesHide properties
StatusEventseqintegerstatusstringopenclosedbyUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
tsstring<date-time>versionIdstringコメントを付けた文書の版。
createdTsstring<date-time>editedTsstring<date-time>deletedTsstring<date-time>削除されたコメントにだけ付く。画面には出ない。
aiReviewRunsRun[]Show propertiesHide properties
Runidstringkindstringai_reviewvoicestatusstringrunningcompletedfailedcancelledtitlestringversionIdstringcommentIdsstring[]summarystringcreatedTsstring<date-time>completedTsstring<date-time>createdAtstring<date-time>sourceobject本文の出どころと版。
Show propertiesHide properties
versionsobject[]版の一覧。古い順で、最後が最新の版。
Show propertiesHide properties
objectversionIdstringlabelstringcreatedAtinteger版を作った時刻(UNIX 時間のミリ秒)。
sourceHashstring_projectProjectLinkこの文書に案件の結び付けがあるときだけ付く。
Show propertiesHide properties
codestringrequirednamestring | nullrequiredcompanystring | nullrequiredstatusstringrequiredactiveinactiveinSnapshotbooleanrequiredrolestring | nullrequired要求した本人の案件の役割。
managereditorviewernullcommentCommentShow propertiesHide properties
idstringauthorUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
Show propertiesHide properties
idstringproviderstringdisplayNamestringcategorystringコメントの種類。note はメモ、revise は書き換えの提案、add は追記、delete は削除の提案、needs_review は確認、consult は相談。none は分類の無い旧いデータで、画面ではメモとして出す。
notereviseadddeleteneeds_reviewconsultnonestatusstringopen は未解決、closed は解決済み。
openclosedbodystringanchorobject画面でコメントを表示する位置。書き込むときは anchor でなく Locator を送る。
threadThreadMessage[]Show propertiesHide properties
ThreadMessageidstringauthorUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
Show propertiesHide properties
idstringproviderstringdisplayNamestringbodystringcreatedTsstring<date-time>statusEventsStatusEvent[]Show propertiesHide properties
StatusEventseqintegerstatusstringopenclosedbyUser書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。
Show propertiesHide properties
idstringproviderstringdisplayNamestringtsstring<date-time>versionIdstringコメントを付けた文書の版。
createdTsstring<date-time>editedTsstring<date-time>deletedTsstring<date-time>削除されたコメントにだけ付く。画面には出ない。
dedupedboolean送り直しで前のコメントを返したときだけ付く。
本文が空・長すぎる(body_too_long)、dedupeKey が無い、Locator の形が違う(locator_invalid)、送れない項目がある(field_not_allowed)。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
トークンが無いか、この文書を読む権限が無い。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
このトークンでは使えない操作か、対象に対する権限が無い。使えるトークンは各操作の Authorization の欄を見る。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
文書・run・コメントのいずれかが無い。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
ai review run is terminal: run がもう終わっている。新しい run を開始する。
source_changed・version_changed: run を開始した後に文書の本文か版が変わった。文書を読み直し、新しい run で書き直す。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
位置が決まらない。quote_not_found(引用が本文に無い)、quote_not_unique(引用が 2 か所以上に当たる。長くするか sectionId で絞る)、
section_not_found、element_not_found、coordinate_out_of_range。
run_limit_exceeded: run の上限(コメントと返信で 100 件、文書全体への指摘は 5 件)を超えた。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。
本文を一時的に読めない(source_unavailable)。少し待って送り直す。
errorstringrequiredエラーの種類を表す短いコード。対処を分けるときはこの値を見る。
statusintegerrequiredHTTP ステータスと同じ値。
currentRevisioninteger409 comments revision conflict のとき、文書の今の commentsRevision。
latestVersionIdstring409 stale_target_version のとき、文書の最新版の ID。