CesToolSpec

Spec of CES tool that the generator can choose from.

JSON representation
{
  "cesTool": string,
  "confirmationRequirement": enum (ConfirmationRequirement),
  "parameterOverrides": [
    {
      object (ParameterOverride)
    }
  ],
  "proactiveEnabled": boolean,
  "reactiveEnabled": boolean
}
Fields
cesTool

string

Optional. Format: projects/<Project ID>/locations/<Location ID>/apps/<app ID>/tools/<tool ID>.

confirmationRequirement

enum (ConfirmationRequirement)

Optional. Indicates whether the tool requires human confirmation.

parameterOverrides[]

object (ParameterOverride)

Optional. Only applicable for CompanionAgent. Overrides for the tool's input parameters. When the tool is called, each listed parameter is set to the value found in the ingested context references, populating it if omitted by the model or replacing any value predicted by the model. Duplicate entries for the same parameterName are disallowed and rejected during Companion Agent validation.

proactiveEnabled

boolean

Optional. Only applicable for CompanionAgent. Indicates whether the tool is enabled in proactive mode. All tools are enabled in proactive mode by default. To disable a tool in proactive mode, set this field to false. NOTE: At least one of proactiveEnabled or reactiveEnabled should be true else the tool will be ignored.

reactiveEnabled

boolean

Optional. Only applicable for CompanionAgent. Indicates whether the tool is enabled in reactive mode. Currently supported tools are: - CX Agent Studio [GoogleSearchTool][google.cloud.ces.v1main.GoogleSearchTool]: Represents a tool to perform Google web searches for grounding. See: https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/search) - CX Agent Studio [DataStoreTool][google.cloud.ces.v1main.DataStoreTool]: Tool to retrieve from Vertex AI Search datastore or engine for grounding. See: https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/data-store)

All tools are disabled in reactive mode by default. To enable a tool in reactive mode, set this field to true. NOTE: - At least one of reactiveEnabled or proactiveEnabled should be true else the tool will be ignored. - CompanionAgent config will throw an error if any unsupported tool is enabled in reactive mode.