FruxonDocs
ApiAgent reviews

Dismisses a recommendation card.

The reason and the note are shown to the reviewer in every later review of this agent, so it learns what the agent's admins don't want. Say where the card went wrong: `AGENT_WAS_RIGHT`, `KNOWLEDGE_BASE_WAS_WRONG` and `ALREADY_IN_INSTRUCTIONS` (and the older `WRONG`) are never raised again; `NO_LONGER_HAPPENS` and `OTHER` (and the older `NOT_RELEVANT` and `ALREADY_HANDLED`) come back only if several more conversations show the problem. With `KNOWLEDGE_BASE_WAS_WRONG`, name the articles that were wrong in `documentIds`, picked from `recommendations/{recommendation}/articles`: each is held for review, its text unchanged, with the card's conversations as evidence. Send the card's `version` as you saw it: a card that changed since answers 409. Agent admins only.

POST
/v1/tenants/{tenant}/agents/{agent}/recommendations/{recommendation}:dismiss
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.

recommendation*string

The recommendation ID.

Formatuuid
tenant*string

The tenant identifier

Why, and the card's version.

reason?string

Why an admin dismissed a recommendation — told to the reviewer with the admin's note, so it learns what this agent's admins don't want. The reasons from AgentRecommendationDismissReason.AgentWasRight on name where the card went wrong, which is what the reviewer can learn from; the four before them stay readable for the cards dismissed with them, and an API caller may still send them.

Value in"UNSPECIFIED" | "NOT_RELEVANT" | "WRONG" | "ALREADY_HANDLED" | "OTHER" | "AGENT_WAS_RIGHT" | "KNOWLEDGE_BASE_WAS_WRONG" | "ALREADY_IN_INSTRUCTIONS" | "NO_LONGER_HAPPENS"
note?string|null

Optional: what the admin wants to say about it. The reviewer reads it with the reason.

documentIds?|null

With KNOWLEDGE_BASE_WAS_WRONG only: the articles that were wrong, picked from the card's (recommendations/{recommendation}/articles). Each is held for review with the card's conversations as evidence. Optional: none names none.

version?integer

The card's version as the admin saw it.

Formatint32
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/agents/string/recommendations/497f6eca-6276-4993-bfeb-53cbbbba6f08:dismiss" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "kind": "ADD_TOOLS",
  "category": "MISSING_CAPABILITY",
  "severity": "LOW",
  "status": "CANDIDATE",
  "title": "string",
  "summary": "string",
  "need": "string",
  "patch": {
    "tools": [
      {
        "integrationId": "string",
        "id": "string",
        "displayName": "string",
        "actionType": "UNSPECIFIED",
        "availability": "UNSPECIFIED"
      }
    ],
    "instructionText": "string",
    "replaceAnchor": "string",
    "adviceMarkdown": "string",
    "feature": "string"
  },
  "evidenceCount": 0,
  "customerCount": 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": "00000000-0000-0000-0000-000000000000",
    "patchRevision": 0,
    "cardRunId": "00000000-0000-0000-0000-000000000000",
    "otherRunId": "00000000-0000-0000-0000-000000000000",
    "regressionRunId": "00000000-0000-0000-0000-000000000000",
    "cardTurns": [
      {
        "unitId": "00000000-0000-0000-0000-000000000000",
        "anchorMessageId": 0
      }
    ],
    "otherTurns": [
      {
        "unitId": "00000000-0000-0000-0000-000000000000",
        "anchorMessageId": 0
      }
    ],
    "regressionTurns": [
      {
        "unitId": "00000000-0000-0000-0000-000000000000",
        "anchorMessageId": 0
      }
    ],
    "sandboxRouting": {},
    "baseRevision": 0,
    "startedAt": 0,
    "startedBy": "string",
    "recheck": {
      "id": "00000000-0000-0000-0000-000000000000",
      "cardRunIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "otherRunIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "cases": [],
      "startedAt": 0,
      "startedBy": "string",
      "usedAt": 0
    }
  },
  "patchRevision": 0,
  "revisions": [
    {
      "outcome": "REVISED",
      "patchRevision": 0,
      "comparisonId": "00000000-0000-0000-0000-000000000000",
      "recheckId": "00000000-0000-0000-0000-000000000000",
      "previousKind": "ADD_TOOLS",
      "previousPatch": {
        "tools": [],
        "instructionText": "string",
        "replaceAnchor": "string",
        "adviceMarkdown": "string",
        "feature": "string"
      },
      "explanation": "string",
      "shownTurns": [],
      "cases": [],
      "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
      },
      "excludedCaseKeys": [
        "string"
      ],
      "note": "string",
      "revisedBy": "string",
      "revisedAt": 0,
      "recordId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "version": 0
}
{
  "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
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}