google-cloud-dialogflow-v2 0.6.2 → 0.8.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

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # 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
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -21,7 +21,15 @@ module Google
   module Cloud
     module Dialogflow
       module V2
-        # Represents a conversational agent.
+        # A Dialogflow agent is a virtual agent that handles conversations with your
+        # end-users. It is a natural language understanding module that understands the
+        # nuances of human language. Dialogflow translates end-user text or audio
+        # during a conversation to structured data that your apps and services can
+        # understand. You design and build a Dialogflow agent to handle the types of
+        # conversations required for your system.
+        #
+        # For more information about agents, see the
+        # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The project of this agent.

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

@@ -0,0 +1,252 @@
+# 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
+        # Answer records are records to manage answer history and feedbacks for
+        # Dialogflow.
+        #
+        # Currently, answer record includes:
+        #
+        # - human agent assistant article suggestion
+        # - human agent assistant faq article
+        #
+        # It doesn't include:
+        #
+        # - `DetectIntent` intent matching
+        # - `DetectIntent` knowledge
+        #
+        # Answer records are not related to the conversation history in the
+        # Dialogflow Console. A Record is generated even when the end-user disables
+        # conversation history in the console. Records are created when there's a human
+        # agent assistant suggestion generated.
+        #
+        # 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
+        #    [UpdateAnswerRecord][] method to send feedback about a specific answer
+        #    that they believe is wrong.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The unique identifier of this answer record.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/answerRecords/<Answer Record ID>`.
+        # @!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.
+        # @!attribute [r] agent_assistant_record
+        #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantRecord]
+        #     Output only. The record for human agent assistant.
+        class AnswerRecord
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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
+        #     chronological order. Format: `projects/<Project ID>/locations/<Location
+        #     ID>`.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Required. Filters to restrict results to specific answer records.
+        #     Filter on answer record type. Currently predicates on `type` is supported,
+        #     valid values are `ARTICLE_ANSWER`, `FAQ_ANSWER`.
+        #
+        #     For more information about filtering, see
+        #     [API Filtering](https://aip.dev/160).
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of records to return in a single page.
+        #     The server may return fewer records than this. If unspecified, we use 10.
+        #     The maximum is 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The
+        #     {::Google::Cloud::Dialogflow::V2::ListAnswerRecordsResponse#next_page_token ListAnswerRecordsResponse.next_page_token}
+        #     value returned from a previous list request used to continue listing on
+        #     the next page.
+        class ListAnswerRecordsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve next page of results. Or empty if there are no more
+        #     results.
+        #     Pass this value in the
+        #     {::Google::Cloud::Dialogflow::V2::ListAnswerRecordsRequest#page_token ListAnswerRecordsRequest.page_token}
+        #     field in the subsequent call to `ListAnswerRecords` method to retrieve the
+        #     next page of results.
+        class ListAnswerRecordsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The mask to control which fields get updated.
+        class UpdateAnswerRecordRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents feedback the customer has about the quality & correctness of a
+        # certain answer in a conversation.
+        # @!attribute [rw] correctness_level
+        #   @return [::Google::Cloud::Dialogflow::V2::AnswerFeedback::CorrectnessLevel]
+        #     The correctness level of the specific answer.
+        # @!attribute [rw] agent_assistant_detail_feedback
+        #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback]
+        #     Detail feedback of agent assist suggestions.
+        # @!attribute [rw] clicked
+        #   @return [::Boolean]
+        #     Indicates whether the answer/item was clicked by the human agent
+        #     or not. Default to false.
+        # @!attribute [rw] click_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Time when the answer/item was clicked.
+        # @!attribute [rw] displayed
+        #   @return [::Boolean]
+        #     Indicates whether the answer/item was displayed to the human
+        #     agent in the agent desktop UI. Default to false.
+        # @!attribute [rw] display_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Time when the answer/item was displayed.
+        class AnswerFeedback
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The correctness level of an answer.
+          module CorrectnessLevel
+            # Correctness level unspecified.
+            CORRECTNESS_LEVEL_UNSPECIFIED = 0
+
+            # Answer is totally wrong.
+            NOT_CORRECT = 1
+
+            # Answer is partially correct.
+            PARTIALLY_CORRECT = 2
+
+            # Answer is fully correct.
+            FULLY_CORRECT = 3
+          end
+        end
+
+        # Detail feedback of Agent Assist result.
+        # @!attribute [rw] answer_relevance
+        #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::AnswerRelevance]
+        #     Optional. Whether or not the suggested answer is relevant.
+        #
+        #     For example:
+        #
+        #     * Query: "Can I change my mailing address?"
+        #     * Suggested document says: "Items must be returned/exchanged within 60
+        #       days of the purchase date."
+        #     * {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback#answer_relevance answer_relevance}: {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::AnswerRelevance::IRRELEVANT AnswerRelevance.IRRELEVANT}
+        # @!attribute [rw] document_correctness
+        #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentCorrectness]
+        #     Optional. Whether or not the information in the document is correct.
+        #
+        #     For example:
+        #
+        #     * Query: "Can I return the package in 2 days once received?"
+        #     * Suggested document says: "Items must be returned/exchanged within 60
+        #       days of the purchase date."
+        #     * Ground truth: "No return or exchange is allowed."
+        #     * [document_correctness]: INCORRECT
+        # @!attribute [rw] document_efficiency
+        #   @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
+        #     {::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentEfficiency::INEFFICIENT DocumentEfficiency.INEFFICIENT}.
+        class AgentAssistantFeedback
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Relevance of an answer.
+          module AnswerRelevance
+            # Answer relevance unspecified.
+            ANSWER_RELEVANCE_UNSPECIFIED = 0
+
+            # Answer is irrelevant to query.
+            IRRELEVANT = 1
+
+            # Answer is relevant to query.
+            RELEVANT = 2
+          end
+
+          # Correctness of document.
+          module DocumentCorrectness
+            # Document correctness unspecified.
+            DOCUMENT_CORRECTNESS_UNSPECIFIED = 0
+
+            # Information in document is incorrect.
+            INCORRECT = 1
+
+            # Information in document is correct.
+            CORRECT = 2
+          end
+
+          # Efficiency of document.
+          module DocumentEfficiency
+            # Document efficiency unspecified.
+            DOCUMENT_EFFICIENCY_UNSPECIFIED = 0
+
+            # Document is inefficient.
+            INEFFICIENT = 1
+
+            # Document is efficient.
+            EFFICIENT = 2
+          end
+        end
+
+        # Represents a record of a human agent assist answer.
+        # @!attribute [r] article_suggestion_answer
+        #   @return [::Google::Cloud::Dialogflow::V2::ArticleAnswer]
+        #     Output only. The article suggestion answer.
+        # @!attribute [r] faq_answer
+        #   @return [::Google::Cloud::Dialogflow::V2::FaqAnswer]
+        #     Output only. The FAQ answer.
+        class AgentAssistantRecord
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end