IAgentInstruction
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A rule an agent follows when answering, such as a business definition or how to handle a kind of request. Carried inside IAgent.instructions.
Instructions have no identifier: they live and die with their agent, and the backend addresses them by position. Writing an agent replaces its whole list.
export interface IAgentInstruction
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) The rule the agent follows when answering. Required, must not be blank. | ||
boolean | (ALPHA) (Optional) Whether the instruction is disabled. | ||
(ALPHA) Required — the backend rejects a payload that omits it. | |||
string | (ALPHA) (Optional) Short name shown in the agent builder. |
Property details
IAgentInstruction.contentpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The rule the agent follows when answering. Required, must not be blank.
content: string;
IAgentInstruction.isDisabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the instruction is disabled.
isDisabled?: boolean;
IAgentInstruction.strategypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Required — the backend rejects a payload that omits it.
strategy: AgentInstructionStrategy;
IAgentInstruction.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Short name shown in the agent builder.
title?: string;