google-apis-discoveryengine_v1beta 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad0d07d24eef4303cd9ca9eede848066f632fb97f26f770e72d68ae9a5423671
-  data.tar.gz: 8d43d3ae5bb46ab16a3f663ebb027f45e329d1316d9cb53a74ec54ba963cf7c6
+  metadata.gz: be813845d5d32a7e2cbca0854542fdd8174a53579e9de1a79e9f0764874cb6fc
+  data.tar.gz: 71eb1d3ccc7fbdd8510366e50ef2c4a20ddd3769dbb9e903910e139e26ede3c0
 SHA512:
-  metadata.gz: 3958c35dc3aabe278dbc2af25a0c3561653b3a42d231dbeb8bbdcce036ab689648bb4baa140f70e89316c869cbb1b44e8a445ffcd0319d7cd4767a054a72a641
-  data.tar.gz: 494028185a5c5d24cbc1c7ec0e7c289864bffe1ec7c747aa420f7080ab71c5d8d84f6813b91338147f10a40b88f10afeb5fdeb77f84496c4bf501410d56defd1
+  metadata.gz: cae9a2da17593a613dcd643af4f36be90a40e87a3679bf6c5e2291edc2490f5bf9dde13cef4f20da4eb9ac8350d35e85e0895f47bdcb3ce429a5785114ec4e19
+  data.tar.gz: ecb5df29d11b27f728b6728153db14883846573d36940b03a3e9f291023d082e1e71faf101df829a0e83dc1bc8ea5d1cf74ae4644dd6dc57a455915bf50a954f

data/CHANGELOG.md

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

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
@@ -1270,19 +1407,12 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure
         include Google::Apis::Core::Hashable
       
-        # This number is an estimation on how much total quota this project needs to
-        # successfully complete indexing.
-        # Corresponds to the JSON property `totalRequiredQuota`
-        # @return [Fixnum]
-        attr_accessor :total_required_quota
-      
         def initialize(**args)
            update!(**args)
         end
       
         # Update properties of this object
         def update!(**args)
-          @total_required_quota = args[:total_required_quota] if args.key?(:total_required_quota)
         end
       end
       
@@ -1416,9 +1546,9 @@ module Google
         # 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.
-        # Corresponds to the JSON property `completableFieldPath`
+        # Corresponds to the JSON property `completableFieldPaths`
         # @return [Array<String>]
-        attr_accessor :completable_field_path
+        attr_accessor :completable_field_paths
       
         # The suggestion for the query.
         # Corresponds to the JSON property `suggestion`
@@ -1431,7 +1561,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @completable_field_path = args[:completable_field_path] if args.key?(:completable_field_path)
+          @completable_field_paths = args[:completable_field_paths] if args.key?(:completable_field_paths)
           @suggestion = args[:suggestion] if args.key?(:suggestion)
         end
       end
@@ -1599,6 +1729,11 @@ module Google
         # @return [String]
         attr_accessor :serving_config
       
+        # A specification for configuring a summary returned in a search response.
+        # Corresponds to the JSON property `summarySpec`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec]
+        attr_accessor :summary_spec
+      
         # The user labels applied to a resource must meet the following requirements: *
         # Each resource can have multiple labels, up to a maximum of 64. * Each label
         # must be a key-value pair. * Keys have a minimum length of 1 character and a
@@ -1624,6 +1759,7 @@ module Google
           @query = args[:query] if args.key?(:query)
           @safe_search = args[:safe_search] if args.key?(:safe_search)
           @serving_config = args[:serving_config] if args.key?(:serving_config)
+          @summary_spec = args[:summary_spec] if args.key?(:summary_spec)
           @user_labels = args[:user_labels] if args.key?(:user_labels)
         end
       end
@@ -3253,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
@@ -3270,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
       
@@ -3355,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
@@ -3911,6 +4040,11 @@ module Google
       class GoogleCloudDiscoveryengineV1betaSearchResponseSummary
         include Google::Apis::Core::Hashable
       
+        # Safety Attribute categories and their associated confidence scores.
+        # Corresponds to the JSON property `safetyAttributes`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes]
+        attr_accessor :safety_attributes
+      
         # Additional summary-skipped reasons. This provides the reason for ignored cases.
         # If nothing is skipped, this field is not set.
         # Corresponds to the JSON property `summarySkippedReasons`
@@ -3928,11 +4062,39 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @safety_attributes = args[:safety_attributes] if args.key?(:safety_attributes)
           @summary_skipped_reasons = args[:summary_skipped_reasons] if args.key?(:summary_skipped_reasons)
           @summary_text = args[:summary_text] if args.key?(:summary_text)
         end
       end
       
+      # Safety Attribute categories and their associated confidence scores.
+      class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes
+        include Google::Apis::Core::Hashable
+      
+        # The display names of Safety Attribute categories associated with the generated
+        # content. Order matches the Scores.
+        # Corresponds to the JSON property `categories`
+        # @return [Array<String>]
+        attr_accessor :categories
+      
+        # The confidence scores of the each category, higher value means higher
+        # confidence. Order matches the Categories.
+        # Corresponds to the JSON property `scores`
+        # @return [Array<Float>]
+        attr_accessor :scores
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @categories = args[:categories] if args.key?(:categories)
+          @scores = args[:scores] if args.key?(:scores)
+        end
+      end
+      
       # Defines text input.
       class GoogleCloudDiscoveryengineV1betaTextInput
         include Google::Apis::Core::Hashable

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.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 = "20230817"
+      REVISION = "20230925"
     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
       
@@ -634,6 +658,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1betaTextInput
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -985,6 +1015,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
@@ -1032,7 +1101,6 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :total_required_quota, :numeric_string => true, as: 'totalRequiredQuota'
         end
       end
       
@@ -1069,7 +1137,7 @@ module Google
       class GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          collection :completable_field_path, as: 'completableFieldPath'
+          collection :completable_field_paths, as: 'completableFieldPaths'
           property :suggestion, as: 'suggestion'
         end
       end
@@ -1123,6 +1191,8 @@ module Google
       
           property :safe_search, as: 'safeSearch'
           property :serving_config, as: 'servingConfig'
+          property :summary_spec, as: 'summarySpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec::Representation
+      
           hash :user_labels, as: 'userLabels'
         end
       end
@@ -1543,7 +1613,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
       
@@ -1711,11 +1780,21 @@ module Google
       class GoogleCloudDiscoveryengineV1betaSearchResponseSummary
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :safety_attributes, as: 'safetyAttributes', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes::Representation
+      
           collection :summary_skipped_reasons, as: 'summarySkippedReasons'
           property :summary_text, as: 'summaryText'
         end
       end
       
+      class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :categories, as: 'categories'
+          collection :scores, as: 'scores'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1betaTextInput
         # @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.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-27 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_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.20.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.22.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
 post_install_message: 
 rdoc_options: []