resetAssistantContext

mutation · in the family Your own session

What it does

Clear this session's Ask context.

Clear YOUR login session's Ask context: the assistant forgets this session's prior exchanges and the condensed memory; idempotent (a fresh thread answers the same zero meter). SELF by construction — no target argument exists. Requires authentication (user sessions).

What happens

The assistant forgets what this login session discussed; asking starts fresh.

Who may call it

Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.

• Owner
• System Administrator
• Manager
• Associate Manager
• Warehouse Associate
• Sales Associate
• Cashier
• An API key whose scope allows api:resetAssistantContext

Returns

AssistantContextMeter AssistantContextMeter! — The Ask session-context meter after a clear.

Example request

mutation ExampleResetAssistantContext {
  resetAssistantContext {
    contextTurns
    contextTurnsMax
    contextFolded
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "resetAssistantContext": {
      "contextTurns": 1,
      "contextTurnsMax": 1,
      "contextFolded": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)