@google-cloud/discoveryengine 2.0.1 → 2.1.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 (85) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +7 -2
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +54 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +2 -1
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +35 -6
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +113 -2
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +168 -2
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +23 -4
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +7 -2
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +16 -3
  12. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +70 -9
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +20 -1
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +9 -5
  15. package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +3 -1
  16. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -2
  17. package/build/protos/google/cloud/discoveryengine/v1/safety.proto +107 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +96 -8
  19. package/build/protos/google/cloud/discoveryengine/v1/serving_config.proto +271 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/serving_config_service.proto +75 -0
  21. package/build/protos/google/cloud/discoveryengine/v1/session.proto +19 -0
  22. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +27 -3
  23. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +184 -5
  24. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +34 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +16 -4
  26. package/build/protos/protos.d.ts +5356 -981
  27. package/build/protos/protos.js +32266 -20956
  28. package/build/protos/protos.json +1391 -74
  29. package/build/src/index.d.ts +4 -1
  30. package/build/src/index.js +4 -1
  31. package/build/src/v1/completion_service_client.d.ts +237 -0
  32. package/build/src/v1/completion_service_client.js +326 -0
  33. package/build/src/v1/completion_service_proto_list.json +3 -0
  34. package/build/src/v1/control_service_client.d.ts +237 -0
  35. package/build/src/v1/control_service_client.js +326 -0
  36. package/build/src/v1/control_service_proto_list.json +3 -0
  37. package/build/src/v1/conversational_search_service_client.d.ts +213 -6
  38. package/build/src/v1/conversational_search_service_client.js +265 -5
  39. package/build/src/v1/conversational_search_service_client_config.json +5 -0
  40. package/build/src/v1/conversational_search_service_proto_list.json +3 -0
  41. package/build/src/v1/data_store_service_client.d.ts +237 -0
  42. package/build/src/v1/data_store_service_client.js +326 -0
  43. package/build/src/v1/data_store_service_proto_list.json +3 -0
  44. package/build/src/v1/document_service_client.d.ts +244 -1
  45. package/build/src/v1/document_service_client.js +326 -0
  46. package/build/src/v1/document_service_proto_list.json +3 -0
  47. package/build/src/v1/engine_service_client.d.ts +237 -0
  48. package/build/src/v1/engine_service_client.js +326 -0
  49. package/build/src/v1/engine_service_proto_list.json +3 -0
  50. package/build/src/v1/gapic_metadata.json +59 -0
  51. package/build/src/v1/grounded_generation_service_client.d.ts +238 -3
  52. package/build/src/v1/grounded_generation_service_client.js +326 -0
  53. package/build/src/v1/grounded_generation_service_proto_list.json +3 -0
  54. package/build/src/v1/index.d.ts +1 -0
  55. package/build/src/v1/index.js +3 -1
  56. package/build/src/v1/project_service_client.d.ts +237 -0
  57. package/build/src/v1/project_service_client.js +326 -0
  58. package/build/src/v1/project_service_proto_list.json +3 -0
  59. package/build/src/v1/rank_service_client.d.ts +238 -1
  60. package/build/src/v1/rank_service_client.js +326 -0
  61. package/build/src/v1/rank_service_proto_list.json +3 -0
  62. package/build/src/v1/recommendation_service_client.d.ts +95 -2
  63. package/build/src/v1/recommendation_service_client.js +128 -0
  64. package/build/src/v1/recommendation_service_proto_list.json +3 -0
  65. package/build/src/v1/schema_service_client.d.ts +237 -0
  66. package/build/src/v1/schema_service_client.js +326 -0
  67. package/build/src/v1/schema_service_proto_list.json +3 -0
  68. package/build/src/v1/search_service_client.d.ts +219 -30
  69. package/build/src/v1/search_service_client.js +212 -20
  70. package/build/src/v1/search_service_proto_list.json +3 -0
  71. package/build/src/v1/search_tuning_service_client.d.ts +237 -0
  72. package/build/src/v1/search_tuning_service_client.js +326 -0
  73. package/build/src/v1/search_tuning_service_proto_list.json +3 -0
  74. package/build/src/v1/serving_config_service_client.d.ts +1851 -0
  75. package/build/src/v1/serving_config_service_client.js +2653 -0
  76. package/build/src/v1/serving_config_service_client_config.json +30 -0
  77. package/build/src/v1/serving_config_service_proto_list.json +39 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +356 -3
  79. package/build/src/v1/site_search_engine_service_client.js +473 -0
  80. package/build/src/v1/site_search_engine_service_client_config.json +12 -0
  81. package/build/src/v1/site_search_engine_service_proto_list.json +3 -0
  82. package/build/src/v1/user_event_service_client.d.ts +258 -9
  83. package/build/src/v1/user_event_service_client.js +326 -0
  84. package/build/src/v1/user_event_service_proto_list.json +3 -0
  85. package/package.json +4 -4
@@ -18,6 +18,7 @@
18
18
  // ** All changes to this file may be overwritten. **
19
19
  Object.defineProperty(exports, "__esModule", { value: true });
20
20
  exports.ConversationalSearchServiceClient = void 0;
21
+ const stream_1 = require("stream");
21
22
  const jsonProtos = require("../../protos/protos.json");
22
23
  const google_gax_1 = require("google-gax");
23
24
  /**
@@ -183,6 +184,7 @@ class ConversationalSearchServiceClient {
183
184
  projectLocationCollectionDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
184
185
  projectLocationCollectionDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
185
186
  projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
187
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
186
188
  projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
187
189
  projectLocationCollectionEngineControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/controls/{control}'),
188
190
  projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
@@ -201,6 +203,7 @@ class ConversationalSearchServiceClient {
201
203
  projectLocationDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
202
204
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
203
205
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
206
+ projectLocationDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
204
207
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
205
208
  };
206
209
  // Some of the methods on this service return "paged" results,
@@ -210,6 +213,11 @@ class ConversationalSearchServiceClient {
210
213
  listConversations: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'conversations'),
211
214
  listSessions: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'sessions'),
212
215
  };
216
+ // Some of the methods on this service provide streaming responses.
217
+ // Provide descriptors for these.
218
+ this.descriptors.stream = {
219
+ streamAnswerQuery: new this._gaxModule.StreamDescriptor(this._gaxModule.StreamType.SERVER_STREAMING, !!opts.fallback, !!opts.gaxServerStreamingRetries),
220
+ };
213
221
  // Put together the default options sent with requests.
214
222
  this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1.ConversationalSearchService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
215
223
  // Set up a dictionary of "inner API calls"; the core implementation
@@ -252,6 +260,7 @@ class ConversationalSearchServiceClient {
252
260
  'getConversation',
253
261
  'listConversations',
254
262
  'answerQuery',
263
+ 'streamAnswerQuery',
255
264
  'getAnswer',
256
265
  'createSession',
257
266
  'deleteSession',
@@ -262,6 +271,13 @@ class ConversationalSearchServiceClient {
262
271
  for (const methodName of conversationalSearchServiceStubMethods) {
263
272
  const callPromise = this.conversationalSearchServiceStub.then(stub => (...args) => {
264
273
  if (this._terminated) {
274
+ if (methodName in this.descriptors.stream) {
275
+ const stream = new stream_1.PassThrough({ objectMode: true });
276
+ setImmediate(() => {
277
+ stream.emit('error', new this._gaxModule.GoogleError('The client has already been closed.'));
278
+ });
279
+ return stream;
280
+ }
265
281
  return Promise.reject('The client has already been closed.');
266
282
  }
267
283
  const func = stub[methodName];
@@ -269,7 +285,9 @@ class ConversationalSearchServiceClient {
269
285
  }, (err) => () => {
270
286
  throw err;
271
287
  });
272
- const descriptor = this.descriptors.page[methodName] || undefined;
288
+ const descriptor = this.descriptors.page[methodName] ||
289
+ this.descriptors.stream[methodName] ||
290
+ undefined;
273
291
  const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
274
292
  this.innerApiCalls[methodName] = apiCall;
275
293
  }
@@ -709,6 +727,112 @@ class ConversationalSearchServiceClient {
709
727
  return [response, options, rawResponse];
710
728
  });
711
729
  }
730
+ /**
731
+ * Answer query method (streaming).
732
+ *
733
+ * It takes one
734
+ * {@link protos.google.cloud.discoveryengine.v1.AnswerQueryRequest|AnswerQueryRequest}
735
+ * and returns multiple
736
+ * {@link protos.google.cloud.discoveryengine.v1.AnswerQueryResponse|AnswerQueryResponse}
737
+ * messages in a stream.
738
+ *
739
+ * @param {Object} request
740
+ * The request object that will be sent.
741
+ * @param {string} request.servingConfig
742
+ * Required. The resource name of the Search serving config, such as
743
+ * `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
744
+ * or
745
+ * `projects/* /locations/global/collections/default_collection/dataStores/* /servingConfigs/default_serving_config`.
746
+ * This field is used to identify the serving configuration name, set
747
+ * of models used to make the search.
748
+ * @param {google.cloud.discoveryengine.v1.Query} request.query
749
+ * Required. Current user query.
750
+ * @param {string} request.session
751
+ * The session resource name. Not required.
752
+ *
753
+ * When session field is not set, the API is in sessionless mode.
754
+ *
755
+ * We support auto session mode: users can use the wildcard symbol `-` as
756
+ * session ID. A new ID will be automatically generated and assigned.
757
+ * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec} request.safetySpec
758
+ * Model specification.
759
+ * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.RelatedQuestionsSpec} request.relatedQuestionsSpec
760
+ * Related questions specification.
761
+ * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.GroundingSpec} [request.groundingSpec]
762
+ * Optional. Grounding specification.
763
+ * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.AnswerGenerationSpec} request.answerGenerationSpec
764
+ * Answer generation specification.
765
+ * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec} request.searchSpec
766
+ * Search specification.
767
+ * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec} request.queryUnderstandingSpec
768
+ * Query understanding specification.
769
+ * @param {boolean} request.asynchronousMode
770
+ * Deprecated: This field is deprecated. Streaming Answer API will be
771
+ * supported.
772
+ *
773
+ * Asynchronous mode control.
774
+ *
775
+ * If enabled, the response will be returned with answer/session resource
776
+ * name without final answer. The API users need to do the polling to get
777
+ * the latest status of answer/session by calling
778
+ * {@link protos.google.cloud.discoveryengine.v1.ConversationalSearchService.GetAnswer|ConversationalSearchService.GetAnswer}
779
+ * or
780
+ * {@link protos.google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession|ConversationalSearchService.GetSession}
781
+ * method.
782
+ * @param {string} request.userPseudoId
783
+ * A unique identifier for tracking visitors. For example, this could be
784
+ * implemented with an HTTP cookie, which should be able to uniquely identify
785
+ * a visitor on a single device. This unique identifier should not change if
786
+ * the visitor logs in or out of the website.
787
+ *
788
+ * This field should NOT have a fixed value such as `unknown_visitor`.
789
+ *
790
+ * The field must be a UTF-8 encoded string with a length limit of 128
791
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
792
+ * @param {number[]} request.userLabels
793
+ * The user labels applied to a resource must meet the following requirements:
794
+ *
795
+ * * Each resource can have multiple labels, up to a maximum of 64.
796
+ * * Each label must be a key-value pair.
797
+ * * Keys have a minimum length of 1 character and a maximum length of 63
798
+ * characters and cannot be empty. Values can be empty and have a maximum
799
+ * length of 63 characters.
800
+ * * Keys and values can contain only lowercase letters, numeric characters,
801
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
802
+ * international characters are allowed.
803
+ * * The key portion of a label must be unique. However, you can use the same
804
+ * key with multiple resources.
805
+ * * Keys must start with a lowercase letter or international character.
806
+ *
807
+ * See [Google Cloud
808
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
809
+ * for more details.
810
+ * @param {google.cloud.discoveryengine.v1.AnswerQueryRequest.EndUserSpec} [request.endUserSpec]
811
+ * Optional. End user specification.
812
+ * @param {object} [options]
813
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
814
+ * @returns {Stream}
815
+ * An object stream which emits {@link protos.google.cloud.discoveryengine.v1.AnswerQueryResponse|AnswerQueryResponse} on 'data' event.
816
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation }
817
+ * for more details and examples.
818
+ * @example <caption>include:samples/generated/v1/conversational_search_service.stream_answer_query.js</caption>
819
+ * region_tag:discoveryengine_v1_generated_ConversationalSearchService_StreamAnswerQuery_async
820
+ */
821
+ streamAnswerQuery(request, options) {
822
+ request = request || {};
823
+ options = options || {};
824
+ options.otherArgs = options.otherArgs || {};
825
+ options.otherArgs.headers = options.otherArgs.headers || {};
826
+ options.otherArgs.headers['x-goog-request-params'] =
827
+ this._gaxModule.routingHeader.fromParams({
828
+ serving_config: request.servingConfig ?? '',
829
+ });
830
+ this.initialize().catch(err => {
831
+ throw err;
832
+ });
833
+ this._log.info('streamAnswerQuery stream %j', options);
834
+ return this.innerApiCalls.streamAnswerQuery(request, options);
835
+ }
712
836
  listConversations(request, optionsOrCallback, callback) {
713
837
  request = request || {};
714
838
  let options;
@@ -919,13 +1043,18 @@ class ConversationalSearchServiceClient {
919
1043
  * A comma-separated list of fields to order by, sorted in ascending order.
920
1044
  * Use "desc" after a field name for descending.
921
1045
  * Supported fields:
1046
+ *
922
1047
  * * `update_time`
923
1048
  * * `create_time`
924
1049
  * * `session_name`
1050
+ * * `is_pinned`
925
1051
  *
926
1052
  * Example:
927
- * "update_time desc"
928
- * "create_time"
1053
+ *
1054
+ * * "update_time desc"
1055
+ * * "create_time"
1056
+ * * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
1057
+ * by update_time.
929
1058
  * @param {object} [options]
930
1059
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
931
1060
  * @returns {Stream}
@@ -979,13 +1108,18 @@ class ConversationalSearchServiceClient {
979
1108
  * A comma-separated list of fields to order by, sorted in ascending order.
980
1109
  * Use "desc" after a field name for descending.
981
1110
  * Supported fields:
1111
+ *
982
1112
  * * `update_time`
983
1113
  * * `create_time`
984
1114
  * * `session_name`
1115
+ * * `is_pinned`
985
1116
  *
986
1117
  * Example:
987
- * "update_time desc"
988
- * "create_time"
1118
+ *
1119
+ * * "update_time desc"
1120
+ * * "create_time"
1121
+ * * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
1122
+ * by update_time.
989
1123
  * @param {object} [options]
990
1124
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
991
1125
  * @returns {Object}
@@ -1991,6 +2125,75 @@ class ConversationalSearchServiceClient {
1991
2125
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1992
2126
  return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
1993
2127
  }
2128
+ /**
2129
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
2130
+ *
2131
+ * @param {string} project
2132
+ * @param {string} location
2133
+ * @param {string} collection
2134
+ * @param {string} data_store
2135
+ * @param {string} sitemap
2136
+ * @returns {string} Resource name string.
2137
+ */
2138
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project, location, collection, dataStore, sitemap) {
2139
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.render({
2140
+ project: project,
2141
+ location: location,
2142
+ collection: collection,
2143
+ data_store: dataStore,
2144
+ sitemap: sitemap,
2145
+ });
2146
+ }
2147
+ /**
2148
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2149
+ *
2150
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2151
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2152
+ * @returns {string} A string representing the project.
2153
+ */
2154
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2155
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).project;
2156
+ }
2157
+ /**
2158
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2159
+ *
2160
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2161
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2162
+ * @returns {string} A string representing the location.
2163
+ */
2164
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2165
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).location;
2166
+ }
2167
+ /**
2168
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2169
+ *
2170
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2171
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2172
+ * @returns {string} A string representing the collection.
2173
+ */
2174
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2175
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).collection;
2176
+ }
2177
+ /**
2178
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2179
+ *
2180
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2181
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2182
+ * @returns {string} A string representing the data_store.
2183
+ */
2184
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2185
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).data_store;
2186
+ }
2187
+ /**
2188
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2189
+ *
2190
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2191
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2192
+ * @returns {string} A string representing the sitemap.
2193
+ */
2194
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2195
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).sitemap;
2196
+ }
1994
2197
  /**
1995
2198
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1996
2199
  *
@@ -3113,6 +3316,63 @@ class ConversationalSearchServiceClient {
3113
3316
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
3114
3317
  return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
3115
3318
  }
3319
+ /**
3320
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
3321
+ *
3322
+ * @param {string} project
3323
+ * @param {string} location
3324
+ * @param {string} data_store
3325
+ * @param {string} sitemap
3326
+ * @returns {string} Resource name string.
3327
+ */
3328
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project, location, dataStore, sitemap) {
3329
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.render({
3330
+ project: project,
3331
+ location: location,
3332
+ data_store: dataStore,
3333
+ sitemap: sitemap,
3334
+ });
3335
+ }
3336
+ /**
3337
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3338
+ *
3339
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3340
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3341
+ * @returns {string} A string representing the project.
3342
+ */
3343
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3344
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).project;
3345
+ }
3346
+ /**
3347
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3348
+ *
3349
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3350
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3351
+ * @returns {string} A string representing the location.
3352
+ */
3353
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3354
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).location;
3355
+ }
3356
+ /**
3357
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3358
+ *
3359
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3360
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3361
+ * @returns {string} A string representing the data_store.
3362
+ */
3363
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3364
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).data_store;
3365
+ }
3366
+ /**
3367
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3368
+ *
3369
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3370
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3371
+ * @returns {string} A string representing the sitemap.
3372
+ */
3373
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3374
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).sitemap;
3375
+ }
3116
3376
  /**
3117
3377
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
3118
3378
  *
@@ -67,6 +67,11 @@
67
67
  "retry_codes_name": "unavailable",
68
68
  "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
69
69
  },
70
+ "StreamAnswerQuery": {
71
+ "timeout_millis": 30000,
72
+ "retry_codes_name": "unavailable",
73
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
74
+ },
70
75
  "GetAnswer": {
71
76
  "timeout_millis": 30000,
72
77
  "retry_codes_name": "unavailable",
@@ -24,10 +24,13 @@
24
24
  "../../protos/google/cloud/discoveryengine/v1/purge_config.proto",
25
25
  "../../protos/google/cloud/discoveryengine/v1/rank_service.proto",
26
26
  "../../protos/google/cloud/discoveryengine/v1/recommendation_service.proto",
27
+ "../../protos/google/cloud/discoveryengine/v1/safety.proto",
27
28
  "../../protos/google/cloud/discoveryengine/v1/schema.proto",
28
29
  "../../protos/google/cloud/discoveryengine/v1/schema_service.proto",
29
30
  "../../protos/google/cloud/discoveryengine/v1/search_service.proto",
30
31
  "../../protos/google/cloud/discoveryengine/v1/search_tuning_service.proto",
32
+ "../../protos/google/cloud/discoveryengine/v1/serving_config.proto",
33
+ "../../protos/google/cloud/discoveryengine/v1/serving_config_service.proto",
31
34
  "../../protos/google/cloud/discoveryengine/v1/session.proto",
32
35
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
33
36
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
@@ -1126,6 +1126,57 @@ export declare class DataStoreServiceClient {
1126
1126
  * @returns {string} A string representing the schema.
1127
1127
  */
1128
1128
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1129
+ /**
1130
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
1131
+ *
1132
+ * @param {string} project
1133
+ * @param {string} location
1134
+ * @param {string} collection
1135
+ * @param {string} data_store
1136
+ * @param {string} serving_config
1137
+ * @returns {string} Resource name string.
1138
+ */
1139
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
1140
+ /**
1141
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
1142
+ *
1143
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1144
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1145
+ * @returns {string} A string representing the project.
1146
+ */
1147
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1148
+ /**
1149
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
1150
+ *
1151
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1152
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1153
+ * @returns {string} A string representing the location.
1154
+ */
1155
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1156
+ /**
1157
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
1158
+ *
1159
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1160
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1161
+ * @returns {string} A string representing the collection.
1162
+ */
1163
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1164
+ /**
1165
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
1166
+ *
1167
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1168
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1169
+ * @returns {string} A string representing the data_store.
1170
+ */
1171
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1172
+ /**
1173
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
1174
+ *
1175
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1176
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1177
+ * @returns {string} A string representing the serving_config.
1178
+ */
1179
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1129
1180
  /**
1130
1181
  * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
1131
1182
  *
@@ -1279,6 +1330,57 @@ export declare class DataStoreServiceClient {
1279
1330
  * @returns {string} A string representing the data_store.
1280
1331
  */
1281
1332
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1333
+ /**
1334
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
1335
+ *
1336
+ * @param {string} project
1337
+ * @param {string} location
1338
+ * @param {string} collection
1339
+ * @param {string} data_store
1340
+ * @param {string} sitemap
1341
+ * @returns {string} Resource name string.
1342
+ */
1343
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
1344
+ /**
1345
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1346
+ *
1347
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1348
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1349
+ * @returns {string} A string representing the project.
1350
+ */
1351
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1352
+ /**
1353
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1354
+ *
1355
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1356
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1357
+ * @returns {string} A string representing the location.
1358
+ */
1359
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1360
+ /**
1361
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1362
+ *
1363
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1364
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1365
+ * @returns {string} A string representing the collection.
1366
+ */
1367
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1368
+ /**
1369
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1370
+ *
1371
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1372
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1373
+ * @returns {string} A string representing the data_store.
1374
+ */
1375
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1376
+ /**
1377
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1378
+ *
1379
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1380
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1381
+ * @returns {string} A string representing the sitemap.
1382
+ */
1383
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1282
1384
  /**
1283
1385
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1284
1386
  *
@@ -1432,6 +1534,57 @@ export declare class DataStoreServiceClient {
1432
1534
  * @returns {string} A string representing the conversation.
1433
1535
  */
1434
1536
  matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1537
+ /**
1538
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1539
+ *
1540
+ * @param {string} project
1541
+ * @param {string} location
1542
+ * @param {string} collection
1543
+ * @param {string} engine
1544
+ * @param {string} serving_config
1545
+ * @returns {string} Resource name string.
1546
+ */
1547
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
1548
+ /**
1549
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1550
+ *
1551
+ * @param {string} projectLocationCollectionEngineServingConfigName
1552
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1553
+ * @returns {string} A string representing the project.
1554
+ */
1555
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1556
+ /**
1557
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1558
+ *
1559
+ * @param {string} projectLocationCollectionEngineServingConfigName
1560
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1561
+ * @returns {string} A string representing the location.
1562
+ */
1563
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1564
+ /**
1565
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1566
+ *
1567
+ * @param {string} projectLocationCollectionEngineServingConfigName
1568
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1569
+ * @returns {string} A string representing the collection.
1570
+ */
1571
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1572
+ /**
1573
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1574
+ *
1575
+ * @param {string} projectLocationCollectionEngineServingConfigName
1576
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1577
+ * @returns {string} A string representing the engine.
1578
+ */
1579
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1580
+ /**
1581
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1582
+ *
1583
+ * @param {string} projectLocationCollectionEngineServingConfigName
1584
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1585
+ * @returns {string} A string representing the serving_config.
1586
+ */
1587
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1435
1588
  /**
1436
1589
  * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
1437
1590
  *
@@ -1888,6 +2041,48 @@ export declare class DataStoreServiceClient {
1888
2041
  * @returns {string} A string representing the schema.
1889
2042
  */
1890
2043
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
2044
+ /**
2045
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
2046
+ *
2047
+ * @param {string} project
2048
+ * @param {string} location
2049
+ * @param {string} data_store
2050
+ * @param {string} serving_config
2051
+ * @returns {string} Resource name string.
2052
+ */
2053
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
2054
+ /**
2055
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
2056
+ *
2057
+ * @param {string} projectLocationDataStoreServingConfigName
2058
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2059
+ * @returns {string} A string representing the project.
2060
+ */
2061
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2062
+ /**
2063
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
2064
+ *
2065
+ * @param {string} projectLocationDataStoreServingConfigName
2066
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2067
+ * @returns {string} A string representing the location.
2068
+ */
2069
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2070
+ /**
2071
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
2072
+ *
2073
+ * @param {string} projectLocationDataStoreServingConfigName
2074
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2075
+ * @returns {string} A string representing the data_store.
2076
+ */
2077
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2078
+ /**
2079
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
2080
+ *
2081
+ * @param {string} projectLocationDataStoreServingConfigName
2082
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2083
+ * @returns {string} A string representing the serving_config.
2084
+ */
2085
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1891
2086
  /**
1892
2087
  * Return a fully-qualified projectLocationDataStoreSession resource name string.
1893
2088
  *
@@ -2014,6 +2209,48 @@ export declare class DataStoreServiceClient {
2014
2209
  * @returns {string} A string representing the data_store.
2015
2210
  */
2016
2211
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
2212
+ /**
2213
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
2214
+ *
2215
+ * @param {string} project
2216
+ * @param {string} location
2217
+ * @param {string} data_store
2218
+ * @param {string} sitemap
2219
+ * @returns {string} Resource name string.
2220
+ */
2221
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
2222
+ /**
2223
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2224
+ *
2225
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2226
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2227
+ * @returns {string} A string representing the project.
2228
+ */
2229
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2230
+ /**
2231
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2232
+ *
2233
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2234
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2235
+ * @returns {string} A string representing the location.
2236
+ */
2237
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2238
+ /**
2239
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2240
+ *
2241
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2242
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2243
+ * @returns {string} A string representing the data_store.
2244
+ */
2245
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2246
+ /**
2247
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2248
+ *
2249
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2250
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2251
+ * @returns {string} A string representing the sitemap.
2252
+ */
2253
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2017
2254
  /**
2018
2255
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
2019
2256
  *