GenAiPlannerDefinition

Represents an agent planner service that uses a large language model (LLM) and a reasoning strategy to decompose a given task into smaller subtasks, identify the most suitable actions for each subtask, and invoke them.

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 

AgentGraph 

• Type: textarea
• Required: No
• Properties: Nillable
• Introduced: API version 64.0

AgentGraphRefId 

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

AgentScriptRefId 

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

Capabilities 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A set of tags associated with the agent planner service definition.

Description 

• Type: textarea

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A description explaining the general purpose and domain of the agent planner service definition.

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

• Introduced: API version 60.0

• Description: The full name of the associated object in Metadata API. The full name can include a namespace prefix.

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the GenAiPlannerDefinition. 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

LinkedBotVersionId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort

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 of the agent planner service definition.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the GenAiPlannerDefinition.

PlannerType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: A particular approach to problem solving that is given as prompt instructions to a large language model (LLM).

• Possible values:

  • AiCopilot__SequentialPlannerIntentClassifier — Sequential Intent Classifier — Uses an intent classifier prompt and a sequential planner prompt. With each text input, the planner asks the LLM to generate a step-by-step plan to finish the goal. It plans first, then executes.

  • AiCopilot__ReAct — ReAct — Uses a reactive planning strategy to solve problems with the LLM. This strategy consists of prompting the LLM to generate the next step in response to an event and the current context. It differs from a sequential planner in that it doesn’t plan more than one step ahead of time.

  • AiCopilot__AgileAppDev — AiCopilot__AgileAppDev

  • Atlas__ConcurrentMultiAgentOrchestration — Concurrent Multi-Agent Orchestration

  • SentOS__SearchAgent — SentOS__SearchAgent

  • Atlas__VoiceAgent — Atlas__VoiceAgent

  • BYOP__waiiplanner — BYOP__waiiplanner