RubyGems - google-apis-discoveryengine_v1alpha - Versions diffs - 0.45.0 → 0.47.0 - Mend

google-apis-discoveryengine_v1alpha 0.45.0 → 0.47.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +9 -0
data/lib/google/apis/discoveryengine_v1alpha/classes.rb +89 -67
data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +3 -3
data/lib/google/apis/discoveryengine_v1alpha/representations.rb +13 -0
data/lib/google/apis/discoveryengine_v1alpha/service.rb +137 -57
metadata +5 -5

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c3707fac08b990fcfab1ae8b2a0abb4c4484b3fbce2ebbd1b3fbfceef766610
-  data.tar.gz: 63e6432f374ce908671e00de0fd35609d98584f0012ab761b47209a129600c77
+  metadata.gz: 5c1cbdc0410d868f3539c2346265ed0a11534271be51d032d2e37e2ba985ebfd
+  data.tar.gz: 5ea1e94b6ddd2c0ce47191ac76fb7dea8d8060930f26e1429e7729d6f301563f
 SHA512:
-  metadata.gz: 25e5f9cdc550f32f68a4ba879349e28d2ea3e5ee71a8499662ea1031f1a510c9731ab771e67b9a7cfc6e0637d9c5807ad9921e51e2d78e86092546fd0d43986e
-  data.tar.gz: 6a49c76f78de338e705d2c6bab11ff253f9c908ce17639af5b59f68f95daa73886746991c36a251d37284beb9cbe5b169947f6994011eb85dcf1e2f1b93b6d80
+  metadata.gz: 1676b563c3d6149905df4647945604625cf6ab845382ead3e1695fc43e07ba07d0be67d7a4416e474525b17eab6d0f660ac1a5bc44a9350305b99f758e5bc681
+  data.tar.gz: 3f095ab86f4239015f382a4ad001934fd1fdaa2473c1a7375403749cb33ccb46b20c6dc41046cf4f60388a6f096bcc28cc0ee31eb7f462b41432538ecfcb2596

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,14 @@
 # Release history for google-apis-discoveryengine_v1alpha
+### v0.47.0 (2024-05-26)
+* Regenerated from discovery document revision 20240517
+### v0.46.0 (2024-05-19)
+* Regenerated from discovery document revision 20240512
+* Regenerated using generator version 0.15.0
 ### v0.45.0 (2024-05-05)
 * Regenerated from discovery document revision 20240502

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

@@ -849,8 +849,7 @@ module Google
         # The industry vertical that the engine registers. The restriction of the Engine
         # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
-        # Vertical on Engine has to match vertical of the DataStore liniked to the
-        # engine.
+        # Vertical on Engine has to match vertical of the DataStore linked to the engine.
         # Corresponds to the JSON property `industryVertical`
         # @return [String]
         attr_accessor :industry_vertical
@@ -1844,7 +1843,7 @@ module Google
         # The session resource name. Not required. When session field is not set, the
         # API is in sessionless mode. We support auto session mode: users can use the
-        # wildcard symbol “-” as session id. A new id will be automatically generated
+        # wildcard symbol `-` as session ID. A new ID will be automatically generated
         # and assigned.
         # Corresponds to the JSON property `session`
         # @return [String]
@@ -3331,6 +3330,13 @@ module Google
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkPageSpan]
         attr_accessor :page_span
+        # Represents the relevance score based on similarity. Higher score represents
+        # the chunk relevance. The score is in range [-1.0, 1.0]. Only populated on
+        # SearchService.SearchResponse
+        # Corresponds to the JSON property `relevanceScore`
+        # @return [Float]
+        attr_accessor :relevance_score
         def initialize(**args)
            update!(**args)
         end
@@ -3344,6 +3350,7 @@ module Google
           @id = args[:id] if args.key?(:id)
           @name = args[:name] if args.key?(:name)
           @page_span = args[:page_span] if args.key?(:page_span)
+          @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
         end
       end
@@ -4508,9 +4515,9 @@ module Google
         attr_accessor :promotion_ids
         # Quantity of the Document associated with the user event. Defaults to 1. For
-        # example, this field will be 2 if two quantities of the same Document are
-        # involved in a `add-to-cart` event. Required for events of the following event
-        # types: * `add-to-cart` * `purchase`
+        # example, this field is 2 if two quantities of the same Document are involved
+        # in a `add-to-cart` event. Required for events of the following event types: * `
+        # add-to-cart` * `purchase`
         # Corresponds to the JSON property `quantity`
         # @return [Fixnum]
         attr_accessor :quantity
@@ -4846,8 +4853,7 @@ module Google
         # The industry vertical that the engine registers. The restriction of the Engine
         # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
-        # Vertical on Engine has to match vertical of the DataStore liniked to the
-        # engine.
+        # Vertical on Engine has to match vertical of the DataStore linked to the engine.
         # Corresponds to the JSON property `industryVertical`
         # @return [String]
         attr_accessor :industry_vertical
@@ -5585,8 +5591,8 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaFirestoreSource
         include Google::Apis::Core::Hashable
-        # Required. The Firestore collection to copy the data from with a length limit
-        # of 1,500 characters.
+        # Required. The Firestore collection (or entity) to copy the data from with a
+        # length limit of 1,500 characters.
         # Corresponds to the JSON property `collectionId`
         # @return [String]
         attr_accessor :collection_id
@@ -5639,17 +5645,17 @@ module Google
         # vertical. * `csv`: A CSV file with header conforming to the defined Schema of
         # the data store. Each entry after the header is imported as a Document. This
         # can only be used by the GENERIC Data Store vertical. Supported values for user
-        # even imports: * `user_event` (default): One JSON UserEvent per line.
+        # event imports: * `user_event` (default): One JSON UserEvent per line.
         # Corresponds to the JSON property `dataSchema`
         # @return [String]
         attr_accessor :data_schema
-        # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters
-        # long. URIs can match the full object path (for example, `gs://bucket/directory/
-        # object.json`) or a pattern matching one or more files, such as `gs://bucket/
-        # directory/*.json`. A request can contain at most 100 files (or 100,000 files
-        # if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `
-        # data_schema` is `content`).
+        # Required. Cloud Storage URIs to input files. Each URI can be up to 2000
+        # characters long. URIs can match the full object path (for example, `gs://
+        # bucket/directory/object.json`) or a pattern matching one or more files, such
+        # as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or
+        # 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or
+        # 100 MB if `data_schema` is `content`).
         # Corresponds to the JSON property `inputUris`
         # @return [Array<String>]
         attr_accessor :input_uris
@@ -7301,45 +7307,44 @@ module Google
         # field, then attribute-based expressions are expected instead of the above
         # described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
         # categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
-        # OR (categories: ANY("Movie")) If your filter blocks all results, the API will
-        # return generic (unfiltered) popular Documents. If you only want results
-        # strictly matching the filters, set `strictFiltering` to True in
+        # OR (categories: ANY("Movie")) If your filter blocks all results, the API
+        # returns generic (unfiltered) popular Documents. If you only want results
+        # strictly matching the filters, set `strictFiltering` to `true` in
         # RecommendRequest.params to receive empty results instead. Note that the API
-        # will never return Documents with `storageStatus` of `EXPIRED` or `DELETED`
+        # never returns Documents with `storageStatus` as `EXPIRED` or `DELETED`
         # regardless of filter choices.
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
         # Maximum number of results to return. Set this property to the number of
-        # recommendation results needed. If zero, the service will choose a reasonable
-        # default. The maximum allowed value is 100. Values above 100 will be coerced to
-        # 100.
+        # recommendation results needed. If zero, the service chooses a reasonable
+        # default. The maximum allowed value is 100. Values above 100 are set to 100.
         # Corresponds to the JSON property `pageSize`
         # @return [Fixnum]
         attr_accessor :page_size
         # Additional domain specific parameters for the recommendations. Allowed values:
-        # * `returnDocument`: Boolean. If set to true, the associated Document object
-        # will be returned in RecommendResponse.RecommendationResult.document. * `
-        # returnScore`: Boolean. If set to true, the recommendation 'score'
-        # corresponding to each returned Document will be set in RecommendResponse.
-        # RecommendationResult.metadata. The given 'score' indicates the probability of
-        # a Document conversion given the user's context and history. * `strictFiltering`
-        # : Boolean. True by default. If set to false, the service will return generic (
-        # unfiltered) popular Documents instead of empty if your filter blocks all
-        # recommendation results. * `diversityLevel`: String. Default empty. If set to
-        # be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` *
-        # `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-
-        # level control and adjusts recommendation results based on Document category. *
-        # `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `
-        # filter` field is interpreted according to the new, attribute-based syntax.
+        # * `returnDocument`: Boolean. If set to `true`, the associated Document object
+        # is returned in RecommendResponse.RecommendationResult.document. * `returnScore`
+        # : Boolean. If set to true, the recommendation score corresponding to each
+        # returned Document is set in RecommendResponse.RecommendationResult.metadata.
+        # The given score indicates the probability of a Document conversion given the
+        # user's context and history. * `strictFiltering`: Boolean. True by default. If
+        # set to `false`, the service returns generic (unfiltered) popular Documents
+        # instead of empty if your filter blocks all recommendation results. * `
+        # diversityLevel`: String. Default empty. If set to be non-empty, then it needs
+        # to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-
+        # diversity` * `auto-diversity` This gives request-level control and adjusts
+        # recommendation results based on Document category. * `attributeFilteringSyntax`
+        # : Boolean. False by default. If set to true, the `filter` field is interpreted
+        # according to the new, attribute-based syntax.
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
         # UserEvent captures all metadata information Discovery Engine API needs to know
-        # about how end users interact with customers' website.
+        # about how end users interact with your website.
         # Corresponds to the JSON property `userEvent`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
         attr_accessor :user_event
@@ -7359,10 +7364,9 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :user_labels
-        # Use validate only mode for this recommendation query. If set to true, a fake
-        # model will be used that returns arbitrary Document IDs. Note that the validate
-        # only mode should only be used for testing the API, or if the model is not
-        # ready.
+        # Use validate only mode for this recommendation query. If set to `true`, a fake
+        # model is used that returns arbitrary Document IDs. Note that the validate only
+        # mode should only be used for testing the API, or if the model is not ready.
         # Corresponds to the JSON property `validateOnly`
         # @return [Boolean]
         attr_accessor :validate_only
@@ -7441,7 +7445,7 @@ module Google
         # @return [String]
         attr_accessor :id
-        # Additional Document metadata / annotations. Possible values: * `score`:
+        # Additional Document metadata or annotations. Possible values: * `score`:
         # Recommendation score in double value. Is set if `returnScore` is set to true
         # in RecommendRequest.params.
         # Corresponds to the JSON property `metadata`
@@ -7632,7 +7636,7 @@ module Google
         # @return [String]
         attr_accessor :reply
-        # Summary of the top N search result specified by the summary spec.
+        # Summary of the top N search results specified by the summary spec.
         # Corresponds to the JSON property `summary`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummary]
         attr_accessor :summary
@@ -7858,7 +7862,10 @@ module Google
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
         attr_accessor :custom_fine_tuning_spec
-        # A list of data store specs to apply on a search call.
+        # Specs defining dataStores to filter on in a search call and configurations for
+        # those dataStores. This is only considered for engines with multiple dataStores
+        # use case. For single dataStore within an engine, they should use the specs at
+        # the top level.
         # Corresponds to the JSON property `dataStoreSpecs`
         # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
         attr_accessor :data_store_specs
@@ -7932,12 +7939,12 @@ module Google
         # Additional search parameters. For public website search only, supported values
         # are: * `user_country_code`: string. Default empty. If set to non-empty,
-        # results are restricted or boosted based on the location provided. Example:
-        # user_country_code: "au" For available codes see [Country Codes](https://
+        # results are restricted or boosted based on the location provided. For example,
+        # `user_country_code: "au"` For available codes see [Country Codes](https://
         # developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `
         # search_type`: double. Default empty. Enables non-webpage searching depending
         # on the value. The only valid non-default value is 1, which enables image
-        # searching. Example: search_type: 1
+        # searching. For example, `search_type: 1`
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
@@ -8508,7 +8515,9 @@ module Google
         end
       end
-      # A struct to define data stores to filter on in a search call.
+      # 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.
       class GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec
         include Google::Apis::Core::Hashable
@@ -8624,9 +8633,9 @@ module Google
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey]
         attr_accessor :facet_key
-        # Maximum of facet values that should be returned for this facet. If unspecified,
-        # defaults to 20. The maximum allowed value is 300. Values above 300 are
-        # coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        # 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. If this field is negative, an `INVALID_ARGUMENT` is returned.
         # Corresponds to the JSON property `limit`
         # @return [Fixnum]
         attr_accessor :limit
@@ -8655,7 +8664,7 @@ module Google
         attr_accessor :case_insensitive
         alias_method :case_insensitive?, :case_insensitive
-        # Only get facet values that contains the given strings. For example, suppose "
+        # Only get facet values that contain the given strings. For example, suppose "
         # category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022"
         # . If set "contains" to "2022", the "category" facet only contains "Action >
         # 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
@@ -8772,8 +8781,8 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec
         include Google::Apis::Core::Hashable
-        # The mode under which spell correction should take effect to replace the
-        # original search query. Default to Mode.AUTO.
+        # The mode under which spell correction replaces the original search query.
+        # Defaults to Mode.AUTO.
         # Corresponds to the JSON property `mode`
         # @return [String]
         attr_accessor :mode
@@ -8851,7 +8860,7 @@ module Google
         # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult>]
         attr_accessor :results
-        # Summary of the top N search result specified by the summary spec.
+        # Summary of the top N search results specified by the summary spec.
         # Corresponds to the JSON property `summary`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummary]
         attr_accessor :summary
@@ -8894,8 +8903,8 @@ module Google
         attr_accessor :dynamic_facet
         alias_method :dynamic_facet?, :dynamic_facet
-        # The key for this facet. E.g., "colors" or "price". It matches SearchRequest.
-        # FacetSpec.FacetKey.key.
+        # The key for this facet. For example, `"colors"` or `"price"`. It matches
+        # SearchRequest.FacetSpec.FacetKey.key.
         # Corresponds to the JSON property `key`
         # @return [String]
         attr_accessor :key
@@ -9004,12 +9013,12 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute
         include Google::Apis::Core::Hashable
-        # Attribute key used to refine the results e.g. 'movie_type'.
+        # Attribute key used to refine the results. For example, `"movie_type"`.
         # Corresponds to the JSON property `attributeKey`
         # @return [String]
         attr_accessor :attribute_key
-        # Attribute value used to refine the results e.g. 'drama'.
+        # Attribute value used to refine the results. For example, `"drama"`.
         # Corresponds to the JSON property `attributeValue`
         # @return [String]
         attr_accessor :attribute_value
@@ -9092,7 +9101,7 @@ module Google
         end
       end
-      # Summary of the top N search result specified by the summary spec.
+      # Summary of the top N search results specified by the summary spec.
       class GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
         include Google::Apis::Core::Hashable
@@ -9644,7 +9653,8 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaSessionTurn
         include Google::Apis::Core::Hashable
-        # The resource name of the answer to the user query.
+        # The resource name of the answer to the user query. Only set if the answer
+        # generation (/answer API call) happened in this turn.
         # Corresponds to the JSON property `answer`
         # @return [String]
         attr_accessor :answer
@@ -10259,7 +10269,7 @@ module Google
       end
       # UserEvent captures all metadata information Discovery Engine API needs to know
-      # about how end users interact with customers' website.
+      # about how end users interact with your website.
       class GoogleCloudDiscoveryengineV1alphaUserEvent
         include Google::Apis::Core::Hashable
@@ -10398,7 +10408,7 @@ module Google
         # A list of identifiers for the independent experiment groups this user event
         # belongs to. This is used to distinguish between user events associated with
-        # different experiment setups on the customer end.
+        # different experiment setups.
         # Corresponds to the JSON property `tagIds`
         # @return [Array<String>]
         attr_accessor :tag_ids
@@ -11113,8 +11123,7 @@ module Google
         # The industry vertical that the engine registers. The restriction of the Engine
         # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
-        # Vertical on Engine has to match vertical of the DataStore liniked to the
-        # engine.
+        # Vertical on Engine has to match vertical of the DataStore linked to the engine.
         # Corresponds to the JSON property `industryVertical`
         # @return [String]
         attr_accessor :industry_vertical
@@ -12033,6 +12042,19 @@ module Google
         end
       end
+      # The request message for Operations.CancelOperation.
+      class GoogleLongrunningCancelOperationRequest
+        include Google::Apis::Core::Hashable
+        def initialize(**args)
+           update!(**args)
+        end
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
       # The response message for Operations.ListOperations.
       class GoogleLongrunningListOperationsResponse
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha gem
-      GEM_VERSION = "0.45.0"
+      GEM_VERSION = "0.47.0"
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.14.0"
+      GENERATOR_VERSION = "0.15.0"
       # Revision of the discovery document this client was generated from
-      REVISION = "20240502"
+      REVISION = "20240517"
     end
   end
 end

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

@@ -2086,6 +2086,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
+      class GoogleLongrunningCancelOperationRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        include Google::Apis::Core::JsonObjectSupport
+      end
       class GoogleLongrunningListOperationsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -3081,6 +3087,7 @@ module Google
           property :name, as: 'name'
           property :page_span, as: 'pageSpan', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkPageSpan, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkPageSpan::Representation
+          property :relevance_score, as: 'relevanceScore'
         end
       end
@@ -5449,6 +5456,12 @@ module Google
         end
       end
+      class GoogleLongrunningCancelOperationRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
       class GoogleLongrunningListOperationsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -745,14 +745,14 @@ module Google
         #   location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
         # @param [String] document_id
-        #   Required. The ID to use for the Document, which will become the final
-        #   component of the Document.name. If the caller does not have permission to
-        #   create the Document, regardless of whether or not it exists, a `
-        #   PERMISSION_DENIED` error is returned. This field must be unique among all
-        #   Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
-        #   returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
-        #   rfc1034) standard with a length limit of 63 characters. Otherwise, an `
-        #   INVALID_ARGUMENT` error is returned.
+        #   Required. The ID to use for the Document, which becomes the final component of
+        #   the Document.name. If the caller does not have permission to create the
+        #   Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
+        #   is returned. This field must be unique among all Documents with the same
+        #   parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
+        #   conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
+        #   length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
+        #   returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -895,8 +895,8 @@ module Google
         end
         # Bulk import of multiple Documents. Request processing may be synchronous. Non-
-        # existing items will be created. Note: It is possible for a subset of the
-        # Documents to be successfully updated.
+        # existing items are created. Note: It is possible for a subset of the Documents
+        # to be successfully updated.
         # @param [String] parent
         #   Required. The parent branch resource name, such as `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -941,8 +941,8 @@ module Google
         #   PERMISSION_DENIED` error is returned.
         # @param [Fixnum] page_size
         #   Maximum number of Documents to return. If unspecified, defaults to 100. The
-        #   maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
-        #   this field is negative, an `INVALID_ARGUMENT` error is returned.
+        #   maximum allowed value is 1000. Values above 1000 are set to 1000. If this
+        #   field is negative, an `INVALID_ARGUMENT` error is returned.
         # @param [String] page_token
         #   A page token ListDocumentsResponse.next_page_token, received from a previous
         #   DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -986,10 +986,10 @@ module Google
         #   with a length limit of 1024 characters.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
         # @param [Boolean] allow_missing
-        #   If set to true, and the Document is not found, a new Document will be created.
+        #   If set to `true` and the Document is not found, a new Document is be created.
         # @param [String] update_mask
         #   Indicates which fields in the provided imported 'document' to update. If not
-        #   set, will by default update all fields.
+        #   set, by default updates all fields.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1141,6 +1141,46 @@ module Google
           execute_or_queue_command(command, &block)
         end
+        # Starts asynchronous cancellation on a long-running operation. The server makes
+        # a best effort to cancel the operation, but success is not guaranteed. If the
+        # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+        # Clients can use Operations.GetOperation or other methods to check whether the
+        # cancellation succeeded or whether the operation completed despite cancellation.
+        # On successful cancellation, the operation is not deleted; instead, it becomes
+        # an operation with an Operation.error value with a google.rpc.Status.code of 1,
+        # corresponding to `Code.CANCELLED`.
+        # @param [String] name
+        #   The name of the operation resource to be cancelled.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_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::GoogleProtobufEmpty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
+        #
+        # @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 cancel_project_location_collection_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningCancelOperationRequest::Representation
+          command.request_object = google_longrunning_cancel_operation_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
+          command.params['name'] = name unless name.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
@@ -1621,8 +1661,8 @@ module Google
         #   .
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
         # @param [String] schema_id
-        #   Required. The ID to use for the Schema, which will become the final component
-        #   of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
+        #   Required. The ID to use for the Schema, which becomes the final component of
+        #   the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
         #   org/html/rfc1034) standard with a length limit of 63 characters.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1725,8 +1765,8 @@ module Google
         #   .
         # @param [Fixnum] page_size
         #   The maximum number of Schemas to return. The service may return fewer than
-        #   this value. If unspecified, at most 100 Schemas will be returned. The maximum
-        #   value is 1000; values above 1000 will be coerced to 1000.
+        #   this value. If unspecified, at most 100 Schemas are returned. The maximum
+        #   value is 1000; values above 1000 are set to 1000.
         # @param [String] page_token
         #   A page token, received from a previous SchemaService.ListSchemas call. Provide
         #   this to retrieve the subsequent page. When paginating, all other parameters
@@ -1769,8 +1809,8 @@ module Google
         #   limit of 1024 characters.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
         # @param [Boolean] allow_missing
-        #   If set to true, and the Schema is not found, a new Schema will be created. In
-        #   this situation, `update_mask` is ignored.
+        #   If set to true, and the Schema is not found, a new Schema is created. In this
+        #   situation, `update_mask` is ignored.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -2028,11 +2068,11 @@ module Google
         #   Required. Full resource name of a ServingConfig: `projects/*/locations/global/
         #   collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
         #   collections/*/dataStores/*/servingConfigs/*` One default serving config is
-        #   created along with your recommendation engine creation. The engine ID will be
-        #   used as the ID of the default serving config. For example, for Engine `
-        #   projects/*/locations/global/collections/*/engines/my-engine`, you can use `
-        #   projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
-        #   engine` for your RecommendationService.Recommend requests.
+        #   created along with your recommendation engine creation. The engine ID is used
+        #   as the ID of the default serving config. For example, for Engine `projects/*/
+        #   locations/global/collections/*/engines/my-engine`, you can use `projects/*/
+        #   locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
+        #   your RecommendationService.Recommend requests.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2985,7 +3025,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
-        # Bulk import of User events. Request processing might be synchronous. Events
+        # Bulk import of user events. Request processing might be synchronous. Events
         # that already exist are skipped. Use this method for backfilling historical
         # user events. Operation.response is of type ImportResponse. Note that it is
         # possible for a subset of the items to be successfully inserted. Operation.
@@ -3847,11 +3887,11 @@ module Google
         #   Required. Full resource name of a ServingConfig: `projects/*/locations/global/
         #   collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
         #   collections/*/dataStores/*/servingConfigs/*` One default serving config is
-        #   created along with your recommendation engine creation. The engine ID will be
-        #   used as the ID of the default serving config. For example, for Engine `
-        #   projects/*/locations/global/collections/*/engines/my-engine`, you can use `
-        #   projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
-        #   engine` for your RecommendationService.Recommend requests.
+        #   created along with your recommendation engine creation. The engine ID is used
+        #   as the ID of the default serving config. For example, for Engine `projects/*/
+        #   locations/global/collections/*/engines/my-engine`, you can use `projects/*/
+        #   locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
+        #   your RecommendationService.Recommend requests.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -4593,14 +4633,14 @@ module Google
         #   location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
         # @param [String] document_id
-        #   Required. The ID to use for the Document, which will become the final
-        #   component of the Document.name. If the caller does not have permission to
-        #   create the Document, regardless of whether or not it exists, a `
-        #   PERMISSION_DENIED` error is returned. This field must be unique among all
-        #   Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
-        #   returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
-        #   rfc1034) standard with a length limit of 63 characters. Otherwise, an `
-        #   INVALID_ARGUMENT` error is returned.
+        #   Required. The ID to use for the Document, which becomes the final component of
+        #   the Document.name. If the caller does not have permission to create the
+        #   Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
+        #   is returned. This field must be unique among all Documents with the same
+        #   parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
+        #   conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
+        #   length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
+        #   returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -4743,8 +4783,8 @@ module Google
         end
         # Bulk import of multiple Documents. Request processing may be synchronous. Non-
-        # existing items will be created. Note: It is possible for a subset of the
-        # Documents to be successfully updated.
+        # existing items are created. Note: It is possible for a subset of the Documents
+        # to be successfully updated.
         # @param [String] parent
         #   Required. The parent branch resource name, such as `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
@@ -4789,8 +4829,8 @@ module Google
         #   PERMISSION_DENIED` error is returned.
         # @param [Fixnum] page_size
         #   Maximum number of Documents to return. If unspecified, defaults to 100. The
-        #   maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
-        #   this field is negative, an `INVALID_ARGUMENT` error is returned.
+        #   maximum allowed value is 1000. Values above 1000 are set to 1000. If this
+        #   field is negative, an `INVALID_ARGUMENT` error is returned.
         # @param [String] page_token
         #   A page token ListDocumentsResponse.next_page_token, received from a previous
         #   DocumentService.ListDocuments call. Provide this to retrieve the subsequent
@@ -4834,10 +4874,10 @@ module Google
         #   with a length limit of 1024 characters.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
         # @param [Boolean] allow_missing
-        #   If set to true, and the Document is not found, a new Document will be created.
+        #   If set to `true` and the Document is not found, a new Document is be created.
         # @param [String] update_mask
         #   Indicates which fields in the provided imported 'document' to update. If not
-        #   set, will by default update all fields.
+        #   set, by default updates all fields.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -4989,6 +5029,46 @@ module Google
           execute_or_queue_command(command, &block)
         end
+        # Starts asynchronous cancellation on a long-running operation. The server makes
+        # a best effort to cancel the operation, but success is not guaranteed. If the
+        # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+        # Clients can use Operations.GetOperation or other methods to check whether the
+        # cancellation succeeded or whether the operation completed despite cancellation.
+        # On successful cancellation, the operation is not deleted; instead, it becomes
+        # an operation with an Operation.error value with a google.rpc.Status.code of 1,
+        # corresponding to `Code.CANCELLED`.
+        # @param [String] name
+        #   The name of the operation resource to be cancelled.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_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::GoogleProtobufEmpty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
+        #
+        # @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 cancel_project_location_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningCancelOperationRequest::Representation
+          command.request_object = google_longrunning_cancel_operation_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
+          command.params['name'] = name unless name.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
@@ -5437,8 +5517,8 @@ module Google
         #   .
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
         # @param [String] schema_id
-        #   Required. The ID to use for the Schema, which will become the final component
-        #   of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
+        #   Required. The ID to use for the Schema, which becomes the final component of
+        #   the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
         #   org/html/rfc1034) standard with a length limit of 63 characters.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -5541,8 +5621,8 @@ module Google
         #   .
         # @param [Fixnum] page_size
         #   The maximum number of Schemas to return. The service may return fewer than
-        #   this value. If unspecified, at most 100 Schemas will be returned. The maximum
-        #   value is 1000; values above 1000 will be coerced to 1000.
+        #   this value. If unspecified, at most 100 Schemas are returned. The maximum
+        #   value is 1000; values above 1000 are set to 1000.
         # @param [String] page_token
         #   A page token, received from a previous SchemaService.ListSchemas call. Provide
         #   this to retrieve the subsequent page. When paginating, all other parameters
@@ -5585,8 +5665,8 @@ module Google
         #   limit of 1024 characters.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
         # @param [Boolean] allow_missing
-        #   If set to true, and the Schema is not found, a new Schema will be created. In
-        #   this situation, `update_mask` is ignored.
+        #   If set to true, and the Schema is not found, a new Schema is created. In this
+        #   situation, `update_mask` is ignored.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -5773,11 +5853,11 @@ module Google
         #   Required. Full resource name of a ServingConfig: `projects/*/locations/global/
         #   collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
         #   collections/*/dataStores/*/servingConfigs/*` One default serving config is
-        #   created along with your recommendation engine creation. The engine ID will be
-        #   used as the ID of the default serving config. For example, for Engine `
-        #   projects/*/locations/global/collections/*/engines/my-engine`, you can use `
-        #   projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
-        #   engine` for your RecommendationService.Recommend requests.
+        #   created along with your recommendation engine creation. The engine ID is used
+        #   as the ID of the default serving config. For example, for Engine `projects/*/
+        #   locations/global/collections/*/engines/my-engine`, you can use `projects/*/
+        #   locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
+        #   your RecommendationService.Recommend requests.
         # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -6507,7 +6587,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
-        # Bulk import of User events. Request processing might be synchronous. Events
+        # Bulk import of user events. Request processing might be synchronous. Events
         # that already exist are skipped. Use this method for backfilling historical
         # user events. Operation.response is of type ImportResponse. Note that it is
         # possible for a subset of the items to be successfully inserted. Operation.

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.47.0
 platform: ruby
 authors:
 - Google LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-05 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -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.45.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.47.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message:
 rdoc_options: []