WidgetTool

import type { WidgetTool } from "https://googleapis.deno.dev/v1/ces:v1.ts";

Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.

interface WidgetTool {

description?: string;

name?: string;

parameters?: Schema;

widgetType?:

| "WIDGET_TYPE_UNSPECIFIED"

| "CUSTOM"

| "PRODUCT_CAROUSEL"

| "PRODUCT_DETAILS"

| "QUICK_ACTIONS"

| "PRODUCT_COMPARISON"

| "ADVANCED_PRODUCT_DETAILS"

| "SHORT_FORM"

| "OVERALL_SATISFACTION"

| "ORDER_SUMMARY";

}

§Properties

description?: string

[src]

Optional. The description of the widget tool.

name?: string

[src]

Required. The display name of the widget tool.

parameters?: Schema

[src]

Optional. The input parameters of the widget tool.

[src]

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.