Playbook Models
Data structures for user playbooks and agent playbooks -- collecting, aggregating, and managing agent improvement data.
Playbook Models
UserPlaybook
Represents a user playbook row containing agent guidance. Rows are usually extracted from user interactions, but supported manual and playbook-optimizer workflows can also create rows.
Prop
Type
AgentPlaybook
Represents an agent playbook consolidated from multiple user playbooks.
Prop
Type
GetUserPlaybooksRequest
Request model for getting user playbooks.
Prop
Type
GetUserPlaybooksResponse
Response model for getting user playbooks.
Prop
Type
AddUserPlaybookRequest
Request model for adding user playbooks directly to storage.
Prop
Type
AddUserPlaybookResponse
Response model for adding user playbooks.
Prop
Type
AddAgentPlaybookRequest
Request model for adding agent playbooks directly to storage.
Prop
Type
AddAgentPlaybookResponse
Response model for adding agent playbooks.
Prop
Type
GetAgentPlaybooksRequest
Request model for getting agent playbooks.
Prop
Type
GetAgentPlaybooksResponse
Response model for getting agent playbooks.
Prop
Type
RunPlaybookAggregationRequest
Request model for running playbook aggregation.
Prop
Type
RunPlaybookAggregationResponse
Response model for playbook aggregation requests.
Prop
Type
DeleteAgentPlaybookRequest
Request model for deleting an agent playbook.
Prop
Type
DeleteAgentPlaybookResponse
Response model for agent playbook deletion requests.
Prop
Type
DeleteUserPlaybookRequest
Request model for deleting a user playbook.
Prop
Type
DeleteUserPlaybookResponse
Response model for user playbook deletion requests.
Prop
Type
ReviewUserPlaybooksRequest
Selects current user playbooks by inclusive creation-time bounds and reviews the newest matches first.
Prop
Type
ReviewUserPlaybookEdit
Complete replacement fields proposed for an edit decision.
Prop
Type
ReviewUserPlaybookResult
One selected playbook's review decision. skip means the playbook could not be
reviewed because its finalized generation-window provenance or validated
evidence is absent, a required interaction/request is missing, or provenance
ownership does not match — not that the reviewer chose to leave it unchanged,
which is accept. Historical context uses the full run-level interaction window,
not only the playbook's cited-evidence subset, and is independent of the current
extractor window and source filter. A skipped playbook is never written to.
Prop
Type
ReviewUserPlaybooksResponse
Review report, or an acknowledgement for a background apply run. In report mode
results holds one entry per selected playbook. In apply mode the run is
dispatched in the background, so the response carries only run_id and an empty
results; a later failure stops the run but leaves earlier decisions committed,
and each applied edit is recorded on its replacement's lineage under run_id.
Prop
Type
RerunPlaybookGenerationRequest
Request model for rerunning playbook generation.
Prop
Type
RerunPlaybookGenerationResponse
Response model for playbook generation rerun requests.
Prop
Type
ManualPlaybookGenerationRequest
Request model for manually triggering playbook generation with window-sized interactions. Creates playbook entries with CURRENT status directly (no upgrade needed).
Prop
Type
ManualPlaybookGenerationResponse
Response model for manual playbook generation.
Prop
Type