Mirrors/talemate
1
0
Fork 0
mirror of https://github.com/vegu-ai/talemate.git synced 2025-12-25 07:59:36 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
talemate/docs/user-guide/node-editor/reference/events.md

639 lines
23 KiB
Markdown
Raw Permalink Normal View History

0.30.0 (#184) * pytorch update * github workflow for tests * tests set up config * tests download nltk punkt * punkt_tab * fix world state not updating on new initial scene load * fix new character creation from scene tools * py 312 py 313 support remove unreliant cuda detection and just lock poetry with cuda * fix tests * dont auto install cuda * remove unused StrEnum import * separate cuda install * fix auto progress OFF no longer working * fix debug logging options not sticking * disable revision during image prompt generation * prompt tweaks * prompt tweaks * fix some issues with directed character creation * tweak the continue generation button so its less prone to pop into a new line on itsown * fix context db filter field layout * handle error when trying to regnerate passthrough narrator message * prompt tweaks * increase auto direct evaluation length * fix node library on windows * auto direct eval tweaks * prompt tweaks * prompt tweaks * allow updationg of scene phase through director console * add generate action to director console phase intent text fields * prompt tweaks * track iteration count in scene loop always yield to user at initial start / load of a scene * fix issue with Split and Join nodes when passed \n as delimiter * sim suite only generate auto direct requirements if auto direct is enabled sim suite fix issues with title generation * autocomplete button disable until there is text to autcomplete * update installation docs * update scenario tools docs * docs * writing style phrase detection * typo * docs * fix issue where deleting an applied preset group would prevent selection of a different preset group in the affected client * fix @-Instruction is broken when using apostrophes * editor never attempt to fix exposition on user input if input starts with command characters @, ! or / * prompt tweaks * editor revision: automatic revision setting, prompt tweaks, docs * missing files * fix issue where narration responses starting with # would result in empty messages * prompt tweaks * fix issue with autocomplete not working at the beginning of a scene * fix issues where cached guidance would result in no guidance * editor revision analysis now has access to scene analysis and director guidance if it exists * fix issue where all nodes in the node editor would be locked on winsows OS * add `scene/SetIntroducation` node * fix issue where generating narration in a scene with zero characters would always come back blank * SceneIntroduction node state output fixed * node editor docs progress * fix issue with loading scene from file upload no longer working * better handling of what to do when there are no characters in a scene and no default character is defined * typo * silence trigger game loop debug message * docs * GenerateThematicList node * docs * docs * stubs * allow creation of module from existing nodes * move function into plugin * separate graph export functions into own .js file * group from selected nodes * remove debug output * tweak create module dialog * docs * docs * graph tests need to assume auto_progres True * add ModuleProperty node * fix some issues in the module creation modal when extending or copying a module * include module name in module deletion confirm dialog * fix node module copy not setting updated registry * module property name output * docs * docs * initializing a scene from a character card will no longer break the node editor * docs * when greeting text and intro do not match, do the greeting text first. * intro is set during card import, there is no need to ever emit character greetings in addition to the intro, its not really something that matches talemate's design philsophy at this point * docs * dynamic premise modules * tweaks * propagate module level property defaults to node * docs * fix issue where the default character would get added to scenes during load even though there already was a player character * prompt tweaks * tweaks to generate-premise module * docs * infinity quest dynamic story v2 * tweaks limits * fix line endings * prompt tweaks * fix some issues with node property editing * formatting * prompt tweaks * group and comment * add talemate tint node style fix gap in nodes when there are no sockets * node style fixes * docs * docs * icon for swtich nodes * conditional emit status node * don't reset dynamic premise * dynamic premise tweaks * dynamic premis status messages * fix issue with Input value error node * validate that topic is specified * fix issue where cancelling a generation triggered during scene loop init would cause the loop to reinitialize * docs * node error handling improvements * docs * better error handling in generate premise module * a connected socket should always override a property of the same value even if the socket connection is not resolved * dynamic premise expose intro length property * fix some issues with node module creation and add registry path validation * correctly title creative loop module so it can be copied * remove debug message * rename to dynamic storyline for clarity and so it doesn't collide with tutorial * import dynanimc storyline node * docs * gracefully handle a node missing during graph load * docs * make agent list a bit more compact * disable node property editing in inherited nodes * rename editor revision events so they are inline with the other agent events * support instruction injection for director.generate_choices action * normalize dynamic instructions * fix director guidance dynamic instructions * docs * generate choices event add choices property * prompt tweaks * add dynamic instruction node * prompt tweak * fix issue where some events could not be hooked into through event node modules * docs * clean response node * docs * docs * docs * module library tweaks * fix some issues with act-as selection * dont allow creation of new modules until scene has been saved at least once * public node modules dir * sim suite module styles * remove debug messages * fix default node titles * fix number input vlaidation in math nodes * context awareness in contextual generate now includes character info * fix dupe id warnings * alt drag to clone multiple nodes * alt drag to clone multiple nodes * docs * docs * fix issue where some scene modules could leak across scenes * dynamic instructions already included through extra context * prompt tweaks * update defaults * docs * make list init from json * socs * fix issue where not all field definitions would get sent * docs * fix issue causing deep analysis to loop * case insentive regex matching * prompt tweaks * fix node title * fix size issue in scene view when node editor was open on smaller resolutions * fix issue with autocomplete sometime loosing markup * add claude 4 * make director guidance and actor instructions available to autocomplete prompt * fix trim node handling of \n * extract node * extract node trim property * remover cruft * charactermessage node only set character if not already part of message prefix * editor revision unslop mode * fix search scenes showing node module files * prompt tweaks * unslop support unwanted phrase detection * define bad_prose * </FIX> seems to get ommitted a lot so lets handle it * cleanup * return on no issues * fix some issues with character creation * fix some character creation issues * prompt tweaks * contewxtual generate and autocomplete signals added * prefix revision_ * use uuidv4 which is already installed and doesnt come with compatibility issues * editor revision support for contextual generations normalize some event objects * add template picker to worldstate character creation interface * prompt tweaks * dont unslop scene intent or story intent generation * prompt tweaks * prompt tweaks * prompt tweaks * prompt tweaks * prompt tweaks * prompt tweaks * prompt tweaks * prompt tweaks * prompt tweaks * prompt tweaks * fix issue of conversation losing edits through signals * support revisions for world state entry generation * task_instructions * dont show rewrite specific options if unslop method is selected * docs * fix issue with setting locked save file when auto saving was turned on * don't trigger player_turn_start in creative mode * better check for when to fire player_turn_start and when not * node editor crash course fixes * docs * fix issue where sometimes wrong system prompt was selected * add world context to contextual generate node * fix node dragging issue when cloning multiple nodes * support editor revision for summarization generation * summarization support dynamic instructions * dedicated template for summary unslop * pass summarization_history to template vars * prompt tweaks * prompt tweaks * not sure how this got blanked * wording * wording * only display debug log if TALEMATE_DEBUG=1 * fix syntax * fix syntax * remove unused cruft * start-debug * log message cleanup * docs * tweak defaults * sim suite polish * remove unused images * add writing style instructions to revision prompts * missing endif tag * prompt tweaks * prompt tweaks * prompt tweaks * use app-busy * prompt tweaks * update readme and screenshots wording wording * add discord link
2025-06-03 12:26:12 +03:00
# Events
List of currently supported events.
!!! warning "Events not listed here"
There are some other events defined in the talemate codebase that are purposefully not listed here yet.
The reason for this is that there is an ongoing cleanup process and some of them may not stick around in their current form.
You can of course still hook into them, but be aware that they may change or be removed in the future.
## Event Index
| Event | Category |
|-------|----------|
| [`game_loop_actor_iter`](#game_loop_actor_iter) | Game Loop |
| [`game_loop_ai_character_iter`](#game_loop_ai_character_iter) | Game Loop |
| [`game_loop_player_character_iter`](#game_loop_player_character_iter) | Game Loop |
| [`game_loop_new_message`](#game_loop_new_message) | Game Loop |
| [`player_turn_start`](#player_turn_start) | Game Loop |
| [`scene_loop_init`](#scene_loop_init) | Scene Loop |
| [`scene_loop_start_cycle`](#scene_loop_start_cycle) | Scene Loop |
| [`scene_loop_end_cycle`](#scene_loop_end_cycle) | Scene Loop |
| [`regenerate.msg.character`](#regeneratemsgcharacter) | Regenerate |
| [`regenerate.msg.narrator`](#regeneratemsgnarrator) | Regenerate |
| [`regenerate.msg.reinforcement`](#regeneratemsgreinforcement) | Regenerate |
| [`regenerate.msg.context_investigation`](#regeneratemsgcontext_investigation) | Regenerate |
| [`agent.conversation.before_generate`](#agentconversationbefore_generate) | Conversation Agent |
| [`agent.conversation.inject_instructions`](#agentconversationinject_instructions) | Conversation Agent |
| [`agent.conversation.generated`](#agentconversationgenerated) | Conversation Agent |
| [`agent.creator.contextual_generate.before`](#agentcreatorcontextual_generatebefore) | Creator Agent |
| [`agent.creator.contextual_generate.after`](#agentcreatorcontextual_generateafter) | Creator Agent |
| [`agent.creator.autocomplete.before`](#agentcreatorautocompletebefore) | Creator Agent |
| [`agent.creator.autocomplete.after`](#agentcreatorautocompleteafter) | Creator Agent |
| [`agent.editor.revision-analysis.before`](#agenteditorrevision-analysisbefore) | Editor Agent |
| [`agent.editor.revision-analysis.after`](#agenteditorrevision-analysisafter) | Editor Agent |
| [`agent.editor.revision-revise.before`](#agenteditorrevision-revisebefore) | Editor Agent |
| [`agent.editor.revision-revise.after`](#agenteditorrevision-reviseafter) | Editor Agent |
| [`agent.narrator.before_generate`](#agentnarratorbefore_generate) | Narrator Agent |
| [`agent.narrator.inject_instructions`](#agentnarratorinject_instructions) | Narrator Agent |
| [`agent.narrator.generated`](#agentnarratorgenerated) | Narrator Agent |
| [`agent.director.guide.before_generate`](#agentdirectorguidebefore_generate) | Director Agent |
| [`agent.director.guide.inject_instructions`](#agentdirectorguideinject_instructions) | Director Agent |
| [`agent.director.guide.generated`](#agentdirectorguidegenerated) | Director Agent |
| [`agent.director.generate_choices.before_generate`](#agentdirectorgenerate_choicesbefore_generate) | Director Agent |
| [`agent.director.generate_choices.inject_instructions`](#agentdirectorgenerate_choicesinject_instructions) | Director Agent |
| [`agent.director.generate_choices.generated`](#agentdirectorgenerate_choicesgenerated) | Director Agent |
| [`agent.world_state.time`](#agentworld_statetime) | World State Agent |
| [`agent.summarization.scene_analysis.before`](#agentsummarizationscene_analysisbefore) | Summarization Agent |
| [`agent.summarization.scene_analysis.cached`](#agentsummarizationscene_analysiscached) | Summarization Agent |
| [`agent.summarization.scene_analysis.before_deep_analysis`](#agentsummarizationscene_analysisbefore_deep_analysis) | Summarization Agent |
| [`agent.summarization.scene_analysis.after_deep_analysis`](#agentsummarizationscene_analysisafter_deep_analysis) | Summarization Agent |
| [`agent.summarization.scene_analysis.after`](#agentsummarizationscene_analysisafter) | Summarization Agent |
| [`agent.summarization.summarize.before`](#agentsummarizationsummarizebefore) | Summarization Agent |
| [`agent.summarization.summarize.after`](#agentsummarizationsummarizeafter) | Summarization Agent |
## Game Loop
---
### game_loop_actor_iter
Triggered after either a player or AI character has had a turn.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
| `actor` | `Actor` | The actor object |
---
### game_loop_ai_character_iter
Triggered after the AI character has had a turn.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
| `character` | `Character` | The character object |
---
### game_loop_player_character_iter
Triggered after the player character has had a turn.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
| `character` | `Character` | The character object |
---
### game_loop_new_message
Triggered when a new message is added to the scene history.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
| `message` | `SceneMessage` | The message object |
---
### player_turn_start
Triggered when the user turn starts. User input has not yet happened at this point.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
---
## Scene Loop
### scene_loop_init
Triggered when the scene loop is initialised.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
---
### scene_loop_start_cycle
Triggered when the scene loop starts a new cycle.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
---
### scene_loop_end_cycle
Triggered when the scene loop ends a cycle.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
---
## Regenerate Events
### regenerate.msg.character
Triggered after regeneration replaces a *CharacterMessage*.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene in which regeneration happened |
| `message` | `CharacterMessage` | The regenerated character message |
| `character` | `Character` | The character associated with the message |
---
### regenerate.msg.narrator
Triggered after regeneration replaces a *NarratorMessage*.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
| `message` | `NarratorMessage` | The regenerated narrator message |
| `character` | `None` | Not applicable (always `None`) |
---
### regenerate.msg.reinforcement
Triggered when a *ReinforcementMessage* is regenerated.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
| `message` | `ReinforcementMessage` | The regenerated reinforcement message |
| `character` | `None` | Not applicable |
---
### regenerate.msg.context_investigation
Triggered when a *ContextInvestigationMessage* is regenerated.
!!! payload "Payload"
| Name | Type | Description |
|------|------|-------------|
| `scene` | `Scene` | The scene object |
| `message` | `ContextInvestigationMessage` | The regenerated context investigation message |
| `character` | `None` | Not applicable |
## Conversation Agent Events
### agent.conversation.before_generate
Emitted **just before** the Conversation agent sends the prompt to the model.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `ConversationAgent` | The agent instance |
| `actor` | `Actor` | The speaking actor |
| `character` | `Character` | Shortcut to `actor.character` |
---
### agent.conversation.inject_instructions
Emitted while constructing the prompt, **before** the prompt is sent to the model.
Handlers can mutate `dynamic_instructions` to inject extra task instructions.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `ConversationAgent` | The agent instance |
| `character` | `Character` | Target character |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Append strings here to include them near the top of the prompt |
---
### agent.conversation.generated
Emitted **after** the Conversation agent receives the model output but **before** the message is pushed to history.
Handlers can edit `generation` in-place to clean up or transform the text (the Editor agent does this).
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `ConversationAgent` | The agent instance |
| `actor` | `Actor` | Actor that spoke |
| `character` | `Character` | The speaking character |
| `response` | `str` | **Mutable.** Final text lines that will be turned into messages |
## Creator Agent Events
### agent.creator.contextual_generate.before
Contextual generation are things like character attributes, details, scene introductions, etc.
Emitted **before** the Creator agent sends the prompt to the model.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `CreatorAgent` | The agent instance |
| `character` | `Character` | The character that the contextual generation is for |
| `template_vars` | `dict` | Variables that will be fed into the prompt – **mutable** |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Push additional `DynamicInstruction` objects to influence generation |
### agent.creator.contextual_generate.after
Emitted **after** the Creator agent receives the model output but **before** the message is pushed to history.
Handlers can edit `response` in-place to clean up or transform the text (the Editor agent does this).
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `CreatorAgent` | The agent instance |
| `response` | `str` | **Mutable.** Final text lines that will be turned into messages |
| `template_vars` | `dict` | Variables that were fed into the prompt – **mutable** |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Push additional `DynamicInstruction` objects to influence generation |
### agent.creator.autocomplete.before
Autocomplete generation for character action or narrative text.
Emitted **before** the Creator agent sends the prompt to the model.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `CreatorAgent` | The agent instance |
| `input` | `str` | The input text that the autocomplete is for |
| `type` | `str` | The type of autocomplete (e.g. `dialogue`, `narrative`) |
| `character` | `Character` | The character that the autocomplete is for |
| `template_vars` | `dict` | Variables that will be fed into the prompt – **mutable** |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Push additional `DynamicInstruction` objects to influence generation |
### agent.creator.autocomplete.after
Emitted **after** the Creator agent receives the model output but **before** the message is pushed to history.
Handlers can edit `response` in-place to clean up or transform the text (the Editor agent does this).
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `CreatorAgent` | The agent instance |
| `response` | `str` | **Mutable.** Final text lines that will be turned into messages |
| `input` | `str` | The input text that the autocomplete is for |
| `type` | `str` | The type of autocomplete (e.g. `dialogue`, `narrative`) |
| `character` | `Character` | The character that the autocomplete is for |
| `template_vars` | `dict` | Variables that were fed into the prompt – **mutable** |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Push additional `DynamicInstruction` objects to influence generation |
## Editor Agent Events
### agent.editor.revision-revise.before
Emitted **before** the Editor agent requests the revision-revise prompt.
Handlers can add extra revise instructions via `dynamic_instructions` or adjust `template_vars`.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `EditorAgent` | The agent instance |
| `template_vars` | `dict` | Variables that will be fed into the prompt – **mutable** |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Push additional `DynamicInstruction` objects to influence generation |
---
### agent.editor.revision-revise.after
Emitted **after** the Editor agent receives the model output but **before** the message is pushed to history.
Handlers can edit `response` in-place to clean up or transform the text (the Editor agent does this).
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `EditorAgent` | The agent instance |
| `response` | `str` | **Mutable.** Final text lines that will be turned into messages |
| `template_vars` | `dict` | Variables that were fed into the prompt – **mutable** |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Push additional `DynamicInstruction` objects to influence generation |
---
### agent.editor.revision-analysis.before
Emitted **before** the Editor agent requests the revision-analysis prompt.
Handlers can add extra analysis instructions via `dynamic_instructions` or adjust `template_vars`.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `EditorAgent` | The agent instance |
| `template_vars` | `dict` | Variables that will be fed into the prompt – **mutable** |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Push additional `DynamicInstruction` objects to influence analysis |
---
### agent.editor.revision-analysis.after
Emitted after the revision-analysis prompt returns but **before** the rewrite is requested.
Handlers may inspect or replace the `response` string.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `EditorAgent` | The agent instance |
| `template_vars` | `dict` | Same vars used for the prompt |
| `response` | `str` | **Mutable.** Raw analysis text returned by the model |
## Narrator Agent Events
### agent.narrator.before_generate
Emitted **before** the Narrator agent sends the prompt to the model.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `NarratorAgent` | The agent instance |
---
### agent.narrator.inject_instructions
Emitted while constructing the prompt, **before** the prompt is sent to the model.
Handlers can mutate `dynamic_instructions` to inject extra task instructions.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `NarratorAgent` | The agent instance |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Append strings here to include them near the top of the prompt |
---
### agent.narrator.generated
Emitted **after** the Narrator agent receives the model output but **before** the message is pushed to history.
Handlers can edit `generation` in-place to clean up or transform the text (the Editor agent does this).
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `NarratorAgent` | The agent instance |
| `response` | `str` | **Mutable.** Final text lines that will be turned into messages |
## Director Agent Events
### agent.director.guide.before_generate
Emitted before the Director **guidance** module runs to craft guidance text.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `DirectorAgent` | The agent instance |
---
### agent.director.guide.inject_instructions
Runs just after the previous event. Same payload – gives one more chance to adjust `dynamic_instructions`.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `DirectorAgent` | The agent instance |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Add strings to influence the prompt |
---
### agent.director.guide.generated
Fires after guidance text is generated, but before it is cached or written to context.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `DirectorAgent` | The agent instance |
| `response` | `str` | **Mutable.** The guidance text |
---
### agent.director.generate_choices.before_generate
Emitted before the Director generates player choice actions.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `DirectorAgent` | The agent instance |
| `character` | `Character` | The character that the choices are for |
---
### agent.director.generate_choices.inject_instructions
Run before the Director generates player choice actions, gives one more chance to adjust `dynamic_instructions`.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `DirectorAgent` | The agent instance |
| `character` | `Character` | The character that the choices are for |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable.** Add strings to influence the prompt |
---
### agent.director.generate_choices.generated
After choices text is ready.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `DirectorAgent` | The agent instance |
| `response` | `str` | **Mutable.** Text that describes available choices |
| `choices` | `list[str]` | **Mutable.** List of of generated choices |
| `character` | `Character` | The character that the choices are for |
## World State Agent Events
### agent.world_state.time
Emitted when the world state agent advances the time in the scene.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `WorldStateAgent` | The agent instance |
| `duration` | `str` | The duration of the time passage (ISO 8601 duration) |
| `human_duration` | `str` | The human-readable duration of the time passage |
| `narrative` | `str` | The narrative direction of the time passage |
## Summarization Agent Events
### agent.summarization.scene_analysis.before
Emitted just before the summarizer performs a scene analysis prompt. Handlers can tweak `template_vars` or inject `dynamic_instructions` to influence the analysis.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `SummarizeAgent` | The agent instance |
| `template_vars` | `dict` | **Mutable.** Variables used in the prompt |
| `analysis_type` | `str` | `conversation` or `narration` |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable** |
---
### agent.summarization.scene_analysis.cached
Fired when a cached analysis is reused instead of generating a new one. Same payload as above plus `response` containing cached analysis text.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `SummarizeAgent` | The agent instance |
| `template_vars` | `dict` | **Mutable.** Variables used in the prompt |
| `analysis_type` | `str` | `conversation` or `narration` |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable** |
| `response` | `str` | The cached analysis text |
---
### agent.summarization.scene_analysis.before_deep_analysis
Occurs before running deep analysis passes (context investigations). Payload is `SceneAnalysisDeepAnalysisEmission`.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `SummarizeAgent` | The agent instance |
| `analysis` | `str` | Current analysis text |
| `analysis_type` | `str` | Same as above |
| `analysis_sub_type` | `str` | e.g. `progress`, `query`, etc. |
| `max_content_investigations` | `int` | Upper bound for investigations |
| `character` | `Character` | Character in focus (may be None) |
---
### agent.summarization.scene_analysis.after_deep_analysis
Fired immediately after deep analysis completes. Payload identical to previous event; handlers may alter `analysis`.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `SummarizeAgent` | The agent instance |
| `analysis` | `str` | Current analysis text |
| `analysis_type` | `str` | Same as above |
| `analysis_sub_type` | `str` | e.g. `progress`, `query`, etc. |
| `max_content_investigations` | `int` | Upper bound for investigations |
| `character` | `Character` | Character in focus (may be None) |
---
### agent.summarization.scene_analysis.after
Emitted after scene analysis is done and stored in scene state. Payload: `SceneAnalysisEmission` with `response` populated.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `SummarizeAgent` | The agent instance |
| `template_vars` | `dict` | **Mutable.** Variables used in the prompt |
| `analysis_type` | `str` | `conversation` or `narration` |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable** |
| `response` | `str` | The analysis text |
### agent.summarization.summarize.before
Emitted before the summarizer performs a summarize prompt. Handlers can tweak `template_vars` or inject `dynamic_instructions` to influence the summarize.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `SummarizeAgent` | The agent instance |
| `text` | `str` | The text to summarize |
| `template_vars` | `dict` | **Mutable.** Variables used in the prompt |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable** |
| `extra_instructions` | `str` | **Mutable.** any additional instructions |
| `generation_options` | `GenerationOptions` | **Mutable.** Generation options |
| `summarization_history` | `list[str]` | **Mutable.** any previous historical summaries |
---
### agent.summarization.summarize.after
Emitted after the summarizer performs a summarize prompt. Handlers can inspect or replace `response`.
!!! payload "Payload"
| Field | Type | Notes |
|-------|------|-------|
| `agent` | `SummarizeAgent` | The agent instance |
| `text` | `str` | The text to summarize |
| `template_vars` | `dict` | **Mutable.** Variables used in the prompt |
| `dynamic_instructions` | `list[DynamicInstruction]` | **Mutable** |
| `extra_instructions` | `str` | **Mutable.** any additional instructions |
| `generation_options` | `GenerationOptions` | **Mutable.** Generation options |
| `summarization_history` | `list[str]` | **Mutable.** any previous historical summaries |
| `response` | `str` | **Mutable.** The summary text |
Reference in New Issue Copy Permalink