google-cloud-dialogflow-v2 0.7.0 → 0.10.1

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 "googleauth"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        module Versions
+          # Credentials for the Versions API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/dialogflow"
+            ]
+            self.env_vars = [
+              "DIALOGFLOW_CREDENTIALS",
+              "DIALOGFLOW_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "DIALOGFLOW_CREDENTIALS_JSON",
+              "DIALOGFLOW_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+        module Versions
+          # Path helper methods for the Versions API.
+          module Paths
+            ##
+            # Create a fully-qualified Agent resource string.
+            #
+            # @overload agent_path(project:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent`
+            #
+            #   @param project [String]
+            #
+            # @overload agent_path(project:, location:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #
+            # @return [::String]
+            def agent_path **args
+              resources = {
+                "project" => (proc do |project:|
+                  "projects/#{project}/agent"
+                end),
+                "location:project" => (proc do |project:, location:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
+            ##
+            # Create a fully-qualified Version resource string.
+            #
+            # @overload version_path(project:, version:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent/versions/{version}`
+            #
+            #   @param project [String]
+            #   @param version [String]
+            #
+            # @overload version_path(project:, location:, version:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent/versions/{version}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param version [String]
+            #
+            # @return [::String]
+            def version_path **args
+              resources = {
+                "project:version" => (proc do |project:, version:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/agent/versions/#{version}"
+                end),
+                "location:project:version" => (proc do |project:, location:, version:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent/versions/#{version}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

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

@@ -42,11 +42,9 @@ module Google
         # A typical workflow for customers provide feedback to an answer is:
         #
         # 1. For human agent assistant, customers get suggestion via ListSuggestions
-        #    API. Together with the answers,
-        #    {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} are
-        #    returned to the customers.
-        # 2. The customer uses the
-        # {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} to call the
+        #    API. Together with the answers, {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} are returned to the
+        #    customers.
+        # 2. The customer uses the {::Google::Cloud::Dialogflow::V2::AnswerRecord#name AnswerRecord.name} to call the
         #    [UpdateAnswerRecord][] method to send feedback about a specific answer
         #    that they believe is wrong.
         # @!attribute [rw] name
@@ -57,8 +55,8 @@ module Google
         # @!attribute [rw] answer_feedback
         #   @return [::Google::Cloud::Dialogflow::V2::AnswerFeedback]
         #     Required. The AnswerFeedback for this record. You can set this with
-        #     {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord}
-        #     in order to give us feedback about this answer.
+        #     {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord} in order to give us feedback about
+        #     this answer.
         # @!attribute [r] agent_assistant_record
         #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantRecord]
         #     Output only. The record for human agent assistant.
@@ -67,8 +65,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for
-        # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
+        # Request message for {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The project to list all answer records for in reverse
@@ -98,8 +95,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for
-        # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
+        # Response message for {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#list_answer_records AnswerRecords.ListAnswerRecords}.
         # @!attribute [rw] answer_records
         #   @return [::Array<::Google::Cloud::Dialogflow::V2::AnswerRecord>]
         #     The list of answer records.
@@ -116,8 +112,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for
-        # {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord}.
+        # Request message for {::Google::Cloud::Dialogflow::V2::AnswerRecords::Client#update_answer_record AnswerRecords.UpdateAnswerRecord}.
         # @!attribute [rw] answer_record
         #   @return [::Google::Cloud::Dialogflow::V2::AnswerRecord]
         #     Required. Answer record to update.
@@ -197,9 +192,7 @@ module Google
         #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentEfficiency]
         #     Optional. Whether or not the suggested document is efficient. For example,
         #     if the document is poorly written, hard to understand, hard to use or
-        #     too long to find useful information,
-        #     {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback#document_efficiency document_efficiency}
-        #     is
+        #     too long to find useful information, {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback#document_efficiency document_efficiency} is
         #     {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentEfficiency::INEFFICIENT DocumentEfficiency.INEFFICIENT}.
         class AgentAssistantFeedback
           include ::Google::Protobuf::MessageExts

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

@@ -24,7 +24,7 @@ module Google
         # Defines the services to connect to incoming Dialogflow conversations.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Optional. The unique identifier of this conversation profile.
+        #     The unique identifier of this conversation profile.
         #     Format: `projects/<Project ID>/locations/<Location
         #     ID>/conversationProfiles/<Conversation Profile ID>`.
         # @!attribute [rw] display_name
@@ -45,6 +45,9 @@ module Google
         # @!attribute [rw] human_agent_handoff_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig]
         #     Configuration for connecting to a live agent.
+        #
+        #     Currently, this feature is not general available, please contact Google
+        #     to get access.
         # @!attribute [rw] notification_config
         #   @return [::Google::Cloud::Dialogflow::V2::NotificationConfig]
         #     Configuration for publishing conversation lifecycle events.
@@ -179,6 +182,9 @@ module Google
         # @!attribute [rw] end_user_suggestion_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig]
         #     Configuration for agent assistance of end user participant.
+        #
+        #     Currently, this feature is not general available, please contact Google
+        #     to get access.
         # @!attribute [rw] message_analysis_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::MessageAnalysisConfig]
         #     Configuration for message analysis.
@@ -357,7 +363,7 @@ module Google
           # Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY.
           # @!attribute [rw] model
           #   @return [::String]
-          #     Required. Conversation model resource name. Format: `projects/<Project
+          #     Conversation model resource name. Format: `projects/<Project
           #     ID>/conversationModels/<Model ID>`.
           class ConversationModelConfig
             include ::Google::Protobuf::MessageExts
@@ -370,6 +376,9 @@ module Google
           #     Enable entity extraction in conversation messages on [agent assist
           #     stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages).
           #     If unspecified, defaults to false.
+          #
+          #     Currently, this feature is not general available, please contact Google
+          #     to get access.
           # @!attribute [rw] enable_sentiment_analysis
           #   @return [::Boolean]
           #     Enable sentiment analysis in conversation messages on [agent assist
@@ -394,6 +403,9 @@ module Google
 
         # Defines the hand off to a live agent, typically on which external agent
         # service provider to connect to a conversation.
+        #
+        # Currently, this feature is not general available, please contact Google
+        # to get access.
         # @!attribute [rw] live_person_config
         #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig::LivePersonConfig]
         #     Uses LivePerson (https://www.liveperson.com).

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

@@ -42,16 +42,21 @@ module Google
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The unique identifier of this agent environment.
-        #     Format: `projects/<Project ID>/agent/environments/<Environment ID>`.
-        #     For Environment ID, "-" is reserved for 'draft' environment.
+        #     Supported formats:
+        #     - `projects/<Project ID>/agent/environments/<Environment ID>`
+        #     - `projects/<Project ID>/locations/<Location
+        #       ID>/agent/environments/<Environment ID>`
         # @!attribute [rw] description
         #   @return [::String]
         #     Optional. The developer-provided description for this environment.
         #     The maximum length is 500 characters. If exceeded, the request is rejected.
         # @!attribute [rw] agent_version
         #   @return [::String]
-        #     Optional. The agent version loaded into this environment.
-        #     Format: `projects/<Project ID>/agent/versions/<Version ID>`.
+        #     Required. The agent version loaded into this environment.
+        #     Supported formats:
+        #     - `projects/<Project ID>/agent/versions/<Version ID>`
+        #     - `projects/<Project ID>/locations/<Location ID>/agent/versions/<Version
+        #       ID>`
         # @!attribute [r] state
         #   @return [::Google::Cloud::Dialogflow::V2::Environment::State]
         #     Output only. The state of this environment. This field is read-only, i.e., it cannot be
@@ -60,6 +65,12 @@ module Google
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The last update time of this environment. This field is read-only, i.e., it
         #     cannot be set by create and update methods.
+        # @!attribute [rw] text_to_speech_settings
+        #   @return [::Google::Cloud::Dialogflow::V2::TextToSpeechSettings]
+        #     Optional. Text to speech settings for this environment.
+        # @!attribute [rw] fulfillment
+        #   @return [::Google::Cloud::Dialogflow::V2::Fulfillment]
+        #     Optional. The fulfillment settings to use for this environment.
         class Environment
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -84,11 +95,47 @@ module Google
           end
         end
 
+        # Instructs the speech synthesizer on how to generate the output audio content.
+        # @!attribute [rw] enable_text_to_speech
+        #   @return [::Boolean]
+        #     Optional. Indicates whether text to speech is enabled. Even when this field is false,
+        #     other settings in this proto are still retained.
+        # @!attribute [rw] output_audio_encoding
+        #   @return [::Google::Cloud::Dialogflow::V2::OutputAudioEncoding]
+        #     Required. Audio encoding of the synthesized audio content.
+        # @!attribute [rw] sample_rate_hertz
+        #   @return [::Integer]
+        #     Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then
+        #     the synthesizer will use the default sample rate based on the audio
+        #     encoding. If this is different from the voice's natural sample rate, then
+        #     the synthesizer will honor this request by converting to the desired sample
+        #     rate (which might result in worse audio quality).
+        # @!attribute [rw] synthesize_speech_configs
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::SynthesizeSpeechConfig}]
+        #     Optional. Configuration of how speech should be synthesized, mapping from language
+        #     (https://cloud.google.com/dialogflow/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::V2::SynthesizeSpeechConfig]
+          class SynthesizeSpeechConfigsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # The request message for {::Google::Cloud::Dialogflow::V2::Environments::Client#list_environments Environments.ListEnvironments}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The agent to list all environments from.
-        #     Format: `projects/<Project ID>/agent`.
+        #     Format:
+        #     - `projects/<Project ID>/agent`
+        #     - `projects/<Project ID>/locations/<Location ID>/agent`
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. The maximum number of items to return in a single page. By default 100 and
@@ -114,6 +161,124 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Environments::Client#get_environment Environments.GetEnvironment}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the environment.
+        #     Supported formats:
+        #     - `projects/<Project ID>/agent/environments/<Environment ID>`
+        #     - `projects/<Project ID>/locations/<Location
+        #       ID>/agent/environments/<Environment ID>`
+        class GetEnvironmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Environments::Client#create_environment Environments.CreateEnvironment}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The agent to create an environment for.
+        #     Supported formats:
+        #     - `projects/<Project ID>/agent`
+        #     - `projects/<Project ID>/locations/<Location ID>/agent`
+        # @!attribute [rw] environment
+        #   @return [::Google::Cloud::Dialogflow::V2::Environment]
+        #     Required. The environment to create.
+        # @!attribute [rw] environment_id
+        #   @return [::String]
+        #     Required. The unique id of the new environment.
+        class CreateEnvironmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Environments::Client#update_environment Environments.UpdateEnvironment}.
+        # @!attribute [rw] environment
+        #   @return [::Google::Cloud::Dialogflow::V2::Environment]
+        #     Required. The environment to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The mask to control which fields get updated.
+        # @!attribute [rw] allow_load_to_draft_and_discard_changes
+        #   @return [::Boolean]
+        #     Optional. This field is used to prevent accidental overwrite of the draft
+        #     environment, which is an operation that cannot be undone. To confirm that
+        #     the caller desires this overwrite, this field must be explicitly set to
+        #     true when updating the draft environment (environment ID = `-`).
+        class UpdateEnvironmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Environments::Client#delete_environment Environments.DeleteEnvironment}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the environment to delete.
+        #     / Format:
+        #     - `projects/<Project ID>/agent/environments/<Environment ID>`
+        #     - `projects/<Project ID>/locations/<Location
+        #     ID>/agent/environments/<Environment ID>`
+        class DeleteEnvironmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {::Google::Cloud::Dialogflow::V2::Environments::Client#get_environment_history Environments.GetEnvironmentHistory}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the environment to retrieve history for.
+        #     Supported formats:
+        #     - `projects/<Project ID>/agent/environments/<Environment ID>`
+        #     - `projects/<Project ID>/locations/<Location
+        #       ID>/agent/environments/<Environment ID>`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of items to return in a single page. By default 100 and
+        #     at most 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The next_page_token value returned from a previous list request.
+        class GetEnvironmentHistoryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for {::Google::Cloud::Dialogflow::V2::Environments::Client#get_environment_history Environments.GetEnvironmentHistory}.
+        # @!attribute [r] parent
+        #   @return [::String]
+        #     Output only. The name of the environment this history is for.
+        #     Supported formats:
+        #     - `projects/<Project ID>/agent/environments/<Environment ID>`
+        #     - `projects/<Project ID>/locations/<Location
+        #        ID>/agent/environments/<Environment ID>`
+        # @!attribute [r] entries
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::EnvironmentHistory::Entry>]
+        #     Output only. The list of agent environments. There will be a maximum number of items
+        #     returned based on the page_size field in the request.
+        # @!attribute [r] next_page_token
+        #   @return [::String]
+        #     Output only. Token to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class EnvironmentHistory
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents an environment history entry.
+          # @!attribute [rw] agent_version
+          #   @return [::String]
+          #     The agent version loaded into this environment history entry.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     The developer-provided description for this environment history entry.
+          # @!attribute [rw] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The creation time of this environment history entry.
+          class Entry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end