Skip to main content

Interface: ResolvedStructuredReply

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:98

Properties​

description?​

optional description: string

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:100


instruction​

instruction: string

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:108

The instruction the system prompt carries: the schema in words the model follows.


jsonSchema​

jsonSchema: JsonSchemaObject

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:103


maxRetries​

maxRetries: number

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:104


name​

name: string

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:99


onExhausted​

onExhausted: "error" | "return_invalid"

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:105


streamDeltas​

streamDeltas: boolean

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:106


zod?​

optional zod: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:102

The Zod schema when the spec gave one: the gateway lowers it per provider.

Methods​

checkValue()​

checkValue(value): StructuredCheck

Defined in: packages/agentos/src/api/runtime/structuredReply.ts:110

Checks a parsed value.

Parameters​

value​

unknown

Returns​

StructuredCheck