Interface: SessionSendStructuredResult<T>
Defined in: packages/agentos/src/api/agent.ts:471
Result returned by AgentSession.send when responseSchema is set.
Extends GenerateTextResult with a typed Zod-validated object.
Extends
Type Parameters
T
T
Properties
agentCalls?
optionalagentCalls:AgentCallRecord[]
Defined in: packages/agentos/src/api/generateText.ts:1028
Ordered records of every sub-agent call made during an agency() run.
undefined for plain generateText / agent() calls.
Inherited from
cacheDiagnostics?
optionalcacheDiagnostics:CacheDiagnostics|null
Defined in: packages/agentos/src/api/generateText.ts:1001
Cache-diagnostics verdict from the LAST agentic step (Anthropic beta;
present only when the run opted in via
GenerateTextOptions.cacheDiagnostics). null = the last step's
request matched its predecessor (prefix stable). A populated
cacheMissReason names the earliest divergence. Per-step verdicts are
available on the onAfterGeneration hook.
Inherited from
GenerateTextResult.cacheDiagnostics
fallback?
optionalfallback:FallbackSignal
Defined in: packages/agentos/src/api/generateText.ts:1059
Per-hop provider fallback trail. fired is true when any non-primary
provider produced — or was tried for — the result, so callers can flag a
degraded run even when the final attempt recovered on the primary.
undefined only on legacy code paths that predate the field.
Inherited from
finishReason
finishReason:
"error"|"length"|"stop"|"tool-calls"
Defined in: packages/agentos/src/api/generateText.ts:1023
Reason the model stopped generating.
"stop": natural end of response."length":maxTokenslimit reached."tool-calls": loop exhaustedmaxStepswhile still calling tools."error": provider returned an error.
Inherited from
GenerateTextResult.finishReason
grounding?
optionalgrounding:VerifiedResponse
Defined in: packages/agentos/src/api/generateText.ts:1052
Per-claim citation verdicts attached when agent({ verifyCitations: … })
is configured. undefined when verification was not requested or could
not run for this turn.
See
VerifyCitationsConfig (exported from @framers/agentos/api) for
the verifyCitations options.
Inherited from
model
model:
string
Defined in: packages/agentos/src/api/generateText.ts:970
Resolved model identifier used for the run.
Inherited from
object
object:
T
Defined in: packages/agentos/src/api/agent.ts:473
Zod-validated typed object.
parsed?
optionalparsed:unknown
Defined in: packages/agentos/src/api/generateText.ts:1038
Parsed structured output from BaseAgentConfig.output, or from
agent().generate() with responseSchema. Undefined without a schema.
Inherited from
plan?
optionalplan:Plan
Defined in: packages/agentos/src/api/generateText.ts:1043
The plan produced by the planning phase when planning is enabled.
undefined when planning is disabled or was not requested.
Inherited from
provider
provider:
string
Defined in: packages/agentos/src/api/generateText.ts:968
Provider identifier used for the final run.
Inherited from
providerMessageId?
optionalproviderMessageId:string|null
Defined in: packages/agentos/src/api/generateText.ts:1009
Provider message id (msg_...) of the LAST agentic step; present only
when the run opted in via GenerateTextOptions.cacheDiagnostics.
Persist it and pass it back as the next request's
cacheDiagnostics.previousMessageId to thread the comparison across
turns. null when the provider reported no id.
Inherited from
GenerateTextResult.providerMessageId
responseModel?
optionalresponseModel:string
Defined in: packages/agentos/src/api/generateText.ts:977
Provider-reported model id of the final step (spec batch-1 C1) — can
differ from model across aliases and fallback routing. Undefined on
paths where no provider-reported id was captured. model keeps its
existing meaning (zero-change).
Inherited from
GenerateTextResult.responseModel
serviceTier?
optionalserviceTier:string
Defined in: packages/agentos/src/api/generateText.ts:983
Provider-reported service tier the final step actually ran at (OpenAI
service_tier on the response; spec batch-1 C2). Undefined on
providers/paths without a tier concept.
Inherited from
GenerateTextResult.serviceTier
servingProvider?
optionalservingProvider:string
Defined in: packages/agentos/src/api/generateText.ts:992
Upstream host that actually served the request when provider is an
aggregator/router (OpenRouter reports e.g. 'Groq' or 'DeepInfra'
per completion). Undefined for direct providers, for aggregators that
omit it, and on the prompt-shim tool path. Latency attribution:
identical model + token counts vary 3-5x in wall-clock by serving
host, so telemetry needs this to interpret durations.
Inherited from
GenerateTextResult.servingProvider
text
text:
string
Defined in: packages/agentos/src/api/generateText.ts:1011
Final assistant text after all agentic steps have completed.
Inherited from
toolCalls
toolCalls:
ToolCallRecord[]
Defined in: packages/agentos/src/api/generateText.ts:1015
Ordered list of every tool call made during the run.
Inherited from
trace?
optionaltrace:AgencyTraceEvent[]
Defined in: packages/agentos/src/api/generateText.ts:1033
Structured trace events emitted during the run.
Populated by the agency orchestrator; undefined for single-agent calls.
Inherited from
transcriptDelta?
optionaltranscriptDelta:SessionTranscriptMessage[]
Defined in: packages/agentos/src/api/generateText.ts:966
Lossless message delta this call appended to the conversation: the request's user turn plus every assistant / tool turn the tool loop recorded, in order, in provider-replayable shape (tool_call ids, parallel results, thinking blocks). Sessions append THIS — never a reconstruction — to their history. Absent only on legacy paths that never seeded a conversation array. The prompt-shim path carries a partial delta (seeded turns only); native providers carry the full trail.
Inherited from
GenerateTextResult.transcriptDelta
usage
usage:
TokenUsage
Defined in: packages/agentos/src/api/generateText.ts:1013
Aggregated token usage across all steps.