@daydreamsai/core

---

@daydreamsai/core / Output

Type Alias: Output<Schema, Response, TContext, TAgent>

Output<Schema, Response, TContext, TAgent> = object

Defined in: packages/core/src/types.ts:272

Type Parameters

Schema

Schema extends OutputSchema = OutputSchema

Response

Response extends OutputRefResponse = OutputRefResponse

TContext

TContext extends AnyContext = AnyContext

TAgent

TAgent extends AnyAgent = AnyAgent

Properties

attributes?

optional attributes: OutputSchema

Defined in: packages/core/src/types.ts:283

---

context?

optional context: TContext

Defined in: packages/core/src/types.ts:284

---

description?

optional description: string

Defined in: packages/core/src/types.ts:279

---

enabled()?

optional enabled: (ctx) => boolean

Defined in: packages/core/src/types.ts:286

Parameters

ctx

ContextState<TContext>

Returns

boolean

---

examples?

optional examples: string[]

Defined in: packages/core/src/types.ts:296

---

format()?

optional format: (res) => string | string[] | XMLElement

Defined in: packages/core/src/types.ts:294

Parameters

res

OutputRef<Response["data"]>

Returns

string | string[] | XMLElement

---

handler()?

optional handler: (data, ctx, agent) => MaybePromise<Response | Response[]>

Defined in: packages/core/src/types.ts:287

Parameters

data

InferOutputSchemaParams<Schema>

ctx

ContextState<TContext> & object

agent

TAgent

Returns

MaybePromise<Response | Response[]>

---

install()?

optional install: (agent) => MaybePromise<void>

Defined in: packages/core/src/types.ts:285

Parameters

agent

TAgent

Returns

MaybePromise<void>

---

instructions?

optional instructions: string

Defined in: packages/core/src/types.ts:280

---

required?

optional required: boolean

Defined in: packages/core/src/types.ts:281

---

schema?

optional schema: Schema

Defined in: packages/core/src/types.ts:282

---

type

type: string

Defined in: packages/core/src/types.ts:278