xref: /aosp_15_r20/external/googleapis/google/cloud/dialogflow/cx/v3beta1/tool_call.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.dialogflow.cx.v3beta1;
18
19import "google/api/annotations.proto";
20import "google/api/client.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23import "google/protobuf/struct.proto";
24
25option cc_enable_arenas = true;
26option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3Beta1";
27option go_package = "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb";
28option java_multiple_files = true;
29option java_outer_classname = "ToolCallProto";
30option java_package = "com.google.cloud.dialogflow.cx.v3beta1";
31option objc_class_prefix = "DF";
32option ruby_package = "Google::Cloud::Dialogflow::CX::V3beta1";
33
34// The result of calling a tool's action that has been executed by the client.
35message ToolCallResult {
36  // The [tool][Tool] associated with this call.
37  // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
38  // ID>/tools/<Tool ID>`.
39  string tool = 1 [
40    (google.api.field_behavior) = REQUIRED,
41    (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Tool" }
42  ];
43  // The name of the tool's action associated with this call.
44  string action = 2 [(google.api.field_behavior) = REQUIRED];
45  // An error produced by the tool call.
46  message Error {
47    // The error message of the function.
48    string message = 1 [(google.api.field_behavior) = OPTIONAL];
49  }
50  // The tool call's result.
51  oneof result {
52    // The tool call's error.
53    Error error = 3;
54    // The tool call's output parameters.
55    google.protobuf.Struct output_parameters = 4;
56  }
57}
58