@google-cloud/discoveryengine 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/build/protos/protos.d.ts +31 -316
  3. package/build/protos/protos.js +146 -593
  4. package/build/protos/protos.json +25 -1
  5. package/build/src/index.d.ts +1 -1
  6. package/build/src/index.js +1 -21
  7. package/build/src/v1/completion_service_client.d.ts +76 -76
  8. package/build/src/v1/completion_service_client.js +125 -262
  9. package/build/src/v1/control_service_client.d.ts +81 -81
  10. package/build/src/v1/control_service_client.js +96 -132
  11. package/build/src/v1/conversational_search_service_client.d.ts +143 -143
  12. package/build/src/v1/conversational_search_service_client.js +138 -226
  13. package/build/src/v1/data_store_service_client.d.ts +122 -122
  14. package/build/src/v1/data_store_service_client.js +134 -280
  15. package/build/src/v1/document_service_client.d.ts +120 -120
  16. package/build/src/v1/document_service_client.js +143 -300
  17. package/build/src/v1/engine_service_client.d.ts +103 -103
  18. package/build/src/v1/engine_service_client.js +134 -279
  19. package/build/src/v1/grounded_generation_service_client.d.ts +48 -48
  20. package/build/src/v1/grounded_generation_service_client.js +79 -100
  21. package/build/src/v1/project_service_client.d.ts +76 -76
  22. package/build/src/v1/project_service_client.js +108 -222
  23. package/build/src/v1/rank_service_client.d.ts +47 -47
  24. package/build/src/v1/rank_service_client.js +72 -85
  25. package/build/src/v1/recommendation_service_client.d.ts +47 -47
  26. package/build/src/v1/recommendation_service_client.js +70 -82
  27. package/build/src/v1/schema_service_client.d.ts +111 -111
  28. package/build/src/v1/schema_service_client.js +131 -273
  29. package/build/src/v1/search_service_client.d.ts +545 -545
  30. package/build/src/v1/search_service_client.js +90 -113
  31. package/build/src/v1/search_tuning_service_client.d.ts +77 -77
  32. package/build/src/v1/search_tuning_service_client.js +113 -235
  33. package/build/src/v1/serving_config_service_client.d.ts +48 -48
  34. package/build/src/v1/serving_config_service_client.js +69 -80
  35. package/build/src/v1/site_search_engine_service_client.d.ts +148 -148
  36. package/build/src/v1/site_search_engine_service_client.js +179 -378
  37. package/build/src/v1/user_event_service_client.d.ts +77 -77
  38. package/build/src/v1/user_event_service_client.js +121 -253
  39. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  40. package/build/src/v1alpha/acl_config_service_client.js +82 -106
  41. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  42. package/build/src/v1alpha/chunk_service_client.js +92 -120
  43. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  44. package/build/src/v1alpha/completion_service_client.js +134 -280
  45. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  46. package/build/src/v1alpha/control_service_client.js +105 -151
  47. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  48. package/build/src/v1alpha/conversational_search_service_client.js +145 -237
  49. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  50. package/build/src/v1alpha/data_store_service_client.js +151 -316
  51. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  52. package/build/src/v1alpha/document_service_client.js +156 -328
  53. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  54. package/build/src/v1alpha/engine_service_client.js +155 -325
  55. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  56. package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
  57. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  58. package/build/src/v1alpha/evaluation_service_client.js +143 -295
  59. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  60. package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
  61. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  62. package/build/src/v1alpha/project_service_client.js +126 -262
  63. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  64. package/build/src/v1alpha/rank_service_client.js +81 -104
  65. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  66. package/build/src/v1alpha/recommendation_service_client.js +79 -100
  67. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  68. package/build/src/v1alpha/sample_query_service_client.js +144 -301
  69. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  70. package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
  71. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  72. package/build/src/v1alpha/schema_service_client.js +140 -292
  73. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  74. package/build/src/v1alpha/search_service_client.js +88 -112
  75. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  76. package/build/src/v1alpha/search_tuning_service_client.js +122 -253
  77. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  78. package/build/src/v1alpha/serving_config_service_client.js +97 -133
  79. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  80. package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
  81. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  82. package/build/src/v1alpha/user_event_service_client.js +130 -271
  83. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  84. package/build/src/v1beta/completion_service_client.js +136 -279
  85. package/build/src/v1beta/control_service_client.d.ts +84 -84
  86. package/build/src/v1beta/control_service_client.js +103 -147
  87. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  88. package/build/src/v1beta/conversational_search_service_client.js +143 -233
  89. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  90. package/build/src/v1beta/data_store_service_client.js +141 -288
  91. package/build/src/v1beta/document_service_client.d.ts +124 -124
  92. package/build/src/v1beta/document_service_client.js +150 -309
  93. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  94. package/build/src/v1beta/engine_service_client.js +153 -315
  95. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  96. package/build/src/v1beta/evaluation_service_client.js +141 -285
  97. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  98. package/build/src/v1beta/grounded_generation_service_client.js +86 -114
  99. package/build/src/v1beta/project_service_client.d.ts +76 -76
  100. package/build/src/v1beta/project_service_client.js +115 -231
  101. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  102. package/build/src/v1beta/rank_service_client.js +79 -99
  103. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  104. package/build/src/v1beta/recommendation_service_client.js +77 -96
  105. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  106. package/build/src/v1beta/sample_query_service_client.js +142 -291
  107. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  108. package/build/src/v1beta/sample_query_set_service_client.js +104 -149
  109. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  110. package/build/src/v1beta/schema_service_client.js +138 -282
  111. package/build/src/v1beta/search_service_client.d.ts +665 -665
  112. package/build/src/v1beta/search_service_client.js +97 -128
  113. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  114. package/build/src/v1beta/search_tuning_service_client.js +120 -243
  115. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  116. package/build/src/v1beta/serving_config_service_client.js +95 -129
  117. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  118. package/build/src/v1beta/site_search_engine_service_client.js +186 -386
  119. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  120. package/build/src/v1beta/user_event_service_client.js +128 -261
  121. package/package.json +1 -1
@@ -177,7 +177,7 @@ export declare class CompletionServiceClient {
177
177
  */
178
178
  completeQuery(request?: protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest, options?: CallOptions): Promise<[
179
179
  protos.google.cloud.discoveryengine.v1beta.ICompleteQueryResponse,
180
- (protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest | undefined),
180
+ protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest | undefined,
181
181
  {} | undefined
182
182
  ]>;
183
183
  completeQuery(request: protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ICompleteQueryResponse, protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -262,7 +262,7 @@ export declare class CompletionServiceClient {
262
262
  */
263
263
  advancedCompleteQuery(request?: protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest, options?: CallOptions): Promise<[
264
264
  protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryResponse,
265
- (protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest | undefined),
265
+ protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest | undefined,
266
266
  {} | undefined
267
267
  ]>;
268
268
  advancedCompleteQuery(request: protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryResponse, protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -450,86 +450,86 @@ export declare class CompletionServiceClient {
450
450
  */
451
451
  checkPurgeCompletionSuggestionsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsMetadata>>;
452
452
  /**
453
- * Gets information about a location.
454
- *
455
- * @param {Object} request
456
- * The request object that will be sent.
457
- * @param {string} request.name
458
- * Resource name for the location.
459
- * @param {object} [options]
460
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
461
- * @returns {Promise} - The promise which resolves to an array.
462
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
463
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
464
- * for more details and examples.
465
- * @example
466
- * ```
467
- * const [response] = await client.getLocation(request);
468
- * ```
469
- */
453
+ * Gets information about a location.
454
+ *
455
+ * @param {Object} request
456
+ * The request object that will be sent.
457
+ * @param {string} request.name
458
+ * Resource name for the location.
459
+ * @param {object} [options]
460
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
461
+ * @returns {Promise} - The promise which resolves to an array.
462
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
463
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
464
+ * for more details and examples.
465
+ * @example
466
+ * ```
467
+ * const [response] = await client.getLocation(request);
468
+ * ```
469
+ */
470
470
  getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
471
471
  /**
472
- * Lists information about the supported locations for this service. Returns an iterable object.
473
- *
474
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
475
- * @param {Object} request
476
- * The request object that will be sent.
477
- * @param {string} request.name
478
- * The resource that owns the locations collection, if applicable.
479
- * @param {string} request.filter
480
- * The standard list filter.
481
- * @param {number} request.pageSize
482
- * The standard list page size.
483
- * @param {string} request.pageToken
484
- * The standard list page token.
485
- * @param {object} [options]
486
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
487
- * @returns {Object}
488
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
489
- * When you iterate the returned iterable, each element will be an object representing
490
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
491
- * so you can stop the iteration when you don't need more results.
492
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
493
- * for more details and examples.
494
- * @example
495
- * ```
496
- * const iterable = client.listLocationsAsync(request);
497
- * for await (const response of iterable) {
498
- * // process response
499
- * }
500
- * ```
501
- */
472
+ * Lists information about the supported locations for this service. Returns an iterable object.
473
+ *
474
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
475
+ * @param {Object} request
476
+ * The request object that will be sent.
477
+ * @param {string} request.name
478
+ * The resource that owns the locations collection, if applicable.
479
+ * @param {string} request.filter
480
+ * The standard list filter.
481
+ * @param {number} request.pageSize
482
+ * The standard list page size.
483
+ * @param {string} request.pageToken
484
+ * The standard list page token.
485
+ * @param {object} [options]
486
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
487
+ * @returns {Object}
488
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
489
+ * When you iterate the returned iterable, each element will be an object representing
490
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
491
+ * so you can stop the iteration when you don't need more results.
492
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
493
+ * for more details and examples.
494
+ * @example
495
+ * ```
496
+ * const iterable = client.listLocationsAsync(request);
497
+ * for await (const response of iterable) {
498
+ * // process response
499
+ * }
500
+ * ```
501
+ */
502
502
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
503
503
  /**
504
- * Gets the latest state of a long-running operation. Clients can use this
505
- * method to poll the operation result at intervals as recommended by the API
506
- * service.
507
- *
508
- * @param {Object} request - The request object that will be sent.
509
- * @param {string} request.name - The name of the operation resource.
510
- * @param {Object=} options
511
- * Optional parameters. You can override the default settings for this call,
512
- * e.g, timeout, retries, paginations, etc. See {@link
513
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
514
- * for the details.
515
- * @param {function(?Error, ?Object)=} callback
516
- * The function which will be called with the result of the API call.
517
- *
518
- * The second parameter to the callback is an object representing
519
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
520
- * @return {Promise} - The promise which resolves to an array.
521
- * The first element of the array is an object representing
522
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
523
- * The promise has a method named "cancel" which cancels the ongoing API call.
524
- *
525
- * @example
526
- * ```
527
- * const client = longrunning.operationsClient();
528
- * const name = '';
529
- * const [response] = await client.getOperation({name});
530
- * // doThingsWith(response)
531
- * ```
532
- */
504
+ * Gets the latest state of a long-running operation. Clients can use this
505
+ * method to poll the operation result at intervals as recommended by the API
506
+ * service.
507
+ *
508
+ * @param {Object} request - The request object that will be sent.
509
+ * @param {string} request.name - The name of the operation resource.
510
+ * @param {Object=} options
511
+ * Optional parameters. You can override the default settings for this call,
512
+ * e.g, timeout, retries, paginations, etc. See {@link
513
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
514
+ * for the details.
515
+ * @param {function(?Error, ?Object)=} callback
516
+ * The function which will be called with the result of the API call.
517
+ *
518
+ * The second parameter to the callback is an object representing
519
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
520
+ * @return {Promise} - The promise which resolves to an array.
521
+ * The first element of the array is an object representing
522
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
523
+ * The promise has a method named "cancel" which cancels the ongoing API call.
524
+ *
525
+ * @example
526
+ * ```
527
+ * const client = longrunning.operationsClient();
528
+ * const name = '';
529
+ * const [response] = await client.getOperation({name});
530
+ * // doThingsWith(response)
531
+ * ```
532
+ */
533
533
  getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
534
534
  /**
535
535
  * Lists operations that match the specified filter in the request. If the