ModelAgents module

Install

A model in the Agents module, with 26 members for templates, 27 API properties and 30 members for admin templates.

Agents\Models\Frontend\Install Agents\Models\Api\Install Agents\Models\Backend\Install Also in Agents: Escalation Invocation Recommendation
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 26

Take no arguments.

# isForked()
bool
Whether this install is a fork carrying its own copied agent definition (system prompt, tools, model, max iterations) instead of resolving the library agent by slug.
# getId()
?int
# getLibraryAgentSlug()
?string
# getInstallType()
?string
# getParameterValues()
?array
# getActionMode()
?string
# getVetoWindowHours()
?int
# getAutoApplyConfidenceThreshold()
?string
# getEscalationUser()
?User
# getEscalationChatProvider()
?string
# getEscalationChatChannel()
?string
# getForkedSystemPrompt()
?string
# getForkedTools()
?array
# getForkedModel()
?string
# getModelTier()
?string
# getProvider()
?string
# getForkedMaxIterations()
?int
# getCreatedBy()
?User
# getModifiedBy()
?User
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getEscalationGroup()
?Group
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 27

Read-only values on the record.

# forked
bool
Whether this install is a fork carrying its own copied agent definition (system prompt, tools, model, max iterations) instead of resolving the library agent by slug.
# deleteUrl Not in Templates
?string
Get the url for deleting the record.
# editUrl Not in Templates
?string
Get the url for editing the record.
# manageUrl Not in Templates
?string
Get the url for managing records.
# id
?int
# libraryAgentSlug
?string
# installType
?string
# parameterValues
?array
# actionMode
?string
# vetoWindowHours
?int
# autoApplyConfidenceThreshold
?string
# escalationUser
?User
# escalationChatProvider
?string
# escalationChatChannel
?string
# forkedSystemPrompt
?string
# forkedTools
?array
# forkedModel
?string
# modelTier
?string
# provider
?string
# forkedMaxIterations
?int
# createdBy
?User
# modifiedBy
?User
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# escalationGroup
?Group
# site
?Site

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 30

Take no arguments.

# isForked()
bool
Whether this install is a fork carrying its own copied agent definition (system prompt, tools, model, max iterations) instead of resolving the library agent by slug.
# getDeleteUrl() Not in Templates
?string
Get the url for deleting the record.
# getEditUrl() Not in Templates
?string
Get the url for editing the record.
# getManageUrl() Not in Templates
?string
Get the url for managing records.
# getId()
?int
# getLibraryAgentSlug()
?string
# getInstallType()
?string
# getParameterValues()
?array
# getActionMode()
?string
# getVetoWindowHours()
?int
# getAutoApplyConfidenceThreshold()
?string
# getEscalationUser()
?User
# getEscalationChatProvider()
?string
# getEscalationChatChannel()
?string
# getForkedSystemPrompt()
?string
# getForkedTools()
?array
# getForkedModel()
?string
# getModelTier()
?string
# getProvider()
?string
# getForkedMaxIterations()
?int
# getCreatedBy()
?User
# getModifiedBy()
?User
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getEscalationGroup()
?Group
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned