CompanionSuggestion

Represents a companion suggestion answer.

JSON representation 
{
  "guidances": [
    {
      object (Guidance)
    }
  ]
}
Fields
guidances[]

object (Guidance)

List of guidances generated by the Companion Agent.

Guidance

Represents guidance for companion suggestion.

JSON representation 
{
  "suggestedReply": string,
  "suggestedAction": string,
  "instructionSource": {
    object (GuidanceInstruction)
  },
  "knowledgeSources": [
    {
      object (KnowledgeSource)
    }
  ],
  "explanation": string,
  "toolCalls": [
    {
      object (ToolCallSuggestion)
    }
  ],
  "triggeringToolCallAnswerRecords": [
    string
  ],
  "groundingMetadata": {
    object (GroundingMetadata)
  }
}
Fields
suggestedReply

string

Suggested reply for the agent to respond to the customer.
suggestedAction

string

Suggested action to human agent. For example, "Ask the customer for their shipping address" or "Create a new case for the customer".
instructionSource

object (GuidanceInstruction)

Guidance instruction source.
knowledgeSources[]

object (KnowledgeSource)

Knowledge sources.
explanation

string

Optional. A brief explanation of why the action is suggested.
toolCalls[]

object (ToolCallSuggestion)

Optional. Rich structured tool calls and their associated citations delivered directly as suggestions.
triggeringToolCallAnswerRecords[]

string

Optional. The AnswerRecords of the tool calls that triggered this guidance. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.
groundingMetadata

object (GroundingMetadata)

Optional. Grounding metadata for the generated guidance.

KnowledgeSource

Represents a knowledge source for the guidance.

JSON representation 
{
  "knowledgeArticleUrl": string,
  "knowledgeArticleTitle": string,
  "knowledgeSnippet": string
}
Fields
knowledgeArticleUrl

string

URL of the knowledge article.
knowledgeArticleTitle

string

Knowledge article title.
knowledgeSnippet

string

Knowledge snippet.