google-apis-discoveryengine_v1 0.9.0 → 0.10.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +248 -67
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1/representations.rb +83 -30
- data/lib/google/apis/discoveryengine_v1/service.rb +92 -2
- 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: 1861b8ceb2fc3bbef20c94dfa880d117634736ba3db00f4402ab5a9ca2acd689
|
4
|
+
data.tar.gz: e545831cdddfa27c2def75c6428ba49113f235fea41fe48b7801ede6dbf04f73
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5dd35d46c5eb6cf62d379928326fe3e44434866b5ab6128d306e1eb8e82a54941519e11c10b6eadcab6b64d6b38df2d8b06f8926c4bb9b13b4c2919f1c1c0edb
|
7
|
+
data.tar.gz: 43f5cb184e5171a86f19545d1d76268cfd81bb5d992588b107c3b5bdb9c7ba16ecc8e951fc47d5b4e89ec66ffe5761f5328bbc58ef830588122ea0cf97d8339f
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,10 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1
|
2
2
|
|
3
|
+
### v0.10.0 (2024-08-04)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20240729
|
6
|
+
* Regenerated using generator version 0.15.1
|
7
|
+
|
3
8
|
### v0.9.0 (2024-07-25)
|
4
9
|
|
5
10
|
* Regenerated from discovery document revision 20240715
|
@@ -1161,6 +1161,11 @@ module Google
|
|
1161
1161
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo]
|
1162
1162
|
attr_accessor :chunk_info
|
1163
1163
|
|
1164
|
+
# Structured search information.
|
1165
|
+
# Corresponds to the JSON property `structuredDocumentInfo`
|
1166
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo]
|
1167
|
+
attr_accessor :structured_document_info
|
1168
|
+
|
1164
1169
|
# Unstructured document information.
|
1165
1170
|
# Corresponds to the JSON property `unstructuredDocumentInfo`
|
1166
1171
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo]
|
@@ -1173,6 +1178,7 @@ module Google
|
|
1173
1178
|
# Update properties of this object
|
1174
1179
|
def update!(**args)
|
1175
1180
|
@chunk_info = args[:chunk_info] if args.key?(:chunk_info)
|
1181
|
+
@structured_document_info = args[:structured_document_info] if args.key?(:structured_document_info)
|
1176
1182
|
@unstructured_document_info = args[:unstructured_document_info] if args.key?(:unstructured_document_info)
|
1177
1183
|
end
|
1178
1184
|
end
|
@@ -1196,7 +1202,10 @@ module Google
|
|
1196
1202
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata]
|
1197
1203
|
attr_accessor :document_metadata
|
1198
1204
|
|
1199
|
-
#
|
1205
|
+
# The relevance of the chunk for a given query. Values range from 0.0 (
|
1206
|
+
# completely irrelevant) to 1.0 (completely relevant). This value is for
|
1207
|
+
# informational purpose only. It may change for the same query and chunk at any
|
1208
|
+
# time due to a model retraining or change in implementation.
|
1200
1209
|
# Corresponds to the JSON property `relevanceScore`
|
1201
1210
|
# @return [Float]
|
1202
1211
|
attr_accessor :relevance_score
|
@@ -1258,6 +1267,31 @@ module Google
|
|
1258
1267
|
end
|
1259
1268
|
end
|
1260
1269
|
|
1270
|
+
# Structured search information.
|
1271
|
+
class GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo
|
1272
|
+
include Google::Apis::Core::Hashable
|
1273
|
+
|
1274
|
+
# Document resource name.
|
1275
|
+
# Corresponds to the JSON property `document`
|
1276
|
+
# @return [String]
|
1277
|
+
attr_accessor :document
|
1278
|
+
|
1279
|
+
# Structured search data.
|
1280
|
+
# Corresponds to the JSON property `structData`
|
1281
|
+
# @return [Hash<String,Object>]
|
1282
|
+
attr_accessor :struct_data
|
1283
|
+
|
1284
|
+
def initialize(**args)
|
1285
|
+
update!(**args)
|
1286
|
+
end
|
1287
|
+
|
1288
|
+
# Update properties of this object
|
1289
|
+
def update!(**args)
|
1290
|
+
@document = args[:document] if args.key?(:document)
|
1291
|
+
@struct_data = args[:struct_data] if args.key?(:struct_data)
|
1292
|
+
end
|
1293
|
+
end
|
1294
|
+
|
1261
1295
|
# Unstructured document information.
|
1262
1296
|
class GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo
|
1263
1297
|
include Google::Apis::Core::Hashable
|
@@ -1316,6 +1350,14 @@ module Google
|
|
1316
1350
|
# @return [String]
|
1317
1351
|
attr_accessor :page_identifier
|
1318
1352
|
|
1353
|
+
# The relevance of the chunk for a given query. Values range from 0.0 (
|
1354
|
+
# completely irrelevant) to 1.0 (completely relevant). This value is for
|
1355
|
+
# informational purpose only. It may change for the same query and chunk at any
|
1356
|
+
# time due to a model retraining or change in implementation.
|
1357
|
+
# Corresponds to the JSON property `relevanceScore`
|
1358
|
+
# @return [Float]
|
1359
|
+
attr_accessor :relevance_score
|
1360
|
+
|
1319
1361
|
def initialize(**args)
|
1320
1362
|
update!(**args)
|
1321
1363
|
end
|
@@ -1324,6 +1366,7 @@ module Google
|
|
1324
1366
|
def update!(**args)
|
1325
1367
|
@content = args[:content] if args.key?(:content)
|
1326
1368
|
@page_identifier = args[:page_identifier] if args.key?(:page_identifier)
|
1369
|
+
@relevance_score = args[:relevance_score] if args.key?(:relevance_score)
|
1327
1370
|
end
|
1328
1371
|
end
|
1329
1372
|
|
@@ -1474,7 +1517,10 @@ module Google
|
|
1474
1517
|
# @return [String]
|
1475
1518
|
attr_accessor :content
|
1476
1519
|
|
1477
|
-
#
|
1520
|
+
# The relevance of the chunk for a given query. Values range from 0.0 (
|
1521
|
+
# completely irrelevant) to 1.0 (completely relevant). This value is for
|
1522
|
+
# informational purpose only. It may change for the same query and chunk at any
|
1523
|
+
# time due to a model retraining or change in implementation.
|
1478
1524
|
# Corresponds to the JSON property `relevanceScore`
|
1479
1525
|
# @return [Float]
|
1480
1526
|
attr_accessor :relevance_score
|
@@ -5343,6 +5389,11 @@ module Google
|
|
5343
5389
|
class GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
|
5344
5390
|
include Google::Apis::Core::Hashable
|
5345
5391
|
|
5392
|
+
# Configuration of destination for Purge related errors.
|
5393
|
+
# Corresponds to the JSON property `errorConfig`
|
5394
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeErrorConfig]
|
5395
|
+
attr_accessor :error_config
|
5396
|
+
|
5346
5397
|
# Required. Filter matching documents to purge. Only currently supported value
|
5347
5398
|
# is `*` (all items).
|
5348
5399
|
# Corresponds to the JSON property `filter`
|
@@ -5356,14 +5407,50 @@ module Google
|
|
5356
5407
|
attr_accessor :force
|
5357
5408
|
alias_method :force?, :force
|
5358
5409
|
|
5410
|
+
# Cloud Storage location for input content.
|
5411
|
+
# Corresponds to the JSON property `gcsSource`
|
5412
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
|
5413
|
+
attr_accessor :gcs_source
|
5414
|
+
|
5415
|
+
# The inline source for the input config for DocumentService.PurgeDocuments
|
5416
|
+
# method.
|
5417
|
+
# Corresponds to the JSON property `inlineSource`
|
5418
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource]
|
5419
|
+
attr_accessor :inline_source
|
5420
|
+
|
5359
5421
|
def initialize(**args)
|
5360
5422
|
update!(**args)
|
5361
5423
|
end
|
5362
5424
|
|
5363
5425
|
# Update properties of this object
|
5364
5426
|
def update!(**args)
|
5427
|
+
@error_config = args[:error_config] if args.key?(:error_config)
|
5365
5428
|
@filter = args[:filter] if args.key?(:filter)
|
5366
5429
|
@force = args[:force] if args.key?(:force)
|
5430
|
+
@gcs_source = args[:gcs_source] if args.key?(:gcs_source)
|
5431
|
+
@inline_source = args[:inline_source] if args.key?(:inline_source)
|
5432
|
+
end
|
5433
|
+
end
|
5434
|
+
|
5435
|
+
# The inline source for the input config for DocumentService.PurgeDocuments
|
5436
|
+
# method.
|
5437
|
+
class GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource
|
5438
|
+
include Google::Apis::Core::Hashable
|
5439
|
+
|
5440
|
+
# Required. A list of full resource name of documents to purge. In the format `
|
5441
|
+
# projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
|
5442
|
+
# Recommended max of 100 items.
|
5443
|
+
# Corresponds to the JSON property `documents`
|
5444
|
+
# @return [Array<String>]
|
5445
|
+
attr_accessor :documents
|
5446
|
+
|
5447
|
+
def initialize(**args)
|
5448
|
+
update!(**args)
|
5449
|
+
end
|
5450
|
+
|
5451
|
+
# Update properties of this object
|
5452
|
+
def update!(**args)
|
5453
|
+
@documents = args[:documents] if args.key?(:documents)
|
5367
5454
|
end
|
5368
5455
|
end
|
5369
5456
|
|
@@ -5396,6 +5483,27 @@ module Google
|
|
5396
5483
|
end
|
5397
5484
|
end
|
5398
5485
|
|
5486
|
+
# Configuration of destination for Purge related errors.
|
5487
|
+
class GoogleCloudDiscoveryengineV1PurgeErrorConfig
|
5488
|
+
include Google::Apis::Core::Hashable
|
5489
|
+
|
5490
|
+
# Cloud Storage prefix for purge errors. This must be an empty, existing Cloud
|
5491
|
+
# Storage directory. Purge errors are written to sharded files in this directory,
|
5492
|
+
# one per line, as a JSON-encoded `google.rpc.Status` message.
|
5493
|
+
# Corresponds to the JSON property `gcsPrefix`
|
5494
|
+
# @return [String]
|
5495
|
+
attr_accessor :gcs_prefix
|
5496
|
+
|
5497
|
+
def initialize(**args)
|
5498
|
+
update!(**args)
|
5499
|
+
end
|
5500
|
+
|
5501
|
+
# Update properties of this object
|
5502
|
+
def update!(**args)
|
5503
|
+
@gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
|
5504
|
+
end
|
5505
|
+
end
|
5506
|
+
|
5399
5507
|
# Metadata related to the progress of the PurgeSuggestionDenyListEntries
|
5400
5508
|
# operation. This is returned by the google.longrunning.Operation.metadata field.
|
5401
5509
|
class GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata
|
@@ -5461,6 +5569,46 @@ module Google
|
|
5461
5569
|
end
|
5462
5570
|
end
|
5463
5571
|
|
5572
|
+
# Request message for PurgeUserEvents method.
|
5573
|
+
class GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
|
5574
|
+
include Google::Apis::Core::Hashable
|
5575
|
+
|
5576
|
+
# Required. The filter string to specify the events to be deleted with a length
|
5577
|
+
# limit of 5,000 characters. The eligible fields for filtering are: * `eventType`
|
5578
|
+
# : Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu"
|
5579
|
+
# format. * `userPseudoId`: Double quoted string. Specifying this will delete
|
5580
|
+
# all events associated with a visitor. * `userId`: Double quoted string.
|
5581
|
+
# Specifying this will delete all events associated with a user. Examples: *
|
5582
|
+
# Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z"
|
5583
|
+
# eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `
|
5584
|
+
# eventType = "search"` * Deleting all events for a specific visitor: `
|
5585
|
+
# userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*`
|
5586
|
+
# The filtering fields are assumed to have an implicit AND.
|
5587
|
+
# Corresponds to the JSON property `filter`
|
5588
|
+
# @return [String]
|
5589
|
+
attr_accessor :filter
|
5590
|
+
|
5591
|
+
# The `force` field is currently not supported. Purge user event requests will
|
5592
|
+
# permanently delete all purgeable events. Once the development is complete: If `
|
5593
|
+
# force` is set to false, the method will return the expected purge count
|
5594
|
+
# without deleting any user events. This field will default to false if not
|
5595
|
+
# included in the request.
|
5596
|
+
# Corresponds to the JSON property `force`
|
5597
|
+
# @return [Boolean]
|
5598
|
+
attr_accessor :force
|
5599
|
+
alias_method :force?, :force
|
5600
|
+
|
5601
|
+
def initialize(**args)
|
5602
|
+
update!(**args)
|
5603
|
+
end
|
5604
|
+
|
5605
|
+
# Update properties of this object
|
5606
|
+
def update!(**args)
|
5607
|
+
@filter = args[:filter] if args.key?(:filter)
|
5608
|
+
@force = args[:force] if args.key?(:force)
|
5609
|
+
end
|
5610
|
+
end
|
5611
|
+
|
5464
5612
|
# Defines a user inputed query.
|
5465
5613
|
class GoogleCloudDiscoveryengineV1Query
|
5466
5614
|
include Google::Apis::Core::Hashable
|
@@ -5983,9 +6131,12 @@ module Google
|
|
5983
6131
|
|
5984
6132
|
# The order in which documents are returned. Documents can be ordered by a field
|
5985
6133
|
# in an Document object. Leave it unset if ordered by relevance. `order_by`
|
5986
|
-
# expression is case-sensitive. For more information on ordering
|
5987
|
-
# search, see [
|
5988
|
-
# order)
|
6134
|
+
# expression is case-sensitive. For more information on ordering the website
|
6135
|
+
# search results, see [Order web search results](https://cloud.google.com/
|
6136
|
+
# generative-ai-app-builder/docs/order-web-search-results). For more information
|
6137
|
+
# on ordering the healthcare search results, see [Order healthcare search
|
6138
|
+
# results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-
|
6139
|
+
# results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
5989
6140
|
# Corresponds to the JSON property `orderBy`
|
5990
6141
|
# @return [String]
|
5991
6142
|
attr_accessor :order_by
|
@@ -6391,6 +6542,15 @@ module Google
|
|
6391
6542
|
attr_accessor :ignore_adversarial_query
|
6392
6543
|
alias_method :ignore_adversarial_query?, :ignore_adversarial_query
|
6393
6544
|
|
6545
|
+
# Specifies whether to filter out queries that have low relevance. The default
|
6546
|
+
# value is `false`. If this field is set to `false`, all search results are used
|
6547
|
+
# regardless of relevance to generate answers. If set to `true`, only queries
|
6548
|
+
# with high relevance search results will generate answers.
|
6549
|
+
# Corresponds to the JSON property `ignoreLowRelevantContent`
|
6550
|
+
# @return [Boolean]
|
6551
|
+
attr_accessor :ignore_low_relevant_content
|
6552
|
+
alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
|
6553
|
+
|
6394
6554
|
# Specifies whether to filter out queries that are not summary-seeking. The
|
6395
6555
|
# default value is `false`. Google employs search-query classification to detect
|
6396
6556
|
# summary-seeking queries. No summary is returned if the search query is
|
@@ -6461,6 +6621,7 @@ module Google
|
|
6461
6621
|
# Update properties of this object
|
6462
6622
|
def update!(**args)
|
6463
6623
|
@ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
|
6624
|
+
@ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
|
6464
6625
|
@ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
|
6465
6626
|
@include_citations = args[:include_citations] if args.key?(:include_citations)
|
6466
6627
|
@language_code = args[:language_code] if args.key?(:language_code)
|
@@ -8203,6 +8364,11 @@ module Google
|
|
8203
8364
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo]
|
8204
8365
|
attr_accessor :chunk_info
|
8205
8366
|
|
8367
|
+
# Structured search information.
|
8368
|
+
# Corresponds to the JSON property `structuredDocumentInfo`
|
8369
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo]
|
8370
|
+
attr_accessor :structured_document_info
|
8371
|
+
|
8206
8372
|
# Unstructured document information.
|
8207
8373
|
# Corresponds to the JSON property `unstructuredDocumentInfo`
|
8208
8374
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo]
|
@@ -8215,6 +8381,7 @@ module Google
|
|
8215
8381
|
# Update properties of this object
|
8216
8382
|
def update!(**args)
|
8217
8383
|
@chunk_info = args[:chunk_info] if args.key?(:chunk_info)
|
8384
|
+
@structured_document_info = args[:structured_document_info] if args.key?(:structured_document_info)
|
8218
8385
|
@unstructured_document_info = args[:unstructured_document_info] if args.key?(:unstructured_document_info)
|
8219
8386
|
end
|
8220
8387
|
end
|
@@ -8238,7 +8405,10 @@ module Google
|
|
8238
8405
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata]
|
8239
8406
|
attr_accessor :document_metadata
|
8240
8407
|
|
8241
|
-
#
|
8408
|
+
# The relevance of the chunk for a given query. Values range from 0.0 (
|
8409
|
+
# completely irrelevant) to 1.0 (completely relevant). This value is for
|
8410
|
+
# informational purpose only. It may change for the same query and chunk at any
|
8411
|
+
# time due to a model retraining or change in implementation.
|
8242
8412
|
# Corresponds to the JSON property `relevanceScore`
|
8243
8413
|
# @return [Float]
|
8244
8414
|
attr_accessor :relevance_score
|
@@ -8300,6 +8470,31 @@ module Google
|
|
8300
8470
|
end
|
8301
8471
|
end
|
8302
8472
|
|
8473
|
+
# Structured search information.
|
8474
|
+
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo
|
8475
|
+
include Google::Apis::Core::Hashable
|
8476
|
+
|
8477
|
+
# Document resource name.
|
8478
|
+
# Corresponds to the JSON property `document`
|
8479
|
+
# @return [String]
|
8480
|
+
attr_accessor :document
|
8481
|
+
|
8482
|
+
# Structured search data.
|
8483
|
+
# Corresponds to the JSON property `structData`
|
8484
|
+
# @return [Hash<String,Object>]
|
8485
|
+
attr_accessor :struct_data
|
8486
|
+
|
8487
|
+
def initialize(**args)
|
8488
|
+
update!(**args)
|
8489
|
+
end
|
8490
|
+
|
8491
|
+
# Update properties of this object
|
8492
|
+
def update!(**args)
|
8493
|
+
@document = args[:document] if args.key?(:document)
|
8494
|
+
@struct_data = args[:struct_data] if args.key?(:struct_data)
|
8495
|
+
end
|
8496
|
+
end
|
8497
|
+
|
8303
8498
|
# Unstructured document information.
|
8304
8499
|
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo
|
8305
8500
|
include Google::Apis::Core::Hashable
|
@@ -8358,6 +8553,14 @@ module Google
|
|
8358
8553
|
# @return [String]
|
8359
8554
|
attr_accessor :page_identifier
|
8360
8555
|
|
8556
|
+
# The relevance of the chunk for a given query. Values range from 0.0 (
|
8557
|
+
# completely irrelevant) to 1.0 (completely relevant). This value is for
|
8558
|
+
# informational purpose only. It may change for the same query and chunk at any
|
8559
|
+
# time due to a model retraining or change in implementation.
|
8560
|
+
# Corresponds to the JSON property `relevanceScore`
|
8561
|
+
# @return [Float]
|
8562
|
+
attr_accessor :relevance_score
|
8563
|
+
|
8361
8564
|
def initialize(**args)
|
8362
8565
|
update!(**args)
|
8363
8566
|
end
|
@@ -8366,6 +8569,7 @@ module Google
|
|
8366
8569
|
def update!(**args)
|
8367
8570
|
@content = args[:content] if args.key?(:content)
|
8368
8571
|
@page_identifier = args[:page_identifier] if args.key?(:page_identifier)
|
8572
|
+
@relevance_score = args[:relevance_score] if args.key?(:relevance_score)
|
8369
8573
|
end
|
8370
8574
|
end
|
8371
8575
|
|
@@ -8516,7 +8720,10 @@ module Google
|
|
8516
8720
|
# @return [String]
|
8517
8721
|
attr_accessor :content
|
8518
8722
|
|
8519
|
-
#
|
8723
|
+
# The relevance of the chunk for a given query. Values range from 0.0 (
|
8724
|
+
# completely irrelevant) to 1.0 (completely relevant). This value is for
|
8725
|
+
# informational purpose only. It may change for the same query and chunk at any
|
8726
|
+
# time due to a model retraining or change in implementation.
|
8520
8727
|
# Corresponds to the JSON property `relevanceScore`
|
8521
8728
|
# @return [Float]
|
8522
8729
|
attr_accessor :relevance_score
|
@@ -10046,7 +10253,7 @@ module Google
|
|
10046
10253
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec]
|
10047
10254
|
attr_accessor :evaluation_spec
|
10048
10255
|
|
10049
|
-
#
|
10256
|
+
# Identifier. The full resource name of the Evaluation, in the format of `
|
10050
10257
|
# projects/`project`/locations/`location`/evaluations/`evaluation``. This field
|
10051
10258
|
# must be a UTF-8 encoded string with a length limit of 1024 characters.
|
10052
10259
|
# Corresponds to the JSON property `name`
|
@@ -10159,12 +10366,6 @@ module Google
|
|
10159
10366
|
class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
|
10160
10367
|
include Google::Apis::Core::Hashable
|
10161
10368
|
|
10162
|
-
# Output result that stores the information about where the exported data is
|
10163
|
-
# stored.
|
10164
|
-
# Corresponds to the JSON property `outputResult`
|
10165
|
-
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOutputResult]
|
10166
|
-
attr_accessor :output_result
|
10167
|
-
|
10168
10369
|
# The `Status` type defines a logical error model that is suitable for different
|
10169
10370
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
10170
10371
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
@@ -10181,7 +10382,6 @@ module Google
|
|
10181
10382
|
|
10182
10383
|
# Update properties of this object
|
10183
10384
|
def update!(**args)
|
10184
|
-
@output_result = args[:output_result] if args.key?(:output_result)
|
10185
10385
|
@status = args[:status] if args.key?(:status)
|
10186
10386
|
end
|
10187
10387
|
end
|
@@ -10855,51 +11055,6 @@ module Google
|
|
10855
11055
|
end
|
10856
11056
|
end
|
10857
11057
|
|
10858
|
-
# Output result that stores the information about where the exported data is
|
10859
|
-
# stored.
|
10860
|
-
class GoogleCloudDiscoveryengineV1alphaOutputResult
|
10861
|
-
include Google::Apis::Core::Hashable
|
10862
|
-
|
10863
|
-
# A BigQuery output result.
|
10864
|
-
# Corresponds to the JSON property `bigqueryResult`
|
10865
|
-
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult]
|
10866
|
-
attr_accessor :bigquery_result
|
10867
|
-
|
10868
|
-
def initialize(**args)
|
10869
|
-
update!(**args)
|
10870
|
-
end
|
10871
|
-
|
10872
|
-
# Update properties of this object
|
10873
|
-
def update!(**args)
|
10874
|
-
@bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
|
10875
|
-
end
|
10876
|
-
end
|
10877
|
-
|
10878
|
-
# A BigQuery output result.
|
10879
|
-
class GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult
|
10880
|
-
include Google::Apis::Core::Hashable
|
10881
|
-
|
10882
|
-
# The ID of a BigQuery Dataset.
|
10883
|
-
# Corresponds to the JSON property `datasetId`
|
10884
|
-
# @return [String]
|
10885
|
-
attr_accessor :dataset_id
|
10886
|
-
|
10887
|
-
# The ID of a BigQuery Table.
|
10888
|
-
# Corresponds to the JSON property `tableId`
|
10889
|
-
# @return [String]
|
10890
|
-
attr_accessor :table_id
|
10891
|
-
|
10892
|
-
def initialize(**args)
|
10893
|
-
update!(**args)
|
10894
|
-
end
|
10895
|
-
|
10896
|
-
# Update properties of this object
|
10897
|
-
def update!(**args)
|
10898
|
-
@dataset_id = args[:dataset_id] if args.key?(:dataset_id)
|
10899
|
-
@table_id = args[:table_id] if args.key?(:table_id)
|
10900
|
-
end
|
10901
|
-
end
|
10902
|
-
|
10903
11058
|
# Metadata and configurations for a Google Cloud project in the service.
|
10904
11059
|
class GoogleCloudDiscoveryengineV1alphaProject
|
10905
11060
|
include Google::Apis::Core::Hashable
|
@@ -11627,9 +11782,12 @@ module Google
|
|
11627
11782
|
|
11628
11783
|
# The order in which documents are returned. Documents can be ordered by a field
|
11629
11784
|
# in an Document object. Leave it unset if ordered by relevance. `order_by`
|
11630
|
-
# expression is case-sensitive. For more information on ordering
|
11631
|
-
# search, see [
|
11632
|
-
# order)
|
11785
|
+
# expression is case-sensitive. For more information on ordering the website
|
11786
|
+
# search results, see [Order web search results](https://cloud.google.com/
|
11787
|
+
# generative-ai-app-builder/docs/order-web-search-results). For more information
|
11788
|
+
# on ordering the healthcare search results, see [Order healthcare search
|
11789
|
+
# results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-
|
11790
|
+
# results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
11633
11791
|
# Corresponds to the JSON property `orderBy`
|
11634
11792
|
# @return [String]
|
11635
11793
|
attr_accessor :order_by
|
@@ -12168,6 +12326,15 @@ module Google
|
|
12168
12326
|
attr_accessor :ignore_adversarial_query
|
12169
12327
|
alias_method :ignore_adversarial_query?, :ignore_adversarial_query
|
12170
12328
|
|
12329
|
+
# Specifies whether to filter out queries that have low relevance. The default
|
12330
|
+
# value is `false`. If this field is set to `false`, all search results are used
|
12331
|
+
# regardless of relevance to generate answers. If set to `true`, only queries
|
12332
|
+
# with high relevance search results will generate answers.
|
12333
|
+
# Corresponds to the JSON property `ignoreLowRelevantContent`
|
12334
|
+
# @return [Boolean]
|
12335
|
+
attr_accessor :ignore_low_relevant_content
|
12336
|
+
alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
|
12337
|
+
|
12171
12338
|
# Specifies whether to filter out queries that are not summary-seeking. The
|
12172
12339
|
# default value is `false`. Google employs search-query classification to detect
|
12173
12340
|
# summary-seeking queries. No summary is returned if the search query is
|
@@ -12238,6 +12405,7 @@ module Google
|
|
12238
12405
|
# Update properties of this object
|
12239
12406
|
def update!(**args)
|
12240
12407
|
@ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
|
12408
|
+
@ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
|
12241
12409
|
@ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
|
12242
12410
|
@include_citations = args[:include_citations] if args.key?(:include_citations)
|
12243
12411
|
@language_code = args[:language_code] if args.key?(:language_code)
|
@@ -14364,7 +14532,7 @@ module Google
|
|
14364
14532
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec]
|
14365
14533
|
attr_accessor :evaluation_spec
|
14366
14534
|
|
14367
|
-
#
|
14535
|
+
# Identifier. The full resource name of the Evaluation, in the format of `
|
14368
14536
|
# projects/`project`/locations/`location`/evaluations/`evaluation``. This field
|
14369
14537
|
# must be a UTF-8 encoded string with a length limit of 1024 characters.
|
14370
14538
|
# Corresponds to the JSON property `name`
|
@@ -15350,9 +15518,12 @@ module Google
|
|
15350
15518
|
|
15351
15519
|
# The order in which documents are returned. Documents can be ordered by a field
|
15352
15520
|
# in an Document object. Leave it unset if ordered by relevance. `order_by`
|
15353
|
-
# expression is case-sensitive. For more information on ordering
|
15354
|
-
# search, see [
|
15355
|
-
# order)
|
15521
|
+
# expression is case-sensitive. For more information on ordering the website
|
15522
|
+
# search results, see [Order web search results](https://cloud.google.com/
|
15523
|
+
# generative-ai-app-builder/docs/order-web-search-results). For more information
|
15524
|
+
# on ordering the healthcare search results, see [Order healthcare search
|
15525
|
+
# results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-
|
15526
|
+
# results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
15356
15527
|
# Corresponds to the JSON property `orderBy`
|
15357
15528
|
# @return [String]
|
15358
15529
|
attr_accessor :order_by
|
@@ -15882,6 +16053,15 @@ module Google
|
|
15882
16053
|
attr_accessor :ignore_adversarial_query
|
15883
16054
|
alias_method :ignore_adversarial_query?, :ignore_adversarial_query
|
15884
16055
|
|
16056
|
+
# Specifies whether to filter out queries that have low relevance. The default
|
16057
|
+
# value is `false`. If this field is set to `false`, all search results are used
|
16058
|
+
# regardless of relevance to generate answers. If set to `true`, only queries
|
16059
|
+
# with high relevance search results will generate answers.
|
16060
|
+
# Corresponds to the JSON property `ignoreLowRelevantContent`
|
16061
|
+
# @return [Boolean]
|
16062
|
+
attr_accessor :ignore_low_relevant_content
|
16063
|
+
alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
|
16064
|
+
|
15885
16065
|
# Specifies whether to filter out queries that are not summary-seeking. The
|
15886
16066
|
# default value is `false`. Google employs search-query classification to detect
|
15887
16067
|
# summary-seeking queries. No summary is returned if the search query is
|
@@ -15952,6 +16132,7 @@ module Google
|
|
15952
16132
|
# Update properties of this object
|
15953
16133
|
def update!(**args)
|
15954
16134
|
@ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
|
16135
|
+
@ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
|
15955
16136
|
@ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
|
15956
16137
|
@include_citations = args[:include_citations] if args.key?(:include_citations)
|
15957
16138
|
@language_code = args[:language_code] if args.key?(:language_code)
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DiscoveryengineV1
|
18
18
|
# Version of the google-apis-discoveryengine_v1 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
|
-
GENERATOR_VERSION = "0.15.
|
22
|
+
GENERATOR_VERSION = "0.15.1"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20240729"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -232,6 +232,12 @@ module Google
|
|
232
232
|
include Google::Apis::Core::JsonObjectSupport
|
233
233
|
end
|
234
234
|
|
235
|
+
class GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo
|
236
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
237
|
+
|
238
|
+
include Google::Apis::Core::JsonObjectSupport
|
239
|
+
end
|
240
|
+
|
235
241
|
class GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo
|
236
242
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
237
243
|
|
@@ -958,12 +964,24 @@ module Google
|
|
958
964
|
include Google::Apis::Core::JsonObjectSupport
|
959
965
|
end
|
960
966
|
|
967
|
+
class GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource
|
968
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
969
|
+
|
970
|
+
include Google::Apis::Core::JsonObjectSupport
|
971
|
+
end
|
972
|
+
|
961
973
|
class GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
|
962
974
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
963
975
|
|
964
976
|
include Google::Apis::Core::JsonObjectSupport
|
965
977
|
end
|
966
978
|
|
979
|
+
class GoogleCloudDiscoveryengineV1PurgeErrorConfig
|
980
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
981
|
+
|
982
|
+
include Google::Apis::Core::JsonObjectSupport
|
983
|
+
end
|
984
|
+
|
967
985
|
class GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata
|
968
986
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
969
987
|
|
@@ -982,6 +1000,12 @@ module Google
|
|
982
1000
|
include Google::Apis::Core::JsonObjectSupport
|
983
1001
|
end
|
984
1002
|
|
1003
|
+
class GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
|
1004
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1005
|
+
|
1006
|
+
include Google::Apis::Core::JsonObjectSupport
|
1007
|
+
end
|
1008
|
+
|
985
1009
|
class GoogleCloudDiscoveryengineV1Query
|
986
1010
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
987
1011
|
|
@@ -1384,6 +1408,12 @@ module Google
|
|
1384
1408
|
include Google::Apis::Core::JsonObjectSupport
|
1385
1409
|
end
|
1386
1410
|
|
1411
|
+
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo
|
1412
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1413
|
+
|
1414
|
+
include Google::Apis::Core::JsonObjectSupport
|
1415
|
+
end
|
1416
|
+
|
1387
1417
|
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo
|
1388
1418
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1389
1419
|
|
@@ -1846,18 +1876,6 @@ module Google
|
|
1846
1876
|
include Google::Apis::Core::JsonObjectSupport
|
1847
1877
|
end
|
1848
1878
|
|
1849
|
-
class GoogleCloudDiscoveryengineV1alphaOutputResult
|
1850
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1851
|
-
|
1852
|
-
include Google::Apis::Core::JsonObjectSupport
|
1853
|
-
end
|
1854
|
-
|
1855
|
-
class GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult
|
1856
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1857
|
-
|
1858
|
-
include Google::Apis::Core::JsonObjectSupport
|
1859
|
-
end
|
1860
|
-
|
1861
1879
|
class GoogleCloudDiscoveryengineV1alphaProject
|
1862
1880
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1863
1881
|
|
@@ -3159,6 +3177,8 @@ module Google
|
|
3159
3177
|
class Representation < Google::Apis::Core::JsonRepresentation
|
3160
3178
|
property :chunk_info, as: 'chunkInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo::Representation
|
3161
3179
|
|
3180
|
+
property :structured_document_info, as: 'structuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo::Representation
|
3181
|
+
|
3162
3182
|
property :unstructured_document_info, as: 'unstructuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo::Representation
|
3163
3183
|
|
3164
3184
|
end
|
@@ -3186,6 +3206,14 @@ module Google
|
|
3186
3206
|
end
|
3187
3207
|
end
|
3188
3208
|
|
3209
|
+
class GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo
|
3210
|
+
# @private
|
3211
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3212
|
+
property :document, as: 'document'
|
3213
|
+
hash :struct_data, as: 'structData'
|
3214
|
+
end
|
3215
|
+
end
|
3216
|
+
|
3189
3217
|
class GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo
|
3190
3218
|
# @private
|
3191
3219
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -3203,6 +3231,7 @@ module Google
|
|
3203
3231
|
class Representation < Google::Apis::Core::JsonRepresentation
|
3204
3232
|
property :content, as: 'content'
|
3205
3233
|
property :page_identifier, as: 'pageIdentifier'
|
3234
|
+
property :relevance_score, as: 'relevanceScore'
|
3206
3235
|
end
|
3207
3236
|
end
|
3208
3237
|
|
@@ -4355,8 +4384,21 @@ module Google
|
|
4355
4384
|
class GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
|
4356
4385
|
# @private
|
4357
4386
|
class Representation < Google::Apis::Core::JsonRepresentation
|
4387
|
+
property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeErrorConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeErrorConfig::Representation
|
4388
|
+
|
4358
4389
|
property :filter, as: 'filter'
|
4359
4390
|
property :force, as: 'force'
|
4391
|
+
property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource::Representation
|
4392
|
+
|
4393
|
+
property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource::Representation
|
4394
|
+
|
4395
|
+
end
|
4396
|
+
end
|
4397
|
+
|
4398
|
+
class GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource
|
4399
|
+
# @private
|
4400
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4401
|
+
collection :documents, as: 'documents'
|
4360
4402
|
end
|
4361
4403
|
end
|
4362
4404
|
|
@@ -4368,6 +4410,13 @@ module Google
|
|
4368
4410
|
end
|
4369
4411
|
end
|
4370
4412
|
|
4413
|
+
class GoogleCloudDiscoveryengineV1PurgeErrorConfig
|
4414
|
+
# @private
|
4415
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4416
|
+
property :gcs_prefix, as: 'gcsPrefix'
|
4417
|
+
end
|
4418
|
+
end
|
4419
|
+
|
4371
4420
|
class GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata
|
4372
4421
|
# @private
|
4373
4422
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -4391,6 +4440,14 @@ module Google
|
|
4391
4440
|
end
|
4392
4441
|
end
|
4393
4442
|
|
4443
|
+
class GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
|
4444
|
+
# @private
|
4445
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4446
|
+
property :filter, as: 'filter'
|
4447
|
+
property :force, as: 'force'
|
4448
|
+
end
|
4449
|
+
end
|
4450
|
+
|
4394
4451
|
class GoogleCloudDiscoveryengineV1Query
|
4395
4452
|
# @private
|
4396
4453
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -4600,6 +4657,7 @@ module Google
|
|
4600
4657
|
# @private
|
4601
4658
|
class Representation < Google::Apis::Core::JsonRepresentation
|
4602
4659
|
property :ignore_adversarial_query, as: 'ignoreAdversarialQuery'
|
4660
|
+
property :ignore_low_relevant_content, as: 'ignoreLowRelevantContent'
|
4603
4661
|
property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
|
4604
4662
|
property :include_citations, as: 'includeCitations'
|
4605
4663
|
property :language_code, as: 'languageCode'
|
@@ -5075,6 +5133,8 @@ module Google
|
|
5075
5133
|
class Representation < Google::Apis::Core::JsonRepresentation
|
5076
5134
|
property :chunk_info, as: 'chunkInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo::Representation
|
5077
5135
|
|
5136
|
+
property :structured_document_info, as: 'structuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo::Representation
|
5137
|
+
|
5078
5138
|
property :unstructured_document_info, as: 'unstructuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo::Representation
|
5079
5139
|
|
5080
5140
|
end
|
@@ -5102,6 +5162,14 @@ module Google
|
|
5102
5162
|
end
|
5103
5163
|
end
|
5104
5164
|
|
5165
|
+
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo
|
5166
|
+
# @private
|
5167
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
5168
|
+
property :document, as: 'document'
|
5169
|
+
hash :struct_data, as: 'structData'
|
5170
|
+
end
|
5171
|
+
end
|
5172
|
+
|
5105
5173
|
class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo
|
5106
5174
|
# @private
|
5107
5175
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -5119,6 +5187,7 @@ module Google
|
|
5119
5187
|
class Representation < Google::Apis::Core::JsonRepresentation
|
5120
5188
|
property :content, as: 'content'
|
5121
5189
|
property :page_identifier, as: 'pageIdentifier'
|
5190
|
+
property :relevance_score, as: 'relevanceScore'
|
5122
5191
|
end
|
5123
5192
|
end
|
5124
5193
|
|
@@ -5648,8 +5717,6 @@ module Google
|
|
5648
5717
|
class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
|
5649
5718
|
# @private
|
5650
5719
|
class Representation < Google::Apis::Core::JsonRepresentation
|
5651
|
-
property :output_result, as: 'outputResult', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOutputResult, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOutputResult::Representation
|
5652
|
-
|
5653
5720
|
property :status, as: 'status', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
|
5654
5721
|
|
5655
5722
|
end
|
@@ -5832,22 +5899,6 @@ module Google
|
|
5832
5899
|
end
|
5833
5900
|
end
|
5834
5901
|
|
5835
|
-
class GoogleCloudDiscoveryengineV1alphaOutputResult
|
5836
|
-
# @private
|
5837
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
5838
|
-
property :bigquery_result, as: 'bigqueryResult', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult::Representation
|
5839
|
-
|
5840
|
-
end
|
5841
|
-
end
|
5842
|
-
|
5843
|
-
class GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult
|
5844
|
-
# @private
|
5845
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
5846
|
-
property :dataset_id, as: 'datasetId'
|
5847
|
-
property :table_id, as: 'tableId'
|
5848
|
-
end
|
5849
|
-
end
|
5850
|
-
|
5851
5902
|
class GoogleCloudDiscoveryengineV1alphaProject
|
5852
5903
|
# @private
|
5853
5904
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -6164,6 +6215,7 @@ module Google
|
|
6164
6215
|
# @private
|
6165
6216
|
class Representation < Google::Apis::Core::JsonRepresentation
|
6166
6217
|
property :ignore_adversarial_query, as: 'ignoreAdversarialQuery'
|
6218
|
+
property :ignore_low_relevant_content, as: 'ignoreLowRelevantContent'
|
6167
6219
|
property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
|
6168
6220
|
property :include_citations, as: 'includeCitations'
|
6169
6221
|
property :language_code, as: 'languageCode'
|
@@ -7167,6 +7219,7 @@ module Google
|
|
7167
7219
|
# @private
|
7168
7220
|
class Representation < Google::Apis::Core::JsonRepresentation
|
7169
7221
|
property :ignore_adversarial_query, as: 'ignoreAdversarialQuery'
|
7222
|
+
property :ignore_low_relevant_content, as: 'ignoreLowRelevantContent'
|
7170
7223
|
property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
|
7171
7224
|
property :include_citations, as: 'includeCitations'
|
7172
7225
|
property :language_code, as: 'languageCode'
|
@@ -239,6 +239,12 @@ module Google
|
|
239
239
|
# component of the DataStore's resource name. This field must conform to [RFC-
|
240
240
|
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
241
241
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
242
|
+
# @param [Boolean] skip_default_schema_creation
|
243
|
+
# A boolean flag indicating whether to skip the default schema creation for the
|
244
|
+
# data store. Only enable this flag if you are certain that the default schema
|
245
|
+
# is incompatible with your use case. If set to true, you must manually create a
|
246
|
+
# schema for the data store before any documents can be ingested. This flag
|
247
|
+
# cannot be specified if `data_store.starting_schema` is specified.
|
242
248
|
# @param [String] fields
|
243
249
|
# Selector specifying which fields to include in a partial response.
|
244
250
|
# @param [String] quota_user
|
@@ -256,7 +262,7 @@ module Google
|
|
256
262
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
257
263
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
258
264
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
259
|
-
def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
265
|
+
def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
|
260
266
|
command = make_simple_command(:post, 'v1/{+parent}/dataStores', options)
|
261
267
|
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
|
262
268
|
command.request_object = google_cloud_discoveryengine_v1_data_store_object
|
@@ -265,6 +271,7 @@ module Google
|
|
265
271
|
command.params['parent'] = parent unless parent.nil?
|
266
272
|
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
267
273
|
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
274
|
+
command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
|
268
275
|
command.query['fields'] = fields unless fields.nil?
|
269
276
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
270
277
|
execute_or_queue_command(command, &block)
|
@@ -2781,6 +2788,44 @@ module Google
|
|
2781
2788
|
execute_or_queue_command(command, &block)
|
2782
2789
|
end
|
2783
2790
|
|
2791
|
+
# Deletes permanently all user events specified by the filter provided.
|
2792
|
+
# Depending on the number of events specified by the filter, this operation
|
2793
|
+
# could take hours or days to complete. To test a filter, use the list command
|
2794
|
+
# first.
|
2795
|
+
# @param [String] parent
|
2796
|
+
# Required. The resource name of the catalog under which the events are created.
|
2797
|
+
# The format is `projects/$`projectId`/locations/global/collections/`$
|
2798
|
+
# collectionId`/dataStores/$`dataStoreId``
|
2799
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest] google_cloud_discoveryengine_v1_purge_user_events_request_object
|
2800
|
+
# @param [String] fields
|
2801
|
+
# Selector specifying which fields to include in a partial response.
|
2802
|
+
# @param [String] quota_user
|
2803
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2804
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2805
|
+
# @param [Google::Apis::RequestOptions] options
|
2806
|
+
# Request-specific options
|
2807
|
+
#
|
2808
|
+
# @yield [result, err] Result & error if block supplied
|
2809
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
2810
|
+
# @yieldparam err [StandardError] error object if request failed
|
2811
|
+
#
|
2812
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
2813
|
+
#
|
2814
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2815
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2816
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2817
|
+
def purge_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2818
|
+
command = make_simple_command(:post, 'v1/{+parent}/userEvents:purge', options)
|
2819
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest::Representation
|
2820
|
+
command.request_object = google_cloud_discoveryengine_v1_purge_user_events_request_object
|
2821
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
2822
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
2823
|
+
command.params['parent'] = parent unless parent.nil?
|
2824
|
+
command.query['fields'] = fields unless fields.nil?
|
2825
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2826
|
+
execute_or_queue_command(command, &block)
|
2827
|
+
end
|
2828
|
+
|
2784
2829
|
# Writes a single user event.
|
2785
2830
|
# @param [String] parent
|
2786
2831
|
# Required. The parent resource name. If the write user event action is applied
|
@@ -3991,6 +4036,12 @@ module Google
|
|
3991
4036
|
# component of the DataStore's resource name. This field must conform to [RFC-
|
3992
4037
|
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
3993
4038
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
4039
|
+
# @param [Boolean] skip_default_schema_creation
|
4040
|
+
# A boolean flag indicating whether to skip the default schema creation for the
|
4041
|
+
# data store. Only enable this flag if you are certain that the default schema
|
4042
|
+
# is incompatible with your use case. If set to true, you must manually create a
|
4043
|
+
# schema for the data store before any documents can be ingested. This flag
|
4044
|
+
# cannot be specified if `data_store.starting_schema` is specified.
|
3994
4045
|
# @param [String] fields
|
3995
4046
|
# Selector specifying which fields to include in a partial response.
|
3996
4047
|
# @param [String] quota_user
|
@@ -4008,7 +4059,7 @@ module Google
|
|
4008
4059
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4009
4060
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4010
4061
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4011
|
-
def create_project_location_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4062
|
+
def create_project_location_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4012
4063
|
command = make_simple_command(:post, 'v1/{+parent}/dataStores', options)
|
4013
4064
|
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
|
4014
4065
|
command.request_object = google_cloud_discoveryengine_v1_data_store_object
|
@@ -4017,6 +4068,7 @@ module Google
|
|
4017
4068
|
command.params['parent'] = parent unless parent.nil?
|
4018
4069
|
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
4019
4070
|
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
4071
|
+
command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
|
4020
4072
|
command.query['fields'] = fields unless fields.nil?
|
4021
4073
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4022
4074
|
execute_or_queue_command(command, &block)
|
@@ -6239,6 +6291,44 @@ module Google
|
|
6239
6291
|
execute_or_queue_command(command, &block)
|
6240
6292
|
end
|
6241
6293
|
|
6294
|
+
# Deletes permanently all user events specified by the filter provided.
|
6295
|
+
# Depending on the number of events specified by the filter, this operation
|
6296
|
+
# could take hours or days to complete. To test a filter, use the list command
|
6297
|
+
# first.
|
6298
|
+
# @param [String] parent
|
6299
|
+
# Required. The resource name of the catalog under which the events are created.
|
6300
|
+
# The format is `projects/$`projectId`/locations/global/collections/`$
|
6301
|
+
# collectionId`/dataStores/$`dataStoreId``
|
6302
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest] google_cloud_discoveryengine_v1_purge_user_events_request_object
|
6303
|
+
# @param [String] fields
|
6304
|
+
# Selector specifying which fields to include in a partial response.
|
6305
|
+
# @param [String] quota_user
|
6306
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6307
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6308
|
+
# @param [Google::Apis::RequestOptions] options
|
6309
|
+
# Request-specific options
|
6310
|
+
#
|
6311
|
+
# @yield [result, err] Result & error if block supplied
|
6312
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
6313
|
+
# @yieldparam err [StandardError] error object if request failed
|
6314
|
+
#
|
6315
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
6316
|
+
#
|
6317
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6318
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6319
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6320
|
+
def purge_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
6321
|
+
command = make_simple_command(:post, 'v1/{+parent}/userEvents:purge', options)
|
6322
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest::Representation
|
6323
|
+
command.request_object = google_cloud_discoveryengine_v1_purge_user_events_request_object
|
6324
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
6325
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
6326
|
+
command.params['parent'] = parent unless parent.nil?
|
6327
|
+
command.query['fields'] = fields unless fields.nil?
|
6328
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6329
|
+
execute_or_queue_command(command, &block)
|
6330
|
+
end
|
6331
|
+
|
6242
6332
|
# Writes a single user event.
|
6243
6333
|
# @param [String] parent
|
6244
6334
|
# Required. The parent resource name. If the write user event action is applied
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1
|
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: 2024-
|
11
|
+
date: 2024-08-04 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_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.10.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|