GuidanceInstruction

Guidance instruction for the companion agent.

JSON representation
{
  "displayName": string,
  "displayDetails": string,
  "condition": string,
  "actions": [
    {
      object (Action)
    }
  ],
  "triggerEvent": enum (TriggerEvent),
  "disableSuggestedReply": boolean
}
Fields
displayName

string

Optional. Display name for the instruction. This name should be unique within the companion agent.

displayDetails

string

Optional. The detailed description of this instruction.

condition

string

Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.

actions[]

object (Action)

Optional. The action items that can be processed.

triggerEvent

enum (TriggerEvent)

Optional. Event that triggers the guidance instruction. If UNSPECIFIED, the instruction triggering will be the same as the skill's skillTriggeringEvent.

disableSuggestedReply

boolean

Optional. Whether to disable suggested reply generation for this instruction. When set to true, guidance generated from this instruction will not include a suggested reply. Default is false (suggested reply enabled).

Action

Actions to take, including agent action and system action (automation).

JSON representation
{
  "description": string
}
Fields
description

string

Required. Description of action item. It can be a agent action (e.g. "Send a message to the customer", "greet the customer") or system action (e.g. "Update the ticket", "Create a task", "cancel the order").

TriggerEvent

Event that triggers companion agent skills and guidance instructions.

Enums
TRIGGER_EVENT_UNSPECIFIED Default value for TriggerEvent. For skillTriggeringEvent, UNSPECIFIED defaults to CUSTOMER_MESSAGE. For instruction triggerEvent, UNSPECIFIED defaults to the skill's skillTriggeringEvent.
END_OF_UTTERANCE Triggers when each chat message or voice utterance ends.
CUSTOMER_MESSAGE Triggers after each customer message.
AGENT_MESSAGE Triggers after each agent message.