spec: GLOSSARY.md — topic-shape, stop-targeting, and shared_pipeline_id entries - #127
spec: GLOSSARY.md — topic-shape, stop-targeting, and shared_pipeline_id entries#127JarbasAl wants to merge 1 commit into
Conversation
|
Warning Review limit reached
Next review available in: 36 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. 📝 WalkthroughWalkthroughGLOSSARY.md replaces “Capture map” with “Slot map”, adds ChangesGlossary terminology
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
a0d5016 to
4bec3be
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
GLOSSARY.md (1)
39-40: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winClarify the two dispatch topic entries.
Dispatch-shaped topicandDispatch topiccurrently describe the same colon-bearing<skill_id>:<intent_name>address. DefineDispatch-shaped topicas the syntax category andDispatch topicas the concrete MSG-1 term, or cross-reference one entry from the other.Also applies to: 69-69
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@GLOSSARY.md` around lines 39 - 40, Clarify the glossary distinction between “Dispatch-shaped topic” and “Dispatch topic”: define the former as the general colon-bearing syntax category, and define the latter as the concrete MSG-1 term for a valid <skill_id>:<intent_name> address, or cross-reference the entries while avoiding duplicate definitions.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@GLOSSARY.md`:
- Line 64: Update the “Transformer chain” glossary definition to state that
transformers run unconditionally except when utterance cancellation permits the
chain to stop early, keeping the wording aligned with the cancellation exception
defined in transformer.md.
- Line 62: Clarify the pipeline_id definition in GLOSSARY.md so the allowed
character constraint is unambiguous: specify that multi-character IDs are valid
and require one or more characters from [A-Za-z0-9_-], or explicitly state the
per-character rule. Preserve the existing exclusions of “:” and “.” and the
reference to the orchestrator’s loaded-plugin set.
---
Nitpick comments:
In `@GLOSSARY.md`:
- Around line 39-40: Clarify the glossary distinction between “Dispatch-shaped
topic” and “Dispatch topic”: define the former as the general colon-bearing
syntax category, and define the latter as the concrete MSG-1 term for a valid
<skill_id>:<intent_name> address, or cross-reference the entries while avoiding
duplicate definitions.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| | **Fallback pipeline plugin** | A pipeline plugin that maintains a registry of fallback skills and queries them in order until one claims the utterance ([FALLBACK-1 §2](fallback.md)). | | ||
| | **Match** | The object a pipeline plugin's `match` function returns to claim an utterance — `skill_id`, `intent_name`, `lang`, `slots`, `utterance`, and optionally `updated_session` ([PIPELINE-1 §4.1](pipeline-1.md)). | | ||
| | **Pipeline plugin** | A component occupying a stage in `session.pipeline`, identified by an opaque `pipeline_id`, that may claim an utterance via `match` ([PIPELINE-1 §3](pipeline-1.md)). | | ||
| | **`pipeline_id`** | The opaque string matching `[A-Za-z0-9_-]` — no `:`, no `.` — that keys a pipeline plugin instance in the orchestrator's loaded-plugin set ([PIPELINE-1 §3](pipeline-1.md)). | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the pipeline_id constraint unambiguous.
[A-Za-z0-9_-] is a single-character regex class. If multi-character IDs are valid, use [A-Za-z0-9_-]+ or state that every character must belong to the class. The current wording can make valid IDs appear invalid.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@GLOSSARY.md` at line 62, Clarify the pipeline_id definition in GLOSSARY.md so
the allowed character constraint is unambiguous: specify that multi-character
IDs are valid and require one or more characters from [A-Za-z0-9_-], or
explicitly state the per-character rule. Preserve the existing exclusions of “:”
and “.” and the reference to the orchestrator’s loaded-plugin set.
| | **Pipeline plugin** | A component occupying a stage in `session.pipeline`, identified by an opaque `pipeline_id`, that may claim an utterance via `match` ([PIPELINE-1 §3](pipeline-1.md)). | | ||
| | **`pipeline_id`** | The opaque string matching `[A-Za-z0-9_-]` — no `:`, no `.` — that keys a pipeline plugin instance in the orchestrator's loaded-plugin set ([PIPELINE-1 §3](pipeline-1.md)). | | ||
| | **Transformer** | A black-box component that consumes one artifact at a fixed point in the utterance lifecycle and produces an artifact of the same shape for the next stage ([TRANSFORM-1 §1](transformer.md)). | | ||
| | **Transformer chain** | An ordered set of transformers of one type that all run, unconditionally, when their injection point is reached — no claim, no first-result-wins ([TRANSFORM-1 §1](transformer.md)). | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Include the transformer cancellation exception.
Line 64 says all transformers run unconditionally. transformer.md:41-58 states that utterance cancellation is an exception to the no-early-exit rule. Add this exception to keep the glossary aligned with the referenced specification.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@GLOSSARY.md` at line 64, Update the “Transformer chain” glossary definition
to state that transformers run unconditionally except when utterance
cancellation permits the chain to stop early, keeping the wording aligned with
the cancellation exception defined in transformer.md.
…id entries Squashed from: - spec: GLOSSARY.md — rows aligned with MSG-1/PIPELINE-1 audit wording - spec: GLOSSARY.md — coined-term rows for INTENT-4, FALLBACK-1, PIPELINE-1, TRANSFORM-1, MSG-1, PERSONA-1, OCP-1 - spec: GLOSSARY.md — dispatch-shaped vs dotted addressed topic, recency-targeted stop, <shared_pipeline_id> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1c254dd to
de9b176
Compare
1 participant
Adds glossary entries introduced by the spec refactors.
Merge after #117. The
Recency-targeted stopand<shared_pipeline_id>rows point at STOP-1 §4.1/§5.2 (PR #117); merge #117 first so the citations resolve against landed wording.<skill_id>:<intent_name>(MSG-1 §2.1.1).:-free dotted topic that names a recipient in a segment (e.g.<skill_id>.common_query.request); addressed, not a dispatch.<shared_pipeline_id>— pointer to STOP-1 §5.2'sglobal_stopdispatch identity (no longer duplicates the normative text)..promptadded to the resource-role enumeration;ovos.listener.wakewordadded to the listening-lifecycle-signal enumeration.pipeline_id(PIPELINE-1); transformer, transformer chain, injection point (TRANSFORM-1); Layer-2 system, Assistant core, Derivation, Dispatch topic (MSG-1); persona, summon, dismiss, no-persona mode, persona-fallback,persona_id(PERSONA-1); Virtual Media Player, media entry,PlayerState,MediaState(OCP-1).Non-normative — no CHANGELOG entry.
🤖 Generated with Claude Code
Summary by CodeRabbit