@googleapis/discoveryengine 27.1.0 → 28.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 +18 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +865 -582
- package/build/v1.js +251 -40
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +1274 -1163
- package/build/v1alpha.js +351 -118
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +1078 -811
- package/build/v1beta.js +251 -40
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +2007 -1475
- package/v1alpha.ts +2634 -2372
- package/v1beta.ts +2008 -1503
package/build/v1.d.ts
CHANGED
|
@@ -67,341 +67,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
67
67
|
*/
|
|
68
68
|
export class Discoveryengine {
|
|
69
69
|
context: APIRequestContext;
|
|
70
|
-
media: Resource$Media;
|
|
71
70
|
projects: Resource$Projects;
|
|
72
71
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
73
72
|
}
|
|
74
|
-
/**
|
|
75
|
-
* Information to read/write to blobstore2.
|
|
76
|
-
*/
|
|
77
|
-
export interface Schema$GdataBlobstore2Info {
|
|
78
|
-
/**
|
|
79
|
-
* The blob generation id.
|
|
80
|
-
*/
|
|
81
|
-
blobGeneration?: string | null;
|
|
82
|
-
/**
|
|
83
|
-
* The blob id, e.g., /blobstore/prod/playground/scotty
|
|
84
|
-
*/
|
|
85
|
-
blobId?: string | null;
|
|
86
|
-
/**
|
|
87
|
-
* Read handle passed from Bigstore -\> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
|
|
88
|
-
*/
|
|
89
|
-
downloadReadHandle?: string | null;
|
|
90
|
-
/**
|
|
91
|
-
* The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
|
|
92
|
-
*/
|
|
93
|
-
readToken?: string | null;
|
|
94
|
-
/**
|
|
95
|
-
* Metadata passed from Blobstore -\> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
|
|
96
|
-
*/
|
|
97
|
-
uploadMetadataContainer?: string | null;
|
|
98
|
-
}
|
|
99
|
-
/**
|
|
100
|
-
* A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
|
|
101
|
-
*/
|
|
102
|
-
export interface Schema$GdataCompositeMedia {
|
|
103
|
-
/**
|
|
104
|
-
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
|
|
105
|
-
*/
|
|
106
|
-
blobRef?: string | null;
|
|
107
|
-
/**
|
|
108
|
-
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
|
|
109
|
-
*/
|
|
110
|
-
blobstore2Info?: Schema$GdataBlobstore2Info;
|
|
111
|
-
/**
|
|
112
|
-
* A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
|
|
113
|
-
*/
|
|
114
|
-
cosmoBinaryReference?: string | null;
|
|
115
|
-
/**
|
|
116
|
-
* crc32.c hash for the payload.
|
|
117
|
-
*/
|
|
118
|
-
crc32cHash?: number | null;
|
|
119
|
-
/**
|
|
120
|
-
* Media data, set if reference_type is INLINE
|
|
121
|
-
*/
|
|
122
|
-
inline?: string | null;
|
|
123
|
-
/**
|
|
124
|
-
* Size of the data, in bytes
|
|
125
|
-
*/
|
|
126
|
-
length?: string | null;
|
|
127
|
-
/**
|
|
128
|
-
* MD5 hash for the payload.
|
|
129
|
-
*/
|
|
130
|
-
md5Hash?: string | null;
|
|
131
|
-
/**
|
|
132
|
-
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
|
|
133
|
-
*/
|
|
134
|
-
objectId?: Schema$GdataObjectId;
|
|
135
|
-
/**
|
|
136
|
-
* Path to the data, set if reference_type is PATH
|
|
137
|
-
*/
|
|
138
|
-
path?: string | null;
|
|
139
|
-
/**
|
|
140
|
-
* Describes what the field reference contains.
|
|
141
|
-
*/
|
|
142
|
-
referenceType?: string | null;
|
|
143
|
-
/**
|
|
144
|
-
* SHA-1 hash for the payload.
|
|
145
|
-
*/
|
|
146
|
-
sha1Hash?: string | null;
|
|
147
|
-
}
|
|
148
|
-
/**
|
|
149
|
-
* Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
|
|
150
|
-
*/
|
|
151
|
-
export interface Schema$GdataContentTypeInfo {
|
|
152
|
-
/**
|
|
153
|
-
* Scotty's best guess of what the content type of the file is.
|
|
154
|
-
*/
|
|
155
|
-
bestGuess?: string | null;
|
|
156
|
-
/**
|
|
157
|
-
* The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
|
|
158
|
-
*/
|
|
159
|
-
fromBytes?: string | null;
|
|
160
|
-
/**
|
|
161
|
-
* The content type of the file derived from the file extension of the original file name used by the client.
|
|
162
|
-
*/
|
|
163
|
-
fromFileName?: string | null;
|
|
164
|
-
/**
|
|
165
|
-
* The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
|
|
166
|
-
*/
|
|
167
|
-
fromHeader?: string | null;
|
|
168
|
-
/**
|
|
169
|
-
* The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
|
|
170
|
-
*/
|
|
171
|
-
fromUrlPath?: string | null;
|
|
172
|
-
}
|
|
173
|
-
/**
|
|
174
|
-
* Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
175
|
-
*/
|
|
176
|
-
export interface Schema$GdataDiffChecksumsResponse {
|
|
177
|
-
/**
|
|
178
|
-
* Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
|
|
179
|
-
*/
|
|
180
|
-
checksumsLocation?: Schema$GdataCompositeMedia;
|
|
181
|
-
/**
|
|
182
|
-
* The chunk size of checksums. Must be a multiple of 256KB.
|
|
183
|
-
*/
|
|
184
|
-
chunkSizeBytes?: string | null;
|
|
185
|
-
/**
|
|
186
|
-
* If set, calculate the checksums based on the contents and return them to the caller.
|
|
187
|
-
*/
|
|
188
|
-
objectLocation?: Schema$GdataCompositeMedia;
|
|
189
|
-
/**
|
|
190
|
-
* The total size of the server object.
|
|
191
|
-
*/
|
|
192
|
-
objectSizeBytes?: string | null;
|
|
193
|
-
/**
|
|
194
|
-
* The object version of the object the checksums are being returned for.
|
|
195
|
-
*/
|
|
196
|
-
objectVersion?: string | null;
|
|
197
|
-
}
|
|
198
|
-
/**
|
|
199
|
-
* Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
200
|
-
*/
|
|
201
|
-
export interface Schema$GdataDiffDownloadResponse {
|
|
202
|
-
/**
|
|
203
|
-
* The original object location.
|
|
204
|
-
*/
|
|
205
|
-
objectLocation?: Schema$GdataCompositeMedia;
|
|
206
|
-
}
|
|
207
|
-
/**
|
|
208
|
-
* A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
209
|
-
*/
|
|
210
|
-
export interface Schema$GdataDiffUploadRequest {
|
|
211
|
-
/**
|
|
212
|
-
* The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
|
|
213
|
-
*/
|
|
214
|
-
checksumsInfo?: Schema$GdataCompositeMedia;
|
|
215
|
-
/**
|
|
216
|
-
* The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
|
|
217
|
-
*/
|
|
218
|
-
objectInfo?: Schema$GdataCompositeMedia;
|
|
219
|
-
/**
|
|
220
|
-
* The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
|
|
221
|
-
*/
|
|
222
|
-
objectVersion?: string | null;
|
|
223
|
-
}
|
|
224
|
-
/**
|
|
225
|
-
* Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
226
|
-
*/
|
|
227
|
-
export interface Schema$GdataDiffUploadResponse {
|
|
228
|
-
/**
|
|
229
|
-
* The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
|
|
230
|
-
*/
|
|
231
|
-
objectVersion?: string | null;
|
|
232
|
-
/**
|
|
233
|
-
* The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
|
|
234
|
-
*/
|
|
235
|
-
originalObject?: Schema$GdataCompositeMedia;
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
* Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
239
|
-
*/
|
|
240
|
-
export interface Schema$GdataDiffVersionResponse {
|
|
241
|
-
/**
|
|
242
|
-
* The total size of the server object.
|
|
243
|
-
*/
|
|
244
|
-
objectSizeBytes?: string | null;
|
|
245
|
-
/**
|
|
246
|
-
* The version of the object stored at the server.
|
|
247
|
-
*/
|
|
248
|
-
objectVersion?: string | null;
|
|
249
|
-
}
|
|
250
|
-
/**
|
|
251
|
-
* Parameters specific to media downloads.
|
|
252
|
-
*/
|
|
253
|
-
export interface Schema$GdataDownloadParameters {
|
|
254
|
-
/**
|
|
255
|
-
* A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
|
|
256
|
-
*/
|
|
257
|
-
allowGzipCompression?: boolean | null;
|
|
258
|
-
/**
|
|
259
|
-
* Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
|
|
260
|
-
*/
|
|
261
|
-
ignoreRange?: boolean | null;
|
|
262
|
-
}
|
|
263
|
-
/**
|
|
264
|
-
* A reference to data stored on the filesystem, on GFS or in blobstore.
|
|
265
|
-
*/
|
|
266
|
-
export interface Schema$GdataMedia {
|
|
267
|
-
/**
|
|
268
|
-
* Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
|
|
269
|
-
*/
|
|
270
|
-
algorithm?: string | null;
|
|
271
|
-
/**
|
|
272
|
-
* Use object_id instead.
|
|
273
|
-
*/
|
|
274
|
-
bigstoreObjectRef?: string | null;
|
|
275
|
-
/**
|
|
276
|
-
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
|
|
277
|
-
*/
|
|
278
|
-
blobRef?: string | null;
|
|
279
|
-
/**
|
|
280
|
-
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
|
|
281
|
-
*/
|
|
282
|
-
blobstore2Info?: Schema$GdataBlobstore2Info;
|
|
283
|
-
/**
|
|
284
|
-
* A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
|
|
285
|
-
*/
|
|
286
|
-
compositeMedia?: Schema$GdataCompositeMedia[];
|
|
287
|
-
/**
|
|
288
|
-
* MIME type of the data
|
|
289
|
-
*/
|
|
290
|
-
contentType?: string | null;
|
|
291
|
-
/**
|
|
292
|
-
* Extended content type information provided for Scotty uploads.
|
|
293
|
-
*/
|
|
294
|
-
contentTypeInfo?: Schema$GdataContentTypeInfo;
|
|
295
|
-
/**
|
|
296
|
-
* A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
|
|
297
|
-
*/
|
|
298
|
-
cosmoBinaryReference?: string | null;
|
|
299
|
-
/**
|
|
300
|
-
* For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
|
|
301
|
-
*/
|
|
302
|
-
crc32cHash?: number | null;
|
|
303
|
-
/**
|
|
304
|
-
* Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
|
|
305
|
-
*/
|
|
306
|
-
diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse;
|
|
307
|
-
/**
|
|
308
|
-
* Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
|
|
309
|
-
*/
|
|
310
|
-
diffDownloadResponse?: Schema$GdataDiffDownloadResponse;
|
|
311
|
-
/**
|
|
312
|
-
* Set if reference_type is DIFF_UPLOAD_REQUEST.
|
|
313
|
-
*/
|
|
314
|
-
diffUploadRequest?: Schema$GdataDiffUploadRequest;
|
|
315
|
-
/**
|
|
316
|
-
* Set if reference_type is DIFF_UPLOAD_RESPONSE.
|
|
317
|
-
*/
|
|
318
|
-
diffUploadResponse?: Schema$GdataDiffUploadResponse;
|
|
319
|
-
/**
|
|
320
|
-
* Set if reference_type is DIFF_VERSION_RESPONSE.
|
|
321
|
-
*/
|
|
322
|
-
diffVersionResponse?: Schema$GdataDiffVersionResponse;
|
|
323
|
-
/**
|
|
324
|
-
* Parameters for a media download.
|
|
325
|
-
*/
|
|
326
|
-
downloadParameters?: Schema$GdataDownloadParameters;
|
|
327
|
-
/**
|
|
328
|
-
* Original file name
|
|
329
|
-
*/
|
|
330
|
-
filename?: string | null;
|
|
331
|
-
/**
|
|
332
|
-
* Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
|
|
333
|
-
*/
|
|
334
|
-
hash?: string | null;
|
|
335
|
-
/**
|
|
336
|
-
* For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
|
|
337
|
-
*/
|
|
338
|
-
hashVerified?: boolean | null;
|
|
339
|
-
/**
|
|
340
|
-
* Media data, set if reference_type is INLINE
|
|
341
|
-
*/
|
|
342
|
-
inline?: string | null;
|
|
343
|
-
/**
|
|
344
|
-
* |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
|
|
345
|
-
*/
|
|
346
|
-
isPotentialRetry?: boolean | null;
|
|
347
|
-
/**
|
|
348
|
-
* Size of the data, in bytes
|
|
349
|
-
*/
|
|
350
|
-
length?: string | null;
|
|
351
|
-
/**
|
|
352
|
-
* Scotty-provided MD5 hash for an upload.
|
|
353
|
-
*/
|
|
354
|
-
md5Hash?: string | null;
|
|
355
|
-
/**
|
|
356
|
-
* Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
|
|
357
|
-
*/
|
|
358
|
-
mediaId?: string | null;
|
|
359
|
-
/**
|
|
360
|
-
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
|
|
361
|
-
*/
|
|
362
|
-
objectId?: Schema$GdataObjectId;
|
|
363
|
-
/**
|
|
364
|
-
* Path to the data, set if reference_type is PATH
|
|
365
|
-
*/
|
|
366
|
-
path?: string | null;
|
|
367
|
-
/**
|
|
368
|
-
* Describes what the field reference contains.
|
|
369
|
-
*/
|
|
370
|
-
referenceType?: string | null;
|
|
371
|
-
/**
|
|
372
|
-
* Scotty-provided SHA1 hash for an upload.
|
|
373
|
-
*/
|
|
374
|
-
sha1Hash?: string | null;
|
|
375
|
-
/**
|
|
376
|
-
* Scotty-provided SHA256 hash for an upload.
|
|
377
|
-
*/
|
|
378
|
-
sha256Hash?: string | null;
|
|
379
|
-
/**
|
|
380
|
-
* Time at which the media data was last updated, in milliseconds since UNIX epoch
|
|
381
|
-
*/
|
|
382
|
-
timestamp?: string | null;
|
|
383
|
-
/**
|
|
384
|
-
* A unique fingerprint/version id for the media data
|
|
385
|
-
*/
|
|
386
|
-
token?: string | null;
|
|
387
|
-
}
|
|
388
|
-
/**
|
|
389
|
-
* This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
|
|
390
|
-
*/
|
|
391
|
-
export interface Schema$GdataObjectId {
|
|
392
|
-
/**
|
|
393
|
-
* The name of the bucket to which this object belongs.
|
|
394
|
-
*/
|
|
395
|
-
bucketName?: string | null;
|
|
396
|
-
/**
|
|
397
|
-
* Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
|
|
398
|
-
*/
|
|
399
|
-
generation?: string | null;
|
|
400
|
-
/**
|
|
401
|
-
* The name of the object.
|
|
402
|
-
*/
|
|
403
|
-
objectName?: string | null;
|
|
404
|
-
}
|
|
405
73
|
/**
|
|
406
74
|
* `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
|
|
407
75
|
*/
|
|
@@ -3421,6 +3089,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3421
3089
|
* Configurations for a Search Engine.
|
|
3422
3090
|
*/
|
|
3423
3091
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
3092
|
+
/**
|
|
3093
|
+
* Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
|
|
3094
|
+
*/
|
|
3095
|
+
requiredSubscriptionTier?: string | null;
|
|
3424
3096
|
/**
|
|
3425
3097
|
* The add-on that this search engine enables.
|
|
3426
3098
|
*/
|
|
@@ -4561,6 +4233,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4561
4233
|
* A specification for configuring the behavior of content search.
|
|
4562
4234
|
*/
|
|
4563
4235
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
4236
|
+
/**
|
|
4237
|
+
* Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
|
|
4238
|
+
*/
|
|
4239
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
4564
4240
|
/**
|
|
4565
4241
|
* Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
|
|
4566
4242
|
*/
|
|
@@ -4609,6 +4285,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4609
4285
|
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
4610
4286
|
*/
|
|
4611
4287
|
orderBy?: string | null;
|
|
4288
|
+
/**
|
|
4289
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
4290
|
+
*/
|
|
4291
|
+
pageCategories?: string[] | null;
|
|
4612
4292
|
/**
|
|
4613
4293
|
* Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
4614
4294
|
*/
|
|
@@ -4918,6 +4598,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
4918
4598
|
*/
|
|
4919
4599
|
imageSource?: string | null;
|
|
4920
4600
|
}
|
|
4601
|
+
/**
|
|
4602
|
+
* Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
|
|
4603
|
+
*/
|
|
4604
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec {
|
|
4605
|
+
/**
|
|
4606
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
4607
|
+
*/
|
|
4608
|
+
field?: string | null;
|
|
4609
|
+
/**
|
|
4610
|
+
* The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
|
|
4611
|
+
*/
|
|
4612
|
+
maxCount?: number | null;
|
|
4613
|
+
/**
|
|
4614
|
+
* Mode to use for documents that are crowded away.
|
|
4615
|
+
*/
|
|
4616
|
+
mode?: string | null;
|
|
4617
|
+
}
|
|
4921
4618
|
/**
|
|
4922
4619
|
* A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
4923
4620
|
*/
|
|
@@ -6500,6 +6197,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
6500
6197
|
* Optional. Customer policy for the assistant.
|
|
6501
6198
|
*/
|
|
6502
6199
|
customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
6200
|
+
/**
|
|
6201
|
+
* Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
|
|
6202
|
+
*/
|
|
6203
|
+
description?: string | null;
|
|
6204
|
+
/**
|
|
6205
|
+
* Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
|
|
6206
|
+
*/
|
|
6207
|
+
displayName?: string | null;
|
|
6503
6208
|
/**
|
|
6504
6209
|
* Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId\}/locations/{locationId\}/collections/{collectionId\}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] \}
|
|
6505
6210
|
*/
|
|
@@ -6651,10 +6356,18 @@ export declare namespace discoveryengine_v1 {
|
|
|
6651
6356
|
* Configuration for the generation of the assistant response.
|
|
6652
6357
|
*/
|
|
6653
6358
|
export interface Schema$GoogleCloudDiscoveryengineV1AssistantGenerationConfig {
|
|
6359
|
+
/**
|
|
6360
|
+
* Optional. The list of models that are allowed to be used for assistant.
|
|
6361
|
+
*/
|
|
6362
|
+
allowedModelIds?: string[] | null;
|
|
6654
6363
|
/**
|
|
6655
6364
|
* The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.
|
|
6656
6365
|
*/
|
|
6657
6366
|
defaultLanguage?: string | null;
|
|
6367
|
+
/**
|
|
6368
|
+
* Optional. The default model to use for assistant.
|
|
6369
|
+
*/
|
|
6370
|
+
defaultModelId?: string | null;
|
|
6658
6371
|
/**
|
|
6659
6372
|
* System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
|
|
6660
6373
|
*/
|
|
@@ -7943,6 +7656,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7943
7656
|
* Configurations for a Search Engine.
|
|
7944
7657
|
*/
|
|
7945
7658
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
7659
|
+
/**
|
|
7660
|
+
* Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
|
|
7661
|
+
*/
|
|
7662
|
+
requiredSubscriptionTier?: string | null;
|
|
7946
7663
|
/**
|
|
7947
7664
|
* The add-on that this search engine enables.
|
|
7948
7665
|
*/
|
|
@@ -8710,6 +8427,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
8710
8427
|
* A specification for configuring the behavior of content search.
|
|
8711
8428
|
*/
|
|
8712
8429
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
8430
|
+
/**
|
|
8431
|
+
* Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
|
|
8432
|
+
*/
|
|
8433
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
8713
8434
|
/**
|
|
8714
8435
|
* Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.
|
|
8715
8436
|
*/
|
|
@@ -8754,6 +8475,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
8754
8475
|
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
8755
8476
|
*/
|
|
8756
8477
|
orderBy?: string | null;
|
|
8478
|
+
/**
|
|
8479
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
8480
|
+
*/
|
|
8481
|
+
pageCategories?: string[] | null;
|
|
8757
8482
|
/**
|
|
8758
8483
|
* Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
8759
8484
|
*/
|
|
@@ -9059,6 +8784,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
9059
8784
|
*/
|
|
9060
8785
|
imageSource?: string | null;
|
|
9061
8786
|
}
|
|
8787
|
+
/**
|
|
8788
|
+
* Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
|
|
8789
|
+
*/
|
|
8790
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec {
|
|
8791
|
+
/**
|
|
8792
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
8793
|
+
*/
|
|
8794
|
+
field?: string | null;
|
|
8795
|
+
/**
|
|
8796
|
+
* The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
|
|
8797
|
+
*/
|
|
8798
|
+
maxCount?: number | null;
|
|
8799
|
+
/**
|
|
8800
|
+
* Mode to use for documents that are crowded away.
|
|
8801
|
+
*/
|
|
8802
|
+
mode?: string | null;
|
|
8803
|
+
}
|
|
9062
8804
|
/**
|
|
9063
8805
|
* A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
9064
8806
|
*/
|
|
@@ -10887,6 +10629,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
10887
10629
|
* Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
10888
10630
|
*/
|
|
10889
10631
|
name?: string | null;
|
|
10632
|
+
/**
|
|
10633
|
+
* Optional. Configuration for Natural Language Query Understanding.
|
|
10634
|
+
*/
|
|
10635
|
+
naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig;
|
|
10890
10636
|
/**
|
|
10891
10637
|
* Optional. Stores serving config at DataStore level.
|
|
10892
10638
|
*/
|
|
@@ -11606,6 +11352,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11606
11352
|
* Configurations for a Search Engine.
|
|
11607
11353
|
*/
|
|
11608
11354
|
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
11355
|
+
/**
|
|
11356
|
+
* Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
|
|
11357
|
+
*/
|
|
11358
|
+
requiredSubscriptionTier?: string | null;
|
|
11609
11359
|
/**
|
|
11610
11360
|
* The add-on that this search engine enables.
|
|
11611
11361
|
*/
|
|
@@ -11776,6 +11526,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11776
11526
|
* Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.
|
|
11777
11527
|
*/
|
|
11778
11528
|
externalIdentity?: string | null;
|
|
11529
|
+
/**
|
|
11530
|
+
* Optional. The name of the external identity.
|
|
11531
|
+
*/
|
|
11532
|
+
externalIdentityName?: string | null;
|
|
11779
11533
|
/**
|
|
11780
11534
|
* Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.
|
|
11781
11535
|
*/
|
|
@@ -12269,6 +12023,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
12269
12023
|
*/
|
|
12270
12024
|
usedLicenseCount?: string | null;
|
|
12271
12025
|
}
|
|
12026
|
+
/**
|
|
12027
|
+
* Response message for the AssistantService.ListAssistants method.
|
|
12028
|
+
*/
|
|
12029
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse {
|
|
12030
|
+
/**
|
|
12031
|
+
* All the customer's Assistants.
|
|
12032
|
+
*/
|
|
12033
|
+
assistants?: Schema$GoogleCloudDiscoveryengineV1Assistant[];
|
|
12034
|
+
/**
|
|
12035
|
+
* A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
12036
|
+
*/
|
|
12037
|
+
nextPageToken?: string | null;
|
|
12038
|
+
}
|
|
12272
12039
|
/**
|
|
12273
12040
|
* Response message for CmekConfigService.ListCmekConfigs method.
|
|
12274
12041
|
*/
|
|
@@ -12469,6 +12236,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
12469
12236
|
*/
|
|
12470
12237
|
mediaProgressPercentage?: number | null;
|
|
12471
12238
|
}
|
|
12239
|
+
/**
|
|
12240
|
+
* Configuration for Natural Language Query Understanding.
|
|
12241
|
+
*/
|
|
12242
|
+
export interface Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig {
|
|
12243
|
+
/**
|
|
12244
|
+
* Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
|
|
12245
|
+
*/
|
|
12246
|
+
mode?: string | null;
|
|
12247
|
+
}
|
|
12472
12248
|
/**
|
|
12473
12249
|
* Detailed page information.
|
|
12474
12250
|
*/
|
|
@@ -13140,6 +12916,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
13140
12916
|
* A specification for configuring the behavior of content search.
|
|
13141
12917
|
*/
|
|
13142
12918
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
12919
|
+
/**
|
|
12920
|
+
* Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
|
|
12921
|
+
*/
|
|
12922
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec[];
|
|
13143
12923
|
/**
|
|
13144
12924
|
* Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.
|
|
13145
12925
|
*/
|
|
@@ -13180,6 +12960,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
13180
12960
|
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
13181
12961
|
*/
|
|
13182
12962
|
orderBy?: string | null;
|
|
12963
|
+
/**
|
|
12964
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
12965
|
+
*/
|
|
12966
|
+
pageCategories?: string[] | null;
|
|
13183
12967
|
/**
|
|
13184
12968
|
* Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
13185
12969
|
*/
|
|
@@ -13456,6 +13240,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
13456
13240
|
*/
|
|
13457
13241
|
version?: string | null;
|
|
13458
13242
|
}
|
|
13243
|
+
/**
|
|
13244
|
+
* Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
|
|
13245
|
+
*/
|
|
13246
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec {
|
|
13247
|
+
/**
|
|
13248
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
13249
|
+
*/
|
|
13250
|
+
field?: string | null;
|
|
13251
|
+
/**
|
|
13252
|
+
* The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
|
|
13253
|
+
*/
|
|
13254
|
+
maxCount?: number | null;
|
|
13255
|
+
/**
|
|
13256
|
+
* Mode to use for documents that are crowded away.
|
|
13257
|
+
*/
|
|
13258
|
+
mode?: string | null;
|
|
13259
|
+
}
|
|
13459
13260
|
/**
|
|
13460
13261
|
* A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
13461
13262
|
*/
|
|
@@ -13659,6 +13460,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
13659
13460
|
* Promotions for site search.
|
|
13660
13461
|
*/
|
|
13661
13462
|
searchLinkPromotions?: Schema$GoogleCloudDiscoveryengineV1SearchLinkPromotion[];
|
|
13463
|
+
/**
|
|
13464
|
+
* Output only. Indicates the semantic state of the search response.
|
|
13465
|
+
*/
|
|
13466
|
+
semanticState?: string | null;
|
|
13662
13467
|
/**
|
|
13663
13468
|
* Session information. Only set if SearchRequest.session is provided. See its description for more details.
|
|
13664
13469
|
*/
|
|
@@ -14310,6 +14115,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
14310
14115
|
* A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
|
|
14311
14116
|
*/
|
|
14312
14117
|
assistToken?: string | null;
|
|
14118
|
+
/**
|
|
14119
|
+
* The tool names of the tools that were invoked.
|
|
14120
|
+
*/
|
|
14121
|
+
invocationTools?: string[] | null;
|
|
14313
14122
|
/**
|
|
14314
14123
|
* Session information. Only included in the final StreamAssistResponse of the response stream.
|
|
14315
14124
|
*/
|
|
@@ -14627,7 +14436,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
14627
14436
|
*/
|
|
14628
14437
|
eventType?: string | null;
|
|
14629
14438
|
/**
|
|
14630
|
-
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
14439
|
+
* Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
14631
14440
|
*/
|
|
14632
14441
|
filter?: string | null;
|
|
14633
14442
|
/**
|
|
@@ -15264,7 +15073,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
15264
15073
|
*/
|
|
15265
15074
|
operations?: Schema$GoogleLongrunningOperation[];
|
|
15266
15075
|
/**
|
|
15267
|
-
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections
|
|
15076
|
+
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
|
|
15268
15077
|
*/
|
|
15269
15078
|
unreachable?: string[] | null;
|
|
15270
15079
|
}
|
|
@@ -15480,121 +15289,6 @@ export declare namespace discoveryengine_v1 {
|
|
|
15480
15289
|
*/
|
|
15481
15290
|
version?: string | null;
|
|
15482
15291
|
}
|
|
15483
|
-
export class Resource$Media {
|
|
15484
|
-
context: APIRequestContext;
|
|
15485
|
-
constructor(context: APIRequestContext);
|
|
15486
|
-
/**
|
|
15487
|
-
* Downloads a file from the session.
|
|
15488
|
-
* @example
|
|
15489
|
-
* ```js
|
|
15490
|
-
* // Before running the sample:
|
|
15491
|
-
* // - Enable the API at:
|
|
15492
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15493
|
-
* // - Login into gcloud by running:
|
|
15494
|
-
* // ```sh
|
|
15495
|
-
* // $ gcloud auth application-default login
|
|
15496
|
-
* // ```
|
|
15497
|
-
* // - Install the npm module by running:
|
|
15498
|
-
* // ```sh
|
|
15499
|
-
* // $ npm install googleapis
|
|
15500
|
-
* // ```
|
|
15501
|
-
*
|
|
15502
|
-
* const {google} = require('googleapis');
|
|
15503
|
-
* const discoveryengine = google.discoveryengine('v1');
|
|
15504
|
-
*
|
|
15505
|
-
* async function main() {
|
|
15506
|
-
* const auth = new google.auth.GoogleAuth({
|
|
15507
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15508
|
-
* scopes: [
|
|
15509
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
15510
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
15511
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
15512
|
-
* ],
|
|
15513
|
-
* });
|
|
15514
|
-
*
|
|
15515
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
15516
|
-
* const authClient = await auth.getClient();
|
|
15517
|
-
* google.options({auth: authClient});
|
|
15518
|
-
*
|
|
15519
|
-
* // Do the magic
|
|
15520
|
-
* const res = await discoveryengine.media.download({
|
|
15521
|
-
* // Required. The ID of the file to be downloaded.
|
|
15522
|
-
* fileId: 'placeholder-value',
|
|
15523
|
-
* // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
15524
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
15525
|
-
* // Optional. The ID of the view to be downloaded.
|
|
15526
|
-
* viewId: 'placeholder-value',
|
|
15527
|
-
* });
|
|
15528
|
-
* console.log(res.data);
|
|
15529
|
-
*
|
|
15530
|
-
* // Example response
|
|
15531
|
-
* // {
|
|
15532
|
-
* // "algorithm": "my_algorithm",
|
|
15533
|
-
* // "bigstoreObjectRef": "my_bigstoreObjectRef",
|
|
15534
|
-
* // "blobRef": "my_blobRef",
|
|
15535
|
-
* // "blobstore2Info": {},
|
|
15536
|
-
* // "compositeMedia": [],
|
|
15537
|
-
* // "contentType": "my_contentType",
|
|
15538
|
-
* // "contentTypeInfo": {},
|
|
15539
|
-
* // "cosmoBinaryReference": "my_cosmoBinaryReference",
|
|
15540
|
-
* // "crc32cHash": 0,
|
|
15541
|
-
* // "diffChecksumsResponse": {},
|
|
15542
|
-
* // "diffDownloadResponse": {},
|
|
15543
|
-
* // "diffUploadRequest": {},
|
|
15544
|
-
* // "diffUploadResponse": {},
|
|
15545
|
-
* // "diffVersionResponse": {},
|
|
15546
|
-
* // "downloadParameters": {},
|
|
15547
|
-
* // "filename": "my_filename",
|
|
15548
|
-
* // "hash": "my_hash",
|
|
15549
|
-
* // "hashVerified": false,
|
|
15550
|
-
* // "inline": "my_inline",
|
|
15551
|
-
* // "isPotentialRetry": false,
|
|
15552
|
-
* // "length": "my_length",
|
|
15553
|
-
* // "md5Hash": "my_md5Hash",
|
|
15554
|
-
* // "mediaId": "my_mediaId",
|
|
15555
|
-
* // "objectId": {},
|
|
15556
|
-
* // "path": "my_path",
|
|
15557
|
-
* // "referenceType": "my_referenceType",
|
|
15558
|
-
* // "sha1Hash": "my_sha1Hash",
|
|
15559
|
-
* // "sha256Hash": "my_sha256Hash",
|
|
15560
|
-
* // "timestamp": "my_timestamp",
|
|
15561
|
-
* // "token": "my_token"
|
|
15562
|
-
* // }
|
|
15563
|
-
* }
|
|
15564
|
-
*
|
|
15565
|
-
* main().catch(e => {
|
|
15566
|
-
* console.error(e);
|
|
15567
|
-
* throw e;
|
|
15568
|
-
* });
|
|
15569
|
-
*
|
|
15570
|
-
* ```
|
|
15571
|
-
*
|
|
15572
|
-
* @param params - Parameters for request
|
|
15573
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15574
|
-
* @param callback - Optional callback that handles the response.
|
|
15575
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15576
|
-
*/
|
|
15577
|
-
download(params: Params$Resource$Media$Download, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15578
|
-
download(params?: Params$Resource$Media$Download, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GdataMedia>>;
|
|
15579
|
-
download(params: Params$Resource$Media$Download, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15580
|
-
download(params: Params$Resource$Media$Download, options: MethodOptions | BodyResponseCallback<Schema$GdataMedia>, callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
15581
|
-
download(params: Params$Resource$Media$Download, callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
15582
|
-
download(callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
15583
|
-
}
|
|
15584
|
-
export interface Params$Resource$Media$Download extends StandardParameters {
|
|
15585
|
-
/**
|
|
15586
|
-
* Required. The ID of the file to be downloaded.
|
|
15587
|
-
*/
|
|
15588
|
-
fileId?: string;
|
|
15589
|
-
/**
|
|
15590
|
-
* Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
15591
|
-
*/
|
|
15592
|
-
name?: string;
|
|
15593
|
-
/**
|
|
15594
|
-
* Optional. The ID of the view to be downloaded.
|
|
15595
|
-
*/
|
|
15596
|
-
viewId?: string;
|
|
15597
|
-
}
|
|
15598
15292
|
export class Resource$Projects {
|
|
15599
15293
|
context: APIRequestContext;
|
|
15600
15294
|
locations: Resource$Projects$Locations;
|
|
@@ -17051,7 +16745,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17051
16745
|
* pageSize: 'placeholder-value',
|
|
17052
16746
|
* // The standard list page token.
|
|
17053
16747
|
* pageToken: 'placeholder-value',
|
|
17054
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16748
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
17055
16749
|
* returnPartialSuccess: 'placeholder-value',
|
|
17056
16750
|
* },
|
|
17057
16751
|
* );
|
|
@@ -17108,7 +16802,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17108
16802
|
*/
|
|
17109
16803
|
pageToken?: string;
|
|
17110
16804
|
/**
|
|
17111
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16805
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
17112
16806
|
*/
|
|
17113
16807
|
returnPartialSuccess?: boolean;
|
|
17114
16808
|
}
|
|
@@ -17277,6 +16971,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17277
16971
|
* // "isInfobotFaqDataStore": false,
|
|
17278
16972
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
17279
16973
|
* // "name": "my_name",
|
|
16974
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
17280
16975
|
* // "servingConfigDataStore": {},
|
|
17281
16976
|
* // "solutionTypes": [],
|
|
17282
16977
|
* // "startingSchema": {},
|
|
@@ -17441,6 +17136,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17441
17136
|
* // "isInfobotFaqDataStore": false,
|
|
17442
17137
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
17443
17138
|
* // "name": "my_name",
|
|
17139
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
17444
17140
|
* // "servingConfigDataStore": {},
|
|
17445
17141
|
* // "solutionTypes": [],
|
|
17446
17142
|
* // "startingSchema": {},
|
|
@@ -17665,6 +17361,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17665
17361
|
* // "isInfobotFaqDataStore": false,
|
|
17666
17362
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
17667
17363
|
* // "name": "my_name",
|
|
17364
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
17668
17365
|
* // "servingConfigDataStore": {},
|
|
17669
17366
|
* // "solutionTypes": [],
|
|
17670
17367
|
* // "startingSchema": {},
|
|
@@ -17693,6 +17390,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17693
17390
|
* // "isInfobotFaqDataStore": false,
|
|
17694
17391
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
17695
17392
|
* // "name": "my_name",
|
|
17393
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
17696
17394
|
* // "servingConfigDataStore": {},
|
|
17697
17395
|
* // "solutionTypes": [],
|
|
17698
17396
|
* // "startingSchema": {},
|
|
@@ -18856,7 +18554,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18856
18554
|
* pageSize: 'placeholder-value',
|
|
18857
18555
|
* // The standard list page token.
|
|
18858
18556
|
* pageToken: 'placeholder-value',
|
|
18859
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18557
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
18860
18558
|
* returnPartialSuccess: 'placeholder-value',
|
|
18861
18559
|
* },
|
|
18862
18560
|
* );
|
|
@@ -18923,7 +18621,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18923
18621
|
*/
|
|
18924
18622
|
pageToken?: string;
|
|
18925
18623
|
/**
|
|
18926
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18624
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
18927
18625
|
*/
|
|
18928
18626
|
returnPartialSuccess?: boolean;
|
|
18929
18627
|
}
|
|
@@ -20420,7 +20118,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20420
20118
|
* pageSize: 'placeholder-value',
|
|
20421
20119
|
* // The standard list page token.
|
|
20422
20120
|
* pageToken: 'placeholder-value',
|
|
20423
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20121
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20424
20122
|
* returnPartialSuccess: 'placeholder-value',
|
|
20425
20123
|
* },
|
|
20426
20124
|
* );
|
|
@@ -20477,7 +20175,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20477
20175
|
*/
|
|
20478
20176
|
pageToken?: string;
|
|
20479
20177
|
/**
|
|
20480
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20178
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20481
20179
|
*/
|
|
20482
20180
|
returnPartialSuccess?: boolean;
|
|
20483
20181
|
}
|
|
@@ -20598,7 +20296,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20598
20296
|
* pageSize: 'placeholder-value',
|
|
20599
20297
|
* // The standard list page token.
|
|
20600
20298
|
* pageToken: 'placeholder-value',
|
|
20601
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20299
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20602
20300
|
* returnPartialSuccess: 'placeholder-value',
|
|
20603
20301
|
* },
|
|
20604
20302
|
* );
|
|
@@ -20655,7 +20353,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20655
20353
|
*/
|
|
20656
20354
|
pageToken?: string;
|
|
20657
20355
|
/**
|
|
20658
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20356
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20659
20357
|
*/
|
|
20660
20358
|
returnPartialSuccess?: boolean;
|
|
20661
20359
|
}
|
|
@@ -21210,7 +20908,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21210
20908
|
* pageSize: 'placeholder-value',
|
|
21211
20909
|
* // The standard list page token.
|
|
21212
20910
|
* pageToken: 'placeholder-value',
|
|
21213
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20911
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
21214
20912
|
* returnPartialSuccess: 'placeholder-value',
|
|
21215
20913
|
* },
|
|
21216
20914
|
* );
|
|
@@ -21267,7 +20965,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21267
20965
|
*/
|
|
21268
20966
|
pageToken?: string;
|
|
21269
20967
|
/**
|
|
21270
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20968
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
21271
20969
|
*/
|
|
21272
20970
|
returnPartialSuccess?: boolean;
|
|
21273
20971
|
}
|
|
@@ -21362,6 +21060,70 @@ export declare namespace discoveryengine_v1 {
|
|
|
21362
21060
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21363
21061
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21364
21062
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21063
|
+
/**
|
|
21064
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
21065
|
+
* @example
|
|
21066
|
+
* ```js
|
|
21067
|
+
* // Before running the sample:
|
|
21068
|
+
* // - Enable the API at:
|
|
21069
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21070
|
+
* // - Login into gcloud by running:
|
|
21071
|
+
* // ```sh
|
|
21072
|
+
* // $ gcloud auth application-default login
|
|
21073
|
+
* // ```
|
|
21074
|
+
* // - Install the npm module by running:
|
|
21075
|
+
* // ```sh
|
|
21076
|
+
* // $ npm install googleapis
|
|
21077
|
+
* // ```
|
|
21078
|
+
*
|
|
21079
|
+
* const {google} = require('googleapis');
|
|
21080
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
21081
|
+
*
|
|
21082
|
+
* async function main() {
|
|
21083
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21084
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21085
|
+
* scopes: [
|
|
21086
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21087
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21088
|
+
* ],
|
|
21089
|
+
* });
|
|
21090
|
+
*
|
|
21091
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21092
|
+
* const authClient = await auth.getClient();
|
|
21093
|
+
* google.options({auth: authClient});
|
|
21094
|
+
*
|
|
21095
|
+
* // Do the magic
|
|
21096
|
+
* const res =
|
|
21097
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete(
|
|
21098
|
+
* {
|
|
21099
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
21100
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
21101
|
+
* },
|
|
21102
|
+
* );
|
|
21103
|
+
* console.log(res.data);
|
|
21104
|
+
*
|
|
21105
|
+
* // Example response
|
|
21106
|
+
* // {}
|
|
21107
|
+
* }
|
|
21108
|
+
*
|
|
21109
|
+
* main().catch(e => {
|
|
21110
|
+
* console.error(e);
|
|
21111
|
+
* throw e;
|
|
21112
|
+
* });
|
|
21113
|
+
*
|
|
21114
|
+
* ```
|
|
21115
|
+
*
|
|
21116
|
+
* @param params - Parameters for request
|
|
21117
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21118
|
+
* @param callback - Optional callback that handles the response.
|
|
21119
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21120
|
+
*/
|
|
21121
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21122
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
21123
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21124
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
21125
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
21126
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
21365
21127
|
/**
|
|
21366
21128
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
21367
21129
|
* @example
|
|
@@ -21765,6 +21527,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21765
21527
|
* // "branch": "my_branch",
|
|
21766
21528
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
21767
21529
|
* // "contentSearchSpec": {},
|
|
21530
|
+
* // "crowdingSpecs": [],
|
|
21768
21531
|
* // "dataStoreSpecs": [],
|
|
21769
21532
|
* // "displaySpec": {},
|
|
21770
21533
|
* // "facetSpecs": [],
|
|
@@ -21775,6 +21538,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21775
21538
|
* // "offset": 0,
|
|
21776
21539
|
* // "oneBoxPageSize": 0,
|
|
21777
21540
|
* // "orderBy": "my_orderBy",
|
|
21541
|
+
* // "pageCategories": [],
|
|
21778
21542
|
* // "pageSize": 0,
|
|
21779
21543
|
* // "pageToken": "my_pageToken",
|
|
21780
21544
|
* // "params": {},
|
|
@@ -21808,6 +21572,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21808
21572
|
* // "redirectUri": "my_redirectUri",
|
|
21809
21573
|
* // "results": [],
|
|
21810
21574
|
* // "searchLinkPromotions": [],
|
|
21575
|
+
* // "semanticState": "my_semanticState",
|
|
21811
21576
|
* // "sessionInfo": {},
|
|
21812
21577
|
* // "summary": {},
|
|
21813
21578
|
* // "totalSize": 0
|
|
@@ -21881,6 +21646,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21881
21646
|
* // "branch": "my_branch",
|
|
21882
21647
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
21883
21648
|
* // "contentSearchSpec": {},
|
|
21649
|
+
* // "crowdingSpecs": [],
|
|
21884
21650
|
* // "dataStoreSpecs": [],
|
|
21885
21651
|
* // "displaySpec": {},
|
|
21886
21652
|
* // "facetSpecs": [],
|
|
@@ -21891,6 +21657,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21891
21657
|
* // "offset": 0,
|
|
21892
21658
|
* // "oneBoxPageSize": 0,
|
|
21893
21659
|
* // "orderBy": "my_orderBy",
|
|
21660
|
+
* // "pageCategories": [],
|
|
21894
21661
|
* // "pageSize": 0,
|
|
21895
21662
|
* // "pageToken": "my_pageToken",
|
|
21896
21663
|
* // "params": {},
|
|
@@ -21924,6 +21691,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21924
21691
|
* // "redirectUri": "my_redirectUri",
|
|
21925
21692
|
* // "results": [],
|
|
21926
21693
|
* // "searchLinkPromotions": [],
|
|
21694
|
+
* // "semanticState": "my_semanticState",
|
|
21927
21695
|
* // "sessionInfo": {},
|
|
21928
21696
|
* // "summary": {},
|
|
21929
21697
|
* // "totalSize": 0
|
|
@@ -22047,6 +21815,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
22047
21815
|
*/
|
|
22048
21816
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
22049
21817
|
}
|
|
21818
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
21819
|
+
/**
|
|
21820
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
21821
|
+
*/
|
|
21822
|
+
name?: string;
|
|
21823
|
+
}
|
|
22050
21824
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
22051
21825
|
/**
|
|
22052
21826
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -23243,7 +23017,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
23243
23017
|
* pageSize: 'placeholder-value',
|
|
23244
23018
|
* // The standard list page token.
|
|
23245
23019
|
* pageToken: 'placeholder-value',
|
|
23246
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
23020
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
23247
23021
|
* returnPartialSuccess: 'placeholder-value',
|
|
23248
23022
|
* },
|
|
23249
23023
|
* );
|
|
@@ -23300,7 +23074,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
23300
23074
|
*/
|
|
23301
23075
|
pageToken?: string;
|
|
23302
23076
|
/**
|
|
23303
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
23077
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
23304
23078
|
*/
|
|
23305
23079
|
returnPartialSuccess?: boolean;
|
|
23306
23080
|
}
|
|
@@ -24204,7 +23978,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24204
23978
|
* pageSize: 'placeholder-value',
|
|
24205
23979
|
* // The standard list page token.
|
|
24206
23980
|
* pageToken: 'placeholder-value',
|
|
24207
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
23981
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
24208
23982
|
* returnPartialSuccess: 'placeholder-value',
|
|
24209
23983
|
* },
|
|
24210
23984
|
* );
|
|
@@ -24261,7 +24035,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24261
24035
|
*/
|
|
24262
24036
|
pageToken?: string;
|
|
24263
24037
|
/**
|
|
24264
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
24038
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
24265
24039
|
*/
|
|
24266
24040
|
returnPartialSuccess?: boolean;
|
|
24267
24041
|
}
|
|
@@ -25647,9 +25421,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
25647
25421
|
}
|
|
25648
25422
|
export class Resource$Projects$Locations$Collections$Engines$Assistants {
|
|
25649
25423
|
context: APIRequestContext;
|
|
25424
|
+
agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
|
|
25650
25425
|
constructor(context: APIRequestContext);
|
|
25651
25426
|
/**
|
|
25652
|
-
*
|
|
25427
|
+
* Creates an Assistant.
|
|
25653
25428
|
* @example
|
|
25654
25429
|
* ```js
|
|
25655
25430
|
* // Before running the sample:
|
|
@@ -25683,10 +25458,27 @@ export declare namespace discoveryengine_v1 {
|
|
|
25683
25458
|
*
|
|
25684
25459
|
* // Do the magic
|
|
25685
25460
|
* const res =
|
|
25686
|
-
* await discoveryengine.projects.locations.collections.engines.assistants.
|
|
25461
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.create(
|
|
25687
25462
|
* {
|
|
25688
|
-
* // Required.
|
|
25689
|
-
*
|
|
25463
|
+
* // Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
25464
|
+
* assistantId: 'placeholder-value',
|
|
25465
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25466
|
+
* parent:
|
|
25467
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
25468
|
+
*
|
|
25469
|
+
* // Request body metadata
|
|
25470
|
+
* requestBody: {
|
|
25471
|
+
* // request body parameters
|
|
25472
|
+
* // {
|
|
25473
|
+
* // "customerPolicy": {},
|
|
25474
|
+
* // "description": "my_description",
|
|
25475
|
+
* // "displayName": "my_displayName",
|
|
25476
|
+
* // "enabledTools": {},
|
|
25477
|
+
* // "generationConfig": {},
|
|
25478
|
+
* // "name": "my_name",
|
|
25479
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25480
|
+
* // }
|
|
25481
|
+
* },
|
|
25690
25482
|
* },
|
|
25691
25483
|
* );
|
|
25692
25484
|
* console.log(res.data);
|
|
@@ -25694,6 +25486,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
25694
25486
|
* // Example response
|
|
25695
25487
|
* // {
|
|
25696
25488
|
* // "customerPolicy": {},
|
|
25489
|
+
* // "description": "my_description",
|
|
25490
|
+
* // "displayName": "my_displayName",
|
|
25697
25491
|
* // "enabledTools": {},
|
|
25698
25492
|
* // "generationConfig": {},
|
|
25699
25493
|
* // "name": "my_name",
|
|
@@ -25713,14 +25507,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
25713
25507
|
* @param callback - Optional callback that handles the response.
|
|
25714
25508
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25715
25509
|
*/
|
|
25716
|
-
|
|
25717
|
-
|
|
25718
|
-
|
|
25719
|
-
|
|
25720
|
-
|
|
25721
|
-
|
|
25510
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25511
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Assistant>>;
|
|
25512
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25513
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25514
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25515
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25722
25516
|
/**
|
|
25723
|
-
*
|
|
25517
|
+
* Deletes an Assistant.
|
|
25724
25518
|
* @example
|
|
25725
25519
|
* ```js
|
|
25726
25520
|
* // Before running the sample:
|
|
@@ -25754,36 +25548,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
25754
25548
|
*
|
|
25755
25549
|
* // Do the magic
|
|
25756
25550
|
* const res =
|
|
25757
|
-
* await discoveryengine.projects.locations.collections.engines.assistants.
|
|
25551
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.delete(
|
|
25758
25552
|
* {
|
|
25759
|
-
* //
|
|
25553
|
+
* // Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.
|
|
25760
25554
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25761
|
-
* // The list of fields to update.
|
|
25762
|
-
* updateMask: 'placeholder-value',
|
|
25763
|
-
*
|
|
25764
|
-
* // Request body metadata
|
|
25765
|
-
* requestBody: {
|
|
25766
|
-
* // request body parameters
|
|
25767
|
-
* // {
|
|
25768
|
-
* // "customerPolicy": {},
|
|
25769
|
-
* // "enabledTools": {},
|
|
25770
|
-
* // "generationConfig": {},
|
|
25771
|
-
* // "name": "my_name",
|
|
25772
|
-
* // "webGroundingType": "my_webGroundingType"
|
|
25773
|
-
* // }
|
|
25774
|
-
* },
|
|
25775
25555
|
* },
|
|
25776
25556
|
* );
|
|
25777
25557
|
* console.log(res.data);
|
|
25778
25558
|
*
|
|
25779
25559
|
* // Example response
|
|
25780
|
-
* // {
|
|
25781
|
-
* // "customerPolicy": {},
|
|
25782
|
-
* // "enabledTools": {},
|
|
25783
|
-
* // "generationConfig": {},
|
|
25784
|
-
* // "name": "my_name",
|
|
25785
|
-
* // "webGroundingType": "my_webGroundingType"
|
|
25786
|
-
* // }
|
|
25560
|
+
* // {}
|
|
25787
25561
|
* }
|
|
25788
25562
|
*
|
|
25789
25563
|
* main().catch(e => {
|
|
@@ -25798,14 +25572,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
25798
25572
|
* @param callback - Optional callback that handles the response.
|
|
25799
25573
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25800
25574
|
*/
|
|
25801
|
-
|
|
25802
|
-
|
|
25803
|
-
|
|
25804
|
-
|
|
25805
|
-
|
|
25806
|
-
|
|
25575
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25576
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
25577
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25578
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25579
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25580
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25807
25581
|
/**
|
|
25808
|
-
*
|
|
25582
|
+
* Gets an Assistant.
|
|
25809
25583
|
* @example
|
|
25810
25584
|
* ```js
|
|
25811
25585
|
* // Before running the sample:
|
|
@@ -25839,31 +25613,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
25839
25613
|
*
|
|
25840
25614
|
* // Do the magic
|
|
25841
25615
|
* const res =
|
|
25842
|
-
* await discoveryengine.projects.locations.collections.engines.assistants.
|
|
25616
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.get(
|
|
25843
25617
|
* {
|
|
25844
|
-
* // Required.
|
|
25618
|
+
* // Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25845
25619
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25846
|
-
*
|
|
25847
|
-
* // Request body metadata
|
|
25848
|
-
* requestBody: {
|
|
25849
|
-
* // request body parameters
|
|
25850
|
-
* // {
|
|
25851
|
-
* // "generationSpec": {},
|
|
25852
|
-
* // "query": {},
|
|
25853
|
-
* // "session": "my_session",
|
|
25854
|
-
* // "toolsSpec": {},
|
|
25855
|
-
* // "userMetadata": {}
|
|
25856
|
-
* // }
|
|
25857
|
-
* },
|
|
25858
25620
|
* },
|
|
25859
25621
|
* );
|
|
25860
25622
|
* console.log(res.data);
|
|
25861
25623
|
*
|
|
25862
25624
|
* // Example response
|
|
25863
25625
|
* // {
|
|
25864
|
-
* // "
|
|
25865
|
-
* // "
|
|
25866
|
-
* // "
|
|
25626
|
+
* // "customerPolicy": {},
|
|
25627
|
+
* // "description": "my_description",
|
|
25628
|
+
* // "displayName": "my_displayName",
|
|
25629
|
+
* // "enabledTools": {},
|
|
25630
|
+
* // "generationConfig": {},
|
|
25631
|
+
* // "name": "my_name",
|
|
25632
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25867
25633
|
* // }
|
|
25868
25634
|
* }
|
|
25869
25635
|
*
|
|
@@ -25879,48 +25645,411 @@ export declare namespace discoveryengine_v1 {
|
|
|
25879
25645
|
* @param callback - Optional callback that handles the response.
|
|
25880
25646
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25881
25647
|
*/
|
|
25882
|
-
|
|
25883
|
-
|
|
25884
|
-
|
|
25885
|
-
|
|
25886
|
-
|
|
25887
|
-
|
|
25888
|
-
}
|
|
25889
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
|
|
25890
|
-
/**
|
|
25891
|
-
* Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25892
|
-
*/
|
|
25893
|
-
name?: string;
|
|
25894
|
-
}
|
|
25895
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
|
|
25896
|
-
/**
|
|
25897
|
-
* Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
25898
|
-
*/
|
|
25899
|
-
name?: string;
|
|
25900
|
-
/**
|
|
25901
|
-
* The list of fields to update.
|
|
25902
|
-
*/
|
|
25903
|
-
updateMask?: string;
|
|
25904
|
-
/**
|
|
25905
|
-
* Request body metadata
|
|
25906
|
-
*/
|
|
25907
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1Assistant;
|
|
25908
|
-
}
|
|
25909
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist extends StandardParameters {
|
|
25910
|
-
/**
|
|
25911
|
-
* Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25912
|
-
*/
|
|
25913
|
-
name?: string;
|
|
25914
|
-
/**
|
|
25915
|
-
* Request body metadata
|
|
25916
|
-
*/
|
|
25917
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1StreamAssistRequest;
|
|
25918
|
-
}
|
|
25919
|
-
export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
25920
|
-
context: APIRequestContext;
|
|
25921
|
-
constructor(context: APIRequestContext);
|
|
25648
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25649
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Assistant>>;
|
|
25650
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25651
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25652
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25653
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25922
25654
|
/**
|
|
25923
|
-
*
|
|
25655
|
+
* Lists all Assistants under an Engine.
|
|
25656
|
+
* @example
|
|
25657
|
+
* ```js
|
|
25658
|
+
* // Before running the sample:
|
|
25659
|
+
* // - Enable the API at:
|
|
25660
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25661
|
+
* // - Login into gcloud by running:
|
|
25662
|
+
* // ```sh
|
|
25663
|
+
* // $ gcloud auth application-default login
|
|
25664
|
+
* // ```
|
|
25665
|
+
* // - Install the npm module by running:
|
|
25666
|
+
* // ```sh
|
|
25667
|
+
* // $ npm install googleapis
|
|
25668
|
+
* // ```
|
|
25669
|
+
*
|
|
25670
|
+
* const {google} = require('googleapis');
|
|
25671
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25672
|
+
*
|
|
25673
|
+
* async function main() {
|
|
25674
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25675
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25676
|
+
* scopes: [
|
|
25677
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25678
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25679
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25680
|
+
* ],
|
|
25681
|
+
* });
|
|
25682
|
+
*
|
|
25683
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25684
|
+
* const authClient = await auth.getClient();
|
|
25685
|
+
* google.options({auth: authClient});
|
|
25686
|
+
*
|
|
25687
|
+
* // Do the magic
|
|
25688
|
+
* const res =
|
|
25689
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.list(
|
|
25690
|
+
* {
|
|
25691
|
+
* // Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
25692
|
+
* pageSize: 'placeholder-value',
|
|
25693
|
+
* // A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.
|
|
25694
|
+
* pageToken: 'placeholder-value',
|
|
25695
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25696
|
+
* parent:
|
|
25697
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
25698
|
+
* },
|
|
25699
|
+
* );
|
|
25700
|
+
* console.log(res.data);
|
|
25701
|
+
*
|
|
25702
|
+
* // Example response
|
|
25703
|
+
* // {
|
|
25704
|
+
* // "assistants": [],
|
|
25705
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
25706
|
+
* // }
|
|
25707
|
+
* }
|
|
25708
|
+
*
|
|
25709
|
+
* main().catch(e => {
|
|
25710
|
+
* console.error(e);
|
|
25711
|
+
* throw e;
|
|
25712
|
+
* });
|
|
25713
|
+
*
|
|
25714
|
+
* ```
|
|
25715
|
+
*
|
|
25716
|
+
* @param params - Parameters for request
|
|
25717
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25718
|
+
* @param callback - Optional callback that handles the response.
|
|
25719
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25720
|
+
*/
|
|
25721
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25722
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>>;
|
|
25723
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25724
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>): void;
|
|
25725
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>): void;
|
|
25726
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>): void;
|
|
25727
|
+
/**
|
|
25728
|
+
* Updates an Assistant
|
|
25729
|
+
* @example
|
|
25730
|
+
* ```js
|
|
25731
|
+
* // Before running the sample:
|
|
25732
|
+
* // - Enable the API at:
|
|
25733
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25734
|
+
* // - Login into gcloud by running:
|
|
25735
|
+
* // ```sh
|
|
25736
|
+
* // $ gcloud auth application-default login
|
|
25737
|
+
* // ```
|
|
25738
|
+
* // - Install the npm module by running:
|
|
25739
|
+
* // ```sh
|
|
25740
|
+
* // $ npm install googleapis
|
|
25741
|
+
* // ```
|
|
25742
|
+
*
|
|
25743
|
+
* const {google} = require('googleapis');
|
|
25744
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25745
|
+
*
|
|
25746
|
+
* async function main() {
|
|
25747
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25748
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25749
|
+
* scopes: [
|
|
25750
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25751
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25752
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25753
|
+
* ],
|
|
25754
|
+
* });
|
|
25755
|
+
*
|
|
25756
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25757
|
+
* const authClient = await auth.getClient();
|
|
25758
|
+
* google.options({auth: authClient});
|
|
25759
|
+
*
|
|
25760
|
+
* // Do the magic
|
|
25761
|
+
* const res =
|
|
25762
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.patch(
|
|
25763
|
+
* {
|
|
25764
|
+
* // Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
25765
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25766
|
+
* // The list of fields to update.
|
|
25767
|
+
* updateMask: 'placeholder-value',
|
|
25768
|
+
*
|
|
25769
|
+
* // Request body metadata
|
|
25770
|
+
* requestBody: {
|
|
25771
|
+
* // request body parameters
|
|
25772
|
+
* // {
|
|
25773
|
+
* // "customerPolicy": {},
|
|
25774
|
+
* // "description": "my_description",
|
|
25775
|
+
* // "displayName": "my_displayName",
|
|
25776
|
+
* // "enabledTools": {},
|
|
25777
|
+
* // "generationConfig": {},
|
|
25778
|
+
* // "name": "my_name",
|
|
25779
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25780
|
+
* // }
|
|
25781
|
+
* },
|
|
25782
|
+
* },
|
|
25783
|
+
* );
|
|
25784
|
+
* console.log(res.data);
|
|
25785
|
+
*
|
|
25786
|
+
* // Example response
|
|
25787
|
+
* // {
|
|
25788
|
+
* // "customerPolicy": {},
|
|
25789
|
+
* // "description": "my_description",
|
|
25790
|
+
* // "displayName": "my_displayName",
|
|
25791
|
+
* // "enabledTools": {},
|
|
25792
|
+
* // "generationConfig": {},
|
|
25793
|
+
* // "name": "my_name",
|
|
25794
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25795
|
+
* // }
|
|
25796
|
+
* }
|
|
25797
|
+
*
|
|
25798
|
+
* main().catch(e => {
|
|
25799
|
+
* console.error(e);
|
|
25800
|
+
* throw e;
|
|
25801
|
+
* });
|
|
25802
|
+
*
|
|
25803
|
+
* ```
|
|
25804
|
+
*
|
|
25805
|
+
* @param params - Parameters for request
|
|
25806
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25807
|
+
* @param callback - Optional callback that handles the response.
|
|
25808
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25809
|
+
*/
|
|
25810
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25811
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Assistant>>;
|
|
25812
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25813
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25814
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25815
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25816
|
+
/**
|
|
25817
|
+
* Assists the user with a query in a streaming fashion.
|
|
25818
|
+
* @example
|
|
25819
|
+
* ```js
|
|
25820
|
+
* // Before running the sample:
|
|
25821
|
+
* // - Enable the API at:
|
|
25822
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25823
|
+
* // - Login into gcloud by running:
|
|
25824
|
+
* // ```sh
|
|
25825
|
+
* // $ gcloud auth application-default login
|
|
25826
|
+
* // ```
|
|
25827
|
+
* // - Install the npm module by running:
|
|
25828
|
+
* // ```sh
|
|
25829
|
+
* // $ npm install googleapis
|
|
25830
|
+
* // ```
|
|
25831
|
+
*
|
|
25832
|
+
* const {google} = require('googleapis');
|
|
25833
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25834
|
+
*
|
|
25835
|
+
* async function main() {
|
|
25836
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25837
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25838
|
+
* scopes: [
|
|
25839
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25840
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25841
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25842
|
+
* ],
|
|
25843
|
+
* });
|
|
25844
|
+
*
|
|
25845
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25846
|
+
* const authClient = await auth.getClient();
|
|
25847
|
+
* google.options({auth: authClient});
|
|
25848
|
+
*
|
|
25849
|
+
* // Do the magic
|
|
25850
|
+
* const res =
|
|
25851
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.streamAssist(
|
|
25852
|
+
* {
|
|
25853
|
+
* // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25854
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25855
|
+
*
|
|
25856
|
+
* // Request body metadata
|
|
25857
|
+
* requestBody: {
|
|
25858
|
+
* // request body parameters
|
|
25859
|
+
* // {
|
|
25860
|
+
* // "generationSpec": {},
|
|
25861
|
+
* // "query": {},
|
|
25862
|
+
* // "session": "my_session",
|
|
25863
|
+
* // "toolsSpec": {},
|
|
25864
|
+
* // "userMetadata": {}
|
|
25865
|
+
* // }
|
|
25866
|
+
* },
|
|
25867
|
+
* },
|
|
25868
|
+
* );
|
|
25869
|
+
* console.log(res.data);
|
|
25870
|
+
*
|
|
25871
|
+
* // Example response
|
|
25872
|
+
* // {
|
|
25873
|
+
* // "answer": {},
|
|
25874
|
+
* // "assistToken": "my_assistToken",
|
|
25875
|
+
* // "invocationTools": [],
|
|
25876
|
+
* // "sessionInfo": {}
|
|
25877
|
+
* // }
|
|
25878
|
+
* }
|
|
25879
|
+
*
|
|
25880
|
+
* main().catch(e => {
|
|
25881
|
+
* console.error(e);
|
|
25882
|
+
* throw e;
|
|
25883
|
+
* });
|
|
25884
|
+
*
|
|
25885
|
+
* ```
|
|
25886
|
+
*
|
|
25887
|
+
* @param params - Parameters for request
|
|
25888
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25889
|
+
* @param callback - Optional callback that handles the response.
|
|
25890
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25891
|
+
*/
|
|
25892
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25893
|
+
streamAssist(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>>;
|
|
25894
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25895
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>): void;
|
|
25896
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>): void;
|
|
25897
|
+
streamAssist(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>): void;
|
|
25898
|
+
}
|
|
25899
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create extends StandardParameters {
|
|
25900
|
+
/**
|
|
25901
|
+
* Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
25902
|
+
*/
|
|
25903
|
+
assistantId?: string;
|
|
25904
|
+
/**
|
|
25905
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25906
|
+
*/
|
|
25907
|
+
parent?: string;
|
|
25908
|
+
/**
|
|
25909
|
+
* Request body metadata
|
|
25910
|
+
*/
|
|
25911
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1Assistant;
|
|
25912
|
+
}
|
|
25913
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete extends StandardParameters {
|
|
25914
|
+
/**
|
|
25915
|
+
* Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.
|
|
25916
|
+
*/
|
|
25917
|
+
name?: string;
|
|
25918
|
+
}
|
|
25919
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
|
|
25920
|
+
/**
|
|
25921
|
+
* Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25922
|
+
*/
|
|
25923
|
+
name?: string;
|
|
25924
|
+
}
|
|
25925
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$List extends StandardParameters {
|
|
25926
|
+
/**
|
|
25927
|
+
* Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
|
|
25928
|
+
*/
|
|
25929
|
+
pageSize?: number;
|
|
25930
|
+
/**
|
|
25931
|
+
* A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.
|
|
25932
|
+
*/
|
|
25933
|
+
pageToken?: string;
|
|
25934
|
+
/**
|
|
25935
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25936
|
+
*/
|
|
25937
|
+
parent?: string;
|
|
25938
|
+
}
|
|
25939
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
|
|
25940
|
+
/**
|
|
25941
|
+
* Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
25942
|
+
*/
|
|
25943
|
+
name?: string;
|
|
25944
|
+
/**
|
|
25945
|
+
* The list of fields to update.
|
|
25946
|
+
*/
|
|
25947
|
+
updateMask?: string;
|
|
25948
|
+
/**
|
|
25949
|
+
* Request body metadata
|
|
25950
|
+
*/
|
|
25951
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1Assistant;
|
|
25952
|
+
}
|
|
25953
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist extends StandardParameters {
|
|
25954
|
+
/**
|
|
25955
|
+
* Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25956
|
+
*/
|
|
25957
|
+
name?: string;
|
|
25958
|
+
/**
|
|
25959
|
+
* Request body metadata
|
|
25960
|
+
*/
|
|
25961
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1StreamAssistRequest;
|
|
25962
|
+
}
|
|
25963
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents {
|
|
25964
|
+
context: APIRequestContext;
|
|
25965
|
+
operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations;
|
|
25966
|
+
constructor(context: APIRequestContext);
|
|
25967
|
+
}
|
|
25968
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations {
|
|
25969
|
+
context: APIRequestContext;
|
|
25970
|
+
constructor(context: APIRequestContext);
|
|
25971
|
+
/**
|
|
25972
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
25973
|
+
* @example
|
|
25974
|
+
* ```js
|
|
25975
|
+
* // Before running the sample:
|
|
25976
|
+
* // - Enable the API at:
|
|
25977
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25978
|
+
* // - Login into gcloud by running:
|
|
25979
|
+
* // ```sh
|
|
25980
|
+
* // $ gcloud auth application-default login
|
|
25981
|
+
* // ```
|
|
25982
|
+
* // - Install the npm module by running:
|
|
25983
|
+
* // ```sh
|
|
25984
|
+
* // $ npm install googleapis
|
|
25985
|
+
* // ```
|
|
25986
|
+
*
|
|
25987
|
+
* const {google} = require('googleapis');
|
|
25988
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25989
|
+
*
|
|
25990
|
+
* async function main() {
|
|
25991
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25992
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25993
|
+
* scopes: [
|
|
25994
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25995
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25996
|
+
* ],
|
|
25997
|
+
* });
|
|
25998
|
+
*
|
|
25999
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
26000
|
+
* const authClient = await auth.getClient();
|
|
26001
|
+
* google.options({auth: authClient});
|
|
26002
|
+
*
|
|
26003
|
+
* // Do the magic
|
|
26004
|
+
* const res =
|
|
26005
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get(
|
|
26006
|
+
* {
|
|
26007
|
+
* // The name of the operation resource.
|
|
26008
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent/operations/my-operation',
|
|
26009
|
+
* },
|
|
26010
|
+
* );
|
|
26011
|
+
* console.log(res.data);
|
|
26012
|
+
*
|
|
26013
|
+
* // Example response
|
|
26014
|
+
* // {
|
|
26015
|
+
* // "done": false,
|
|
26016
|
+
* // "error": {},
|
|
26017
|
+
* // "metadata": {},
|
|
26018
|
+
* // "name": "my_name",
|
|
26019
|
+
* // "response": {}
|
|
26020
|
+
* // }
|
|
26021
|
+
* }
|
|
26022
|
+
*
|
|
26023
|
+
* main().catch(e => {
|
|
26024
|
+
* console.error(e);
|
|
26025
|
+
* throw e;
|
|
26026
|
+
* });
|
|
26027
|
+
*
|
|
26028
|
+
* ```
|
|
26029
|
+
*
|
|
26030
|
+
* @param params - Parameters for request
|
|
26031
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
26032
|
+
* @param callback - Optional callback that handles the response.
|
|
26033
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
26034
|
+
*/
|
|
26035
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
26036
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
26037
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
26038
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
26039
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
26040
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
26041
|
+
}
|
|
26042
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get extends StandardParameters {
|
|
26043
|
+
/**
|
|
26044
|
+
* The name of the operation resource.
|
|
26045
|
+
*/
|
|
26046
|
+
name?: string;
|
|
26047
|
+
}
|
|
26048
|
+
export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
26049
|
+
context: APIRequestContext;
|
|
26050
|
+
constructor(context: APIRequestContext);
|
|
26051
|
+
/**
|
|
26052
|
+
* Completes the user input with advanced keyword suggestions.
|
|
25924
26053
|
* @example
|
|
25925
26054
|
* ```js
|
|
25926
26055
|
* // Before running the sample:
|
|
@@ -27208,7 +27337,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27208
27337
|
* pageSize: 'placeholder-value',
|
|
27209
27338
|
* // The standard list page token.
|
|
27210
27339
|
* pageToken: 'placeholder-value',
|
|
27211
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
27340
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
27212
27341
|
* returnPartialSuccess: 'placeholder-value',
|
|
27213
27342
|
* },
|
|
27214
27343
|
* );
|
|
@@ -27275,7 +27404,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27275
27404
|
*/
|
|
27276
27405
|
pageToken?: string;
|
|
27277
27406
|
/**
|
|
27278
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
27407
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
27279
27408
|
*/
|
|
27280
27409
|
returnPartialSuccess?: boolean;
|
|
27281
27410
|
}
|
|
@@ -27370,6 +27499,70 @@ export declare namespace discoveryengine_v1 {
|
|
|
27370
27499
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27371
27500
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27372
27501
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27502
|
+
/**
|
|
27503
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
27504
|
+
* @example
|
|
27505
|
+
* ```js
|
|
27506
|
+
* // Before running the sample:
|
|
27507
|
+
* // - Enable the API at:
|
|
27508
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
27509
|
+
* // - Login into gcloud by running:
|
|
27510
|
+
* // ```sh
|
|
27511
|
+
* // $ gcloud auth application-default login
|
|
27512
|
+
* // ```
|
|
27513
|
+
* // - Install the npm module by running:
|
|
27514
|
+
* // ```sh
|
|
27515
|
+
* // $ npm install googleapis
|
|
27516
|
+
* // ```
|
|
27517
|
+
*
|
|
27518
|
+
* const {google} = require('googleapis');
|
|
27519
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
27520
|
+
*
|
|
27521
|
+
* async function main() {
|
|
27522
|
+
* const auth = new google.auth.GoogleAuth({
|
|
27523
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
27524
|
+
* scopes: [
|
|
27525
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
27526
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
27527
|
+
* ],
|
|
27528
|
+
* });
|
|
27529
|
+
*
|
|
27530
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
27531
|
+
* const authClient = await auth.getClient();
|
|
27532
|
+
* google.options({auth: authClient});
|
|
27533
|
+
*
|
|
27534
|
+
* // Do the magic
|
|
27535
|
+
* const res =
|
|
27536
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.delete(
|
|
27537
|
+
* {
|
|
27538
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
27539
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig',
|
|
27540
|
+
* },
|
|
27541
|
+
* );
|
|
27542
|
+
* console.log(res.data);
|
|
27543
|
+
*
|
|
27544
|
+
* // Example response
|
|
27545
|
+
* // {}
|
|
27546
|
+
* }
|
|
27547
|
+
*
|
|
27548
|
+
* main().catch(e => {
|
|
27549
|
+
* console.error(e);
|
|
27550
|
+
* throw e;
|
|
27551
|
+
* });
|
|
27552
|
+
*
|
|
27553
|
+
* ```
|
|
27554
|
+
*
|
|
27555
|
+
* @param params - Parameters for request
|
|
27556
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
27557
|
+
* @param callback - Optional callback that handles the response.
|
|
27558
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27559
|
+
*/
|
|
27560
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
27561
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
27562
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
27563
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
27564
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
27565
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
27373
27566
|
/**
|
|
27374
27567
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
27375
27568
|
* @example
|
|
@@ -27773,6 +27966,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27773
27966
|
* // "branch": "my_branch",
|
|
27774
27967
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
27775
27968
|
* // "contentSearchSpec": {},
|
|
27969
|
+
* // "crowdingSpecs": [],
|
|
27776
27970
|
* // "dataStoreSpecs": [],
|
|
27777
27971
|
* // "displaySpec": {},
|
|
27778
27972
|
* // "facetSpecs": [],
|
|
@@ -27783,6 +27977,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27783
27977
|
* // "offset": 0,
|
|
27784
27978
|
* // "oneBoxPageSize": 0,
|
|
27785
27979
|
* // "orderBy": "my_orderBy",
|
|
27980
|
+
* // "pageCategories": [],
|
|
27786
27981
|
* // "pageSize": 0,
|
|
27787
27982
|
* // "pageToken": "my_pageToken",
|
|
27788
27983
|
* // "params": {},
|
|
@@ -27816,6 +28011,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27816
28011
|
* // "redirectUri": "my_redirectUri",
|
|
27817
28012
|
* // "results": [],
|
|
27818
28013
|
* // "searchLinkPromotions": [],
|
|
28014
|
+
* // "semanticState": "my_semanticState",
|
|
27819
28015
|
* // "sessionInfo": {},
|
|
27820
28016
|
* // "summary": {},
|
|
27821
28017
|
* // "totalSize": 0
|
|
@@ -27889,6 +28085,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27889
28085
|
* // "branch": "my_branch",
|
|
27890
28086
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
27891
28087
|
* // "contentSearchSpec": {},
|
|
28088
|
+
* // "crowdingSpecs": [],
|
|
27892
28089
|
* // "dataStoreSpecs": [],
|
|
27893
28090
|
* // "displaySpec": {},
|
|
27894
28091
|
* // "facetSpecs": [],
|
|
@@ -27899,6 +28096,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27899
28096
|
* // "offset": 0,
|
|
27900
28097
|
* // "oneBoxPageSize": 0,
|
|
27901
28098
|
* // "orderBy": "my_orderBy",
|
|
28099
|
+
* // "pageCategories": [],
|
|
27902
28100
|
* // "pageSize": 0,
|
|
27903
28101
|
* // "pageToken": "my_pageToken",
|
|
27904
28102
|
* // "params": {},
|
|
@@ -27932,6 +28130,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27932
28130
|
* // "redirectUri": "my_redirectUri",
|
|
27933
28131
|
* // "results": [],
|
|
27934
28132
|
* // "searchLinkPromotions": [],
|
|
28133
|
+
* // "semanticState": "my_semanticState",
|
|
27935
28134
|
* // "sessionInfo": {},
|
|
27936
28135
|
* // "summary": {},
|
|
27937
28136
|
* // "totalSize": 0
|
|
@@ -28055,6 +28254,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
28055
28254
|
*/
|
|
28056
28255
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
28057
28256
|
}
|
|
28257
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
|
|
28258
|
+
/**
|
|
28259
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
28260
|
+
*/
|
|
28261
|
+
name?: string;
|
|
28262
|
+
}
|
|
28058
28263
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
28059
28264
|
/**
|
|
28060
28265
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -29085,7 +29290,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29085
29290
|
* pageSize: 'placeholder-value',
|
|
29086
29291
|
* // The standard list page token.
|
|
29087
29292
|
* pageToken: 'placeholder-value',
|
|
29088
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
29293
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
29089
29294
|
* returnPartialSuccess: 'placeholder-value',
|
|
29090
29295
|
* });
|
|
29091
29296
|
* console.log(res.data);
|
|
@@ -29141,7 +29346,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29141
29346
|
*/
|
|
29142
29347
|
pageToken?: string;
|
|
29143
29348
|
/**
|
|
29144
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
29349
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
29145
29350
|
*/
|
|
29146
29351
|
returnPartialSuccess?: boolean;
|
|
29147
29352
|
}
|
|
@@ -29306,6 +29511,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29306
29511
|
* // "isInfobotFaqDataStore": false,
|
|
29307
29512
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
29308
29513
|
* // "name": "my_name",
|
|
29514
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
29309
29515
|
* // "servingConfigDataStore": {},
|
|
29310
29516
|
* // "solutionTypes": [],
|
|
29311
29517
|
* // "startingSchema": {},
|
|
@@ -29468,6 +29674,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29468
29674
|
* // "isInfobotFaqDataStore": false,
|
|
29469
29675
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
29470
29676
|
* // "name": "my_name",
|
|
29677
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
29471
29678
|
* // "servingConfigDataStore": {},
|
|
29472
29679
|
* // "solutionTypes": [],
|
|
29473
29680
|
* // "startingSchema": {},
|
|
@@ -29687,6 +29894,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29687
29894
|
* // "isInfobotFaqDataStore": false,
|
|
29688
29895
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
29689
29896
|
* // "name": "my_name",
|
|
29897
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
29690
29898
|
* // "servingConfigDataStore": {},
|
|
29691
29899
|
* // "solutionTypes": [],
|
|
29692
29900
|
* // "startingSchema": {},
|
|
@@ -29715,6 +29923,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29715
29923
|
* // "isInfobotFaqDataStore": false,
|
|
29716
29924
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
29717
29925
|
* // "name": "my_name",
|
|
29926
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
29718
29927
|
* // "servingConfigDataStore": {},
|
|
29719
29928
|
* // "solutionTypes": [],
|
|
29720
29929
|
* // "startingSchema": {},
|
|
@@ -30784,7 +30993,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
30784
30993
|
* pageSize: 'placeholder-value',
|
|
30785
30994
|
* // The standard list page token.
|
|
30786
30995
|
* pageToken: 'placeholder-value',
|
|
30787
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
30996
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30788
30997
|
* returnPartialSuccess: 'placeholder-value',
|
|
30789
30998
|
* },
|
|
30790
30999
|
* );
|
|
@@ -30851,7 +31060,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
30851
31060
|
*/
|
|
30852
31061
|
pageToken?: string;
|
|
30853
31062
|
/**
|
|
30854
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
31063
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30855
31064
|
*/
|
|
30856
31065
|
returnPartialSuccess?: boolean;
|
|
30857
31066
|
}
|
|
@@ -32246,7 +32455,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32246
32455
|
* pageSize: 'placeholder-value',
|
|
32247
32456
|
* // The standard list page token.
|
|
32248
32457
|
* pageToken: 'placeholder-value',
|
|
32249
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32458
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
32250
32459
|
* returnPartialSuccess: 'placeholder-value',
|
|
32251
32460
|
* });
|
|
32252
32461
|
* console.log(res.data);
|
|
@@ -32302,7 +32511,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32302
32511
|
*/
|
|
32303
32512
|
pageToken?: string;
|
|
32304
32513
|
/**
|
|
32305
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32514
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
32306
32515
|
*/
|
|
32307
32516
|
returnPartialSuccess?: boolean;
|
|
32308
32517
|
}
|
|
@@ -32420,7 +32629,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32420
32629
|
* pageSize: 'placeholder-value',
|
|
32421
32630
|
* // The standard list page token.
|
|
32422
32631
|
* pageToken: 'placeholder-value',
|
|
32423
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32632
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
32424
32633
|
* returnPartialSuccess: 'placeholder-value',
|
|
32425
32634
|
* });
|
|
32426
32635
|
* console.log(res.data);
|
|
@@ -32476,7 +32685,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32476
32685
|
*/
|
|
32477
32686
|
pageToken?: string;
|
|
32478
32687
|
/**
|
|
32479
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32688
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
32480
32689
|
*/
|
|
32481
32690
|
returnPartialSuccess?: boolean;
|
|
32482
32691
|
}
|
|
@@ -32990,6 +33199,68 @@ export declare namespace discoveryengine_v1 {
|
|
|
32990
33199
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
32991
33200
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
32992
33201
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
33202
|
+
/**
|
|
33203
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
33204
|
+
* @example
|
|
33205
|
+
* ```js
|
|
33206
|
+
* // Before running the sample:
|
|
33207
|
+
* // - Enable the API at:
|
|
33208
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33209
|
+
* // - Login into gcloud by running:
|
|
33210
|
+
* // ```sh
|
|
33211
|
+
* // $ gcloud auth application-default login
|
|
33212
|
+
* // ```
|
|
33213
|
+
* // - Install the npm module by running:
|
|
33214
|
+
* // ```sh
|
|
33215
|
+
* // $ npm install googleapis
|
|
33216
|
+
* // ```
|
|
33217
|
+
*
|
|
33218
|
+
* const {google} = require('googleapis');
|
|
33219
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
33220
|
+
*
|
|
33221
|
+
* async function main() {
|
|
33222
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33223
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33224
|
+
* scopes: [
|
|
33225
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33226
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33227
|
+
* ],
|
|
33228
|
+
* });
|
|
33229
|
+
*
|
|
33230
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33231
|
+
* const authClient = await auth.getClient();
|
|
33232
|
+
* google.options({auth: authClient});
|
|
33233
|
+
*
|
|
33234
|
+
* // Do the magic
|
|
33235
|
+
* const res =
|
|
33236
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.delete({
|
|
33237
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
33238
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
33239
|
+
* });
|
|
33240
|
+
* console.log(res.data);
|
|
33241
|
+
*
|
|
33242
|
+
* // Example response
|
|
33243
|
+
* // {}
|
|
33244
|
+
* }
|
|
33245
|
+
*
|
|
33246
|
+
* main().catch(e => {
|
|
33247
|
+
* console.error(e);
|
|
33248
|
+
* throw e;
|
|
33249
|
+
* });
|
|
33250
|
+
*
|
|
33251
|
+
* ```
|
|
33252
|
+
*
|
|
33253
|
+
* @param params - Parameters for request
|
|
33254
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33255
|
+
* @param callback - Optional callback that handles the response.
|
|
33256
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33257
|
+
*/
|
|
33258
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33259
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
33260
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33261
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
33262
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
33263
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
32993
33264
|
/**
|
|
32994
33265
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
32995
33266
|
* @example
|
|
@@ -33386,6 +33657,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33386
33657
|
* // "branch": "my_branch",
|
|
33387
33658
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
33388
33659
|
* // "contentSearchSpec": {},
|
|
33660
|
+
* // "crowdingSpecs": [],
|
|
33389
33661
|
* // "dataStoreSpecs": [],
|
|
33390
33662
|
* // "displaySpec": {},
|
|
33391
33663
|
* // "facetSpecs": [],
|
|
@@ -33396,6 +33668,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33396
33668
|
* // "offset": 0,
|
|
33397
33669
|
* // "oneBoxPageSize": 0,
|
|
33398
33670
|
* // "orderBy": "my_orderBy",
|
|
33671
|
+
* // "pageCategories": [],
|
|
33399
33672
|
* // "pageSize": 0,
|
|
33400
33673
|
* // "pageToken": "my_pageToken",
|
|
33401
33674
|
* // "params": {},
|
|
@@ -33428,6 +33701,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33428
33701
|
* // "redirectUri": "my_redirectUri",
|
|
33429
33702
|
* // "results": [],
|
|
33430
33703
|
* // "searchLinkPromotions": [],
|
|
33704
|
+
* // "semanticState": "my_semanticState",
|
|
33431
33705
|
* // "sessionInfo": {},
|
|
33432
33706
|
* // "summary": {},
|
|
33433
33707
|
* // "totalSize": 0
|
|
@@ -33501,6 +33775,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33501
33775
|
* // "branch": "my_branch",
|
|
33502
33776
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
33503
33777
|
* // "contentSearchSpec": {},
|
|
33778
|
+
* // "crowdingSpecs": [],
|
|
33504
33779
|
* // "dataStoreSpecs": [],
|
|
33505
33780
|
* // "displaySpec": {},
|
|
33506
33781
|
* // "facetSpecs": [],
|
|
@@ -33511,6 +33786,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33511
33786
|
* // "offset": 0,
|
|
33512
33787
|
* // "oneBoxPageSize": 0,
|
|
33513
33788
|
* // "orderBy": "my_orderBy",
|
|
33789
|
+
* // "pageCategories": [],
|
|
33514
33790
|
* // "pageSize": 0,
|
|
33515
33791
|
* // "pageToken": "my_pageToken",
|
|
33516
33792
|
* // "params": {},
|
|
@@ -33544,6 +33820,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33544
33820
|
* // "redirectUri": "my_redirectUri",
|
|
33545
33821
|
* // "results": [],
|
|
33546
33822
|
* // "searchLinkPromotions": [],
|
|
33823
|
+
* // "semanticState": "my_semanticState",
|
|
33547
33824
|
* // "sessionInfo": {},
|
|
33548
33825
|
* // "summary": {},
|
|
33549
33826
|
* // "totalSize": 0
|
|
@@ -33667,6 +33944,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
33667
33944
|
*/
|
|
33668
33945
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
33669
33946
|
}
|
|
33947
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
33948
|
+
/**
|
|
33949
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
33950
|
+
*/
|
|
33951
|
+
name?: string;
|
|
33952
|
+
}
|
|
33670
33953
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
33671
33954
|
/**
|
|
33672
33955
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -37026,7 +37309,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37026
37309
|
* pageSize: 'placeholder-value',
|
|
37027
37310
|
* // The standard list page token.
|
|
37028
37311
|
* pageToken: 'placeholder-value',
|
|
37029
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37312
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
37030
37313
|
* returnPartialSuccess: 'placeholder-value',
|
|
37031
37314
|
* },
|
|
37032
37315
|
* );
|
|
@@ -37083,7 +37366,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37083
37366
|
*/
|
|
37084
37367
|
pageToken?: string;
|
|
37085
37368
|
/**
|
|
37086
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37369
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
37087
37370
|
*/
|
|
37088
37371
|
returnPartialSuccess?: boolean;
|
|
37089
37372
|
}
|
|
@@ -37491,7 +37774,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37491
37774
|
* pageSize: 'placeholder-value',
|
|
37492
37775
|
* // The standard list page token.
|
|
37493
37776
|
* pageToken: 'placeholder-value',
|
|
37494
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37777
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
37495
37778
|
* returnPartialSuccess: 'placeholder-value',
|
|
37496
37779
|
* });
|
|
37497
37780
|
* console.log(res.data);
|
|
@@ -37547,7 +37830,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37547
37830
|
*/
|
|
37548
37831
|
pageToken?: string;
|
|
37549
37832
|
/**
|
|
37550
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37833
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
37551
37834
|
*/
|
|
37552
37835
|
returnPartialSuccess?: boolean;
|
|
37553
37836
|
}
|
|
@@ -38584,8 +38867,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
38584
38867
|
* // Do the magic
|
|
38585
38868
|
* const res =
|
|
38586
38869
|
* await discoveryengine.projects.locations.userStores.userLicenses.list({
|
|
38587
|
-
* // Optional.
|
|
38588
|
-
*
|
|
38870
|
+
* // Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order.
|
|
38871
|
+
* orderBy: 'placeholder-value',
|
|
38589
38872
|
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
38590
38873
|
* pageSize: 'placeholder-value',
|
|
38591
38874
|
* // Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.
|
|
@@ -38624,9 +38907,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
38624
38907
|
}
|
|
38625
38908
|
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
|
|
38626
38909
|
/**
|
|
38627
|
-
* Optional.
|
|
38910
|
+
* Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order.
|
|
38628
38911
|
*/
|
|
38629
|
-
|
|
38912
|
+
orderBy?: string;
|
|
38630
38913
|
/**
|
|
38631
38914
|
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
38632
38915
|
*/
|
|
@@ -38819,7 +39102,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38819
39102
|
* pageSize: 'placeholder-value',
|
|
38820
39103
|
* // The standard list page token.
|
|
38821
39104
|
* pageToken: 'placeholder-value',
|
|
38822
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
39105
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
38823
39106
|
* returnPartialSuccess: 'placeholder-value',
|
|
38824
39107
|
* });
|
|
38825
39108
|
* console.log(res.data);
|
|
@@ -38885,7 +39168,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38885
39168
|
*/
|
|
38886
39169
|
pageToken?: string;
|
|
38887
39170
|
/**
|
|
38888
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
39171
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
38889
39172
|
*/
|
|
38890
39173
|
returnPartialSuccess?: boolean;
|
|
38891
39174
|
}
|