Skip to main content
The analysis block carries derived data for retrieval and AI workflows. Optional and discardable — a document without analysis is still canonical.

Shape

{
  "analysis": {
    "embeddings": { "<target-uuid>": [ /* embeddings */ ] },
    "passages":   [ /* passages */ ],
    "summaries":  [ /* summaries */ ],
    "settings":   { /* how this was produced */ },
    "meta":       {}
  }
}

embeddings

A map keyed by the UUID of the target (a scene, element, or character). Value is an array of one or more embedding records.
{
  "id":         "<embedding-uuid>",
  "model":      "text-embedding-3-large",
  "dimensions": 1536,
  "values":     [0.023, -0.041, ...],
  "source":     "text",
  "lang":       "en",
  "tokens":     420,
  "created":    "2026-01-14T10:30:00Z"
}
FieldTypeRequiredDescription
iduuidEmbedding identifier.
modelstring (1–100)Model identifier.
dimensionsinteger 1–4096Vector length.
valuesnumber[] 1–4096Vector payload.
sourceenumWhich field was embedded. name, text, desc, heading, composite.
createddatetimeISO 8601.
langlangBCP 47 tag the source text was drawn from.
tokensinteger ≥1Token count of the source text.
metametaExtension.
Keys in the embeddings map are matched against the UUID pattern — only valid RFC 4122 strings are accepted.

passages

Retrieval-sized text chunks keyed to source elements.
{
  "id":       "<uuid>",
  "scene":    "<scene-uuid>",
  "elements": ["<element-uuid>", "<element-uuid>"],
  "text":     { "en": "..." },
  "tokens":   256,
  "overlap":  32
}
FieldTypeRequiredDescription
iduuid
sceneuuid
elementsuuid[] (≥1)Element ids covered by this passage.
texttextPassage text, language-keyed.
tokensinteger ≥1
overlapinteger ≥0Sliding-window overlap in tokens. Default 0.
metametaExtension.

summaries

Document- or scene-scoped summaries.
{
  "id":        "<uuid>",
  "scope":     "scene",
  "target":    "<scene-uuid>",
  "generated": true,
  "model":     "claude-opus-4-7",
  "text":      { "en": "..." },
  "created":   "2026-01-14T10:45:00Z"
}
FieldTypeRequiredDescription
iduuid
scopeenumdocument or scene.
texttextSummary text.
createddatetimeISO 8601.
targetuuid | nullScene id when scope="scene".
generatedbooleantrue for machine-generated. Default false.
modelstring (≤100)Producing model id.
metametaExtension.

settings

Records how derived data was produced — for reproducibility.
FieldTypeDefaultDescription
modelstring (≤100)Embedding or summary model.
sizeinteger ≥1512Chunk size.
overlapinteger ≥064Chunk overlap.
tokeniserstring (≤50)Tokeniser identifier — e.g. cl100k.
metameta{}Extension.