google-cloud-dialogflow-v2 0.6.2 → 0.8.1

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

@@ -0,0 +1,267 @@
+# 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
+        # A knowledge document to be used by a {::Google::Cloud::Dialogflow::V2::KnowledgeBase KnowledgeBase}.
+        #
+        # For more information, see the [knowledge base
+        # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
+        #
+        # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
+        # only use `projects.knowledgeBases.documents`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Optional. The document resource name.
+        #     The name must be empty when creating a document.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the document. The name must be 1024 bytes or
+        #     less; otherwise, the creation request fails.
+        # @!attribute [rw] mime_type
+        #   @return [::String]
+        #     Required. The MIME type of this document.
+        # @!attribute [rw] knowledge_types
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::Document::KnowledgeType>]
+        #     Required. The knowledge type of document content.
+        # @!attribute [rw] content_uri
+        #   @return [::String]
+        #     The URI where the file content is located.
+        #
+        #     For documents stored in Google Cloud Storage, these URIs must have
+        #     the form `gs://<bucket-name>/<object-name>`.
+        #
+        #     NOTE: External URLs must correspond to public webpages, i.e., they must
+        #     be indexed by Google Search. In particular, URLs for showing documents in
+        #     Google Cloud Storage (i.e. the URL in your browser) are not supported.
+        #     Instead use the `gs://` format URI described above.
+        # @!attribute [rw] raw_content
+        #   @return [::String]
+        #     The raw content of the document. This field is only permitted for
+        #     EXTRACTIVE_QA and FAQ knowledge types.
+        # @!attribute [rw] enable_auto_reload
+        #   @return [::Boolean]
+        #     Optional. If true, we try to automatically reload the document every day
+        #     (at a time picked by the system). If false or unspecified, we don't try
+        #     to automatically reload the document.
+        #
+        #     Currently you can only enable automatic reload for documents sourced from
+        #     a public url, see `source` field for the source types.
+        #
+        #     Reload status can be tracked in `latest_reload_status`. If a reload
+        #     fails, we will keep the document unchanged.
+        #
+        #     If a reload fails with internal errors, the system will try to reload the
+        #     document on the next day.
+        #     If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
+        #     system will not try to reload the document anymore. You need to manually
+        #     reload the document successfully by calling `ReloadDocument` and clear the
+        #     errors.
+        # @!attribute [r] latest_reload_status
+        #   @return [::Google::Cloud::Dialogflow::V2::Document::ReloadStatus]
+        #     Output only. The time and status of the latest reload.
+        #     This reload may have been triggered automatically or manually
+        #     and may not have succeeded.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Metadata for the document. The metadata supports arbitrary
+        #     key-value pairs. Suggested use cases include storing a document's title,
+        #     an external URL distinct from the document's content_uri, etc.
+        #     The max size of a `key` or a `value` of the metadata is 1024 bytes.
+        class Document
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of a reload attempt.
+          # @!attribute [rw] time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time of a reload attempt.
+          #     This reload may have been triggered automatically or manually and may
+          #     not have succeeded.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     The status of a reload attempt or the initial load.
+          class ReloadStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class MetadataEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The knowledge type of document content.
+          module KnowledgeType
+            # The type is unspecified or arbitrary.
+            KNOWLEDGE_TYPE_UNSPECIFIED = 0
+
+            # The document content contains question and answer pairs as either HTML or
+            # CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats
+            # may fail to be parsed.
+            #
+            # CSV must have questions in the first column and answers in the second,
+            # with no header. Because of this explicit format, they are always parsed
+            # accurately.
+            FAQ = 1
+
+            # Documents for which unstructured text is extracted and used for
+            # question answering.
+            EXTRACTIVE_QA = 2
+
+            # The entire document content as a whole can be used for query results.
+            # Only for Contact Center Solutions on Dialogflow.
+            ARTICLE_SUGGESTION = 3
+          end
+        end
+
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#get_document Documents.GetDocument}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the document to retrieve.
+        #     Format `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
+        class GetDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#list_documents Documents.ListDocuments}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The knowledge base to list all documents for.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of items to return in a single page. By
+        #     default 10 and at most 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The next_page_token value returned from a previous list request.
+        class ListDocumentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Dialogflow::V2::Documents::Client#list_documents Documents.ListDocuments}.
+        # @!attribute [rw] documents
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::Document>]
+        #     The list of documents.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Token to retrieve the next page of results, or empty if there are no
+        #     more results in the list.
+        class ListDocumentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#create_document Documents.CreateDocument}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The knowledge base to create a document for.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>`.
+        # @!attribute [rw] document
+        #   @return [::Google::Cloud::Dialogflow::V2::Document]
+        #     Required. The document to create.
+        class CreateDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#delete_document Documents.DeleteDocument}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the document to delete.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
+        class DeleteDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#update_document Documents.UpdateDocument}.
+        # @!attribute [rw] document
+        #   @return [::Google::Cloud::Dialogflow::V2::Document]
+        #     Required. The document to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Not specified means `update all`.
+        #     Currently, only `display_name` can be updated, an InvalidArgument will be
+        #     returned for attempting to update other fields.
+        class UpdateDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#reload_document Documents.ReloadDocument}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the document to reload.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
+        # @!attribute [rw] content_uri
+        #   @return [::String]
+        #     Optional. The path of gcs source file for reloading document content. For now,
+        #     only gcs uri is supported.
+        #
+        #     For documents stored in Google Cloud Storage, these URIs must have
+        #     the form `gs://<bucket-name>/<object-name>`.
+        class ReloadDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata in google::longrunning::Operation for Knowledge operations.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata::State]
+        #     Output only. The current state of this operation.
+        class KnowledgeOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # States of the operation.
+          module State
+            # State unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The operation has been created.
+            PENDING = 1
+
+            # The operation is currently running.
+            RUNNING = 2
+
+            # The operation is done, either cancelled or completed.
+            DONE = 3
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,9 +21,18 @@ module Google
   module Cloud
     module Dialogflow
       module V2
-        # Represents an entity type.
-        # Entity types serve as a tool for extracting parameter values from natural
-        # language queries.
+        # Each intent parameter has a type, called the entity type, which dictates
+        # exactly how data from an end-user expression is extracted.
+        #
+        # Dialogflow provides predefined system entities that can match many common
+        # types of data. For example, there are system entities for matching dates,
+        # times, colors, email addresses, and so on. You can also create your own
+        # custom entities for matching custom data. For example, you could define a
+        # vegetable entity that can match the types of vegetables available for
+        # purchase with a grocery store agent.
+        #
+        # For more information, see the
+        # [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).
         # @!attribute [rw] name
         #   @return [::String]
         #     The unique identifier of the entity type.

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

@@ -21,12 +21,31 @@ module Google
   module Cloud
     module Dialogflow
       module V2
-        # Represents an agent environment.
+        # You can create multiple versions of your agent and publish them to separate
+        # environments.
+        #
+        # When you edit an agent, you are editing the draft agent. At any point, you
+        # can save the draft agent as an agent version, which is an immutable snapshot
+        # of your agent.
+        #
+        # When you save the draft agent, it is published to the default environment.
+        # When you create agent versions, you can publish them to custom environments.
+        # You can create a variety of custom environments for:
+        #
+        # - testing
+        # - development
+        # - production
+        # - etc.
+        #
+        # For more information, see the [versions and environments
+        # guide](https://cloud.google.com/dialogflow/docs/agents-versions).
         # @!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.
@@ -34,7 +53,10 @@ module Google
         # @!attribute [rw] agent_version
         #   @return [::String]
         #     Optional. The agent version loaded into this environment.
-        #     Format: `projects/<Project ID>/agent/versions/<Version ID>`.
+        #     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
@@ -43,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
@@ -67,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
@@ -97,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