google-cloud-discovery_engine-v1beta 0.7.2 → 0.9.0

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

@@ -338,6 +338,72 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#import_suggestion_deny_list_entries CompletionService.ImportSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportSuggestionDenyListEntriesRequest::InlineSource]
+        #     The Inline source for the input content for suggestion deny list entries.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource]
+        #     Cloud Storage location for the input content.
+        #
+        #     Only 1 file can be specified that contains all entries to import.
+        #     Supported values `gcs_source.schema` for autocomplete suggestion deny
+        #     list entry imports:
+        #
+        #     * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
+        #     per line.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to import denylist
+        #     entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+        class ImportSuggestionDenyListEntriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for SuggestionDenyListEntry.
+          # @!attribute [rw] entries
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SuggestionDenyListEntry>]
+          #     Required. A list of all denylist entries to import. Max of 1000 items.
+          class InlineSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#import_suggestion_deny_list_entries CompletionService.ImportSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] imported_entries_count
+        #   @return [::Integer]
+        #     Count of deny list entries successfully imported.
+        # @!attribute [rw] failed_entries_count
+        #   @return [::Integer]
+        #     Count of deny list entries that failed to be imported.
+        class ImportSuggestionDenyListEntriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the ImportSuggestionDenyListEntries
+        # operation. This is returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!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 ImportSuggestionDenyListEntriesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -78,6 +78,47 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#purge_suggestion_deny_list_entries CompletionService.PurgeSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to import denylist
+        #     entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+        class PurgeSuggestionDenyListEntriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#purge_suggestion_deny_list_entries CompletionService.PurgeSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] purge_count
+        #   @return [::Integer]
+        #     Number of suggestion deny list entries purged.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        class PurgeSuggestionDenyListEntriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the PurgeSuggestionDenyListEntries
+        # operation. This is returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!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 PurgeSuggestionDenyListEntriesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -24,11 +24,19 @@ module Google
         # Request message for Recommend method.
         # @!attribute [rw] serving_config
         #   @return [::String]
-        #     Required. Full resource name of the format:
+        #     Required. Full resource name of a
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig}:
+        #     `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
         #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
         #
-        #     Before you can request recommendations from your model, you must create at
-        #     least one serving config  for it.
+        #     One default serving config is created along with your recommendation engine
+        #     creation. The engine ID will be used as the ID of the default serving
+        #     config. For example, for Engine
+        #     `projects/*/locations/global/collections/*/engines/my-engine`, you can use
+        #     `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
+        #     for your
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client#recommend RecommendationService.Recommend}
+        #     requests.
         # @!attribute [rw] user_event
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent]
         #     Required. Context about the user, what they are looking at and what action
@@ -65,6 +73,14 @@ module Google
         #      * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
         #      * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
         #
+        #     If `attributeFilteringSyntax` is set to true under the `params` field, then
+        #     attribute-based expressions are expected instead of the above described
+        #     tag-based syntax. Examples:
+        #
+        #      * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
+        #      * (available: true) AND
+        #        (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
+        #
         #     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
@@ -106,6 +122,9 @@ module Google
         #         *  `auto-diversity`
         #        This gives request-level control and adjusts recommendation results
         #        based on Document category.
+        #     * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
+        #        the `filter` field is interpreted according to the new,
+        #        attribute-based syntax.
         # @!attribute [rw] user_labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     The user labels applied to a resource must meet the following requirements:

data/proto_docs/google/cloud/discoveryengine/v1beta/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::V1beta::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::V1beta::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::V1beta::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::V1beta::SearchRequest::QueryExpansionSpec]
         #     The query expansion specification that specifies the conditions under which
@@ -142,16 +179,18 @@ module Google
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec]
         #     Uses the provided embedding to do additional semantic document retrieval.
         #     The retrieval is based on the dot product of
-        #     [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document
-        #     embedding that is provided in
-        #     [SearchRequest.embedding_spec.embedding_vectors.field_path][].
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#vector SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
+        #     and the document embedding that is provided in
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#field_path SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
         #
-        #     If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not
-        #     provided, it will use [ServingConfig.embedding_config.field_paths][].
+        #     If
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#field_path SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
+        #     is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
         # @!attribute [rw] ranking_expression
         #   @return [::String]
         #     The ranking expression controls the customized ranking on retrieval
-        #     documents. This overrides [ServingConfig.ranking_expression][].
+        #     documents. This overrides
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
         #     The ranking expression is a single function or multiple functions that are
         #     joint by "+".
         #       * ranking_expression = function, { " + ", function };
@@ -546,13 +585,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::V1beta::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::V1beta::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
 
             # A specification for configuring the extractive content in a search
@@ -570,18 +646,18 @@ module Google
             #     `max_extractive_answer_count`, return all of the answers. Otherwise,
             #     return the `max_extractive_answer_count`.
             #
-            #     At most one answer is returned for each
+            #     At most five answers are returned for each
             #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
             # @!attribute [rw] max_extractive_segment_count
             #   @return [::Integer]
             #     The max number of extractive segments returned in each search result.
             #     Only applied if the
-            #     [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to
-            #     [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED]
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is set to
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
             #     or
-            #     [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types]
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore#solution_types DataStore.solution_types}
             #     is
-            #     [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
             #
             #     An extractive segment is a text segment extracted from the original
             #     document that is relevant to the search query, and, in general, more
@@ -595,6 +671,9 @@ module Google
             #   @return [::Boolean]
             #     Specifies whether to return the confidence score from the extractive
             #     segments in each search result. The default value is `false`.
+            #
+            #     Note: this is a priavte preview feature and only works for allowlisted
+            #     users, please reach out to Cloud Support team if you want to use it.
             # @!attribute [rw] num_previous_segments
             #   @return [::Integer]
             #     Specifies whether to also include the adjacent from each selected
@@ -809,6 +888,9 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
           #     A collection of Safety Attribute categories and their associated
           #     confidence scores.
+          # @!attribute [rw] summary_with_metadata
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
+          #     Summary with metadata information.
           class Summary
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -827,6 +909,75 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # Citation metadata.
+            # @!attribute [rw] citations
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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::V1beta::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::V1beta::SearchResponse::Summary::CitationMetadata]
+            #     Citation metadata for given summary.
+            # @!attribute [rw] references
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::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.