GenAiPluginInstructionDef

Represents a topic instruction.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

GenAiPluginInstructionDef components are part of a GenAiPlugin component and aren’t used separately.

Version 

Introduced in API version 62.0.

Special Access Rules 

GenAiPluginInstructionDef is available only if Agents is enabled in your org.

Fields 

description 

• Type: string

• Required: Yes

• Description: Required.

  Description of the topic instruction.

developerName 

• Type: string

• Required: Yes

• Description: Required.

  Represents the API name of the topic instruction. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

language 

• Type: string

• Required: Yes

• Description: Required.

  The language of the topic instruction.

masterLabel 

• Type: string

• Required: Yes

• Description: Required.

  The master label for the topic instruction.

sortOrder 

• Type: int
• Required: Yes
• Description: A numerical value used to determine the order the instructions will be executed in.

Declarative Metadata Sample Definition 

See GenAiPlugin.