google-cloud-dialogflow-v2 0.12.0 → 0.15.0

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

@@ -88,6 +88,9 @@ module Google
         #     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.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Dialogflow::V2::Document::State]
+        #     Output only. The current state of the document.
         class Document
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -136,6 +139,30 @@ module Google
             # The entire document content as a whole can be used for query results.
             # Only for Contact Center Solutions on Dialogflow.
             ARTICLE_SUGGESTION = 3
+
+            # The document contains agent-facing Smart Reply entries.
+            AGENT_FACING_SMART_REPLY = 4
+          end
+
+          # Possible states of the document
+          module State
+            # The document state is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The document creation is in progress.
+            CREATING = 1
+
+            # The document is active and ready to use.
+            ACTIVE = 2
+
+            # The document updation is in progress.
+            UPDATING = 3
+
+            # The document is reloading.
+            RELOADING = 4
+
+            # The document deletion is in progress.
+            DELETING = 5
           end
         end
 
@@ -163,6 +190,29 @@ module Google
         # @!attribute [rw] page_token
         #   @return [::String]
         #     The next_page_token value returned from a previous list request.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     The filter expression used to filter documents returned by the list method.
+        #     The expression has the following syntax:
+        #
+        #       <field> <operator> <value> [AND <field> <operator> <value>] ...
+        #
+        #     The following fields and operators are supported:
+        #
+        #     * knowledge_types with has(:) operator
+        #     * display_name with has(:) operator
+        #     * state with equals(=) operator
+        #
+        #     Examples:
+        #
+        #     * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
+        #     * "display_name:customer" matches documents whose display name contains
+        #       "customer".
+        #     * "state=ACTIVE" matches documents with ACTIVE state.
+        #     * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
+        #
+        #     For more information about filtering, see
+        #     [API Filtering](https://aip.dev/160).
         class ListDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -195,6 +245,68 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#import_documents Documents.ImportDocuments}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The knowledge base to import documents into.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>`.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::Dialogflow::V2::GcsSources]
+        #     The Google Cloud Storage location for the documents.
+        #     The path can include a wildcard.
+        #
+        #     These URIs may have the forms
+        #     `gs://<bucket-name>/<object-name>`.
+        #     `gs://<bucket-name>/<object-path>/*.<extension>`.
+        # @!attribute [rw] document_template
+        #   @return [::Google::Cloud::Dialogflow::V2::ImportDocumentTemplate]
+        #     Required. Document template used for importing all the documents.
+        # @!attribute [rw] import_gcs_custom_metadata
+        #   @return [::Boolean]
+        #     Whether to import custom metadata from Google Cloud Storage.
+        #     Only valid when the document source is Google Cloud Storage URI.
+        class ImportDocumentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The template used for importing documents.
+        # @!attribute [rw] mime_type
+        #   @return [::String]
+        #     Required. The MIME type of the document.
+        # @!attribute [rw] knowledge_types
+        #   @return [::Array<::Google::Cloud::Dialogflow::V2::Document::KnowledgeType>]
+        #     Required. The knowledge type of document content.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     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 ImportDocumentTemplate
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class MetadataEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for {::Google::Cloud::Dialogflow::V2::Documents::Client#import_documents Documents.ImportDocuments}.
+        # @!attribute [rw] warnings
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     Includes details about skipped documents or any other warnings.
+        class ImportDocumentsResponse
+          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]
@@ -233,15 +345,60 @@ module Google
         #
         #     For documents stored in Google Cloud Storage, these URIs must have
         #     the form `gs://<bucket-name>/<object-name>`.
+        # @!attribute [rw] import_gcs_custom_metadata
+        #   @return [::Boolean]
+        #     Optional. Whether to import custom metadata from Google Cloud Storage.
+        #     Only valid when the document source is Google Cloud Storage URI.
+        # @!attribute [rw] smart_messaging_partial_update
+        #   @return [::Boolean]
+        #     Optional. When enabled, the reload request is to apply partial update to the smart
+        #     messaging allowlist.
         class ReloadDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#export_document Documents.ExportDocument}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the document to export.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
+        # @!attribute [rw] gcs_destination
+        #   @return [::Google::Cloud::Dialogflow::V2::GcsDestination]
+        #     Cloud Storage file path to export the document.
+        # @!attribute [rw] export_full_content
+        #   @return [::Boolean]
+        #     When enabled, export the full content of the document including empirical
+        #     probability.
+        # @!attribute [rw] smart_messaging_partial_update
+        #   @return [::Boolean]
+        #     When enabled, export the smart messaging allowlist document for partial
+        #     update.
+        class ExportDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the Export Data Operations (e.g. ExportDocument).
+        # @!attribute [rw] exported_gcs_destination
+        #   @return [::Google::Cloud::Dialogflow::V2::GcsDestination]
+        #     Cloud Storage file path of the exported data.
+        class ExportOperationMetadata
+          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.
+        # @!attribute [rw] knowledge_base
+        #   @return [::String]
+        #     The name of the knowledge base interacted with during the operation.
+        # @!attribute [rw] export_operation_metadata
+        #   @return [::Google::Cloud::Dialogflow::V2::ExportOperationMetadata]
+        #     Metadata for the Export Data Operation such as the destination of export.
         class KnowledgeOperationMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -0,0 +1,50 @@
+# 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
+        # Google Cloud Storage location for the inputs.
+        # @!attribute [rw] uris
+        #   @return [::Array<::String>]
+        #     Required. Google Cloud Storage URIs for the inputs. A URI is of the form:
+        #       gs://bucket/object-prefix-or-name
+        #     Whether a prefix or name is used depends on the use case.
+        class GcsSources
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Google Cloud Storage location for the output.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     The Google Cloud Storage URIs for the output. A URI is of the
+        #     form:
+        #       gs://bucket/object-prefix-or-name
+        #     Whether a prefix or name is used depends on the use case. The requesting
+        #     user must have "write-permission" to the bucket.
+        class GcsDestination
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -63,6 +63,34 @@ module Google
         # @!attribute [rw] page_token
         #   @return [::String]
         #     The next_page_token value returned from a previous list request.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     The filter expression used to filter knowledge bases returned by the list
+        #     method. The expression has the following syntax:
+        #
+        #       <field> <operator> <value> [AND <field> <operator> <value>] ...
+        #
+        #     The following fields and operators are supported:
+        #
+        #     * display_name with has(:) operator
+        #     * language_code with equals(=) operator
+        #
+        #     Examples:
+        #
+        #     * 'language_code=en-us' matches knowledge bases with en-us language code.
+        #     * 'display_name:articles' matches knowledge bases whose display name
+        #       contains "articles".
+        #     * 'display_name:"Best Articles"' matches knowledge bases whose display
+        #       name contains "Best Articles".
+        #     * 'language_code=en-gb AND display_name=articles' matches all knowledge
+        #       bases whose display name contains "articles" and whose language code is
+        #       "en-gb".
+        #
+        #     Note: An empty filter string (i.e. "") is a no-op and will result in no
+        #     filtering.
+        #
+        #     For more information about filtering, see
+        #     [API Filtering](https://aip.dev/160).
         class ListKnowledgeBasesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods