google-apis-discoveryengine_v1beta 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '096dc38f39311fc2c28e082e2ba5716b3f467b2b1fb7299e318633901932aca2'
-  data.tar.gz: 793dff2e9ce1e03d6b7dae1a41e7372d838ce6846de24746edc1f2971c1a72f1
+  metadata.gz: 2971de127b84bc2c251f59546712d6699de8ae469461d010ffe89670964a3b7b
+  data.tar.gz: 7b515fe9278f6417ba3d0ed155ebff0b4451b1204f0d2a2d679f3ddc1c89979d
 SHA512:
-  metadata.gz: 8ef13ac6c1aba32836932fc2783428a5c5ff75a920203d596a186389af444da3602c01b333fea85c7b92058c163b20de473b814e54d774097482b71d3de2042d
-  data.tar.gz: 9679f0b36acf3a998c9cb48793c5c3af7b0658aa1e928955544c706990266732dc38aa01a86757ff3b984e7254268dc6dc83b5a68830ffefd2b99afd4f7a6229
+  metadata.gz: 975156a53f9f553eb808d9426fc0db70f6d970b46bec2c6ea6eb3e858ce11de07b5baf6da90ad0654595b1efa99d82dbac384418bbf596387b67da56d4e8b8f0
+  data.tar.gz: f446c2668909dd95236f2456c663ee95d7e429d9b2caf815550001781234d8f199e974e828cdee27d74b13e5a7f4c7f89338a8129c6feb05f7802a45cd3bfb4c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-discoveryengine_v1beta
 
+### v0.23.0 (2023-10-08)
+
+* Regenerated from discovery document revision 20230928
+
+### v0.22.0 (2023-10-01)
+
+* Regenerated from discovery document revision 20230925
+
 ### v0.21.0 (2023-09-10)
 
 * Regenerated from discovery document revision 20230905

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

@@ -1104,6 +1104,143 @@ 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
+      
+      # 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::DiscoveryengineV1beta::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::DiscoveryengineV1beta::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 the structure and layout of a type of document data.
       class GoogleCloudDiscoveryengineV1alphaSchema
         include Google::Apis::Core::Hashable
@@ -3252,13 +3389,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
@@ -3269,7 +3399,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
       
@@ -3354,7 +3483,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
@@ -3669,6 +3799,11 @@ module Google
         # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseFacet>]
         attr_accessor :facets
       
+        # 
+        # Corresponds to the JSON property `geoSearchDebugInfo`
+        # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo>]
+        attr_accessor :geo_search_debug_info
+      
         # Guided search result. The guided search helps user to refine the search
         # results and narrow down to the real needs from a broaded search results.
         # Corresponds to the JSON property `guidedSearchResult`
@@ -3721,6 +3856,7 @@ module Google
           @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
           @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
           @facets = args[:facets] if args.key?(:facets)
+          @geo_search_debug_info = args[:geo_search_debug_info] if args.key?(:geo_search_debug_info)
           @guided_search_result = args[:guided_search_result] if args.key?(:guided_search_result)
           @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
           @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
@@ -3795,6 +3931,32 @@ module Google
         end
       end
       
+      # Debug information specifically related to forward geocoding issues arising
+      # from Geolocation Search.
+      class GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo
+        include Google::Apis::Core::Hashable
+      
+        # The error produced.
+        # Corresponds to the JSON property `errorMessage`
+        # @return [String]
+        attr_accessor :error_message
+      
+        # The address from which forward geocoding ingestion produced issues.
+        # Corresponds to the JSON property `originalAddressQuery`
+        # @return [String]
+        attr_accessor :original_address_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_message = args[:error_message] if args.key?(:error_message)
+          @original_address_query = args[:original_address_query] if args.key?(:original_address_query)
+        end
+      end
+      
       # Guided search result. The guided search helps user to refine the search
       # results and narrow down to the real needs from a broaded search results.
       class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1beta
       # Version of the google-apis-discoveryengine_v1beta gem
-      GEM_VERSION = "0.21.0"
+      GEM_VERSION = "0.23.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 = "20230928"
     end
   end
 end

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

@@ -208,6 +208,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata
+        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 GoogleCloudDiscoveryengineV1alphaSchema
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -604,6 +628,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -991,6 +1021,45 @@ 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 GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :failed_uris, as: 'failedUris'
+          collection :failure_samples, as: 'failureSamples', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :failure_reasons, as: 'failureReasons', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason, decorator: Google::Apis::DiscoveryengineV1beta::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 GoogleCloudDiscoveryengineV1alphaSchema
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1550,7 +1619,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
       
@@ -1645,6 +1713,8 @@ module Google
           property :corrected_query, as: 'correctedQuery'
           collection :facets, as: 'facets', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseFacet, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseFacet::Representation
       
+          collection :geo_search_debug_info, as: 'geoSearchDebugInfo', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo::Representation
+      
           property :guided_search_result, as: 'guidedSearchResult', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult::Representation
       
           property :next_page_token, as: 'nextPageToken'
@@ -1679,6 +1749,14 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :error_message, as: 'errorMessage'
+          property :original_address_query, as: 'originalAddressQuery'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -70,7 +70,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
@@ -1582,7 +1582,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-10 00:00:00.000000000 Z
+date: 2023-10-08 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_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.21.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.23.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
 post_install_message: 
 rdoc_options: []