Overview
Thebigdata_edit_monitor tool updates a search monitor you own in your Bigdata.com account. Send only the fields that change. Fields you leave out stay as they are.
This is also how a monitor is turned on. bigdata_create_monitor always saves monitors inactive.
When to Use
Edit Monitor is ideal for:- Activating: Turning a monitor on after previewing it, with email delivery if the user asked for it
- Rescheduling: Replacing the frequency or cron schedule
- Refining: Narrowing what the monitor keeps with
intent_refinementorextraction_instructions - Changing scope: Replacing the search queries, the entities, or the structured output schema
How It Works
- Find the monitor
idwithbigdata_get_monitorif the user has not supplied it - Call
bigdata_edit_monitorwith theidand at least one change - Read the returned monitor detail to confirm the result
Parameters
To activate a monitor with email, send one call. Add
delivery only if the user asked for email:
Important Notes
idis required, plus at least one other field. A call with nothing to change returns an error- An explicit
nullonly clearsstructured_output,extraction_instructions,entities, ordelivery intent_refinementcannot be combined withstructured_outputor with anentitieschange. Change the entities first, then send the refinement in a second call- If every field you send already matches what is stored, nothing is updated and the current monitor is returned
- Schema edits and refinements are tried only once, because each one is a model call. A rejection returns the reason, and nothing from that call is saved
- If email delivery is requested for an owner with no email address, the whole update is rejected. Retry without
delivery - An unknown monitor
idreturns a not-found error
Data Returned
Returns the updated monitor detail, as markdown and asstructuredContent.
Practical Tips
Only add email when asked
Activating a monitor does not require delivery. Add{"type": "email"} only when the user asked to be emailed.
Entities, then refinement
To change entities and refine the intent, make two calls: first theentities change, then the intent_refinement.
Preview after a change
After changing queries, entities, or the schema, run a flash preview withbigdata_simulate_monitor to check the new results.