google-cloud-discovery_engine-v1 0.1.0 → 0.2.0

data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb

@@ -44,13 +44,14 @@ module Google
         #     API calls. Do not use it when there is no traffic for Search API.
         #     * `user-event` - Using suggestions generated from user-imported search
         #     events.
+        #     * `document-completable` - Using suggestions taken directly from
+        #     user-imported document fields marked as completable.
         #
         #     Default values:
         #
         #     * `document` is the default model for regular dataStores.
         #     * `search-history` is the default model for
-        #     [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH]
-        #     dataStores.
+        #     [IndustryVertical.SITE_SEARCH][] dataStores.
         # @!attribute [rw] user_pseudo_id
         #   @return [::String]
         #     A unique identifier for tracking visitors. For example, this could be
@@ -67,6 +68,12 @@ module Google
         #
         #     The field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        # @!attribute [rw] include_tail_suggestions
+        #   @return [::Boolean]
+        #     Indicates if tail suggestions should be returned if there are no
+        #     suggestions that match the full query. Even if set to true, if there are
+        #     suggestions that match the full query, those are returned and no
+        #     tail suggestions are returned.
         class CompleteQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -79,6 +86,12 @@ module Google
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse::QuerySuggestion>]
         #     Results of the matched query suggestions. The result list is ordered and
         #     the first result is a top suggestion.
+        # @!attribute [rw] tail_match_triggered
+        #   @return [::Boolean]
+        #     True if the returned suggestions are all tail suggestions.
+        #
+        #     For tail matching to be triggered, include_tail_suggestions in the request
+        #     must be true and there must be no suggestions that match the full query.
         class CompleteQueryResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb

@@ -0,0 +1,113 @@
+# 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 DiscoveryEngine
+      module V1
+        # External conversation proto definition.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation::State]
+        #     The state of the Conversation.
+        # @!attribute [rw] user_pseudo_id
+        #   @return [::String]
+        #     A unique identifier for tracking users.
+        # @!attribute [rw] messages
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::ConversationMessage>]
+        #     Conversation messages.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the conversation started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the conversation finished.
+        class Conversation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enumeration of the state of the conversation.
+          module State
+            # Unknown.
+            STATE_UNSPECIFIED = 0
+
+            # Conversation is currently open.
+            IN_PROGRESS = 1
+
+            # Conversation has been completed.
+            COMPLETED = 2
+          end
+        end
+
+        # Defines a reply message to user.
+        # @!attribute [rw] summary
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary]
+        #     Summary based on search results.
+        class Reply
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Defines context of the conversation
+        # @!attribute [rw] context_documents
+        #   @return [::Array<::String>]
+        #     The current list of documents the user is seeing.
+        #     It contains the document resource references.
+        # @!attribute [rw] active_document
+        #   @return [::String]
+        #     The current active document the user opened.
+        #     It contains the document resource reference.
+        class ConversationContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Defines text input.
+        # @!attribute [rw] input
+        #   @return [::String]
+        #     Text input.
+        # @!attribute [rw] context
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ConversationContext]
+        #     Conversation context of the input.
+        class TextInput
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Defines a conversation message.
+        # @!attribute [rw] user_input
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::TextInput]
+        #     User text input.
+        # @!attribute [rw] reply
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Reply]
+        #     Search reply.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Message creation timestamp.
+        class ConversationMessage
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb

@@ -0,0 +1,206 @@
+# 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 DiscoveryEngine
+      module V1
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#converse_conversation ConversationalSearchService.ConverseConversation}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Conversation to get. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
+        #     Use
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
+        #     to activate auto session mode, which automatically creates a new
+        #     conversation inside a ConverseConversation session.
+        # @!attribute [rw] query
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::TextInput]
+        #     Required. Current user input.
+        # @!attribute [rw] serving_config
+        #   @return [::String]
+        #     The resource name of the Serving Config to use. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
+        #     If this is not set, the default serving config will be used.
+        # @!attribute [rw] conversation
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation]
+        #     The conversation to be used by auto session only. The name field will be
+        #     ignored as we automatically assign new name for the conversation in auto
+        #     session.
+        # @!attribute [rw] safe_search
+        #   @return [::Boolean]
+        #     Whether to turn on safe search.
+        # @!attribute [rw] user_labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The user labels applied to a resource must meet the following requirements:
+        #
+        #     * Each resource can have multiple labels, up to a maximum of 64.
+        #     * Each label must be a key-value pair.
+        #     * Keys have a minimum length of 1 character and a maximum length of 63
+        #       characters and cannot be empty. Values can be empty and have a maximum
+        #       length of 63 characters.
+        #     * Keys and values can contain only lowercase letters, numeric characters,
+        #       underscores, and dashes. All characters must use UTF-8 encoding, and
+        #       international characters are allowed.
+        #     * The key portion of a label must be unique. However, you can use the same
+        #       key with multiple resources.
+        #     * Keys must start with a lowercase letter or international character.
+        #
+        #     See [Google Cloud
+        #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
+        # @!attribute [rw] summary_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec]
+        #     A specification for configuring the summary returned in the response.
+        class ConverseConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserLabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#converse_conversation ConversationalSearchService.ConverseConversation}
+        # method.
+        # @!attribute [rw] reply
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Reply]
+        #     Answer to the current query.
+        # @!attribute [rw] conversation
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation]
+        #     Updated conversation including the answer.
+        # @!attribute [rw] search_results
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
+        #     Search Results.
+        class ConverseConversationResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for CreateConversation method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Full resource name of parent data store. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+        # @!attribute [rw] conversation
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation]
+        #     Required. The conversation to create.
+        class CreateConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for UpdateConversation method.
+        # @!attribute [rw] conversation
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation]
+        #     Required. The Conversation to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::DiscoveryEngine::V1::Conversation Conversation} to update. The
+        #     following are NOT supported:
+        #
+        #     * [conversation.name][]
+        #
+        #     If not set or empty, all supported fields are updated.
+        class UpdateConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for DeleteConversation method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Conversation to delete. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+        class DeleteConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetConversation method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Conversation to get. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+        class GetConversationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListConversations method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The data store resource name. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of results to return. If unspecified, defaults
+        #     to 50. Max allowed value is 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token, received from a previous `ListConversations` call.
+        #     Provide this to retrieve the subsequent page.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     A filter to apply on the list results. The supported features are:
+        #     user_pseudo_id, state.
+        #
+        #     Example:
+        #     "user_pseudo_id = some_id"
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     A comma-separated list of fields to order by, sorted in ascending order.
+        #     Use "desc" after a field name for descending.
+        #     Supported fields:
+        #       * `update_time`
+        #       * `create_time`
+        #       * `conversation_name`
+        #
+        #     Example:
+        #     "update_time desc"
+        #     "create_time"
+        class ListConversationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListConversations method.
+        # @!attribute [rw] conversations
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Conversation>]
+        #     All the Conversations for a given data store.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pagination token, if not returned indicates the last page.
+        class ListConversationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/document.rb

@@ -26,13 +26,13 @@ module Google
         # @!attribute [rw] struct_data
         #   @return [::Google::Protobuf::Struct]
         #     The structured JSON data for the document. It should conform to the
-        #     registered [Schema.schema][google.cloud.discoveryengine.v1.Schema.schema]
-        #     or an `INVALID_ARGUMENT` error is thrown.
+        #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
+        #     `INVALID_ARGUMENT` error is thrown.
         # @!attribute [rw] json_data
         #   @return [::String]
         #     The JSON string representation of the document. It should conform to the
-        #     registered [Schema.schema][google.cloud.discoveryengine.v1.Schema.schema]
-        #     or an `INVALID_ARGUMENT` error is thrown.
+        #     registered {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} or an
+        #     `INVALID_ARGUMENT` error is thrown.
         # @!attribute [rw] name
         #   @return [::String]
         #     Immutable. The full resource name of the document.
@@ -90,8 +90,11 @@ module Google
           #   @return [::String]
           #     The MIME type of the content. Supported types:
           #
-          #     * `application/pdf` (PDF)
+          #     * `application/pdf` (PDF, only native PDFs are supported for now)
           #     * `text/html` (HTML)
+          #     * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+          #     * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+          #     * `text/plain` (TXT)
           #
           #     See https://www.iana.org/assignments/media-types/media-types.xhtml.
           class Content

data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb

@@ -51,9 +51,10 @@ module Google
         #     Use `default_branch` as the branch ID, to list documents under the default
         #     branch.
         #
-        #     If the caller does not have permission to list [Documents][]s under this
-        #     branch, regardless of whether or not this branch exists, a
-        #     `PERMISSION_DENIED` error is returned.
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s under this branch,
+        #     regardless of whether or not this branch exists, a `PERMISSION_DENIED`
+        #     error is returned.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of {::Google::Cloud::DiscoveryEngine::V1::Document Document}s to

data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb

@@ -43,11 +43,15 @@ module Google
         #     document must
         #       have a valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
         #     * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
-        #       `input_uris` will become a document, with the ID set to the first 128
+        #       `input_uris` becomes a document, with the ID set to the first 128
         #       bits of SHA256(URI) encoded as a hex string.
         #     * `custom`: One custom data JSON per row in arbitrary format that conforms
-        #       the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
-        #       store. This can only be used by the GENERIC Data Store vertical.
+        #       to the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
+        #       data store. This can only be used by Gen App Builder.
+        #     * `csv`: A CSV file with header conforming to the defined
+        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
+        #       data store. Each entry after the header is imported as a Document.
+        #       This can only be used by Gen App Builder.
         #
         #     Supported values for user even imports:
         #
@@ -98,9 +102,9 @@ module Google
         #       {::Google::Cloud::DiscoveryEngine::V1::Document#json_data Document.json_data}
         #       or
         #       {::Google::Cloud::DiscoveryEngine::V1::Document#struct_data Document.struct_data}.
-        #     * `custom`: One custom data per row in arbitrary format that conforms the
-        #       defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
-        #       store. This can only be used by the GENERIC Data Store vertical.
+        #     * `custom`: One custom data per row in arbitrary format that conforms to
+        #       the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
+        #       store. This can only be used by Gen App Builder.
         class BigQuerySource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -110,7 +114,7 @@ module Google
         # @!attribute [rw] gcs_prefix
         #   @return [::String]
         #     Cloud Storage prefix for import errors. This must be an empty,
-        #     existing Cloud Storage directory. Import errors will be written to
+        #     existing Cloud Storage directory. Import errors are written to
         #     sharded files in this directory, one per line, as a JSON-encoded
         #     `google.rpc.Status` message.
         class ImportErrorConfig
@@ -121,13 +125,13 @@ module Google
         # Request message for the ImportUserEvents request.
         # @!attribute [rw] inline_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1::ImportUserEventsRequest::InlineSource]
-        #     Required. The Inline source for the input content for UserEvents.
+        #     The Inline source for the input content for UserEvents.
         # @!attribute [rw] gcs_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
-        #     Required. Cloud Storage location for the input content.
+        #     Cloud Storage location for the input content.
         # @!attribute [rw] bigquery_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource]
-        #     Required. BigQuery input source.
+        #     BigQuery input source.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Parent DataStore resource name, of the form
@@ -172,7 +176,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Metadata related to the progress of the Import operation. This will be
+        # Metadata related to the progress of the Import operation. This is
         # returned by the google.longrunning.Operation.metadata field.
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
@@ -192,8 +196,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Metadata related to the progress of the ImportDocuments operation. This will
-        # be returned by the google.longrunning.Operation.metadata field.
+        # Metadata related to the progress of the ImportDocuments operation. This is
+        # returned by the google.longrunning.Operation.metadata field.
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Operation create time.
@@ -248,7 +252,7 @@ module Google
         #     `false`, {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s have
         #     to be specified using
         #     {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#id_field id_field},
-        #     otherwises, documents without IDs will fail to be imported.
+        #     otherwise, documents without IDs fail to be imported.
         #
         #     Only set this field when using
         #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
@@ -256,7 +260,7 @@ module Google
         #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
         #     or
         #     {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
-        #     is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
+        #     is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
         # @!attribute [rw] id_field
         #   @return [::String]
         #     The field in the Cloud Storage and BigQuery sources that indicates the
@@ -267,12 +271,12 @@ module Google
         #     For {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource} it is
         #     the column name of the BigQuery table where the unique ids are stored.
         #
-        #     The values of the JSON field or the BigQuery column will be used as the
+        #     The values of the JSON field or the BigQuery column are used as the
         #     {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s. The JSON field
         #     or the BigQuery column must be of string type, and the values must be set
         #     as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
-        #     with 1-63 characters. Otherwise, documents without valid IDs will fail to
-        #     be imported.
+        #     with 1-63 characters. Otherwise, documents without valid IDs fail to be
+        #     imported.
         #
         #     Only set this field when using
         #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
@@ -304,7 +308,7 @@ module Google
           # Indicates how imported documents are reconciled with the existing documents
           # created or imported before.
           module ReconciliationMode
-            # Defaults to INCREMENTAL.
+            # Defaults to `INCREMENTAL`.
             RECONCILIATION_MODE_UNSPECIFIED = 0
 
             # Inserts new documents or updates existing documents.