feat: add "Passing data between assistants" page to squads#1033
Open
dhruva-reddy wants to merge 2 commits intomainfrom
Open
feat: add "Passing data between assistants" page to squads#1033dhruva-reddy wants to merge 2 commits intomainfrom
dhruva-reddy wants to merge 2 commits intomainfrom
Conversation
Adds a focused decision guide for the three mechanisms Vapi supports for forwarding context across squad handoffs: 1. Handoff arguments (function.parameters on the handoff tool) — LLM fills inline, zero added latency 2. variableExtractionPlan.schema — separate dedicated LLM call against the transcript, structured output with JSON-schema validation 3. Liquid templating in the destination's prompt — sub-millisecond, deterministic, reads anything already in the variable bag The existing /squads/handoff page covers configuration mechanics for the handoff tool itself but doesn't compare these three approaches as alternatives. Customers consistently pick the wrong path (usually defaulting to schema extraction when handoff arguments or direct Liquid would be faster and more reliable). New page sits next to /squads/handoff in the nav. Includes: - At-a-glance comparison table - Per-approach example + when-to-use / when-to-avoid - Decision flowchart for choosing - Common patterns (forwarding extracted IDs, classifying intent, mixed) - Failure-mode notes (empty plan, LLM rejection, non-object result) reflecting the platform-hardening guarantees from PRISM-467 Validated: fern check passes, 2 JSON blocks valid, 5 internal links resolve.
…andoff tool - Flags that function.parameters is API-only today (dashboard UX for the Tools page shipping in VapiAI/vapi#10727, squad-builder backend gap tracked in PRISM-471) - Directs customers to put the handoff tool on the assistant's model.tools[] via the API instead of the squad-member Handoff Tools path until the backend gap (callAssistantsGet synthesizing without `function`) is closed
Contributor
|
🌿 Preview your docs: https://vapi-preview-8af91f5e-49bf-4826-b8ff-712f27a4a206.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-4df34e55-c8f7-4ff7-b636-4e95c3d2bd63.docs.buildwithfern.com |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
fern/squads/passing-data-between-assistants.mdx— a focused decision guide for the three mechanisms Vapi supports for forwarding context across squad handoffs.fern/docs.ymlupdated: new entry under the Build → Squads section, sitting between the existing Handoff tool page and the Examples subsection.The existing
/squads/handoffpage covers configuration mechanics for the handoff tool itself but doesn't compare the three approaches (function.parameters,variableExtractionPlan.schema, Liquid in the destination prompt) as alternatives. Customers default to schema extraction even when handoff arguments or direct Liquid would be faster, cheaper, and more reliable.The page covers:
Resolves the docs follow-up tracked alongside PRISM-467.
Testing Steps
fern check— passes with 0 errors (5 pre-existing warnings, unrelated)/squads/handoff,/squads/handoff#variable-extraction,/squads/handoff(again),/tools/static-variables-and-aliases,/assistants/dynamic-variables— all OKfern/docs.ymlbetween Handoff tool and Examples in the Squads section/squads/passing-data-between-assistantsin the preview deploymentSpecialist,Scheduler) and reference actual JSON schemas matching the API