Skip to content

Sensorium File Read Result v1

Source schema: doc/schemas/sensorium-file-read-result.v1.schema.json

Bounded file read result. Large or sensitive contents should be returned as artifact references.

Governing Basis

Project Lineage

Requirements

Stories

Fields

Field Required Shape Description
schema yes const: sensorium-file-read-result.v1
schema/v yes const: 1
read/ref yes ref: #/$defs/ref
address yes ref: sensorium-relative-path-address.v1.schema.json
result/kind yes enum: inline-text, inline-base64, artifact-ref, refused
text no string
bytes/base64 no string
artifact/ref no ref: #/$defs/ref
size/bytes yes integer
content/sha256 yes string
classification yes ref: classification.v1.schema.json

Definitions

Definition Shape Description
ref string
## Field Semantics

schema

  • Required: yes
  • Shape: const: sensorium-file-read-result.v1

schema/v

  • Required: yes
  • Shape: const: 1

read/ref

  • Required: yes
  • Shape: ref: #/$defs/ref

address

  • Required: yes
  • Shape: ref: sensorium-relative-path-address.v1.schema.json

result/kind

  • Required: yes
  • Shape: enum: inline-text, inline-base64, artifact-ref, refused

text

  • Required: no
  • Shape: string

bytes/base64

  • Required: no
  • Shape: string

artifact/ref

  • Required: no
  • Shape: ref: #/$defs/ref

size/bytes

  • Required: yes
  • Shape: integer

content/sha256

  • Required: yes
  • Shape: string

classification

  • Required: yes
  • Shape: ref: classification.v1.schema.json

Definition Semantics

$defs.ref

  • Shape: string