ModelAgents module

Escalation

A model in the Agents module, with 19 members for templates, 16 API properties and 19 members for admin templates.

Agents\Models\Frontend\Escalation Agents\Models\Api\Escalation Agents\Models\Backend\Escalation Also in Agents: Install 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 19

Take no arguments.

# isAwaitingResponse()
bool
Whether this escalation still needs a human answer
# getQuestionHtml()
string
Render the agent-authored question as HTML. The stored question is markdown produced by the agent, so the respond page gets a formatted block rather than raw markdown source — the same treatment the decision summary gets in \Agents\Models\Invocation::getDecisionSummaryHtml(). Parsedown safe mode is on because the content is model-generated and therefore untrusted.
# getResponseType()
string
The kind of answer the escalation expects: RESPONSE_TYPE_ENUM when the schema declares fixed options, otherwise RESPONSE_TYPE_FREETEXT.
# getResponseOptions()
array
The fixed answer choices for an enum escalation, or an empty array for a free-text one.
# getId()
?int
# getQuestion()
?string
# getResponseSchema()
?array
# getRespondedAt()
?DateTime
# getResponseValue()
?array
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getAssigneeGroup()
?Group
# getBatchAction()
?BatchAction
# getNotification()
?Notification
# getAssigneeUser()
?User
# getRespondedBy()
?User
# 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 16

Read-only values on the record.

# awaitingResponse
bool
Whether this escalation still needs a human answer
# questionHtml
string
Render the agent-authored question as HTML. The stored question is markdown produced by the agent, so the respond page gets a formatted block rather than raw markdown source — the same treatment the decision summary gets in \Agents\Models\Invocation::getDecisionSummaryHtml(). Parsedown safe mode is on because the content is model-generated and therefore untrusted.
# responseType
string
The kind of answer the escalation expects: RESPONSE_TYPE_ENUM when the schema declares fixed options, otherwise RESPONSE_TYPE_FREETEXT.
# responseOptions
array
The fixed answer choices for an enum escalation, or an empty array for a free-text one.
# id
?int
# question
?string
# responseSchema
?array
# respondedAt
?DateTime
# responseValue
?array
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# assigneeGroup
?Group
# batchAction
?BatchAction
# notification
?Notification
# assigneeUser
?User
# respondedBy
?User

Admin view

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

Properties 19

Take no arguments.

# isAwaitingResponse()
bool
Whether this escalation still needs a human answer
# getQuestionHtml()
string
Render the agent-authored question as HTML. The stored question is markdown produced by the agent, so the respond page gets a formatted block rather than raw markdown source — the same treatment the decision summary gets in \Agents\Models\Invocation::getDecisionSummaryHtml(). Parsedown safe mode is on because the content is model-generated and therefore untrusted.
# getResponseType()
string
The kind of answer the escalation expects: RESPONSE_TYPE_ENUM when the schema declares fixed options, otherwise RESPONSE_TYPE_FREETEXT.
# getResponseOptions()
array
The fixed answer choices for an enum escalation, or an empty array for a free-text one.
# getId()
?int
# getQuestion()
?string
# getResponseSchema()
?array
# getRespondedAt()
?DateTime
# getResponseValue()
?array
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getAssigneeGroup()
?Group
# getBatchAction()
?BatchAction
# getNotification()
?Notification
# getAssigneeUser()
?User
# getRespondedBy()
?User
# 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