Response reference
What is returned, when does it appear, and how should you consume it? Start with Quick start and Read the result. All declarations are in TypeScript types.
Import public types and use indexed access for field types:
Default Native call and result
Set environment variables using model configuration. Save the complete file and run node native-response-en.mjs in your application. It selects orderId; suggestions, detailed evidence, diagnostics, and extension extraction are disabled by default.
This table is a reading summary of selected fields. Full responses do not omit required objects or arrays.
This fixed candidate passed through the actual core and schema-dsl Validator. Opaque IDs are consistently renamed for readability. Actual model wording and IDs vary. No order query or cancellation is executed.
Native configuration and request · Complete Native result
Expand the complete default Native result
Root fields
Required fields always occur in a normal IntentResult, using [] or {} when empty. Optional fields may be omitted; that does not mean null. Nullable locations such as domain/action/target and intentId are listed explicitly. Technical failures use exceptions/error envelopes rather than incomplete success objects.
turn and changes
applied means interpretation changed. conditional retains the condition and target without premature withdrawal. A withdrawn target may be absent from new effective; do not discard the valid withdrawal. changes does not promise every internal difference such as context relocation and is not a generic business-state patch.
Effective understanding
I means effective.intents[] or recursive I.children[]. C means effective.constraints[] or I.constraints[]. These are documentation path templates, not extra response fields.
Requirements, constraints, and deliverables
“Sign-in requires an email code” is requirement; “do not modify the database” is prohibition; “enable only after approval” is precondition; “prefer existing styles” is preference. “Deliver Chinese user instructions” belongs to expectedOutput. There is no separate requirements array.
Download the parent/child example, containing all four kinds, a goal tree, explicit parallel relation, and deliverable.
Expand the complete parent/child result
Expressions
E means C.expression or recursive child expressions. O means a comparison's left/right operand.
References and relations
R means I.references[].
Fields and states
States and consumption
Locate values with container + intentId + path. Do not merge multiple orders into the first goal. Unselected, unchanged inherited values may remain, but an absent current field report does not prove revalidation. fields=[] does not clear every old parameter or disable intent recognition.
Issues, candidates, and inferences
Q means issues[].
Sources, options, and diagnostics
S means any SourceRef.
JSON Pointer: the empty string names the root; /meta/ names an empty property; ~0 escapes a tilde and 1 a slash. /a2b is invalid; orders/1/amount lacks the required leading slash. Array pointers retain original indices. On the next turn, sources must be relocated into current supplied material rather than absent old objects.
defaultOutput and request output merge per key; explicit false overrides true. output:{} does not clear defaults. Enabling extensions without extensionSchema throws SCHEMA_NOT_CONFIGURED. See Configuration.
Complete scenarios and multi-turn material
Every scenario includes full config, request, and result; multi-turn examples include actual baseline and relevant context. Configurations omit model credentials; supply an executor to run them. These are fixed structural examples, not a promise of verbatim model output.
The scenarios cover: conditional withdrawal without premature removal; order ownership; all four constraint kinds and hierarchy; withdrawn IDs retained only in baseline; VIP maximum 20 versus non-VIP maximum 10; field invalidation and correction; withdrawn parameter requirements; facts without invented actions; explicitly supplied facts; unresolved and answered references; material-backed candidate choices; inference separated from confirmed target; complete intent with invalid fields; labels and output switches.
Native, MCP, and host wrappers
- Native parse returns IntentResult on success and throws IntentError on technical failure.
- Executor MCP intent_parse puts the same IntentResult into structuredContent and JSON text content, with isError=false.
- Host prepare returns HostTask. The client generates candidateText; accept returns the final IntentResult. cancel returns handoff status. A candidate is not a final response.
- MCP technical failures have isError=true with text {error: SerializedIntentError}, without structuredContent or partialResult.
- SDK envelope fields depend on negotiated protocol; they are not added to Native IntentResult.
Executor request · Complete executor reply
For these host examples, config is standalone MCP configuration and request is prepare input. They use the same default output policy as their corresponding structural scenarios; no duration is a latency guarantee.
Host order configuration/request · Host order result
Host clarification configuration/request · Host clarification result
INTENT_RESULT_SCHEMA validates response shape, not natural-language correctness. The caller decides business actions; see Read the result and Multi-turn.