google-apis-discoveryengine_v1alpha 0.9.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +222 -56
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +74 -0
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +189 -38
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 886e851d158bf55d9c66646adbfb16ebfd86c2f40bb14d26db1b36b0523702d5
|
4
|
+
data.tar.gz: 8ff1956efdc8bf40b39b29fae1005658a5b78708248394cc1040fa7a058b29ea
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a3c4b1e9af6383ce58cacc580a925570c21f8625bab7ede6737eecf68985c9f7ba951277a403234e18507b570f48ad77a4df3a0de04f082341b764deb4c4a21e
|
7
|
+
data.tar.gz: 7fb5ae09a5458b91eae641d8f662ea36b53945b155bef87edce33b46a3a2132300032a110e773706e75d332b525d32c77bfa1dd199990ce48ca563dd853b9b32
|
data/CHANGELOG.md
CHANGED
@@ -377,16 +377,18 @@ module Google
|
|
377
377
|
include Google::Apis::Core::Hashable
|
378
378
|
|
379
379
|
# The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
|
380
|
-
# the key is "lengths_cm". Exactly one of text or
|
381
|
-
# Otherwise, an INVALID_ARGUMENT error
|
380
|
+
# the key is "lengths_cm". Exactly one of CustomAttribute.text or
|
381
|
+
# CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error
|
382
|
+
# is returned.
|
382
383
|
# Corresponds to the JSON property `numbers`
|
383
384
|
# @return [Array<Float>]
|
384
385
|
attr_accessor :numbers
|
385
386
|
|
386
387
|
# The textual values of this custom attribute. For example, `["yellow", "green"]`
|
387
|
-
# when the key is "color". Empty string is not allowed. Otherwise, an
|
388
|
-
# INVALID_ARGUMENT error is returned. Exactly one of text or
|
389
|
-
# set. Otherwise, an INVALID_ARGUMENT error
|
388
|
+
# when the key is "color". Empty string is not allowed. Otherwise, an `
|
389
|
+
# INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or
|
390
|
+
# CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error
|
391
|
+
# is returned.
|
390
392
|
# Corresponds to the JSON property `text`
|
391
393
|
# @return [Array<String>]
|
392
394
|
attr_accessor :text
|
@@ -415,7 +417,7 @@ module Google
|
|
415
417
|
attr_accessor :id
|
416
418
|
|
417
419
|
# The JSON string representation of the document. It should conform to the
|
418
|
-
# registered schema or an INVALID_ARGUMENT error is thrown.
|
420
|
+
# registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.
|
419
421
|
# Corresponds to the JSON property `jsonData`
|
420
422
|
# @return [String]
|
421
423
|
attr_accessor :json_data
|
@@ -441,7 +443,7 @@ module Google
|
|
441
443
|
attr_accessor :schema_id
|
442
444
|
|
443
445
|
# The structured JSON data for the document. It should conform to the registered
|
444
|
-
# schema or an INVALID_ARGUMENT error is thrown.
|
446
|
+
# Schema.schema or an `INVALID_ARGUMENT` error is thrown.
|
445
447
|
# Corresponds to the JSON property `structData`
|
446
448
|
# @return [Hash<String,Object>]
|
447
449
|
attr_accessor :struct_data
|
@@ -470,9 +472,9 @@ module Google
|
|
470
472
|
# @return [String]
|
471
473
|
attr_accessor :id
|
472
474
|
|
473
|
-
# Required. The Document resource full name, of the form: projects/`
|
474
|
-
# locations/`location`/collections/`
|
475
|
-
# branches/`
|
475
|
+
# Required. The Document resource full name, of the form: `projects/`project_id`/
|
476
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
|
477
|
+
# branches/`branch_id`/documents/`document_id``
|
476
478
|
# Corresponds to the JSON property `name`
|
477
479
|
# @return [String]
|
478
480
|
attr_accessor :name
|
@@ -866,7 +868,7 @@ module Google
|
|
866
868
|
attr_accessor :media_progress_duration
|
867
869
|
|
868
870
|
# Media progress should be computed using only the media_progress_duration
|
869
|
-
# relative to the media total length. This value must be between [0, 1.0]
|
871
|
+
# relative to the media total length. This value must be between `[0, 1.0]`
|
870
872
|
# inclusive. If this is not a playback or the progress cannot be computed (e.g.
|
871
873
|
# ongoing livestream), this field should be unset.
|
872
874
|
# Corresponds to the JSON property `mediaProgressPercentage`
|
@@ -978,19 +980,115 @@ module Google
|
|
978
980
|
end
|
979
981
|
end
|
980
982
|
|
983
|
+
# Metadata related to the progress of the PurgeDocuments operation. This will be
|
984
|
+
# returned by the google.longrunning.Operation.metadata field.
|
985
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
|
986
|
+
include Google::Apis::Core::Hashable
|
987
|
+
|
988
|
+
# Operation create time.
|
989
|
+
# Corresponds to the JSON property `createTime`
|
990
|
+
# @return [String]
|
991
|
+
attr_accessor :create_time
|
992
|
+
|
993
|
+
# Count of entries that encountered errors while processing.
|
994
|
+
# Corresponds to the JSON property `failureCount`
|
995
|
+
# @return [Fixnum]
|
996
|
+
attr_accessor :failure_count
|
997
|
+
|
998
|
+
# Count of entries that were deleted successfully.
|
999
|
+
# Corresponds to the JSON property `successCount`
|
1000
|
+
# @return [Fixnum]
|
1001
|
+
attr_accessor :success_count
|
1002
|
+
|
1003
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1004
|
+
# time.
|
1005
|
+
# Corresponds to the JSON property `updateTime`
|
1006
|
+
# @return [String]
|
1007
|
+
attr_accessor :update_time
|
1008
|
+
|
1009
|
+
def initialize(**args)
|
1010
|
+
update!(**args)
|
1011
|
+
end
|
1012
|
+
|
1013
|
+
# Update properties of this object
|
1014
|
+
def update!(**args)
|
1015
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1016
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
1017
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
1018
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1019
|
+
end
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
# Request message for DocumentService.PurgeDocuments method.
|
1023
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
|
1024
|
+
include Google::Apis::Core::Hashable
|
1025
|
+
|
1026
|
+
# Required. Filter matching documents to purge. Only currently supported value
|
1027
|
+
# is “*” (all items).
|
1028
|
+
# Corresponds to the JSON property `filter`
|
1029
|
+
# @return [String]
|
1030
|
+
attr_accessor :filter
|
1031
|
+
|
1032
|
+
# Actually performs the purge. If `force` is set to false, return the expected
|
1033
|
+
# purge count without deleting any documents.
|
1034
|
+
# Corresponds to the JSON property `force`
|
1035
|
+
# @return [Boolean]
|
1036
|
+
attr_accessor :force
|
1037
|
+
alias_method :force?, :force
|
1038
|
+
|
1039
|
+
def initialize(**args)
|
1040
|
+
update!(**args)
|
1041
|
+
end
|
1042
|
+
|
1043
|
+
# Update properties of this object
|
1044
|
+
def update!(**args)
|
1045
|
+
@filter = args[:filter] if args.key?(:filter)
|
1046
|
+
@force = args[:force] if args.key?(:force)
|
1047
|
+
end
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# Response message for DocumentService.PurgeDocuments method. If the long
|
1051
|
+
# running operation is successfully done, then this message is returned by the
|
1052
|
+
# google.longrunning.Operations.response field.
|
1053
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse
|
1054
|
+
include Google::Apis::Core::Hashable
|
1055
|
+
|
1056
|
+
# The total count of documents purged as a result of the operation.
|
1057
|
+
# Corresponds to the JSON property `purgeCount`
|
1058
|
+
# @return [Fixnum]
|
1059
|
+
attr_accessor :purge_count
|
1060
|
+
|
1061
|
+
# A sample of document names that will be deleted. Only populated if `force` is
|
1062
|
+
# set to false. A max of 100 names will be returned and the names are chosen at
|
1063
|
+
# random.
|
1064
|
+
# Corresponds to the JSON property `purgeSample`
|
1065
|
+
# @return [Array<String>]
|
1066
|
+
attr_accessor :purge_sample
|
1067
|
+
|
1068
|
+
def initialize(**args)
|
1069
|
+
update!(**args)
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Update properties of this object
|
1073
|
+
def update!(**args)
|
1074
|
+
@purge_count = args[:purge_count] if args.key?(:purge_count)
|
1075
|
+
@purge_sample = args[:purge_sample] if args.key?(:purge_sample)
|
1076
|
+
end
|
1077
|
+
end
|
1078
|
+
|
981
1079
|
# Request message for Recommend method.
|
982
1080
|
class GoogleCloudDiscoveryengineV1alphaRecommendRequest
|
983
1081
|
include Google::Apis::Core::Hashable
|
984
1082
|
|
985
1083
|
# Filter for restricting recommendation results with a length limit of 5,000
|
986
1084
|
# characters. Currently, only filter expressions on the `filter_tags` attribute
|
987
|
-
# is supported. Examples: * (filter_tags: ANY("Red", "Blue") OR filter_tags:
|
988
|
-
# "Hot", "Cold")) * (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
|
989
|
-
# Green")) If your filter blocks all results, the API will return generic
|
990
|
-
# unfiltered) popular Documents. If you only want results strictly matching the
|
1085
|
+
# is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags:
|
1086
|
+
# ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
|
1087
|
+
# ANY("Green"))` If your filter blocks all results, the API will return generic
|
1088
|
+
# (unfiltered) popular Documents. If you only want results strictly matching the
|
991
1089
|
# filters, set `strictFiltering` to True in RecommendRequest.params to receive
|
992
|
-
# empty results instead. Note that the API will never return Documents with
|
993
|
-
# storageStatus of
|
1090
|
+
# empty results instead. Note that the API will never return Documents with `
|
1091
|
+
# storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
994
1092
|
# Corresponds to the JSON property `filter`
|
995
1093
|
# @return [String]
|
996
1094
|
attr_accessor :filter
|
@@ -1005,17 +1103,17 @@ module Google
|
|
1005
1103
|
|
1006
1104
|
# Additional domain specific parameters for the recommendations. Allowed values:
|
1007
1105
|
# * `returnDocument`: Boolean. If set to true, the associated Document object
|
1008
|
-
# will be returned in RecommendResponse.
|
1009
|
-
# Boolean. If set to true, the recommendation 'score'
|
1010
|
-
# returned Document will be set in RecommendResponse.
|
1011
|
-
# 'score' indicates the probability of
|
1012
|
-
# context and history. * `strictFiltering
|
1013
|
-
# false, the service will return generic (
|
1014
|
-
# of empty if your filter blocks all
|
1015
|
-
# String. Default empty. If set to
|
1016
|
-
#
|
1017
|
-
# auto-diversity
|
1018
|
-
# results based on Document category.
|
1106
|
+
# will be returned in RecommendResponse.RecommendationResult.document. * `
|
1107
|
+
# returnScore`: Boolean. If set to true, the recommendation 'score'
|
1108
|
+
# corresponding to each returned Document will be set in RecommendResponse.
|
1109
|
+
# RecommendationResult.metadata. The given 'score' indicates the probability of
|
1110
|
+
# a Document conversion given the user's context and history. * `strictFiltering`
|
1111
|
+
# : Boolean. True by default. If set to false, the service will return generic (
|
1112
|
+
# unfiltered) popular Documents instead of empty if your filter blocks all
|
1113
|
+
# recommendation results. * `diversityLevel`: String. Default empty. If set to
|
1114
|
+
# be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` *
|
1115
|
+
# `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-
|
1116
|
+
# level control and adjusts recommendation results based on Document category.
|
1019
1117
|
# Corresponds to the JSON property `params`
|
1020
1118
|
# @return [Hash<String,Object>]
|
1021
1119
|
attr_accessor :params
|
@@ -1202,8 +1300,8 @@ module Google
|
|
1202
1300
|
# The user's search query. See SearchRequest.query for definition. The value
|
1203
1301
|
# must be a UTF-8 encoded string with a length limit of 5,000 characters.
|
1204
1302
|
# Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query
|
1205
|
-
# or
|
1206
|
-
# not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
1303
|
+
# or PageInfo.page_category is required for `search` events. Other event types
|
1304
|
+
# should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
1207
1305
|
# Corresponds to the JSON property `searchQuery`
|
1208
1306
|
# @return [String]
|
1209
1307
|
attr_accessor :search_query
|
@@ -1292,33 +1390,33 @@ module Google
|
|
1292
1390
|
# imported events and events provided with prediction requests. This lets the
|
1293
1391
|
# Discovery Engine API use those custom attributes when training models and
|
1294
1392
|
# serving predictions, which helps improve recommendation quality. This field
|
1295
|
-
# needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
|
1393
|
+
# needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is
|
1296
1394
|
# returned: * The key must be a UTF-8 encoded string with a length limit of 5,
|
1297
1395
|
# 000 characters. * For text attributes, at most 400 values are allowed. Empty
|
1298
1396
|
# values are not allowed. Each value must be a UTF-8 encoded string with a
|
1299
1397
|
# length limit of 256 characters. * For number attributes, at most 400 values
|
1300
1398
|
# are allowed. For product recommendations, an example of extra user information
|
1301
|
-
# is traffic_channel
|
1302
|
-
# at the site by coming to the site directly, coming through Google
|
1303
|
-
# in other ways.
|
1399
|
+
# is ` traffic_channel`, which is how a user arrives at the site. Users can
|
1400
|
+
# arrive at the site by coming to the site directly, coming through Google
|
1401
|
+
# search, or in other ways.
|
1304
1402
|
# Corresponds to the JSON property `attributes`
|
1305
1403
|
# @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomAttribute>]
|
1306
1404
|
attr_accessor :attributes
|
1307
1405
|
|
1308
1406
|
# Token to attribute an API response to user action(s) to trigger the event.
|
1309
|
-
# Highly recommended for user events that are the result of
|
1310
|
-
#
|
1311
|
-
# performance. The value must be one of: * PredictResponse.
|
1312
|
-
# events that are the result of
|
1313
|
-
# attribution_token for events that are the result
|
1314
|
-
# CompleteQueryResponse.attribution_token for events
|
1315
|
-
#
|
1316
|
-
# page view or conversion completion back to the event
|
1317
|
-
# predict response containing this clicked/purchased product.
|
1318
|
-
# product K in the recommendation results, pass
|
1319
|
-
# attribution_token as a URL parameter to product K's page. When
|
1320
|
-
# events on product K's page, log the PredictResponse.
|
1321
|
-
# field.
|
1407
|
+
# Highly recommended for user events that are the result of
|
1408
|
+
# RecommendationService.Recommend. This field enables accurate attribution of
|
1409
|
+
# recommendation model performance. The value must be one of: * PredictResponse.
|
1410
|
+
# attribution_token for events that are the result of RecommendationService.
|
1411
|
+
# Recommend. * SearchResponse.attribution_token for events that are the result
|
1412
|
+
# of SearchService.Search. * CompleteQueryResponse.attribution_token for events
|
1413
|
+
# that are the result of CompletionService.CompleteQuery. This token enables us
|
1414
|
+
# to accurately attribute page view or conversion completion back to the event
|
1415
|
+
# and the particular predict response containing this clicked/purchased product.
|
1416
|
+
# If user clicks on product K in the recommendation results, pass
|
1417
|
+
# PredictResponse.attribution_token as a URL parameter to product K's page. When
|
1418
|
+
# recording events on product K's page, log the PredictResponse.
|
1419
|
+
# attribution_token to this field.
|
1322
1420
|
# Corresponds to the JSON property `attributionToken`
|
1323
1421
|
# @return [String]
|
1324
1422
|
attr_accessor :attribution_token
|
@@ -1371,11 +1469,11 @@ module Google
|
|
1371
1469
|
|
1372
1470
|
# The filter syntax consists of an expression language for constructing a
|
1373
1471
|
# predicate from one or more fields of the documents being filtered. One example
|
1374
|
-
# is for `search` events, the associated
|
1375
|
-
#
|
1376
|
-
#
|
1377
|
-
#
|
1378
|
-
#
|
1472
|
+
# is for `search` events, the associated SearchRequest may contain a filter
|
1473
|
+
# expression in SearchRequest.filter conforming to https://google.aip.dev/160#
|
1474
|
+
# filtering. Similarly, for `view-item-list` events that are generated from a
|
1475
|
+
# RecommendationService.RecommendRequest, this field may be populated directly
|
1476
|
+
# from RecommendationService.RecommendRequest.filter conforming to https://
|
1379
1477
|
# google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a
|
1380
1478
|
# length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
|
1381
1479
|
# returned.
|
@@ -1483,10 +1581,10 @@ module Google
|
|
1483
1581
|
|
1484
1582
|
# User agent as included in the HTTP header. Required for getting SearchResponse.
|
1485
1583
|
# sponsored_results. The field must be a UTF-8 encoded string with a length
|
1486
|
-
# limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
1584
|
+
# limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
1487
1585
|
# This should not be set when using the client side event reporting with GTM or
|
1488
|
-
# JavaScript tag in UserEventService.CollectUserEvent or if
|
1489
|
-
# is set.
|
1586
|
+
# JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.
|
1587
|
+
# direct_user_request is set.
|
1490
1588
|
# Corresponds to the JSON property `userAgent`
|
1491
1589
|
# @return [String]
|
1492
1590
|
attr_accessor :user_agent
|
@@ -1496,7 +1594,7 @@ module Google
|
|
1496
1594
|
# for this ID. Don't set the field to the same fixed ID for different users.
|
1497
1595
|
# This mixes the event history of those users together, which results in
|
1498
1596
|
# degraded model quality. The field must be a UTF-8 encoded string with a length
|
1499
|
-
# limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
1597
|
+
# limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
1500
1598
|
# Corresponds to the JSON property `userId`
|
1501
1599
|
# @return [String]
|
1502
1600
|
attr_accessor :user_id
|
@@ -1678,6 +1776,74 @@ module Google
|
|
1678
1776
|
end
|
1679
1777
|
end
|
1680
1778
|
|
1779
|
+
# Metadata related to the progress of the PurgeDocuments operation. This will be
|
1780
|
+
# returned by the google.longrunning.Operation.metadata field.
|
1781
|
+
class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
|
1782
|
+
include Google::Apis::Core::Hashable
|
1783
|
+
|
1784
|
+
# Operation create time.
|
1785
|
+
# Corresponds to the JSON property `createTime`
|
1786
|
+
# @return [String]
|
1787
|
+
attr_accessor :create_time
|
1788
|
+
|
1789
|
+
# Count of entries that encountered errors while processing.
|
1790
|
+
# Corresponds to the JSON property `failureCount`
|
1791
|
+
# @return [Fixnum]
|
1792
|
+
attr_accessor :failure_count
|
1793
|
+
|
1794
|
+
# Count of entries that were deleted successfully.
|
1795
|
+
# Corresponds to the JSON property `successCount`
|
1796
|
+
# @return [Fixnum]
|
1797
|
+
attr_accessor :success_count
|
1798
|
+
|
1799
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1800
|
+
# time.
|
1801
|
+
# Corresponds to the JSON property `updateTime`
|
1802
|
+
# @return [String]
|
1803
|
+
attr_accessor :update_time
|
1804
|
+
|
1805
|
+
def initialize(**args)
|
1806
|
+
update!(**args)
|
1807
|
+
end
|
1808
|
+
|
1809
|
+
# Update properties of this object
|
1810
|
+
def update!(**args)
|
1811
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1812
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
1813
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
1814
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1815
|
+
end
|
1816
|
+
end
|
1817
|
+
|
1818
|
+
# Response message for DocumentService.PurgeDocuments method. If the long
|
1819
|
+
# running operation is successfully done, then this message is returned by the
|
1820
|
+
# google.longrunning.Operations.response field.
|
1821
|
+
class GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse
|
1822
|
+
include Google::Apis::Core::Hashable
|
1823
|
+
|
1824
|
+
# The total count of documents purged as a result of the operation.
|
1825
|
+
# Corresponds to the JSON property `purgeCount`
|
1826
|
+
# @return [Fixnum]
|
1827
|
+
attr_accessor :purge_count
|
1828
|
+
|
1829
|
+
# A sample of document names that will be deleted. Only populated if `force` is
|
1830
|
+
# set to false. A max of 100 names will be returned and the names are chosen at
|
1831
|
+
# random.
|
1832
|
+
# Corresponds to the JSON property `purgeSample`
|
1833
|
+
# @return [Array<String>]
|
1834
|
+
attr_accessor :purge_sample
|
1835
|
+
|
1836
|
+
def initialize(**args)
|
1837
|
+
update!(**args)
|
1838
|
+
end
|
1839
|
+
|
1840
|
+
# Update properties of this object
|
1841
|
+
def update!(**args)
|
1842
|
+
@purge_count = args[:purge_count] if args.key?(:purge_count)
|
1843
|
+
@purge_sample = args[:purge_sample] if args.key?(:purge_sample)
|
1844
|
+
end
|
1845
|
+
end
|
1846
|
+
|
1681
1847
|
# Defines the structure and layout of a type of document data.
|
1682
1848
|
class GoogleCloudDiscoveryengineV1betaSchema
|
1683
1849
|
include Google::Apis::Core::Hashable
|
@@ -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.10.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20230427"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -178,6 +178,24 @@ module Google
|
|
178
178
|
include Google::Apis::Core::JsonObjectSupport
|
179
179
|
end
|
180
180
|
|
181
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
|
182
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
|
+
|
184
|
+
include Google::Apis::Core::JsonObjectSupport
|
185
|
+
end
|
186
|
+
|
187
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
|
188
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
189
|
+
|
190
|
+
include Google::Apis::Core::JsonObjectSupport
|
191
|
+
end
|
192
|
+
|
193
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse
|
194
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
195
|
+
|
196
|
+
include Google::Apis::Core::JsonObjectSupport
|
197
|
+
end
|
198
|
+
|
181
199
|
class GoogleCloudDiscoveryengineV1alphaRecommendRequest
|
182
200
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
201
|
|
@@ -256,6 +274,18 @@ module Google
|
|
256
274
|
include Google::Apis::Core::JsonObjectSupport
|
257
275
|
end
|
258
276
|
|
277
|
+
class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
|
278
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
279
|
+
|
280
|
+
include Google::Apis::Core::JsonObjectSupport
|
281
|
+
end
|
282
|
+
|
283
|
+
class GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse
|
284
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
285
|
+
|
286
|
+
include Google::Apis::Core::JsonObjectSupport
|
287
|
+
end
|
288
|
+
|
259
289
|
class GoogleCloudDiscoveryengineV1betaSchema
|
260
290
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
261
291
|
|
@@ -550,6 +580,32 @@ module Google
|
|
550
580
|
end
|
551
581
|
end
|
552
582
|
|
583
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
|
584
|
+
# @private
|
585
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
586
|
+
property :create_time, as: 'createTime'
|
587
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
588
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
589
|
+
property :update_time, as: 'updateTime'
|
590
|
+
end
|
591
|
+
end
|
592
|
+
|
593
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
|
594
|
+
# @private
|
595
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
596
|
+
property :filter, as: 'filter'
|
597
|
+
property :force, as: 'force'
|
598
|
+
end
|
599
|
+
end
|
600
|
+
|
601
|
+
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse
|
602
|
+
# @private
|
603
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
604
|
+
property :purge_count, :numeric_string => true, as: 'purgeCount'
|
605
|
+
collection :purge_sample, as: 'purgeSample'
|
606
|
+
end
|
607
|
+
end
|
608
|
+
|
553
609
|
class GoogleCloudDiscoveryengineV1alphaRecommendRequest
|
554
610
|
# @private
|
555
611
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -704,6 +760,24 @@ module Google
|
|
704
760
|
end
|
705
761
|
end
|
706
762
|
|
763
|
+
class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
|
764
|
+
# @private
|
765
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
766
|
+
property :create_time, as: 'createTime'
|
767
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
768
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
769
|
+
property :update_time, as: 'updateTime'
|
770
|
+
end
|
771
|
+
end
|
772
|
+
|
773
|
+
class GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse
|
774
|
+
# @private
|
775
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
776
|
+
property :purge_count, :numeric_string => true, as: 'purgeCount'
|
777
|
+
collection :purge_sample, as: 'purgeSample'
|
778
|
+
end
|
779
|
+
end
|
780
|
+
|
707
781
|
class GoogleCloudDiscoveryengineV1betaSchema
|
708
782
|
# @private
|
709
783
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -57,12 +57,12 @@ module Google
|
|
57
57
|
# @param [String] document_id
|
58
58
|
# Required. The ID to use for the Document, which will become the final
|
59
59
|
# component of the Document.name. If the caller does not have permission to
|
60
|
-
# create the Document, regardless of whether or not it exists, a
|
61
|
-
# PERMISSION_DENIED error is returned. This field must be unique among all
|
62
|
-
# Documents with the same parent. Otherwise, an ALREADY_EXISTS error is
|
63
|
-
# This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
64
|
-
# standard with a length limit of 63 characters. Otherwise, an
|
65
|
-
# error is returned.
|
60
|
+
# create the Document, regardless of whether or not it exists, a `
|
61
|
+
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
62
|
+
# Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
63
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
64
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
65
|
+
# INVALID_ARGUMENT` error is returned.
|
66
66
|
# @param [String] fields
|
67
67
|
# Selector specifying which fields to include in a partial response.
|
68
68
|
# @param [String] quota_user
|
@@ -98,9 +98,9 @@ module Google
|
|
98
98
|
# Required. Full resource name of Document, such as `projects/`project`/
|
99
99
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
100
100
|
# `branch`/documents/`document``. If the caller does not have permission to
|
101
|
-
# delete the Document, regardless of whether or not it exists, a
|
102
|
-
# PERMISSION_DENIED error is returned. If the Document to delete does not exist,
|
103
|
-
# a NOT_FOUND error is returned.
|
101
|
+
# delete the Document, regardless of whether or not it exists, a `
|
102
|
+
# PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
|
103
|
+
# a `NOT_FOUND` error is returned.
|
104
104
|
# @param [String] fields
|
105
105
|
# Selector specifying which fields to include in a partial response.
|
106
106
|
# @param [String] quota_user
|
@@ -133,9 +133,9 @@ module Google
|
|
133
133
|
# Required. Full resource name of Document, such as `projects/`project`/
|
134
134
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
135
135
|
# `branch`/documents/`document``. If the caller does not have permission to
|
136
|
-
# access the Document, regardless of whether or not it exists, a
|
137
|
-
# PERMISSION_DENIED error is returned. If the requested Document does not exist,
|
138
|
-
# a NOT_FOUND error is returned.
|
136
|
+
# access the Document, regardless of whether or not it exists, a `
|
137
|
+
# PERMISSION_DENIED` error is returned. If the requested Document does not exist,
|
138
|
+
# a `NOT_FOUND` error is returned.
|
139
139
|
# @param [String] fields
|
140
140
|
# Selector specifying which fields to include in a partial response.
|
141
141
|
# @param [String] quota_user
|
@@ -206,18 +206,18 @@ module Google
|
|
206
206
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
207
207
|
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
208
208
|
# default branch. If the caller does not have permission to list Documentss
|
209
|
-
# under this branch, regardless of whether or not this branch exists, a
|
210
|
-
# PERMISSION_DENIED error is returned.
|
209
|
+
# under this branch, regardless of whether or not this branch exists, a `
|
210
|
+
# PERMISSION_DENIED` error is returned.
|
211
211
|
# @param [Fixnum] page_size
|
212
212
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
213
213
|
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
214
|
-
# this field is negative, an INVALID_ARGUMENT error is returned.
|
214
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
215
215
|
# @param [String] page_token
|
216
216
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
217
217
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
218
218
|
# page. When paginating, all other parameters provided to DocumentService.
|
219
|
-
# ListDocuments must match the call that provided the page token. Otherwise, an
|
220
|
-
# INVALID_ARGUMENT error is returned.
|
219
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
220
|
+
# INVALID_ARGUMENT` error is returned.
|
221
221
|
# @param [String] fields
|
222
222
|
# Selector specifying which fields to include in a partial response.
|
223
223
|
# @param [String] quota_user
|
@@ -286,6 +286,46 @@ module Google
|
|
286
286
|
execute_or_queue_command(command, &block)
|
287
287
|
end
|
288
288
|
|
289
|
+
# Permanently deletes all selected Documents under a branch. This process is
|
290
|
+
# asynchronous. If the request is valid, the removal will be enquired and
|
291
|
+
# processed offlines. Depending on the number of Documents, this operation could
|
292
|
+
# take hours to complete. Before the operation completes, some Documents may
|
293
|
+
# still be returned by DocumentService.GetDocument or DocumentService.
|
294
|
+
# ListDocuments. To get a sample of Documents that would be deleted, set
|
295
|
+
# PurgeDocumentsRequest.force to false.
|
296
|
+
# @param [String] parent
|
297
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
298
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
299
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest] google_cloud_discoveryengine_v1alpha_purge_documents_request_object
|
300
|
+
# @param [String] fields
|
301
|
+
# Selector specifying which fields to include in a partial response.
|
302
|
+
# @param [String] quota_user
|
303
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
304
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
305
|
+
# @param [Google::Apis::RequestOptions] options
|
306
|
+
# Request-specific options
|
307
|
+
#
|
308
|
+
# @yield [result, err] Result & error if block supplied
|
309
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
310
|
+
# @yieldparam err [StandardError] error object if request failed
|
311
|
+
#
|
312
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
313
|
+
#
|
314
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
315
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
316
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
317
|
+
def purge_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1alpha_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
318
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/documents:purge', options)
|
319
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest::Representation
|
320
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_purge_documents_request_object
|
321
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
322
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
323
|
+
command.params['parent'] = parent unless parent.nil?
|
324
|
+
command.query['fields'] = fields unless fields.nil?
|
325
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
326
|
+
execute_or_queue_command(command, &block)
|
327
|
+
end
|
328
|
+
|
289
329
|
# Gets the latest state of a long-running operation. Clients can use this method
|
290
330
|
# to poll the operation result at intervals as recommended by the API service.
|
291
331
|
# @param [String] name
|
@@ -501,8 +541,8 @@ module Google
|
|
501
541
|
|
502
542
|
# Makes a recommendation, which requires a contextual user event.
|
503
543
|
# @param [String] serving_config
|
504
|
-
# Required. Full resource name of the format: projects/*/locations/global/
|
505
|
-
# collections/*/dataStores/*/servingConfigs
|
544
|
+
# Required. Full resource name of the format: `projects/*/locations/global/
|
545
|
+
# collections/*/dataStores/*/servingConfigs/*` Before you can request
|
506
546
|
# recommendations from your model, you must create at least one serving config
|
507
547
|
# for it.
|
508
548
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
@@ -655,6 +695,77 @@ module Google
|
|
655
695
|
execute_or_queue_command(command, &block)
|
656
696
|
end
|
657
697
|
|
698
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
699
|
+
# to poll the operation result at intervals as recommended by the API service.
|
700
|
+
# @param [String] name
|
701
|
+
# The name of the operation resource.
|
702
|
+
# @param [String] fields
|
703
|
+
# Selector specifying which fields to include in a partial response.
|
704
|
+
# @param [String] quota_user
|
705
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
706
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
707
|
+
# @param [Google::Apis::RequestOptions] options
|
708
|
+
# Request-specific options
|
709
|
+
#
|
710
|
+
# @yield [result, err] Result & error if block supplied
|
711
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
712
|
+
# @yieldparam err [StandardError] error object if request failed
|
713
|
+
#
|
714
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
715
|
+
#
|
716
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
717
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
718
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
719
|
+
def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
720
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
721
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
722
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
723
|
+
command.params['name'] = name unless name.nil?
|
724
|
+
command.query['fields'] = fields unless fields.nil?
|
725
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
726
|
+
execute_or_queue_command(command, &block)
|
727
|
+
end
|
728
|
+
|
729
|
+
# Lists operations that match the specified filter in the request. If the server
|
730
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
731
|
+
# @param [String] name
|
732
|
+
# The name of the operation's parent resource.
|
733
|
+
# @param [String] filter
|
734
|
+
# The standard list filter.
|
735
|
+
# @param [Fixnum] page_size
|
736
|
+
# The standard list page size.
|
737
|
+
# @param [String] page_token
|
738
|
+
# The standard list page token.
|
739
|
+
# @param [String] fields
|
740
|
+
# Selector specifying which fields to include in a partial response.
|
741
|
+
# @param [String] quota_user
|
742
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
743
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
744
|
+
# @param [Google::Apis::RequestOptions] options
|
745
|
+
# Request-specific options
|
746
|
+
#
|
747
|
+
# @yield [result, err] Result & error if block supplied
|
748
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
749
|
+
# @yieldparam err [StandardError] error object if request failed
|
750
|
+
#
|
751
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
752
|
+
#
|
753
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
754
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
755
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
756
|
+
def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
757
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
758
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
759
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
760
|
+
command.params['name'] = name unless name.nil?
|
761
|
+
command.query['filter'] = filter unless filter.nil?
|
762
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
763
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
764
|
+
command.query['fields'] = fields unless fields.nil?
|
765
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
766
|
+
execute_or_queue_command(command, &block)
|
767
|
+
end
|
768
|
+
|
658
769
|
# Gets the latest state of a long-running operation. Clients can use this method
|
659
770
|
# to poll the operation result at intervals as recommended by the API service.
|
660
771
|
# @param [String] name
|
@@ -734,12 +845,12 @@ module Google
|
|
734
845
|
# @param [String] document_id
|
735
846
|
# Required. The ID to use for the Document, which will become the final
|
736
847
|
# component of the Document.name. If the caller does not have permission to
|
737
|
-
# create the Document, regardless of whether or not it exists, a
|
738
|
-
# PERMISSION_DENIED error is returned. This field must be unique among all
|
739
|
-
# Documents with the same parent. Otherwise, an ALREADY_EXISTS error is
|
740
|
-
# This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
741
|
-
# standard with a length limit of 63 characters. Otherwise, an
|
742
|
-
# error is returned.
|
848
|
+
# create the Document, regardless of whether or not it exists, a `
|
849
|
+
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
850
|
+
# Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
851
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
852
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
853
|
+
# INVALID_ARGUMENT` error is returned.
|
743
854
|
# @param [String] fields
|
744
855
|
# Selector specifying which fields to include in a partial response.
|
745
856
|
# @param [String] quota_user
|
@@ -775,9 +886,9 @@ module Google
|
|
775
886
|
# Required. Full resource name of Document, such as `projects/`project`/
|
776
887
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
777
888
|
# `branch`/documents/`document``. If the caller does not have permission to
|
778
|
-
# delete the Document, regardless of whether or not it exists, a
|
779
|
-
# PERMISSION_DENIED error is returned. If the Document to delete does not exist,
|
780
|
-
# a NOT_FOUND error is returned.
|
889
|
+
# delete the Document, regardless of whether or not it exists, a `
|
890
|
+
# PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
|
891
|
+
# a `NOT_FOUND` error is returned.
|
781
892
|
# @param [String] fields
|
782
893
|
# Selector specifying which fields to include in a partial response.
|
783
894
|
# @param [String] quota_user
|
@@ -810,9 +921,9 @@ module Google
|
|
810
921
|
# Required. Full resource name of Document, such as `projects/`project`/
|
811
922
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
812
923
|
# `branch`/documents/`document``. If the caller does not have permission to
|
813
|
-
# access the Document, regardless of whether or not it exists, a
|
814
|
-
# PERMISSION_DENIED error is returned. If the requested Document does not exist,
|
815
|
-
# a NOT_FOUND error is returned.
|
924
|
+
# access the Document, regardless of whether or not it exists, a `
|
925
|
+
# PERMISSION_DENIED` error is returned. If the requested Document does not exist,
|
926
|
+
# a `NOT_FOUND` error is returned.
|
816
927
|
# @param [String] fields
|
817
928
|
# Selector specifying which fields to include in a partial response.
|
818
929
|
# @param [String] quota_user
|
@@ -883,18 +994,18 @@ module Google
|
|
883
994
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
884
995
|
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
885
996
|
# default branch. If the caller does not have permission to list Documentss
|
886
|
-
# under this branch, regardless of whether or not this branch exists, a
|
887
|
-
# PERMISSION_DENIED error is returned.
|
997
|
+
# under this branch, regardless of whether or not this branch exists, a `
|
998
|
+
# PERMISSION_DENIED` error is returned.
|
888
999
|
# @param [Fixnum] page_size
|
889
1000
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
890
1001
|
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
891
|
-
# this field is negative, an INVALID_ARGUMENT error is returned.
|
1002
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
892
1003
|
# @param [String] page_token
|
893
1004
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
894
1005
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
895
1006
|
# page. When paginating, all other parameters provided to DocumentService.
|
896
|
-
# ListDocuments must match the call that provided the page token. Otherwise, an
|
897
|
-
# INVALID_ARGUMENT error is returned.
|
1007
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
1008
|
+
# INVALID_ARGUMENT` error is returned.
|
898
1009
|
# @param [String] fields
|
899
1010
|
# Selector specifying which fields to include in a partial response.
|
900
1011
|
# @param [String] quota_user
|
@@ -963,6 +1074,46 @@ module Google
|
|
963
1074
|
execute_or_queue_command(command, &block)
|
964
1075
|
end
|
965
1076
|
|
1077
|
+
# Permanently deletes all selected Documents under a branch. This process is
|
1078
|
+
# asynchronous. If the request is valid, the removal will be enquired and
|
1079
|
+
# processed offlines. Depending on the number of Documents, this operation could
|
1080
|
+
# take hours to complete. Before the operation completes, some Documents may
|
1081
|
+
# still be returned by DocumentService.GetDocument or DocumentService.
|
1082
|
+
# ListDocuments. To get a sample of Documents that would be deleted, set
|
1083
|
+
# PurgeDocumentsRequest.force to false.
|
1084
|
+
# @param [String] parent
|
1085
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
1086
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
1087
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest] google_cloud_discoveryengine_v1alpha_purge_documents_request_object
|
1088
|
+
# @param [String] fields
|
1089
|
+
# Selector specifying which fields to include in a partial response.
|
1090
|
+
# @param [String] quota_user
|
1091
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1092
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1093
|
+
# @param [Google::Apis::RequestOptions] options
|
1094
|
+
# Request-specific options
|
1095
|
+
#
|
1096
|
+
# @yield [result, err] Result & error if block supplied
|
1097
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
1098
|
+
# @yieldparam err [StandardError] error object if request failed
|
1099
|
+
#
|
1100
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
1101
|
+
#
|
1102
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1103
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1104
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1105
|
+
def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1alpha_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1106
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/documents:purge', options)
|
1107
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest::Representation
|
1108
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_purge_documents_request_object
|
1109
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
1110
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
1111
|
+
command.params['parent'] = parent unless parent.nil?
|
1112
|
+
command.query['fields'] = fields unless fields.nil?
|
1113
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1114
|
+
execute_or_queue_command(command, &block)
|
1115
|
+
end
|
1116
|
+
|
966
1117
|
# Gets the latest state of a long-running operation. Clients can use this method
|
967
1118
|
# to poll the operation result at intervals as recommended by the API service.
|
968
1119
|
# @param [String] name
|
@@ -1178,8 +1329,8 @@ module Google
|
|
1178
1329
|
|
1179
1330
|
# Makes a recommendation, which requires a contextual user event.
|
1180
1331
|
# @param [String] serving_config
|
1181
|
-
# Required. Full resource name of the format: projects/*/locations/global/
|
1182
|
-
# collections/*/dataStores/*/servingConfigs
|
1332
|
+
# Required. Full resource name of the format: `projects/*/locations/global/
|
1333
|
+
# collections/*/dataStores/*/servingConfigs/*` Before you can request
|
1183
1334
|
# recommendations from your model, you must create at least one serving config
|
1184
1335
|
# for it.
|
1185
1336
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
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.10.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: 2023-04-
|
11
|
+
date: 2023-04-30 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.10.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: []
|