Class Instructions

Prompt-based operation. May reference skills and additional context. Hidden from the navtree and object picker — accessed only through Routines.

Hierarchy

{
    commands?: readonly {
        description?: string;
        prompt: string;
        sentinel: string;
    }[];
    input: JsonSchemaType;
    name?: string;
    objects?: readonly Ref<Unknown>[];
    output: JsonSchemaType;
    skills: readonly Ref<Skill.Skill & OfKind<Object> & Unknown>[];
    text: Ref<Text & OfKind<Object> & Unknown>;
} & OfKind<Object, this>
- Instructions

Index

Constructors

constructor

Properties

~@dxos/echo/Kind commands? id input name? objects? output skills text ~@dxos/echo/Kind ~@dxos/echo/SchemaKind ~@dxos/echo/Type.Instance? ~@dxos/echo/Type.StaticSchema fields id jsonSchema name?

Constructors

constructor

new Instructions(_: never): Instructions.Instructions
Parameters
- _: never
Returns Instructions.Instructions
Inherited from Type.makeObject<Instructions>(DXN.make('org.dxos.type.instructions', '0.1.0'))( Schema.Struct({ name: Schema.optional(Schema.String), input: JsonSchema.JsonSchema.pipe(Annotation.FormInputAnnotation.set(false)).annotate({ description: 'Input schema', }), output: JsonSchema.JsonSchema.pipe(Annotation.FormInputAnnotation.set(false)).annotate({ description: 'Output schema', }), /** Owned body: `SetParent` cascades it and deep-clones it with the instructions. */ text: Ref.Ref(Text.Text).pipe( Annotation.SetParent.set(), Format.FormatAnnotation.set(Format.TypeFormat.Markdown), Schema.annotate({ title: 'Instructions', description: 'Describe what the agent should do in each session.' }), ), skills: Schema.Array(Ref.Ref(Skill.Skill)), /** * Context objects bound to the agent's session when this routine runs (sibling of `skills`). * Generic `Ref.Ref(Obj.Unknown)` so any space object qualifies. Honored on every run path that * executes a routine through the agent prompt, not only triggered automations. */ objects: Schema.Array(Ref.Ref(Obj.Unknown)).pipe(Schema.annotate({ title: 'Objects' }), Schema.optional), /** Sentinel commands available to chat sessions running with these instructions. */ commands: Schema.Array(Command).pipe(Schema.annotate({ title: 'Commands' }), Schema.optional), }).pipe( Annotation.LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--scroll--regular', hue: 'sky' }), ), ).constructor
- Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:72

Properties

`Readonly`~@dxos/echo/Kind

"~@dxos/echo/Kind": Object

Inherited from Type.makeObject<Instructions>(DXN.make('org.dxos.type.instructions', '0.1.0'))( Schema.Struct({ name: Schema.optional(Schema.String), input: JsonSchema.JsonSchema.pipe(Annotation.FormInputAnnotation.set(false)).annotate({ description: 'Input schema', }), output: JsonSchema.JsonSchema.pipe(Annotation.FormInputAnnotation.set(false)).annotate({ description: 'Output schema', }), /** Owned body: `SetParent` cascades it and deep-clones it with the instructions. */ text: Ref.Ref(Text.Text).pipe( Annotation.SetParent.set(), Format.FormatAnnotation.set(Format.TypeFormat.Markdown), Schema.annotate({ title: 'Instructions', description: 'Describe what the agent should do in each session.' }), ), skills: Schema.Array(Ref.Ref(Skill.Skill)), /** * Context objects bound to the agent's session when this routine runs (sibling of `skills`). * Generic `Ref.Ref(Obj.Unknown)` so any space object qualifies. Honored on every run path that * executes a routine through the agent prompt, not only triggered automations. */ objects: Schema.Array(Ref.Ref(Obj.Unknown)).pipe(Schema.annotate({ title: 'Objects' }), Schema.optional), /** Sentinel commands available to chat sessions running with these instructions. */ commands: Schema.Array(Command).pipe(Schema.annotate({ title: 'Commands' }), Schema.optional), }).pipe( Annotation.LabelAnnotation.set(['name']), Annotation.IconAnnotation.set({ icon: 'ph--scroll--regular', hue: 'sky' }), ), ).~@dxos/echo/Kind

Defined in packages/core/echo/echo/dist/types/src/Entity.d.ts:20

`Optional` `Readonly`commands

commands?: readonly { description?: string; prompt: string; sentinel: string }[] = ...

Sentinel commands available to chat sessions running with these instructions.

Defined in packages/core/compute/compute/src/types/Instructions.ts:50

`Readonly`id

id: string

Defined in packages/core/echo/echo/dist/types/src/Entity.d.ts:21

`Readonly`input

input: JsonSchemaType = ...

Defined in packages/core/compute/compute/src/types/Instructions.ts:30

`Optional` `Readonly`name

name?: string = ...

Defined in packages/core/compute/compute/src/types/Instructions.ts:29

`Optional` `Readonly`objects

objects?: readonly Ref<Unknown>[] = ...

Context objects bound to the agent's session when this routine runs (sibling of skills). Generic Ref.Ref(Obj.Unknown) so any space object qualifies. Honored on every run path that executes a routine through the agent prompt, not only triggered automations.

Defined in packages/core/compute/compute/src/types/Instructions.ts:48

`Readonly`output

output: JsonSchemaType = ...

Defined in packages/core/compute/compute/src/types/Instructions.ts:33

`Readonly`skills

skills: readonly Ref<Skill.Skill & OfKind<Object> & Unknown>[] = ...

Defined in packages/core/compute/compute/src/types/Instructions.ts:42

`Readonly`text

text: Ref<Text & OfKind<Object> & Unknown> = ...

Owned body: SetParent cascades it and deep-clones it with the instructions.

Defined in packages/core/compute/compute/src/types/Instructions.ts:37

`Static` `Readonly`~@dxos/echo/Kind

"~@dxos/echo/Kind": Type

Entity-kind brand of the type-entity value itself — always EntityKind.Type. The kind of instance the type describes lives on [SchemaKindId] (Object / Relation / Type). Lets Obj.isObject / Relation.isRelation reject type entities by a single [KindId] check.

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:23

`Static` `Readonly`~@dxos/echo/SchemaKind

"~@dxos/echo/SchemaKind": Object

Schema-kind brand (object).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:57

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

"~@dxos/echo/Type.Instance"?: Instructions.Instructions & OfKind<Object>

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:34

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

"~@dxos/echo/Type.StaticSchema": Codec<any, any>

Source Effect Schema — used internally by Type.getSchema(self).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:59

`Static` `Readonly`fields

fields: {}

The fields defined in the original struct schema. Allows accessing field definitions for introspection.

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:64

`Static` `Readonly`id

id: string

Object id. Like all ECHO entities, type entities always carry an id — stamped at construction for in-memory (static) declarations and assigned by the database once persisted. The id does NOT determine the entity's URI: static types resolve to their typename DXN, persisted types to echo:///<id> (see getTypeURIFromSpecifier).

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:31

`Static` `Readonly`jsonSchema

jsonSchema: JsonSchemaType

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:33

`Static` `Optional` `Readonly`name

name?: string

Defined in packages/core/echo/echo/dist/types/src/Type.d.ts:32

Class Instructions

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Instructions.Instructions

Properties

`Readonly`~@dxos/echo/Kind

`Optional` `Readonly`commands

`Readonly`id

`Readonly`input

`Optional` `Readonly`name

`Optional` `Readonly`objects

`Readonly`output

`Readonly`skills

`Readonly`text

`Static` `Readonly`~@dxos/echo/Kind

`Static` `Readonly`~@dxos/echo/SchemaKind

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

`Static` `Readonly`fields

`Static` `Readonly`id

`Static` `Readonly`jsonSchema

`Static` `Optional` `Readonly`name

Settings

On This Page

Class Instructions

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns Instructions.Instructions

Properties

Readonly~@dxos/echo/Kind

Optional Readonlycommands

Readonlyid

Readonlyinput

Optional Readonlyname

Optional Readonlyobjects

Readonlyoutput

Readonlyskills

Readonlytext

Static Readonly~@dxos/echo/Kind

Static Readonly~@dxos/echo/SchemaKind

Static Optional Readonly~@dxos/echo/Type.Instance

Static Readonly~@dxos/echo/Type.StaticSchema

Static Readonlyfields

Static Readonlyid

Static ReadonlyjsonSchema

Static Optional Readonlyname

Settings

On This Page

`Readonly`~@dxos/echo/Kind

`Optional` `Readonly`commands

`Readonly`id

`Readonly`input

`Optional` `Readonly`name

`Optional` `Readonly`objects

`Readonly`output

`Readonly`skills

`Readonly`text

`Static` `Readonly`~@dxos/echo/Kind

`Static` `Readonly`~@dxos/echo/SchemaKind

`Static` `Optional` `Readonly`~@dxos/echo/Type.Instance

`Static` `Readonly`~@dxos/echo/Type.StaticSchema

`Static` `Readonly`fields

`Static` `Readonly`id

`Static` `Readonly`jsonSchema

`Static` `Optional` `Readonly`name