Get structured output

{
  "approved": true,
  "reason": "The item arrived damaged."
}

{
  "type": "object",
  "properties": {
    "approved": {
      "type": "boolean"
    },
    "reason": {
      "type": "string"
    }
  },
  "required": [
    "approved",
    "reason"
  ],
  "additionalProperties": false
}

{
  "approved": true,
  "reason": ""
}

Decide whether the request satisfies the stated refund policy. Explain the decision directly.

The item arrived damaged. Should we approve a refund?

const objective = await client.objectives.retrieve(objectiveId, {
  workspaceId,
});

if (objective.state !== 'STATE_FINALIZED') {
  throw new Error(`Objective is ${objective.state}`);
}

console.log(objective.output);

events:
for await (const event of stream) {
  const data = event.data;

  switch (data.type) {
    case 'finalized':
      console.log(data.finalized.output);
      break events;
    case 'error':
      throw new Error(data.error.message ?? 'Objective failed');
  }
}

const agent = await client.agents.create({
  workspaceId,
  metadata: {
    name: 'Refund Decider',
    externalId: 'refund-decider',
  },
  spec: {
    description: 'Returns a structured refund decision.',
    variationSelectionMode: 'VARIATION_SELECTION_MODE_RANDOM',
    outputDefinition: {
      type: 'object',
      properties: {
        approved: { type: 'boolean' },
        reason: { type: 'string' },
      },
      required: ['approved', 'reason'],
      additionalProperties: false,
    },
  },
});