google-cloud-discovery_engine-v1beta 0.7.2 → 0.9.0

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

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+        # Configures metadata that is used to generate serving time results (e.g.
+        # search results or recommendation predictions).
+        # The ServingConfig is passed in the search and predict request and generates
+        # results.
+        # @!attribute [rw] media_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig::MediaConfig]
+        #     The MediaConfig of the serving configuration.
+        # @!attribute [rw] generic_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig::GenericConfig]
+        #     The GenericConfig of the serving configuration.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The human readable serving config display name. Used in Discovery
+        #     UI.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 128
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] solution_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SolutionType]
+        #     Required. Immutable. Specifies the solution type that a serving config can
+        #     be associated with.
+        # @!attribute [rw] model_id
+        #   @return [::String]
+        #     The id of the model to use at serving time.
+        #     Currently only RecommendationModels are supported.
+        #     Can be changed but only to a compatible model (e.g.
+        #     others-you-may-like CTR to others-you-may-like CVR).
+        #
+        #     Required when
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
+        # @!attribute [rw] diversity_level
+        #   @return [::String]
+        #     How much diversity to use in recommendation model results e.g.
+        #     `medium-diversity` or `high-diversity`. Currently supported values:
+        #
+        #     * `no-diversity`
+        #     * `low-diversity`
+        #     * `medium-diversity`
+        #     * `high-diversity`
+        #     * `auto-diversity`
+        #
+        #     If not specified, we choose default based on recommendation model
+        #     type. Default value: `no-diversity`.
+        #
+        #     Can only be set if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
+        # @!attribute [rw] embedding_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::EmbeddingConfig]
+        #     Bring your own embedding config. The config is used for search semantic
+        #     retrieval. The retrieval is based on the dot product of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#vector SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+        #     and the document embeddings that are provided by this EmbeddingConfig. If
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#vector SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+        #     is provided, it overrides this
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#embedding_config ServingConfig.embedding_config}.
+        # @!attribute [rw] ranking_expression
+        #   @return [::String]
+        #     The ranking expression controls the customized ranking on retrieval
+        #     documents. To leverage this, document embedding is required. The ranking
+        #     expression setting in ServingConfig applies to all search requests served
+        #     by the serving config. However, if [SearchRequest.ranking_expression][] is
+        #     specified, it overrides the ServingConfig ranking expression.
+        #
+        #     The ranking expression is a single function or multiple functions that are
+        #     joined by "+".
+        #       * ranking_expression = function, { " + ", function };
+        #     Supported functions:
+        #       * double * relevance_score
+        #       * double * dotProduct(embedding_field_path)
+        #     Function variables:
+        #       relevance_score: pre-defined keywords, used for measure relevance between
+        #       query and document.
+        #       embedding_field_path: the document embedding field
+        #       used with query embedding vector.
+        #       dotProduct: embedding function between embedding_field_path and query
+        #       embedding vector.
+        #
+        #      Example ranking expression:
+        #        If document has an embedding field doc_embedding, the ranking expression
+        #        could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. ServingConfig created timestamp.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. ServingConfig updated timestamp.
+        # @!attribute [rw] filter_control_ids
+        #   @return [::Array<::String>]
+        #     Filter controls to use in serving path.
+        #     All triggered filter controls will be applied.
+        #     Filter controls must be in the same data store as the serving config.
+        #     Maximum of 20 filter controls.
+        # @!attribute [rw] boost_control_ids
+        #   @return [::Array<::String>]
+        #     Boost controls to use in serving path.
+        #     All triggered boost controls will be applied.
+        #     Boost controls must be in the same data store as the serving config.
+        #     Maximum of 20 boost controls.
+        # @!attribute [rw] redirect_control_ids
+        #   @return [::Array<::String>]
+        #     IDs of the redirect controls. Only the first triggered redirect
+        #     action is applied, even if multiple apply. Maximum number of
+        #     specifications is 100.
+        #
+        #     Can only be set if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] synonyms_control_ids
+        #   @return [::Array<::String>]
+        #     Condition synonyms specifications. If multiple synonyms conditions
+        #     match, all matching synonyms controls in the list will execute.
+        #     Maximum number of specifications is 100.
+        #
+        #     Can only be set if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] oneway_synonyms_control_ids
+        #   @return [::Array<::String>]
+        #     Condition oneway synonyms specifications. If multiple oneway synonyms
+        #     conditions match, all matching oneway synonyms controls in the list
+        #     will execute. Maximum number of specifications is 100.
+        #
+        #     Can only be set if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] dissociate_control_ids
+        #   @return [::Array<::String>]
+        #     Condition do not associate specifications. If multiple do not
+        #     associate conditions match, all matching do not associate controls in
+        #     the list will execute.
+        #     Order does not matter.
+        #     Maximum number of specifications is 100.
+        #
+        #     Can only be set if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] replacement_control_ids
+        #   @return [::Array<::String>]
+        #     Condition replacement specifications.
+        #     Applied according to the order in the list.
+        #     A previously replaced term can not be re-replaced.
+        #     Maximum number of specifications is 100.
+        #
+        #     Can only be set if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] ignore_control_ids
+        #   @return [::Array<::String>]
+        #     Condition ignore specifications. If multiple ignore
+        #     conditions match, all matching ignore controls in the list will
+        #     execute.
+        #     Order does not matter.
+        #     Maximum number of specifications is 100.
+        class ServingConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specifies the configurations needed for Media Discovery. Currently we
+          # support:
+          #
+          # * `demote_content_watched`: Threshold for watched content demotion.
+          # Customers can specify if using watched content demotion or use viewed
+          # detail page. Using the content watched demotion, customers need to specify
+          # the watched minutes or percentage exceeds the threshold, the content will
+          # be demoted in the recommendation result.
+          # * `promote_fresh_content`: cutoff days for fresh content promotion.
+          # Customers can specify if using content freshness promotion. If the content
+          # was published within the cutoff days, the content will be promoted in the
+          # recommendation result.
+          # Can only be set if
+          # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is
+          # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
+          # @!attribute [rw] content_watched_percentage_threshold
+          #   @return [::Float]
+          #     Specifies the content watched percentage threshold for demotion.
+          #     Threshold value must be between [0, 1.0] inclusive.
+          # @!attribute [rw] content_watched_seconds_threshold
+          #   @return [::Float]
+          #     Specifies the content watched minutes threshold for demotion.
+          # @!attribute [rw] demotion_event_type
+          #   @return [::String]
+          #     Specifies the event type used for demoting recommendation result.
+          #     Currently supported values:
+          #
+          #     * `view-item`: Item viewed.
+          #     * `media-play`: Start/resume watching a video, playing a song, etc.
+          #     * `media-complete`: Finished or stopped midway through a video, song,
+          #     etc.
+          #
+          #     If unset, watch history demotion will not be applied. Content freshness
+          #     demotion will still be applied.
+          # @!attribute [rw] content_freshness_cutoff_days
+          #   @return [::Integer]
+          #     Specifies the content freshness used for recommendation result.
+          #     Contents will be demoted if contents were published for more than content
+          #     freshness cutoff days.
+          class MediaConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Specifies the configurations needed for Generic Discovery.Currently we
+          # support:
+          #
+          # * `content_search_spec`: configuration for generic content search.
+          # @!attribute [rw] content_search_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
+          #     Specifies the expected behavior of content search.
+          #     Only valid for content-search enabled data store.
+          class GenericConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 for UpdateServingConfig method.
+        # @!attribute [rw] serving_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig]
+        #     Required. The ServingConfig to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} to
+        #     update. The following are NOT supported:
+        #
+        #     * {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#name ServingConfig.name}
+        #
+        #     If not set, all supported fields are updated.
+        class UpdateServingConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetServingConfig method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ServingConfig to get. Format:
+        #     `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`
+        class GetServingConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListServingConfigs method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The dataStore resource name. Format:
+        #     `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return. If unspecified, defaults
+        #     to 100. If a value greater than 100 is provided, at most 100 results are
+        #     returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListServingConfigs` call.
+        #     Provide this to retrieve the subsequent page.
+        class ListServingConfigsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListServingConfigs method.
+        # @!attribute [rw] serving_configs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig>]
+        #     All the ServingConfigs for a given dataStore.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pagination token, if not returned indicates the last page.
+        class ListServingConfigsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+        # SiteSearchEngine captures DataStore level site search persisting
+        # configurations. It is a singleton value per data store.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The fully qualified resource name of the site search engine.
+        #     Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
+        class SiteSearchEngine
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A target site for the SiteSearchEngine.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The fully qualified resource name of the target site.
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
+        #     The `target_site_id` is system-generated.
+        # @!attribute [rw] provided_uri_pattern
+        #   @return [::String]
+        #     Required. Input only. The user provided URI pattern from which the
+        #     `generated_uri_pattern` is generated.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type]
+        #     The type of the target site, e.g., whether the site is to be included or
+        #     excluded.
+        # @!attribute [rw] exact_match
+        #   @return [::Boolean]
+        #     Input only. If set to false, a uri_pattern is generated to include all
+        #     pages whose address contains the provided_uri_pattern. If set to true, an
+        #     uri_pattern is generated to try to be an exact match of the
+        #     provided_uri_pattern or just the specific page if the provided_uri_pattern
+        #     is a specific one. provided_uri_pattern is always normalized to
+        #     generate the URI pattern to be used by the search engine.
+        # @!attribute [r] generated_uri_pattern
+        #   @return [::String]
+        #     Output only. This is system-generated based on the provided_uri_pattern.
+        # @!attribute [r] site_verification_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SiteVerificationInfo]
+        #     Output only. Site ownership and validity verification status.
+        # @!attribute [r] indexing_status
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::IndexingStatus]
+        #     Output only. Indexing status.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The target site's last updated time.
+        # @!attribute [r] failure_reason
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason]
+        #     Output only. Failure reason.
+        class TargetSite
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Site search indexing failure reasons.
+          # @!attribute [rw] quota_failure
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::FailureReason::QuotaFailure]
+          #     Failed due to insufficient quota.
+          class FailureReason
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Failed due to insufficient quota.
+            # @!attribute [rw] total_required_quota
+            #   @return [::Integer]
+            #     This number is an estimation on how much total quota this project needs
+            #     to successfully complete indexing.
+            class QuotaFailure
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Possible target site types.
+          module Type
+            # This value is unused. In this case, server behavior defaults to
+            # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite::Type::INCLUDE Type.INCLUDE}.
+            TYPE_UNSPECIFIED = 0
+
+            # Include the target site.
+            INCLUDE = 1
+
+            # Exclude the target site.
+            EXCLUDE = 2
+          end
+
+          # Target site indexing status enumeration.
+          module IndexingStatus
+            # Defaults to SUCCEEDED.
+            INDEXING_STATUS_UNSPECIFIED = 0
+
+            # The target site is in the update queue and will be picked up by indexing
+            # pipeline.
+            PENDING = 1
+
+            # The target site fails to be indexed.
+            FAILED = 2
+
+            # The target site has been indexed.
+            SUCCEEDED = 3
+
+            # The previously indexed target site has been marked to be deleted. This is
+            # a transitioning state which will resulted in either:
+            # 1. target site deleted if unindexing is successful;
+            # 2. state reverts to SUCCEEDED if the unindexing fails.
+            DELETING = 4
+          end
+        end
+
+        # Verification information for target sites in advanced site search.
+        # @!attribute [rw] site_verification_state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SiteVerificationInfo::SiteVerificationState]
+        #     Site verification state indicating the ownership and validity.
+        # @!attribute [rw] verify_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Latest site verification time.
+        class SiteVerificationInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Site verification state.
+          module SiteVerificationState
+            # Defaults to VERIFIED.
+            SITE_VERIFICATION_STATE_UNSPECIFIED = 0
+
+            # Site ownership verified.
+            VERIFIED = 1
+
+            # Site ownership pending verification or verification failed.
+            UNVERIFIED = 2
+
+            # Site exempt from verification, e.g., a public website that opens to all.
+            EXEMPTED = 3
+          end
+        end
+      end
+    end
+  end
+end