Schema

Use this reference to inspect fields, methods, accepted values and failure outcomes. For setup and working examples, start with the API guide.

Definition: abstraction.inference.job

Encoding [DEF-E1]

settingvaluerule
escapeminimal[DEF-E2]
indent2[DEF-E3]
map_keysutf8-bytes[DEF-E4]
numbersinteger-decimal[DEF-E5]
opaqueverbatim[DEF-E6]
terminatornewline[DEF-E7]
duplicate_keysrefuse[DEF-E8]
depth_limit64[DEF-E9]

Types

kindtypes
built inMode Profile i64 string
declared belowImageRequest JobResult Request
container [DEF-T3]list<RequestGuarantee> list<string>
repeated record [DEF-A9]list<Delivery>
string map [DEF-A10]map<string,string>

Structs [DEF-T1]

A field is required, or says when it is omitted [DEF-A4]. Each struct says on its own what it does with a field name it has never heard of [DEF-A7]. A wire name never moves; where a language must spell it differently the field says so [DEF-A2].

ImageRequest

unknown fields refuse

idfieldtypepresencenamed elsewhere
1modelstringrequired—
2modeModerequired—
3promptstringrequired—
4sizestringrequired—
5counti64required—
6image_digeststringoptional · omitted when zero—
7image_media_typestringoptional · omitted when zero—
8mask_digeststringoptional · omitted when zero—
9mask_media_typestringoptional · omitted when zero—
10guaranteeslist<RequestGuarantee>required—
11credentialstringoptional · omitted when zero—
12required_extensionslist<string>optional · omitted when zero—
13extensionsmap<string,string>optional · omitted when zero—

Delivery

unknown fields refuse

idfieldtypepresencenamed elsewhere
1digeststringrequired—
2media_typestringrequired—
3sizei64required—
4locationstringrequired—

Request

unknown fields refuse

idfieldtypepresencenamed elsewhere
1profileProfilerequired—
2imageImageRequestrequired—
3duration_msi64optional · omitted when zero—

JobResult

unknown fields refuse

idfieldtypepresencenamed elsewhere
1profileProfilerequired—
2deliverieslist<Delivery>required—
3hoststringrequired—
4modelstringrequired—

Document

the document [DEF-A1] · unknown fields refuse

idfieldtypepresencenamed elsewhere
1requestRequestoptional · omitted when absent—
2resultJobResultoptional · omitted when absent—

Enumerations [DEF-T5]

Enum fields carry JSON strings containing exact member wire spellings, never numeric IDs. Unknown names are preserved with grant and refused as bad_enum with refuse on read and write. Optional absent fields preserve presence separately from an empty string.

An enumeration is a closed vocabulary of wire names, and each one says on its own what a reader does with a member it has never heard of [DEF-A5].

Profile

a member this reader does not know is refuse

idmemberwire
1videovideo
2image_batchimage_batch

Mode

a member this reader does not know is refuse

idmemberwire
1generategenerate
2editedit

RequestGuarantee

a member this reader does not know is grant

idmemberwire
1local_onlyabstraction.inference/local-only@1
2hosted_allowedabstraction.inference/hosted-allowed@1

Constants [DEF-A6]

nametypevalue
kindslist<string>inference
execution_guaranteeslist<string>abstraction.inference/recoverable-upstream@1

Refusal words [DEF-R1]

orderwordstage
1malformedgrammar
2bad_stringgrammar
3number_spellinggrammar
4wrong_typegrammar
5depth_exceededgrammar
6duplicate_keygrammar
7duplicate_fieldstructure
8unknown_fieldstructure
9missing_fieldstructure
10bad_enumstructure
11trailing_bytesdocument