Built-in agents
Ready-made agents maintained by Optima - pick one in the Built-in tab, fill in a few parameters and run it with your own model and budget.
A built-in agent is a ready-made agent that Optima writes and maintains. You do not write a prompt. You pick the agent, answer a few questions (its parameters), choose a model and a budget, and start it in dry run like any other instance.
Who uses it
Campaign managers and tenant administrators. Creating an instance needs the agents_editor role or an administrator role, and the Built-in agents feature in your licence. Built-in agents that read campaign data appear only when your licence also includes Campaign. See licences and roles.
What a built-in agent is
- Maintained by Optima. You cannot edit or archive a built-in definition. You can read it in the definition editor, which shows it read-only.
- Versioned. When Optima improves a built-in agent it publishes a new version. Instances you already created stay on the version they started with and keep behaving the same. To use the new version, create a new instance.
- Yours to run. The instance has your model, your budget and an owner, exactly like an agent you wrote yourself, and it can do only what its owner may do.
The Built-in tab
The Agents screen has a Built-in tab next to Definitions and Instances. It shows one card for every built-in agent your licence allows, with what it does, what it Reads and what it Sends (an email, an event or an attribute). Choose Create instance on a card to open the usual create dialog with that agent and its current version already selected. The Definitions tab and New definition appear only when your licence includes Custom agents; the two features are independent.
Parameters
A built-in agent asks for its settings in the create dialog. Besides text, number, duration, users, segment and campaign, you may meet these inputs:
| Input | What you enter |
|---|---|
| Switch | On or off. |
| Schedule | A repeating schedule, shown with a plain-language description such as "every Monday at 08:00". Left empty, the default applies. |
| Campaigns, metrics or forms | One or more items from a list, up to 100. Leaving the list empty usually means Any, as the input says. |
| List of values | Type a value and press Enter, up to 100 values. |
| Choice list | Tick values from a fixed list. |
| Users | Choose people on your team or type an email address. Owner (you) is the default recipient, so the report goes to whoever creates the instance. |
Where a parameter has a default, the form shows it and says "Left empty, the default applies". Once the instance exists its parameters cannot be changed; create another instance.
Numbers in emails are checked
A built-in agent that emails you results is checked so that it does not quote numbers it never read. Before an email is sent, Optima checks each number in its subject and body against the data the agent read during the run, the parameters of the instance and the date of the run. A number that is not found, and cannot be worked out from two related numbers (fields of the same record, for example opened and sent) as a ratio, percentage or difference, is sent back to the agent to fix. Numbers of one digit are not checked, and neither are codes such as "BF24" or multiples such as "33x". A figure with the suffix k, M or bn ("47k", "1.5M", "2bn") is read as thousands, millions or billions and checked at the precision written. Words such as "million" are not understood, so the agent has to write "1.5M" or the full figure ("1,500,000"). The check guards against invented figures; it does not prove that a figure is correct. If it still cites numbers it cannot back up, the run fails with the message "The agent's answer used numbers that no tool returned", and nothing is sent.
Declare the event type first
Some built-in agents write an event of their own, for example a lead classification. Optima needs that event type to exist, with the right properties, before the instance can be created. If it does not, the create dialog says "Declare the event type ... with properties ... before creating this agent" and lists the missing properties. To fix it, open Settings → Workspace → Schema, choose the Event types tab, select New event type, add the event type and its properties with the types shown, and create the instance again. See events.
Common problems
- No Built-in tab. Your licence has no Built-in agents feature. Ask your account administrator.
- A card is missing. The agent reads Campaign data and your licence has no Campaign.
- "Your licence does not include the tools this agent needs". The same cause: a tool the agent uses is not licensed.
- Declare the event type. See above.
- A run failed with "numbers that no tool returned". The model wrote a figure it could not support. Try a stronger model, or look at the run in the run log.
Built-in agents
Each built-in agent has its own page.
- Anomaly explainer: emails you why a metric alert fired.
- Campaign evaluator: emails you a short note when a campaign has been sent and a full evaluation after a delay.
- Weekly campaign digest: emails a weekly summary of how your campaigns and journeys performed.
- Data quality watchdog: emails you when event volume drops, Connect runs fail or identifier fill rates fall.
- Privacy digest: emails a weekly summary of consent withdrawals and erasure requests.
- Lead qualifier: classifies each web form submission by topic, intent and urgency and records it as an event.