Skip to main content

Class: ObjectGenerationError

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

Thrown when structured output generation fails after exhausting all retries.

Captures both the raw LLM output and the Zod validation issues so callers can inspect what went wrong and surface useful diagnostics.

Example​

try {
  await generateObject({ schema: mySchema, prompt: '...' });
} catch (err) {
  if (err instanceof ObjectGenerationError) {
    console.error('Raw text:', err.rawText);
    console.error('Validation:', err.validationErrors);
  }
}

Extends​

  • Error

Constructors​

Constructor​

new ObjectGenerationError(message, rawText, validationErrors?): ObjectGenerationError

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

Parameters​

message​

string

Human-readable summary of the failure.

rawText​

string

The last raw text the LLM produced before we gave up.

validationErrors?​

ZodError<unknown>

Zod validation issues from the final attempt.

Returns​

ObjectGenerationError

Overrides​

Error.constructor

Properties​

message​

message: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message

name​

readonly name: "ObjectGenerationError" = 'ObjectGenerationError'

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

The name of this error class, useful for instanceof checks across realms.

Overrides​

Error.name

rawText​

readonly rawText: string

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

The raw text returned by the LLM on the final attempt.

stack?​

optional stack: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack

validationErrors?​

readonly optional validationErrors: ZodError<unknown>

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

Zod validation error details from the last parse attempt, if available.

stackTraceLimit​

static stackTraceLimit: number

Defined in: packages/agentos/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: packages/agentos/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: packages/agentos/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

Error.prepareStackTrace