GenAiFunctionDefinition

Represents an agent action. This object is available in API version 60.0 and later.

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

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

Fields

Field	Details
Description	Type textarea Properties Nillable Description A description explaining the general purpose and domain of the action.
DeveloperName	Type string Properties Filter, Group, Sort Description The unique name for this object.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated object in Metadata API. The full name can include a namespace prefix.
InvocationTarget	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Target invocation used by invocation operations.
InvocationTargetType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Invocable action types used by invocation operations. Possible values are: `apex` `flow` `generatePromptResponse`
IsConfirmationRequired	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether confirmation is required for this action. The default value is `false`.
IsIncludeInProgressIndicator	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the ProgressIndicatorMessage is displayed.
Language	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the GenAiFunctionDefinition. The value for this field is the language value of the org.
MasterLabel	Type string Properties Filter, Group, Sort Description The master label for the generative AI action.
Metadata	Type complexvalue Properties Create, Nillable, Update Description Provides access to the associated type.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace of the GenAiFunctionDefinition.
ProgressIndicatorMessage	Type string Properties Filter, Group, Sort Description Message displayed when an action is taking longer than expected to execute.