google-cloud-dialogflow-cx-v3 0.11.0 → 0.13.0

data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb

@@ -224,13 +224,11 @@ module Google
               #   # Call the list_intents method.
               #   result = client.list_intents request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Intent.
-              #     p response
+              #     p item
               #   end
               #
               def list_intents request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb

@@ -234,13 +234,11 @@ module Google
               #   # Call the list_pages method.
               #   result = client.list_pages request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Page.
-              #     p response
+              #     p item
               #   end
               #
               def list_pages request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb

@@ -479,13 +479,11 @@ module Google
               #   # Call the list_security_settings method.
               #   result = client.list_security_settings request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::SecuritySettings.
-              #     p response
+              #     p item
               #   end
               #
               def list_security_settings request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb

@@ -216,13 +216,11 @@ module Google
               #   # Call the list_session_entity_types method.
               #   result = client.list_session_entity_types request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::SessionEntityType.
-              #     p response
+              #     p item
               #   end
               #
               def list_session_entity_types request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb

@@ -315,22 +315,22 @@ module Google
               #   # Create a client object. The client can be reused for multiple calls.
               #   client = Google::Cloud::Dialogflow::CX::V3::Sessions::Client.new
               #
-              #   # Create an input stream
+              #   # Create an input stream.
               #   input = Gapic::StreamInput.new
               #
               #   # Call the streaming_detect_intent method to start streaming.
               #   output = client.streaming_detect_intent input
               #
-              #   # Send requests on the stream. For each request, pass in keyword
-              #   # arguments to set fields. Be sure to close the stream when done.
+              #   # Send requests on the stream. For each request object, set fields by
+              #   # passing keyword arguments. Be sure to close the stream when done.
               #   input << Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest.new
               #   input << Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest.new
               #   input.close
               #
-              #   # Handle streamed responses. These may be interleaved with inputs.
-              #   # Each response is of type ::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentResponse.
-              #   output.each do |response|
-              #     p response
+              #   # The returned object is a streamed enumerable yielding elements of type
+              #   # ::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentResponse
+              #   output.each do |current_response|
+              #     p current_response
               #   end
               #
               def streaming_detect_intent request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb

@@ -228,13 +228,11 @@ module Google
               #   # Call the list_test_cases method.
               #   result = client.list_test_cases request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::TestCase.
-              #     p response
+              #     p item
               #   end
               #
               def list_test_cases request, options = nil
@@ -688,14 +686,14 @@ module Google
               #   # Call the run_test_case method.
               #   result = client.run_test_case request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def run_test_case request, options = nil
@@ -798,14 +796,14 @@ module Google
               #   # Call the batch_run_test_cases method.
               #   result = client.batch_run_test_cases request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def batch_run_test_cases request, options = nil
@@ -1003,14 +1001,14 @@ module Google
               #   # Call the import_test_cases method.
               #   result = client.import_test_cases request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def import_test_cases request, options = nil
@@ -1132,14 +1130,14 @@ module Google
               #   # Call the export_test_cases method.
               #   result = client.export_test_cases request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def export_test_cases request, options = nil
@@ -1258,13 +1256,11 @@ module Google
               #   # Call the list_test_case_results method.
               #   result = client.list_test_case_results request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::TestCaseResult.
-              #     p response
+              #     p item
               #   end
               #
               def list_test_case_results request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb

@@ -159,13 +159,11 @@ module Google
               #   # Call the list_operations method.
               #   result = client.list_operations request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Longrunning::Operation.
-              #     p response
+              #     p item
               #   end
               #
               def list_operations request, options = nil
@@ -254,14 +252,14 @@ module Google
               #   # Call the get_operation method.
               #   result = client.get_operation request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def get_operation request, options = nil
@@ -541,14 +539,14 @@ module Google
               #   # Call the wait_operation method.
               #   result = client.wait_operation request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def wait_operation request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb

@@ -227,13 +227,11 @@ module Google
               #   # Call the list_transition_route_groups method.
               #   result = client.list_transition_route_groups request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup.
-              #     p response
+              #     p item
               #   end
               #
               def list_transition_route_groups request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/version.rb

@@ -22,7 +22,7 @@ module Google
     module Dialogflow
       module CX
         module V3
-          VERSION = "0.11.0"
+          VERSION = "0.13.0"
         end
       end
     end

data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb

@@ -11,6 +11,7 @@ require 'google/cloud/dialogflow/cx/v3/flow_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb

@@ -226,13 +226,11 @@ module Google
               #   # Call the list_versions method.
               #   result = client.list_versions request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Version.
-              #     p response
+              #     p item
               #   end
               #
               def list_versions request, options = nil
@@ -419,14 +417,14 @@ module Google
               #   # Call the create_version method.
               #   result = client.create_version request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def create_version request, options = nil
@@ -703,14 +701,14 @@ module Google
               #   # Call the load_version method.
               #   result = client.load_version request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def load_version request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb

@@ -159,13 +159,11 @@ module Google
               #   # Call the list_operations method.
               #   result = client.list_operations request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Longrunning::Operation.
-              #     p response
+              #     p item
               #   end
               #
               def list_operations request, options = nil
@@ -254,14 +252,14 @@ module Google
               #   # Call the get_operation method.
               #   result = client.get_operation request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def get_operation request, options = nil
@@ -541,14 +539,14 @@ module Google
               #   # Call the wait_operation method.
               #   result = client.wait_operation request
               #
-              #   # The returned object is of type Gapic::Operation. You can use this
-              #   # object to check the status of an operation, cancel it, or wait
-              #   # for results. Here is how to block until completion:
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
               #   result.wait_until_done! timeout: 60
               #   if result.response?
               #     p result.response
               #   else
-              #     puts "Error!"
+              #     puts "No response received."
               #   end
               #
               def wait_operation request, options = nil

data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb

@@ -211,13 +211,11 @@ module Google
               #   # Call the list_webhooks method.
               #   result = client.list_webhooks request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Webhook.
-              #     p response
+              #     p item
               #   end
               #
               def list_webhooks request, options = nil

data/proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb

@@ -33,6 +33,13 @@ module Google
           # levels define DTMF detections running in parallel.
           #
           # Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
+          # @!attribute [rw] audio_export_gcs_destination
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::GcsDestination]
+          #     If present, incoming audio is exported by Dialogflow to the configured
+          #     Google Cloud Storage destination.
+          #     Exposed at the following levels:
+          #     - Agent level
+          #     - Flow level
           # @!attribute [rw] logging_settings
           #   @return [::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings::LoggingSettings]
           #     Settings for logging.

data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb

@@ -116,6 +116,10 @@ module Google
           #   @return [::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings]
           #     Hierarchical advanced settings for this agent. The settings exposed at the
           #     lower level overrides the settings exposed at the higher level.
+          # @!attribute [rw] text_to_speech_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings]
+          #     Settings on instructing the speech synthesizer on how to generate the
+          #     output audio content.
           class Agent
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -242,6 +246,9 @@ module Google
 
               # Agent content will be exported as raw bytes.
               BLOB = 1
+
+              # Agent content will be exported in JSON Package format.
+              JSON_PACKAGE = 4
             end
           end
 

data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb

@@ -185,6 +185,26 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Settings related to speech generating.
+          # @!attribute [rw] synthesize_speech_configs
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::SynthesizeSpeechConfig}]
+          #     Configuration of how speech should be synthesized, mapping from
+          #     language (https://dialogflow.com/docs/reference/language) to
+          #     SynthesizeSpeechConfig.
+          class TextToSpeechSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::SynthesizeSpeechConfig]
+            class SynthesizeSpeechConfigsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # Audio encoding of the audio content sent in the conversational query request.
           # Refer to the
           # [Cloud Speech API

data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb

@@ -45,8 +45,8 @@ module Google
           #     500 characters. If exceeded, the request is rejected.
           # @!attribute [rw] version_configs
           #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Environment::VersionConfig>]
-          #     Required. A list of configurations for flow versions. You should include
-          #     version configs for all flows that are reachable from [`Start
+          #     A list of configurations for flow versions. You should include version
+          #     configs for all flows that are reachable from [`Start
           #     Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
           #     returned.
           # @!attribute [r] update_time

data/proto_docs/google/cloud/dialogflow/cx/v3/gcs.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 CX
+        module V3
+          # Google Cloud Storage location for a Dialogflow operation that writes or
+          # exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
+          # @!attribute [rw] uri
+          #   @return [::String]
+          #     Required. The Google Cloud Storage URI for the exported objects. A URI is
+          #     of the form:
+          #       gs://bucket/object-name-or-prefix
+          #     Whether a full object name, or just a prefix, its usage depends on the
+          #     Dialogflow operation.
+          class GcsDestination
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end