mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
89 lines
4.5 KiB
JSON
89 lines
4.5 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules"
|
||
],
|
||
"title": "GenAiPluginDefinition - Data API",
|
||
"description": "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.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"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."
|
||
}
|
||
},
|
||
"special_access_rules": "To access this object, Agents must be enabled in your org.\n\nTo access this object, Agents must be enabled in\n your org."
|
||
} |