Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

GenAiPluginInstructionDef

Represents a topic instruction.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

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

Version

GenAiPluginInstructionDef components are available in API version 62.0 and later.

Special Access Rules

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

Fields

Field Name	Description
description	Field Type string Description Required. Description of the topic instruction.
developerName	Field Type string 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	Field Type string Description Required. The language of the topic instruction.
masterLabel	Field Type string Description Required. The master label for the topic instruction.
sortOrder	Field Type integer Description A numerical value used to determine the order the instructions will be executed in.

Declarative Metadata Sample Definition

See GenAiPlugin.

Metadata API Developer Guide