google-cloud-discovery_engine-v1 0.a → 0.2.0

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

@@ -0,0 +1,108 @@
+# 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
+        # Document captures all raw metadata information of items to be recommended or
+        # searched.
+        # @!attribute [rw] struct_data
+        #   @return [::Google::Protobuf::Struct]
+        #     The structured JSON data for the document. It should conform to the
+        #     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 {::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.
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Immutable. The identifier of the document.
+        #
+        #     Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+        #     standard with a length limit of 63 characters.
+        # @!attribute [rw] schema_id
+        #   @return [::String]
+        #     The identifier of the schema located in the same data store.
+        # @!attribute [rw] content
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Document::Content]
+        #     The unstructured data linked to this document. Content must be set if this
+        #     document is under a
+        #     `CONTENT_REQUIRED` data store.
+        # @!attribute [rw] parent_document_id
+        #   @return [::String]
+        #     The identifier of the parent document. Currently supports at most two level
+        #     document hierarchy.
+        #
+        #     Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+        #     standard with a length limit of 63 characters.
+        # @!attribute [r] derived_struct_data
+        #   @return [::Google::Protobuf::Struct]
+        #     Output only. This field is OUTPUT_ONLY.
+        #     It contains derived data that are not in the original input document.
+        class Document
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Unstructured data linked to this document.
+          # @!attribute [rw] raw_bytes
+          #   @return [::String]
+          #     The content represented as a stream of bytes. The maximum length is
+          #     1,000,000 bytes (1 MB / ~0.95 MiB).
+          #
+          #     Note: As with all `bytes` fields, this field is represented as pure
+          #     binary in Protocol Buffers and base64-encoded string in JSON. For
+          #     example, `abc123!?$*&()'-=@~` should be represented as
+          #     `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
+          #     https://developers.google.com/protocol-buffers/docs/proto3#json.
+          # @!attribute [rw] uri
+          #   @return [::String]
+          #     The URI of the content. Only Cloud Storage URIs (e.g.
+          #     `gs://bucket-name/path/to/file`) are supported. The maximum file size
+          #     is 100 MB.
+          # @!attribute [rw] mime_type
+          #   @return [::String]
+          #     The MIME type of the content. Supported types:
+          #
+          #     * `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
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,181 @@
+# 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::DocumentService::Client#get_document DocumentService.GetDocument}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, regardless of whether
+        #     or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     If the requested {::Google::Cloud::DiscoveryEngine::V1::Document Document} does
+        #     not exist, a `NOT_FOUND` error is returned.
+        class GetDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#list_documents DocumentService.ListDocuments}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent branch resource name, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+        #     Use `default_branch` as the branch ID, to list documents under the default
+        #     branch.
+        #
+        #     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
+        #     return. If unspecified, defaults to 100. The maximum allowed value is 1000.
+        #     Values above 1000 will be coerced to 1000.
+        #
+        #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token
+        #     {::Google::Cloud::DiscoveryEngine::V1::ListDocumentsResponse#next_page_token ListDocumentsResponse.next_page_token},
+        #     received from a previous
+        #     {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#list_documents DocumentService.ListDocuments}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#list_documents DocumentService.ListDocuments}
+        #     must match the call that provided the page token. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class ListDocumentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#list_documents DocumentService.ListDocuments}
+        # method.
+        # @!attribute [rw] documents
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
+        #     The {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::DiscoveryEngine::V1::ListDocumentsRequest#page_token ListDocumentsRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListDocumentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#create_document DocumentService.CreateDocument}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+        # @!attribute [rw] document
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1::Document Document} to
+        #     create.
+        # @!attribute [rw] document_id
+        #   @return [::String]
+        #     Required. The ID to use for the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, which will become the
+        #     final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document#name Document.name}.
+        #
+        #     If the caller does not have permission to create the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, regardless of whether
+        #     or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     This field must be unique among all
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s with the same
+        #     {::Google::Cloud::DiscoveryEngine::V1::CreateDocumentRequest#parent parent}.
+        #     Otherwise, an `ALREADY_EXISTS` error is returned.
+        #
+        #     This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+        #     standard with a length limit of 63 characters. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class CreateDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#update_document DocumentService.UpdateDocument}
+        # method.
+        # @!attribute [rw] document
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
+        #     Required. The document to update/create.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, regardless of whether
+        #     or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1::Document Document} to update does
+        #     not exist and
+        #     {::Google::Cloud::DiscoveryEngine::V1::UpdateDocumentRequest#allow_missing allow_missing}
+        #     is not set, a `NOT_FOUND` error is returned.
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not found, a new
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} will be created.
+        class UpdateDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#delete_document DocumentService.DeleteDocument}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+        #
+        #     If the caller does not have permission to delete the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, regardless of whether
+        #     or not it exists, a `PERMISSION_DENIED` error is returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1::Document Document} to delete does
+        #     not exist, a `NOT_FOUND` error is returned.
+        class DeleteDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end