google-apis-discoveryengine_v1 0.9.0 → 0.11.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 188808d41975ddebc459a16bc5224d5081fba2a65ad91aa3f936a2ec3f6d6836
4
- data.tar.gz: d861513637bc807aceca83f59a4b4adef1dede835ab62d6d30bd9c30bcea767f
3
+ metadata.gz: 2ccd5e7861ae2d160999db2244bc89b0f19e8cf7aa8c41d64396fcce7e4766d5
4
+ data.tar.gz: 03f6cb8d68982f735bdea556cb6a0f2d2fa3195886d2b25bc2be2954204b58cc
5
5
  SHA512:
6
- metadata.gz: 24793c8ca748ea598a4a748cdbcfa09ce7138e76234abe864ba44d32bba3961daa57fd581173bcbe6695817fe981fc484d59411bec3b036c43da493f667c1b11
7
- data.tar.gz: e8fe00c3fb47fcb83f85a680ee448f195253fcc39de821278826d6532c1f1c2fbe46d926df124fa42f47f61f27aff233a615ca7c67c113dbad469648dbe715b5
6
+ metadata.gz: 6c7924af065a978f4ba1103386bb93a64a7d6e9cc847051dcddd13421bff8d01a425b32e38a80adc1ced6af3a9ecaf506659d7e04f0ca5e7d79db76a3eb53fe7
7
+ data.tar.gz: 972db79644c577ae547f705b4ed61efa5ee645c85ee25d4c572628fbc2e457996f41f88f36809aaedde1842f6136f046a0127bdf22da102da18adb0f634d892d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-discoveryengine_v1
2
2
 
3
+ ### v0.11.0 (2024-08-11)
4
+
5
+ * Regenerated from discovery document revision 20240801
6
+
7
+ ### v0.10.0 (2024-08-04)
8
+
9
+ * Regenerated from discovery document revision 20240729
10
+ * Regenerated using generator version 0.15.1
11
+
3
12
  ### v0.9.0 (2024-07-25)
4
13
 
5
14
  * 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
- # Relevance score.
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
- # Relevance score.
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
@@ -3403,6 +3449,12 @@ module Google
3403
3449
  # @return [String]
3404
3450
  attr_accessor :id
3405
3451
 
3452
+ # Output only. Whether the referenced Document can be found in the data store.
3453
+ # Corresponds to the JSON property `joined`
3454
+ # @return [Boolean]
3455
+ attr_accessor :joined
3456
+ alias_method :joined?, :joined
3457
+
3406
3458
  # The Document resource full name, of the form: `projects/`project_id`/locations/
3407
3459
  # `location`/collections/`collection_id`/dataStores/`data_store_id`/branches/`
3408
3460
  # branch_id`/documents/`document_id``
@@ -3436,6 +3488,7 @@ module Google
3436
3488
  # Update properties of this object
3437
3489
  def update!(**args)
3438
3490
  @id = args[:id] if args.key?(:id)
3491
+ @joined = args[:joined] if args.key?(:joined)
3439
3492
  @name = args[:name] if args.key?(:name)
3440
3493
  @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
3441
3494
  @quantity = args[:quantity] if args.key?(:quantity)
@@ -3471,7 +3524,9 @@ module Google
3471
3524
  # Override parsing config for HTML files, only digital parsing and layout
3472
3525
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
3473
3526
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
3474
- # config for PPTX files, only digital parsing and layout parsing are supported.
3527
+ # config for PPTX files, only digital parsing and layout parsing are supported. *
3528
+ # `xlsx`: Override parsing config for XLSX files, only digital parsing and
3529
+ # layout parsing are supported.
3475
3530
  # Corresponds to the JSON property `parsingConfigOverrides`
3476
3531
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig>]
3477
3532
  attr_accessor :parsing_config_overrides
@@ -4007,6 +4062,14 @@ module Google
4007
4062
  # @return [String]
4008
4063
  attr_accessor :gcs_staging_dir
4009
4064
 
4065
+ # The FHIR resource types to import. The resource types should be a subset of
4066
+ # all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-
4067
+ # builder/docs/fhir-schema-reference#resource-level-specification). Default to
4068
+ # all supported FHIR resource types if empty.
4069
+ # Corresponds to the JSON property `resourceTypes`
4070
+ # @return [Array<String>]
4071
+ attr_accessor :resource_types
4072
+
4010
4073
  def initialize(**args)
4011
4074
  update!(**args)
4012
4075
  end
@@ -4015,6 +4078,7 @@ module Google
4015
4078
  def update!(**args)
4016
4079
  @fhir_store = args[:fhir_store] if args.key?(:fhir_store)
4017
4080
  @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
4081
+ @resource_types = args[:resource_types] if args.key?(:resource_types)
4018
4082
  end
4019
4083
  end
4020
4084
 
@@ -5343,6 +5407,11 @@ module Google
5343
5407
  class GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
5344
5408
  include Google::Apis::Core::Hashable
5345
5409
 
5410
+ # Configuration of destination for Purge related errors.
5411
+ # Corresponds to the JSON property `errorConfig`
5412
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeErrorConfig]
5413
+ attr_accessor :error_config
5414
+
5346
5415
  # Required. Filter matching documents to purge. Only currently supported value
5347
5416
  # is `*` (all items).
5348
5417
  # Corresponds to the JSON property `filter`
@@ -5356,14 +5425,50 @@ module Google
5356
5425
  attr_accessor :force
5357
5426
  alias_method :force?, :force
5358
5427
 
5428
+ # Cloud Storage location for input content.
5429
+ # Corresponds to the JSON property `gcsSource`
5430
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
5431
+ attr_accessor :gcs_source
5432
+
5433
+ # The inline source for the input config for DocumentService.PurgeDocuments
5434
+ # method.
5435
+ # Corresponds to the JSON property `inlineSource`
5436
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource]
5437
+ attr_accessor :inline_source
5438
+
5359
5439
  def initialize(**args)
5360
5440
  update!(**args)
5361
5441
  end
5362
5442
 
5363
5443
  # Update properties of this object
5364
5444
  def update!(**args)
5445
+ @error_config = args[:error_config] if args.key?(:error_config)
5365
5446
  @filter = args[:filter] if args.key?(:filter)
5366
5447
  @force = args[:force] if args.key?(:force)
5448
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
5449
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
5450
+ end
5451
+ end
5452
+
5453
+ # The inline source for the input config for DocumentService.PurgeDocuments
5454
+ # method.
5455
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource
5456
+ include Google::Apis::Core::Hashable
5457
+
5458
+ # Required. A list of full resource name of documents to purge. In the format `
5459
+ # projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
5460
+ # Recommended max of 100 items.
5461
+ # Corresponds to the JSON property `documents`
5462
+ # @return [Array<String>]
5463
+ attr_accessor :documents
5464
+
5465
+ def initialize(**args)
5466
+ update!(**args)
5467
+ end
5468
+
5469
+ # Update properties of this object
5470
+ def update!(**args)
5471
+ @documents = args[:documents] if args.key?(:documents)
5367
5472
  end
5368
5473
  end
5369
5474
 
@@ -5396,6 +5501,27 @@ module Google
5396
5501
  end
5397
5502
  end
5398
5503
 
5504
+ # Configuration of destination for Purge related errors.
5505
+ class GoogleCloudDiscoveryengineV1PurgeErrorConfig
5506
+ include Google::Apis::Core::Hashable
5507
+
5508
+ # Cloud Storage prefix for purge errors. This must be an empty, existing Cloud
5509
+ # Storage directory. Purge errors are written to sharded files in this directory,
5510
+ # one per line, as a JSON-encoded `google.rpc.Status` message.
5511
+ # Corresponds to the JSON property `gcsPrefix`
5512
+ # @return [String]
5513
+ attr_accessor :gcs_prefix
5514
+
5515
+ def initialize(**args)
5516
+ update!(**args)
5517
+ end
5518
+
5519
+ # Update properties of this object
5520
+ def update!(**args)
5521
+ @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
5522
+ end
5523
+ end
5524
+
5399
5525
  # Metadata related to the progress of the PurgeSuggestionDenyListEntries
5400
5526
  # operation. This is returned by the google.longrunning.Operation.metadata field.
5401
5527
  class GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata
@@ -5461,6 +5587,46 @@ module Google
5461
5587
  end
5462
5588
  end
5463
5589
 
5590
+ # Request message for PurgeUserEvents method.
5591
+ class GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
5592
+ include Google::Apis::Core::Hashable
5593
+
5594
+ # Required. The filter string to specify the events to be deleted with a length
5595
+ # limit of 5,000 characters. The eligible fields for filtering are: * `eventType`
5596
+ # : Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu"
5597
+ # format. * `userPseudoId`: Double quoted string. Specifying this will delete
5598
+ # all events associated with a visitor. * `userId`: Double quoted string.
5599
+ # Specifying this will delete all events associated with a user. Examples: *
5600
+ # Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z"
5601
+ # eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `
5602
+ # eventType = "search"` * Deleting all events for a specific visitor: `
5603
+ # userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*`
5604
+ # The filtering fields are assumed to have an implicit AND.
5605
+ # Corresponds to the JSON property `filter`
5606
+ # @return [String]
5607
+ attr_accessor :filter
5608
+
5609
+ # The `force` field is currently not supported. Purge user event requests will
5610
+ # permanently delete all purgeable events. Once the development is complete: If `
5611
+ # force` is set to false, the method will return the expected purge count
5612
+ # without deleting any user events. This field will default to false if not
5613
+ # included in the request.
5614
+ # Corresponds to the JSON property `force`
5615
+ # @return [Boolean]
5616
+ attr_accessor :force
5617
+ alias_method :force?, :force
5618
+
5619
+ def initialize(**args)
5620
+ update!(**args)
5621
+ end
5622
+
5623
+ # Update properties of this object
5624
+ def update!(**args)
5625
+ @filter = args[:filter] if args.key?(:filter)
5626
+ @force = args[:force] if args.key?(:force)
5627
+ end
5628
+ end
5629
+
5464
5630
  # Defines a user inputed query.
5465
5631
  class GoogleCloudDiscoveryengineV1Query
5466
5632
  include Google::Apis::Core::Hashable
@@ -5983,9 +6149,12 @@ module Google
5983
6149
 
5984
6150
  # The order in which documents are returned. Documents can be ordered by a field
5985
6151
  # in an Document object. Leave it unset if ordered by relevance. `order_by`
5986
- # expression is case-sensitive. For more information on ordering for retail
5987
- # search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
5988
- # order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
6152
+ # expression is case-sensitive. For more information on ordering the website
6153
+ # search results, see [Order web search results](https://cloud.google.com/
6154
+ # generative-ai-app-builder/docs/order-web-search-results). For more information
6155
+ # on ordering the healthcare search results, see [Order healthcare search
6156
+ # results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-
6157
+ # results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
5989
6158
  # Corresponds to the JSON property `orderBy`
5990
6159
  # @return [String]
5991
6160
  attr_accessor :order_by
@@ -6391,6 +6560,15 @@ module Google
6391
6560
  attr_accessor :ignore_adversarial_query
6392
6561
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
6393
6562
 
6563
+ # Specifies whether to filter out queries that have low relevance. The default
6564
+ # value is `false`. If this field is set to `false`, all search results are used
6565
+ # regardless of relevance to generate answers. If set to `true`, only queries
6566
+ # with high relevance search results will generate answers.
6567
+ # Corresponds to the JSON property `ignoreLowRelevantContent`
6568
+ # @return [Boolean]
6569
+ attr_accessor :ignore_low_relevant_content
6570
+ alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
6571
+
6394
6572
  # Specifies whether to filter out queries that are not summary-seeking. The
6395
6573
  # default value is `false`. Google employs search-query classification to detect
6396
6574
  # summary-seeking queries. No summary is returned if the search query is
@@ -6461,6 +6639,7 @@ module Google
6461
6639
  # Update properties of this object
6462
6640
  def update!(**args)
6463
6641
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
6642
+ @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
6464
6643
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
6465
6644
  @include_citations = args[:include_citations] if args.key?(:include_citations)
6466
6645
  @language_code = args[:language_code] if args.key?(:language_code)
@@ -8203,6 +8382,11 @@ module Google
8203
8382
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo]
8204
8383
  attr_accessor :chunk_info
8205
8384
 
8385
+ # Structured search information.
8386
+ # Corresponds to the JSON property `structuredDocumentInfo`
8387
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo]
8388
+ attr_accessor :structured_document_info
8389
+
8206
8390
  # Unstructured document information.
8207
8391
  # Corresponds to the JSON property `unstructuredDocumentInfo`
8208
8392
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo]
@@ -8215,6 +8399,7 @@ module Google
8215
8399
  # Update properties of this object
8216
8400
  def update!(**args)
8217
8401
  @chunk_info = args[:chunk_info] if args.key?(:chunk_info)
8402
+ @structured_document_info = args[:structured_document_info] if args.key?(:structured_document_info)
8218
8403
  @unstructured_document_info = args[:unstructured_document_info] if args.key?(:unstructured_document_info)
8219
8404
  end
8220
8405
  end
@@ -8238,7 +8423,10 @@ module Google
8238
8423
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata]
8239
8424
  attr_accessor :document_metadata
8240
8425
 
8241
- # Relevance score.
8426
+ # The relevance of the chunk for a given query. Values range from 0.0 (
8427
+ # completely irrelevant) to 1.0 (completely relevant). This value is for
8428
+ # informational purpose only. It may change for the same query and chunk at any
8429
+ # time due to a model retraining or change in implementation.
8242
8430
  # Corresponds to the JSON property `relevanceScore`
8243
8431
  # @return [Float]
8244
8432
  attr_accessor :relevance_score
@@ -8300,6 +8488,31 @@ module Google
8300
8488
  end
8301
8489
  end
8302
8490
 
8491
+ # Structured search information.
8492
+ class GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo
8493
+ include Google::Apis::Core::Hashable
8494
+
8495
+ # Document resource name.
8496
+ # Corresponds to the JSON property `document`
8497
+ # @return [String]
8498
+ attr_accessor :document
8499
+
8500
+ # Structured search data.
8501
+ # Corresponds to the JSON property `structData`
8502
+ # @return [Hash<String,Object>]
8503
+ attr_accessor :struct_data
8504
+
8505
+ def initialize(**args)
8506
+ update!(**args)
8507
+ end
8508
+
8509
+ # Update properties of this object
8510
+ def update!(**args)
8511
+ @document = args[:document] if args.key?(:document)
8512
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
8513
+ end
8514
+ end
8515
+
8303
8516
  # Unstructured document information.
8304
8517
  class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo
8305
8518
  include Google::Apis::Core::Hashable
@@ -8358,6 +8571,14 @@ module Google
8358
8571
  # @return [String]
8359
8572
  attr_accessor :page_identifier
8360
8573
 
8574
+ # The relevance of the chunk for a given query. Values range from 0.0 (
8575
+ # completely irrelevant) to 1.0 (completely relevant). This value is for
8576
+ # informational purpose only. It may change for the same query and chunk at any
8577
+ # time due to a model retraining or change in implementation.
8578
+ # Corresponds to the JSON property `relevanceScore`
8579
+ # @return [Float]
8580
+ attr_accessor :relevance_score
8581
+
8361
8582
  def initialize(**args)
8362
8583
  update!(**args)
8363
8584
  end
@@ -8366,6 +8587,7 @@ module Google
8366
8587
  def update!(**args)
8367
8588
  @content = args[:content] if args.key?(:content)
8368
8589
  @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
8590
+ @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
8369
8591
  end
8370
8592
  end
8371
8593
 
@@ -8516,7 +8738,10 @@ module Google
8516
8738
  # @return [String]
8517
8739
  attr_accessor :content
8518
8740
 
8519
- # Relevance score.
8741
+ # The relevance of the chunk for a given query. Values range from 0.0 (
8742
+ # completely irrelevant) to 1.0 (completely relevant). This value is for
8743
+ # informational purpose only. It may change for the same query and chunk at any
8744
+ # time due to a model retraining or change in implementation.
8520
8745
  # Corresponds to the JSON property `relevanceScore`
8521
8746
  # @return [Float]
8522
8747
  attr_accessor :relevance_score
@@ -9379,7 +9604,9 @@ module Google
9379
9604
  # Override parsing config for HTML files, only digital parsing and layout
9380
9605
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
9381
9606
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
9382
- # config for PPTX files, only digital parsing and layout parsing are supported.
9607
+ # config for PPTX files, only digital parsing and layout parsing are supported. *
9608
+ # `xlsx`: Override parsing config for XLSX files, only digital parsing and
9609
+ # layout parsing are supported.
9383
9610
  # Corresponds to the JSON property `parsingConfigOverrides`
9384
9611
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig>]
9385
9612
  attr_accessor :parsing_config_overrides
@@ -10046,7 +10273,7 @@ module Google
10046
10273
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec]
10047
10274
  attr_accessor :evaluation_spec
10048
10275
 
10049
- # Immutable. The full resource name of the Evaluation, in the format of `
10276
+ # Identifier. The full resource name of the Evaluation, in the format of `
10050
10277
  # projects/`project`/locations/`location`/evaluations/`evaluation``. This field
10051
10278
  # must be a UTF-8 encoded string with a length limit of 1024 characters.
10052
10279
  # Corresponds to the JSON property `name`
@@ -10126,66 +10353,6 @@ module Google
10126
10353
  end
10127
10354
  end
10128
10355
 
10129
- # Metadata related to the progress of the Export operation. This is returned by
10130
- # the google.longrunning.Operation.metadata field.
10131
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata
10132
- include Google::Apis::Core::Hashable
10133
-
10134
- # Operation create time.
10135
- # Corresponds to the JSON property `createTime`
10136
- # @return [String]
10137
- attr_accessor :create_time
10138
-
10139
- # Operation last update time. If the operation is done, this is also the finish
10140
- # time.
10141
- # Corresponds to the JSON property `updateTime`
10142
- # @return [String]
10143
- attr_accessor :update_time
10144
-
10145
- def initialize(**args)
10146
- update!(**args)
10147
- end
10148
-
10149
- # Update properties of this object
10150
- def update!(**args)
10151
- @create_time = args[:create_time] if args.key?(:create_time)
10152
- @update_time = args[:update_time] if args.key?(:update_time)
10153
- end
10154
- end
10155
-
10156
- # Response of the ExportUserEventsRequest. If the long running operation was
10157
- # successful, then this message is returned by the google.longrunning.Operations.
10158
- # response field.
10159
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
10160
- include Google::Apis::Core::Hashable
10161
-
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
- # The `Status` type defines a logical error model that is suitable for different
10169
- # programming environments, including REST APIs and RPC APIs. It is used by [
10170
- # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10171
- # data: error code, error message, and error details. You can find out more
10172
- # about this error model and how to work with it in the [API Design Guide](https:
10173
- # //cloud.google.com/apis/design/errors).
10174
- # Corresponds to the JSON property `status`
10175
- # @return [Google::Apis::DiscoveryengineV1::GoogleRpcStatus]
10176
- attr_accessor :status
10177
-
10178
- def initialize(**args)
10179
- update!(**args)
10180
- end
10181
-
10182
- # Update properties of this object
10183
- def update!(**args)
10184
- @output_result = args[:output_result] if args.key?(:output_result)
10185
- @status = args[:status] if args.key?(:status)
10186
- end
10187
- end
10188
-
10189
10356
  # Configurations for fields of a schema. For example, configuring a field is
10190
10357
  # indexable, or searchable.
10191
10358
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -10855,51 +11022,6 @@ module Google
10855
11022
  end
10856
11023
  end
10857
11024
 
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
11025
  # Metadata and configurations for a Google Cloud project in the service.
10904
11026
  class GoogleCloudDiscoveryengineV1alphaProject
10905
11027
  include Google::Apis::Core::Hashable
@@ -11627,9 +11749,12 @@ module Google
11627
11749
 
11628
11750
  # The order in which documents are returned. Documents can be ordered by a field
11629
11751
  # in an Document object. Leave it unset if ordered by relevance. `order_by`
11630
- # expression is case-sensitive. For more information on ordering for retail
11631
- # search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
11632
- # order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
11752
+ # expression is case-sensitive. For more information on ordering the website
11753
+ # search results, see [Order web search results](https://cloud.google.com/
11754
+ # generative-ai-app-builder/docs/order-web-search-results). For more information
11755
+ # on ordering the healthcare search results, see [Order healthcare search
11756
+ # results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-
11757
+ # results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
11633
11758
  # Corresponds to the JSON property `orderBy`
11634
11759
  # @return [String]
11635
11760
  attr_accessor :order_by
@@ -12168,6 +12293,15 @@ module Google
12168
12293
  attr_accessor :ignore_adversarial_query
12169
12294
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
12170
12295
 
12296
+ # Specifies whether to filter out queries that have low relevance. The default
12297
+ # value is `false`. If this field is set to `false`, all search results are used
12298
+ # regardless of relevance to generate answers. If set to `true`, only queries
12299
+ # with high relevance search results will generate answers.
12300
+ # Corresponds to the JSON property `ignoreLowRelevantContent`
12301
+ # @return [Boolean]
12302
+ attr_accessor :ignore_low_relevant_content
12303
+ alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
12304
+
12171
12305
  # Specifies whether to filter out queries that are not summary-seeking. The
12172
12306
  # default value is `false`. Google employs search-query classification to detect
12173
12307
  # summary-seeking queries. No summary is returned if the search query is
@@ -12238,6 +12372,7 @@ module Google
12238
12372
  # Update properties of this object
12239
12373
  def update!(**args)
12240
12374
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
12375
+ @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
12241
12376
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
12242
12377
  @include_citations = args[:include_citations] if args.key?(:include_citations)
12243
12378
  @language_code = args[:language_code] if args.key?(:language_code)
@@ -13897,7 +14032,9 @@ module Google
13897
14032
  # Override parsing config for HTML files, only digital parsing and layout
13898
14033
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
13899
14034
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
13900
- # config for PPTX files, only digital parsing and layout parsing are supported.
14035
+ # config for PPTX files, only digital parsing and layout parsing are supported. *
14036
+ # `xlsx`: Override parsing config for XLSX files, only digital parsing and
14037
+ # layout parsing are supported.
13901
14038
  # Corresponds to the JSON property `parsingConfigOverrides`
13902
14039
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig>]
13903
14040
  attr_accessor :parsing_config_overrides
@@ -14364,7 +14501,7 @@ module Google
14364
14501
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec]
14365
14502
  attr_accessor :evaluation_spec
14366
14503
 
14367
- # Immutable. The full resource name of the Evaluation, in the format of `
14504
+ # Identifier. The full resource name of the Evaluation, in the format of `
14368
14505
  # projects/`project`/locations/`location`/evaluations/`evaluation``. This field
14369
14506
  # must be a UTF-8 encoded string with a length limit of 1024 characters.
14370
14507
  # Corresponds to the JSON property `name`
@@ -15350,9 +15487,12 @@ module Google
15350
15487
 
15351
15488
  # The order in which documents are returned. Documents can be ordered by a field
15352
15489
  # in an Document object. Leave it unset if ordered by relevance. `order_by`
15353
- # expression is case-sensitive. For more information on ordering for retail
15354
- # search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
15355
- # order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
15490
+ # expression is case-sensitive. For more information on ordering the website
15491
+ # search results, see [Order web search results](https://cloud.google.com/
15492
+ # generative-ai-app-builder/docs/order-web-search-results). For more information
15493
+ # on ordering the healthcare search results, see [Order healthcare search
15494
+ # results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-
15495
+ # results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
15356
15496
  # Corresponds to the JSON property `orderBy`
15357
15497
  # @return [String]
15358
15498
  attr_accessor :order_by
@@ -15882,6 +16022,15 @@ module Google
15882
16022
  attr_accessor :ignore_adversarial_query
15883
16023
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
15884
16024
 
16025
+ # Specifies whether to filter out queries that have low relevance. The default
16026
+ # value is `false`. If this field is set to `false`, all search results are used
16027
+ # regardless of relevance to generate answers. If set to `true`, only queries
16028
+ # with high relevance search results will generate answers.
16029
+ # Corresponds to the JSON property `ignoreLowRelevantContent`
16030
+ # @return [Boolean]
16031
+ attr_accessor :ignore_low_relevant_content
16032
+ alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
16033
+
15885
16034
  # Specifies whether to filter out queries that are not summary-seeking. The
15886
16035
  # default value is `false`. Google employs search-query classification to detect
15887
16036
  # summary-seeking queries. No summary is returned if the search query is
@@ -15952,6 +16101,7 @@ module Google
15952
16101
  # Update properties of this object
15953
16102
  def update!(**args)
15954
16103
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
16104
+ @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
15955
16105
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
15956
16106
  @include_citations = args[:include_citations] if args.key?(:include_citations)
15957
16107
  @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.9.0"
19
+ GEM_VERSION = "0.11.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.15.0"
22
+ GENERATOR_VERSION = "0.15.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240715"
25
+ REVISION = "20240801"
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
 
@@ -1726,18 +1756,6 @@ module Google
1726
1756
  include Google::Apis::Core::JsonObjectSupport
1727
1757
  end
1728
1758
 
1729
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata
1730
- class Representation < Google::Apis::Core::JsonRepresentation; end
1731
-
1732
- include Google::Apis::Core::JsonObjectSupport
1733
- end
1734
-
1735
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
1736
- class Representation < Google::Apis::Core::JsonRepresentation; end
1737
-
1738
- include Google::Apis::Core::JsonObjectSupport
1739
- end
1740
-
1741
1759
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
1742
1760
  class Representation < Google::Apis::Core::JsonRepresentation; end
1743
1761
 
@@ -1846,18 +1864,6 @@ module Google
1846
1864
  include Google::Apis::Core::JsonObjectSupport
1847
1865
  end
1848
1866
 
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
1867
  class GoogleCloudDiscoveryengineV1alphaProject
1862
1868
  class Representation < Google::Apis::Core::JsonRepresentation; end
1863
1869
 
@@ -3159,6 +3165,8 @@ module Google
3159
3165
  class Representation < Google::Apis::Core::JsonRepresentation
3160
3166
  property :chunk_info, as: 'chunkInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo::Representation
3161
3167
 
3168
+ property :structured_document_info, as: 'structuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo::Representation
3169
+
3162
3170
  property :unstructured_document_info, as: 'unstructuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo::Representation
3163
3171
 
3164
3172
  end
@@ -3186,6 +3194,14 @@ module Google
3186
3194
  end
3187
3195
  end
3188
3196
 
3197
+ class GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo
3198
+ # @private
3199
+ class Representation < Google::Apis::Core::JsonRepresentation
3200
+ property :document, as: 'document'
3201
+ hash :struct_data, as: 'structData'
3202
+ end
3203
+ end
3204
+
3189
3205
  class GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo
3190
3206
  # @private
3191
3207
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3203,6 +3219,7 @@ module Google
3203
3219
  class Representation < Google::Apis::Core::JsonRepresentation
3204
3220
  property :content, as: 'content'
3205
3221
  property :page_identifier, as: 'pageIdentifier'
3222
+ property :relevance_score, as: 'relevanceScore'
3206
3223
  end
3207
3224
  end
3208
3225
 
@@ -3779,6 +3796,7 @@ module Google
3779
3796
  # @private
3780
3797
  class Representation < Google::Apis::Core::JsonRepresentation
3781
3798
  property :id, as: 'id'
3799
+ property :joined, as: 'joined'
3782
3800
  property :name, as: 'name'
3783
3801
  collection :promotion_ids, as: 'promotionIds'
3784
3802
  property :quantity, as: 'quantity'
@@ -3954,6 +3972,7 @@ module Google
3954
3972
  class Representation < Google::Apis::Core::JsonRepresentation
3955
3973
  property :fhir_store, as: 'fhirStore'
3956
3974
  property :gcs_staging_dir, as: 'gcsStagingDir'
3975
+ collection :resource_types, as: 'resourceTypes'
3957
3976
  end
3958
3977
  end
3959
3978
 
@@ -4355,8 +4374,21 @@ module Google
4355
4374
  class GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
4356
4375
  # @private
4357
4376
  class Representation < Google::Apis::Core::JsonRepresentation
4377
+ property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeErrorConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeErrorConfig::Representation
4378
+
4358
4379
  property :filter, as: 'filter'
4359
4380
  property :force, as: 'force'
4381
+ property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource::Representation
4382
+
4383
+ property :inline_source, as: 'inlineSource', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource::Representation
4384
+
4385
+ end
4386
+ end
4387
+
4388
+ class GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource
4389
+ # @private
4390
+ class Representation < Google::Apis::Core::JsonRepresentation
4391
+ collection :documents, as: 'documents'
4360
4392
  end
4361
4393
  end
4362
4394
 
@@ -4368,6 +4400,13 @@ module Google
4368
4400
  end
4369
4401
  end
4370
4402
 
4403
+ class GoogleCloudDiscoveryengineV1PurgeErrorConfig
4404
+ # @private
4405
+ class Representation < Google::Apis::Core::JsonRepresentation
4406
+ property :gcs_prefix, as: 'gcsPrefix'
4407
+ end
4408
+ end
4409
+
4371
4410
  class GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata
4372
4411
  # @private
4373
4412
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4391,6 +4430,14 @@ module Google
4391
4430
  end
4392
4431
  end
4393
4432
 
4433
+ class GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
4434
+ # @private
4435
+ class Representation < Google::Apis::Core::JsonRepresentation
4436
+ property :filter, as: 'filter'
4437
+ property :force, as: 'force'
4438
+ end
4439
+ end
4440
+
4394
4441
  class GoogleCloudDiscoveryengineV1Query
4395
4442
  # @private
4396
4443
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4600,6 +4647,7 @@ module Google
4600
4647
  # @private
4601
4648
  class Representation < Google::Apis::Core::JsonRepresentation
4602
4649
  property :ignore_adversarial_query, as: 'ignoreAdversarialQuery'
4650
+ property :ignore_low_relevant_content, as: 'ignoreLowRelevantContent'
4603
4651
  property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
4604
4652
  property :include_citations, as: 'includeCitations'
4605
4653
  property :language_code, as: 'languageCode'
@@ -5075,6 +5123,8 @@ module Google
5075
5123
  class Representation < Google::Apis::Core::JsonRepresentation
5076
5124
  property :chunk_info, as: 'chunkInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo::Representation
5077
5125
 
5126
+ property :structured_document_info, as: 'structuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo::Representation
5127
+
5078
5128
  property :unstructured_document_info, as: 'unstructuredDocumentInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo::Representation
5079
5129
 
5080
5130
  end
@@ -5102,6 +5152,14 @@ module Google
5102
5152
  end
5103
5153
  end
5104
5154
 
5155
+ class GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo
5156
+ # @private
5157
+ class Representation < Google::Apis::Core::JsonRepresentation
5158
+ property :document, as: 'document'
5159
+ hash :struct_data, as: 'structData'
5160
+ end
5161
+ end
5162
+
5105
5163
  class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo
5106
5164
  # @private
5107
5165
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5119,6 +5177,7 @@ module Google
5119
5177
  class Representation < Google::Apis::Core::JsonRepresentation
5120
5178
  property :content, as: 'content'
5121
5179
  property :page_identifier, as: 'pageIdentifier'
5180
+ property :relevance_score, as: 'relevanceScore'
5122
5181
  end
5123
5182
  end
5124
5183
 
@@ -5637,24 +5696,6 @@ module Google
5637
5696
  end
5638
5697
  end
5639
5698
 
5640
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata
5641
- # @private
5642
- class Representation < Google::Apis::Core::JsonRepresentation
5643
- property :create_time, as: 'createTime'
5644
- property :update_time, as: 'updateTime'
5645
- end
5646
- end
5647
-
5648
- class GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse
5649
- # @private
5650
- 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
- property :status, as: 'status', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
5654
-
5655
- end
5656
- end
5657
-
5658
5699
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
5659
5700
  # @private
5660
5701
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5832,22 +5873,6 @@ module Google
5832
5873
  end
5833
5874
  end
5834
5875
 
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
5876
  class GoogleCloudDiscoveryengineV1alphaProject
5852
5877
  # @private
5853
5878
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6164,6 +6189,7 @@ module Google
6164
6189
  # @private
6165
6190
  class Representation < Google::Apis::Core::JsonRepresentation
6166
6191
  property :ignore_adversarial_query, as: 'ignoreAdversarialQuery'
6192
+ property :ignore_low_relevant_content, as: 'ignoreLowRelevantContent'
6167
6193
  property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
6168
6194
  property :include_citations, as: 'includeCitations'
6169
6195
  property :language_code, as: 'languageCode'
@@ -7167,6 +7193,7 @@ module Google
7167
7193
  # @private
7168
7194
  class Representation < Google::Apis::Core::JsonRepresentation
7169
7195
  property :ignore_adversarial_query, as: 'ignoreAdversarialQuery'
7196
+ property :ignore_low_relevant_content, as: 'ignoreLowRelevantContent'
7170
7197
  property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
7171
7198
  property :include_citations, as: 'includeCitations'
7172
7199
  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.9.0
4
+ version: 0.11.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-07-25 00:00:00.000000000 Z
11
+ date: 2024-08-11 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.9.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.11.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: []