FruxonDocs
ApiAgent reviews

Lists what reviews of the agent found.

Newest first. Filter by `disposition` to see where findings went — `SENT_TO_KNOWLEDGE_BASE` lists the drafts reviews wrote to the agent's knowledge bases and the articles they held for review, with the base and document to open; `COMPLIANCE` the rules the agent's prompt already has and it broke, each with the rule; and `INTERNAL` the findings that made no card, such as a connected service failing. A failure of Fruxon's own is reported to Fruxon and not listed. Agent admins only.

GET
/v1/tenants/{tenant}/agents/{agent}/reviewFindings
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

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque pagination token returned by an external service. Pass it back unchanged rather than interpreting it as an offset.

disposition?string

Only findings that went this way.

Value in"UNSPECIFIED" | "MERGED" | "SENT_TO_KNOWLEDGE_BASE" | "KNOWLEDGE_SOURCE_WILL_EXTRACT" | "INTERNAL" | "REJECTED_INVALID" | "COMPLIANCE" | "REFUTED" | "UNVERIFIED"

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/agents/string/reviewFindings"
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "unitId": "00000000-0000-0000-0000-000000000000",
      "category": "MISSING_CAPABILITY",
      "cause": "MISSING_RULE",
      "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",
      "verification": {
        "outcome": "UNSPECIFIED",
        "cause": null,
        "reason": "string",
        "model": "string",
        "at": 0
      },
      "createdAt": 0
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
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
}