@google-cloud/discoveryengine 0.8.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- 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.v1beta.Schema|Schema}s.
|
7
|
+
* Service for managing {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s.
|
8
8
|
* @class
|
9
9
|
* @memberof v1beta
|
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.v1beta.Schema|Schema}.
|
112
|
+
* Gets a {@link protos.google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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/v1beta/schema_service.get_schema.js</caption>
|
127
126
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_GetSchema_async
|
@@ -134,7 +133,7 @@ export declare class SchemaServiceClient {
|
|
134
133
|
getSchema(request: protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISchema, protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
135
134
|
getSchema(request: protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISchema, protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
136
135
|
/**
|
137
|
-
* Creates a {@link google.cloud.discoveryengine.v1beta.Schema|Schema}.
|
136
|
+
* Creates a {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
|
138
137
|
*
|
139
138
|
* @param {Object} request
|
140
139
|
* The request object that will be sent.
|
@@ -142,13 +141,13 @@ 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.v1beta.Schema} request.schema
|
145
|
-
* Required. The {@link google.cloud.discoveryengine.v1beta.Schema|Schema} to
|
144
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} to
|
146
145
|
* create.
|
147
146
|
* @param {string} request.schemaId
|
148
147
|
* Required. The ID to use for the
|
149
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema|Schema}, which will become the
|
148
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}, which will become the
|
150
149
|
* final component of the
|
151
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema.name|Schema.name}.
|
150
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema.name|Schema.name}.
|
152
151
|
*
|
153
152
|
* This field should conform to
|
154
153
|
* [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
|
@@ -159,8 +158,7 @@ export declare class SchemaServiceClient {
|
|
159
158
|
* The first element of the array is an object representing
|
160
159
|
* a long running operation. Its `promise()` method returns a promise
|
161
160
|
* you can `await` for.
|
162
|
-
* Please see the
|
163
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
161
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
164
162
|
* for more details and examples.
|
165
163
|
* @example <caption>include:samples/generated/v1beta/schema_service.create_schema.js</caption>
|
166
164
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_CreateSchema_async
|
@@ -178,25 +176,24 @@ export declare class SchemaServiceClient {
|
|
178
176
|
* The operation name that will be passed.
|
179
177
|
* @returns {Promise} - The promise which resolves to an object.
|
180
178
|
* The decoded operation object has result and metadata field to get information from.
|
181
|
-
* Please see the
|
182
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
179
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
183
180
|
* for more details and examples.
|
184
181
|
* @example <caption>include:samples/generated/v1beta/schema_service.create_schema.js</caption>
|
185
182
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_CreateSchema_async
|
186
183
|
*/
|
187
184
|
checkCreateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.Schema, protos.google.cloud.discoveryengine.v1beta.CreateSchemaMetadata>>;
|
188
185
|
/**
|
189
|
-
* Updates a {@link google.cloud.discoveryengine.v1beta.Schema|Schema}.
|
186
|
+
* Updates a {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
|
190
187
|
*
|
191
188
|
* @param {Object} request
|
192
189
|
* The request object that will be sent.
|
193
190
|
* @param {google.cloud.discoveryengine.v1beta.Schema} request.schema
|
194
|
-
* Required. The {@link google.cloud.discoveryengine.v1beta.Schema|Schema} to
|
191
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} to
|
195
192
|
* update.
|
196
193
|
* @param {boolean} request.allowMissing
|
197
194
|
* If set to true, and the
|
198
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema|Schema} is not found, a new
|
199
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema|Schema} will be created. In
|
195
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} is not found, a new
|
196
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} will be created. In
|
200
197
|
* this situation, `update_mask` is ignored.
|
201
198
|
* @param {object} [options]
|
202
199
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
@@ -204,8 +201,7 @@ export declare class SchemaServiceClient {
|
|
204
201
|
* The first element of the array is an object representing
|
205
202
|
* a long running operation. Its `promise()` method returns a promise
|
206
203
|
* you can `await` for.
|
207
|
-
* Please see the
|
208
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
204
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
209
205
|
* for more details and examples.
|
210
206
|
* @example <caption>include:samples/generated/v1beta/schema_service.update_schema.js</caption>
|
211
207
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_UpdateSchema_async
|
@@ -223,15 +219,14 @@ export declare class SchemaServiceClient {
|
|
223
219
|
* The operation name that will be passed.
|
224
220
|
* @returns {Promise} - The promise which resolves to an object.
|
225
221
|
* The decoded operation object has result and metadata field to get information from.
|
226
|
-
* Please see the
|
227
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
222
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
228
223
|
* for more details and examples.
|
229
224
|
* @example <caption>include:samples/generated/v1beta/schema_service.update_schema.js</caption>
|
230
225
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_UpdateSchema_async
|
231
226
|
*/
|
232
227
|
checkUpdateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.Schema, protos.google.cloud.discoveryengine.v1beta.UpdateSchemaMetadata>>;
|
233
228
|
/**
|
234
|
-
* Deletes a {@link google.cloud.discoveryengine.v1beta.Schema|Schema}.
|
229
|
+
* Deletes a {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
|
235
230
|
*
|
236
231
|
* @param {Object} request
|
237
232
|
* The request object that will be sent.
|
@@ -244,8 +239,7 @@ export declare class SchemaServiceClient {
|
|
244
239
|
* The first element of the array is an object representing
|
245
240
|
* a long running operation. Its `promise()` method returns a promise
|
246
241
|
* you can `await` for.
|
247
|
-
* Please see the
|
248
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
242
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
249
243
|
* for more details and examples.
|
250
244
|
* @example <caption>include:samples/generated/v1beta/schema_service.delete_schema.js</caption>
|
251
245
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_DeleteSchema_async
|
@@ -263,15 +257,14 @@ export declare class SchemaServiceClient {
|
|
263
257
|
* The operation name that will be passed.
|
264
258
|
* @returns {Promise} - The promise which resolves to an object.
|
265
259
|
* The decoded operation object has result and metadata field to get information from.
|
266
|
-
* Please see the
|
267
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
260
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
268
261
|
* for more details and examples.
|
269
262
|
* @example <caption>include:samples/generated/v1beta/schema_service.delete_schema.js</caption>
|
270
263
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_DeleteSchema_async
|
271
264
|
*/
|
272
265
|
checkDeleteSchemaProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1beta.DeleteSchemaMetadata>>;
|
273
266
|
/**
|
274
|
-
* Gets a list of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s.
|
267
|
+
* Gets a list of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s.
|
275
268
|
*
|
276
269
|
* @param {Object} request
|
277
270
|
* The request object that will be sent.
|
@@ -279,32 +272,31 @@ export declare class SchemaServiceClient {
|
|
279
272
|
* Required. The parent data store resource name, in the format of
|
280
273
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
281
274
|
* @param {number} request.pageSize
|
282
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s
|
275
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s
|
283
276
|
* to return. The service may return fewer than this value.
|
284
277
|
*
|
285
278
|
* If unspecified, at most 100
|
286
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
|
279
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
|
287
280
|
*
|
288
281
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
289
282
|
* @param {string} request.pageToken
|
290
283
|
* A page token, received from a previous
|
291
|
-
* {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
284
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
292
285
|
* call. Provide this to retrieve the subsequent page.
|
293
286
|
*
|
294
287
|
* When paginating, all other parameters provided to
|
295
|
-
* {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
288
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
296
289
|
* must match the call that provided the page token.
|
297
290
|
* @param {object} [options]
|
298
291
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
299
292
|
* @returns {Promise} - The promise which resolves to an array.
|
300
|
-
* The first element of the array is Array of {@link google.cloud.discoveryengine.v1beta.Schema
|
293
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
|
301
294
|
* The client library will perform auto-pagination by default: it will call the API as many
|
302
295
|
* times as needed and will merge results from all the pages into this array.
|
303
296
|
* Note that it can affect your quota.
|
304
297
|
* We recommend using `listSchemasAsync()`
|
305
298
|
* method described below for async iteration which you can stop as needed.
|
306
|
-
* Please see the
|
307
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
299
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
308
300
|
* for more details and examples.
|
309
301
|
*/
|
310
302
|
listSchemas(request?: protos.google.cloud.discoveryengine.v1beta.IListSchemasRequest, options?: CallOptions): Promise<[
|
@@ -322,31 +314,30 @@ export declare class SchemaServiceClient {
|
|
322
314
|
* Required. The parent data store resource name, in the format of
|
323
315
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
324
316
|
* @param {number} request.pageSize
|
325
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s
|
317
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s
|
326
318
|
* to return. The service may return fewer than this value.
|
327
319
|
*
|
328
320
|
* If unspecified, at most 100
|
329
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
|
321
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
|
330
322
|
*
|
331
323
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
332
324
|
* @param {string} request.pageToken
|
333
325
|
* A page token, received from a previous
|
334
|
-
* {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
326
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
335
327
|
* call. Provide this to retrieve the subsequent page.
|
336
328
|
*
|
337
329
|
* When paginating, all other parameters provided to
|
338
|
-
* {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
330
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
339
331
|
* must match the call that provided the page token.
|
340
332
|
* @param {object} [options]
|
341
333
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
342
334
|
* @returns {Stream}
|
343
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1beta.Schema
|
335
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} on 'data' event.
|
344
336
|
* The client library will perform auto-pagination by default: it will call the API as many
|
345
337
|
* times as needed. Note that it can affect your quota.
|
346
338
|
* We recommend using `listSchemasAsync()`
|
347
339
|
* method described below for async iteration which you can stop as needed.
|
348
|
-
* Please see the
|
349
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
340
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
350
341
|
* for more details and examples.
|
351
342
|
*/
|
352
343
|
listSchemasStream(request?: protos.google.cloud.discoveryengine.v1beta.IListSchemasRequest, options?: CallOptions): Transform;
|
@@ -360,35 +351,85 @@ export declare class SchemaServiceClient {
|
|
360
351
|
* Required. The parent data store resource name, in the format of
|
361
352
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
362
353
|
* @param {number} request.pageSize
|
363
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s
|
354
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s
|
364
355
|
* to return. The service may return fewer than this value.
|
365
356
|
*
|
366
357
|
* If unspecified, at most 100
|
367
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
|
358
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
|
368
359
|
*
|
369
360
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
370
361
|
* @param {string} request.pageToken
|
371
362
|
* A page token, received from a previous
|
372
|
-
* {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
363
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
373
364
|
* call. Provide this to retrieve the subsequent page.
|
374
365
|
*
|
375
366
|
* When paginating, all other parameters provided to
|
376
|
-
* {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
367
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
377
368
|
* must match the call that provided the page token.
|
378
369
|
* @param {object} [options]
|
379
370
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
380
371
|
* @returns {Object}
|
381
|
-
* An iterable Object that allows
|
372
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
382
373
|
* When you iterate the returned iterable, each element will be an object representing
|
383
|
-
* {@link google.cloud.discoveryengine.v1beta.Schema
|
374
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}. The API will be called under the hood as needed, once per the page,
|
384
375
|
* so you can stop the iteration when you don't need more results.
|
385
|
-
* Please see the
|
386
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
376
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
387
377
|
* for more details and examples.
|
388
378
|
* @example <caption>include:samples/generated/v1beta/schema_service.list_schemas.js</caption>
|
389
379
|
* region_tag:discoveryengine_v1beta_generated_SchemaService_ListSchemas_async
|
390
380
|
*/
|
391
381
|
listSchemasAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListSchemasRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ISchema>;
|
382
|
+
/**
|
383
|
+
* Gets information about a location.
|
384
|
+
*
|
385
|
+
* @param {Object} request
|
386
|
+
* The request object that will be sent.
|
387
|
+
* @param {string} request.name
|
388
|
+
* Resource name for the location.
|
389
|
+
* @param {object} [options]
|
390
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
391
|
+
* @returns {Promise} - The promise which resolves to an array.
|
392
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
393
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
394
|
+
* for more details and examples.
|
395
|
+
* @example
|
396
|
+
* ```
|
397
|
+
* const [response] = await client.getLocation(request);
|
398
|
+
* ```
|
399
|
+
*/
|
400
|
+
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>;
|
401
|
+
/**
|
402
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
403
|
+
*
|
404
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
405
|
+
* @param {Object} request
|
406
|
+
* The request object that will be sent.
|
407
|
+
* @param {string} request.name
|
408
|
+
* The resource that owns the locations collection, if applicable.
|
409
|
+
* @param {string} request.filter
|
410
|
+
* The standard list filter.
|
411
|
+
* @param {number} request.pageSize
|
412
|
+
* The standard list page size.
|
413
|
+
* @param {string} request.pageToken
|
414
|
+
* The standard list page token.
|
415
|
+
* @param {object} [options]
|
416
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
417
|
+
* @returns {Object}
|
418
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
419
|
+
* When you iterate the returned iterable, each element will be an object representing
|
420
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
421
|
+
* so you can stop the iteration when you don't need more results.
|
422
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
423
|
+
* for more details and examples.
|
424
|
+
* @example
|
425
|
+
* ```
|
426
|
+
* const iterable = client.listLocationsAsync(request);
|
427
|
+
* for await (const response of iterable) {
|
428
|
+
* // process response
|
429
|
+
* }
|
430
|
+
* ```
|
431
|
+
*/
|
432
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
392
433
|
/**
|
393
434
|
* Gets the latest state of a long-running operation. Clients can use this
|
394
435
|
* method to poll the operation result at intervals as recommended by the API
|
@@ -611,6 +652,57 @@ export declare class SchemaServiceClient {
|
|
611
652
|
* @returns {string} A string representing the document.
|
612
653
|
*/
|
613
654
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
655
|
+
/**
|
656
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
657
|
+
*
|
658
|
+
* @param {string} project
|
659
|
+
* @param {string} location
|
660
|
+
* @param {string} collection
|
661
|
+
* @param {string} data_store
|
662
|
+
* @param {string} conversation
|
663
|
+
* @returns {string} Resource name string.
|
664
|
+
*/
|
665
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
666
|
+
/**
|
667
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
668
|
+
*
|
669
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
670
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
671
|
+
* @returns {string} A string representing the project.
|
672
|
+
*/
|
673
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
674
|
+
/**
|
675
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
676
|
+
*
|
677
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
678
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
679
|
+
* @returns {string} A string representing the location.
|
680
|
+
*/
|
681
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
682
|
+
/**
|
683
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
684
|
+
*
|
685
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
686
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
687
|
+
* @returns {string} A string representing the collection.
|
688
|
+
*/
|
689
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
690
|
+
/**
|
691
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
692
|
+
*
|
693
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
694
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
695
|
+
* @returns {string} A string representing the data_store.
|
696
|
+
*/
|
697
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
698
|
+
/**
|
699
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
700
|
+
*
|
701
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
702
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
703
|
+
* @returns {string} A string representing the conversation.
|
704
|
+
*/
|
705
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
614
706
|
/**
|
615
707
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
616
708
|
*
|
@@ -746,6 +838,48 @@ export declare class SchemaServiceClient {
|
|
746
838
|
* @returns {string} A string representing the document.
|
747
839
|
*/
|
748
840
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
841
|
+
/**
|
842
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
843
|
+
*
|
844
|
+
* @param {string} project
|
845
|
+
* @param {string} location
|
846
|
+
* @param {string} data_store
|
847
|
+
* @param {string} conversation
|
848
|
+
* @returns {string} Resource name string.
|
849
|
+
*/
|
850
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
851
|
+
/**
|
852
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
853
|
+
*
|
854
|
+
* @param {string} projectLocationDataStoreConversationName
|
855
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
856
|
+
* @returns {string} A string representing the project.
|
857
|
+
*/
|
858
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
859
|
+
/**
|
860
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
861
|
+
*
|
862
|
+
* @param {string} projectLocationDataStoreConversationName
|
863
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
864
|
+
* @returns {string} A string representing the location.
|
865
|
+
*/
|
866
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
867
|
+
/**
|
868
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
869
|
+
*
|
870
|
+
* @param {string} projectLocationDataStoreConversationName
|
871
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
872
|
+
* @returns {string} A string representing the data_store.
|
873
|
+
*/
|
874
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
875
|
+
/**
|
876
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
877
|
+
*
|
878
|
+
* @param {string} projectLocationDataStoreConversationName
|
879
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
880
|
+
* @returns {string} A string representing the conversation.
|
881
|
+
*/
|
882
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
749
883
|
/**
|
750
884
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
751
885
|
*
|