Settings every connection shares
Most connections that bring in knowledge share these settings. Each integration's page lists only what is its own.
The connection's buttons
| Button | What it does |
|---|---|
| Test | Checks the credentials and that the service answers, and updates the status. |
| Reconnect | Sign in again at the provider: after a password change, or when access was revoked. |
| Sync now | Fetch what changed since the last sync now, instead of waiting for the schedule. |
| Turn off | Stops syncing and takes its tools away from agents, keeping its settings. |
| Delete | Removes the connection, and optionally everything it brought in. |
The status reads Active (working), Pending (waiting for sign-in), Error (the last test or sync failed; the reason is shown on the connection) or Disabled.
Sync
| Setting | What it does |
|---|---|
| Automatic sync | Fetch what changed on a schedule. |
| Frequency | Every hour, daily, weekly, every 2 weeks or monthly. |
| Time (UTC) / Day of week | When it runs (not used for every hour). |
| Overwrite existing documents | Every sync re-reads everything instead of only what changed. Turn it on for one sync after changing how documents are read (OCR, say), then off again: each such sync costs as much as the first. |
Reading documents
| Setting | What it does |
|---|---|
| OCR | Read scanned pages and images, billed per page read. Off: only text the files already carry is indexed. |
| Exclude | A regular expression: anything whose name (or subject, or first line) matches is skipped, and removed if already indexed. |
Exclude examples:
| Pattern | Skips |
|---|---|
^Draft | names that start with "Draft" |
\.(tmp|bak)$ | files with those extensions |
invoice|receipt | names containing either word |
^(Automatic reply|Undeliverable) | bot mail, by subject |
Matching is case-sensitive unless the i flag is on.
Writing a pattern
Exclude patterns are JavaScript regular expressions. Try one on a few real file names or subjects before saving it: paste them into regex101.com with the ECMAScript (JavaScript) flavor, and it explains each part of the pattern and highlights what matches.
| Write | To match |
|---|---|
^ / $ | the start / end of the name |
. | any one character (\. for a real dot) |
\d | a digit; \d{4} four digits, like a year |
* / + / ? | the thing before it: any number of times / at least once / optional |
a|b | a or b |
(…) | a group, e.g. ^(Draft|Old) |
[abc] / [^abc] | one of these characters / any but these |
More examples:
| Pattern | Skips |
|---|---|
^~\$ | Office lock files (~$report.docx) |
copy of, with the i flag on | names containing "Copy of", in any case |
\b(19|20)\d{2}-archive\b | names like 2019-archive |
^(Out of office|Automatic reply) | out-of-office mail, by subject |
MDN's regular expressions guide covers the full syntax.
Mailboxes
Every mailbox (Email, Gmail, Outlook and their personal versions) has the same mail settings.
| Setting | What it does |
|---|---|
| Show in Mail | The Mail module reads this mailbox (never changing it) and people with Mail can answer from it. |
| Classify mail | Sort incoming mail into classes (request, billing, noise…) as it arrives. Each email classified is billed. |
| Classes | What mail is sorted into. Add your own (rfq, invoices, support) with a description of what belongs: the classifier reads it. A class keyed noise also keeps its mail out of knowledge. Give a class groups to list it only to those departments. |
| Add its mail to knowledge | Index the mailbox's mail and attachments, shown in Mail or not. |
| Folders | Which folders are read, for knowledge and for Mail. |
| Limit by | A rolling window (up to 6 months back, moving with time) or since a date (no earlier than 6 months ago; old mail is never dropped). |
| Exclude senders | Addresses (noreply@acme.com) or whole domains (notifications.com) never ingested. |
| Readers / Reader groups | Who may find all of this mailbox's mail, like a shared inbox's team. |
| Ingest attachments | Index attached PDFs, Word, Excel, CSV, HTML and text with their email; images with OCR. |
:::info Who finds which email An email is found only by the people who were on it, whoever connected the mailbox, and its readers. Nobody finds a colleague's private mail through an agent. :::
Agent tools and actions
Switches in a connection's Agents section offer it to agents: read tools (search a mailbox, list a folder) and actions (send, post, create). Switching one on only makes it available: grant it to an agent in the agent builder, under Tools. Every action waits in Review until a person approves it.