AIOverview

AI generated overview for the search results.

JSON representation 
{
  "ai_summary": string,
  "suggestions": [
    {
      object (Action)
    }
  ],
  "complete": boolean
}
Fields
ai_summary

string

AI summary for the search results. Markdown formatted.
suggestions[]

object (Action)

Suggested actions to continue the investigation in chat.
complete

boolean

Whether AI overview generation is complete.

Action

Action represents an action that can be performed in the host UI.

JSON representation 
{
  "display_text": string,
  "action_type": enum (ActionType),
  "use_case_id": string,

  // Union field action_metadata can be only one of the following:
  "follow_up": {
    object (FollowUp)
  },
  "navigation": {
    object (Navigation)
  },
  "execution": {
    object (Execution)
  }
  // End of list of possible types for union field action_metadata.
}
Fields
display_text

string

Output only. The text that'll be displayed to the user if this is rendered in the UI as a suggested action.
action_type

enum (ActionType)

Output only. Type of action.
use_case_id

string

Output only. The use case ID of the action. It's used internally to identify in which context the action is used.
Union field action_metadata. Depending on the action type, the corresponding action metadata must be populated. action_metadata can be only one of the following:
follow_up

object (FollowUp)

Metadata for follow up action.
navigation

object (Navigation)

Metadata for navigation action.
execution

object (Execution)

Metadata for execution action.

FollowUp

FollowUp can be used to store metadata required to send a follow up message by the UI.

JSON representation 
{
  "follow_up": string
}
Fields
follow_up

string

Output only. The text to use as input when generating the follow up message.

Execution

Execution can be used to store metadata required for what action the UI should execute.

JSON representation 
{
  "metadata": {
    string: string,
    ...
  }
}
Fields
metadata

map (key: string, value: string)

Output only. The payload to use when executing the action.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.