Public Access
278 lines
17 KiB
Markdown
278 lines
17 KiB
Markdown
# meeting-session Specification
|
|
|
|
## Purpose
|
|
TBD - created by archiving change define-meeting-assistant-v1. Update Purpose after archive.
|
|
## Requirements
|
|
### Requirement: Meeting Assistant creates a note before transcription
|
|
Meeting Assistant SHALL create an Obsidian markdown note for a meeting session before transcription starts.
|
|
|
|
The note SHALL be the durable anchor for meeting metadata, user notes, assistant-discovered context, transcript references, summaries, decisions, and next steps.
|
|
|
|
#### Scenario: Session starts
|
|
- **WHEN** the user starts a new meeting session
|
|
- **THEN** Meeting Assistant creates a markdown note in the configured meetings folder before starting transcription
|
|
|
|
#### Scenario: Recording starts from hotkey
|
|
- **WHEN** the user presses the recording hotkey while recording is inactive
|
|
- **THEN** Meeting Assistant creates the transcript file, creates the meeting note with links to the transcript, assistant context, and summary notes, and opens the meeting note through an `obsidian://` system command
|
|
|
|
#### Scenario: User adds context before transcription
|
|
- **WHEN** the note exists before transcription starts
|
|
- **THEN** the user can add attendees, project context, and other notes to that file
|
|
|
|
### Requirement: Vault locations are configurable
|
|
Meeting Assistant SHALL expose separate configuration settings for transcript files, meeting notes, assistant context, generated summaries, project knowledge, and dictation words.
|
|
|
|
The dictation words location SHALL point to a word-list artifact that speech recognition pipelines MAY use as vocabulary hints when supported.
|
|
|
|
#### Scenario: Transcript and note locations are configured separately
|
|
- **WHEN** Meeting Assistant starts with configured vault locations
|
|
- **THEN** transcripts, meeting notes, assistant context, generated summaries, project knowledge, and dictation words each have an independently configured path
|
|
|
|
#### Scenario: Provider supports dictation words
|
|
- **WHEN** the configured speech recognition pipeline supports vocabulary hints
|
|
- **THEN** Meeting Assistant can provide words from the configured dictation words path without changing the other vault locations
|
|
|
|
### Requirement: Meeting note template is coded and round-trippable
|
|
Meeting Assistant SHALL link the note files generated for one meeting run through frontmatter.
|
|
|
|
The meeting note frontmatter SHALL link to the transcript, assistant context, and summary notes.
|
|
|
|
Generated artifact notes SHALL link only to the other notes from the same run and SHALL omit the frontmatter property that would reference themselves.
|
|
|
|
#### Scenario: Meeting note links to generated artifacts
|
|
- **WHEN** Meeting Assistant creates a meeting note
|
|
- **THEN** the note frontmatter links to the configured transcript, assistant context, and summary note locations
|
|
|
|
#### Scenario: Generated artifacts do not self-reference
|
|
- **WHEN** Meeting Assistant writes transcript, assistant context, or summary artifact frontmatter
|
|
- **THEN** the artifact frontmatter links to the other run notes
|
|
- **AND** the artifact frontmatter omits the property for the artifact's own note type
|
|
|
|
### Requirement: Meeting notes preserve user-authored content
|
|
Meeting Assistant SHALL preserve user-authored meeting notes and include them as input when generating summaries, decisions, and next steps.
|
|
|
|
#### Scenario: User writes notes during the meeting
|
|
- **WHEN** the user updates the meeting note while the meeting is active
|
|
- **THEN** Meeting Assistant keeps that content and incorporates it into generated meeting outputs
|
|
|
|
### Requirement: Meeting sessions are platform independent
|
|
Meeting Assistant SHALL support meeting sessions that do not originate from Teams, Zoom, or any other meeting software API.
|
|
|
|
Meeting software integrations MAY augment the meeting experience, but they SHALL NOT be required for the primary meeting capture, transcription, or summary flow.
|
|
|
|
#### Scenario: In-person meeting is captured
|
|
- **WHEN** the user starts transcription for an in-person meeting
|
|
- **THEN** Meeting Assistant captures and processes the meeting without requiring a meeting platform integration
|
|
|
|
### Requirement: Windows Outlook enrichment is optional
|
|
Meeting Assistant SHALL gate Outlook Classic COM enrichment behind the Windows compilation target.
|
|
|
|
When the Windows build starts a meeting and Outlook Classic has exactly one current Teams appointment, Meeting Assistant SHALL copy the appointment title to the meeting note and copy the appointment agenda and scheduled end time to the assistant-context frontmatter.
|
|
|
|
Meeting Assistant SHALL copy the appointment attendees to the meeting note only when the raw appointment attendee count is less than or equal to the configured `Recording:MaxMetadataAttendeeImportCount`. The default maximum SHALL be 30 attendees.
|
|
|
|
The agenda SHALL be extracted from the appointment body content before the Teams join separator or Teams join text.
|
|
|
|
#### Scenario: Current Teams appointment enriches meeting artifacts
|
|
- **WHEN** a Windows build starts a meeting while Outlook Classic exposes exactly one current Teams appointment
|
|
- **THEN** Meeting Assistant uses the appointment subject as the meeting title
|
|
- **AND** writes the appointment attendees into meeting note frontmatter when the raw attendee count is within the configured import limit
|
|
- **AND** writes the appointment agenda into assistant-context frontmatter
|
|
- **AND** writes the appointment end time as `scheduled_end` into assistant-context frontmatter
|
|
|
|
#### Scenario: Oversized attendee list is not imported
|
|
- **GIVEN** the configured metadata attendee import limit is 30
|
|
- **WHEN** a Windows build starts a meeting while Outlook Classic exposes exactly one current Teams appointment with 31 attendees
|
|
- **THEN** Meeting Assistant uses the appointment subject as the meeting title
|
|
- **AND** does not write the appointment attendees into meeting note frontmatter
|
|
- **AND** writes the appointment agenda into assistant-context frontmatter
|
|
- **AND** writes the appointment end time as `scheduled_end` into assistant-context frontmatter
|
|
|
|
#### Scenario: Outlook is unavailable or ambiguous
|
|
- **WHEN** Outlook Classic is unavailable or more than one current Teams appointment is found
|
|
- **THEN** Meeting Assistant starts the recording with the default generated meeting title and empty agenda
|
|
- **AND** omits `scheduled_end` from assistant-context frontmatter
|
|
|
|
### Requirement: Meeting automation rules are configurable
|
|
Meeting Assistant SHALL allow an optional local YAML rules file path to be configured.
|
|
|
|
When the configured rules file is missing or blank, Meeting Assistant SHALL continue without applying automation rules.
|
|
|
|
The local rules file SHALL be ignored by source control.
|
|
|
|
Rules SHALL be evaluated against the latest meeting note data read from disk for each event.
|
|
|
|
Meeting Assistant SHALL expose a diagnostic endpoint that reloads application configuration so workflow automation configuration changes can be picked up without restarting the application.
|
|
|
|
#### Scenario: Missing rules file is ignored
|
|
- **WHEN** Meeting Assistant handles a meeting event and no configured rules file exists
|
|
- **THEN** it leaves the meeting note and assistant context unchanged
|
|
|
|
#### Scenario: Created rule adds default attendee
|
|
- **GIVEN** a configured rule that triggers on meeting creation when `meeting.attendees.count = 0`
|
|
- **WHEN** Meeting Assistant creates a meeting note without attendees
|
|
- **THEN** it adds the configured attendee to the meeting note
|
|
|
|
#### Scenario: Workflow configuration is reloaded diagnostically
|
|
- **GIVEN** the workflow automation configuration has changed on disk
|
|
- **WHEN** the diagnostic workflow reload endpoint is called
|
|
- **THEN** Meeting Assistant reloads application configuration without restarting
|
|
- **AND** future workflow events use the reloaded workflow automation configuration
|
|
|
|
### Requirement: Meeting automation rules support lifecycle triggers
|
|
Meeting Assistant SHALL support rule triggers for `created`, `state_transition`, and `speaker_identified`.
|
|
|
|
A `state_transition` trigger MAY filter by `from`, `to`, or both state values.
|
|
|
|
A `speaker_identified` trigger MAY filter by speaker name.
|
|
|
|
#### Scenario: State transition rule matches from and to
|
|
- **GIVEN** a configured rule that triggers on a state transition from `collecting metadata` to `transcribing`
|
|
- **WHEN** Meeting Assistant transitions that meeting from `collecting metadata` to `transcribing`
|
|
- **THEN** it applies the rule steps
|
|
|
|
#### Scenario: Speaker identified rule filters by name
|
|
- **GIVEN** a configured rule that triggers when speaker `Ada` is identified
|
|
- **WHEN** Meeting Assistant identifies speaker `Grace`
|
|
- **THEN** it does not apply the rule
|
|
- **WHEN** Meeting Assistant identifies speaker `Ada`
|
|
- **THEN** it applies the rule steps
|
|
|
|
### Requirement: Meeting automation rules support conditions and steps
|
|
Meeting Assistant SHALL support rule conditions using an expression engine.
|
|
|
|
Rules SHALL support nested `and`, `or`, and `not` condition groups.
|
|
|
|
Step values SHALL support Razor syntax against the current meeting event model.
|
|
|
|
Step values SHALL treat `@` characters inside valid email address tokens as literal text rather than Razor transitions.
|
|
|
|
Meeting Assistant SHALL support these initial rule steps:
|
|
|
|
- `add_attendee`
|
|
- `remove_attendee`
|
|
- `set_property`
|
|
- `add_context`
|
|
- `add_project`
|
|
|
|
#### Scenario: Nested conditions choose a matching rule
|
|
- **GIVEN** a configured rule with nested `and`, `or`, and `not` conditions over meeting title, attendees, and event data
|
|
- **WHEN** the condition evaluates to true
|
|
- **THEN** Meeting Assistant applies the rule
|
|
- **WHEN** the condition evaluates to false
|
|
- **THEN** Meeting Assistant skips the rule
|
|
|
|
#### Scenario: Templated context mentions identified speaker
|
|
- **GIVEN** a configured `speaker_identified` rule with an `add_context` step using Razor syntax
|
|
- **WHEN** Meeting Assistant identifies matching speaker `Ada`
|
|
- **THEN** it appends rendered context text containing `Ada` to the assistant context note
|
|
|
|
#### Scenario: Email addresses do not trigger Razor templating
|
|
- **GIVEN** a configured rule step value containing `Support@contoso.com`
|
|
- **WHEN** the rule runs
|
|
- **THEN** Meeting Assistant preserves the email address as literal text
|
|
|
|
#### Scenario: Email addresses can appear beside Razor templating
|
|
- **GIVEN** a configured rule step value containing both `Support@contoso.com` and a Razor expression
|
|
- **WHEN** the rule runs
|
|
- **THEN** Meeting Assistant renders the Razor expression and preserves the email address as literal text
|
|
|
|
#### Scenario: Rule can clean a meeting title
|
|
- **GIVEN** a configured state-transition rule that matches a title containing a configured marker
|
|
- **WHEN** the rule runs
|
|
- **THEN** Meeting Assistant can update the meeting title through `set_property`
|
|
|
|
### Requirement: Workflow rules and speaker identities can be edited through a tray-launched assistant
|
|
Meeting Assistant SHALL expose an `Edit rules and identities` item from the tray icon menu.
|
|
|
|
The tray icon SHALL be implemented through the Uno notification icon stack.
|
|
|
|
The tray icon menu SHALL show every configured launch profile when recording can be started and SHALL include each profile's configured toggle hotkey in the corresponding start or switch menu item.
|
|
|
|
When the user selects `Edit rules and identities`, Meeting Assistant SHALL open a basic MewUI chat window for editing the configured workflow rules file and speaker identities.
|
|
|
|
The chat window SHALL be titled `Edit rules and identities`, SHALL display user and assistant messages as visually distinct cards, SHALL display basic markdown emphasis, inline code, fenced code blocks, pipe tables rendered as grid views, and line breaks in agent responses, SHALL display a plain `Thinking...` line while the agent is working, SHALL provide a multiline text input at the bottom with placeholder text for asking to make a rule or list identities, SHALL send on Enter, SHALL insert a newline on Shift+Enter, and SHALL provide an explicit Send button.
|
|
|
|
When a new chat message or thinking state is appended, the chat window SHALL scroll to the bottom of the newly rendered content if the conversation was already near the bottom or did not need scrolling before the append.
|
|
|
|
The Windows executable and rules-and-identities editor window SHALL use the Meeting Assistant application icon so the editor has a taskbar icon.
|
|
|
|
The rules editor agent SHALL be configured from the summarizer agent settings by default, while allowing workflow-rules-editor-specific endpoint, key, model, reasoning, reconnection, output, and compaction settings to override those defaults.
|
|
|
|
The rules and identities editor agent SHALL include the workflow engine documentation in its system prompt and SHALL receive read, write, and search tools scoped to the configured workflow rules file.
|
|
|
|
The rules editor `write_rules` tool SHALL append to the configured workflow rules file by default and SHALL validate the complete resulting YAML document before writing it.
|
|
|
|
The rules editor `write_rules` tool SHALL replace the whole configured workflow rules file only when `replace_file` is true.
|
|
|
|
The rules editor `write_rules` tool SHALL refuse invalid YAML without changing the configured workflow rules file.
|
|
|
|
The rules and identities editor agent SHALL receive speaker identity tools to search/list, read, create, update, delete, and merge identities in the local speaker identity database.
|
|
|
|
The rules and identities editor agent SHALL receive speaker sample tools to list, read, delete, and queue playback of samples linked to identities.
|
|
|
|
The first model request caused by each user-submitted chat turn SHALL send the `X-Initiator: user` header, while follow-up model requests within that same turn, such as tool-call continuations, SHALL send `X-Initiator: agent`.
|
|
|
|
Meeting Assistant SHALL provide a diagnostic endpoint that opens the workflow rules editor through the same window service used by the tray menu.
|
|
|
|
#### Scenario: Tray menu opens the editor
|
|
- **WHEN** the user opens the tray icon menu
|
|
- **THEN** the menu includes `Edit rules and identities`
|
|
- **WHEN** the user selects `Edit rules and identities`
|
|
- **THEN** Meeting Assistant opens the workflow rules and identities editor chat window
|
|
|
|
#### Scenario: Tray menu shows configured profile hotkeys
|
|
- **GIVEN** the `default` launch profile uses `Ctrl+Alt+M`
|
|
- **AND** the `english` launch profile uses `Ctrl+Alt+E`
|
|
- **WHEN** the user opens the tray icon menu while Meeting Assistant is idle
|
|
- **THEN** the menu includes a start item for `default` showing `Ctrl+Alt+M`
|
|
- **AND** the menu includes a start item for `english` showing `Ctrl+Alt+E`
|
|
|
|
#### Scenario: Rules editor can be opened diagnostically
|
|
- **WHEN** a diagnostic caller requests the workflow rules editor to open
|
|
- **THEN** Meeting Assistant invokes the workflow rules editor window service
|
|
|
|
#### Scenario: Rules editor is scoped to the configured rules file
|
|
- **GIVEN** a configured workflow rules file
|
|
- **WHEN** the rules editor agent runs
|
|
- **THEN** its read, write, and search tools can access only that configured workflow rules file
|
|
- **AND** its system prompt includes the workflow engine documentation
|
|
|
|
#### Scenario: Rules editor appends by default
|
|
- **GIVEN** a configured workflow rules file with existing valid rules
|
|
- **WHEN** the rules editor writes an additional valid rule without `replace_file`
|
|
- **THEN** Meeting Assistant appends the new rule
|
|
- **AND** preserves the existing rules
|
|
|
|
#### Scenario: Rules editor replaces only when requested
|
|
- **GIVEN** a configured workflow rules file with existing rules
|
|
- **WHEN** the rules editor writes valid YAML with `replace_file` set to true
|
|
- **THEN** Meeting Assistant replaces the complete rules file with the supplied YAML
|
|
|
|
#### Scenario: Rules editor refuses invalid YAML
|
|
- **GIVEN** a configured workflow rules file with valid existing rules
|
|
- **WHEN** the rules editor writes YAML that would make the file invalid
|
|
- **THEN** Meeting Assistant refuses the write
|
|
- **AND** keeps the existing rules file unchanged
|
|
|
|
#### Scenario: Rules editor can manage speaker identities
|
|
- **GIVEN** the speaker identity database contains speaker identities and samples
|
|
- **WHEN** the rules editor agent runs
|
|
- **THEN** it can search, read, create, update, delete, and merge speaker identities
|
|
- **AND** it can list, read, delete, and queue playback of identity samples
|
|
|
|
#### Scenario: User sends a rules-editing chat turn
|
|
- **GIVEN** the rules editor chat window is open
|
|
- **WHEN** the user types a prompt and presses Enter
|
|
- **THEN** the user message appears in the conversation
|
|
- **AND** a plain `Thinking...` line appears while the agent is running
|
|
- **AND** the first model request for that turn is marked as user-initiated
|
|
- **AND** the final assistant response replaces the thinking line
|
|
|
|
#### Scenario: Chat auto-scrolls after appended content
|
|
- **GIVEN** the rules editor chat window content fits without scrolling or is already near the bottom
|
|
- **WHEN** a new user or assistant message is appended
|
|
- **THEN** the conversation scrolls to the bottom of the newly rendered message content
|
|
|