@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/v1beta.d.ts
CHANGED
|
@@ -67,341 +67,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
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
|
*/
|
|
@@ -3187,6 +2855,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3187
2855
|
* Configurations for a Search Engine.
|
|
3188
2856
|
*/
|
|
3189
2857
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
2858
|
+
/**
|
|
2859
|
+
* 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.
|
|
2860
|
+
*/
|
|
2861
|
+
requiredSubscriptionTier?: string | null;
|
|
3190
2862
|
/**
|
|
3191
2863
|
* The add-on that this search engine enables.
|
|
3192
2864
|
*/
|
|
@@ -4327,6 +3999,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4327
3999
|
* A specification for configuring the behavior of content search.
|
|
4328
4000
|
*/
|
|
4329
4001
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
4002
|
+
/**
|
|
4003
|
+
* 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.
|
|
4004
|
+
*/
|
|
4005
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
4330
4006
|
/**
|
|
4331
4007
|
* Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
|
|
4332
4008
|
*/
|
|
@@ -4375,6 +4051,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4375
4051
|
* 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.
|
|
4376
4052
|
*/
|
|
4377
4053
|
orderBy?: string | null;
|
|
4054
|
+
/**
|
|
4055
|
+
* 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`
|
|
4056
|
+
*/
|
|
4057
|
+
pageCategories?: string[] | null;
|
|
4378
4058
|
/**
|
|
4379
4059
|
* 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.
|
|
4380
4060
|
*/
|
|
@@ -4684,6 +4364,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4684
4364
|
*/
|
|
4685
4365
|
imageSource?: string | null;
|
|
4686
4366
|
}
|
|
4367
|
+
/**
|
|
4368
|
+
* 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.
|
|
4369
|
+
*/
|
|
4370
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec {
|
|
4371
|
+
/**
|
|
4372
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
4373
|
+
*/
|
|
4374
|
+
field?: string | null;
|
|
4375
|
+
/**
|
|
4376
|
+
* 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.
|
|
4377
|
+
*/
|
|
4378
|
+
maxCount?: number | null;
|
|
4379
|
+
/**
|
|
4380
|
+
* Mode to use for documents that are crowded away.
|
|
4381
|
+
*/
|
|
4382
|
+
mode?: string | null;
|
|
4383
|
+
}
|
|
4687
4384
|
/**
|
|
4688
4385
|
* 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.
|
|
4689
4386
|
*/
|
|
@@ -5379,6 +5076,14 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5379
5076
|
* Optional. Customer policy for the assistant.
|
|
5380
5077
|
*/
|
|
5381
5078
|
customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
5079
|
+
/**
|
|
5080
|
+
* Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
|
|
5081
|
+
*/
|
|
5082
|
+
description?: string | null;
|
|
5083
|
+
/**
|
|
5084
|
+
* Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
|
|
5085
|
+
*/
|
|
5086
|
+
displayName?: string | null;
|
|
5382
5087
|
/**
|
|
5383
5088
|
* 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"),..] \}
|
|
5384
5089
|
*/
|
|
@@ -5449,10 +5154,18 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5449
5154
|
* Configuration for the generation of the assistant response.
|
|
5450
5155
|
*/
|
|
5451
5156
|
export interface Schema$GoogleCloudDiscoveryengineV1AssistantGenerationConfig {
|
|
5157
|
+
/**
|
|
5158
|
+
* Optional. The list of models that are allowed to be used for assistant.
|
|
5159
|
+
*/
|
|
5160
|
+
allowedModelIds?: string[] | null;
|
|
5452
5161
|
/**
|
|
5453
5162
|
* 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.
|
|
5454
5163
|
*/
|
|
5455
5164
|
defaultLanguage?: string | null;
|
|
5165
|
+
/**
|
|
5166
|
+
* Optional. The default model to use for assistant.
|
|
5167
|
+
*/
|
|
5168
|
+
defaultModelId?: string | null;
|
|
5456
5169
|
/**
|
|
5457
5170
|
* 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
|
|
5458
5171
|
*/
|
|
@@ -6814,6 +6527,14 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6814
6527
|
* Optional. Customer policy for the assistant.
|
|
6815
6528
|
*/
|
|
6816
6529
|
customerPolicy?: Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy;
|
|
6530
|
+
/**
|
|
6531
|
+
* Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
|
|
6532
|
+
*/
|
|
6533
|
+
description?: string | null;
|
|
6534
|
+
/**
|
|
6535
|
+
* Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
|
|
6536
|
+
*/
|
|
6537
|
+
displayName?: string | null;
|
|
6817
6538
|
/**
|
|
6818
6539
|
* 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"),..] \}
|
|
6819
6540
|
*/
|
|
@@ -6965,10 +6686,18 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6965
6686
|
* Configuration for the generation of the assistant response.
|
|
6966
6687
|
*/
|
|
6967
6688
|
export interface Schema$GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig {
|
|
6689
|
+
/**
|
|
6690
|
+
* Optional. The list of models that are allowed to be used for assistant.
|
|
6691
|
+
*/
|
|
6692
|
+
allowedModelIds?: string[] | null;
|
|
6968
6693
|
/**
|
|
6969
6694
|
* 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.
|
|
6970
6695
|
*/
|
|
6971
6696
|
defaultLanguage?: string | null;
|
|
6697
|
+
/**
|
|
6698
|
+
* Optional. The default model to use for assistant.
|
|
6699
|
+
*/
|
|
6700
|
+
defaultModelId?: string | null;
|
|
6972
6701
|
/**
|
|
6973
6702
|
* 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
|
|
6974
6703
|
*/
|
|
@@ -8983,6 +8712,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
8983
8712
|
* Configurations for a Search Engine.
|
|
8984
8713
|
*/
|
|
8985
8714
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
8715
|
+
/**
|
|
8716
|
+
* 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.
|
|
8717
|
+
*/
|
|
8718
|
+
requiredSubscriptionTier?: string | null;
|
|
8986
8719
|
/**
|
|
8987
8720
|
* The add-on that this search engine enables.
|
|
8988
8721
|
*/
|
|
@@ -9212,6 +8945,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9212
8945
|
* Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.
|
|
9213
8946
|
*/
|
|
9214
8947
|
externalIdentity?: string | null;
|
|
8948
|
+
/**
|
|
8949
|
+
* Optional. The name of the external identity.
|
|
8950
|
+
*/
|
|
8951
|
+
externalIdentityName?: string | null;
|
|
9215
8952
|
/**
|
|
9216
8953
|
* 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.
|
|
9217
8954
|
*/
|
|
@@ -9781,6 +9518,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9781
9518
|
*/
|
|
9782
9519
|
usedLicenseCount?: string | null;
|
|
9783
9520
|
}
|
|
9521
|
+
/**
|
|
9522
|
+
* Response message for the AssistantService.ListAssistants method.
|
|
9523
|
+
*/
|
|
9524
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse {
|
|
9525
|
+
/**
|
|
9526
|
+
* All the customer's Assistants.
|
|
9527
|
+
*/
|
|
9528
|
+
assistants?: Schema$GoogleCloudDiscoveryengineV1betaAssistant[];
|
|
9529
|
+
/**
|
|
9530
|
+
* 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.
|
|
9531
|
+
*/
|
|
9532
|
+
nextPageToken?: string | null;
|
|
9533
|
+
}
|
|
9784
9534
|
/**
|
|
9785
9535
|
* Response message for CmekConfigService.ListCmekConfigs method.
|
|
9786
9536
|
*/
|
|
@@ -10961,6 +10711,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10961
10711
|
* A specification for configuring the behavior of content search.
|
|
10962
10712
|
*/
|
|
10963
10713
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
10714
|
+
/**
|
|
10715
|
+
* 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.
|
|
10716
|
+
*/
|
|
10717
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
10964
10718
|
/**
|
|
10965
10719
|
* 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.
|
|
10966
10720
|
*/
|
|
@@ -11005,6 +10759,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11005
10759
|
* 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.
|
|
11006
10760
|
*/
|
|
11007
10761
|
orderBy?: string | null;
|
|
10762
|
+
/**
|
|
10763
|
+
* 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`
|
|
10764
|
+
*/
|
|
10765
|
+
pageCategories?: string[] | null;
|
|
11008
10766
|
/**
|
|
11009
10767
|
* 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.
|
|
11010
10768
|
*/
|
|
@@ -11310,6 +11068,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11310
11068
|
*/
|
|
11311
11069
|
imageSource?: string | null;
|
|
11312
11070
|
}
|
|
11071
|
+
/**
|
|
11072
|
+
* 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.
|
|
11073
|
+
*/
|
|
11074
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec {
|
|
11075
|
+
/**
|
|
11076
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
11077
|
+
*/
|
|
11078
|
+
field?: string | null;
|
|
11079
|
+
/**
|
|
11080
|
+
* 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.
|
|
11081
|
+
*/
|
|
11082
|
+
maxCount?: number | null;
|
|
11083
|
+
/**
|
|
11084
|
+
* Mode to use for documents that are crowded away.
|
|
11085
|
+
*/
|
|
11086
|
+
mode?: string | null;
|
|
11087
|
+
}
|
|
11313
11088
|
/**
|
|
11314
11089
|
* 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.
|
|
11315
11090
|
*/
|
|
@@ -11578,6 +11353,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11578
11353
|
* Promotions for site search.
|
|
11579
11354
|
*/
|
|
11580
11355
|
searchLinkPromotions?: Schema$GoogleCloudDiscoveryengineV1betaSearchLinkPromotion[];
|
|
11356
|
+
/**
|
|
11357
|
+
* Output only. Indicates the semantic state of the search response.
|
|
11358
|
+
*/
|
|
11359
|
+
semanticState?: string | null;
|
|
11581
11360
|
/**
|
|
11582
11361
|
* Session information. Only set if SearchRequest.session is provided. See its description for more details.
|
|
11583
11362
|
*/
|
|
@@ -12488,6 +12267,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12488
12267
|
* A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
|
|
12489
12268
|
*/
|
|
12490
12269
|
assistToken?: string | null;
|
|
12270
|
+
/**
|
|
12271
|
+
* The tool names of the tools that were invoked.
|
|
12272
|
+
*/
|
|
12273
|
+
invocationTools?: string[] | null;
|
|
12491
12274
|
/**
|
|
12492
12275
|
* Session information. Only included in the final StreamAssistResponse of the response stream.
|
|
12493
12276
|
*/
|
|
@@ -12794,7 +12577,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12794
12577
|
*/
|
|
12795
12578
|
eventType?: string | null;
|
|
12796
12579
|
/**
|
|
12797
|
-
* 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.
|
|
12580
|
+
* 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.
|
|
12798
12581
|
*/
|
|
12799
12582
|
filter?: string | null;
|
|
12800
12583
|
/**
|
|
@@ -13600,6 +13383,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13600
13383
|
* 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.
|
|
13601
13384
|
*/
|
|
13602
13385
|
name?: string | null;
|
|
13386
|
+
/**
|
|
13387
|
+
* Optional. Configuration for Natural Language Query Understanding.
|
|
13388
|
+
*/
|
|
13389
|
+
naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig;
|
|
13603
13390
|
/**
|
|
13604
13391
|
* Optional. Stores serving config at DataStore level.
|
|
13605
13392
|
*/
|
|
@@ -14158,6 +13945,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14158
13945
|
* Configurations for a Search Engine.
|
|
14159
13946
|
*/
|
|
14160
13947
|
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
13948
|
+
/**
|
|
13949
|
+
* 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.
|
|
13950
|
+
*/
|
|
13951
|
+
requiredSubscriptionTier?: string | null;
|
|
14161
13952
|
/**
|
|
14162
13953
|
* The add-on that this search engine enables.
|
|
14163
13954
|
*/
|
|
@@ -14439,6 +14230,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14439
14230
|
*/
|
|
14440
14231
|
subscriptionTier?: string | null;
|
|
14441
14232
|
}
|
|
14233
|
+
/**
|
|
14234
|
+
* Configuration for Natural Language Query Understanding.
|
|
14235
|
+
*/
|
|
14236
|
+
export interface Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig {
|
|
14237
|
+
/**
|
|
14238
|
+
* Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
|
|
14239
|
+
*/
|
|
14240
|
+
mode?: string | null;
|
|
14241
|
+
}
|
|
14442
14242
|
/**
|
|
14443
14243
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
14444
14244
|
*/
|
|
@@ -15252,7 +15052,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15252
15052
|
*/
|
|
15253
15053
|
operations?: Schema$GoogleLongrunningOperation[];
|
|
15254
15054
|
/**
|
|
15255
|
-
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections
|
|
15055
|
+
* 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.
|
|
15256
15056
|
*/
|
|
15257
15057
|
unreachable?: string[] | null;
|
|
15258
15058
|
}
|
|
@@ -15468,11 +15268,13 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15468
15268
|
*/
|
|
15469
15269
|
version?: string | null;
|
|
15470
15270
|
}
|
|
15471
|
-
export class Resource$
|
|
15271
|
+
export class Resource$Projects {
|
|
15472
15272
|
context: APIRequestContext;
|
|
15273
|
+
locations: Resource$Projects$Locations;
|
|
15274
|
+
operations: Resource$Projects$Operations;
|
|
15473
15275
|
constructor(context: APIRequestContext);
|
|
15474
15276
|
/**
|
|
15475
|
-
*
|
|
15277
|
+
* Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
|
|
15476
15278
|
* @example
|
|
15477
15279
|
* ```js
|
|
15478
15280
|
* // Before running the sample:
|
|
@@ -15495,7 +15297,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15495
15297
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15496
15298
|
* scopes: [
|
|
15497
15299
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
15498
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
15499
15300
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
15500
15301
|
* ],
|
|
15501
15302
|
* });
|
|
@@ -15505,48 +15306,29 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15505
15306
|
* google.options({auth: authClient});
|
|
15506
15307
|
*
|
|
15507
15308
|
* // Do the magic
|
|
15508
|
-
* const res = await discoveryengine.
|
|
15509
|
-
* // Required.
|
|
15510
|
-
*
|
|
15511
|
-
*
|
|
15512
|
-
*
|
|
15513
|
-
*
|
|
15514
|
-
*
|
|
15309
|
+
* const res = await discoveryengine.projects.provision({
|
|
15310
|
+
* // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
15311
|
+
* name: 'projects/my-project',
|
|
15312
|
+
*
|
|
15313
|
+
* // Request body metadata
|
|
15314
|
+
* requestBody: {
|
|
15315
|
+
* // request body parameters
|
|
15316
|
+
* // {
|
|
15317
|
+
* // "acceptDataUseTerms": false,
|
|
15318
|
+
* // "dataUseTermsVersion": "my_dataUseTermsVersion",
|
|
15319
|
+
* // "saasParams": {}
|
|
15320
|
+
* // }
|
|
15321
|
+
* },
|
|
15515
15322
|
* });
|
|
15516
15323
|
* console.log(res.data);
|
|
15517
15324
|
*
|
|
15518
15325
|
* // Example response
|
|
15519
15326
|
* // {
|
|
15520
|
-
* // "
|
|
15521
|
-
* // "
|
|
15522
|
-
* // "
|
|
15523
|
-
* // "
|
|
15524
|
-
* // "
|
|
15525
|
-
* // "contentType": "my_contentType",
|
|
15526
|
-
* // "contentTypeInfo": {},
|
|
15527
|
-
* // "cosmoBinaryReference": "my_cosmoBinaryReference",
|
|
15528
|
-
* // "crc32cHash": 0,
|
|
15529
|
-
* // "diffChecksumsResponse": {},
|
|
15530
|
-
* // "diffDownloadResponse": {},
|
|
15531
|
-
* // "diffUploadRequest": {},
|
|
15532
|
-
* // "diffUploadResponse": {},
|
|
15533
|
-
* // "diffVersionResponse": {},
|
|
15534
|
-
* // "downloadParameters": {},
|
|
15535
|
-
* // "filename": "my_filename",
|
|
15536
|
-
* // "hash": "my_hash",
|
|
15537
|
-
* // "hashVerified": false,
|
|
15538
|
-
* // "inline": "my_inline",
|
|
15539
|
-
* // "isPotentialRetry": false,
|
|
15540
|
-
* // "length": "my_length",
|
|
15541
|
-
* // "md5Hash": "my_md5Hash",
|
|
15542
|
-
* // "mediaId": "my_mediaId",
|
|
15543
|
-
* // "objectId": {},
|
|
15544
|
-
* // "path": "my_path",
|
|
15545
|
-
* // "referenceType": "my_referenceType",
|
|
15546
|
-
* // "sha1Hash": "my_sha1Hash",
|
|
15547
|
-
* // "sha256Hash": "my_sha256Hash",
|
|
15548
|
-
* // "timestamp": "my_timestamp",
|
|
15549
|
-
* // "token": "my_token"
|
|
15327
|
+
* // "done": false,
|
|
15328
|
+
* // "error": {},
|
|
15329
|
+
* // "metadata": {},
|
|
15330
|
+
* // "name": "my_name",
|
|
15331
|
+
* // "response": {}
|
|
15550
15332
|
* // }
|
|
15551
15333
|
* }
|
|
15552
15334
|
*
|
|
@@ -15562,138 +15344,41 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15562
15344
|
* @param callback - Optional callback that handles the response.
|
|
15563
15345
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15564
15346
|
*/
|
|
15565
|
-
|
|
15566
|
-
|
|
15567
|
-
|
|
15568
|
-
|
|
15569
|
-
|
|
15570
|
-
|
|
15347
|
+
provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15348
|
+
provision(params?: Params$Resource$Projects$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15349
|
+
provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15350
|
+
provision(params: Params$Resource$Projects$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15351
|
+
provision(params: Params$Resource$Projects$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15352
|
+
provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15571
15353
|
}
|
|
15572
|
-
export interface Params$Resource$
|
|
15573
|
-
/**
|
|
15574
|
-
* Required. The ID of the file to be downloaded.
|
|
15575
|
-
*/
|
|
15576
|
-
fileId?: string;
|
|
15354
|
+
export interface Params$Resource$Projects$Provision extends StandardParameters {
|
|
15577
15355
|
/**
|
|
15578
|
-
* Required.
|
|
15356
|
+
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
15579
15357
|
*/
|
|
15580
15358
|
name?: string;
|
|
15581
15359
|
/**
|
|
15582
|
-
*
|
|
15360
|
+
* Request body metadata
|
|
15583
15361
|
*/
|
|
15584
|
-
|
|
15362
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest;
|
|
15585
15363
|
}
|
|
15586
|
-
export class Resource$Projects {
|
|
15364
|
+
export class Resource$Projects$Locations {
|
|
15587
15365
|
context: APIRequestContext;
|
|
15588
|
-
|
|
15589
|
-
|
|
15366
|
+
cmekConfigs: Resource$Projects$Locations$Cmekconfigs;
|
|
15367
|
+
collections: Resource$Projects$Locations$Collections;
|
|
15368
|
+
dataStores: Resource$Projects$Locations$Datastores;
|
|
15369
|
+
evaluations: Resource$Projects$Locations$Evaluations;
|
|
15370
|
+
groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
|
|
15371
|
+
identityMappingStores: Resource$Projects$Locations$Identitymappingstores;
|
|
15372
|
+
licenseConfigs: Resource$Projects$Locations$Licenseconfigs;
|
|
15373
|
+
operations: Resource$Projects$Locations$Operations;
|
|
15374
|
+
podcasts: Resource$Projects$Locations$Podcasts;
|
|
15375
|
+
rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
|
|
15376
|
+
sampleQuerySets: Resource$Projects$Locations$Samplequerysets;
|
|
15377
|
+
userEvents: Resource$Projects$Locations$Userevents;
|
|
15378
|
+
userStores: Resource$Projects$Locations$Userstores;
|
|
15590
15379
|
constructor(context: APIRequestContext);
|
|
15591
15380
|
/**
|
|
15592
|
-
*
|
|
15593
|
-
* @example
|
|
15594
|
-
* ```js
|
|
15595
|
-
* // Before running the sample:
|
|
15596
|
-
* // - Enable the API at:
|
|
15597
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15598
|
-
* // - Login into gcloud by running:
|
|
15599
|
-
* // ```sh
|
|
15600
|
-
* // $ gcloud auth application-default login
|
|
15601
|
-
* // ```
|
|
15602
|
-
* // - Install the npm module by running:
|
|
15603
|
-
* // ```sh
|
|
15604
|
-
* // $ npm install googleapis
|
|
15605
|
-
* // ```
|
|
15606
|
-
*
|
|
15607
|
-
* const {google} = require('googleapis');
|
|
15608
|
-
* const discoveryengine = google.discoveryengine('v1beta');
|
|
15609
|
-
*
|
|
15610
|
-
* async function main() {
|
|
15611
|
-
* const auth = new google.auth.GoogleAuth({
|
|
15612
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15613
|
-
* scopes: [
|
|
15614
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
15615
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
15616
|
-
* ],
|
|
15617
|
-
* });
|
|
15618
|
-
*
|
|
15619
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
15620
|
-
* const authClient = await auth.getClient();
|
|
15621
|
-
* google.options({auth: authClient});
|
|
15622
|
-
*
|
|
15623
|
-
* // Do the magic
|
|
15624
|
-
* const res = await discoveryengine.projects.provision({
|
|
15625
|
-
* // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
15626
|
-
* name: 'projects/my-project',
|
|
15627
|
-
*
|
|
15628
|
-
* // Request body metadata
|
|
15629
|
-
* requestBody: {
|
|
15630
|
-
* // request body parameters
|
|
15631
|
-
* // {
|
|
15632
|
-
* // "acceptDataUseTerms": false,
|
|
15633
|
-
* // "dataUseTermsVersion": "my_dataUseTermsVersion",
|
|
15634
|
-
* // "saasParams": {}
|
|
15635
|
-
* // }
|
|
15636
|
-
* },
|
|
15637
|
-
* });
|
|
15638
|
-
* console.log(res.data);
|
|
15639
|
-
*
|
|
15640
|
-
* // Example response
|
|
15641
|
-
* // {
|
|
15642
|
-
* // "done": false,
|
|
15643
|
-
* // "error": {},
|
|
15644
|
-
* // "metadata": {},
|
|
15645
|
-
* // "name": "my_name",
|
|
15646
|
-
* // "response": {}
|
|
15647
|
-
* // }
|
|
15648
|
-
* }
|
|
15649
|
-
*
|
|
15650
|
-
* main().catch(e => {
|
|
15651
|
-
* console.error(e);
|
|
15652
|
-
* throw e;
|
|
15653
|
-
* });
|
|
15654
|
-
*
|
|
15655
|
-
* ```
|
|
15656
|
-
*
|
|
15657
|
-
* @param params - Parameters for request
|
|
15658
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15659
|
-
* @param callback - Optional callback that handles the response.
|
|
15660
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15661
|
-
*/
|
|
15662
|
-
provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15663
|
-
provision(params?: Params$Resource$Projects$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15664
|
-
provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15665
|
-
provision(params: Params$Resource$Projects$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15666
|
-
provision(params: Params$Resource$Projects$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15667
|
-
provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15668
|
-
}
|
|
15669
|
-
export interface Params$Resource$Projects$Provision extends StandardParameters {
|
|
15670
|
-
/**
|
|
15671
|
-
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
15672
|
-
*/
|
|
15673
|
-
name?: string;
|
|
15674
|
-
/**
|
|
15675
|
-
* Request body metadata
|
|
15676
|
-
*/
|
|
15677
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest;
|
|
15678
|
-
}
|
|
15679
|
-
export class Resource$Projects$Locations {
|
|
15680
|
-
context: APIRequestContext;
|
|
15681
|
-
cmekConfigs: Resource$Projects$Locations$Cmekconfigs;
|
|
15682
|
-
collections: Resource$Projects$Locations$Collections;
|
|
15683
|
-
dataStores: Resource$Projects$Locations$Datastores;
|
|
15684
|
-
evaluations: Resource$Projects$Locations$Evaluations;
|
|
15685
|
-
groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
|
|
15686
|
-
identityMappingStores: Resource$Projects$Locations$Identitymappingstores;
|
|
15687
|
-
licenseConfigs: Resource$Projects$Locations$Licenseconfigs;
|
|
15688
|
-
operations: Resource$Projects$Locations$Operations;
|
|
15689
|
-
podcasts: Resource$Projects$Locations$Podcasts;
|
|
15690
|
-
rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
|
|
15691
|
-
sampleQuerySets: Resource$Projects$Locations$Samplequerysets;
|
|
15692
|
-
userEvents: Resource$Projects$Locations$Userevents;
|
|
15693
|
-
userStores: Resource$Projects$Locations$Userstores;
|
|
15694
|
-
constructor(context: APIRequestContext);
|
|
15695
|
-
/**
|
|
15696
|
-
* Gets the AclConfig.
|
|
15381
|
+
* Gets the AclConfig.
|
|
15697
15382
|
* @example
|
|
15698
15383
|
* ```js
|
|
15699
15384
|
* // Before running the sample:
|
|
@@ -16729,7 +16414,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16729
16414
|
* pageSize: 'placeholder-value',
|
|
16730
16415
|
* // The standard list page token.
|
|
16731
16416
|
* pageToken: 'placeholder-value',
|
|
16732
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16417
|
+
* // 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.
|
|
16733
16418
|
* returnPartialSuccess: 'placeholder-value',
|
|
16734
16419
|
* },
|
|
16735
16420
|
* );
|
|
@@ -16786,7 +16471,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16786
16471
|
*/
|
|
16787
16472
|
pageToken?: string;
|
|
16788
16473
|
/**
|
|
16789
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16474
|
+
* 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.
|
|
16790
16475
|
*/
|
|
16791
16476
|
returnPartialSuccess?: boolean;
|
|
16792
16477
|
}
|
|
@@ -18541,7 +18226,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18541
18226
|
* pageSize: 'placeholder-value',
|
|
18542
18227
|
* // The standard list page token.
|
|
18543
18228
|
* pageToken: 'placeholder-value',
|
|
18544
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18229
|
+
* // 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.
|
|
18545
18230
|
* returnPartialSuccess: 'placeholder-value',
|
|
18546
18231
|
* },
|
|
18547
18232
|
* );
|
|
@@ -18608,7 +18293,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18608
18293
|
*/
|
|
18609
18294
|
pageToken?: string;
|
|
18610
18295
|
/**
|
|
18611
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18296
|
+
* 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.
|
|
18612
18297
|
*/
|
|
18613
18298
|
returnPartialSuccess?: boolean;
|
|
18614
18299
|
}
|
|
@@ -20106,7 +19791,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20106
19791
|
* pageSize: 'placeholder-value',
|
|
20107
19792
|
* // The standard list page token.
|
|
20108
19793
|
* pageToken: 'placeholder-value',
|
|
20109
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
19794
|
+
* // 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.
|
|
20110
19795
|
* returnPartialSuccess: 'placeholder-value',
|
|
20111
19796
|
* },
|
|
20112
19797
|
* );
|
|
@@ -20163,7 +19848,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20163
19848
|
*/
|
|
20164
19849
|
pageToken?: string;
|
|
20165
19850
|
/**
|
|
20166
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
19851
|
+
* 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.
|
|
20167
19852
|
*/
|
|
20168
19853
|
returnPartialSuccess?: boolean;
|
|
20169
19854
|
}
|
|
@@ -20284,7 +19969,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20284
19969
|
* pageSize: 'placeholder-value',
|
|
20285
19970
|
* // The standard list page token.
|
|
20286
19971
|
* pageToken: 'placeholder-value',
|
|
20287
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
19972
|
+
* // 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.
|
|
20288
19973
|
* returnPartialSuccess: 'placeholder-value',
|
|
20289
19974
|
* },
|
|
20290
19975
|
* );
|
|
@@ -20341,7 +20026,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20341
20026
|
*/
|
|
20342
20027
|
pageToken?: string;
|
|
20343
20028
|
/**
|
|
20344
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20029
|
+
* 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.
|
|
20345
20030
|
*/
|
|
20346
20031
|
returnPartialSuccess?: boolean;
|
|
20347
20032
|
}
|
|
@@ -20896,7 +20581,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20896
20581
|
* pageSize: 'placeholder-value',
|
|
20897
20582
|
* // The standard list page token.
|
|
20898
20583
|
* pageToken: 'placeholder-value',
|
|
20899
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20584
|
+
* // 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.
|
|
20900
20585
|
* returnPartialSuccess: 'placeholder-value',
|
|
20901
20586
|
* },
|
|
20902
20587
|
* );
|
|
@@ -20953,7 +20638,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20953
20638
|
*/
|
|
20954
20639
|
pageToken?: string;
|
|
20955
20640
|
/**
|
|
20956
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20641
|
+
* 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.
|
|
20957
20642
|
*/
|
|
20958
20643
|
returnPartialSuccess?: boolean;
|
|
20959
20644
|
}
|
|
@@ -21049,7 +20734,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21049
20734
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
21050
20735
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
21051
20736
|
/**
|
|
21052
|
-
*
|
|
20737
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
21053
20738
|
* @example
|
|
21054
20739
|
* ```js
|
|
21055
20740
|
* // Before running the sample:
|
|
@@ -21082,111 +20767,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21082
20767
|
*
|
|
21083
20768
|
* // Do the magic
|
|
21084
20769
|
* const res =
|
|
21085
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.
|
|
20770
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete(
|
|
21086
20771
|
* {
|
|
21087
|
-
* // Required. The resource name of the ServingConfig to
|
|
20772
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
21088
20773
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
21089
20774
|
* },
|
|
21090
20775
|
* );
|
|
21091
20776
|
* console.log(res.data);
|
|
21092
20777
|
*
|
|
21093
20778
|
* // Example response
|
|
21094
|
-
* // {
|
|
21095
|
-
* // "answerGenerationSpec": {},
|
|
21096
|
-
* // "boostControlIds": [],
|
|
21097
|
-
* // "createTime": "my_createTime",
|
|
21098
|
-
* // "displayName": "my_displayName",
|
|
21099
|
-
* // "dissociateControlIds": [],
|
|
21100
|
-
* // "diversityLevel": "my_diversityLevel",
|
|
21101
|
-
* // "embeddingConfig": {},
|
|
21102
|
-
* // "filterControlIds": [],
|
|
21103
|
-
* // "genericConfig": {},
|
|
21104
|
-
* // "ignoreControlIds": [],
|
|
21105
|
-
* // "mediaConfig": {},
|
|
21106
|
-
* // "modelId": "my_modelId",
|
|
21107
|
-
* // "name": "my_name",
|
|
21108
|
-
* // "onewaySynonymsControlIds": [],
|
|
21109
|
-
* // "personalizationSpec": {},
|
|
21110
|
-
* // "promoteControlIds": [],
|
|
21111
|
-
* // "rankingExpression": "my_rankingExpression",
|
|
21112
|
-
* // "redirectControlIds": [],
|
|
21113
|
-
* // "replacementControlIds": [],
|
|
21114
|
-
* // "solutionType": "my_solutionType",
|
|
21115
|
-
* // "synonymsControlIds": [],
|
|
21116
|
-
* // "updateTime": "my_updateTime"
|
|
21117
|
-
* // }
|
|
21118
|
-
* }
|
|
21119
|
-
*
|
|
21120
|
-
* main().catch(e => {
|
|
21121
|
-
* console.error(e);
|
|
21122
|
-
* throw e;
|
|
21123
|
-
* });
|
|
21124
|
-
*
|
|
21125
|
-
* ```
|
|
21126
|
-
*
|
|
21127
|
-
* @param params - Parameters for request
|
|
21128
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21129
|
-
* @param callback - Optional callback that handles the response.
|
|
21130
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21131
|
-
*/
|
|
21132
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21133
|
-
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>>;
|
|
21134
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21135
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
21136
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
21137
|
-
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
21138
|
-
/**
|
|
21139
|
-
* Lists all ServingConfigs linked to this dataStore.
|
|
21140
|
-
* @example
|
|
21141
|
-
* ```js
|
|
21142
|
-
* // Before running the sample:
|
|
21143
|
-
* // - Enable the API at:
|
|
21144
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21145
|
-
* // - Login into gcloud by running:
|
|
21146
|
-
* // ```sh
|
|
21147
|
-
* // $ gcloud auth application-default login
|
|
21148
|
-
* // ```
|
|
21149
|
-
* // - Install the npm module by running:
|
|
21150
|
-
* // ```sh
|
|
21151
|
-
* // $ npm install googleapis
|
|
21152
|
-
* // ```
|
|
21153
|
-
*
|
|
21154
|
-
* const {google} = require('googleapis');
|
|
21155
|
-
* const discoveryengine = google.discoveryengine('v1beta');
|
|
21156
|
-
*
|
|
21157
|
-
* async function main() {
|
|
21158
|
-
* const auth = new google.auth.GoogleAuth({
|
|
21159
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21160
|
-
* scopes: [
|
|
21161
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21162
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21163
|
-
* ],
|
|
21164
|
-
* });
|
|
21165
|
-
*
|
|
21166
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
21167
|
-
* const authClient = await auth.getClient();
|
|
21168
|
-
* google.options({auth: authClient});
|
|
21169
|
-
*
|
|
21170
|
-
* // Do the magic
|
|
21171
|
-
* const res =
|
|
21172
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list(
|
|
21173
|
-
* {
|
|
21174
|
-
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
21175
|
-
* pageSize: 'placeholder-value',
|
|
21176
|
-
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
21177
|
-
* pageToken: 'placeholder-value',
|
|
21178
|
-
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
21179
|
-
* parent:
|
|
21180
|
-
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21181
|
-
* },
|
|
21182
|
-
* );
|
|
21183
|
-
* console.log(res.data);
|
|
21184
|
-
*
|
|
21185
|
-
* // Example response
|
|
21186
|
-
* // {
|
|
21187
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
21188
|
-
* // "servingConfigs": []
|
|
21189
|
-
* // }
|
|
20779
|
+
* // {}
|
|
21190
20780
|
* }
|
|
21191
20781
|
*
|
|
21192
20782
|
* main().catch(e => {
|
|
@@ -21201,14 +20791,14 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21201
20791
|
* @param callback - Optional callback that handles the response.
|
|
21202
20792
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21203
20793
|
*/
|
|
21204
|
-
|
|
21205
|
-
|
|
21206
|
-
|
|
21207
|
-
|
|
21208
|
-
|
|
21209
|
-
|
|
20794
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
20795
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
20796
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
20797
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
20798
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
20799
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
21210
20800
|
/**
|
|
21211
|
-
*
|
|
20801
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
21212
20802
|
* @example
|
|
21213
20803
|
* ```js
|
|
21214
20804
|
* // Before running the sample:
|
|
@@ -21241,41 +20831,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21241
20831
|
*
|
|
21242
20832
|
* // Do the magic
|
|
21243
20833
|
* const res =
|
|
21244
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.
|
|
20834
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.get(
|
|
21245
20835
|
* {
|
|
21246
|
-
* //
|
|
20836
|
+
* // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
21247
20837
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
21248
|
-
* // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
21249
|
-
* updateMask: 'placeholder-value',
|
|
21250
|
-
*
|
|
21251
|
-
* // Request body metadata
|
|
21252
|
-
* requestBody: {
|
|
21253
|
-
* // request body parameters
|
|
21254
|
-
* // {
|
|
21255
|
-
* // "answerGenerationSpec": {},
|
|
21256
|
-
* // "boostControlIds": [],
|
|
21257
|
-
* // "createTime": "my_createTime",
|
|
21258
|
-
* // "displayName": "my_displayName",
|
|
21259
|
-
* // "dissociateControlIds": [],
|
|
21260
|
-
* // "diversityLevel": "my_diversityLevel",
|
|
21261
|
-
* // "embeddingConfig": {},
|
|
21262
|
-
* // "filterControlIds": [],
|
|
21263
|
-
* // "genericConfig": {},
|
|
21264
|
-
* // "ignoreControlIds": [],
|
|
21265
|
-
* // "mediaConfig": {},
|
|
21266
|
-
* // "modelId": "my_modelId",
|
|
21267
|
-
* // "name": "my_name",
|
|
21268
|
-
* // "onewaySynonymsControlIds": [],
|
|
21269
|
-
* // "personalizationSpec": {},
|
|
21270
|
-
* // "promoteControlIds": [],
|
|
21271
|
-
* // "rankingExpression": "my_rankingExpression",
|
|
21272
|
-
* // "redirectControlIds": [],
|
|
21273
|
-
* // "replacementControlIds": [],
|
|
21274
|
-
* // "solutionType": "my_solutionType",
|
|
21275
|
-
* // "synonymsControlIds": [],
|
|
21276
|
-
* // "updateTime": "my_updateTime"
|
|
21277
|
-
* // }
|
|
21278
|
-
* },
|
|
21279
20838
|
* },
|
|
21280
20839
|
* );
|
|
21281
20840
|
* console.log(res.data);
|
|
@@ -21319,14 +20878,204 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21319
20878
|
* @param callback - Optional callback that handles the response.
|
|
21320
20879
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21321
20880
|
*/
|
|
21322
|
-
|
|
21323
|
-
|
|
21324
|
-
|
|
21325
|
-
|
|
21326
|
-
|
|
21327
|
-
|
|
20881
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
20882
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>>;
|
|
20883
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
20884
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
20885
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
20886
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
21328
20887
|
/**
|
|
21329
|
-
*
|
|
20888
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
20889
|
+
* @example
|
|
20890
|
+
* ```js
|
|
20891
|
+
* // Before running the sample:
|
|
20892
|
+
* // - Enable the API at:
|
|
20893
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
20894
|
+
* // - Login into gcloud by running:
|
|
20895
|
+
* // ```sh
|
|
20896
|
+
* // $ gcloud auth application-default login
|
|
20897
|
+
* // ```
|
|
20898
|
+
* // - Install the npm module by running:
|
|
20899
|
+
* // ```sh
|
|
20900
|
+
* // $ npm install googleapis
|
|
20901
|
+
* // ```
|
|
20902
|
+
*
|
|
20903
|
+
* const {google} = require('googleapis');
|
|
20904
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
20905
|
+
*
|
|
20906
|
+
* async function main() {
|
|
20907
|
+
* const auth = new google.auth.GoogleAuth({
|
|
20908
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
20909
|
+
* scopes: [
|
|
20910
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
20911
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
20912
|
+
* ],
|
|
20913
|
+
* });
|
|
20914
|
+
*
|
|
20915
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
20916
|
+
* const authClient = await auth.getClient();
|
|
20917
|
+
* google.options({auth: authClient});
|
|
20918
|
+
*
|
|
20919
|
+
* // Do the magic
|
|
20920
|
+
* const res =
|
|
20921
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list(
|
|
20922
|
+
* {
|
|
20923
|
+
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
20924
|
+
* pageSize: 'placeholder-value',
|
|
20925
|
+
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
20926
|
+
* pageToken: 'placeholder-value',
|
|
20927
|
+
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
20928
|
+
* parent:
|
|
20929
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
20930
|
+
* },
|
|
20931
|
+
* );
|
|
20932
|
+
* console.log(res.data);
|
|
20933
|
+
*
|
|
20934
|
+
* // Example response
|
|
20935
|
+
* // {
|
|
20936
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
20937
|
+
* // "servingConfigs": []
|
|
20938
|
+
* // }
|
|
20939
|
+
* }
|
|
20940
|
+
*
|
|
20941
|
+
* main().catch(e => {
|
|
20942
|
+
* console.error(e);
|
|
20943
|
+
* throw e;
|
|
20944
|
+
* });
|
|
20945
|
+
*
|
|
20946
|
+
* ```
|
|
20947
|
+
*
|
|
20948
|
+
* @param params - Parameters for request
|
|
20949
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
20950
|
+
* @param callback - Optional callback that handles the response.
|
|
20951
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
20952
|
+
*/
|
|
20953
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
20954
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>>;
|
|
20955
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
20956
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
20957
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
20958
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
20959
|
+
/**
|
|
20960
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
20961
|
+
* @example
|
|
20962
|
+
* ```js
|
|
20963
|
+
* // Before running the sample:
|
|
20964
|
+
* // - Enable the API at:
|
|
20965
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
20966
|
+
* // - Login into gcloud by running:
|
|
20967
|
+
* // ```sh
|
|
20968
|
+
* // $ gcloud auth application-default login
|
|
20969
|
+
* // ```
|
|
20970
|
+
* // - Install the npm module by running:
|
|
20971
|
+
* // ```sh
|
|
20972
|
+
* // $ npm install googleapis
|
|
20973
|
+
* // ```
|
|
20974
|
+
*
|
|
20975
|
+
* const {google} = require('googleapis');
|
|
20976
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
20977
|
+
*
|
|
20978
|
+
* async function main() {
|
|
20979
|
+
* const auth = new google.auth.GoogleAuth({
|
|
20980
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
20981
|
+
* scopes: [
|
|
20982
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
20983
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
20984
|
+
* ],
|
|
20985
|
+
* });
|
|
20986
|
+
*
|
|
20987
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
20988
|
+
* const authClient = await auth.getClient();
|
|
20989
|
+
* google.options({auth: authClient});
|
|
20990
|
+
*
|
|
20991
|
+
* // Do the magic
|
|
20992
|
+
* const res =
|
|
20993
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch(
|
|
20994
|
+
* {
|
|
20995
|
+
* // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
20996
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
20997
|
+
* // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
20998
|
+
* updateMask: 'placeholder-value',
|
|
20999
|
+
*
|
|
21000
|
+
* // Request body metadata
|
|
21001
|
+
* requestBody: {
|
|
21002
|
+
* // request body parameters
|
|
21003
|
+
* // {
|
|
21004
|
+
* // "answerGenerationSpec": {},
|
|
21005
|
+
* // "boostControlIds": [],
|
|
21006
|
+
* // "createTime": "my_createTime",
|
|
21007
|
+
* // "displayName": "my_displayName",
|
|
21008
|
+
* // "dissociateControlIds": [],
|
|
21009
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
21010
|
+
* // "embeddingConfig": {},
|
|
21011
|
+
* // "filterControlIds": [],
|
|
21012
|
+
* // "genericConfig": {},
|
|
21013
|
+
* // "ignoreControlIds": [],
|
|
21014
|
+
* // "mediaConfig": {},
|
|
21015
|
+
* // "modelId": "my_modelId",
|
|
21016
|
+
* // "name": "my_name",
|
|
21017
|
+
* // "onewaySynonymsControlIds": [],
|
|
21018
|
+
* // "personalizationSpec": {},
|
|
21019
|
+
* // "promoteControlIds": [],
|
|
21020
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
21021
|
+
* // "redirectControlIds": [],
|
|
21022
|
+
* // "replacementControlIds": [],
|
|
21023
|
+
* // "solutionType": "my_solutionType",
|
|
21024
|
+
* // "synonymsControlIds": [],
|
|
21025
|
+
* // "updateTime": "my_updateTime"
|
|
21026
|
+
* // }
|
|
21027
|
+
* },
|
|
21028
|
+
* },
|
|
21029
|
+
* );
|
|
21030
|
+
* console.log(res.data);
|
|
21031
|
+
*
|
|
21032
|
+
* // Example response
|
|
21033
|
+
* // {
|
|
21034
|
+
* // "answerGenerationSpec": {},
|
|
21035
|
+
* // "boostControlIds": [],
|
|
21036
|
+
* // "createTime": "my_createTime",
|
|
21037
|
+
* // "displayName": "my_displayName",
|
|
21038
|
+
* // "dissociateControlIds": [],
|
|
21039
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
21040
|
+
* // "embeddingConfig": {},
|
|
21041
|
+
* // "filterControlIds": [],
|
|
21042
|
+
* // "genericConfig": {},
|
|
21043
|
+
* // "ignoreControlIds": [],
|
|
21044
|
+
* // "mediaConfig": {},
|
|
21045
|
+
* // "modelId": "my_modelId",
|
|
21046
|
+
* // "name": "my_name",
|
|
21047
|
+
* // "onewaySynonymsControlIds": [],
|
|
21048
|
+
* // "personalizationSpec": {},
|
|
21049
|
+
* // "promoteControlIds": [],
|
|
21050
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
21051
|
+
* // "redirectControlIds": [],
|
|
21052
|
+
* // "replacementControlIds": [],
|
|
21053
|
+
* // "solutionType": "my_solutionType",
|
|
21054
|
+
* // "synonymsControlIds": [],
|
|
21055
|
+
* // "updateTime": "my_updateTime"
|
|
21056
|
+
* // }
|
|
21057
|
+
* }
|
|
21058
|
+
*
|
|
21059
|
+
* main().catch(e => {
|
|
21060
|
+
* console.error(e);
|
|
21061
|
+
* throw e;
|
|
21062
|
+
* });
|
|
21063
|
+
*
|
|
21064
|
+
* ```
|
|
21065
|
+
*
|
|
21066
|
+
* @param params - Parameters for request
|
|
21067
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21068
|
+
* @param callback - Optional callback that handles the response.
|
|
21069
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21070
|
+
*/
|
|
21071
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21072
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>>;
|
|
21073
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21074
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
21075
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
21076
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
21077
|
+
/**
|
|
21078
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
21330
21079
|
* @example
|
|
21331
21080
|
* ```js
|
|
21332
21081
|
* // Before running the sample:
|
|
@@ -21457,6 +21206,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21457
21206
|
* // "branch": "my_branch",
|
|
21458
21207
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
21459
21208
|
* // "contentSearchSpec": {},
|
|
21209
|
+
* // "crowdingSpecs": [],
|
|
21460
21210
|
* // "dataStoreSpecs": [],
|
|
21461
21211
|
* // "displaySpec": {},
|
|
21462
21212
|
* // "embeddingSpec": {},
|
|
@@ -21468,6 +21218,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21468
21218
|
* // "offset": 0,
|
|
21469
21219
|
* // "oneBoxPageSize": 0,
|
|
21470
21220
|
* // "orderBy": "my_orderBy",
|
|
21221
|
+
* // "pageCategories": [],
|
|
21471
21222
|
* // "pageSize": 0,
|
|
21472
21223
|
* // "pageToken": "my_pageToken",
|
|
21473
21224
|
* // "params": {},
|
|
@@ -21510,6 +21261,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21510
21261
|
* // "redirectUri": "my_redirectUri",
|
|
21511
21262
|
* // "results": [],
|
|
21512
21263
|
* // "searchLinkPromotions": [],
|
|
21264
|
+
* // "semanticState": "my_semanticState",
|
|
21513
21265
|
* // "sessionInfo": {},
|
|
21514
21266
|
* // "suggestedQuery": "my_suggestedQuery",
|
|
21515
21267
|
* // "summary": {},
|
|
@@ -21584,6 +21336,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21584
21336
|
* // "branch": "my_branch",
|
|
21585
21337
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
21586
21338
|
* // "contentSearchSpec": {},
|
|
21339
|
+
* // "crowdingSpecs": [],
|
|
21587
21340
|
* // "dataStoreSpecs": [],
|
|
21588
21341
|
* // "displaySpec": {},
|
|
21589
21342
|
* // "embeddingSpec": {},
|
|
@@ -21595,6 +21348,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21595
21348
|
* // "offset": 0,
|
|
21596
21349
|
* // "oneBoxPageSize": 0,
|
|
21597
21350
|
* // "orderBy": "my_orderBy",
|
|
21351
|
+
* // "pageCategories": [],
|
|
21598
21352
|
* // "pageSize": 0,
|
|
21599
21353
|
* // "pageToken": "my_pageToken",
|
|
21600
21354
|
* // "params": {},
|
|
@@ -21637,6 +21391,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21637
21391
|
* // "redirectUri": "my_redirectUri",
|
|
21638
21392
|
* // "results": [],
|
|
21639
21393
|
* // "searchLinkPromotions": [],
|
|
21394
|
+
* // "semanticState": "my_semanticState",
|
|
21640
21395
|
* // "sessionInfo": {},
|
|
21641
21396
|
* // "suggestedQuery": "my_suggestedQuery",
|
|
21642
21397
|
* // "summary": {},
|
|
@@ -21761,6 +21516,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21761
21516
|
*/
|
|
21762
21517
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
21763
21518
|
}
|
|
21519
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
21520
|
+
/**
|
|
21521
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
21522
|
+
*/
|
|
21523
|
+
name?: string;
|
|
21524
|
+
}
|
|
21764
21525
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
21765
21526
|
/**
|
|
21766
21527
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -22958,7 +22719,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
22958
22719
|
* pageSize: 'placeholder-value',
|
|
22959
22720
|
* // The standard list page token.
|
|
22960
22721
|
* pageToken: 'placeholder-value',
|
|
22961
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
22722
|
+
* // 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.
|
|
22962
22723
|
* returnPartialSuccess: 'placeholder-value',
|
|
22963
22724
|
* },
|
|
22964
22725
|
* );
|
|
@@ -23015,7 +22776,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23015
22776
|
*/
|
|
23016
22777
|
pageToken?: string;
|
|
23017
22778
|
/**
|
|
23018
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
22779
|
+
* 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.
|
|
23019
22780
|
*/
|
|
23020
22781
|
returnPartialSuccess?: boolean;
|
|
23021
22782
|
}
|
|
@@ -23919,7 +23680,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23919
23680
|
* pageSize: 'placeholder-value',
|
|
23920
23681
|
* // The standard list page token.
|
|
23921
23682
|
* pageToken: 'placeholder-value',
|
|
23922
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
23683
|
+
* // 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.
|
|
23923
23684
|
* returnPartialSuccess: 'placeholder-value',
|
|
23924
23685
|
* },
|
|
23925
23686
|
* );
|
|
@@ -23976,7 +23737,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23976
23737
|
*/
|
|
23977
23738
|
pageToken?: string;
|
|
23978
23739
|
/**
|
|
23979
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
23740
|
+
* 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.
|
|
23980
23741
|
*/
|
|
23981
23742
|
returnPartialSuccess?: boolean;
|
|
23982
23743
|
}
|
|
@@ -25354,7 +25115,163 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25354
25115
|
}
|
|
25355
25116
|
export class Resource$Projects$Locations$Collections$Engines$Assistants {
|
|
25356
25117
|
context: APIRequestContext;
|
|
25118
|
+
agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
|
|
25357
25119
|
constructor(context: APIRequestContext);
|
|
25120
|
+
/**
|
|
25121
|
+
* Creates an Assistant.
|
|
25122
|
+
* @example
|
|
25123
|
+
* ```js
|
|
25124
|
+
* // Before running the sample:
|
|
25125
|
+
* // - Enable the API at:
|
|
25126
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25127
|
+
* // - Login into gcloud by running:
|
|
25128
|
+
* // ```sh
|
|
25129
|
+
* // $ gcloud auth application-default login
|
|
25130
|
+
* // ```
|
|
25131
|
+
* // - Install the npm module by running:
|
|
25132
|
+
* // ```sh
|
|
25133
|
+
* // $ npm install googleapis
|
|
25134
|
+
* // ```
|
|
25135
|
+
*
|
|
25136
|
+
* const {google} = require('googleapis');
|
|
25137
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
25138
|
+
*
|
|
25139
|
+
* async function main() {
|
|
25140
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25141
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25142
|
+
* scopes: [
|
|
25143
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25144
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25145
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25146
|
+
* ],
|
|
25147
|
+
* });
|
|
25148
|
+
*
|
|
25149
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25150
|
+
* const authClient = await auth.getClient();
|
|
25151
|
+
* google.options({auth: authClient});
|
|
25152
|
+
*
|
|
25153
|
+
* // Do the magic
|
|
25154
|
+
* const res =
|
|
25155
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.create(
|
|
25156
|
+
* {
|
|
25157
|
+
* // 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.
|
|
25158
|
+
* assistantId: 'placeholder-value',
|
|
25159
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25160
|
+
* parent:
|
|
25161
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
25162
|
+
*
|
|
25163
|
+
* // Request body metadata
|
|
25164
|
+
* requestBody: {
|
|
25165
|
+
* // request body parameters
|
|
25166
|
+
* // {
|
|
25167
|
+
* // "customerPolicy": {},
|
|
25168
|
+
* // "description": "my_description",
|
|
25169
|
+
* // "displayName": "my_displayName",
|
|
25170
|
+
* // "enabledTools": {},
|
|
25171
|
+
* // "generationConfig": {},
|
|
25172
|
+
* // "name": "my_name",
|
|
25173
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25174
|
+
* // }
|
|
25175
|
+
* },
|
|
25176
|
+
* },
|
|
25177
|
+
* );
|
|
25178
|
+
* console.log(res.data);
|
|
25179
|
+
*
|
|
25180
|
+
* // Example response
|
|
25181
|
+
* // {
|
|
25182
|
+
* // "customerPolicy": {},
|
|
25183
|
+
* // "description": "my_description",
|
|
25184
|
+
* // "displayName": "my_displayName",
|
|
25185
|
+
* // "enabledTools": {},
|
|
25186
|
+
* // "generationConfig": {},
|
|
25187
|
+
* // "name": "my_name",
|
|
25188
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25189
|
+
* // }
|
|
25190
|
+
* }
|
|
25191
|
+
*
|
|
25192
|
+
* main().catch(e => {
|
|
25193
|
+
* console.error(e);
|
|
25194
|
+
* throw e;
|
|
25195
|
+
* });
|
|
25196
|
+
*
|
|
25197
|
+
* ```
|
|
25198
|
+
*
|
|
25199
|
+
* @param params - Parameters for request
|
|
25200
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25201
|
+
* @param callback - Optional callback that handles the response.
|
|
25202
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25203
|
+
*/
|
|
25204
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25205
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAssistant>>;
|
|
25206
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25207
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25208
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25209
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25210
|
+
/**
|
|
25211
|
+
* Deletes an Assistant.
|
|
25212
|
+
* @example
|
|
25213
|
+
* ```js
|
|
25214
|
+
* // Before running the sample:
|
|
25215
|
+
* // - Enable the API at:
|
|
25216
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25217
|
+
* // - Login into gcloud by running:
|
|
25218
|
+
* // ```sh
|
|
25219
|
+
* // $ gcloud auth application-default login
|
|
25220
|
+
* // ```
|
|
25221
|
+
* // - Install the npm module by running:
|
|
25222
|
+
* // ```sh
|
|
25223
|
+
* // $ npm install googleapis
|
|
25224
|
+
* // ```
|
|
25225
|
+
*
|
|
25226
|
+
* const {google} = require('googleapis');
|
|
25227
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
25228
|
+
*
|
|
25229
|
+
* async function main() {
|
|
25230
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25231
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25232
|
+
* scopes: [
|
|
25233
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25234
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25235
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25236
|
+
* ],
|
|
25237
|
+
* });
|
|
25238
|
+
*
|
|
25239
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25240
|
+
* const authClient = await auth.getClient();
|
|
25241
|
+
* google.options({auth: authClient});
|
|
25242
|
+
*
|
|
25243
|
+
* // Do the magic
|
|
25244
|
+
* const res =
|
|
25245
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.delete(
|
|
25246
|
+
* {
|
|
25247
|
+
* // 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.
|
|
25248
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25249
|
+
* },
|
|
25250
|
+
* );
|
|
25251
|
+
* console.log(res.data);
|
|
25252
|
+
*
|
|
25253
|
+
* // Example response
|
|
25254
|
+
* // {}
|
|
25255
|
+
* }
|
|
25256
|
+
*
|
|
25257
|
+
* main().catch(e => {
|
|
25258
|
+
* console.error(e);
|
|
25259
|
+
* throw e;
|
|
25260
|
+
* });
|
|
25261
|
+
*
|
|
25262
|
+
* ```
|
|
25263
|
+
*
|
|
25264
|
+
* @param params - Parameters for request
|
|
25265
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25266
|
+
* @param callback - Optional callback that handles the response.
|
|
25267
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25268
|
+
*/
|
|
25269
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25270
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
25271
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25272
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25273
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25274
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25358
25275
|
/**
|
|
25359
25276
|
* Gets an Assistant.
|
|
25360
25277
|
* @example
|
|
@@ -25401,6 +25318,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25401
25318
|
* // Example response
|
|
25402
25319
|
* // {
|
|
25403
25320
|
* // "customerPolicy": {},
|
|
25321
|
+
* // "description": "my_description",
|
|
25322
|
+
* // "displayName": "my_displayName",
|
|
25404
25323
|
* // "enabledTools": {},
|
|
25405
25324
|
* // "generationConfig": {},
|
|
25406
25325
|
* // "name": "my_name",
|
|
@@ -25426,6 +25345,79 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25426
25345
|
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25427
25346
|
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25428
25347
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25348
|
+
/**
|
|
25349
|
+
* Lists all Assistants under an Engine.
|
|
25350
|
+
* @example
|
|
25351
|
+
* ```js
|
|
25352
|
+
* // Before running the sample:
|
|
25353
|
+
* // - Enable the API at:
|
|
25354
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25355
|
+
* // - Login into gcloud by running:
|
|
25356
|
+
* // ```sh
|
|
25357
|
+
* // $ gcloud auth application-default login
|
|
25358
|
+
* // ```
|
|
25359
|
+
* // - Install the npm module by running:
|
|
25360
|
+
* // ```sh
|
|
25361
|
+
* // $ npm install googleapis
|
|
25362
|
+
* // ```
|
|
25363
|
+
*
|
|
25364
|
+
* const {google} = require('googleapis');
|
|
25365
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
25366
|
+
*
|
|
25367
|
+
* async function main() {
|
|
25368
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25369
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25370
|
+
* scopes: [
|
|
25371
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25372
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25373
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25374
|
+
* ],
|
|
25375
|
+
* });
|
|
25376
|
+
*
|
|
25377
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25378
|
+
* const authClient = await auth.getClient();
|
|
25379
|
+
* google.options({auth: authClient});
|
|
25380
|
+
*
|
|
25381
|
+
* // Do the magic
|
|
25382
|
+
* const res =
|
|
25383
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.list(
|
|
25384
|
+
* {
|
|
25385
|
+
* // 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.
|
|
25386
|
+
* pageSize: 'placeholder-value',
|
|
25387
|
+
* // 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.
|
|
25388
|
+
* pageToken: 'placeholder-value',
|
|
25389
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25390
|
+
* parent:
|
|
25391
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
25392
|
+
* },
|
|
25393
|
+
* );
|
|
25394
|
+
* console.log(res.data);
|
|
25395
|
+
*
|
|
25396
|
+
* // Example response
|
|
25397
|
+
* // {
|
|
25398
|
+
* // "assistants": [],
|
|
25399
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
25400
|
+
* // }
|
|
25401
|
+
* }
|
|
25402
|
+
*
|
|
25403
|
+
* main().catch(e => {
|
|
25404
|
+
* console.error(e);
|
|
25405
|
+
* throw e;
|
|
25406
|
+
* });
|
|
25407
|
+
*
|
|
25408
|
+
* ```
|
|
25409
|
+
*
|
|
25410
|
+
* @param params - Parameters for request
|
|
25411
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25412
|
+
* @param callback - Optional callback that handles the response.
|
|
25413
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25414
|
+
*/
|
|
25415
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25416
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>>;
|
|
25417
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25418
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>): void;
|
|
25419
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>): void;
|
|
25420
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>): void;
|
|
25429
25421
|
/**
|
|
25430
25422
|
* Updates an Assistant
|
|
25431
25423
|
* @example
|
|
@@ -25450,7 +25442,250 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25450
25442
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25451
25443
|
* scopes: [
|
|
25452
25444
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25453
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25445
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25446
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25447
|
+
* ],
|
|
25448
|
+
* });
|
|
25449
|
+
*
|
|
25450
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25451
|
+
* const authClient = await auth.getClient();
|
|
25452
|
+
* google.options({auth: authClient});
|
|
25453
|
+
*
|
|
25454
|
+
* // Do the magic
|
|
25455
|
+
* const res =
|
|
25456
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.patch(
|
|
25457
|
+
* {
|
|
25458
|
+
* // 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.
|
|
25459
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25460
|
+
* // The list of fields to update.
|
|
25461
|
+
* updateMask: 'placeholder-value',
|
|
25462
|
+
*
|
|
25463
|
+
* // Request body metadata
|
|
25464
|
+
* requestBody: {
|
|
25465
|
+
* // request body parameters
|
|
25466
|
+
* // {
|
|
25467
|
+
* // "customerPolicy": {},
|
|
25468
|
+
* // "description": "my_description",
|
|
25469
|
+
* // "displayName": "my_displayName",
|
|
25470
|
+
* // "enabledTools": {},
|
|
25471
|
+
* // "generationConfig": {},
|
|
25472
|
+
* // "name": "my_name",
|
|
25473
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25474
|
+
* // }
|
|
25475
|
+
* },
|
|
25476
|
+
* },
|
|
25477
|
+
* );
|
|
25478
|
+
* console.log(res.data);
|
|
25479
|
+
*
|
|
25480
|
+
* // Example response
|
|
25481
|
+
* // {
|
|
25482
|
+
* // "customerPolicy": {},
|
|
25483
|
+
* // "description": "my_description",
|
|
25484
|
+
* // "displayName": "my_displayName",
|
|
25485
|
+
* // "enabledTools": {},
|
|
25486
|
+
* // "generationConfig": {},
|
|
25487
|
+
* // "name": "my_name",
|
|
25488
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25489
|
+
* // }
|
|
25490
|
+
* }
|
|
25491
|
+
*
|
|
25492
|
+
* main().catch(e => {
|
|
25493
|
+
* console.error(e);
|
|
25494
|
+
* throw e;
|
|
25495
|
+
* });
|
|
25496
|
+
*
|
|
25497
|
+
* ```
|
|
25498
|
+
*
|
|
25499
|
+
* @param params - Parameters for request
|
|
25500
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25501
|
+
* @param callback - Optional callback that handles the response.
|
|
25502
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25503
|
+
*/
|
|
25504
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25505
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAssistant>>;
|
|
25506
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25507
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25508
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25509
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25510
|
+
/**
|
|
25511
|
+
* Assists the user with a query in a streaming fashion.
|
|
25512
|
+
* @example
|
|
25513
|
+
* ```js
|
|
25514
|
+
* // Before running the sample:
|
|
25515
|
+
* // - Enable the API at:
|
|
25516
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25517
|
+
* // - Login into gcloud by running:
|
|
25518
|
+
* // ```sh
|
|
25519
|
+
* // $ gcloud auth application-default login
|
|
25520
|
+
* // ```
|
|
25521
|
+
* // - Install the npm module by running:
|
|
25522
|
+
* // ```sh
|
|
25523
|
+
* // $ npm install googleapis
|
|
25524
|
+
* // ```
|
|
25525
|
+
*
|
|
25526
|
+
* const {google} = require('googleapis');
|
|
25527
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
25528
|
+
*
|
|
25529
|
+
* async function main() {
|
|
25530
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25531
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25532
|
+
* scopes: [
|
|
25533
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25534
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25535
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25536
|
+
* ],
|
|
25537
|
+
* });
|
|
25538
|
+
*
|
|
25539
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25540
|
+
* const authClient = await auth.getClient();
|
|
25541
|
+
* google.options({auth: authClient});
|
|
25542
|
+
*
|
|
25543
|
+
* // Do the magic
|
|
25544
|
+
* const res =
|
|
25545
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.streamAssist(
|
|
25546
|
+
* {
|
|
25547
|
+
* // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25548
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25549
|
+
*
|
|
25550
|
+
* // Request body metadata
|
|
25551
|
+
* requestBody: {
|
|
25552
|
+
* // request body parameters
|
|
25553
|
+
* // {
|
|
25554
|
+
* // "generationSpec": {},
|
|
25555
|
+
* // "query": {},
|
|
25556
|
+
* // "session": "my_session",
|
|
25557
|
+
* // "toolsSpec": {},
|
|
25558
|
+
* // "userMetadata": {}
|
|
25559
|
+
* // }
|
|
25560
|
+
* },
|
|
25561
|
+
* },
|
|
25562
|
+
* );
|
|
25563
|
+
* console.log(res.data);
|
|
25564
|
+
*
|
|
25565
|
+
* // Example response
|
|
25566
|
+
* // {
|
|
25567
|
+
* // "answer": {},
|
|
25568
|
+
* // "assistToken": "my_assistToken",
|
|
25569
|
+
* // "invocationTools": [],
|
|
25570
|
+
* // "sessionInfo": {}
|
|
25571
|
+
* // }
|
|
25572
|
+
* }
|
|
25573
|
+
*
|
|
25574
|
+
* main().catch(e => {
|
|
25575
|
+
* console.error(e);
|
|
25576
|
+
* throw e;
|
|
25577
|
+
* });
|
|
25578
|
+
*
|
|
25579
|
+
* ```
|
|
25580
|
+
*
|
|
25581
|
+
* @param params - Parameters for request
|
|
25582
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25583
|
+
* @param callback - Optional callback that handles the response.
|
|
25584
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25585
|
+
*/
|
|
25586
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25587
|
+
streamAssist(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponse>>;
|
|
25588
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25589
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponse>): void;
|
|
25590
|
+
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponse>): void;
|
|
25591
|
+
streamAssist(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponse>): void;
|
|
25592
|
+
}
|
|
25593
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create extends StandardParameters {
|
|
25594
|
+
/**
|
|
25595
|
+
* 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.
|
|
25596
|
+
*/
|
|
25597
|
+
assistantId?: string;
|
|
25598
|
+
/**
|
|
25599
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25600
|
+
*/
|
|
25601
|
+
parent?: string;
|
|
25602
|
+
/**
|
|
25603
|
+
* Request body metadata
|
|
25604
|
+
*/
|
|
25605
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAssistant;
|
|
25606
|
+
}
|
|
25607
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete extends StandardParameters {
|
|
25608
|
+
/**
|
|
25609
|
+
* 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.
|
|
25610
|
+
*/
|
|
25611
|
+
name?: string;
|
|
25612
|
+
}
|
|
25613
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
|
|
25614
|
+
/**
|
|
25615
|
+
* Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25616
|
+
*/
|
|
25617
|
+
name?: string;
|
|
25618
|
+
}
|
|
25619
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$List extends StandardParameters {
|
|
25620
|
+
/**
|
|
25621
|
+
* 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.
|
|
25622
|
+
*/
|
|
25623
|
+
pageSize?: number;
|
|
25624
|
+
/**
|
|
25625
|
+
* 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.
|
|
25626
|
+
*/
|
|
25627
|
+
pageToken?: string;
|
|
25628
|
+
/**
|
|
25629
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25630
|
+
*/
|
|
25631
|
+
parent?: string;
|
|
25632
|
+
}
|
|
25633
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
|
|
25634
|
+
/**
|
|
25635
|
+
* 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.
|
|
25636
|
+
*/
|
|
25637
|
+
name?: string;
|
|
25638
|
+
/**
|
|
25639
|
+
* The list of fields to update.
|
|
25640
|
+
*/
|
|
25641
|
+
updateMask?: string;
|
|
25642
|
+
/**
|
|
25643
|
+
* Request body metadata
|
|
25644
|
+
*/
|
|
25645
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAssistant;
|
|
25646
|
+
}
|
|
25647
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist extends StandardParameters {
|
|
25648
|
+
/**
|
|
25649
|
+
* Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25650
|
+
*/
|
|
25651
|
+
name?: string;
|
|
25652
|
+
/**
|
|
25653
|
+
* Request body metadata
|
|
25654
|
+
*/
|
|
25655
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistRequest;
|
|
25656
|
+
}
|
|
25657
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents {
|
|
25658
|
+
context: APIRequestContext;
|
|
25659
|
+
operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations;
|
|
25660
|
+
constructor(context: APIRequestContext);
|
|
25661
|
+
}
|
|
25662
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations {
|
|
25663
|
+
context: APIRequestContext;
|
|
25664
|
+
constructor(context: APIRequestContext);
|
|
25665
|
+
/**
|
|
25666
|
+
* 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.
|
|
25667
|
+
* @example
|
|
25668
|
+
* ```js
|
|
25669
|
+
* // Before running the sample:
|
|
25670
|
+
* // - Enable the API at:
|
|
25671
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25672
|
+
* // - Login into gcloud by running:
|
|
25673
|
+
* // ```sh
|
|
25674
|
+
* // $ gcloud auth application-default login
|
|
25675
|
+
* // ```
|
|
25676
|
+
* // - Install the npm module by running:
|
|
25677
|
+
* // ```sh
|
|
25678
|
+
* // $ npm install googleapis
|
|
25679
|
+
* // ```
|
|
25680
|
+
*
|
|
25681
|
+
* const {google} = require('googleapis');
|
|
25682
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
25683
|
+
*
|
|
25684
|
+
* async function main() {
|
|
25685
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25686
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25687
|
+
* scopes: [
|
|
25688
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25454
25689
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25455
25690
|
* ],
|
|
25456
25691
|
* });
|
|
@@ -25461,116 +25696,21 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25461
25696
|
*
|
|
25462
25697
|
* // Do the magic
|
|
25463
25698
|
* const res =
|
|
25464
|
-
* await discoveryengine.projects.locations.collections.engines.assistants.
|
|
25699
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get(
|
|
25465
25700
|
* {
|
|
25466
|
-
* //
|
|
25467
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25468
|
-
* // The list of fields to update.
|
|
25469
|
-
* updateMask: 'placeholder-value',
|
|
25470
|
-
*
|
|
25471
|
-
* // Request body metadata
|
|
25472
|
-
* requestBody: {
|
|
25473
|
-
* // request body parameters
|
|
25474
|
-
* // {
|
|
25475
|
-
* // "customerPolicy": {},
|
|
25476
|
-
* // "enabledTools": {},
|
|
25477
|
-
* // "generationConfig": {},
|
|
25478
|
-
* // "name": "my_name",
|
|
25479
|
-
* // "webGroundingType": "my_webGroundingType"
|
|
25480
|
-
* // }
|
|
25481
|
-
* },
|
|
25701
|
+
* // The name of the operation resource.
|
|
25702
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent/operations/my-operation',
|
|
25482
25703
|
* },
|
|
25483
25704
|
* );
|
|
25484
25705
|
* console.log(res.data);
|
|
25485
25706
|
*
|
|
25486
25707
|
* // Example response
|
|
25487
25708
|
* // {
|
|
25488
|
-
* // "
|
|
25489
|
-
* // "
|
|
25490
|
-
* // "
|
|
25709
|
+
* // "done": false,
|
|
25710
|
+
* // "error": {},
|
|
25711
|
+
* // "metadata": {},
|
|
25491
25712
|
* // "name": "my_name",
|
|
25492
|
-
* // "
|
|
25493
|
-
* // }
|
|
25494
|
-
* }
|
|
25495
|
-
*
|
|
25496
|
-
* main().catch(e => {
|
|
25497
|
-
* console.error(e);
|
|
25498
|
-
* throw e;
|
|
25499
|
-
* });
|
|
25500
|
-
*
|
|
25501
|
-
* ```
|
|
25502
|
-
*
|
|
25503
|
-
* @param params - Parameters for request
|
|
25504
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25505
|
-
* @param callback - Optional callback that handles the response.
|
|
25506
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25507
|
-
*/
|
|
25508
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25509
|
-
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAssistant>>;
|
|
25510
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25511
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25512
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25513
|
-
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
|
|
25514
|
-
/**
|
|
25515
|
-
* Assists the user with a query in a streaming fashion.
|
|
25516
|
-
* @example
|
|
25517
|
-
* ```js
|
|
25518
|
-
* // Before running the sample:
|
|
25519
|
-
* // - Enable the API at:
|
|
25520
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25521
|
-
* // - Login into gcloud by running:
|
|
25522
|
-
* // ```sh
|
|
25523
|
-
* // $ gcloud auth application-default login
|
|
25524
|
-
* // ```
|
|
25525
|
-
* // - Install the npm module by running:
|
|
25526
|
-
* // ```sh
|
|
25527
|
-
* // $ npm install googleapis
|
|
25528
|
-
* // ```
|
|
25529
|
-
*
|
|
25530
|
-
* const {google} = require('googleapis');
|
|
25531
|
-
* const discoveryengine = google.discoveryengine('v1beta');
|
|
25532
|
-
*
|
|
25533
|
-
* async function main() {
|
|
25534
|
-
* const auth = new google.auth.GoogleAuth({
|
|
25535
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25536
|
-
* scopes: [
|
|
25537
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25538
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25539
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25540
|
-
* ],
|
|
25541
|
-
* });
|
|
25542
|
-
*
|
|
25543
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
25544
|
-
* const authClient = await auth.getClient();
|
|
25545
|
-
* google.options({auth: authClient});
|
|
25546
|
-
*
|
|
25547
|
-
* // Do the magic
|
|
25548
|
-
* const res =
|
|
25549
|
-
* await discoveryengine.projects.locations.collections.engines.assistants.streamAssist(
|
|
25550
|
-
* {
|
|
25551
|
-
* // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25552
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25553
|
-
*
|
|
25554
|
-
* // Request body metadata
|
|
25555
|
-
* requestBody: {
|
|
25556
|
-
* // request body parameters
|
|
25557
|
-
* // {
|
|
25558
|
-
* // "generationSpec": {},
|
|
25559
|
-
* // "query": {},
|
|
25560
|
-
* // "session": "my_session",
|
|
25561
|
-
* // "toolsSpec": {},
|
|
25562
|
-
* // "userMetadata": {}
|
|
25563
|
-
* // }
|
|
25564
|
-
* },
|
|
25565
|
-
* },
|
|
25566
|
-
* );
|
|
25567
|
-
* console.log(res.data);
|
|
25568
|
-
*
|
|
25569
|
-
* // Example response
|
|
25570
|
-
* // {
|
|
25571
|
-
* // "answer": {},
|
|
25572
|
-
* // "assistToken": "my_assistToken",
|
|
25573
|
-
* // "sessionInfo": {}
|
|
25713
|
+
* // "response": {}
|
|
25574
25714
|
* // }
|
|
25575
25715
|
* }
|
|
25576
25716
|
*
|
|
@@ -25586,42 +25726,18 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25586
25726
|
* @param callback - Optional callback that handles the response.
|
|
25587
25727
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25588
25728
|
*/
|
|
25589
|
-
|
|
25590
|
-
|
|
25591
|
-
|
|
25592
|
-
|
|
25593
|
-
|
|
25594
|
-
|
|
25595
|
-
}
|
|
25596
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
|
|
25597
|
-
/**
|
|
25598
|
-
* Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25599
|
-
*/
|
|
25600
|
-
name?: string;
|
|
25601
|
-
}
|
|
25602
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
|
|
25603
|
-
/**
|
|
25604
|
-
* 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.
|
|
25605
|
-
*/
|
|
25606
|
-
name?: string;
|
|
25607
|
-
/**
|
|
25608
|
-
* The list of fields to update.
|
|
25609
|
-
*/
|
|
25610
|
-
updateMask?: string;
|
|
25611
|
-
/**
|
|
25612
|
-
* Request body metadata
|
|
25613
|
-
*/
|
|
25614
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAssistant;
|
|
25729
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25730
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
25731
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25732
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
25733
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
25734
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
25615
25735
|
}
|
|
25616
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$
|
|
25736
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get extends StandardParameters {
|
|
25617
25737
|
/**
|
|
25618
|
-
*
|
|
25738
|
+
* The name of the operation resource.
|
|
25619
25739
|
*/
|
|
25620
25740
|
name?: string;
|
|
25621
|
-
/**
|
|
25622
|
-
* Request body metadata
|
|
25623
|
-
*/
|
|
25624
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistRequest;
|
|
25625
25741
|
}
|
|
25626
25742
|
export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
25627
25743
|
context: APIRequestContext;
|
|
@@ -26934,7 +27050,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26934
27050
|
* pageSize: 'placeholder-value',
|
|
26935
27051
|
* // The standard list page token.
|
|
26936
27052
|
* pageToken: 'placeholder-value',
|
|
26937
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
27053
|
+
* // 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.
|
|
26938
27054
|
* returnPartialSuccess: 'placeholder-value',
|
|
26939
27055
|
* },
|
|
26940
27056
|
* );
|
|
@@ -26991,7 +27107,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26991
27107
|
*/
|
|
26992
27108
|
pageToken?: string;
|
|
26993
27109
|
/**
|
|
26994
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
27110
|
+
* 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.
|
|
26995
27111
|
*/
|
|
26996
27112
|
returnPartialSuccess?: boolean;
|
|
26997
27113
|
}
|
|
@@ -27086,6 +27202,70 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27086
27202
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
27087
27203
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
27088
27204
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
27205
|
+
/**
|
|
27206
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
27207
|
+
* @example
|
|
27208
|
+
* ```js
|
|
27209
|
+
* // Before running the sample:
|
|
27210
|
+
* // - Enable the API at:
|
|
27211
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
27212
|
+
* // - Login into gcloud by running:
|
|
27213
|
+
* // ```sh
|
|
27214
|
+
* // $ gcloud auth application-default login
|
|
27215
|
+
* // ```
|
|
27216
|
+
* // - Install the npm module by running:
|
|
27217
|
+
* // ```sh
|
|
27218
|
+
* // $ npm install googleapis
|
|
27219
|
+
* // ```
|
|
27220
|
+
*
|
|
27221
|
+
* const {google} = require('googleapis');
|
|
27222
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
27223
|
+
*
|
|
27224
|
+
* async function main() {
|
|
27225
|
+
* const auth = new google.auth.GoogleAuth({
|
|
27226
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
27227
|
+
* scopes: [
|
|
27228
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
27229
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
27230
|
+
* ],
|
|
27231
|
+
* });
|
|
27232
|
+
*
|
|
27233
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
27234
|
+
* const authClient = await auth.getClient();
|
|
27235
|
+
* google.options({auth: authClient});
|
|
27236
|
+
*
|
|
27237
|
+
* // Do the magic
|
|
27238
|
+
* const res =
|
|
27239
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.delete(
|
|
27240
|
+
* {
|
|
27241
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
27242
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig',
|
|
27243
|
+
* },
|
|
27244
|
+
* );
|
|
27245
|
+
* console.log(res.data);
|
|
27246
|
+
*
|
|
27247
|
+
* // Example response
|
|
27248
|
+
* // {}
|
|
27249
|
+
* }
|
|
27250
|
+
*
|
|
27251
|
+
* main().catch(e => {
|
|
27252
|
+
* console.error(e);
|
|
27253
|
+
* throw e;
|
|
27254
|
+
* });
|
|
27255
|
+
*
|
|
27256
|
+
* ```
|
|
27257
|
+
*
|
|
27258
|
+
* @param params - Parameters for request
|
|
27259
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
27260
|
+
* @param callback - Optional callback that handles the response.
|
|
27261
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27262
|
+
*/
|
|
27263
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
27264
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
27265
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
27266
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
27267
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
27268
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
27089
27269
|
/**
|
|
27090
27270
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
27091
27271
|
* @example
|
|
@@ -27495,6 +27675,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27495
27675
|
* // "branch": "my_branch",
|
|
27496
27676
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
27497
27677
|
* // "contentSearchSpec": {},
|
|
27678
|
+
* // "crowdingSpecs": [],
|
|
27498
27679
|
* // "dataStoreSpecs": [],
|
|
27499
27680
|
* // "displaySpec": {},
|
|
27500
27681
|
* // "embeddingSpec": {},
|
|
@@ -27506,6 +27687,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27506
27687
|
* // "offset": 0,
|
|
27507
27688
|
* // "oneBoxPageSize": 0,
|
|
27508
27689
|
* // "orderBy": "my_orderBy",
|
|
27690
|
+
* // "pageCategories": [],
|
|
27509
27691
|
* // "pageSize": 0,
|
|
27510
27692
|
* // "pageToken": "my_pageToken",
|
|
27511
27693
|
* // "params": {},
|
|
@@ -27548,6 +27730,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27548
27730
|
* // "redirectUri": "my_redirectUri",
|
|
27549
27731
|
* // "results": [],
|
|
27550
27732
|
* // "searchLinkPromotions": [],
|
|
27733
|
+
* // "semanticState": "my_semanticState",
|
|
27551
27734
|
* // "sessionInfo": {},
|
|
27552
27735
|
* // "suggestedQuery": "my_suggestedQuery",
|
|
27553
27736
|
* // "summary": {},
|
|
@@ -27622,6 +27805,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27622
27805
|
* // "branch": "my_branch",
|
|
27623
27806
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
27624
27807
|
* // "contentSearchSpec": {},
|
|
27808
|
+
* // "crowdingSpecs": [],
|
|
27625
27809
|
* // "dataStoreSpecs": [],
|
|
27626
27810
|
* // "displaySpec": {},
|
|
27627
27811
|
* // "embeddingSpec": {},
|
|
@@ -27633,6 +27817,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27633
27817
|
* // "offset": 0,
|
|
27634
27818
|
* // "oneBoxPageSize": 0,
|
|
27635
27819
|
* // "orderBy": "my_orderBy",
|
|
27820
|
+
* // "pageCategories": [],
|
|
27636
27821
|
* // "pageSize": 0,
|
|
27637
27822
|
* // "pageToken": "my_pageToken",
|
|
27638
27823
|
* // "params": {},
|
|
@@ -27675,6 +27860,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27675
27860
|
* // "redirectUri": "my_redirectUri",
|
|
27676
27861
|
* // "results": [],
|
|
27677
27862
|
* // "searchLinkPromotions": [],
|
|
27863
|
+
* // "semanticState": "my_semanticState",
|
|
27678
27864
|
* // "sessionInfo": {},
|
|
27679
27865
|
* // "suggestedQuery": "my_suggestedQuery",
|
|
27680
27866
|
* // "summary": {},
|
|
@@ -27799,6 +27985,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27799
27985
|
*/
|
|
27800
27986
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
27801
27987
|
}
|
|
27988
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
|
|
27989
|
+
/**
|
|
27990
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
27991
|
+
*/
|
|
27992
|
+
name?: string;
|
|
27993
|
+
}
|
|
27802
27994
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
27803
27995
|
/**
|
|
27804
27996
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -28544,7 +28736,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
28544
28736
|
* pageSize: 'placeholder-value',
|
|
28545
28737
|
* // The standard list page token.
|
|
28546
28738
|
* pageToken: 'placeholder-value',
|
|
28547
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
28739
|
+
* // 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.
|
|
28548
28740
|
* returnPartialSuccess: 'placeholder-value',
|
|
28549
28741
|
* });
|
|
28550
28742
|
* console.log(res.data);
|
|
@@ -28600,7 +28792,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
28600
28792
|
*/
|
|
28601
28793
|
pageToken?: string;
|
|
28602
28794
|
/**
|
|
28603
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
28795
|
+
* 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.
|
|
28604
28796
|
*/
|
|
28605
28797
|
returnPartialSuccess?: boolean;
|
|
28606
28798
|
}
|
|
@@ -30250,7 +30442,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30250
30442
|
* pageSize: 'placeholder-value',
|
|
30251
30443
|
* // The standard list page token.
|
|
30252
30444
|
* pageToken: 'placeholder-value',
|
|
30253
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
30445
|
+
* // 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.
|
|
30254
30446
|
* returnPartialSuccess: 'placeholder-value',
|
|
30255
30447
|
* },
|
|
30256
30448
|
* );
|
|
@@ -30317,7 +30509,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30317
30509
|
*/
|
|
30318
30510
|
pageToken?: string;
|
|
30319
30511
|
/**
|
|
30320
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
30512
|
+
* 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.
|
|
30321
30513
|
*/
|
|
30322
30514
|
returnPartialSuccess?: boolean;
|
|
30323
30515
|
}
|
|
@@ -31713,7 +31905,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
31713
31905
|
* pageSize: 'placeholder-value',
|
|
31714
31906
|
* // The standard list page token.
|
|
31715
31907
|
* pageToken: 'placeholder-value',
|
|
31716
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
31908
|
+
* // 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.
|
|
31717
31909
|
* returnPartialSuccess: 'placeholder-value',
|
|
31718
31910
|
* });
|
|
31719
31911
|
* console.log(res.data);
|
|
@@ -31769,7 +31961,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
31769
31961
|
*/
|
|
31770
31962
|
pageToken?: string;
|
|
31771
31963
|
/**
|
|
31772
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
31964
|
+
* 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.
|
|
31773
31965
|
*/
|
|
31774
31966
|
returnPartialSuccess?: boolean;
|
|
31775
31967
|
}
|
|
@@ -31887,7 +32079,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
31887
32079
|
* pageSize: 'placeholder-value',
|
|
31888
32080
|
* // The standard list page token.
|
|
31889
32081
|
* pageToken: 'placeholder-value',
|
|
31890
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32082
|
+
* // 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.
|
|
31891
32083
|
* returnPartialSuccess: 'placeholder-value',
|
|
31892
32084
|
* });
|
|
31893
32085
|
* console.log(res.data);
|
|
@@ -31943,7 +32135,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
31943
32135
|
*/
|
|
31944
32136
|
pageToken?: string;
|
|
31945
32137
|
/**
|
|
31946
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32138
|
+
* 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.
|
|
31947
32139
|
*/
|
|
31948
32140
|
returnPartialSuccess?: boolean;
|
|
31949
32141
|
}
|
|
@@ -32457,6 +32649,68 @@ export declare namespace discoveryengine_v1beta {
|
|
|
32457
32649
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
32458
32650
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
32459
32651
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
32652
|
+
/**
|
|
32653
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
32654
|
+
* @example
|
|
32655
|
+
* ```js
|
|
32656
|
+
* // Before running the sample:
|
|
32657
|
+
* // - Enable the API at:
|
|
32658
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
32659
|
+
* // - Login into gcloud by running:
|
|
32660
|
+
* // ```sh
|
|
32661
|
+
* // $ gcloud auth application-default login
|
|
32662
|
+
* // ```
|
|
32663
|
+
* // - Install the npm module by running:
|
|
32664
|
+
* // ```sh
|
|
32665
|
+
* // $ npm install googleapis
|
|
32666
|
+
* // ```
|
|
32667
|
+
*
|
|
32668
|
+
* const {google} = require('googleapis');
|
|
32669
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
32670
|
+
*
|
|
32671
|
+
* async function main() {
|
|
32672
|
+
* const auth = new google.auth.GoogleAuth({
|
|
32673
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
32674
|
+
* scopes: [
|
|
32675
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
32676
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
32677
|
+
* ],
|
|
32678
|
+
* });
|
|
32679
|
+
*
|
|
32680
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
32681
|
+
* const authClient = await auth.getClient();
|
|
32682
|
+
* google.options({auth: authClient});
|
|
32683
|
+
*
|
|
32684
|
+
* // Do the magic
|
|
32685
|
+
* const res =
|
|
32686
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.delete({
|
|
32687
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
32688
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
32689
|
+
* });
|
|
32690
|
+
* console.log(res.data);
|
|
32691
|
+
*
|
|
32692
|
+
* // Example response
|
|
32693
|
+
* // {}
|
|
32694
|
+
* }
|
|
32695
|
+
*
|
|
32696
|
+
* main().catch(e => {
|
|
32697
|
+
* console.error(e);
|
|
32698
|
+
* throw e;
|
|
32699
|
+
* });
|
|
32700
|
+
*
|
|
32701
|
+
* ```
|
|
32702
|
+
*
|
|
32703
|
+
* @param params - Parameters for request
|
|
32704
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
32705
|
+
* @param callback - Optional callback that handles the response.
|
|
32706
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
32707
|
+
*/
|
|
32708
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
32709
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
32710
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
32711
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
32712
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
32713
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
32460
32714
|
/**
|
|
32461
32715
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
32462
32716
|
* @example
|
|
@@ -32859,6 +33113,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
32859
33113
|
* // "branch": "my_branch",
|
|
32860
33114
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
32861
33115
|
* // "contentSearchSpec": {},
|
|
33116
|
+
* // "crowdingSpecs": [],
|
|
32862
33117
|
* // "dataStoreSpecs": [],
|
|
32863
33118
|
* // "displaySpec": {},
|
|
32864
33119
|
* // "embeddingSpec": {},
|
|
@@ -32870,6 +33125,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
32870
33125
|
* // "offset": 0,
|
|
32871
33126
|
* // "oneBoxPageSize": 0,
|
|
32872
33127
|
* // "orderBy": "my_orderBy",
|
|
33128
|
+
* // "pageCategories": [],
|
|
32873
33129
|
* // "pageSize": 0,
|
|
32874
33130
|
* // "pageToken": "my_pageToken",
|
|
32875
33131
|
* // "params": {},
|
|
@@ -32911,6 +33167,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
32911
33167
|
* // "redirectUri": "my_redirectUri",
|
|
32912
33168
|
* // "results": [],
|
|
32913
33169
|
* // "searchLinkPromotions": [],
|
|
33170
|
+
* // "semanticState": "my_semanticState",
|
|
32914
33171
|
* // "sessionInfo": {},
|
|
32915
33172
|
* // "suggestedQuery": "my_suggestedQuery",
|
|
32916
33173
|
* // "summary": {},
|
|
@@ -32985,6 +33242,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
32985
33242
|
* // "branch": "my_branch",
|
|
32986
33243
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
32987
33244
|
* // "contentSearchSpec": {},
|
|
33245
|
+
* // "crowdingSpecs": [],
|
|
32988
33246
|
* // "dataStoreSpecs": [],
|
|
32989
33247
|
* // "displaySpec": {},
|
|
32990
33248
|
* // "embeddingSpec": {},
|
|
@@ -32996,6 +33254,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
32996
33254
|
* // "offset": 0,
|
|
32997
33255
|
* // "oneBoxPageSize": 0,
|
|
32998
33256
|
* // "orderBy": "my_orderBy",
|
|
33257
|
+
* // "pageCategories": [],
|
|
32999
33258
|
* // "pageSize": 0,
|
|
33000
33259
|
* // "pageToken": "my_pageToken",
|
|
33001
33260
|
* // "params": {},
|
|
@@ -33038,6 +33297,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
33038
33297
|
* // "redirectUri": "my_redirectUri",
|
|
33039
33298
|
* // "results": [],
|
|
33040
33299
|
* // "searchLinkPromotions": [],
|
|
33300
|
+
* // "semanticState": "my_semanticState",
|
|
33041
33301
|
* // "sessionInfo": {},
|
|
33042
33302
|
* // "suggestedQuery": "my_suggestedQuery",
|
|
33043
33303
|
* // "summary": {},
|
|
@@ -33162,6 +33422,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
33162
33422
|
*/
|
|
33163
33423
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
33164
33424
|
}
|
|
33425
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
33426
|
+
/**
|
|
33427
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
33428
|
+
*/
|
|
33429
|
+
name?: string;
|
|
33430
|
+
}
|
|
33165
33431
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
33166
33432
|
/**
|
|
33167
33433
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -35455,6 +35721,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
35455
35721
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
35456
35722
|
* scopes: [
|
|
35457
35723
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
35724
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
35458
35725
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
35459
35726
|
* ],
|
|
35460
35727
|
* });
|
|
@@ -36656,7 +36923,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36656
36923
|
* pageSize: 'placeholder-value',
|
|
36657
36924
|
* // The standard list page token.
|
|
36658
36925
|
* pageToken: 'placeholder-value',
|
|
36659
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
36926
|
+
* // 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.
|
|
36660
36927
|
* returnPartialSuccess: 'placeholder-value',
|
|
36661
36928
|
* },
|
|
36662
36929
|
* );
|
|
@@ -36713,7 +36980,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36713
36980
|
*/
|
|
36714
36981
|
pageToken?: string;
|
|
36715
36982
|
/**
|
|
36716
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
36983
|
+
* 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.
|
|
36717
36984
|
*/
|
|
36718
36985
|
returnPartialSuccess?: boolean;
|
|
36719
36986
|
}
|
|
@@ -37121,7 +37388,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
37121
37388
|
* pageSize: 'placeholder-value',
|
|
37122
37389
|
* // The standard list page token.
|
|
37123
37390
|
* pageToken: 'placeholder-value',
|
|
37124
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37391
|
+
* // 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.
|
|
37125
37392
|
* returnPartialSuccess: 'placeholder-value',
|
|
37126
37393
|
* });
|
|
37127
37394
|
* console.log(res.data);
|
|
@@ -37177,7 +37444,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
37177
37444
|
*/
|
|
37178
37445
|
pageToken?: string;
|
|
37179
37446
|
/**
|
|
37180
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37447
|
+
* 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.
|
|
37181
37448
|
*/
|
|
37182
37449
|
returnPartialSuccess?: boolean;
|
|
37183
37450
|
}
|
|
@@ -39218,8 +39485,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39218
39485
|
* // Do the magic
|
|
39219
39486
|
* const res =
|
|
39220
39487
|
* await discoveryengine.projects.locations.userStores.userLicenses.list({
|
|
39221
|
-
* // Optional.
|
|
39222
|
-
*
|
|
39488
|
+
* // 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.
|
|
39489
|
+
* orderBy: 'placeholder-value',
|
|
39223
39490
|
* // 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.
|
|
39224
39491
|
* pageSize: 'placeholder-value',
|
|
39225
39492
|
* // 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.
|
|
@@ -39258,9 +39525,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39258
39525
|
}
|
|
39259
39526
|
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
|
|
39260
39527
|
/**
|
|
39261
|
-
* Optional.
|
|
39528
|
+
* 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.
|
|
39262
39529
|
*/
|
|
39263
|
-
|
|
39530
|
+
orderBy?: string;
|
|
39264
39531
|
/**
|
|
39265
39532
|
* 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.
|
|
39266
39533
|
*/
|
|
@@ -39386,7 +39653,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39386
39653
|
* pageSize: 'placeholder-value',
|
|
39387
39654
|
* // The standard list page token.
|
|
39388
39655
|
* pageToken: 'placeholder-value',
|
|
39389
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
39656
|
+
* // 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.
|
|
39390
39657
|
* returnPartialSuccess: 'placeholder-value',
|
|
39391
39658
|
* });
|
|
39392
39659
|
* console.log(res.data);
|
|
@@ -39442,7 +39709,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39442
39709
|
*/
|
|
39443
39710
|
pageToken?: string;
|
|
39444
39711
|
/**
|
|
39445
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
39712
|
+
* 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.
|
|
39446
39713
|
*/
|
|
39447
39714
|
returnPartialSuccess?: boolean;
|
|
39448
39715
|
}
|