ApiAgent reviews

Gets how one of the agent's conversations has been reviewed, or why it has not been yet.

Name the conversation as for `:review`: by a run in it (`executionRecordId`) or by its topic (`topicId`, whose most recent conversation is meant). `unit` is its review — `REVIEWED` with what it found in `findings` and the cards those went to in `recommendations`, `PENDING` while the background review has it queued, or passed over: `SKIPPED_SAMPLE` when nothing flagged it and the sample of unflagged conversations did not draw it, `SKIPPED_BUDGET` when the daily review budget ran out before it was reached. `unit` is null when nothing has taken the conversation in: it is still going (`closed` false — it counts as over four quiet hours after its latest run, `closesAt`), it is outside the background review (`inBackgroundScope` false), or the background review has not reached it yet. A `lastRunAt` later than `unit.lastRunAt` means the conversation went on after it was reviewed, which the background review does not read again. Reads only. Agent admins only.

Authorization

Bearer

AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

agent*string

The agent ID.

tenant*string

The tenant identifier

Query Parameters

ExecutionRecordId?string

A run in the conversation — its conversation is reviewed; a run with no session is reviewed alone.

Formatuuid

TopicId?string

A topic — its most recent conversation is reviewed.

Formatuuid

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/agents/string/conversationReview"

{
  "unit": {
    "id": "00000000-0000-0000-0000-000000000000",
    "kind": "CONVERSATION",
    "status": "PENDING",
    "sessionId": "string",
    "topicId": "00000000-0000-0000-0000-000000000000",
    "runIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "firstRunAt": 0,
    "lastRunAt": 0,
    "revision": 0,
    "summary": "string",
    "findingsCount": 0,
    "reviewedAt": 0,
    "requestedBy": "string"
  },
  "findings": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "unitId": "00000000-0000-0000-0000-000000000000",
      "category": "MISSING_CAPABILITY",
      "severity": "LOW",
      "title": "string",
      "need": "string",
      "whatHappened": "string",
      "turns": [
        0
      ],
      "disposition": "MERGED",
      "dispositionDetail": "string",
      "recommendationId": "00000000-0000-0000-0000-000000000000",
      "knowledgeBaseId": "00000000-0000-0000-0000-000000000000",
      "knowledgeDocumentId": "00000000-0000-0000-0000-000000000000",
      "question": "string",
      "createdAt": 0
    }
  ],
  "recommendations": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "ADD_TOOLS",
      "category": "MISSING_CAPABILITY",
      "severity": "LOW",
      "status": "CANDIDATE",
      "title": "string",
      "summary": "string",
      "need": "string",
      "patch": {
        "tools": [],
        "instructionText": "string",
        "replaceAnchor": "string",
        "adviceMarkdown": "string",
        "feature": "string"
      },
      "evidenceCount": 0,
      "firstSeenAt": 0,
      "lastSeenAt": 0,
      "baseRevision": 0,
      "changedSince": 0,
      "changedAt": 0,
      "appliedRevision": 0,
      "previousRevision": 0,
      "appliedBy": "string",
      "appliedAt": 0,
      "dismissedBy": "string",
      "dismissedAt": 0,
      "dismissReason": "NOT_RELEVANT",
      "dismissNote": "string",
      "obsoleteReason": "string",
      "comparison": {
        "id": null,
        "patchRevision": null,
        "cardRunId": null,
        "otherRunId": null,
        "regressionRunId": null,
        "cardTurns": null,
        "otherTurns": null,
        "regressionTurns": null,
        "sandboxRouting": null,
        "baseRevision": 0,
        "startedAt": 0,
        "startedBy": "string",
        "recheck": null
      },
      "patchRevision": 0,
      "revisions": [],
      "version": 0
    }
  ],
  "lastRunAt": 0,
  "closesAt": 0,
  "closed": false,
  "inBackgroundScope": false
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Empty

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}