Class: FieldBuilder

Defined in: packages/sdk/src/backend/records.ts:92

Chainable field builder: f.string().describe("…"), f.enum([...]).

Constructors

Constructor

new FieldBuilder(field): FieldBuilder

Defined in: packages/sdk/src/backend/records.ts:97

Parameters

field

RecordField

Returns

FieldBuilder

Properties

field

readonly field: RecordField

Defined in: packages/sdk/src/backend/records.ts:93

---

isOptional

isOptional: boolean = false

Defined in: packages/sdk/src/backend/records.ts:95

Set by .optional(); consumed by defineSchema.

Methods

describe()

describe(text): this

Defined in: packages/sdk/src/backend/records.ts:108

Attach a description (guides LLM extraction).

Parameters

text

string

Returns

this

---

optional()

optional(): this

Defined in: packages/sdk/src/backend/records.ts:102

Mark the field optional (fields are required by default).

Returns

this