AgentOperations

The agent.* operations.

Extended by

Agent

Properties

agent

readonly agent: string;

The agent's ID.

conversation

readonly conversation: string | undefined;

The conversation the methods act on. undefined for the agent's own history.

Methods

read()

read(options?): Promise<AgentSnapshot>;

Read what an agent is doing now.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSnapshot>

define()

define(input?, options?): Promise<AgentSnapshot>;

Define an agent.

Starts the agent the definition describes, or brings the one running to it from its next turn. A definition put again replaces the last. A key nothing here supports yet answers not_supported, naming it.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`input?`	`AgentDefinition`
`options?`	`CallOptions`

Returns

Promise<AgentSnapshot>

forget()

forget(options?): Promise<void>;

Forget an agent.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<void>

ask()

ask(input, options?): Promise<{
  id: string;
  cursor: string;
}>;

Send an agent a message.

Parameters

Parameter	Type
`input`	`Ask`
`options?`	`CallOptions`

Returns

Promise<{ id: string; cursor: string; }>

decide()

decide(input, options?): Promise<object[]>;

Approve or reject the calls an agent waits on.

The decisions are taken together and recorded as the caller's. A rejection's reason is what the model is told in place of the call's answer. An approval's note is what it reads beside the answer.

Parameters

Parameter	Type
`input`	`Decisions`
`options?`	`CallOptions`

Returns

Promise<object[]>

authorization()

authorization(interrupt, options?): Promise<Authorization>;

Read where a person authorizes a call.

Parameters

Parameter	Type
`interrupt`	`string`
`options?`	`CallOptions`

Returns

Promise<Authorization>

cancel()

cancel(options?): Promise<void>;

Stop what an agent is doing.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<void>

events()

events(input?, options?): Promise<Events>;

Read an agent's log.

Parameters

Parameter	Type	Description
`input?`	{ `types?`: `string`[]; `after?`: `string`; `limit?`: `number`; }	-
`input.types?`	`string`[]	The event types to read, as wardrik.run.completed, given once for each. Every type where left out. A wardrik.events.dropped comes whatever the types.
`input.after?`	`string`	The cursor to read after: a page's next, the id of an event a stream gave, or a snapshot's cursor.
`input.limit?`	`number`	How many to read, 100 unless set.
`options?`	`CallOptions`	-

Returns

Promise<Events>

streamEvents()

streamEvents(input?, options?): EventStream;

Like events, then follows each new event as it's written. Starts after after, or at the end of the log. See EventStream.

Parameters

Parameter	Type	Description
`input?`	{ `types?`: `string`[]; `after?`: `string`; }	-
`input.types?`	`string`[]	The event types to read, as wardrik.run.completed, given once for each. Every type where left out. A wardrik.events.dropped comes whatever the types.
`input.after?`	`string`	The cursor to read after: a page's next, the id of an event a stream gave, or a snapshot's cursor.
`options?`	`StreamOptions`	-

Returns

EventStream

timeline()

timeline(options?): Promise<Timeline>;

Read an agent's conversation as a person reads it.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<Timeline>

runs()

runs(options?): Promise<Runs>;

Read what an agent's runs did and cost.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<Runs>

approve()

approve(
   interrupt,
   input?,
   options?
): Promise<object[]>;

Approve a call an agent waits on.

agent.decide with one approval. Recorded as the caller's.

Parameters

Parameter	Type
`interrupt`	`string`
`input?`	`Approve`
`options?`	`CallOptions`

Returns

Promise<object[]>

deny()

deny(
   interrupt,
   input?,
   options?
): Promise<object[]>;

Reject a call an agent waits on.

agent.decide with one rejection. Recorded as the caller's.

Parameters

Parameter	Type
`interrupt`	`string`
`input?`	`Deny`
`options?`	`CallOptions`

Returns

Promise<object[]>

definition()

definition(options?): Promise<DefinitionRead>;

Read an agent's definition.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<DefinitionRead>

spawn()

spawn(options?): Promise<AgentSummary>;

Start an agent.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSummary>

stop()

stop(options?): Promise<AgentSummary>;

Stop an agent.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSummary>

clear()

clear(options?): Promise<AgentSnapshot>;

Clear an agent's history.

Empties its history. The agent, its definition and its other conversations stay. Answers conflict while it runs a turn or waits on a person.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<AgentSnapshot>

calls()

calls(options?): Promise<object[]>;

List the tool calls an agent is running.

Answers not_found while the agent sleeps.

Parameters

Parameter	Type
`options?`	`CallOptions`

Returns

Promise<object[]>

kill()

kill(call, options?): Promise<void>;

Stop one tool call.

Parameters

Parameter	Type
`call`	`string`
`options?`	`CallOptions`

Returns

Promise<void>

triggerSet()

triggerSet(
   trigger,
   input?,
   options?
): Promise<TriggerDefinition>;

Set one of an agent's triggers.

Sets or changes one trigger of an agent with a definition, which keeps it; not_found where it has none. A trigger whose every and timezone stay keeps its next run.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`trigger`	`string`
`input?`	`TriggerDefinition`
`options?`	`CallOptions`

Returns

Promise<TriggerDefinition>

triggerRemove()

triggerRemove(trigger, options?): Promise<TriggerDefinition>;

Remove one of an agent's triggers.

Acts on the agent, never a conversation.

Parameters

Parameter	Type
`trigger`	`string`
`options?`	`CallOptions`

Returns

Promise<TriggerDefinition>

move()

move(input, options?): Promise<AgentSummary>;

Move an agent to another node.

Starts the agent again on node, as it was. A turn it's taking ends, and what it waits on is abandoned, so ask it again once it's moved.

Parameters

Parameter	Type
`input`	`Node`
`options?`	`CallOptions`

Returns

Promise<AgentSummary>