@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
@@ -290,7 +290,7 @@ export declare class DocumentServiceClient {
290
290
  */
291
291
  batchGetDocumentsMetadata(request?: protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest, options?: CallOptions): Promise<[
292
292
  protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataResponse,
293
- (protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest | undefined),
293
+ protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest | undefined,
294
294
  {} | undefined
295
295
  ]>;
296
296
  batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
@@ -504,49 +504,49 @@ export declare class DocumentServiceClient {
504
504
  */
505
505
  checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1.PurgeDocumentsMetadata>>;
506
506
  /**
507
- * Gets a list of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s.
508
- *
509
- * @param {Object} request
510
- * The request object that will be sent.
511
- * @param {string} request.parent
512
- * Required. The parent branch resource name, such as
513
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
514
- * Use `default_branch` as the branch ID, to list documents under the default
515
- * branch.
516
- *
517
- * If the caller does not have permission to list
518
- * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
519
- * regardless of whether or not this branch exists, a `PERMISSION_DENIED`
520
- * error is returned.
521
- * @param {number} request.pageSize
522
- * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
523
- * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
524
- * Values above 1000 are set to 1000.
525
- *
526
- * If this field is negative, an `INVALID_ARGUMENT` error is returned.
527
- * @param {string} request.pageToken
528
- * A page token
529
- * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
530
- * received from a previous
531
- * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
532
- * call. Provide this to retrieve the subsequent page.
533
- *
534
- * When paginating, all other parameters provided to
535
- * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
536
- * must match the call that provided the page token. Otherwise, an
537
- * `INVALID_ARGUMENT` error is returned.
538
- * @param {object} [options]
539
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
540
- * @returns {Promise} - The promise which resolves to an array.
541
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
542
- * The client library will perform auto-pagination by default: it will call the API as many
543
- * times as needed and will merge results from all the pages into this array.
544
- * Note that it can affect your quota.
545
- * We recommend using `listDocumentsAsync()`
546
- * method described below for async iteration which you can stop as needed.
547
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
548
- * for more details and examples.
549
- */
507
+ * Gets a list of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s.
508
+ *
509
+ * @param {Object} request
510
+ * The request object that will be sent.
511
+ * @param {string} request.parent
512
+ * Required. The parent branch resource name, such as
513
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
514
+ * Use `default_branch` as the branch ID, to list documents under the default
515
+ * branch.
516
+ *
517
+ * If the caller does not have permission to list
518
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
519
+ * regardless of whether or not this branch exists, a `PERMISSION_DENIED`
520
+ * error is returned.
521
+ * @param {number} request.pageSize
522
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
523
+ * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
524
+ * Values above 1000 are set to 1000.
525
+ *
526
+ * If this field is negative, an `INVALID_ARGUMENT` error is returned.
527
+ * @param {string} request.pageToken
528
+ * A page token
529
+ * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
530
+ * received from a previous
531
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
532
+ * call. Provide this to retrieve the subsequent page.
533
+ *
534
+ * When paginating, all other parameters provided to
535
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
536
+ * must match the call that provided the page token. Otherwise, an
537
+ * `INVALID_ARGUMENT` error is returned.
538
+ * @param {object} [options]
539
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
540
+ * @returns {Promise} - The promise which resolves to an array.
541
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
542
+ * The client library will perform auto-pagination by default: it will call the API as many
543
+ * times as needed and will merge results from all the pages into this array.
544
+ * Note that it can affect your quota.
545
+ * We recommend using `listDocumentsAsync()`
546
+ * method described below for async iteration which you can stop as needed.
547
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
548
+ * for more details and examples.
549
+ */
550
550
  listDocuments(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Promise<[
551
551
  protos.google.cloud.discoveryengine.v1.IDocument[],
552
552
  protos.google.cloud.discoveryengine.v1.IListDocumentsRequest | null,
@@ -644,86 +644,86 @@ export declare class DocumentServiceClient {
644
644
  */
645
645
  listDocumentsAsync(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IDocument>;
646
646
  /**
647
- * Gets information about a location.
648
- *
649
- * @param {Object} request
650
- * The request object that will be sent.
651
- * @param {string} request.name
652
- * Resource name for the location.
653
- * @param {object} [options]
654
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
655
- * @returns {Promise} - The promise which resolves to an array.
656
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
657
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
658
- * for more details and examples.
659
- * @example
660
- * ```
661
- * const [response] = await client.getLocation(request);
662
- * ```
663
- */
647
+ * Gets information about a location.
648
+ *
649
+ * @param {Object} request
650
+ * The request object that will be sent.
651
+ * @param {string} request.name
652
+ * Resource name for the location.
653
+ * @param {object} [options]
654
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
655
+ * @returns {Promise} - The promise which resolves to an array.
656
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
657
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
658
+ * for more details and examples.
659
+ * @example
660
+ * ```
661
+ * const [response] = await client.getLocation(request);
662
+ * ```
663
+ */
664
664
  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>;
665
665
  /**
666
- * Lists information about the supported locations for this service. Returns an iterable object.
667
- *
668
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
669
- * @param {Object} request
670
- * The request object that will be sent.
671
- * @param {string} request.name
672
- * The resource that owns the locations collection, if applicable.
673
- * @param {string} request.filter
674
- * The standard list filter.
675
- * @param {number} request.pageSize
676
- * The standard list page size.
677
- * @param {string} request.pageToken
678
- * The standard list page token.
679
- * @param {object} [options]
680
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
681
- * @returns {Object}
682
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
683
- * When you iterate the returned iterable, each element will be an object representing
684
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
685
- * so you can stop the iteration when you don't need more results.
686
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
687
- * for more details and examples.
688
- * @example
689
- * ```
690
- * const iterable = client.listLocationsAsync(request);
691
- * for await (const response of iterable) {
692
- * // process response
693
- * }
694
- * ```
695
- */
666
+ * Lists information about the supported locations for this service. Returns an iterable object.
667
+ *
668
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
669
+ * @param {Object} request
670
+ * The request object that will be sent.
671
+ * @param {string} request.name
672
+ * The resource that owns the locations collection, if applicable.
673
+ * @param {string} request.filter
674
+ * The standard list filter.
675
+ * @param {number} request.pageSize
676
+ * The standard list page size.
677
+ * @param {string} request.pageToken
678
+ * The standard list page token.
679
+ * @param {object} [options]
680
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
681
+ * @returns {Object}
682
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
683
+ * When you iterate the returned iterable, each element will be an object representing
684
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
685
+ * so you can stop the iteration when you don't need more results.
686
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
687
+ * for more details and examples.
688
+ * @example
689
+ * ```
690
+ * const iterable = client.listLocationsAsync(request);
691
+ * for await (const response of iterable) {
692
+ * // process response
693
+ * }
694
+ * ```
695
+ */
696
696
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
697
697
  /**
698
- * Gets the latest state of a long-running operation. Clients can use this
699
- * method to poll the operation result at intervals as recommended by the API
700
- * service.
701
- *
702
- * @param {Object} request - The request object that will be sent.
703
- * @param {string} request.name - The name of the operation resource.
704
- * @param {Object=} options
705
- * Optional parameters. You can override the default settings for this call,
706
- * e.g, timeout, retries, paginations, etc. See {@link
707
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
708
- * for the details.
709
- * @param {function(?Error, ?Object)=} callback
710
- * The function which will be called with the result of the API call.
711
- *
712
- * The second parameter to the callback is an object representing
713
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
714
- * @return {Promise} - The promise which resolves to an array.
715
- * The first element of the array is an object representing
716
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
717
- * The promise has a method named "cancel" which cancels the ongoing API call.
718
- *
719
- * @example
720
- * ```
721
- * const client = longrunning.operationsClient();
722
- * const name = '';
723
- * const [response] = await client.getOperation({name});
724
- * // doThingsWith(response)
725
- * ```
726
- */
698
+ * Gets the latest state of a long-running operation. Clients can use this
699
+ * method to poll the operation result at intervals as recommended by the API
700
+ * service.
701
+ *
702
+ * @param {Object} request - The request object that will be sent.
703
+ * @param {string} request.name - The name of the operation resource.
704
+ * @param {Object=} options
705
+ * Optional parameters. You can override the default settings for this call,
706
+ * e.g, timeout, retries, paginations, etc. See {@link
707
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
708
+ * for the details.
709
+ * @param {function(?Error, ?Object)=} callback
710
+ * The function which will be called with the result of the API call.
711
+ *
712
+ * The second parameter to the callback is an object representing
713
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
714
+ * @return {Promise} - The promise which resolves to an array.
715
+ * The first element of the array is an object representing
716
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
717
+ * The promise has a method named "cancel" which cancels the ongoing API call.
718
+ *
719
+ * @example
720
+ * ```
721
+ * const client = longrunning.operationsClient();
722
+ * const name = '';
723
+ * const [response] = await client.getOperation({name});
724
+ * // doThingsWith(response)
725
+ * ```
726
+ */
727
727
  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]>;
728
728
  /**
729
729
  * Lists operations that match the specified filter in the request. If the