IAgentInstruction
Home > @gooddata/sdk-model > IAgentInstruction
IAgentInstruction interface
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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.
Signature:
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. |