run を終える

書き込みが終わったら completed、途中で止めたら failed にする。終えた run には書き込めない。

PATCH/api/reviews/{reviewId}/ai-review-runs/{runId}

Authorization

AuthorizationBearer token · headerrequired

エージェント用トークン。文書とコメントを読み、run の中でコメントを書くのに使う。ブラウザのログインと一緒に送らない。

AuthorizationBearer token · headerrequired

本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。

Path parameters

reviewIdstringrequired

文書の ID。文書の URL /reviews/<reviewId> の末尾と同じ。

runIdstringrequired

run の ID。run を開始したときの応答の run.id。

Request body

requiredapplication/json

statusstringrequired

Allowed:completedfailed

baseCommentsRevisionintegerrequired

summarystring

終えたときのまとめ。

errorstring

failed の理由。

Responses

200

終えた。

reviewReview

文書とコメントの全体。ここに挙げた項目のほかにも、画面が使う項目が入る。

Show properties

reviewIdstring

titlestring

commentsRevisioninteger

コメントが書き換わるたびに 1 増える番号。書き込みで baseCommentsRevision として送る。

structureRevisioninteger

commentsComment[]

Show properties

Array of Comment

idstring

authorUser

書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。

Show properties

idstring

providerstring

displayNamestring

categorystring

コメントの種類。note はメモ、revise は書き換えの提案、add は追記、delete は削除の提案、needs_review は確認、consult は相談。none は分類の無い旧いデータで、画面ではメモとして出す。

Allowed:notereviseadddeleteneeds_reviewconsultnone

statusstring

open は未解決、closed は解決済み。

Allowed:openclosed

bodystring

anchorobject

画面でコメントを表示する位置。書き込むときは anchor でなく Locator を送る。

threadThreadMessage[]

Show properties

Array of ThreadMessage

idstring

authorUser

書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。

bodystring

createdTsstring<date-time>

statusEventsStatusEvent[]

Show properties

Array of StatusEvent

seqinteger

statusstring

Allowed:openclosed

byUser

書いた人。エージェント用トークンで書いたものは、トークンの持ち主の名義になる。

tsstring<date-time>

versionIdstring

コメントを付けた文書の版。

createdTsstring<date-time>

editedTsstring<date-time>

deletedTsstring<date-time>

削除されたコメントにだけ付く。画面には出ない。

aiReviewRunsRun[]

Show properties

Array of Run

idstring

kindstring

Allowed:ai_reviewvoice

statusstring

Allowed:runningcompletedfailedcancelled

titlestring

versionIdstring

commentIdsstring[]

summarystring

createdTsstring<date-time>

completedTsstring<date-time>

createdAtstring<date-time>

sourceobject

本文の出どころと版。

Show properties

versionsobject[]

版の一覧。古い順で、最後が最新の版。

Show properties

Array of object

versionIdstring

labelstring

createdAtinteger

版を作った時刻（UNIX 時間のミリ秒）。

sourceHashstring

_projectProjectLink

この文書に案件の結び付けがあるときだけ付く。

Show properties

codestringrequired

namestring | nullrequired

companystring | nullrequired

statusstringrequired

Allowed:activeinactive

inSnapshotbooleanrequired

rolestring | nullrequired

要求した本人の案件の役割。

Allowed:managereditorviewernull

runRun

Show properties

idstring

kindstring

Allowed:ai_reviewvoice

statusstring

Allowed:runningcompletedfailedcancelled

titlestring

versionIdstring

commentIdsstring[]

summarystring

createdTsstring<date-time>

completedTsstring<date-time>

401

トークンが無いか、この文書を読む権限が無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

403

このトークンでは使えない操作か、対象に対する権限が無い。使えるトークンは各操作の Authorization の欄を見る。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

404

文書・run・コメントのいずれかが無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

409

送った baseCommentsRevision が文書の今の値と違う。ほかの人やエージェントが先に書き込んだ。 GET /api/reviews/{reviewId} で commentsRevision を取り直してから送り直す。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

Request

curl -X PATCH 'https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/ai-review-runs/airun_example01' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "completed",
  "baseCommentsRevision": 5,
  "summary": "指摘 1 件"
}'

const response = await fetch("https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/ai-review-runs/airun_example01", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"status\": \"completed\",\n  \"baseCommentsRevision\": 5,\n  \"summary\": \"指摘 1 件\"\n}"
});

import requests

response = requests.patch(
    "https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01/ai-review-runs/airun_example01",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"status\": \"completed\",\n  \"baseCommentsRevision\": 5,\n  \"summary\": \"指摘 1 件\"\n}",
)

Response

{
  "review": {
    "reviewId": "string",
    "title": "string",
    "commentsRevision": 0,
    "structureRevision": 0,
    "comments": [
      {
        "id": "string",
        "author": {
          "id": "string",
          "provider": "string",
          "displayName": "string"
        },
        "category": "note",
        "status": "open",
        "body": "string",
        "anchor": {},
        "thread": [
          {
            "id": "string",
            "author": {
              "id": "string",
              "provider": "string",
              "displayName": "string"
            },
            "body": "string",
            "createdTs": "2019-08-24T14:15:22Z"
          }
        ],
        "statusEvents": [
          {
            "seq": 0,
            "status": "open",
            "by": {
              "id": "string",
              "provider": "string",
              "displayName": "string"
            },
            "ts": "2019-08-24T14:15:22Z"
          }
        ],
        "versionId": "string",
        "createdTs": "2019-08-24T14:15:22Z",
        "editedTs": "2019-08-24T14:15:22Z",
        "deletedTs": "2019-08-24T14:15:22Z"
      }
    ],
    "aiReviewRuns": [
      {
        "id": "string",
        "kind": "ai_review",
        "status": "running",
        "title": "string",
        "versionId": "string",
        "commentIds": [
          "string"
        ],
        "summary": "string",
        "createdTs": "2019-08-24T14:15:22Z",
        "completedTs": "2019-08-24T14:15:22Z"
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "source": {
      "versions": [
        {
          "versionId": "string",
          "label": "string",
          "createdAt": 0,
          "sourceHash": "string"
        }
      ]
    },
    "_project": {
      "code": "EX-AA",
      "name": "string",
      "company": "string",
      "status": "active",
      "inSnapshot": true,
      "role": "manager"
    }
  },
  "run": {
    "id": "string",
    "kind": "ai_review",
    "status": "running",
    "title": "string",
    "versionId": "string",
    "commentIds": [
      "string"
    ],
    "summary": "string",
    "createdTs": "2019-08-24T14:15:22Z",
    "completedTs": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "review not found",
  "status": 404
}

{
  "error": "comments revision conflict",
  "status": 409,
  "currentRevision": 7
}