GenAiPluginDefinition

Represents an agent topic, which is a category of actions related to a particular job to be done by AI agents. This object is available in API version 62.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

To access this object, Agents must be enabled in your org.

Fields

Field Details
CanEscalate
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this topic is eligible for escalation to a rep.
The default value is false.
Description
Type
textarea
Properties
Create, Update
Description
The description of the topic.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Represents the API name of the topic. 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.
IsLocal
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
This field is a calculated field and is set to true if this topic is an edited version of a standard topic.
The default value is false.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the topic.
LocalDeveloperName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique name for this topic within an agent.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The master label for the topic.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of these values.

  • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
ParentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the object that owns the topic.
This field is a polymorphic relationship field.
Relationship Name
Parent
Refers To
GenAiPlannerDefinition, GenAiPlannerFunctionDef
PlannerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The agent planner service for this topic.
This field is a relationship field.
Relationship Name
Planner
Refers To
GenAiPlannerDefinition
PluginType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Possible values are:
  • APICustomTopic
  • Topic
Scope
Type
textarea
Properties
Create, Nillable, Update
Description
A specific job description for a topic.
Source
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The optional source standard or custom topic from which this topic's configuration, including description, instructions, and utterances, is copied. If there's no value, the topic is used only within this agent version.