google-apis-discoveryengine_v1alpha 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9863624d7aca9ef038f39e9db1ec589c57f7d100fb799d6ee71e30e26b933022
-  data.tar.gz: 31a13fd1f7c9eeeca948526df998a7325acd0eb44f09e6cc19d14782507a9195
+  metadata.gz: 1c13ca72d119cad12e2e1445c5e2d48878a34269026159691976b315eaed78dd
+  data.tar.gz: f953015892fb521e7f2ab068397fb92d637ded26976d1728d89d634db4daef3a
 SHA512:
-  metadata.gz: 6a596bcd206a4e8ea92590ddb74f86b27f61a1052848db675aae3b81b7c9ac864a5ab97685781e104ea65582829ff41790d47e6cbe86ad9b2e424cebcd491d80
-  data.tar.gz: 3872081c566c8fd539267998a6df8e133758f9cbd294ccb4ce8ace6570cde7fdf138f266d75ffd1ba0f3df7d7523249648e342ce1894da071430fd3a77237815
+  metadata.gz: d53093596560775764fcf708f9f11c564dd25fe44c46acce53175654e90eb5824bf38f4b9d60eae9c377e47d364ae5f034878125490bee25a20b1d162bae75c9
+  data.tar.gz: aa294cdfd80c35f7ec4407485d5a1bfd31fc84f2e4631e4c557cc3f1a40082ec07bfbd589f7e4445299330cb7efdb908dc5594d6499d70c6f93c598f9788b735

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.22.0 (2023-10-01)
+
+* Regenerated from discovery document revision 20230925
+
+### v0.21.0 (2023-09-24)
+
+* Regenerated from discovery document revision 20230914
+
 ### v0.20.0 (2023-09-10)
 
 * Regenerated from discovery document revision 20230905

data/lib/google/apis/discoveryengine_v1alpha/classes.rb

@@ -762,7 +762,7 @@ module Google
         # 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 IndustryVertical.SITE_SEARCH dataStores.
+        # history` is the default model for site search dataStores.
         # Corresponds to the JSON property `queryModel`
         # @return [String]
         attr_accessor :query_model
@@ -2475,6 +2475,164 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the SiteSearchEngineService.RecrawlUris
+      # operation. This will be returned by the google.longrunning.Operation.metadata
+      # field.
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Unique URIs in the request that don't match any TargetSite in the DataStore,
+        # only match TargetSites that haven't been fully indexed, or match a TargetSite
+        # with type EXCLUDE.
+        # Corresponds to the JSON property `invalidUris`
+        # @return [Array<String>]
+        attr_accessor :invalid_uris
+      
+        # Total number of URIs that have yet to be crawled.
+        # Corresponds to the JSON property `pendingCount`
+        # @return [Fixnum]
+        attr_accessor :pending_count
+      
+        # Total number of URIs that were rejected due to insufficient indexing resources.
+        # Corresponds to the JSON property `quotaExceededCount`
+        # @return [Fixnum]
+        attr_accessor :quota_exceeded_count
+      
+        # Total number of URIs that have been crawled so far.
+        # Corresponds to the JSON property `successCount`
+        # @return [Fixnum]
+        attr_accessor :success_count
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        # Total number of unique URIs in the request that are not in invalid_uris.
+        # Corresponds to the JSON property `validUrisCount`
+        # @return [Fixnum]
+        attr_accessor :valid_uris_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @invalid_uris = args[:invalid_uris] if args.key?(:invalid_uris)
+          @pending_count = args[:pending_count] if args.key?(:pending_count)
+          @quota_exceeded_count = args[:quota_exceeded_count] if args.key?(:quota_exceeded_count)
+          @success_count = args[:success_count] if args.key?(:success_count)
+          @update_time = args[:update_time] if args.key?(:update_time)
+          @valid_uris_count = args[:valid_uris_count] if args.key?(:valid_uris_count)
+        end
+      end
+      
+      # Request message for SiteSearchEngineService.RecrawlUris method.
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an
+        # INVALID_ARGUMENT error is thrown. Each URI should match at least one
+        # TargetSite in `site_search_engine`.
+        # Corresponds to the JSON property `uris`
+        # @return [Array<String>]
+        attr_accessor :uris
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @uris = args[:uris] if args.key?(:uris)
+        end
+      end
+      
+      # Response message for SiteSearchEngineService.RecrawlUris method.
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse
+        include Google::Apis::Core::Hashable
+      
+        # URIs that were not crawled before the LRO terminated.
+        # Corresponds to the JSON property `failedUris`
+        # @return [Array<String>]
+        attr_accessor :failed_uris
+      
+        # Details for a sample of up to 10 `failed_uris`.
+        # Corresponds to the JSON property `failureSamples`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo>]
+        attr_accessor :failure_samples
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @failed_uris = args[:failed_uris] if args.key?(:failed_uris)
+          @failure_samples = args[:failure_samples] if args.key?(:failure_samples)
+        end
+      end
+      
+      # Details about why a particular URI failed to be crawled. Each FailureInfo
+      # contains one FailureReason per CorpusType.
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo
+        include Google::Apis::Core::Hashable
+      
+        # List of failure reasons by corpus type (e.g. desktop, mobile).
+        # Corresponds to the JSON property `failureReasons`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason>]
+        attr_accessor :failure_reasons
+      
+        # URI that failed to be crawled.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @failure_reasons = args[:failure_reasons] if args.key?(:failure_reasons)
+          @uri = args[:uri] if args.key?(:uri)
+        end
+      end
+      
+      # Details about why crawling failed for a particular CorpusType, e.g. DESKTOP
+      # and MOBILE crawling may fail for different reasons.
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason
+        include Google::Apis::Core::Hashable
+      
+        # DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
+        # Corresponds to the JSON property `corpusType`
+        # @return [String]
+        attr_accessor :corpus_type
+      
+        # Reason why the URI was not crawled.
+        # Corresponds to the JSON property `errorMessage`
+        # @return [String]
+        attr_accessor :error_message
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @corpus_type = args[:corpus_type] if args.key?(:corpus_type)
+          @error_message = args[:error_message] if args.key?(:error_message)
+        end
+      end
+      
       # Defines a reply message to user.
       class GoogleCloudDiscoveryengineV1alphaReply
         include Google::Apis::Core::Hashable
@@ -2953,13 +3111,6 @@ module Google
         # @return [Fixnum]
         attr_accessor :num_previous_segments
       
-        # Specifies whether to return the confidence score from the extractive segments
-        # in each search result. The default value is `false`.
-        # Corresponds to the JSON property `returnExtractiveSegmentScore`
-        # @return [Boolean]
-        attr_accessor :return_extractive_segment_score
-        alias_method :return_extractive_segment_score?, :return_extractive_segment_score
-      
         def initialize(**args)
            update!(**args)
         end
@@ -2970,7 +3121,6 @@ module Google
           @max_extractive_segment_count = args[:max_extractive_segment_count] if args.key?(:max_extractive_segment_count)
           @num_next_segments = args[:num_next_segments] if args.key?(:num_next_segments)
           @num_previous_segments = args[:num_previous_segments] if args.key?(:num_previous_segments)
-          @return_extractive_segment_score = args[:return_extractive_segment_score] if args.key?(:return_extractive_segment_score)
         end
       end
       
@@ -3055,7 +3205,8 @@ module Google
         attr_accessor :include_citations
         alias_method :include_citations?, :include_citations
       
-        # Language code for Summary. Use language tags defined by BCP47.
+        # Language code for Summary. Use language tags defined by [BCP47](https://www.
+        # rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
         # Corresponds to the JSON property `languageCode`
         # @return [String]
         attr_accessor :language_code

data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha gem
-      GEM_VERSION = "0.20.0"
+      GEM_VERSION = "0.22.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230905"
+      REVISION = "20230925"
     end
   end
 end

data/lib/google/apis/discoveryengine_v1alpha/representations.rb

@@ -418,6 +418,36 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaReply
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1433,6 +1463,52 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          collection :invalid_uris, as: 'invalidUris'
+          property :pending_count, as: 'pendingCount'
+          property :quota_exceeded_count, as: 'quotaExceededCount'
+          property :success_count, as: 'successCount'
+          property :update_time, as: 'updateTime'
+          property :valid_uris_count, as: 'validUrisCount'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :uris, as: 'uris'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :failed_uris, as: 'failedUris'
+          collection :failure_samples, as: 'failureSamples', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :failure_reasons, as: 'failureReasons', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason::Representation
+      
+          property :uri, as: 'uri'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :corpus_type, as: 'corpusType'
+          property :error_message, as: 'errorMessage'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaReply
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1544,7 +1620,6 @@ module Google
           property :max_extractive_segment_count, as: 'maxExtractiveSegmentCount'
           property :num_next_segments, as: 'numNextSegments'
           property :num_previous_segments, as: 'numPreviousSegments'
-          property :return_extractive_segment_score, as: 'returnExtractiveSegmentScore'
         end
       end
       

data/lib/google/apis/discoveryengine_v1alpha/service.rb

@@ -211,7 +211,7 @@ module Google
         #   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 IndustryVertical.SITE_SEARCH dataStores.
+        #   history` is the default model for site search dataStores.
         # @param [String] user_pseudo_id
         #   A unique identifier for tracking visitors. For example, this could be
         #   implemented with an HTTP cookie, which should be able to uniquely identify a
@@ -1298,6 +1298,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Request on-demand recrawl for a list of URIs.
+        # @param [String] site_search_engine
+        #   Required. Full resource name of the SiteSearchEngine, such as `projects/*/
+        #   locations/*/collections/*/dataStores/*/siteSearchEngine`.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def recrawl_project_location_collection_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
+          command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name
@@ -1761,7 +1795,7 @@ module Google
         #   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 IndustryVertical.SITE_SEARCH dataStores.
+        #   history` is the default model for site search dataStores.
         # @param [String] user_pseudo_id
         #   A unique identifier for tracking visitors. For example, this could be
         #   implemented with an HTTP cookie, which should be able to uniquely identify a
@@ -2777,6 +2811,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Request on-demand recrawl for a list of URIs.
+        # @param [String] site_search_engine
+        #   Required. Full resource name of the SiteSearchEngine, such as `projects/*/
+        #   locations/*/collections/*/dataStores/*/siteSearchEngine`.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest] google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def recrawl_project_location_data_store_site_search_engine_uris(site_search_engine, google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:recrawlUris', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_recrawl_uris_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
+          command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Writes a single user event from the browser. This uses a GET request to due to
         # browser restriction of POST-ing to a third-party domain. This method is used
         # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-10 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.20.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.22.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message: 
 rdoc_options: []