google-cloud-discovery_engine-v1 0.4.2 → 0.5.0

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

@@ -27,6 +27,8 @@ module Google
         # @!attribute [rw] serving_config
         #   @return [::String]
         #     Required. The resource name of the Search serving config, such as
+        #     `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
+        #     or
         #     `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
         #     This field is used to identify the serving configuration name, set
         #     of models used to make the search.
@@ -77,12 +79,37 @@ module Google
         #     expression is case-sensitive.
         #
         #     If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+        #
+        #     Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+        #     key property defined in the Vertex AI Search backend -- this mapping is
+        #     defined by the customer in their schema. For example a media customer might
+        #     have a field 'name' in their schema. In this case the filter would look
+        #     like this: filter --> name:'ANY("king kong")'
+        #
+        #     For more information about filtering including syntax and filter
+        #     operators, see
+        #     [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+        # @!attribute [rw] canonical_filter
+        #   @return [::String]
+        #     The default filter that is applied when a user performs a search without
+        #     checking any filters on the search page.
+        #
+        #     The filter applied to every search request when quality improvement such as
+        #     query expansion is needed. In the case a query does not have a sufficient
+        #     amount of results this filter will be used to determine whether or not to
+        #     enable the query expansion flow. The original filter will still be used for
+        #     the query expanded search.
+        #     This field is strongly recommended to achieve high search quality.
+        #
+        #     For more information about filter syntax, see
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
         # @!attribute [rw] order_by
         #   @return [::String]
         #     The order in which documents are returned. Documents can be ordered by
         #     a field in an {::Google::Cloud::DiscoveryEngine::V1::Document Document} object.
         #     Leave it unset if ordered by relevance. `order_by` expression is
-        #     case-sensitive.
+        #     case-sensitive. For more information on ordering, see
+        #     [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
         #
         #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         # @!attribute [rw] user_info
@@ -100,6 +127,8 @@ module Google
         # @!attribute [rw] boost_spec
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec]
         #     Boost specification to boost certain documents.
+        #     For more information on boosting, see
+        #     [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
         # @!attribute [rw] params
         #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
         #     Additional search parameters.
@@ -108,9 +137,17 @@ module Google
         #
         #     * `user_country_code`: string. Default empty. If set to non-empty, results
         #        are restricted or boosted based on the location provided.
+        #        Example:
+        #        user_country_code: "au"
+        #
+        #        For available codes see [Country
+        #        Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
+        #
         #     * `search_type`: double. Default empty. Enables non-webpage searching
-        #       depending on the value. The only valid non-default value is 1,
-        #       which enables image searching.
+        #        depending on the value. The only valid non-default value is 1,
+        #        which enables image searching.
+        #        Example:
+        #        search_type: 1
         # @!attribute [rw] query_expansion_spec
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec]
         #     The query expansion specification that specifies the conditions under which
@@ -511,13 +548,50 @@ module Google
             #     navigational queries. If this field is set to `true`, we skip
             #     generating summaries for non-summary seeking queries and return
             #     fallback messages instead.
+            # @!attribute [rw] model_prompt_spec
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
+            #     If specified, the spec will be used to modify the prompt provided to
+            #     the LLM.
             # @!attribute [rw] language_code
             #   @return [::String]
             #     Language code for Summary. Use language tags defined by
-            #     [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
+            #     [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
+            #     Note: This is an experimental feature.
+            # @!attribute [rw] model_spec
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
+            #     If specified, the spec will be used to modify the model specification
+            #     provided to the LLM.
             class SummarySpec
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Specification of the prompt to use with the model.
+              # @!attribute [rw] preamble
+              #   @return [::String]
+              #     Text at the beginning of the prompt that instructs the assistant.
+              #     Examples are available in the user guide.
+              class ModelPromptSpec
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Specification of the model.
+              # @!attribute [rw] version
+              #   @return [::String]
+              #     The model version used to generate the summary.
+              #
+              #     Supported values are:
+              #
+              #     * `stable`: string. Default value when no value is specified. Uses a
+              #       generally available, fine-tuned version of the text-bison@001
+              #       model.
+              #     * `preview`: string. (Public preview) Uses a fine-tuned version of
+              #       the text-bison@002 model. This model works only for summaries in
+              #       English.
+              class ModelSpec
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
             end
           end
 
@@ -653,6 +727,9 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes]
           #     A collection of Safety Attribute categories and their associated
           #     confidence scores.
+          # @!attribute [rw] summary_with_metadata
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummaryWithMetadata]
+          #     Summary with metadata information.
           class Summary
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -671,6 +748,74 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # Citation metadata.
+            # @!attribute [rw] citations
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::Citation>]
+            #     Citations for segments.
+            class CitationMetadata
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Citation info for a segment.
+            # @!attribute [rw] start_index
+            #   @return [::Integer]
+            #     Index indicates the start of the segment, measured in bytes/unicode.
+            # @!attribute [rw] end_index
+            #   @return [::Integer]
+            #     End of the attributed segment, exclusive.
+            # @!attribute [rw] sources
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::CitationSource>]
+            #     Citation sources for the attributed segment.
+            class Citation
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Citation source.
+            # @!attribute [rw] reference_index
+            #   @return [::Integer]
+            #     Document reference index from SummaryWithMetadata.references.
+            #     It is 0-indexed and the value will be zero if the reference_index is
+            #     not set explicitly.
+            class CitationSource
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Document reference.
+            # @!attribute [rw] title
+            #   @return [::String]
+            #     Title of the document.
+            # @!attribute [rw] document
+            #   @return [::String]
+            #     Required.
+            #     {::Google::Cloud::DiscoveryEngine::V1::Document#name Document.name} of the
+            #     document. Full resource name of the referenced document, in the format
+            #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+            # @!attribute [rw] uri
+            #   @return [::String]
+            #     Cloud Storage or HTTP uri for the document.
+            class Reference
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Summary with metadata information.
+            # @!attribute [rw] summary
+            #   @return [::String]
+            #     Summary text with no citation information.
+            # @!attribute [rw] citation_metadata
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::CitationMetadata]
+            #     Citation metadata for given summary.
+            # @!attribute [rw] references
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::Reference>]
+            #     Document References.
+            class SummaryWithMetadata
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # An Enum for summary-skipped reasons.
             module SummarySkippedReason
               # Default value. The summary skipped reason is not specified.

data/proto_docs/google/cloud/discoveryengine/v1/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 V1
+        # 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::V1::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::V1::SiteVerificationInfo]
+        #     Output only. Site ownership and validity verification status.
+        # @!attribute [r] indexing_status
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::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::V1::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::V1::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::V1::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::V1::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