YaqeenDocs
Back to Yaqeen

How-to guide

Use YQN

Ask for lookups, run a tool from the slash menu, read the results, and confirm a change with a before and after.

YQN, the assistant, answers questions about holds, cases, appeals, payouts, stores, rules and system health, and it prepares changes. It never changes anything by itself. You need to be signed in. What you can use depends on your role.

Ask or run a tool#

  1. In the dashboard, press Ask YQN at the bottom corner, or press Cmd+J (Ctrl+J on Windows). On a wide screen YQN opens beside the page and stays open as you move around. On a phone it fills the screen. YQN in the sidebar opens the full page. To ask about something on screen, select its text first and press Cmd+J: YQN opens with the text quoted in the box. On a wide screen you can also press the crosshair in the panel header and click a row or card on the page. If an answer is going the wrong way, type the better question and press Enter: YQN stops and answers that instead.
  2. Type a question such as "Show open holds", pick one of the starters, or type / to pick one tool. A tool that needs an input opens a small form. On a hold or case page, the chat starts about that record. Remove the chip to ask about something else.
  3. While it works, one line names the tool it is running and the time. When the reply is done the line folds into "3 steps in 1.4 s". Open it to see each step.
  4. The results appear as numbers, tables, cards, charts or a timeline before the words.

Hand it to a person#

  • Staff: press Hand to a teammate under the box. Pick a colleague and edit the note. Sending assigns the case behind the hold or case you were asking about, and adds the note to it. If the chat is not about a hold or a case yet, open one first.
  • Merchants: press Ask the review team, pick the payout if the chat is not about one already, and send. The team's reply shows on the payout page.

Preview and trace#

  • Click a hold id in a table. A side pane shows that hold without leaving the chat.
  • Open the step line above a reply. It shows each step with its time: the whole reply, the planning, each tool and the drawing of its result. A trace holds names and times only. It never holds your message or the data.

Confirm a change#

A tool that changes something shows a card first. The card lists before and after, and what it affects. If a second person has to approve it, the card says so. Press Confirm to go on or Cancel to leave everything as it was. A card works once, only for you, and expires after 10 minutes.

If something goes wrong#

  • "That is not available to your role" means the tool is not in your list.
  • "There is nothing like that, or you cannot see it" means the reference was wrong or belongs to someone else.
  • "Too many messages" means you reached the limit of 40 a minute for chat and 30 for confirms. Running a tool from the menu allows 120 a minute.
  • If the assistant does not understand a request, it offers the closest tools to choose from.

To ask the same kind of question from Claude or Codex instead, see Connect Claude and Codex. That connection is read-only and offers twelve of these tools.

For the API, see POST /api/v1/assistant/chat/stream/, POST /api/v1/assistant/run/ and GET /api/v1/assistant/tools/ in the API reference.

Up Down to moveEnter to openEsc to close