@google-cloud/discoveryengine 1.9.0 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +2 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +13 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +119 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +0 -5
  6. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +31 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +38 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +35 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  10. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +37 -2
  11. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +108 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +200 -4
  14. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +3 -0
  15. package/build/protos/protos.d.ts +3851 -1527
  16. package/build/protos/protos.js +14056 -8213
  17. package/build/protos/protos.json +548 -8
  18. package/build/src/v1/completion_service_client.d.ts +220 -0
  19. package/build/src/v1/completion_service_client.js +260 -0
  20. package/build/src/v1/completion_service_client_config.json +10 -0
  21. package/build/src/v1/control_service_client.d.ts +129 -1
  22. package/build/src/v1/control_service_client.js +176 -0
  23. package/build/src/v1/conversational_search_service_client.d.ts +147 -1
  24. package/build/src/v1/conversational_search_service_client.js +176 -0
  25. package/build/src/v1/data_store_service_client.d.ts +129 -1
  26. package/build/src/v1/data_store_service_client.js +176 -0
  27. package/build/src/v1/document_service_client.d.ts +131 -1
  28. package/build/src/v1/document_service_client.js +176 -0
  29. package/build/src/v1/engine_service_client.d.ts +129 -1
  30. package/build/src/v1/engine_service_client.js +176 -0
  31. package/build/src/v1/grounded_generation_service_client.d.ts +129 -0
  32. package/build/src/v1/grounded_generation_service_client.js +176 -0
  33. package/build/src/v1/project_service_client.d.ts +129 -0
  34. package/build/src/v1/project_service_client.js +176 -0
  35. package/build/src/v1/rank_service_client.d.ts +129 -0
  36. package/build/src/v1/rank_service_client.js +176 -0
  37. package/build/src/v1/recommendation_service_client.d.ts +129 -0
  38. package/build/src/v1/recommendation_service_client.js +176 -0
  39. package/build/src/v1/schema_service_client.d.ts +129 -1
  40. package/build/src/v1/schema_service_client.js +176 -0
  41. package/build/src/v1/search_service_client.d.ts +252 -1
  42. package/build/src/v1/search_service_client.js +258 -0
  43. package/build/src/v1/site_search_engine_service_client.d.ts +129 -1
  44. package/build/src/v1/site_search_engine_service_client.js +176 -0
  45. package/build/src/v1/user_event_service_client.d.ts +129 -0
  46. package/build/src/v1/user_event_service_client.js +176 -0
  47. package/build/src/v1alpha/chunk_service_client.d.ts +0 -1
  48. package/build/src/v1alpha/control_service_client.d.ts +0 -1
  49. package/build/src/v1alpha/conversational_search_service_client.d.ts +0 -1
  50. package/build/src/v1alpha/data_store_service_client.d.ts +0 -1
  51. package/build/src/v1alpha/document_service_client.d.ts +0 -1
  52. package/build/src/v1alpha/engine_service_client.d.ts +0 -1
  53. package/build/src/v1alpha/schema_service_client.d.ts +0 -1
  54. package/build/src/v1alpha/search_service_client.d.ts +0 -1
  55. package/build/src/v1alpha/serving_config_service_client.d.ts +0 -1
  56. package/build/src/v1alpha/site_search_engine_service_client.d.ts +0 -1
  57. package/build/src/v1beta/control_service_client.d.ts +0 -1
  58. package/build/src/v1beta/conversational_search_service_client.d.ts +0 -1
  59. package/build/src/v1beta/data_store_service_client.d.ts +0 -1
  60. package/build/src/v1beta/document_service_client.d.ts +0 -1
  61. package/build/src/v1beta/engine_service_client.d.ts +0 -1
  62. package/build/src/v1beta/schema_service_client.d.ts +0 -1
  63. package/build/src/v1beta/search_service_client.d.ts +0 -1
  64. package/build/src/v1beta/serving_config_service_client.d.ts +0 -1
  65. package/build/src/v1beta/site_search_engine_service_client.d.ts +0 -1
  66. package/package.json +1 -1
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  import type * as gax from 'google-gax';
3
2
  import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
3
  import { Transform } from 'stream';
@@ -215,6 +214,12 @@ export declare class SearchServiceClient {
215
214
  * Highly recommended for analytics.
216
215
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
217
216
  * is used to deduce `device_type` for analytics.
217
+ * @param {string} request.languageCode
218
+ * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
219
+ * information, see [Standard
220
+ * fields](https://cloud.google.com/apis/design/standard_fields). This field
221
+ * helps to better interpret the query. If a value isn't specified, the query
222
+ * language code is automatically detected, which may not be accurate.
218
223
  * @param {number[]} request.facetSpecs
219
224
  * Facet specifications for faceted search. If empty, no facets are returned.
220
225
  *
@@ -284,6 +289,41 @@ export declare class SearchServiceClient {
284
289
  * See [Google Cloud
285
290
  * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
286
291
  * for more details.
292
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
293
+ * Search as you type configuration. Only supported for the
294
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
295
+ * vertical.
296
+ * @param {string} request.session
297
+ * The session resource name. Optional.
298
+ *
299
+ * Session allows users to do multi-turn /search API calls or coordination
300
+ * between /search API calls and /answer API calls.
301
+ *
302
+ * Example #1 (multi-turn /search API calls):
303
+ * 1. Call /search API with the auto-session mode (see below).
304
+ * 2. Call /search API with the session ID generated in the first call.
305
+ * Here, the previous search query gets considered in query
306
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
307
+ * and the current query is "How about 2023?", the current query will
308
+ * be interpreted as "How did Alphabet do in 2023?".
309
+ *
310
+ * Example #2 (coordination between /search API calls and /answer API calls):
311
+ * 1. Call /search API with the auto-session mode (see below).
312
+ * 2. Call /answer API with the session ID generated in the first call.
313
+ * Here, the answer generation happens in the context of the search
314
+ * results from the first search call.
315
+ *
316
+ * Auto-session mode: when `projects/.../sessions/-` is used, a new session
317
+ * gets automatically created. Otherwise, users can use the create-session API
318
+ * to create a session manually.
319
+ *
320
+ * Multi-turn Search feature is currently at private GA stage. Please use
321
+ * v1alpha or v1beta version instead before we launch this feature to public
322
+ * GA. Or ask for allowlisting through Google Support team.
323
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
324
+ * Session specification.
325
+ *
326
+ * Can be used only when `session` is set.
287
327
  * @param {object} [options]
288
328
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
289
329
  * @returns {Promise} - The promise which resolves to an array.
@@ -401,6 +441,12 @@ export declare class SearchServiceClient {
401
441
  * Highly recommended for analytics.
402
442
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
403
443
  * is used to deduce `device_type` for analytics.
444
+ * @param {string} request.languageCode
445
+ * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
446
+ * information, see [Standard
447
+ * fields](https://cloud.google.com/apis/design/standard_fields). This field
448
+ * helps to better interpret the query. If a value isn't specified, the query
449
+ * language code is automatically detected, which may not be accurate.
404
450
  * @param {number[]} request.facetSpecs
405
451
  * Facet specifications for faceted search. If empty, no facets are returned.
406
452
  *
@@ -470,6 +516,41 @@ export declare class SearchServiceClient {
470
516
  * See [Google Cloud
471
517
  * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
472
518
  * for more details.
519
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
520
+ * Search as you type configuration. Only supported for the
521
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
522
+ * vertical.
523
+ * @param {string} request.session
524
+ * The session resource name. Optional.
525
+ *
526
+ * Session allows users to do multi-turn /search API calls or coordination
527
+ * between /search API calls and /answer API calls.
528
+ *
529
+ * Example #1 (multi-turn /search API calls):
530
+ * 1. Call /search API with the auto-session mode (see below).
531
+ * 2. Call /search API with the session ID generated in the first call.
532
+ * Here, the previous search query gets considered in query
533
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
534
+ * and the current query is "How about 2023?", the current query will
535
+ * be interpreted as "How did Alphabet do in 2023?".
536
+ *
537
+ * Example #2 (coordination between /search API calls and /answer API calls):
538
+ * 1. Call /search API with the auto-session mode (see below).
539
+ * 2. Call /answer API with the session ID generated in the first call.
540
+ * Here, the answer generation happens in the context of the search
541
+ * results from the first search call.
542
+ *
543
+ * Auto-session mode: when `projects/.../sessions/-` is used, a new session
544
+ * gets automatically created. Otherwise, users can use the create-session API
545
+ * to create a session manually.
546
+ *
547
+ * Multi-turn Search feature is currently at private GA stage. Please use
548
+ * v1alpha or v1beta version instead before we launch this feature to public
549
+ * GA. Or ask for allowlisting through Google Support team.
550
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
551
+ * Session specification.
552
+ *
553
+ * Can be used only when `session` is set.
473
554
  * @param {object} [options]
474
555
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
475
556
  * @returns {Stream}
@@ -582,6 +663,12 @@ export declare class SearchServiceClient {
582
663
  * Highly recommended for analytics.
583
664
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
584
665
  * is used to deduce `device_type` for analytics.
666
+ * @param {string} request.languageCode
667
+ * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
668
+ * information, see [Standard
669
+ * fields](https://cloud.google.com/apis/design/standard_fields). This field
670
+ * helps to better interpret the query. If a value isn't specified, the query
671
+ * language code is automatically detected, which may not be accurate.
585
672
  * @param {number[]} request.facetSpecs
586
673
  * Facet specifications for faceted search. If empty, no facets are returned.
587
674
  *
@@ -651,6 +738,41 @@ export declare class SearchServiceClient {
651
738
  * See [Google Cloud
652
739
  * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
653
740
  * for more details.
741
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
742
+ * Search as you type configuration. Only supported for the
743
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
744
+ * vertical.
745
+ * @param {string} request.session
746
+ * The session resource name. Optional.
747
+ *
748
+ * Session allows users to do multi-turn /search API calls or coordination
749
+ * between /search API calls and /answer API calls.
750
+ *
751
+ * Example #1 (multi-turn /search API calls):
752
+ * 1. Call /search API with the auto-session mode (see below).
753
+ * 2. Call /search API with the session ID generated in the first call.
754
+ * Here, the previous search query gets considered in query
755
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
756
+ * and the current query is "How about 2023?", the current query will
757
+ * be interpreted as "How did Alphabet do in 2023?".
758
+ *
759
+ * Example #2 (coordination between /search API calls and /answer API calls):
760
+ * 1. Call /search API with the auto-session mode (see below).
761
+ * 2. Call /answer API with the session ID generated in the first call.
762
+ * Here, the answer generation happens in the context of the search
763
+ * results from the first search call.
764
+ *
765
+ * Auto-session mode: when `projects/.../sessions/-` is used, a new session
766
+ * gets automatically created. Otherwise, users can use the create-session API
767
+ * to create a session manually.
768
+ *
769
+ * Multi-turn Search feature is currently at private GA stage. Please use
770
+ * v1alpha or v1beta version instead before we launch this feature to public
771
+ * GA. Or ask for allowlisting through Google Support team.
772
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
773
+ * Session specification.
774
+ *
775
+ * Can be used only when `session` is set.
654
776
  * @param {object} [options]
655
777
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
656
778
  * @returns {Object}
@@ -925,6 +1047,75 @@ export declare class SearchServiceClient {
925
1047
  * @returns {string} A string representing the document.
926
1048
  */
927
1049
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1050
+ /**
1051
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
1052
+ *
1053
+ * @param {string} project
1054
+ * @param {string} location
1055
+ * @param {string} collection
1056
+ * @param {string} data_store
1057
+ * @param {string} branch
1058
+ * @param {string} document
1059
+ * @param {string} chunk
1060
+ * @returns {string} Resource name string.
1061
+ */
1062
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
1063
+ /**
1064
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1065
+ *
1066
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1067
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1068
+ * @returns {string} A string representing the project.
1069
+ */
1070
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1071
+ /**
1072
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1073
+ *
1074
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1075
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1076
+ * @returns {string} A string representing the location.
1077
+ */
1078
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1079
+ /**
1080
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1081
+ *
1082
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1083
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1084
+ * @returns {string} A string representing the collection.
1085
+ */
1086
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1087
+ /**
1088
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1089
+ *
1090
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1091
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1092
+ * @returns {string} A string representing the data_store.
1093
+ */
1094
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1095
+ /**
1096
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1097
+ *
1098
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1099
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1100
+ * @returns {string} A string representing the branch.
1101
+ */
1102
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1103
+ /**
1104
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1105
+ *
1106
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1107
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1108
+ * @returns {string} A string representing the document.
1109
+ */
1110
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1111
+ /**
1112
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1113
+ *
1114
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1115
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1116
+ * @returns {string} A string representing the chunk.
1117
+ */
1118
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
928
1119
  /**
929
1120
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
930
1121
  *
@@ -1765,6 +1956,66 @@ export declare class SearchServiceClient {
1765
1956
  * @returns {string} A string representing the document.
1766
1957
  */
1767
1958
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1959
+ /**
1960
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
1961
+ *
1962
+ * @param {string} project
1963
+ * @param {string} location
1964
+ * @param {string} data_store
1965
+ * @param {string} branch
1966
+ * @param {string} document
1967
+ * @param {string} chunk
1968
+ * @returns {string} Resource name string.
1969
+ */
1970
+ projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
1971
+ /**
1972
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
1973
+ *
1974
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1975
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1976
+ * @returns {string} A string representing the project.
1977
+ */
1978
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1979
+ /**
1980
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
1981
+ *
1982
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1983
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1984
+ * @returns {string} A string representing the location.
1985
+ */
1986
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1987
+ /**
1988
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
1989
+ *
1990
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1991
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1992
+ * @returns {string} A string representing the data_store.
1993
+ */
1994
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1995
+ /**
1996
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
1997
+ *
1998
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1999
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2000
+ * @returns {string} A string representing the branch.
2001
+ */
2002
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
2003
+ /**
2004
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
2005
+ *
2006
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2007
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2008
+ * @returns {string} A string representing the document.
2009
+ */
2010
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
2011
+ /**
2012
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
2013
+ *
2014
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2015
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2016
+ * @returns {string} A string representing the chunk.
2017
+ */
2018
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1768
2019
  /**
1769
2020
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1770
2021
  *
@@ -154,6 +154,7 @@ class SearchServiceClient {
154
154
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
155
155
  projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
156
156
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
157
+ projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
157
158
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
158
159
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
159
160
  projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
@@ -171,6 +172,7 @@ class SearchServiceClient {
171
172
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
172
173
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
173
174
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
175
+ projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
174
176
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
175
177
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
176
178
  projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
@@ -416,6 +418,12 @@ class SearchServiceClient {
416
418
  * Highly recommended for analytics.
417
419
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
418
420
  * is used to deduce `device_type` for analytics.
421
+ * @param {string} request.languageCode
422
+ * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
423
+ * information, see [Standard
424
+ * fields](https://cloud.google.com/apis/design/standard_fields). This field
425
+ * helps to better interpret the query. If a value isn't specified, the query
426
+ * language code is automatically detected, which may not be accurate.
419
427
  * @param {number[]} request.facetSpecs
420
428
  * Facet specifications for faceted search. If empty, no facets are returned.
421
429
  *
@@ -485,6 +493,41 @@ class SearchServiceClient {
485
493
  * See [Google Cloud
486
494
  * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
487
495
  * for more details.
496
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
497
+ * Search as you type configuration. Only supported for the
498
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
499
+ * vertical.
500
+ * @param {string} request.session
501
+ * The session resource name. Optional.
502
+ *
503
+ * Session allows users to do multi-turn /search API calls or coordination
504
+ * between /search API calls and /answer API calls.
505
+ *
506
+ * Example #1 (multi-turn /search API calls):
507
+ * 1. Call /search API with the auto-session mode (see below).
508
+ * 2. Call /search API with the session ID generated in the first call.
509
+ * Here, the previous search query gets considered in query
510
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
511
+ * and the current query is "How about 2023?", the current query will
512
+ * be interpreted as "How did Alphabet do in 2023?".
513
+ *
514
+ * Example #2 (coordination between /search API calls and /answer API calls):
515
+ * 1. Call /search API with the auto-session mode (see below).
516
+ * 2. Call /answer API with the session ID generated in the first call.
517
+ * Here, the answer generation happens in the context of the search
518
+ * results from the first search call.
519
+ *
520
+ * Auto-session mode: when `projects/.../sessions/-` is used, a new session
521
+ * gets automatically created. Otherwise, users can use the create-session API
522
+ * to create a session manually.
523
+ *
524
+ * Multi-turn Search feature is currently at private GA stage. Please use
525
+ * v1alpha or v1beta version instead before we launch this feature to public
526
+ * GA. Or ask for allowlisting through Google Support team.
527
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
528
+ * Session specification.
529
+ *
530
+ * Can be used only when `session` is set.
488
531
  * @param {object} [options]
489
532
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
490
533
  * @returns {Stream}
@@ -611,6 +654,12 @@ class SearchServiceClient {
611
654
  * Highly recommended for analytics.
612
655
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
613
656
  * is used to deduce `device_type` for analytics.
657
+ * @param {string} request.languageCode
658
+ * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
659
+ * information, see [Standard
660
+ * fields](https://cloud.google.com/apis/design/standard_fields). This field
661
+ * helps to better interpret the query. If a value isn't specified, the query
662
+ * language code is automatically detected, which may not be accurate.
614
663
  * @param {number[]} request.facetSpecs
615
664
  * Facet specifications for faceted search. If empty, no facets are returned.
616
665
  *
@@ -680,6 +729,41 @@ class SearchServiceClient {
680
729
  * See [Google Cloud
681
730
  * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
682
731
  * for more details.
732
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
733
+ * Search as you type configuration. Only supported for the
734
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
735
+ * vertical.
736
+ * @param {string} request.session
737
+ * The session resource name. Optional.
738
+ *
739
+ * Session allows users to do multi-turn /search API calls or coordination
740
+ * between /search API calls and /answer API calls.
741
+ *
742
+ * Example #1 (multi-turn /search API calls):
743
+ * 1. Call /search API with the auto-session mode (see below).
744
+ * 2. Call /search API with the session ID generated in the first call.
745
+ * Here, the previous search query gets considered in query
746
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
747
+ * and the current query is "How about 2023?", the current query will
748
+ * be interpreted as "How did Alphabet do in 2023?".
749
+ *
750
+ * Example #2 (coordination between /search API calls and /answer API calls):
751
+ * 1. Call /search API with the auto-session mode (see below).
752
+ * 2. Call /answer API with the session ID generated in the first call.
753
+ * Here, the answer generation happens in the context of the search
754
+ * results from the first search call.
755
+ *
756
+ * Auto-session mode: when `projects/.../sessions/-` is used, a new session
757
+ * gets automatically created. Otherwise, users can use the create-session API
758
+ * to create a session manually.
759
+ *
760
+ * Multi-turn Search feature is currently at private GA stage. Please use
761
+ * v1alpha or v1beta version instead before we launch this feature to public
762
+ * GA. Or ask for allowlisting through Google Support team.
763
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
764
+ * Session specification.
765
+ *
766
+ * Can be used only when `session` is set.
683
767
  * @param {object} [options]
684
768
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
685
769
  * @returns {Object}
@@ -1050,6 +1134,99 @@ class SearchServiceClient {
1050
1134
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1051
1135
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
1052
1136
  }
1137
+ /**
1138
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
1139
+ *
1140
+ * @param {string} project
1141
+ * @param {string} location
1142
+ * @param {string} collection
1143
+ * @param {string} data_store
1144
+ * @param {string} branch
1145
+ * @param {string} document
1146
+ * @param {string} chunk
1147
+ * @returns {string} Resource name string.
1148
+ */
1149
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project, location, collection, dataStore, branch, document, chunk) {
1150
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.render({
1151
+ project: project,
1152
+ location: location,
1153
+ collection: collection,
1154
+ data_store: dataStore,
1155
+ branch: branch,
1156
+ document: document,
1157
+ chunk: chunk,
1158
+ });
1159
+ }
1160
+ /**
1161
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1162
+ *
1163
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1164
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1165
+ * @returns {string} A string representing the project.
1166
+ */
1167
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1168
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).project;
1169
+ }
1170
+ /**
1171
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1172
+ *
1173
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1174
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1175
+ * @returns {string} A string representing the location.
1176
+ */
1177
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1178
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).location;
1179
+ }
1180
+ /**
1181
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1182
+ *
1183
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1184
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1185
+ * @returns {string} A string representing the collection.
1186
+ */
1187
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1188
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).collection;
1189
+ }
1190
+ /**
1191
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1192
+ *
1193
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1194
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1195
+ * @returns {string} A string representing the data_store.
1196
+ */
1197
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1198
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).data_store;
1199
+ }
1200
+ /**
1201
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1202
+ *
1203
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1204
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1205
+ * @returns {string} A string representing the branch.
1206
+ */
1207
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1208
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).branch;
1209
+ }
1210
+ /**
1211
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1212
+ *
1213
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1214
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1215
+ * @returns {string} A string representing the document.
1216
+ */
1217
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1218
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).document;
1219
+ }
1220
+ /**
1221
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1222
+ *
1223
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1224
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1225
+ * @returns {string} A string representing the chunk.
1226
+ */
1227
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1228
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).chunk;
1229
+ }
1053
1230
  /**
1054
1231
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
1055
1232
  *
@@ -2187,6 +2364,87 @@ class SearchServiceClient {
2187
2364
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
2188
2365
  return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
2189
2366
  }
2367
+ /**
2368
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
2369
+ *
2370
+ * @param {string} project
2371
+ * @param {string} location
2372
+ * @param {string} data_store
2373
+ * @param {string} branch
2374
+ * @param {string} document
2375
+ * @param {string} chunk
2376
+ * @returns {string} Resource name string.
2377
+ */
2378
+ projectLocationDataStoreBranchDocumentChunkPath(project, location, dataStore, branch, document, chunk) {
2379
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.render({
2380
+ project: project,
2381
+ location: location,
2382
+ data_store: dataStore,
2383
+ branch: branch,
2384
+ document: document,
2385
+ chunk: chunk,
2386
+ });
2387
+ }
2388
+ /**
2389
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
2390
+ *
2391
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2392
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2393
+ * @returns {string} A string representing the project.
2394
+ */
2395
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2396
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).project;
2397
+ }
2398
+ /**
2399
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
2400
+ *
2401
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2402
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2403
+ * @returns {string} A string representing the location.
2404
+ */
2405
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2406
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).location;
2407
+ }
2408
+ /**
2409
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
2410
+ *
2411
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2412
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2413
+ * @returns {string} A string representing the data_store.
2414
+ */
2415
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2416
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).data_store;
2417
+ }
2418
+ /**
2419
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
2420
+ *
2421
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2422
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2423
+ * @returns {string} A string representing the branch.
2424
+ */
2425
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2426
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).branch;
2427
+ }
2428
+ /**
2429
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
2430
+ *
2431
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2432
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2433
+ * @returns {string} A string representing the document.
2434
+ */
2435
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2436
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).document;
2437
+ }
2438
+ /**
2439
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
2440
+ *
2441
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2442
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2443
+ * @returns {string} A string representing the chunk.
2444
+ */
2445
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2446
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).chunk;
2447
+ }
2190
2448
  /**
2191
2449
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
2192
2450
  *