Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/tools / / ResultEnvelope

Interface: ResultEnvelope<TOutput>

Defined in: packages/tools/src/result/envelope.ts:21

Canonical envelope passed through the executor's downstream pipeline. The text-shaped portion (textBody) is the only field subject to the result-size cap and the inbound sanitization scan.

Stable

Type Parameters

Type ParameterDefault type
TOutputunknown

Properties

PropertyModifierTypeDescriptionDefined in
contentPartsreadonlyreadonly MessageContent[]Multipart wire payload (text + non-text parts).packages/tools/src/result/envelope.ts:27
outputreadonlyTOutput | undefinedTyped structured payload (the model-facing output).packages/tools/src/result/envelope.ts:23
taint?readonly{ sensitive?: boolean; sourceKind?: string; untrusted?: boolean; }C6: per-result taint override carried from the ToolReturn envelope.packages/tools/src/result/envelope.ts:29
taint.sensitive?readonlyboolean-packages/tools/src/result/envelope.ts:31
taint.sourceKind?readonlystring-packages/tools/src/result/envelope.ts:32
taint.untrusted?readonlyboolean-packages/tools/src/result/envelope.ts:30
textBodyreadonlystringPlain-text rendering of the structured payload (used for cap accounting).packages/tools/src/result/envelope.ts:25