Interface: AIHelper

Defined in: packages/workflow-engine/src/ai/types.ts:701

Properties

topic

readonly topic: string

Defined in: packages/workflow-engine/src/ai/types.ts:703

Current topic path

Methods

batch()

batch<T>(modelKey, provider?, options?): AIBatch<T>

Defined in: packages/workflow-engine/src/ai/types.ts:756

Type Parameters

T

T = string

Parameters

modelKey

ModelKey

provider?

AIBatchProvider

options?

BatchOptions

Returns

AIBatch<T>

---

createChild()

createChild(segment, id?): AIHelper

Defined in: packages/workflow-engine/src/ai/types.ts:763

Parameters

segment

string

id?

string

Returns

AIHelper

---

embed()

embed(modelKey, text, options?): Promise<AIEmbedResult>

Defined in: packages/workflow-engine/src/ai/types.ts:719

Parameters

modelKey

ModelKey

text

string | string[]

options?

EmbedOptions

Returns

Promise<AIEmbedResult>

---

evaluate()

evaluate<Q>(modelKey, spec, options?): Promise<AIEvaluateResult<Q>>

Defined in: packages/workflow-engine/src/ai/types.ts:737

Answer typed questions about one shared state with a decision model (isEvaluationModel in the registry, e.g. TypeSafe's Jev). Each answer's type follows from its question, so a choice answer is the union of that question's criteria keys.

Type Parameters

Q

Q extends Readonly<Record<string, EvaluationQuestion>>

Parameters

modelKey

ModelKey

spec

EvaluationSpec<Q>

options?

EvaluateOptions

Returns

Promise<AIEvaluateResult<Q>>

---

generateObject()

generateObject<TSchema>(modelKey, prompt, schema, options?): Promise<AIObjectResult<output<TSchema>>>

Defined in: packages/workflow-engine/src/ai/types.ts:712

Type Parameters

TSchema

TSchema extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters

modelKey

ModelKey

prompt

TextInput

schema

TSchema

options?

ObjectOptions<ToolSet>

Returns

Promise<AIObjectResult<output<TSchema>>>

---

generateText()

generateText<TTools>(modelKey, prompt, options?): Promise<AITextResult>

Defined in: packages/workflow-engine/src/ai/types.ts:706

Type Parameters

TTools

TTools extends ToolSet = ToolSet

Parameters

modelKey

ModelKey

prompt

TextInput

options?

TextOptions<TTools>

Returns

Promise<AITextResult>

---

getStats()

getStats(): Promise<AIHelperStats>

Defined in: packages/workflow-engine/src/ai/types.ts:769

Returns

Promise<AIHelperStats>

---

recordCall()

recordCall(params): void

Defined in: packages/workflow-engine/src/ai/types.ts:766

Parameters

params

RecordCallParams

Returns

void

---

streamText()

streamText(modelKey, input, options?): AIStreamResult

Defined in: packages/workflow-engine/src/ai/types.ts:725

Parameters

modelKey

ModelKey

input

StreamTextInput

options?

StreamOptions

Returns

AIStreamResult

---

transcribe()

transcribe(modelKey, audio, options?): Promise<AITranscribeResult>

Defined in: packages/workflow-engine/src/ai/types.ts:749

Transcribe audio with a speech-to-text model (isTranscriptionModel in the registry). Cost is estimated per minute of audio (transcriptionCostPerMinute) or per reported token, whichever the provider bills by, unless the provider reports a USD cost itself.

Parameters

modelKey

ModelKey

audio

TranscriptionAudio

options?

TranscribeOptions

Returns

Promise<AITranscribeResult>