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

data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb

@@ -0,0 +1,210 @@
+# 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 V1beta
+        # Request message for Recommend method.
+        # @!attribute [rw] serving_config
+        #   @return [::String]
+        #     Required. Full resource name of the format:
+        #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
+        #
+        #     Before you can request recommendations from your model, you must create at
+        #     least one serving config  for it.
+        # @!attribute [rw] user_event
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent]
+        #     Required. Context about the user, what they are looking at and what action
+        #     they took to trigger the Recommend request. Note that this user event
+        #     detail won't be ingested to userEvent logs. Thus, a separate userEvent
+        #     write request is required for event logging.
+        #
+        #     Don't set
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+        #     or
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_id UserEvent.user_info.user_id}
+        #     to the same fixed ID for different users. If you are trying to receive
+        #     non-personalized recommendations (not recommended; this can negatively
+        #     impact model performance), instead set
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+        #     to a random unique ID and leave
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_id UserEvent.user_info.user_id}
+        #     unset.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of results to return. Set this property
+        #     to the number of recommendation results needed. If zero, the service will
+        #     choose a reasonable default. The maximum allowed value is 100. Values
+        #     above 100 will be coerced to 100.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Filter for restricting recommendation results with a length limit of 5,000
+        #     characters. Currently, only filter expressions on the `filter_tags`
+        #     attribute is supported.
+        #
+        #
+        #     Examples:
+        #
+        #      * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
+        #      * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
+        #
+        #     If your filter blocks all results, the API will return generic
+        #     (unfiltered) popular Documents. If you only want results strictly matching
+        #     the filters, set `strictFiltering` to True in
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}
+        #     to receive empty results instead.
+        #
+        #     Note that the API will never return
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s with
+        #     `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Use validate only mode for this recommendation query. If set to true, a
+        #     fake model will be used that returns arbitrary Document IDs.
+        #     Note that the validate only mode should only be used for testing the API,
+        #     or if the model is not ready.
+        # @!attribute [rw] params
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
+        #     Additional domain specific parameters for the recommendations.
+        #
+        #     Allowed values:
+        #
+        #     * `returnDocument`: Boolean. If set to true, the associated Document
+        #        object will be returned in
+        #        {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#document RecommendResponse.RecommendationResult.document}.
+        #     * `returnScore`: Boolean. If set to true, the recommendation 'score'
+        #        corresponding to each returned Document will be set in
+        #        {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#metadata RecommendResponse.RecommendationResult.metadata}.
+        #        The given 'score' indicates the probability of a Document conversion
+        #        given the user's context and history.
+        #     * `strictFiltering`: Boolean. True by default. If set to false, the service
+        #        will return generic (unfiltered) popular Documents instead of empty if
+        #        your filter blocks all recommendation results.
+        #     * `diversityLevel`: String. Default empty. If set to be non-empty, then
+        #        it needs to be one of:
+        #         *  `no-diversity`
+        #         *  `low-diversity`
+        #         *  `medium-diversity`
+        #         *  `high-diversity`
+        #         *  `auto-diversity`
+        #        This gives request-level control and adjusts recommendation results
+        #        based on Document category.
+        # @!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 [Requirements for
+        #     labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
+        class RecommendRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Protobuf::Value]
+          class ParamsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!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 Recommend method.
+        # @!attribute [rw] results
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult>]
+        #     A list of recommended Documents. The order represents the ranking (from the
+        #     most relevant Document to the least).
+        # @!attribute [rw] attribution_token
+        #   @return [::String]
+        #     A unique attribution token. This should be included in the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent UserEvent} logs resulting
+        #     from this recommendation, which enables accurate attribution of
+        #     recommendation model performance.
+        # @!attribute [rw] missing_ids
+        #   @return [::Array<::String>]
+        #     IDs of documents in the request that were missing from the default Branch
+        #     associated with the requested ServingConfig.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     True if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#validate_only RecommendRequest.validate_only}
+        #     was set.
+        class RecommendResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # RecommendationResult represents a generic recommendation result with
+          # associated metadata.
+          # @!attribute [rw] id
+          #   @return [::String]
+          #     Resource ID of the recommended Document.
+          # @!attribute [rw] document
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
+          #     Set if `returnDocument` is set to true in
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
+          # @!attribute [rw] metadata
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
+          #     Additional Document metadata / annotations.
+          #
+          #     Possible values:
+          #
+          #     * `score`: Recommendation score in double value. Is set if
+          #       `returnScore` is set to true in
+          #       {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
+          class RecommendationResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Protobuf::Value]
+            class MetadataEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1beta/schema.rb

@@ -0,0 +1,45 @@
+# 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 V1beta
+        # Defines the structure and layout of a type of document data.
+        # @!attribute [rw] struct_schema
+        #   @return [::Google::Protobuf::Struct]
+        #     The structured representation of the schema.
+        # @!attribute [rw] json_schema
+        #   @return [::String]
+        #     The JSON representation of the schema.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The full resource name of the schema, in the format of
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        class Schema
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb

@@ -0,0 +1,180 @@
+# 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 V1beta
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#get_schema SchemaService.GetSchema}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the schema, in the format of
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
+        class GetSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name, in the format of
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s
+        #     to return. The service may return fewer than this value.
+        #
+        #     If unspecified, at most 100
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s will be returned.
+        #
+        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token, received from a previous
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
+        #     must match the call that provided the page token.
+        class ListSchemasRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#list_schemas SchemaService.ListSchemas}
+        # method.
+        # @!attribute [rw] schemas
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Schema>]
+        #     The {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListSchemasRequest#page_token ListSchemasRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListSchemasResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#create_schema SchemaService.CreateSchema}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name, in the format of
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+        # @!attribute [rw] schema
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Schema]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} to
+        #     create.
+        # @!attribute [rw] schema_id
+        #   @return [::String]
+        #     Required. The ID to use for the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which will become the
+        #     final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema#name Schema.name}.
+        #
+        #     This field should conform to
+        #     [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
+        #     limit of 63 characters.
+        class CreateSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#update_schema SchemaService.UpdateSchema}
+        # method.
+        # @!attribute [rw] schema
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Schema]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} to
+        #     update.
+        # @!attribute [rw] allow_missing
+        #   @return [::Boolean]
+        #     If set to true, and the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is not found, a new
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} will be created. In
+        #     this situation, `update_mask` is ignored.
+        class UpdateSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#delete_schema SchemaService.DeleteSchema}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the schema, in the format of
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
+        class DeleteSchemaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for Create Schema LRO.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class CreateSchemaMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for UpdateSchema LRO.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class UpdateSchemaMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for DeleteSchema LRO.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class DeleteSchemaMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end