REST Resource: projects.locations.companionAgents

Resource: CompanionAgent

Companion agent.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "toolsetTools": [
    {
      object (ToolsetTool)
    }
  ],
  "cesToolSpecs": [
    {
      object (CesToolSpec)
    }
  ],
  "displayName": string,
  "description": string,
  "skillConfigs": [
    {
      object (SkillConfig)
    }
  ]
}
Fields
name

string

Identifier. The unique identifier of the companion agent. Format: projects/{project}/locations/{location}/companionAgents/{companionAgent}
createTime

string (Timestamp format)

Output only. Creation time of this companion agent.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update time of this companion agent.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
toolsetTools[]

object (ToolsetTool)

Optional. List of CES toolset specs that the companion agent can choose from.
cesToolSpecs[]

object (CesToolSpec)

Optional. List of CES tool specs that the companion agent can choose from.
displayName

string

Optional. Display name for the companion agent. Character limit is 63.
description

string

Optional. Description for the companion agent.
skillConfigs[]

object (SkillConfig)

Optional. List of skill configs for the companion agent. Allows at most one instance of each SkillConfig type.

SkillConfig

Skill configuration for the companion agent.

JSON representation 
{
  "skillTriggeringEvent": enum (SkillTriggerEvent),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "guidanceSkillConfig": {
    object (GuidanceSkillConfig)
  },
  "translationSkillConfig": {
    object (TranslationSkillConfig)
  }
  // End of mutually exclusive fields.
}
Fields
skillTriggeringEvent

enum (SkillTriggerEvent)

Optional. The event that should trigger the skill.
Each SkillConfig will be one of the following specific skill configs. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
guidanceSkillConfig

object (GuidanceSkillConfig)

Optional. Guidance skill configuration.
translationSkillConfig

object (TranslationSkillConfig)

Optional. Translation skill configuration.
End of mutually exclusive fields.

GuidanceSkillConfig

Guidance skill configuration.

JSON representation 
{
  "guidanceInstructions": [
    {
      object (GuidanceInstruction)
    }
  ],
  "overarchingGuidance": string,
  "knowledgeSource": {
    object (KnowledgeSource)
  }
}
Fields
guidanceInstructions[]

object (GuidanceInstruction)

Optional. Customized instructions for guidance.
overarchingGuidance

string

Optional. This is specific additional guidance that can configured by the user.
knowledgeSource

object (KnowledgeSource)

Optional. Knowledge source configuration for guidance.

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.

KnowledgeSource

This type has no fields.

Knowledge source configuration for knowledge retrieval.

TranslationSkillConfig

Translation skill configuration for the companion agent.

JSON representation 
{
  "agentLanguageCode": string,
  "customerLanguageCode": string
}
Fields
agentLanguageCode

string

Optional. Target language code for the agent, in IETF BCP-47 format (e.g., "en-US").
customerLanguageCode

string

Optional. Target language code for the customer, in IETF BCP-47 format (e.g., "es").

SkillTriggerEvent

The event that should trigger the skill.

Enums
SKILL_TRIGGER_EVENT_UNSPECIFIED Default value for SkillTriggerEvent.
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.

Methods

create

 Creates a companion agent.

delete

 Deletes a companion agent.

get

 Gets a companion agent.

list

 Lists companion agents.

patch

 Updates a companion agent.