google-apis-discoveryengine_v1alpha 0.46.0 → 0.47.0
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5c1cbdc0410d868f3539c2346265ed0a11534271be51d032d2e37e2ba985ebfd
|
|
4
|
+
data.tar.gz: 5ea1e94b6ddd2c0ce47191ac76fb7dea8d8060930f26e1429e7729d6f301563f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1676b563c3d6149905df4647945604625cf6ab845382ead3e1695fc43e07ba07d0be67d7a4416e474525b17eab6d0f660ac1a5bc44a9350305b99f758e5bc681
|
|
7
|
+
data.tar.gz: 3f095ab86f4239015f382a4ad001934fd1fdaa2473c1a7375403749cb33ccb46b20c6dc41046cf4f60388a6f096bcc28cc0ee31eb7f462b41432538ecfcb2596
|
data/CHANGELOG.md
CHANGED
|
@@ -849,8 +849,7 @@ module Google
|
|
|
849
849
|
|
|
850
850
|
# The industry vertical that the engine registers. The restriction of the Engine
|
|
851
851
|
# industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
|
|
852
|
-
# Vertical on Engine has to match vertical of the DataStore
|
|
853
|
-
# engine.
|
|
852
|
+
# Vertical on Engine has to match vertical of the DataStore linked to the engine.
|
|
854
853
|
# Corresponds to the JSON property `industryVertical`
|
|
855
854
|
# @return [String]
|
|
856
855
|
attr_accessor :industry_vertical
|
|
@@ -1844,7 +1843,7 @@ module Google
|
|
|
1844
1843
|
|
|
1845
1844
|
# The session resource name. Not required. When session field is not set, the
|
|
1846
1845
|
# API is in sessionless mode. We support auto session mode: users can use the
|
|
1847
|
-
# wildcard symbol
|
|
1846
|
+
# wildcard symbol `-` as session ID. A new ID will be automatically generated
|
|
1848
1847
|
# and assigned.
|
|
1849
1848
|
# Corresponds to the JSON property `session`
|
|
1850
1849
|
# @return [String]
|
|
@@ -3332,7 +3331,7 @@ module Google
|
|
|
3332
3331
|
attr_accessor :page_span
|
|
3333
3332
|
|
|
3334
3333
|
# Represents the relevance score based on similarity. Higher score represents
|
|
3335
|
-
# the chunk relevance. The score is in range [
|
|
3334
|
+
# the chunk relevance. The score is in range [-1.0, 1.0]. Only populated on
|
|
3336
3335
|
# SearchService.SearchResponse
|
|
3337
3336
|
# Corresponds to the JSON property `relevanceScore`
|
|
3338
3337
|
# @return [Float]
|
|
@@ -4516,9 +4515,9 @@ module Google
|
|
|
4516
4515
|
attr_accessor :promotion_ids
|
|
4517
4516
|
|
|
4518
4517
|
# Quantity of the Document associated with the user event. Defaults to 1. For
|
|
4519
|
-
# example, this field
|
|
4520
|
-
#
|
|
4521
|
-
#
|
|
4518
|
+
# example, this field is 2 if two quantities of the same Document are involved
|
|
4519
|
+
# in a `add-to-cart` event. Required for events of the following event types: * `
|
|
4520
|
+
# add-to-cart` * `purchase`
|
|
4522
4521
|
# Corresponds to the JSON property `quantity`
|
|
4523
4522
|
# @return [Fixnum]
|
|
4524
4523
|
attr_accessor :quantity
|
|
@@ -4854,8 +4853,7 @@ module Google
|
|
|
4854
4853
|
|
|
4855
4854
|
# The industry vertical that the engine registers. The restriction of the Engine
|
|
4856
4855
|
# industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
|
|
4857
|
-
# Vertical on Engine has to match vertical of the DataStore
|
|
4858
|
-
# engine.
|
|
4856
|
+
# Vertical on Engine has to match vertical of the DataStore linked to the engine.
|
|
4859
4857
|
# Corresponds to the JSON property `industryVertical`
|
|
4860
4858
|
# @return [String]
|
|
4861
4859
|
attr_accessor :industry_vertical
|
|
@@ -5593,8 +5591,8 @@ module Google
|
|
|
5593
5591
|
class GoogleCloudDiscoveryengineV1alphaFirestoreSource
|
|
5594
5592
|
include Google::Apis::Core::Hashable
|
|
5595
5593
|
|
|
5596
|
-
# Required. The Firestore collection to copy the data from with a
|
|
5597
|
-
# of 1,500 characters.
|
|
5594
|
+
# Required. The Firestore collection (or entity) to copy the data from with a
|
|
5595
|
+
# length limit of 1,500 characters.
|
|
5598
5596
|
# Corresponds to the JSON property `collectionId`
|
|
5599
5597
|
# @return [String]
|
|
5600
5598
|
attr_accessor :collection_id
|
|
@@ -5647,17 +5645,17 @@ module Google
|
|
|
5647
5645
|
# vertical. * `csv`: A CSV file with header conforming to the defined Schema of
|
|
5648
5646
|
# the data store. Each entry after the header is imported as a Document. This
|
|
5649
5647
|
# can only be used by the GENERIC Data Store vertical. Supported values for user
|
|
5650
|
-
#
|
|
5648
|
+
# event imports: * `user_event` (default): One JSON UserEvent per line.
|
|
5651
5649
|
# Corresponds to the JSON property `dataSchema`
|
|
5652
5650
|
# @return [String]
|
|
5653
5651
|
attr_accessor :data_schema
|
|
5654
5652
|
|
|
5655
|
-
# Required. Cloud Storage URIs to input files. URI can be up to 2000
|
|
5656
|
-
# long. URIs can match the full object path (for example, `gs://
|
|
5657
|
-
# object.json`) or a pattern matching one or more files, such
|
|
5658
|
-
# directory/*.json`. A request can contain at most 100 files (or
|
|
5659
|
-
# if `data_schema` is `content`). Each file can be up to 2 GB (or
|
|
5660
|
-
# data_schema` is `content`).
|
|
5653
|
+
# Required. Cloud Storage URIs to input files. Each URI can be up to 2000
|
|
5654
|
+
# characters long. URIs can match the full object path (for example, `gs://
|
|
5655
|
+
# bucket/directory/object.json`) or a pattern matching one or more files, such
|
|
5656
|
+
# as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or
|
|
5657
|
+
# 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or
|
|
5658
|
+
# 100 MB if `data_schema` is `content`).
|
|
5661
5659
|
# Corresponds to the JSON property `inputUris`
|
|
5662
5660
|
# @return [Array<String>]
|
|
5663
5661
|
attr_accessor :input_uris
|
|
@@ -7309,45 +7307,44 @@ module Google
|
|
|
7309
7307
|
# field, then attribute-based expressions are expected instead of the above
|
|
7310
7308
|
# described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
|
|
7311
7309
|
# categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
|
|
7312
|
-
# OR (categories: ANY("Movie")) If your filter blocks all results, the API
|
|
7313
|
-
#
|
|
7314
|
-
# strictly matching the filters, set `strictFiltering` to
|
|
7310
|
+
# OR (categories: ANY("Movie")) If your filter blocks all results, the API
|
|
7311
|
+
# returns generic (unfiltered) popular Documents. If you only want results
|
|
7312
|
+
# strictly matching the filters, set `strictFiltering` to `true` in
|
|
7315
7313
|
# RecommendRequest.params to receive empty results instead. Note that the API
|
|
7316
|
-
#
|
|
7314
|
+
# never returns Documents with `storageStatus` as `EXPIRED` or `DELETED`
|
|
7317
7315
|
# regardless of filter choices.
|
|
7318
7316
|
# Corresponds to the JSON property `filter`
|
|
7319
7317
|
# @return [String]
|
|
7320
7318
|
attr_accessor :filter
|
|
7321
7319
|
|
|
7322
7320
|
# Maximum number of results to return. Set this property to the number of
|
|
7323
|
-
# recommendation results needed. If zero, the service
|
|
7324
|
-
# default. The maximum allowed value is 100. Values above 100
|
|
7325
|
-
# 100.
|
|
7321
|
+
# recommendation results needed. If zero, the service chooses a reasonable
|
|
7322
|
+
# default. The maximum allowed value is 100. Values above 100 are set to 100.
|
|
7326
7323
|
# Corresponds to the JSON property `pageSize`
|
|
7327
7324
|
# @return [Fixnum]
|
|
7328
7325
|
attr_accessor :page_size
|
|
7329
7326
|
|
|
7330
7327
|
# Additional domain specific parameters for the recommendations. Allowed values:
|
|
7331
|
-
# * `returnDocument`: Boolean. If set to true
|
|
7332
|
-
#
|
|
7333
|
-
#
|
|
7334
|
-
#
|
|
7335
|
-
#
|
|
7336
|
-
#
|
|
7337
|
-
#
|
|
7338
|
-
#
|
|
7339
|
-
#
|
|
7340
|
-
#
|
|
7341
|
-
#
|
|
7342
|
-
#
|
|
7343
|
-
#
|
|
7344
|
-
#
|
|
7328
|
+
# * `returnDocument`: Boolean. If set to `true`, the associated Document object
|
|
7329
|
+
# is returned in RecommendResponse.RecommendationResult.document. * `returnScore`
|
|
7330
|
+
# : Boolean. If set to true, the recommendation score corresponding to each
|
|
7331
|
+
# returned Document is set in RecommendResponse.RecommendationResult.metadata.
|
|
7332
|
+
# The given score indicates the probability of a Document conversion given the
|
|
7333
|
+
# user's context and history. * `strictFiltering`: Boolean. True by default. If
|
|
7334
|
+
# set to `false`, the service returns generic (unfiltered) popular Documents
|
|
7335
|
+
# instead of empty if your filter blocks all recommendation results. * `
|
|
7336
|
+
# diversityLevel`: String. Default empty. If set to be non-empty, then it needs
|
|
7337
|
+
# to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-
|
|
7338
|
+
# diversity` * `auto-diversity` This gives request-level control and adjusts
|
|
7339
|
+
# recommendation results based on Document category. * `attributeFilteringSyntax`
|
|
7340
|
+
# : Boolean. False by default. If set to true, the `filter` field is interpreted
|
|
7341
|
+
# according to the new, attribute-based syntax.
|
|
7345
7342
|
# Corresponds to the JSON property `params`
|
|
7346
7343
|
# @return [Hash<String,Object>]
|
|
7347
7344
|
attr_accessor :params
|
|
7348
7345
|
|
|
7349
7346
|
# UserEvent captures all metadata information Discovery Engine API needs to know
|
|
7350
|
-
# about how end users interact with
|
|
7347
|
+
# about how end users interact with your website.
|
|
7351
7348
|
# Corresponds to the JSON property `userEvent`
|
|
7352
7349
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
|
|
7353
7350
|
attr_accessor :user_event
|
|
@@ -7367,10 +7364,9 @@ module Google
|
|
|
7367
7364
|
# @return [Hash<String,String>]
|
|
7368
7365
|
attr_accessor :user_labels
|
|
7369
7366
|
|
|
7370
|
-
# Use validate only mode for this recommendation query. If set to true
|
|
7371
|
-
# model
|
|
7372
|
-
#
|
|
7373
|
-
# ready.
|
|
7367
|
+
# Use validate only mode for this recommendation query. If set to `true`, a fake
|
|
7368
|
+
# model is used that returns arbitrary Document IDs. Note that the validate only
|
|
7369
|
+
# mode should only be used for testing the API, or if the model is not ready.
|
|
7374
7370
|
# Corresponds to the JSON property `validateOnly`
|
|
7375
7371
|
# @return [Boolean]
|
|
7376
7372
|
attr_accessor :validate_only
|
|
@@ -7449,7 +7445,7 @@ module Google
|
|
|
7449
7445
|
# @return [String]
|
|
7450
7446
|
attr_accessor :id
|
|
7451
7447
|
|
|
7452
|
-
# Additional Document metadata
|
|
7448
|
+
# Additional Document metadata or annotations. Possible values: * `score`:
|
|
7453
7449
|
# Recommendation score in double value. Is set if `returnScore` is set to true
|
|
7454
7450
|
# in RecommendRequest.params.
|
|
7455
7451
|
# Corresponds to the JSON property `metadata`
|
|
@@ -7640,7 +7636,7 @@ module Google
|
|
|
7640
7636
|
# @return [String]
|
|
7641
7637
|
attr_accessor :reply
|
|
7642
7638
|
|
|
7643
|
-
# Summary of the top N search
|
|
7639
|
+
# Summary of the top N search results specified by the summary spec.
|
|
7644
7640
|
# Corresponds to the JSON property `summary`
|
|
7645
7641
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummary]
|
|
7646
7642
|
attr_accessor :summary
|
|
@@ -7866,7 +7862,10 @@ module Google
|
|
|
7866
7862
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
|
|
7867
7863
|
attr_accessor :custom_fine_tuning_spec
|
|
7868
7864
|
|
|
7869
|
-
#
|
|
7865
|
+
# Specs defining dataStores to filter on in a search call and configurations for
|
|
7866
|
+
# those dataStores. This is only considered for engines with multiple dataStores
|
|
7867
|
+
# use case. For single dataStore within an engine, they should use the specs at
|
|
7868
|
+
# the top level.
|
|
7870
7869
|
# Corresponds to the JSON property `dataStoreSpecs`
|
|
7871
7870
|
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
|
|
7872
7871
|
attr_accessor :data_store_specs
|
|
@@ -7940,12 +7939,12 @@ module Google
|
|
|
7940
7939
|
|
|
7941
7940
|
# Additional search parameters. For public website search only, supported values
|
|
7942
7941
|
# are: * `user_country_code`: string. Default empty. If set to non-empty,
|
|
7943
|
-
# results are restricted or boosted based on the location provided.
|
|
7944
|
-
# user_country_code: "au" For available codes see [Country Codes](https://
|
|
7942
|
+
# results are restricted or boosted based on the location provided. For example,
|
|
7943
|
+
# `user_country_code: "au"` For available codes see [Country Codes](https://
|
|
7945
7944
|
# developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `
|
|
7946
7945
|
# search_type`: double. Default empty. Enables non-webpage searching depending
|
|
7947
7946
|
# on the value. The only valid non-default value is 1, which enables image
|
|
7948
|
-
# searching.
|
|
7947
|
+
# searching. For example, `search_type: 1`
|
|
7949
7948
|
# Corresponds to the JSON property `params`
|
|
7950
7949
|
# @return [Hash<String,Object>]
|
|
7951
7950
|
attr_accessor :params
|
|
@@ -8516,7 +8515,9 @@ module Google
|
|
|
8516
8515
|
end
|
|
8517
8516
|
end
|
|
8518
8517
|
|
|
8519
|
-
# A struct to define data stores to filter on in a search call
|
|
8518
|
+
# A struct to define data stores to filter on in a search call and
|
|
8519
|
+
# configurations for those data stores. A maximum of 1 DataStoreSpec per
|
|
8520
|
+
# data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
8520
8521
|
class GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec
|
|
8521
8522
|
include Google::Apis::Core::Hashable
|
|
8522
8523
|
|
|
@@ -8632,9 +8633,9 @@ module Google
|
|
|
8632
8633
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey]
|
|
8633
8634
|
attr_accessor :facet_key
|
|
8634
8635
|
|
|
8635
|
-
# Maximum
|
|
8636
|
-
# defaults to 20. The maximum allowed value is 300. Values above 300 are
|
|
8637
|
-
#
|
|
8636
|
+
# Maximum facet values that are returned for this facet. If unspecified,
|
|
8637
|
+
# defaults to 20. The maximum allowed value is 300. Values above 300 are coerced
|
|
8638
|
+
# to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
8638
8639
|
# Corresponds to the JSON property `limit`
|
|
8639
8640
|
# @return [Fixnum]
|
|
8640
8641
|
attr_accessor :limit
|
|
@@ -8663,7 +8664,7 @@ module Google
|
|
|
8663
8664
|
attr_accessor :case_insensitive
|
|
8664
8665
|
alias_method :case_insensitive?, :case_insensitive
|
|
8665
8666
|
|
|
8666
|
-
# Only get facet values that
|
|
8667
|
+
# Only get facet values that contain the given strings. For example, suppose "
|
|
8667
8668
|
# category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022"
|
|
8668
8669
|
# . If set "contains" to "2022", the "category" facet only contains "Action >
|
|
8669
8670
|
# 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
|
|
@@ -8780,8 +8781,8 @@ module Google
|
|
|
8780
8781
|
class GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec
|
|
8781
8782
|
include Google::Apis::Core::Hashable
|
|
8782
8783
|
|
|
8783
|
-
# The mode under which spell correction
|
|
8784
|
-
#
|
|
8784
|
+
# The mode under which spell correction replaces the original search query.
|
|
8785
|
+
# Defaults to Mode.AUTO.
|
|
8785
8786
|
# Corresponds to the JSON property `mode`
|
|
8786
8787
|
# @return [String]
|
|
8787
8788
|
attr_accessor :mode
|
|
@@ -8859,7 +8860,7 @@ module Google
|
|
|
8859
8860
|
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult>]
|
|
8860
8861
|
attr_accessor :results
|
|
8861
8862
|
|
|
8862
|
-
# Summary of the top N search
|
|
8863
|
+
# Summary of the top N search results specified by the summary spec.
|
|
8863
8864
|
# Corresponds to the JSON property `summary`
|
|
8864
8865
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummary]
|
|
8865
8866
|
attr_accessor :summary
|
|
@@ -8902,8 +8903,8 @@ module Google
|
|
|
8902
8903
|
attr_accessor :dynamic_facet
|
|
8903
8904
|
alias_method :dynamic_facet?, :dynamic_facet
|
|
8904
8905
|
|
|
8905
|
-
# The key for this facet.
|
|
8906
|
-
# FacetSpec.FacetKey.key.
|
|
8906
|
+
# The key for this facet. For example, `"colors"` or `"price"`. It matches
|
|
8907
|
+
# SearchRequest.FacetSpec.FacetKey.key.
|
|
8907
8908
|
# Corresponds to the JSON property `key`
|
|
8908
8909
|
# @return [String]
|
|
8909
8910
|
attr_accessor :key
|
|
@@ -9012,12 +9013,12 @@ module Google
|
|
|
9012
9013
|
class GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute
|
|
9013
9014
|
include Google::Apis::Core::Hashable
|
|
9014
9015
|
|
|
9015
|
-
# Attribute key used to refine the results
|
|
9016
|
+
# Attribute key used to refine the results. For example, `"movie_type"`.
|
|
9016
9017
|
# Corresponds to the JSON property `attributeKey`
|
|
9017
9018
|
# @return [String]
|
|
9018
9019
|
attr_accessor :attribute_key
|
|
9019
9020
|
|
|
9020
|
-
# Attribute value used to refine the results
|
|
9021
|
+
# Attribute value used to refine the results. For example, `"drama"`.
|
|
9021
9022
|
# Corresponds to the JSON property `attributeValue`
|
|
9022
9023
|
# @return [String]
|
|
9023
9024
|
attr_accessor :attribute_value
|
|
@@ -9100,7 +9101,7 @@ module Google
|
|
|
9100
9101
|
end
|
|
9101
9102
|
end
|
|
9102
9103
|
|
|
9103
|
-
# Summary of the top N search
|
|
9104
|
+
# Summary of the top N search results specified by the summary spec.
|
|
9104
9105
|
class GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
|
|
9105
9106
|
include Google::Apis::Core::Hashable
|
|
9106
9107
|
|
|
@@ -9652,7 +9653,8 @@ module Google
|
|
|
9652
9653
|
class GoogleCloudDiscoveryengineV1alphaSessionTurn
|
|
9653
9654
|
include Google::Apis::Core::Hashable
|
|
9654
9655
|
|
|
9655
|
-
# The resource name of the answer to the user query.
|
|
9656
|
+
# The resource name of the answer to the user query. Only set if the answer
|
|
9657
|
+
# generation (/answer API call) happened in this turn.
|
|
9656
9658
|
# Corresponds to the JSON property `answer`
|
|
9657
9659
|
# @return [String]
|
|
9658
9660
|
attr_accessor :answer
|
|
@@ -10267,7 +10269,7 @@ module Google
|
|
|
10267
10269
|
end
|
|
10268
10270
|
|
|
10269
10271
|
# UserEvent captures all metadata information Discovery Engine API needs to know
|
|
10270
|
-
# about how end users interact with
|
|
10272
|
+
# about how end users interact with your website.
|
|
10271
10273
|
class GoogleCloudDiscoveryengineV1alphaUserEvent
|
|
10272
10274
|
include Google::Apis::Core::Hashable
|
|
10273
10275
|
|
|
@@ -10406,7 +10408,7 @@ module Google
|
|
|
10406
10408
|
|
|
10407
10409
|
# A list of identifiers for the independent experiment groups this user event
|
|
10408
10410
|
# belongs to. This is used to distinguish between user events associated with
|
|
10409
|
-
# different experiment setups
|
|
10411
|
+
# different experiment setups.
|
|
10410
10412
|
# Corresponds to the JSON property `tagIds`
|
|
10411
10413
|
# @return [Array<String>]
|
|
10412
10414
|
attr_accessor :tag_ids
|
|
@@ -11121,8 +11123,7 @@ module Google
|
|
|
11121
11123
|
|
|
11122
11124
|
# The industry vertical that the engine registers. The restriction of the Engine
|
|
11123
11125
|
# industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
|
|
11124
|
-
# Vertical on Engine has to match vertical of the DataStore
|
|
11125
|
-
# engine.
|
|
11126
|
+
# Vertical on Engine has to match vertical of the DataStore linked to the engine.
|
|
11126
11127
|
# Corresponds to the JSON property `industryVertical`
|
|
11127
11128
|
# @return [String]
|
|
11128
11129
|
attr_accessor :industry_vertical
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module DiscoveryengineV1alpha
|
|
18
18
|
# Version of the google-apis-discoveryengine_v1alpha gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.47.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.15.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20240517"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -745,14 +745,14 @@ module Google
|
|
|
745
745
|
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
|
746
746
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
|
747
747
|
# @param [String] document_id
|
|
748
|
-
# Required. The ID to use for the Document, which
|
|
749
|
-
#
|
|
750
|
-
#
|
|
751
|
-
#
|
|
752
|
-
#
|
|
753
|
-
#
|
|
754
|
-
#
|
|
755
|
-
#
|
|
748
|
+
# Required. The ID to use for the Document, which becomes the final component of
|
|
749
|
+
# the Document.name. If the caller does not have permission to create the
|
|
750
|
+
# Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
|
|
751
|
+
# is returned. This field must be unique among all Documents with the same
|
|
752
|
+
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
|
753
|
+
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
|
754
|
+
# length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
755
|
+
# returned.
|
|
756
756
|
# @param [String] fields
|
|
757
757
|
# Selector specifying which fields to include in a partial response.
|
|
758
758
|
# @param [String] quota_user
|
|
@@ -895,8 +895,8 @@ module Google
|
|
|
895
895
|
end
|
|
896
896
|
|
|
897
897
|
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
|
898
|
-
# existing items
|
|
899
|
-
#
|
|
898
|
+
# existing items are created. Note: It is possible for a subset of the Documents
|
|
899
|
+
# to be successfully updated.
|
|
900
900
|
# @param [String] parent
|
|
901
901
|
# Required. The parent branch resource name, such as `projects/`project`/
|
|
902
902
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
@@ -941,8 +941,8 @@ module Google
|
|
|
941
941
|
# PERMISSION_DENIED` error is returned.
|
|
942
942
|
# @param [Fixnum] page_size
|
|
943
943
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
|
944
|
-
# maximum allowed value is 1000. Values above 1000
|
|
945
|
-
#
|
|
944
|
+
# maximum allowed value is 1000. Values above 1000 are set to 1000. If this
|
|
945
|
+
# field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
946
946
|
# @param [String] page_token
|
|
947
947
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
|
948
948
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
|
@@ -986,10 +986,10 @@ module Google
|
|
|
986
986
|
# with a length limit of 1024 characters.
|
|
987
987
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
|
988
988
|
# @param [Boolean] allow_missing
|
|
989
|
-
# If set to true
|
|
989
|
+
# If set to `true` and the Document is not found, a new Document is be created.
|
|
990
990
|
# @param [String] update_mask
|
|
991
991
|
# Indicates which fields in the provided imported 'document' to update. If not
|
|
992
|
-
# set,
|
|
992
|
+
# set, by default updates all fields.
|
|
993
993
|
# @param [String] fields
|
|
994
994
|
# Selector specifying which fields to include in a partial response.
|
|
995
995
|
# @param [String] quota_user
|
|
@@ -1661,8 +1661,8 @@ module Google
|
|
|
1661
1661
|
# .
|
|
1662
1662
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
|
1663
1663
|
# @param [String] schema_id
|
|
1664
|
-
# Required. The ID to use for the Schema, which
|
|
1665
|
-
#
|
|
1664
|
+
# Required. The ID to use for the Schema, which becomes the final component of
|
|
1665
|
+
# the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
|
1666
1666
|
# org/html/rfc1034) standard with a length limit of 63 characters.
|
|
1667
1667
|
# @param [String] fields
|
|
1668
1668
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -1765,8 +1765,8 @@ module Google
|
|
|
1765
1765
|
# .
|
|
1766
1766
|
# @param [Fixnum] page_size
|
|
1767
1767
|
# The maximum number of Schemas to return. The service may return fewer than
|
|
1768
|
-
# this value. If unspecified, at most 100 Schemas
|
|
1769
|
-
# value is 1000; values above 1000
|
|
1768
|
+
# this value. If unspecified, at most 100 Schemas are returned. The maximum
|
|
1769
|
+
# value is 1000; values above 1000 are set to 1000.
|
|
1770
1770
|
# @param [String] page_token
|
|
1771
1771
|
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
|
1772
1772
|
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
@@ -1809,8 +1809,8 @@ module Google
|
|
|
1809
1809
|
# limit of 1024 characters.
|
|
1810
1810
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
|
1811
1811
|
# @param [Boolean] allow_missing
|
|
1812
|
-
# If set to true, and the Schema is not found, a new Schema
|
|
1813
|
-
#
|
|
1812
|
+
# If set to true, and the Schema is not found, a new Schema is created. In this
|
|
1813
|
+
# situation, `update_mask` is ignored.
|
|
1814
1814
|
# @param [String] fields
|
|
1815
1815
|
# Selector specifying which fields to include in a partial response.
|
|
1816
1816
|
# @param [String] quota_user
|
|
@@ -2068,11 +2068,11 @@ module Google
|
|
|
2068
2068
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
|
2069
2069
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
|
2070
2070
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
|
2071
|
-
# created along with your recommendation engine creation. The engine ID
|
|
2072
|
-
#
|
|
2073
|
-
#
|
|
2074
|
-
#
|
|
2075
|
-
#
|
|
2071
|
+
# created along with your recommendation engine creation. The engine ID is used
|
|
2072
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
|
2073
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
|
2074
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
|
2075
|
+
# your RecommendationService.Recommend requests.
|
|
2076
2076
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
|
2077
2077
|
# @param [String] fields
|
|
2078
2078
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -3025,7 +3025,7 @@ module Google
|
|
|
3025
3025
|
execute_or_queue_command(command, &block)
|
|
3026
3026
|
end
|
|
3027
3027
|
|
|
3028
|
-
# Bulk import of
|
|
3028
|
+
# Bulk import of user events. Request processing might be synchronous. Events
|
|
3029
3029
|
# that already exist are skipped. Use this method for backfilling historical
|
|
3030
3030
|
# user events. Operation.response is of type ImportResponse. Note that it is
|
|
3031
3031
|
# possible for a subset of the items to be successfully inserted. Operation.
|
|
@@ -3887,11 +3887,11 @@ module Google
|
|
|
3887
3887
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
|
3888
3888
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
|
3889
3889
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
|
3890
|
-
# created along with your recommendation engine creation. The engine ID
|
|
3891
|
-
#
|
|
3892
|
-
#
|
|
3893
|
-
#
|
|
3894
|
-
#
|
|
3890
|
+
# created along with your recommendation engine creation. The engine ID is used
|
|
3891
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
|
3892
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
|
3893
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
|
3894
|
+
# your RecommendationService.Recommend requests.
|
|
3895
3895
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
|
3896
3896
|
# @param [String] fields
|
|
3897
3897
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -4633,14 +4633,14 @@ module Google
|
|
|
4633
4633
|
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
|
4634
4634
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
|
4635
4635
|
# @param [String] document_id
|
|
4636
|
-
# Required. The ID to use for the Document, which
|
|
4637
|
-
#
|
|
4638
|
-
#
|
|
4639
|
-
#
|
|
4640
|
-
#
|
|
4641
|
-
#
|
|
4642
|
-
#
|
|
4643
|
-
#
|
|
4636
|
+
# Required. The ID to use for the Document, which becomes the final component of
|
|
4637
|
+
# the Document.name. If the caller does not have permission to create the
|
|
4638
|
+
# Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
|
|
4639
|
+
# is returned. This field must be unique among all Documents with the same
|
|
4640
|
+
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
|
4641
|
+
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
|
4642
|
+
# length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
4643
|
+
# returned.
|
|
4644
4644
|
# @param [String] fields
|
|
4645
4645
|
# Selector specifying which fields to include in a partial response.
|
|
4646
4646
|
# @param [String] quota_user
|
|
@@ -4783,8 +4783,8 @@ module Google
|
|
|
4783
4783
|
end
|
|
4784
4784
|
|
|
4785
4785
|
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
|
4786
|
-
# existing items
|
|
4787
|
-
#
|
|
4786
|
+
# existing items are created. Note: It is possible for a subset of the Documents
|
|
4787
|
+
# to be successfully updated.
|
|
4788
4788
|
# @param [String] parent
|
|
4789
4789
|
# Required. The parent branch resource name, such as `projects/`project`/
|
|
4790
4790
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
@@ -4829,8 +4829,8 @@ module Google
|
|
|
4829
4829
|
# PERMISSION_DENIED` error is returned.
|
|
4830
4830
|
# @param [Fixnum] page_size
|
|
4831
4831
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
|
4832
|
-
# maximum allowed value is 1000. Values above 1000
|
|
4833
|
-
#
|
|
4832
|
+
# maximum allowed value is 1000. Values above 1000 are set to 1000. If this
|
|
4833
|
+
# field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
4834
4834
|
# @param [String] page_token
|
|
4835
4835
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
|
4836
4836
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
|
@@ -4874,10 +4874,10 @@ module Google
|
|
|
4874
4874
|
# with a length limit of 1024 characters.
|
|
4875
4875
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
|
4876
4876
|
# @param [Boolean] allow_missing
|
|
4877
|
-
# If set to true
|
|
4877
|
+
# If set to `true` and the Document is not found, a new Document is be created.
|
|
4878
4878
|
# @param [String] update_mask
|
|
4879
4879
|
# Indicates which fields in the provided imported 'document' to update. If not
|
|
4880
|
-
# set,
|
|
4880
|
+
# set, by default updates all fields.
|
|
4881
4881
|
# @param [String] fields
|
|
4882
4882
|
# Selector specifying which fields to include in a partial response.
|
|
4883
4883
|
# @param [String] quota_user
|
|
@@ -5517,8 +5517,8 @@ module Google
|
|
|
5517
5517
|
# .
|
|
5518
5518
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
|
5519
5519
|
# @param [String] schema_id
|
|
5520
|
-
# Required. The ID to use for the Schema, which
|
|
5521
|
-
#
|
|
5520
|
+
# Required. The ID to use for the Schema, which becomes the final component of
|
|
5521
|
+
# the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
|
5522
5522
|
# org/html/rfc1034) standard with a length limit of 63 characters.
|
|
5523
5523
|
# @param [String] fields
|
|
5524
5524
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -5621,8 +5621,8 @@ module Google
|
|
|
5621
5621
|
# .
|
|
5622
5622
|
# @param [Fixnum] page_size
|
|
5623
5623
|
# The maximum number of Schemas to return. The service may return fewer than
|
|
5624
|
-
# this value. If unspecified, at most 100 Schemas
|
|
5625
|
-
# value is 1000; values above 1000
|
|
5624
|
+
# this value. If unspecified, at most 100 Schemas are returned. The maximum
|
|
5625
|
+
# value is 1000; values above 1000 are set to 1000.
|
|
5626
5626
|
# @param [String] page_token
|
|
5627
5627
|
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
|
5628
5628
|
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
@@ -5665,8 +5665,8 @@ module Google
|
|
|
5665
5665
|
# limit of 1024 characters.
|
|
5666
5666
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema] google_cloud_discoveryengine_v1alpha_schema_object
|
|
5667
5667
|
# @param [Boolean] allow_missing
|
|
5668
|
-
# If set to true, and the Schema is not found, a new Schema
|
|
5669
|
-
#
|
|
5668
|
+
# If set to true, and the Schema is not found, a new Schema is created. In this
|
|
5669
|
+
# situation, `update_mask` is ignored.
|
|
5670
5670
|
# @param [String] fields
|
|
5671
5671
|
# Selector specifying which fields to include in a partial response.
|
|
5672
5672
|
# @param [String] quota_user
|
|
@@ -5853,11 +5853,11 @@ module Google
|
|
|
5853
5853
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
|
5854
5854
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
|
5855
5855
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
|
5856
|
-
# created along with your recommendation engine creation. The engine ID
|
|
5857
|
-
#
|
|
5858
|
-
#
|
|
5859
|
-
#
|
|
5860
|
-
#
|
|
5856
|
+
# created along with your recommendation engine creation. The engine ID is used
|
|
5857
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
|
5858
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
|
5859
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
|
5860
|
+
# your RecommendationService.Recommend requests.
|
|
5861
5861
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
|
5862
5862
|
# @param [String] fields
|
|
5863
5863
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -6587,7 +6587,7 @@ module Google
|
|
|
6587
6587
|
execute_or_queue_command(command, &block)
|
|
6588
6588
|
end
|
|
6589
6589
|
|
|
6590
|
-
# Bulk import of
|
|
6590
|
+
# Bulk import of user events. Request processing might be synchronous. Events
|
|
6591
6591
|
# that already exist are skipped. Use this method for backfilling historical
|
|
6592
6592
|
# user events. Operation.response is of type ImportResponse. Note that it is
|
|
6593
6593
|
# possible for a subset of the items to be successfully inserted. Operation.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-discoveryengine_v1alpha
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.47.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-05-
|
|
11
|
+
date: 2024-05-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: google-apis-core
|
|
@@ -58,7 +58,7 @@ licenses:
|
|
|
58
58
|
metadata:
|
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
|
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.
|
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.47.0
|
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
|
|
63
63
|
post_install_message:
|
|
64
64
|
rdoc_options: []
|