@google-cloud/discoveryengine 0.8.0 → 1.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.
- package/CHANGELOG.md +30 -0
- package/README.md +13 -1
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +30 -2
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +303 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +8 -5
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +4 -3
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +27 -23
- package/build/protos/google/cloud/discoveryengine/v1/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +428 -20
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +48 -39
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +7 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +13 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +138 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +2 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +17 -17
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +276 -64
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +45 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +13913 -8367
- package/build/protos/protos.js +36766 -22883
- package/build/protos/protos.json +3956 -2571
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +4 -1
- package/build/src/v1/completion_service_client.d.ts +161 -12
- package/build/src/v1/completion_service_client.js +188 -4
- package/build/src/v1/conversational_search_service_client.d.ts +947 -0
- package/build/src/v1/conversational_search_service_client.js +1205 -0
- package/build/src/v1/conversational_search_service_client_config.json +68 -0
- package/build/src/v1/document_service_client.d.ts +245 -109
- package/build/src/v1/document_service_client.js +231 -31
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +3 -1
- package/build/src/v1/schema_service_client.d.ts +187 -53
- package/build/src/v1/schema_service_client.js +224 -27
- package/build/src/v1/search_service_client.d.ts +266 -59
- package/build/src/v1/search_service_client.js +267 -41
- package/build/src/v1/user_event_service_client.d.ts +159 -19
- package/build/src/v1/user_event_service_client.js +208 -7
- package/build/src/v1beta/completion_service_client.d.ts +159 -12
- package/build/src/v1beta/completion_service_client.js +188 -4
- package/build/src/v1beta/conversational_search_service_client.d.ts +947 -0
- package/build/src/v1beta/conversational_search_service_client.js +1205 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +237 -101
- package/build/src/v1beta/document_service_client.js +227 -27
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +158 -15
- package/build/src/v1beta/recommendation_service_client.js +188 -4
- package/build/src/v1beta/schema_service_client.d.ts +187 -53
- package/build/src/v1beta/schema_service_client.js +224 -27
- package/build/src/v1beta/search_service_client.d.ts +305 -71
- package/build/src/v1beta/search_service_client.js +293 -49
- package/build/src/v1beta/user_event_service_client.d.ts +156 -16
- package/build/src/v1beta/user_event_service_client.js +208 -7
- package/package.json +10 -13
@@ -1,10 +1,10 @@
|
|
1
1
|
/// <reference types="node" />
|
2
2
|
import type * as gax from 'google-gax';
|
3
|
-
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
|
3
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
|
4
4
|
import { Transform } from 'stream';
|
5
5
|
import * as protos from '../../protos/protos';
|
6
6
|
/**
|
7
|
-
* Service for managing {@link google.cloud.discoveryengine.v1.Schema|Schema}s.
|
7
|
+
* Service for managing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s.
|
8
8
|
* @class
|
9
9
|
* @memberof v1
|
10
10
|
*/
|
@@ -22,6 +22,7 @@ export declare class SchemaServiceClient {
|
|
22
22
|
innerApiCalls: {
|
23
23
|
[name: string]: Function;
|
24
24
|
};
|
25
|
+
locationsClient: LocationsClient;
|
25
26
|
pathTemplates: {
|
26
27
|
[name: string]: gax.PathTemplate;
|
27
28
|
};
|
@@ -57,8 +58,7 @@ export declare class SchemaServiceClient {
|
|
57
58
|
* API remote host.
|
58
59
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
59
60
|
* Follows the structure of {@link gapicConfig}.
|
60
|
-
* @param {boolean
|
61
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
61
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
62
62
|
* For more information, please check the
|
63
63
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
64
64
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
@@ -66,7 +66,7 @@ export declare class SchemaServiceClient {
|
|
66
66
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
67
67
|
* ```
|
68
68
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
69
|
-
* const client = new SchemaServiceClient({fallback:
|
69
|
+
* const client = new SchemaServiceClient({fallback: true}, gax);
|
70
70
|
* ```
|
71
71
|
*/
|
72
72
|
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
@@ -109,7 +109,7 @@ export declare class SchemaServiceClient {
|
|
109
109
|
getProjectId(): Promise<string>;
|
110
110
|
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
111
111
|
/**
|
112
|
-
* Gets a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
112
|
+
* Gets a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
113
113
|
*
|
114
114
|
* @param {Object} request
|
115
115
|
* The request object that will be sent.
|
@@ -119,9 +119,8 @@ export declare class SchemaServiceClient {
|
|
119
119
|
* @param {object} [options]
|
120
120
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
121
121
|
* @returns {Promise} - The promise which resolves to an array.
|
122
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Schema
|
123
|
-
* Please see the
|
124
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
122
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
123
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
125
124
|
* for more details and examples.
|
126
125
|
* @example <caption>include:samples/generated/v1/schema_service.get_schema.js</caption>
|
127
126
|
* region_tag:discoveryengine_v1_generated_SchemaService_GetSchema_async
|
@@ -134,7 +133,7 @@ export declare class SchemaServiceClient {
|
|
134
133
|
getSchema(request: protos.google.cloud.discoveryengine.v1.IGetSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.ISchema, protos.google.cloud.discoveryengine.v1.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
135
134
|
getSchema(request: protos.google.cloud.discoveryengine.v1.IGetSchemaRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.ISchema, protos.google.cloud.discoveryengine.v1.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
136
135
|
/**
|
137
|
-
* Creates a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
136
|
+
* Creates a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
138
137
|
*
|
139
138
|
* @param {Object} request
|
140
139
|
* The request object that will be sent.
|
@@ -142,12 +141,12 @@ export declare class SchemaServiceClient {
|
|
142
141
|
* Required. The parent data store resource name, in the format of
|
143
142
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
144
143
|
* @param {google.cloud.discoveryengine.v1.Schema} request.schema
|
145
|
-
* Required. The {@link google.cloud.discoveryengine.v1.Schema|Schema} to create.
|
144
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} to create.
|
146
145
|
* @param {string} request.schemaId
|
147
146
|
* Required. The ID to use for the
|
148
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}, which will become the
|
147
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}, which will become the
|
149
148
|
* final component of the
|
150
|
-
* {@link google.cloud.discoveryengine.v1.Schema.name|Schema.name}.
|
149
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema.name|Schema.name}.
|
151
150
|
*
|
152
151
|
* This field should conform to
|
153
152
|
* [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
|
@@ -158,8 +157,7 @@ export declare class SchemaServiceClient {
|
|
158
157
|
* The first element of the array is an object representing
|
159
158
|
* a long running operation. Its `promise()` method returns a promise
|
160
159
|
* you can `await` for.
|
161
|
-
* Please see the
|
162
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
160
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
163
161
|
* for more details and examples.
|
164
162
|
* @example <caption>include:samples/generated/v1/schema_service.create_schema.js</caption>
|
165
163
|
* region_tag:discoveryengine_v1_generated_SchemaService_CreateSchema_async
|
@@ -177,23 +175,22 @@ export declare class SchemaServiceClient {
|
|
177
175
|
* The operation name that will be passed.
|
178
176
|
* @returns {Promise} - The promise which resolves to an object.
|
179
177
|
* The decoded operation object has result and metadata field to get information from.
|
180
|
-
* Please see the
|
181
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
178
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
182
179
|
* for more details and examples.
|
183
180
|
* @example <caption>include:samples/generated/v1/schema_service.create_schema.js</caption>
|
184
181
|
* region_tag:discoveryengine_v1_generated_SchemaService_CreateSchema_async
|
185
182
|
*/
|
186
183
|
checkCreateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.Schema, protos.google.cloud.discoveryengine.v1.CreateSchemaMetadata>>;
|
187
184
|
/**
|
188
|
-
* Updates a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
185
|
+
* Updates a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
189
186
|
*
|
190
187
|
* @param {Object} request
|
191
188
|
* The request object that will be sent.
|
192
189
|
* @param {google.cloud.discoveryengine.v1.Schema} request.schema
|
193
|
-
* Required. The {@link google.cloud.discoveryengine.v1.Schema|Schema} to update.
|
190
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} to update.
|
194
191
|
* @param {boolean} request.allowMissing
|
195
|
-
* If set to true, and the {@link google.cloud.discoveryengine.v1.Schema|Schema} is
|
196
|
-
* not found, a new {@link google.cloud.discoveryengine.v1.Schema|Schema} will be
|
192
|
+
* If set to true, and the {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} is
|
193
|
+
* not found, a new {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} will be
|
197
194
|
* created. In this situation, `update_mask` is ignored.
|
198
195
|
* @param {object} [options]
|
199
196
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
@@ -201,8 +198,7 @@ export declare class SchemaServiceClient {
|
|
201
198
|
* The first element of the array is an object representing
|
202
199
|
* a long running operation. Its `promise()` method returns a promise
|
203
200
|
* you can `await` for.
|
204
|
-
* Please see the
|
205
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
201
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
206
202
|
* for more details and examples.
|
207
203
|
* @example <caption>include:samples/generated/v1/schema_service.update_schema.js</caption>
|
208
204
|
* region_tag:discoveryengine_v1_generated_SchemaService_UpdateSchema_async
|
@@ -220,15 +216,14 @@ export declare class SchemaServiceClient {
|
|
220
216
|
* The operation name that will be passed.
|
221
217
|
* @returns {Promise} - The promise which resolves to an object.
|
222
218
|
* The decoded operation object has result and metadata field to get information from.
|
223
|
-
* Please see the
|
224
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
219
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
225
220
|
* for more details and examples.
|
226
221
|
* @example <caption>include:samples/generated/v1/schema_service.update_schema.js</caption>
|
227
222
|
* region_tag:discoveryengine_v1_generated_SchemaService_UpdateSchema_async
|
228
223
|
*/
|
229
224
|
checkUpdateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.Schema, protos.google.cloud.discoveryengine.v1.UpdateSchemaMetadata>>;
|
230
225
|
/**
|
231
|
-
* Deletes a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
226
|
+
* Deletes a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
232
227
|
*
|
233
228
|
* @param {Object} request
|
234
229
|
* The request object that will be sent.
|
@@ -241,8 +236,7 @@ export declare class SchemaServiceClient {
|
|
241
236
|
* The first element of the array is an object representing
|
242
237
|
* a long running operation. Its `promise()` method returns a promise
|
243
238
|
* you can `await` for.
|
244
|
-
* Please see the
|
245
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
239
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
246
240
|
* for more details and examples.
|
247
241
|
* @example <caption>include:samples/generated/v1/schema_service.delete_schema.js</caption>
|
248
242
|
* region_tag:discoveryengine_v1_generated_SchemaService_DeleteSchema_async
|
@@ -260,15 +254,14 @@ export declare class SchemaServiceClient {
|
|
260
254
|
* The operation name that will be passed.
|
261
255
|
* @returns {Promise} - The promise which resolves to an object.
|
262
256
|
* The decoded operation object has result and metadata field to get information from.
|
263
|
-
* Please see the
|
264
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
257
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
265
258
|
* for more details and examples.
|
266
259
|
* @example <caption>include:samples/generated/v1/schema_service.delete_schema.js</caption>
|
267
260
|
* region_tag:discoveryengine_v1_generated_SchemaService_DeleteSchema_async
|
268
261
|
*/
|
269
262
|
checkDeleteSchemaProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1.DeleteSchemaMetadata>>;
|
270
263
|
/**
|
271
|
-
* Gets a list of {@link google.cloud.discoveryengine.v1.Schema|Schema}s.
|
264
|
+
* Gets a list of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s.
|
272
265
|
*
|
273
266
|
* @param {Object} request
|
274
267
|
* The request object that will be sent.
|
@@ -276,32 +269,31 @@ export declare class SchemaServiceClient {
|
|
276
269
|
* Required. The parent data store resource name, in the format of
|
277
270
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
278
271
|
* @param {number} request.pageSize
|
279
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
272
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
280
273
|
* return. The service may return fewer than this value.
|
281
274
|
*
|
282
275
|
* If unspecified, at most 100
|
283
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
276
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
284
277
|
*
|
285
278
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
286
279
|
* @param {string} request.pageToken
|
287
280
|
* A page token, received from a previous
|
288
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
281
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
289
282
|
* call. Provide this to retrieve the subsequent page.
|
290
283
|
*
|
291
284
|
* When paginating, all other parameters provided to
|
292
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
285
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
293
286
|
* must match the call that provided the page token.
|
294
287
|
* @param {object} [options]
|
295
288
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
296
289
|
* @returns {Promise} - The promise which resolves to an array.
|
297
|
-
* The first element of the array is Array of {@link google.cloud.discoveryengine.v1.Schema
|
290
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
298
291
|
* The client library will perform auto-pagination by default: it will call the API as many
|
299
292
|
* times as needed and will merge results from all the pages into this array.
|
300
293
|
* Note that it can affect your quota.
|
301
294
|
* We recommend using `listSchemasAsync()`
|
302
295
|
* method described below for async iteration which you can stop as needed.
|
303
|
-
* Please see the
|
304
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
296
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
305
297
|
* for more details and examples.
|
306
298
|
*/
|
307
299
|
listSchemas(request?: protos.google.cloud.discoveryengine.v1.IListSchemasRequest, options?: CallOptions): Promise<[
|
@@ -319,31 +311,30 @@ export declare class SchemaServiceClient {
|
|
319
311
|
* Required. The parent data store resource name, in the format of
|
320
312
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
321
313
|
* @param {number} request.pageSize
|
322
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
314
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
323
315
|
* return. The service may return fewer than this value.
|
324
316
|
*
|
325
317
|
* If unspecified, at most 100
|
326
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
318
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
327
319
|
*
|
328
320
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
329
321
|
* @param {string} request.pageToken
|
330
322
|
* A page token, received from a previous
|
331
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
323
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
332
324
|
* call. Provide this to retrieve the subsequent page.
|
333
325
|
*
|
334
326
|
* When paginating, all other parameters provided to
|
335
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
327
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
336
328
|
* must match the call that provided the page token.
|
337
329
|
* @param {object} [options]
|
338
330
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
339
331
|
* @returns {Stream}
|
340
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Schema
|
332
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} on 'data' event.
|
341
333
|
* The client library will perform auto-pagination by default: it will call the API as many
|
342
334
|
* times as needed. Note that it can affect your quota.
|
343
335
|
* We recommend using `listSchemasAsync()`
|
344
336
|
* method described below for async iteration which you can stop as needed.
|
345
|
-
* Please see the
|
346
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
337
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
347
338
|
* for more details and examples.
|
348
339
|
*/
|
349
340
|
listSchemasStream(request?: protos.google.cloud.discoveryengine.v1.IListSchemasRequest, options?: CallOptions): Transform;
|
@@ -357,35 +348,85 @@ export declare class SchemaServiceClient {
|
|
357
348
|
* Required. The parent data store resource name, in the format of
|
358
349
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
359
350
|
* @param {number} request.pageSize
|
360
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
351
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
361
352
|
* return. The service may return fewer than this value.
|
362
353
|
*
|
363
354
|
* If unspecified, at most 100
|
364
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
355
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
365
356
|
*
|
366
357
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
367
358
|
* @param {string} request.pageToken
|
368
359
|
* A page token, received from a previous
|
369
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
360
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
370
361
|
* call. Provide this to retrieve the subsequent page.
|
371
362
|
*
|
372
363
|
* When paginating, all other parameters provided to
|
373
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
364
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
374
365
|
* must match the call that provided the page token.
|
375
366
|
* @param {object} [options]
|
376
367
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
377
368
|
* @returns {Object}
|
378
|
-
* An iterable Object that allows
|
369
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
379
370
|
* When you iterate the returned iterable, each element will be an object representing
|
380
|
-
* {@link google.cloud.discoveryengine.v1.Schema
|
371
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}. The API will be called under the hood as needed, once per the page,
|
381
372
|
* so you can stop the iteration when you don't need more results.
|
382
|
-
* Please see the
|
383
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
373
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
384
374
|
* for more details and examples.
|
385
375
|
* @example <caption>include:samples/generated/v1/schema_service.list_schemas.js</caption>
|
386
376
|
* region_tag:discoveryengine_v1_generated_SchemaService_ListSchemas_async
|
387
377
|
*/
|
388
378
|
listSchemasAsync(request?: protos.google.cloud.discoveryengine.v1.IListSchemasRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.ISchema>;
|
379
|
+
/**
|
380
|
+
* Gets information about a location.
|
381
|
+
*
|
382
|
+
* @param {Object} request
|
383
|
+
* The request object that will be sent.
|
384
|
+
* @param {string} request.name
|
385
|
+
* Resource name for the location.
|
386
|
+
* @param {object} [options]
|
387
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
388
|
+
* @returns {Promise} - The promise which resolves to an array.
|
389
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
390
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
391
|
+
* for more details and examples.
|
392
|
+
* @example
|
393
|
+
* ```
|
394
|
+
* const [response] = await client.getLocation(request);
|
395
|
+
* ```
|
396
|
+
*/
|
397
|
+
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>;
|
398
|
+
/**
|
399
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
400
|
+
*
|
401
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
402
|
+
* @param {Object} request
|
403
|
+
* The request object that will be sent.
|
404
|
+
* @param {string} request.name
|
405
|
+
* The resource that owns the locations collection, if applicable.
|
406
|
+
* @param {string} request.filter
|
407
|
+
* The standard list filter.
|
408
|
+
* @param {number} request.pageSize
|
409
|
+
* The standard list page size.
|
410
|
+
* @param {string} request.pageToken
|
411
|
+
* The standard list page token.
|
412
|
+
* @param {object} [options]
|
413
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
414
|
+
* @returns {Object}
|
415
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
416
|
+
* When you iterate the returned iterable, each element will be an object representing
|
417
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
418
|
+
* so you can stop the iteration when you don't need more results.
|
419
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
420
|
+
* for more details and examples.
|
421
|
+
* @example
|
422
|
+
* ```
|
423
|
+
* const iterable = client.listLocationsAsync(request);
|
424
|
+
* for await (const response of iterable) {
|
425
|
+
* // process response
|
426
|
+
* }
|
427
|
+
* ```
|
428
|
+
*/
|
429
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
389
430
|
/**
|
390
431
|
* Gets the latest state of a long-running operation. Clients can use this
|
391
432
|
* method to poll the operation result at intervals as recommended by the API
|
@@ -608,6 +649,57 @@ export declare class SchemaServiceClient {
|
|
608
649
|
* @returns {string} A string representing the document.
|
609
650
|
*/
|
610
651
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
652
|
+
/**
|
653
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
654
|
+
*
|
655
|
+
* @param {string} project
|
656
|
+
* @param {string} location
|
657
|
+
* @param {string} collection
|
658
|
+
* @param {string} data_store
|
659
|
+
* @param {string} conversation
|
660
|
+
* @returns {string} Resource name string.
|
661
|
+
*/
|
662
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
663
|
+
/**
|
664
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
665
|
+
*
|
666
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
667
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
668
|
+
* @returns {string} A string representing the project.
|
669
|
+
*/
|
670
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
671
|
+
/**
|
672
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
673
|
+
*
|
674
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
675
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
676
|
+
* @returns {string} A string representing the location.
|
677
|
+
*/
|
678
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
679
|
+
/**
|
680
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
681
|
+
*
|
682
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
683
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
684
|
+
* @returns {string} A string representing the collection.
|
685
|
+
*/
|
686
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
687
|
+
/**
|
688
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
689
|
+
*
|
690
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
691
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
692
|
+
* @returns {string} A string representing the data_store.
|
693
|
+
*/
|
694
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
695
|
+
/**
|
696
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
697
|
+
*
|
698
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
699
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
700
|
+
* @returns {string} A string representing the conversation.
|
701
|
+
*/
|
702
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
611
703
|
/**
|
612
704
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
613
705
|
*
|
@@ -743,6 +835,48 @@ export declare class SchemaServiceClient {
|
|
743
835
|
* @returns {string} A string representing the document.
|
744
836
|
*/
|
745
837
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
838
|
+
/**
|
839
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
840
|
+
*
|
841
|
+
* @param {string} project
|
842
|
+
* @param {string} location
|
843
|
+
* @param {string} data_store
|
844
|
+
* @param {string} conversation
|
845
|
+
* @returns {string} Resource name string.
|
846
|
+
*/
|
847
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
848
|
+
/**
|
849
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
850
|
+
*
|
851
|
+
* @param {string} projectLocationDataStoreConversationName
|
852
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
853
|
+
* @returns {string} A string representing the project.
|
854
|
+
*/
|
855
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
856
|
+
/**
|
857
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
858
|
+
*
|
859
|
+
* @param {string} projectLocationDataStoreConversationName
|
860
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
861
|
+
* @returns {string} A string representing the location.
|
862
|
+
*/
|
863
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
864
|
+
/**
|
865
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
866
|
+
*
|
867
|
+
* @param {string} projectLocationDataStoreConversationName
|
868
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
869
|
+
* @returns {string} A string representing the data_store.
|
870
|
+
*/
|
871
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
872
|
+
/**
|
873
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
874
|
+
*
|
875
|
+
* @param {string} projectLocationDataStoreConversationName
|
876
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
877
|
+
* @returns {string} A string representing the conversation.
|
878
|
+
*/
|
879
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
746
880
|
/**
|
747
881
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
748
882
|
*
|