google-cloud-discovery_engine-v1beta 0.14.2 → 0.16.0

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

@@ -93,6 +93,9 @@ module Google
           # @!attribute [rw] chunk_info
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::ChunkInfo]
           #     Chunk information.
+          # @!attribute [rw] structured_document_info
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::StructuredDocumentInfo]
+          #     Structured document information.
           class Reference
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -125,6 +128,13 @@ module Google
               # @!attribute [rw] page_identifier
               #   @return [::String]
               #     Page identifier.
+              # @!attribute [rw] relevance_score
+              #   @return [::Float]
+              #     The relevance of the chunk for a given query. Values range from 0.0
+              #     (completely irrelevant) to 1.0 (completely relevant).
+              #     This value is for informational purpose only. It may change for
+              #     the same query and chunk at any time due to a model retraining or
+              #     change in implementation.
               class ChunkContent
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -140,7 +150,11 @@ module Google
             #     Chunk textual content.
             # @!attribute [rw] relevance_score
             #   @return [::Float]
-            #     Relevance score.
+            #     The relevance of the chunk for a given query. Values range from 0.0
+            #     (completely irrelevant) to 1.0 (completely relevant).
+            #     This value is for informational purpose only. It may change for
+            #     the same query and chunk at any time due to a model retraining or
+            #     change in implementation.
             # @!attribute [rw] document_metadata
             #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::ChunkInfo::DocumentMetadata]
             #     Document metadata.
@@ -170,6 +184,18 @@ module Google
                 extend ::Google::Protobuf::MessageExts::ClassMethods
               end
             end
+
+            # Structured search information.
+            # @!attribute [rw] document
+            #   @return [::String]
+            #     Document resource name.
+            # @!attribute [rw] struct_data
+            #   @return [::Google::Protobuf::Struct]
+            #     Structured search data.
+            class StructuredDocumentInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # Step information.
@@ -239,10 +265,8 @@ module Google
                 #   @return [::Google::Protobuf::Struct]
                 #     Data representation.
                 #     The structured JSON data for the document.
-                #     It's populated from the struct data from the Document
-                #     , or the Chunk in
-                #     search result
-                #     .
+                #     It's populated from the struct data from the Document, or the
+                #     Chunk in search result.
                 class SearchResult
                   include ::Google::Protobuf::MessageExts
                   extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -268,7 +292,11 @@ module Google
                   #     Chunk textual content.
                   # @!attribute [rw] relevance_score
                   #   @return [::Float]
-                  #     Relevance score.
+                  #     The relevance of the chunk for a given query. Values range from
+                  #     0.0 (completely irrelevant) to 1.0 (completely relevant).
+                  #     This value is for informational purpose only. It may change for
+                  #     the same query and chunk at any time due to a model retraining or
+                  #     change in implementation.
                   class ChunkInfo
                     include ::Google::Protobuf::MessageExts
                     extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -320,8 +348,14 @@ module Google
                 # Adversarial query classification type.
                 ADVERSARIAL_QUERY = 1
 
-                # Non-answer-seeking query classification type.
+                # Non-answer-seeking query classification type, for chit chat.
                 NON_ANSWER_SEEKING_QUERY = 2
+
+                # Jail-breaking query classification type.
+                JAIL_BREAKING_QUERY = 3
+
+                # Non-answer-seeking query classification type, for no clear intent.
+                NON_ANSWER_SEEKING_QUERY_V2 = 4
               end
             end
           end
@@ -349,7 +383,9 @@ module Google
             # The adversarial query ignored case.
             ADVERSARIAL_QUERY_IGNORED = 1
 
-            # The non-answer seeking query ignored case.
+            # The non-answer seeking query ignored case
+            #
+            # Google skips the answer if the query is chit chat.
             NON_ANSWER_SEEKING_QUERY_IGNORED = 2
 
             # The out-of-domain query ignored case.
@@ -368,6 +404,30 @@ module Google
             # Google skips the answer if there is no relevant content in the
             # retrieved search results.
             NO_RELEVANT_CONTENT = 5
+
+            # The jail-breaking query ignored case.
+            #
+            # For example, "Reply in the tone of a competing company's CEO".
+            # Google skips the answer if the query is classified as a jail-breaking
+            # query.
+            JAIL_BREAKING_QUERY_IGNORED = 6
+
+            # The customer policy violation case.
+            #
+            # Google skips the summary if there is a customer policy violation
+            # detected. The policy is defined by the customer.
+            CUSTOMER_POLICY_VIOLATION = 7
+
+            # The non-answer seeking query ignored case.
+            #
+            # Google skips the answer if the query doesn't have clear intent.
+            NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8
+
+            # The low-grounded answer case.
+            #
+            # Google skips the answer if a well grounded answer was unable to be
+            # generated.
+            LOW_GROUNDED_ANSWER = 9
           end
         end
       end

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

@@ -111,6 +111,274 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#advanced_complete_query CompletionService.AdvancedCompleteQuery}
+        # method.
+        # .
+        # @!attribute [rw] completion_config
+        #   @return [::String]
+        #     Required. The completion_config of the parent dataStore or engine resource
+        #     name for which the completion is performed, such as
+        #     `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
+        #     `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     Required. The typeahead input used to fetch suggestions. Maximum length is
+        #     128 characters.
+        #
+        #     The query can not be empty for most of the suggestion types. If it is
+        #     empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
+        #     suggestion_types contains only the type `RECENT_SEARCH`, the query can
+        #     be an empty string. The is called "zero prefix" feature, which returns
+        #     user's recently searched queries given the empty query.
+        # @!attribute [rw] query_model
+        #   @return [::String]
+        #     Specifies the autocomplete data model. This overrides any model specified
+        #     in the Configuration > Autocomplete section of the Cloud console. Currently
+        #     supported values:
+        #
+        #     * `document` - Using suggestions generated from user-imported documents.
+        #     * `search-history` - Using suggestions generated from the past history of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
+        #     API calls. Do not use it when there is no traffic for Search API.
+        #     * `user-event` - Using suggestions generated from user-imported search
+        #     events.
+        #     * `document-completable` - Using suggestions taken directly from
+        #     user-imported document fields marked as completable.
+        #
+        #     Default values:
+        #
+        #     * `document` is the default model for regular dataStores.
+        #     * `search-history` is the default model for site search dataStores.
+        # @!attribute [rw] user_pseudo_id
+        #   @return [::String]
+        #     A unique identifier for tracking visitors. For example, this could be
+        #     implemented with an HTTP cookie, which should be able to uniquely identify
+        #     a visitor on a single device. This unique identifier should not change if
+        #     the visitor logs in or out of the website.
+        #
+        #     This field should NOT have a fixed value such as `unknown_visitor`.
+        #
+        #     This should be the same identifier as
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+        #     and
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
+        #
+        #     The field must be a UTF-8 encoded string with a length limit of 128
+        # @!attribute [rw] user_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo]
+        #     Optional. Information about the end user.
+        #
+        #     This should be the same identifier information as
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_info UserEvent.user_info}
+        #     and
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_info SearchRequest.user_info}.
+        # @!attribute [rw] include_tail_suggestions
+        #   @return [::Boolean]
+        #     Indicates if tail suggestions should be returned if there are no
+        #     suggestions that match the full query. Even if set to true, if there are
+        #     suggestions that match the full query, those are returned and no
+        #     tail suggestions are returned.
+        # @!attribute [rw] boost_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec]
+        #     Optional. Specification to boost suggestions matching the condition.
+        # @!attribute [rw] suggestion_types
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionType>]
+        #     Optional. Suggestion types to return. If empty or unspecified, query
+        #     suggestions are returned. Only one suggestion type is supported at the
+        #     moment.
+        class AdvancedCompleteQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specification to boost suggestions based on the condtion of the suggestion.
+          # @!attribute [rw] condition_boost_specs
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec::ConditionBoostSpec>]
+          #     Condition boost specifications. If a suggestion matches multiple
+          #     conditions in the specifictions, boost values from these specifications
+          #     are all applied and combined in a non-linear way. Maximum number of
+          #     specifications is 20.
+          #
+          #     Note: Currently only support language condition boost.
+          class BoostSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Boost applies to suggestions which match a condition.
+            # @!attribute [rw] condition
+            #   @return [::String]
+            #     An expression which specifies a boost condition. The syntax is the same
+            #     as [filter expression
+            #     syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax).
+            #     Currently, the only supported condition is a list of BCP-47 lang codes.
+            #
+            #     Example:
+            #
+            #     * To boost suggestions in languages `en` or `fr`:
+            #     `(lang_code: ANY("en", "fr"))`
+            # @!attribute [rw] boost
+            #   @return [::Float]
+            #     Strength of the boost, which should be in [-1, 1].
+            #     Negative boost means demotion. Default is 0.0.
+            #
+            #     Setting to 1.0 gives the suggestions a big promotion. However, it does
+            #     not necessarily mean that the top result will be a boosted suggestion.
+            #
+            #     Setting to -1.0 gives the suggestions a big demotion. However, other
+            #     suggestions that are relevant might still be shown.
+            #
+            #     Setting to 0.0 means no boost applied. The boosting condition is
+            #     ignored.
+            class ConditionBoostSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Suggestion type to return.
+          module SuggestionType
+            # Default value.
+            SUGGESTION_TYPE_UNSPECIFIED = 0
+
+            # Returns query suggestions.
+            QUERY = 1
+
+            # Returns people suggestions.
+            PEOPLE = 2
+
+            # Returns content suggestions.
+            CONTENT = 3
+
+            # Returns recent search suggestions.
+            RECENT_SEARCH = 4
+
+            # Returns Google Workspace suggestions.
+            GOOGLE_WORKSPACE = 5
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#advanced_complete_query CompletionService.AdvancedCompleteQuery}
+        # method.
+        # @!attribute [rw] query_suggestions
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::QuerySuggestion>]
+        #     Results of the matched query suggestions. The result list is ordered and
+        #     the first result is a top suggestion.
+        # @!attribute [rw] tail_match_triggered
+        #   @return [::Boolean]
+        #     True if the returned suggestions are all tail suggestions.
+        #
+        #     For tail matching to be triggered, include_tail_suggestions in the request
+        #     must be true and there must be no suggestions that match the full query.
+        # @!attribute [rw] people_suggestions
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::PersonSuggestion>]
+        #     Results of the matched people suggestions. The result list is ordered and
+        #     the first result is the top suggestion.
+        # @!attribute [rw] content_suggestions
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::ContentSuggestion>]
+        #     Results of the matched content suggestions. The result list is ordered and
+        #     the first result is the top suggestion.
+        # @!attribute [rw] recent_search_suggestions
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::RecentSearchSuggestion>]
+        #     Results of the matched "recent search" suggestions. The result list is
+        #     ordered and the first result is the top suggestion.
+        class AdvancedCompleteQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Suggestions as search queries.
+          # @!attribute [rw] suggestion
+          #   @return [::String]
+          #     The suggestion for the query.
+          # @!attribute [rw] completable_field_paths
+          #   @return [::Array<::String>]
+          #     The unique document field paths that serve as the source of this
+          #     suggestion if it was generated from completable fields.
+          #
+          #     This field is only populated for the document-completable model.
+          # @!attribute [rw] data_store
+          #   @return [::Array<::String>]
+          #     The name of the dataStore that this suggestion belongs to.
+          class QuerySuggestion
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Suggestions as people.
+          # @!attribute [rw] suggestion
+          #   @return [::String]
+          #     The suggestion for the query.
+          # @!attribute [rw] person_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::PersonSuggestion::PersonType]
+          #     The type of the person.
+          # @!attribute [rw] document
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
+          #     The document data snippet in the suggestion. Only a subset of fields is
+          #     populated.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     The name of the dataStore that this suggestion belongs to.
+          class PersonSuggestion
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the person based on the source.
+            module PersonType
+              # Default value.
+              PERSON_TYPE_UNSPECIFIED = 0
+
+              # The suggestion is from a GOOGLE_IDENTITY source.
+              CLOUD_IDENTITY = 1
+
+              # The suggestion is from a THIRD_PARTY_IDENTITY source.
+              THIRD_PARTY_IDENTITY = 2
+            end
+          end
+
+          # Suggestions as content.
+          # @!attribute [rw] suggestion
+          #   @return [::String]
+          #     The suggestion for the query.
+          # @!attribute [rw] content_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse::ContentSuggestion::ContentType]
+          #     The type of the content suggestion.
+          # @!attribute [rw] document
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
+          #     The document data snippet in the suggestion. Only a subset of fields will
+          #     be populated.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     The name of the dataStore that this suggestion belongs to.
+          class ContentSuggestion
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the content returned for content suggestions.
+            module ContentType
+              # Default value.
+              CONTENT_TYPE_UNSPECIFIED = 0
+
+              # The suggestion is from a Google Workspace source.
+              GOOGLE_WORKSPACE = 1
+
+              # The suggestion is from a third party source.
+              THIRD_PARTY = 2
+            end
+          end
+
+          # Suggestions from recent search history.
+          # @!attribute [rw] suggestion
+          #   @return [::String]
+          #     The suggestion for the query.
+          # @!attribute [rw] recent_search_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time when this recent rearch happened.
+          class RecentSearchSuggestion
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end

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

@@ -26,6 +26,9 @@ module Google
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::QueryTerm>]
         #     Search only
         #     A list of terms to match the query on.
+        #     Cannot be set when
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Condition#query_regex Condition.query_regex}
+        #     is set.
         #
         #     Maximum of 10 query terms.
         # @!attribute [rw] active_time_range
@@ -33,6 +36,12 @@ module Google
         #     Range of time(s) specifying when condition is active.
         #
         #     Maximum of 10 time ranges.
+        # @!attribute [rw] query_regex
+        #   @return [::String]
+        #     Optional. Query regex to match the whole search query.
+        #     Cannot be set when
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Condition#query_terms Condition.query_terms}
+        #     is set. This is currently supporting promotion use case.
         class Condition
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -102,7 +111,7 @@ module Google
         # @!attribute [r] associated_serving_config_ids
         #   @return [::Array<::String>]
         #     Output only. List of all
-        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} ids this
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} IDs this
         #     control is attached to. May take up to 10 minutes to update after changes.
         # @!attribute [rw] solution_type
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SolutionType]

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

@@ -25,9 +25,9 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Full resource name of parent data store. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
         #     or
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
         # @!attribute [rw] control
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
         #     Required. The Control to create.
@@ -66,7 +66,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Control to delete. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
         class DeleteControlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -76,7 +76,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Control to get. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
         class GetControlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -86,9 +86,9 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The data store resource name. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
         #     or
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Maximum number of results to return. If unspecified, defaults