google-cloud-dialogflow-v2 1.12.1 → 1.13.0

data/lib/google/cloud/dialogflow/v2/tools/rest/service_stub.rb

@@ -0,0 +1,388 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/dialogflow/v2/tool_pb"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        module Tools
+          module Rest
+            ##
+            # REST service stub for the Tools service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                             endpoint_template: endpoint_template,
+                                                             universe_domain: universe_domain,
+                                                             credentials: credentials,
+                                                             numeric_enums: true,
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
+              end
+
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @client_stub.universe_domain
+              end
+
+              ##
+              # The effective endpoint
+              #
+              # @return [String]
+              #
+              def endpoint
+                @client_stub.endpoint
+              end
+
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
+              ##
+              # Baseline implementation for the create_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::CreateToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Dialogflow::V2::Tool]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::Tool]
+              #   A result object deserialized from the server's reply
+              def create_tool request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_create_tool_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "create_tool",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Dialogflow::V2::Tool.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
+              ##
+              # Baseline implementation for the get_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::GetToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Dialogflow::V2::Tool]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::Tool]
+              #   A result object deserialized from the server's reply
+              def get_tool request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_get_tool_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_tool",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Dialogflow::V2::Tool.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
+              ##
+              # Baseline implementation for the list_tools REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::ListToolsRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Dialogflow::V2::ListToolsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::ListToolsResponse]
+              #   A result object deserialized from the server's reply
+              def list_tools request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_tools_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_tools",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Dialogflow::V2::ListToolsResponse.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
+              ##
+              # Baseline implementation for the delete_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::DeleteToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Protobuf::Empty]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Protobuf::Empty]
+              #   A result object deserialized from the server's reply
+              def delete_tool request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_delete_tool_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_tool",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
+              ##
+              # Baseline implementation for the update_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::UpdateToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Dialogflow::V2::Tool]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::Tool]
+              #   A result object deserialized from the server's reply
+              def update_tool request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_update_tool_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "update_tool",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Dialogflow::V2::Tool.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the create_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::CreateToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_create_tool_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/tools",
+                                                          body: "tool",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the get_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::GetToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_get_tool_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v2/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/tools/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_tools REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::ListToolsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_list_tools_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v2/{parent}/tools",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the delete_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::DeleteToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_delete_tool_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :delete,
+                                                          uri_template: "/v2/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/tools/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the update_tool REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::UpdateToolRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_update_tool_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :patch,
+                                                          uri_template: "/v2/{tool.name}",
+                                                          body: "tool",
+                                                          matches: [
+                                                            ["tool.name", %r{^projects/[^/]+/locations/[^/]+/tools/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dialogflow/v2/tools/rest.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/v2/version"
+require "google/cloud/dialogflow/v2/bindings_override"
+
+require "google/cloud/dialogflow/v2/tools/credentials"
+require "google/cloud/dialogflow/v2/tools/paths"
+require "google/cloud/dialogflow/v2/tools/rest/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        ##
+        # Tool Service for LLM powered Agent Assist. Tools can be used to interact with
+        # remote APIs (e.g. fetching orders) to retrieve additional information as
+        # input to LLM.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/dialogflow/v2/tools/rest"
+        #     client = ::Google::Cloud::Dialogflow::V2::Tools::Rest::Client.new
+        #
+        module Tools
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/dialogflow/v2/tools/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/dialogflow/v2/tools.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/v2/version"
+
+require "google/cloud/dialogflow/v2/tools/credentials"
+require "google/cloud/dialogflow/v2/tools/paths"
+require "google/cloud/dialogflow/v2/tools/client"
+require "google/cloud/dialogflow/v2/tools/rest"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        ##
+        # Tool Service for LLM powered Agent Assist. Tools can be used to interact with
+        # remote APIs (e.g. fetching orders) to retrieve additional information as
+        # input to LLM.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/dialogflow/v2/tools"
+        #     client = ::Google::Cloud::Dialogflow::V2::Tools::Client.new
+        #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/dialogflow/v2/tools/rest"
+        #     client = ::Google::Cloud::Dialogflow::V2::Tools::Rest::Client.new
+        #
+        module Tools
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "tools", "helpers.rb"
+require "google/cloud/dialogflow/v2/tools/helpers" if ::File.file? helper_path

data/lib/google/cloud/dialogflow/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Dialogflow
       module V2
-        VERSION = "1.12.1"
+        VERSION = "1.13.0"
       end
     end
   end

data/lib/google/cloud/dialogflow/v2/webhook_pb.rb

@@ -4,6 +4,7 @@
 
 require 'google/protobuf'
 
+require 'google/api/resource_pb'
 require 'google/cloud/dialogflow/v2/context_pb'
 require 'google/cloud/dialogflow/v2/intent_pb'
 require 'google/cloud/dialogflow/v2/session_pb'
@@ -11,7 +12,7 @@ require 'google/cloud/dialogflow/v2/session_entity_type_pb'
 require 'google/protobuf/struct_pb'
 
 
-descriptor_data = "\n(google/cloud/dialogflow/v2/webhook.proto\x12\x1agoogle.cloud.dialogflow.v2\x1a(google/cloud/dialogflow/v2/context.proto\x1a\'google/cloud/dialogflow/v2/intent.proto\x1a(google/cloud/dialogflow/v2/session.proto\x1a\x34google/cloud/dialogflow/v2/session_entity_type.proto\x1a\x1cgoogle/protobuf/struct.proto\"\xd6\x01\n\x0eWebhookRequest\x12\x0f\n\x07session\x18\x04 \x01(\t\x12\x13\n\x0bresponse_id\x18\x01 \x01(\t\x12=\n\x0cquery_result\x18\x02 \x01(\x0b\x32\'.google.cloud.dialogflow.v2.QueryResult\x12_\n\x1eoriginal_detect_intent_request\x18\x03 \x01(\x0b\x32\x37.google.cloud.dialogflow.v2.OriginalDetectIntentRequest\"\x80\x03\n\x0fWebhookResponse\x12\x18\n\x10\x66ulfillment_text\x18\x01 \x01(\t\x12H\n\x14\x66ulfillment_messages\x18\x02 \x03(\x0b\x32*.google.cloud.dialogflow.v2.Intent.Message\x12\x0e\n\x06source\x18\x03 \x01(\t\x12(\n\x07payload\x18\x04 \x01(\x0b\x32\x17.google.protobuf.Struct\x12<\n\x0foutput_contexts\x18\x05 \x03(\x0b\x32#.google.cloud.dialogflow.v2.Context\x12\x44\n\x14\x66ollowup_event_input\x18\x06 \x01(\x0b\x32&.google.cloud.dialogflow.v2.EventInput\x12K\n\x14session_entity_types\x18\n \x03(\x0b\x32-.google.cloud.dialogflow.v2.SessionEntityType\"h\n\x1bOriginalDetectIntentRequest\x12\x0e\n\x06source\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\x12(\n\x07payload\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructB\x92\x01\n\x1e\x63om.google.cloud.dialogflow.v2B\x0cWebhookProtoP\x01Z>cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb\xa2\x02\x02\x44\x46\xaa\x02\x1aGoogle.Cloud.Dialogflow.V2b\x06proto3"
+descriptor_data = "\n(google/cloud/dialogflow/v2/webhook.proto\x12\x1agoogle.cloud.dialogflow.v2\x1a\x19google/api/resource.proto\x1a(google/cloud/dialogflow/v2/context.proto\x1a\'google/cloud/dialogflow/v2/intent.proto\x1a(google/cloud/dialogflow/v2/session.proto\x1a\x34google/cloud/dialogflow/v2/session_entity_type.proto\x1a\x1cgoogle/protobuf/struct.proto\"\xd6\x01\n\x0eWebhookRequest\x12\x0f\n\x07session\x18\x04 \x01(\t\x12\x13\n\x0bresponse_id\x18\x01 \x01(\t\x12=\n\x0cquery_result\x18\x02 \x01(\x0b\x32\'.google.cloud.dialogflow.v2.QueryResult\x12_\n\x1eoriginal_detect_intent_request\x18\x03 \x01(\x0b\x32\x37.google.cloud.dialogflow.v2.OriginalDetectIntentRequest\"\x80\x03\n\x0fWebhookResponse\x12\x18\n\x10\x66ulfillment_text\x18\x01 \x01(\t\x12H\n\x14\x66ulfillment_messages\x18\x02 \x03(\x0b\x32*.google.cloud.dialogflow.v2.Intent.Message\x12\x0e\n\x06source\x18\x03 \x01(\t\x12(\n\x07payload\x18\x04 \x01(\x0b\x32\x17.google.protobuf.Struct\x12<\n\x0foutput_contexts\x18\x05 \x03(\x0b\x32#.google.cloud.dialogflow.v2.Context\x12\x44\n\x14\x66ollowup_event_input\x18\x06 \x01(\x0b\x32&.google.cloud.dialogflow.v2.EventInput\x12K\n\x14session_entity_types\x18\n \x03(\x0b\x32-.google.cloud.dialogflow.v2.SessionEntityType\"h\n\x1bOriginalDetectIntentRequest\x12\x0e\n\x06source\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\x12(\n\x07payload\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructB\x91\x02\n\x1e\x63om.google.cloud.dialogflow.v2B\x0cWebhookProtoP\x01Z>cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb\xa2\x02\x02\x44\x46\xaa\x02\x1aGoogle.Cloud.Dialogflow.V2\xea\x41|\n\'servicedirectory.googleapis.com/Service\x12Qprojects/{project}/locations/{location}/namespaces/{namespace}/services/{service}b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 

data/lib/google/cloud/dialogflow/v2.rb

@@ -33,7 +33,10 @@ require "google/cloud/dialogflow/v2/documents"
 require "google/cloud/dialogflow/v2/encryption_spec_service"
 require "google/cloud/dialogflow/v2/fulfillments"
 require "google/cloud/dialogflow/v2/environments"
+require "google/cloud/dialogflow/v2/generator_evaluations"
 require "google/cloud/dialogflow/v2/knowledge_bases"
+require "google/cloud/dialogflow/v2/sip_trunks"
+require "google/cloud/dialogflow/v2/tools"
 require "google/cloud/dialogflow/v2/versions"
 require "google/cloud/dialogflow/v2/version"
 

data/proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        # Agent Coaching instructions that customer can configure.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. Display name for the instruction.
+        # @!attribute [rw] display_details
+        #   @return [::String]
+        #     Optional. The detailed description of this instruction.
+        # @!attribute [rw] condition
+        #   @return [::String]
+        #     Optional. The condition of the instruction. For example, "the customer
+        #     wants to cancel an order".  If the users want the instruction to be
+        #     triggered unconditionally, the condition can be empty.
+        # @!attribute [rw] agent_action
+        #   @return [::String]
+        #     Optional. The action that human agent should take. For example, "apologize
+        #     for the slow shipping". If the users only want to use agent coaching for
+        #     intent detection, agent_action can be empty
+        # @!attribute [rw] system_action
+        #   @return [::String]
+        #     Optional. The action that system should take. For example,
+        #     "call GetOrderTime with order_number={order number provided by the
+        #     customer}". If the users don't have plugins or don't want to trigger
+        #     plugins, the system_action can be empty
+        # @!attribute [r] duplicate_check_result
+        #   @return [::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult]
+        #     Output only. Duplication check for the AgentCoachingInstruction.
+        # @!attribute [rw] triggering_event
+        #   @return [::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::TriggerEvent]
+        #     Optional. The event that should trigger this instruction.
+        #     If UNSPECIFIED, the instruction triggering will be same as the generator's
+        #     trigger_event.
+        class AgentCoachingInstruction
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Duplication check for the suggestion.
+          # @!attribute [r] duplicate_suggestions
+          #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
+          #     Output only. The duplicate suggestions.
+          class DuplicateCheckResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The duplicate suggestion details.
+            # @!attribute [r] answer_record
+            #   @return [::String]
+            #     Output only. The answer record id of the past duplicate suggestion.
+            # @!attribute [r] suggestion_index
+            #   @return [::Integer]
+            #     Output only. The index of the duplicate suggestion in the past
+            #     suggestion list.
+            # @!attribute [r] similarity_score
+            #   @return [::Float]
+            #     Output only. The similarity score of between the past and current
+            #     suggestion.
+            class DuplicateSuggestion
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The event that should trigger this instruction.
+          module TriggerEvent
+            # Default value for TriggerEvent.
+            TRIGGER_EVENT_UNSPECIFIED = 0
+
+            # Triggers when each chat message or voice utterance ends.
+            END_OF_UTTERANCE = 1
+
+            # Triggers on the conversation manually by API calls.
+            MANUAL_CALL = 2
+
+            # Triggers after each customer message.
+            CUSTOMER_MESSAGE = 3
+
+            # Triggers after each agent message.
+            AGENT_MESSAGE = 4
+
+            # Triggers on tool call completion.
+            TOOL_CALL_COMPLETION = 5
+          end
+        end
+      end
+    end
+  end
+end