Skip to main content

Interface: GenerateObjectResult<T>

Defined in: packages/agentos/src/api/generateObject.ts:382

The completed result returned by generateObject.

Type Parameters​

T​

T

The inferred type from the Zod schema, representing the validated object.

Properties​

fallback?​

optional fallback: FallbackSignal

Defined in: packages/agentos/src/api/generateObject.ts:414

Provider-fallback trail aggregated across all attempts. fired is true when any attempt used or tried a non-primary provider — including a fallback on a failed attempt that a later attempt recovered from on the primary. Callers use this to flag a degraded run.


finishReason​

finishReason: string

Defined in: packages/agentos/src/api/generateObject.ts:400

Reason the model stopped generating on the final successful attempt. Mirrors the finish reasons from generateText.


model​

model: string

Defined in: packages/agentos/src/api/generateObject.ts:406

Resolved model identifier used for the run.


object​

object: T

Defined in: packages/agentos/src/api/generateObject.ts:384

The parsed, Zod-validated object matching the provided schema.


provider​

provider: string

Defined in: packages/agentos/src/api/generateObject.ts:403

Provider identifier used for the run.


text​

text: string

Defined in: packages/agentos/src/api/generateObject.ts:387

The raw LLM output text before parsing.


usage​

usage: TokenUsage

Defined in: packages/agentos/src/api/generateObject.ts:394

Aggregated token usage across all attempts (including retries), summed as generateText sums its steps: every counter it reports, the cache reads and writes and inclusiveInputTokens among them.