GenAiFunctionDefinition

Represents an agent action.

Version 

Introduced in API version 59.0.

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 

Description 

• Type: textarea

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A description explaining the general purpose and domain of the action.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name for this object.

FullName 

• Type: string

• Required: No

• 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

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Target invocation used by invocation operations.

InvocationTargetType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Invocable action types used by invocation operations.

IsConfirmationRequired 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates whether confirmation is required for this action.

The default value is false.

• Default value: false

IsIncludeInProgressIndicator 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 62.0

• Description: Indicates whether the ProgressIndicatorMessage is displayed.

• Default value: false

IsLocal 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 62.0

• Default value: false

Language 

• Type: picklist

• Required: No

• 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.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

LocalDeveloperName 

• Type: string
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 65.0

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package.

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The master label for the generative AI action.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Description: Provides access to the associated type.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the GenAiFunctionDefinition.

ParentId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 62.0

• Relationship name: Parent

• Relationship type: relationship

• Refers to: GenAiPlannerFunctionDef

PlannerId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 65.0

• Relationship name: Planner

• Relationship type: relationship

• Refers to: GenAiPlannerDefinition

PluginId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 65.0

• Relationship name: Plugin

• Relationship type: relationship

• Refers to: GenAiPluginDefinition

ProgressIndicatorMessage 

• Type: textarea

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 62.0

• Description: Message displayed when an action is taking longer than expected to execute.

Source 

• Type: picklist
• Required: No
• Properties: Filter, Group, Nillable, Restricted picklist, Sort
• Introduced: API version 65.0