google-cloud-discovery_engine-v1 0.8.0 → 1.0.0

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

@@ -338,6 +338,41 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # AlloyDB source import data from.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID that the AlloyDB source is in
+        #     with a length limit of 128 characters. If not specified, inherits the
+        #     project ID from the parent request.
+        # @!attribute [rw] location_id
+        #   @return [::String]
+        #     Required. The AlloyDB location to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] cluster_id
+        #   @return [::String]
+        #     Required. The AlloyDB cluster to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     Required. The AlloyDB database to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] table_id
+        #   @return [::String]
+        #     Required. The AlloyDB table to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] gcs_staging_dir
+        #   @return [::String]
+        #     Intermediate Cloud Storage directory used for the import with a length
+        #     limit of 2,000 characters. Can be specified if one wants to have the
+        #     AlloyDB export to a specific Cloud Storage directory.
+        #
+        #     Ensure that the AlloyDB service account has the necessary Cloud
+        #     Storage Admin permissions to access the specified Cloud Storage directory.
+        class AlloyDbSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Firestore source import data from.
         # @!attribute [rw] project_id
         #   @return [::String]
@@ -496,6 +531,9 @@ module Google
         # @!attribute [rw] firestore_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1::FirestoreSource]
         #     Firestore input source.
+        # @!attribute [rw] alloy_db_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AlloyDbSource]
+        #     AlloyDB input source.
         # @!attribute [rw] bigtable_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableSource]
         #     Cloud Bigtable input source.
@@ -689,6 +727,82 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#import_completion_suggestions CompletionService.ImportCompletionSuggestions}
+        # method.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ImportCompletionSuggestionsRequest::InlineSource]
+        #     The Inline source for suggestion entries.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
+        #     Cloud Storage location for the input content.
+        # @!attribute [rw] bigquery_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource]
+        #     BigQuery input source.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to import customer
+        #     autocomplete suggestions.
+        #
+        #     Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportCompletionSuggestionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for CompletionSuggestions.
+          # @!attribute [rw] suggestions
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::CompletionSuggestion>]
+          #     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 of the
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#import_completion_suggestions CompletionService.ImportCompletionSuggestions}
+        # method. If the long running operation is done, this message is returned by
+        # the google.longrunning.Operations.response field if the operation is
+        # successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportCompletionSuggestionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the ImportCompletionSuggestions
+        # operation. This will be 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.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of
+        #     {::Google::Cloud::DiscoveryEngine::V1::CompletionSuggestion CompletionSuggestion}s
+        #     successfully imported.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of
+        #     {::Google::Cloud::DiscoveryEngine::V1::CompletionSuggestion CompletionSuggestion}s
+        #     that failed to be imported.
+        class ImportCompletionSuggestionsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -122,6 +122,48 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_completion_suggestions CompletionService.PurgeCompletionSuggestions}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to purge completion
+        #     suggestions. Follows pattern
+        #     projects/*/locations/*/collections/*/dataStores/*.
+        class PurgeCompletionSuggestionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_completion_suggestions CompletionService.PurgeCompletionSuggestions}
+        # method.
+        # @!attribute [rw] purge_succeeded
+        #   @return [::Boolean]
+        #     Whether the completion suggestions were successfully purged.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        class PurgeCompletionSuggestionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the PurgeCompletionSuggestions
+        # 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 PurgeCompletionSuggestionsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -130,6 +130,13 @@ module Google
         #     Highly recommended for analytics.
         #     {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_agent UserInfo.user_agent}
         #     is used to deduce `device_type` for analytics.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+        #     information, see [Standard
+        #     fields](https://cloud.google.com/apis/design/standard_fields). This field
+        #     helps to better interpret the query. If a value isn't specified, the query
+        #     language code is automatically detected, which may not be accurate.
         # @!attribute [rw] facet_specs
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec>]
         #     Facet specifications for faceted search. If empty, no facets are returned.
@@ -208,6 +215,44 @@ module Google
         #     See [Google Cloud
         #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         #     for more details.
+        # @!attribute [rw] search_as_you_type_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec]
+        #     Search as you type configuration. Only supported for the
+        #     {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
+        #     vertical.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     The session resource name. Optional.
+        #
+        #     Session allows users to do multi-turn /search API calls or coordination
+        #     between /search API calls and /answer API calls.
+        #
+        #     Example #1 (multi-turn /search API calls):
+        #       1. Call /search API with the auto-session mode (see below).
+        #       2. Call /search API with the session ID generated in the first call.
+        #          Here, the previous search query gets considered in query
+        #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
+        #          and the current query is "How about 2023?", the current query will
+        #          be interpreted as "How did Alphabet do in 2023?".
+        #
+        #     Example #2 (coordination between /search API calls and /answer API calls):
+        #       1. Call /search API with the auto-session mode (see below).
+        #       2. Call /answer API with the session ID generated in the first call.
+        #          Here, the answer generation happens in the context of the search
+        #          results from the first search call.
+        #
+        #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
+        #     gets automatically created. Otherwise, users can use the create-session API
+        #     to create a session manually.
+        #
+        #     Multi-turn Search feature is currently at private GA stage. Please use
+        #     v1alpha or v1beta version instead before we launch this feature to public
+        #     GA. Or ask for allowlisting through Google Support team.
+        # @!attribute [rw] session_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec]
+        #     Session specification.
+        #
+        #     Can be used only when `session` is set.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -223,8 +268,8 @@ module Google
           end
 
           # A struct to define data stores to filter on in a search call and
-          # configurations for those data stores. A maximum of 1 DataStoreSpec per
-          # data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          # configurations for those data stores. Otherwise, an `INVALID_ARGUMENT`
+          # error is returned.
           # @!attribute [rw] data_store
           #   @return [::String]
           #     Required. Full resource name of
@@ -244,6 +289,9 @@ module Google
           #     Maximum facet values that are returned for this facet. If
           #     unspecified, defaults to 20. The maximum allowed value is 300. Values
           #     above 300 are coerced to 300.
+          #     For aggregation in healthcare search, when the [FacetKey.key] is
+          #     "healthcare_aggregation_key", the limit will be overridden to
+          #     10,000 internally, regardless of the value set here.
           #
           #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
           # @!attribute [rw] excluded_filter_keys
@@ -497,6 +545,21 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec]
           #     If there is no extractive_content_spec provided, there will be no
           #     extractive answer in the search response.
+          # @!attribute [rw] search_result_mode
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode]
+          #     Specifies the search result mode. If unspecified, the
+          #     search result mode is based on
+          #     [DataStore.DocumentProcessingConfig.chunking_config][]:
+          #     * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
+          #       it defaults to `CHUNKS`.
+          #     * Otherwise, it defaults to `DOCUMENTS`.
+          # @!attribute [rw] chunk_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec]
+          #     Specifies the chunk spec to be returned from the search response.
+          #     Only available if the
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+          #     is set to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
           class ContentSearchSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -533,8 +596,9 @@ module Google
             #
             #     At most 10 results for documents mode, or 50 for chunks mode, can be
             #     used to generate a summary. The chunks mode is used when
-            #     [SearchRequest.ContentSearchSpec.search_result_mode][] is set to
-            #     [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+            #     is set to
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
             # @!attribute [rw] include_citations
             #   @return [::Boolean]
             #     Specifies whether to include citations in the summary. The default
@@ -691,6 +755,114 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # Specifies the chunk spec to be returned from the search response.
+            # Only available if the
+            # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+            # is set to
+            # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
+            # @!attribute [rw] num_previous_chunks
+            #   @return [::Integer]
+            #     The number of previous chunks to be returned of the current chunk. The
+            #     maximum allowed value is 3.
+            #     If not specified, no previous chunks will be returned.
+            # @!attribute [rw] num_next_chunks
+            #   @return [::Integer]
+            #     The number of next chunks to be returned of the current chunk. The
+            #     maximum allowed value is 3.
+            #     If not specified, no next chunks will be returned.
+            class ChunkSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specifies the search result mode. If unspecified, the
+            # search result mode is based on
+            # [DataStore.DocumentProcessingConfig.chunking_config][]:
+            # * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
+            #   it defaults to `CHUNKS`.
+            # * Otherwise, it defaults to `DOCUMENTS`.
+            module SearchResultMode
+              # Default value.
+              SEARCH_RESULT_MODE_UNSPECIFIED = 0
+
+              # Returns documents in the search result.
+              DOCUMENTS = 1
+
+              # Returns chunks in the search result. Only available if the
+              # [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
+              CHUNKS = 2
+            end
+          end
+
+          # Specification for search as you type in search requests.
+          # @!attribute [rw] condition
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Condition]
+          #     The condition under which search as you type should occur.
+          #     Default to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Condition::DISABLED Condition.DISABLED}.
+          class SearchAsYouTypeSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Enum describing under which condition search as you type should occur.
+            module Condition
+              # Server behavior defaults to
+              # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Condition::DISABLED Condition.DISABLED}.
+              CONDITION_UNSPECIFIED = 0
+
+              # Disables Search As You Type.
+              DISABLED = 1
+
+              # Enables Search As You Type.
+              ENABLED = 2
+            end
+          end
+
+          # Session specification.
+          #
+          # Multi-turn Search feature is currently at private GA stage. Please use
+          # v1alpha or v1beta version instead before we launch this feature to public
+          # GA. Or ask for allowlisting through Google Support team.
+          # @!attribute [rw] query_id
+          #   @return [::String]
+          #     If set, the search result gets stored to the "turn" specified by this
+          #     query ID.
+          #
+          #     Example: Let's say the session looks like this:
+          #       session {
+          #         name: ".../sessions/xxx"
+          #         turns {
+          #           query { text: "What is foo?" query_id: ".../questions/yyy" }
+          #           answer: "Foo is ..."
+          #         }
+          #         turns {
+          #           query { text: "How about bar then?" query_id: ".../questions/zzz" }
+          #         }
+          #       }
+          #
+          #     The user can call /search API with a request like this:
+          #
+          #        session: ".../sessions/xxx"
+          #        session_spec { query_id: ".../questions/zzz" }
+          #
+          #     Then, the API stores the search result, associated with the last turn.
+          #     The stored search result can be used by a subsequent /answer API call
+          #     (with the session ID and the query ID specified). Also, it is possible
+          #     to call /search and /answer in parallel with the same session ID & query
+          #     ID.
+          # @!attribute [rw] search_result_persistence_count
+          #   @return [::Integer]
+          #     The number of top search results to persist. The persisted search results
+          #     can be used for the subsequent /answer api call.
+          #
+          #     This field is simliar to the `summary_result_count` field in
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#summary_result_count SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count}.
+          #
+          #     At most 10 results for documents mode, or 50 for chunks mode.
+          class SessionSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
           # @!attribute [rw] key
@@ -762,6 +934,13 @@ module Google
         # @!attribute [rw] query_expansion_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::QueryExpansionInfo]
         #     Query expansion information for the returned results.
+        # @!attribute [rw] session_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SessionInfo]
+        #     Session information.
+        #
+        #     Only set if
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#session SearchRequest.session}
+        #     is provided. See its description for more details.
         class SearchResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -775,6 +954,12 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
           #     The document data snippet in the search response. Only fields that are
           #     marked as `retrievable` are populated.
+          # @!attribute [rw] chunk
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Chunk]
+          #     The chunk data in the search response if the
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
+          #     is set to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
           class SearchResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -983,6 +1168,26 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Information about the session.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Name of the session.
+          #     If the auto-session mode is used (when
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#session SearchRequest.session}
+          #     ends with "-"), this field holds the newly generated session name.
+          # @!attribute [rw] query_id
+          #   @return [::String]
+          #     Query ID that corresponds to this search API call.
+          #     One session can have multiple turns, each with a unique query ID.
+          #
+          #     By specifying the session name and this query ID in the Answer API call,
+          #     the answer generation happens in the context of the search results from
+          #     this search call.
+          class SessionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-discovery_engine-v1
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -195,6 +195,7 @@ files:
 - lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1/version.rb
 - lib/google/cloud/discoveryengine/v1/answer_pb.rb
+- lib/google/cloud/discoveryengine/v1/chunk_pb.rb
 - lib/google/cloud/discoveryengine/v1/common_pb.rb
 - lib/google/cloud/discoveryengine/v1/completion_pb.rb
 - lib/google/cloud/discoveryengine/v1/completion_service_pb.rb
@@ -246,6 +247,7 @@ files:
 - proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/discoveryengine/v1/answer.rb
+- proto_docs/google/cloud/discoveryengine/v1/chunk.rb
 - proto_docs/google/cloud/discoveryengine/v1/common.rb
 - proto_docs/google/cloud/discoveryengine/v1/completion.rb
 - proto_docs/google/cloud/discoveryengine/v1/completion_service.rb