Skip to content
PrefactorPrefactorPrefactor Docs

Type Alias: AgentInstanceOptions

Prefactor TypeScript SDK

Prefactor TypeScript SDK / @prefactor/core / AgentInstanceOptions

Type Alias: AgentInstanceOptions

Section titled “Type Alias: AgentInstanceOptions”

AgentInstanceOptions = object

Defined in: packages/core/src/transport/http.ts:33

Properties

Section titled “Properties”

agentId?

Section titled “agentId?”

optional agentId: string

Defined in: packages/core/src/transport/http.ts:35

Existing backend agent id, when available.

agentIdentifier?

Section titled “agentIdentifier?”

optional agentIdentifier: string

Defined in: packages/core/src/transport/http.ts:37

External agent version identifier.

agentName?

Section titled “agentName?”

optional agentName: string

Defined in: packages/core/src/transport/http.ts:39

Human-readable agent name.

agentDescription?

Section titled “agentDescription?”

optional agentDescription: string

Defined in: packages/core/src/transport/http.ts:41

Human-readable agent description.

purpose?

Section titled “purpose?”

optional purpose: "live" | "smoke_test" | "eval"

Defined in: packages/core/src/transport/http.ts:43

Why this instance ran: ‘live’ for an actual agent run, ‘smoke_test’ for a pipeline check, or ‘eval’ for an evaluation run. Omit to let the API default to ‘live’.