@googleapis/discoveryengine 27.0.0 → 28.0.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 +19 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +2055 -519
- package/build/v1.js +423 -40
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +2271 -1387
- package/build/v1alpha.js +599 -191
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +682 -482
- package/build/v1beta.js +195 -40
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +3462 -1266
- package/v1alpha.ts +4146 -2635
- package/v1beta.ts +1617 -1316
package/build/v1.d.ts
CHANGED
|
@@ -67,341 +67,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
67
67
|
*/
|
|
68
68
|
export class Discoveryengine {
|
|
69
69
|
context: APIRequestContext;
|
|
70
|
-
media: Resource$Media;
|
|
71
70
|
projects: Resource$Projects;
|
|
72
71
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
73
72
|
}
|
|
74
|
-
/**
|
|
75
|
-
* Information to read/write to blobstore2.
|
|
76
|
-
*/
|
|
77
|
-
export interface Schema$GdataBlobstore2Info {
|
|
78
|
-
/**
|
|
79
|
-
* The blob generation id.
|
|
80
|
-
*/
|
|
81
|
-
blobGeneration?: string | null;
|
|
82
|
-
/**
|
|
83
|
-
* The blob id, e.g., /blobstore/prod/playground/scotty
|
|
84
|
-
*/
|
|
85
|
-
blobId?: string | null;
|
|
86
|
-
/**
|
|
87
|
-
* Read handle passed from Bigstore -\> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
|
|
88
|
-
*/
|
|
89
|
-
downloadReadHandle?: string | null;
|
|
90
|
-
/**
|
|
91
|
-
* The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
|
|
92
|
-
*/
|
|
93
|
-
readToken?: string | null;
|
|
94
|
-
/**
|
|
95
|
-
* Metadata passed from Blobstore -\> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
|
|
96
|
-
*/
|
|
97
|
-
uploadMetadataContainer?: string | null;
|
|
98
|
-
}
|
|
99
|
-
/**
|
|
100
|
-
* A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
|
|
101
|
-
*/
|
|
102
|
-
export interface Schema$GdataCompositeMedia {
|
|
103
|
-
/**
|
|
104
|
-
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
|
|
105
|
-
*/
|
|
106
|
-
blobRef?: string | null;
|
|
107
|
-
/**
|
|
108
|
-
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
|
|
109
|
-
*/
|
|
110
|
-
blobstore2Info?: Schema$GdataBlobstore2Info;
|
|
111
|
-
/**
|
|
112
|
-
* A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
|
|
113
|
-
*/
|
|
114
|
-
cosmoBinaryReference?: string | null;
|
|
115
|
-
/**
|
|
116
|
-
* crc32.c hash for the payload.
|
|
117
|
-
*/
|
|
118
|
-
crc32cHash?: number | null;
|
|
119
|
-
/**
|
|
120
|
-
* Media data, set if reference_type is INLINE
|
|
121
|
-
*/
|
|
122
|
-
inline?: string | null;
|
|
123
|
-
/**
|
|
124
|
-
* Size of the data, in bytes
|
|
125
|
-
*/
|
|
126
|
-
length?: string | null;
|
|
127
|
-
/**
|
|
128
|
-
* MD5 hash for the payload.
|
|
129
|
-
*/
|
|
130
|
-
md5Hash?: string | null;
|
|
131
|
-
/**
|
|
132
|
-
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
|
|
133
|
-
*/
|
|
134
|
-
objectId?: Schema$GdataObjectId;
|
|
135
|
-
/**
|
|
136
|
-
* Path to the data, set if reference_type is PATH
|
|
137
|
-
*/
|
|
138
|
-
path?: string | null;
|
|
139
|
-
/**
|
|
140
|
-
* Describes what the field reference contains.
|
|
141
|
-
*/
|
|
142
|
-
referenceType?: string | null;
|
|
143
|
-
/**
|
|
144
|
-
* SHA-1 hash for the payload.
|
|
145
|
-
*/
|
|
146
|
-
sha1Hash?: string | null;
|
|
147
|
-
}
|
|
148
|
-
/**
|
|
149
|
-
* Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
|
|
150
|
-
*/
|
|
151
|
-
export interface Schema$GdataContentTypeInfo {
|
|
152
|
-
/**
|
|
153
|
-
* Scotty's best guess of what the content type of the file is.
|
|
154
|
-
*/
|
|
155
|
-
bestGuess?: string | null;
|
|
156
|
-
/**
|
|
157
|
-
* The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
|
|
158
|
-
*/
|
|
159
|
-
fromBytes?: string | null;
|
|
160
|
-
/**
|
|
161
|
-
* The content type of the file derived from the file extension of the original file name used by the client.
|
|
162
|
-
*/
|
|
163
|
-
fromFileName?: string | null;
|
|
164
|
-
/**
|
|
165
|
-
* The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
|
|
166
|
-
*/
|
|
167
|
-
fromHeader?: string | null;
|
|
168
|
-
/**
|
|
169
|
-
* The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
|
|
170
|
-
*/
|
|
171
|
-
fromUrlPath?: string | null;
|
|
172
|
-
}
|
|
173
|
-
/**
|
|
174
|
-
* Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
175
|
-
*/
|
|
176
|
-
export interface Schema$GdataDiffChecksumsResponse {
|
|
177
|
-
/**
|
|
178
|
-
* Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
|
|
179
|
-
*/
|
|
180
|
-
checksumsLocation?: Schema$GdataCompositeMedia;
|
|
181
|
-
/**
|
|
182
|
-
* The chunk size of checksums. Must be a multiple of 256KB.
|
|
183
|
-
*/
|
|
184
|
-
chunkSizeBytes?: string | null;
|
|
185
|
-
/**
|
|
186
|
-
* If set, calculate the checksums based on the contents and return them to the caller.
|
|
187
|
-
*/
|
|
188
|
-
objectLocation?: Schema$GdataCompositeMedia;
|
|
189
|
-
/**
|
|
190
|
-
* The total size of the server object.
|
|
191
|
-
*/
|
|
192
|
-
objectSizeBytes?: string | null;
|
|
193
|
-
/**
|
|
194
|
-
* The object version of the object the checksums are being returned for.
|
|
195
|
-
*/
|
|
196
|
-
objectVersion?: string | null;
|
|
197
|
-
}
|
|
198
|
-
/**
|
|
199
|
-
* Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
200
|
-
*/
|
|
201
|
-
export interface Schema$GdataDiffDownloadResponse {
|
|
202
|
-
/**
|
|
203
|
-
* The original object location.
|
|
204
|
-
*/
|
|
205
|
-
objectLocation?: Schema$GdataCompositeMedia;
|
|
206
|
-
}
|
|
207
|
-
/**
|
|
208
|
-
* A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
209
|
-
*/
|
|
210
|
-
export interface Schema$GdataDiffUploadRequest {
|
|
211
|
-
/**
|
|
212
|
-
* The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
|
|
213
|
-
*/
|
|
214
|
-
checksumsInfo?: Schema$GdataCompositeMedia;
|
|
215
|
-
/**
|
|
216
|
-
* The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
|
|
217
|
-
*/
|
|
218
|
-
objectInfo?: Schema$GdataCompositeMedia;
|
|
219
|
-
/**
|
|
220
|
-
* The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
|
|
221
|
-
*/
|
|
222
|
-
objectVersion?: string | null;
|
|
223
|
-
}
|
|
224
|
-
/**
|
|
225
|
-
* Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
226
|
-
*/
|
|
227
|
-
export interface Schema$GdataDiffUploadResponse {
|
|
228
|
-
/**
|
|
229
|
-
* The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
|
|
230
|
-
*/
|
|
231
|
-
objectVersion?: string | null;
|
|
232
|
-
/**
|
|
233
|
-
* The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
|
|
234
|
-
*/
|
|
235
|
-
originalObject?: Schema$GdataCompositeMedia;
|
|
236
|
-
}
|
|
237
|
-
/**
|
|
238
|
-
* Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
|
|
239
|
-
*/
|
|
240
|
-
export interface Schema$GdataDiffVersionResponse {
|
|
241
|
-
/**
|
|
242
|
-
* The total size of the server object.
|
|
243
|
-
*/
|
|
244
|
-
objectSizeBytes?: string | null;
|
|
245
|
-
/**
|
|
246
|
-
* The version of the object stored at the server.
|
|
247
|
-
*/
|
|
248
|
-
objectVersion?: string | null;
|
|
249
|
-
}
|
|
250
|
-
/**
|
|
251
|
-
* Parameters specific to media downloads.
|
|
252
|
-
*/
|
|
253
|
-
export interface Schema$GdataDownloadParameters {
|
|
254
|
-
/**
|
|
255
|
-
* A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
|
|
256
|
-
*/
|
|
257
|
-
allowGzipCompression?: boolean | null;
|
|
258
|
-
/**
|
|
259
|
-
* Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
|
|
260
|
-
*/
|
|
261
|
-
ignoreRange?: boolean | null;
|
|
262
|
-
}
|
|
263
|
-
/**
|
|
264
|
-
* A reference to data stored on the filesystem, on GFS or in blobstore.
|
|
265
|
-
*/
|
|
266
|
-
export interface Schema$GdataMedia {
|
|
267
|
-
/**
|
|
268
|
-
* Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
|
|
269
|
-
*/
|
|
270
|
-
algorithm?: string | null;
|
|
271
|
-
/**
|
|
272
|
-
* Use object_id instead.
|
|
273
|
-
*/
|
|
274
|
-
bigstoreObjectRef?: string | null;
|
|
275
|
-
/**
|
|
276
|
-
* Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
|
|
277
|
-
*/
|
|
278
|
-
blobRef?: string | null;
|
|
279
|
-
/**
|
|
280
|
-
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
|
|
281
|
-
*/
|
|
282
|
-
blobstore2Info?: Schema$GdataBlobstore2Info;
|
|
283
|
-
/**
|
|
284
|
-
* A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
|
|
285
|
-
*/
|
|
286
|
-
compositeMedia?: Schema$GdataCompositeMedia[];
|
|
287
|
-
/**
|
|
288
|
-
* MIME type of the data
|
|
289
|
-
*/
|
|
290
|
-
contentType?: string | null;
|
|
291
|
-
/**
|
|
292
|
-
* Extended content type information provided for Scotty uploads.
|
|
293
|
-
*/
|
|
294
|
-
contentTypeInfo?: Schema$GdataContentTypeInfo;
|
|
295
|
-
/**
|
|
296
|
-
* A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
|
|
297
|
-
*/
|
|
298
|
-
cosmoBinaryReference?: string | null;
|
|
299
|
-
/**
|
|
300
|
-
* For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
|
|
301
|
-
*/
|
|
302
|
-
crc32cHash?: number | null;
|
|
303
|
-
/**
|
|
304
|
-
* Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
|
|
305
|
-
*/
|
|
306
|
-
diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse;
|
|
307
|
-
/**
|
|
308
|
-
* Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
|
|
309
|
-
*/
|
|
310
|
-
diffDownloadResponse?: Schema$GdataDiffDownloadResponse;
|
|
311
|
-
/**
|
|
312
|
-
* Set if reference_type is DIFF_UPLOAD_REQUEST.
|
|
313
|
-
*/
|
|
314
|
-
diffUploadRequest?: Schema$GdataDiffUploadRequest;
|
|
315
|
-
/**
|
|
316
|
-
* Set if reference_type is DIFF_UPLOAD_RESPONSE.
|
|
317
|
-
*/
|
|
318
|
-
diffUploadResponse?: Schema$GdataDiffUploadResponse;
|
|
319
|
-
/**
|
|
320
|
-
* Set if reference_type is DIFF_VERSION_RESPONSE.
|
|
321
|
-
*/
|
|
322
|
-
diffVersionResponse?: Schema$GdataDiffVersionResponse;
|
|
323
|
-
/**
|
|
324
|
-
* Parameters for a media download.
|
|
325
|
-
*/
|
|
326
|
-
downloadParameters?: Schema$GdataDownloadParameters;
|
|
327
|
-
/**
|
|
328
|
-
* Original file name
|
|
329
|
-
*/
|
|
330
|
-
filename?: string | null;
|
|
331
|
-
/**
|
|
332
|
-
* Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
|
|
333
|
-
*/
|
|
334
|
-
hash?: string | null;
|
|
335
|
-
/**
|
|
336
|
-
* For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
|
|
337
|
-
*/
|
|
338
|
-
hashVerified?: boolean | null;
|
|
339
|
-
/**
|
|
340
|
-
* Media data, set if reference_type is INLINE
|
|
341
|
-
*/
|
|
342
|
-
inline?: string | null;
|
|
343
|
-
/**
|
|
344
|
-
* |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
|
|
345
|
-
*/
|
|
346
|
-
isPotentialRetry?: boolean | null;
|
|
347
|
-
/**
|
|
348
|
-
* Size of the data, in bytes
|
|
349
|
-
*/
|
|
350
|
-
length?: string | null;
|
|
351
|
-
/**
|
|
352
|
-
* Scotty-provided MD5 hash for an upload.
|
|
353
|
-
*/
|
|
354
|
-
md5Hash?: string | null;
|
|
355
|
-
/**
|
|
356
|
-
* Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
|
|
357
|
-
*/
|
|
358
|
-
mediaId?: string | null;
|
|
359
|
-
/**
|
|
360
|
-
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
|
|
361
|
-
*/
|
|
362
|
-
objectId?: Schema$GdataObjectId;
|
|
363
|
-
/**
|
|
364
|
-
* Path to the data, set if reference_type is PATH
|
|
365
|
-
*/
|
|
366
|
-
path?: string | null;
|
|
367
|
-
/**
|
|
368
|
-
* Describes what the field reference contains.
|
|
369
|
-
*/
|
|
370
|
-
referenceType?: string | null;
|
|
371
|
-
/**
|
|
372
|
-
* Scotty-provided SHA1 hash for an upload.
|
|
373
|
-
*/
|
|
374
|
-
sha1Hash?: string | null;
|
|
375
|
-
/**
|
|
376
|
-
* Scotty-provided SHA256 hash for an upload.
|
|
377
|
-
*/
|
|
378
|
-
sha256Hash?: string | null;
|
|
379
|
-
/**
|
|
380
|
-
* Time at which the media data was last updated, in milliseconds since UNIX epoch
|
|
381
|
-
*/
|
|
382
|
-
timestamp?: string | null;
|
|
383
|
-
/**
|
|
384
|
-
* A unique fingerprint/version id for the media data
|
|
385
|
-
*/
|
|
386
|
-
token?: string | null;
|
|
387
|
-
}
|
|
388
|
-
/**
|
|
389
|
-
* This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
|
|
390
|
-
*/
|
|
391
|
-
export interface Schema$GdataObjectId {
|
|
392
|
-
/**
|
|
393
|
-
* The name of the bucket to which this object belongs.
|
|
394
|
-
*/
|
|
395
|
-
bucketName?: string | null;
|
|
396
|
-
/**
|
|
397
|
-
* Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
|
|
398
|
-
*/
|
|
399
|
-
generation?: string | null;
|
|
400
|
-
/**
|
|
401
|
-
* The name of the object.
|
|
402
|
-
*/
|
|
403
|
-
objectName?: string | null;
|
|
404
|
-
}
|
|
405
73
|
/**
|
|
406
74
|
* `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
|
|
407
75
|
*/
|
|
@@ -3122,6 +2790,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3122
2790
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
3123
2791
|
*/
|
|
3124
2792
|
enableImageAnnotation?: boolean | null;
|
|
2793
|
+
/**
|
|
2794
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
2795
|
+
*/
|
|
2796
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
3125
2797
|
/**
|
|
3126
2798
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
3127
2799
|
*/
|
|
@@ -3190,6 +2862,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3190
2862
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3191
2863
|
*/
|
|
3192
2864
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
|
|
2865
|
+
/**
|
|
2866
|
+
* Output only. CMEK-related information for the Engine.
|
|
2867
|
+
*/
|
|
2868
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
|
|
3193
2869
|
/**
|
|
3194
2870
|
* Common config spec that specifies the metadata of the engine.
|
|
3195
2871
|
*/
|
|
@@ -3228,6 +2904,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
3228
2904
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
3229
2905
|
*/
|
|
3230
2906
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
2907
|
+
/**
|
|
2908
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
2909
|
+
*/
|
|
2910
|
+
modelConfigs?: {
|
|
2911
|
+
[key: string]: string;
|
|
2912
|
+
} | null;
|
|
3231
2913
|
/**
|
|
3232
2914
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3233
2915
|
*/
|
|
@@ -3407,6 +3089,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3407
3089
|
* Configurations for a Search Engine.
|
|
3408
3090
|
*/
|
|
3409
3091
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
3092
|
+
/**
|
|
3093
|
+
* Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
|
|
3094
|
+
*/
|
|
3095
|
+
requiredSubscriptionTier?: string | null;
|
|
3410
3096
|
/**
|
|
3411
3097
|
* The add-on that this search engine enables.
|
|
3412
3098
|
*/
|
|
@@ -4547,6 +4233,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4547
4233
|
* A specification for configuring the behavior of content search.
|
|
4548
4234
|
*/
|
|
4549
4235
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
4236
|
+
/**
|
|
4237
|
+
* Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
|
|
4238
|
+
*/
|
|
4239
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
4550
4240
|
/**
|
|
4551
4241
|
* Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
|
|
4552
4242
|
*/
|
|
@@ -4595,6 +4285,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4595
4285
|
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
4596
4286
|
*/
|
|
4597
4287
|
orderBy?: string | null;
|
|
4288
|
+
/**
|
|
4289
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
4290
|
+
*/
|
|
4291
|
+
pageCategories?: string[] | null;
|
|
4598
4292
|
/**
|
|
4599
4293
|
* Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
4600
4294
|
*/
|
|
@@ -4904,6 +4598,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
4904
4598
|
*/
|
|
4905
4599
|
imageSource?: string | null;
|
|
4906
4600
|
}
|
|
4601
|
+
/**
|
|
4602
|
+
* Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
|
|
4603
|
+
*/
|
|
4604
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec {
|
|
4605
|
+
/**
|
|
4606
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
4607
|
+
*/
|
|
4608
|
+
field?: string | null;
|
|
4609
|
+
/**
|
|
4610
|
+
* The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
|
|
4611
|
+
*/
|
|
4612
|
+
maxCount?: number | null;
|
|
4613
|
+
/**
|
|
4614
|
+
* Mode to use for documents that are crowded away.
|
|
4615
|
+
*/
|
|
4616
|
+
mode?: string | null;
|
|
4617
|
+
}
|
|
4907
4618
|
/**
|
|
4908
4619
|
* A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
4909
4620
|
*/
|
|
@@ -6486,6 +6197,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
6486
6197
|
* Optional. Customer policy for the assistant.
|
|
6487
6198
|
*/
|
|
6488
6199
|
customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
6200
|
+
/**
|
|
6201
|
+
* Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
|
|
6202
|
+
*/
|
|
6203
|
+
description?: string | null;
|
|
6204
|
+
/**
|
|
6205
|
+
* Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
|
|
6206
|
+
*/
|
|
6207
|
+
displayName?: string | null;
|
|
6489
6208
|
/**
|
|
6490
6209
|
* Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId\}/locations/{locationId\}/collections/{collectionId\}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] \}
|
|
6491
6210
|
*/
|
|
@@ -6637,10 +6356,18 @@ export declare namespace discoveryengine_v1 {
|
|
|
6637
6356
|
* Configuration for the generation of the assistant response.
|
|
6638
6357
|
*/
|
|
6639
6358
|
export interface Schema$GoogleCloudDiscoveryengineV1AssistantGenerationConfig {
|
|
6359
|
+
/**
|
|
6360
|
+
* Optional. The list of models that are allowed to be used for assistant.
|
|
6361
|
+
*/
|
|
6362
|
+
allowedModelIds?: string[] | null;
|
|
6640
6363
|
/**
|
|
6641
6364
|
* The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.
|
|
6642
6365
|
*/
|
|
6643
6366
|
defaultLanguage?: string | null;
|
|
6367
|
+
/**
|
|
6368
|
+
* Optional. The default model to use for assistant.
|
|
6369
|
+
*/
|
|
6370
|
+
defaultModelId?: string | null;
|
|
6644
6371
|
/**
|
|
6645
6372
|
* System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
|
|
6646
6373
|
*/
|
|
@@ -7663,6 +7390,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7663
7390
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
7664
7391
|
*/
|
|
7665
7392
|
enableImageAnnotation?: boolean | null;
|
|
7393
|
+
/**
|
|
7394
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
7395
|
+
*/
|
|
7396
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
7666
7397
|
/**
|
|
7667
7398
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
7668
7399
|
*/
|
|
@@ -7731,6 +7462,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7731
7462
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
7732
7463
|
*/
|
|
7733
7464
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
7465
|
+
/**
|
|
7466
|
+
* Output only. CMEK-related information for the Engine.
|
|
7467
|
+
*/
|
|
7468
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
|
|
7734
7469
|
/**
|
|
7735
7470
|
* Common config spec that specifies the metadata of the engine.
|
|
7736
7471
|
*/
|
|
@@ -7769,6 +7504,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
7769
7504
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
7770
7505
|
*/
|
|
7771
7506
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
|
|
7507
|
+
/**
|
|
7508
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
7509
|
+
*/
|
|
7510
|
+
modelConfigs?: {
|
|
7511
|
+
[key: string]: string;
|
|
7512
|
+
} | null;
|
|
7772
7513
|
/**
|
|
7773
7514
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
7774
7515
|
*/
|
|
@@ -7915,6 +7656,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7915
7656
|
* Configurations for a Search Engine.
|
|
7916
7657
|
*/
|
|
7917
7658
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
7659
|
+
/**
|
|
7660
|
+
* Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
|
|
7661
|
+
*/
|
|
7662
|
+
requiredSubscriptionTier?: string | null;
|
|
7918
7663
|
/**
|
|
7919
7664
|
* The add-on that this search engine enables.
|
|
7920
7665
|
*/
|
|
@@ -8682,6 +8427,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
8682
8427
|
* A specification for configuring the behavior of content search.
|
|
8683
8428
|
*/
|
|
8684
8429
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
8430
|
+
/**
|
|
8431
|
+
* Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
|
|
8432
|
+
*/
|
|
8433
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
8685
8434
|
/**
|
|
8686
8435
|
* Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.
|
|
8687
8436
|
*/
|
|
@@ -8726,6 +8475,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
8726
8475
|
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
8727
8476
|
*/
|
|
8728
8477
|
orderBy?: string | null;
|
|
8478
|
+
/**
|
|
8479
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
8480
|
+
*/
|
|
8481
|
+
pageCategories?: string[] | null;
|
|
8729
8482
|
/**
|
|
8730
8483
|
* Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
8731
8484
|
*/
|
|
@@ -9031,6 +8784,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
9031
8784
|
*/
|
|
9032
8785
|
imageSource?: string | null;
|
|
9033
8786
|
}
|
|
8787
|
+
/**
|
|
8788
|
+
* Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
|
|
8789
|
+
*/
|
|
8790
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec {
|
|
8791
|
+
/**
|
|
8792
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
8793
|
+
*/
|
|
8794
|
+
field?: string | null;
|
|
8795
|
+
/**
|
|
8796
|
+
* The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
|
|
8797
|
+
*/
|
|
8798
|
+
maxCount?: number | null;
|
|
8799
|
+
/**
|
|
8800
|
+
* Mode to use for documents that are crowded away.
|
|
8801
|
+
*/
|
|
8802
|
+
mode?: string | null;
|
|
8803
|
+
}
|
|
9034
8804
|
/**
|
|
9035
8805
|
* A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
9036
8806
|
*/
|
|
@@ -11298,6 +11068,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11298
11068
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
11299
11069
|
*/
|
|
11300
11070
|
enableImageAnnotation?: boolean | null;
|
|
11071
|
+
/**
|
|
11072
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
11073
|
+
*/
|
|
11074
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
11301
11075
|
/**
|
|
11302
11076
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
11303
11077
|
*/
|
|
@@ -11380,6 +11154,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11380
11154
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
11381
11155
|
*/
|
|
11382
11156
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
11157
|
+
/**
|
|
11158
|
+
* Output only. CMEK-related information for the Engine.
|
|
11159
|
+
*/
|
|
11160
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
|
|
11383
11161
|
/**
|
|
11384
11162
|
* Common config spec that specifies the metadata of the engine.
|
|
11385
11163
|
*/
|
|
@@ -11418,6 +11196,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
11418
11196
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
11419
11197
|
*/
|
|
11420
11198
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
|
|
11199
|
+
/**
|
|
11200
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
11201
|
+
*/
|
|
11202
|
+
modelConfigs?: {
|
|
11203
|
+
[key: string]: string;
|
|
11204
|
+
} | null;
|
|
11421
11205
|
/**
|
|
11422
11206
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
11423
11207
|
*/
|
|
@@ -11564,6 +11348,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11564
11348
|
* Configurations for a Search Engine.
|
|
11565
11349
|
*/
|
|
11566
11350
|
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
11351
|
+
/**
|
|
11352
|
+
* 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.
|
|
11353
|
+
*/
|
|
11354
|
+
requiredSubscriptionTier?: string | null;
|
|
11567
11355
|
/**
|
|
11568
11356
|
* The add-on that this search engine enables.
|
|
11569
11357
|
*/
|
|
@@ -11734,6 +11522,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11734
11522
|
* Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.
|
|
11735
11523
|
*/
|
|
11736
11524
|
externalIdentity?: string | null;
|
|
11525
|
+
/**
|
|
11526
|
+
* Optional. The name of the external identity.
|
|
11527
|
+
*/
|
|
11528
|
+
externalIdentityName?: string | null;
|
|
11737
11529
|
/**
|
|
11738
11530
|
* 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.
|
|
11739
11531
|
*/
|
|
@@ -12214,6 +12006,32 @@ export declare namespace discoveryengine_v1 {
|
|
|
12214
12006
|
*/
|
|
12215
12007
|
subscriptionTier?: string | null;
|
|
12216
12008
|
}
|
|
12009
|
+
/**
|
|
12010
|
+
* Stats about users' licenses.
|
|
12011
|
+
*/
|
|
12012
|
+
export interface Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats {
|
|
12013
|
+
/**
|
|
12014
|
+
* Required. The LicenseConfig name.
|
|
12015
|
+
*/
|
|
12016
|
+
licenseConfig?: string | null;
|
|
12017
|
+
/**
|
|
12018
|
+
* Required. The number of licenses used.
|
|
12019
|
+
*/
|
|
12020
|
+
usedLicenseCount?: string | null;
|
|
12021
|
+
}
|
|
12022
|
+
/**
|
|
12023
|
+
* Response message for the AssistantService.ListAssistants method.
|
|
12024
|
+
*/
|
|
12025
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse {
|
|
12026
|
+
/**
|
|
12027
|
+
* All the customer's Assistants.
|
|
12028
|
+
*/
|
|
12029
|
+
assistants?: Schema$GoogleCloudDiscoveryengineV1Assistant[];
|
|
12030
|
+
/**
|
|
12031
|
+
* 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.
|
|
12032
|
+
*/
|
|
12033
|
+
nextPageToken?: string | null;
|
|
12034
|
+
}
|
|
12217
12035
|
/**
|
|
12218
12036
|
* Response message for CmekConfigService.ListCmekConfigs method.
|
|
12219
12037
|
*/
|
|
@@ -12323,6 +12141,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
12323
12141
|
*/
|
|
12324
12142
|
nextPageToken?: string | null;
|
|
12325
12143
|
}
|
|
12144
|
+
/**
|
|
12145
|
+
* Response message for UserLicenseService.ListLicenseConfigUsageStats method.
|
|
12146
|
+
*/
|
|
12147
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse {
|
|
12148
|
+
/**
|
|
12149
|
+
* All the customer's LicenseConfigUsageStats.
|
|
12150
|
+
*/
|
|
12151
|
+
licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats[];
|
|
12152
|
+
}
|
|
12326
12153
|
/**
|
|
12327
12154
|
* Response message for SchemaService.ListSchemas method.
|
|
12328
12155
|
*/
|
|
@@ -13076,6 +12903,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
13076
12903
|
* A specification for configuring the behavior of content search.
|
|
13077
12904
|
*/
|
|
13078
12905
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
12906
|
+
/**
|
|
12907
|
+
* 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.
|
|
12908
|
+
*/
|
|
12909
|
+
crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec[];
|
|
13079
12910
|
/**
|
|
13080
12911
|
* 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.
|
|
13081
12912
|
*/
|
|
@@ -13116,6 +12947,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
13116
12947
|
* 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.
|
|
13117
12948
|
*/
|
|
13118
12949
|
orderBy?: string | null;
|
|
12950
|
+
/**
|
|
12951
|
+
* 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. 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`
|
|
12952
|
+
*/
|
|
12953
|
+
pageCategories?: string[] | null;
|
|
13119
12954
|
/**
|
|
13120
12955
|
* 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.
|
|
13121
12956
|
*/
|
|
@@ -13392,6 +13227,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
13392
13227
|
*/
|
|
13393
13228
|
version?: string | null;
|
|
13394
13229
|
}
|
|
13230
|
+
/**
|
|
13231
|
+
* 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.
|
|
13232
|
+
*/
|
|
13233
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec {
|
|
13234
|
+
/**
|
|
13235
|
+
* The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
|
|
13236
|
+
*/
|
|
13237
|
+
field?: string | null;
|
|
13238
|
+
/**
|
|
13239
|
+
* 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.
|
|
13240
|
+
*/
|
|
13241
|
+
maxCount?: number | null;
|
|
13242
|
+
/**
|
|
13243
|
+
* Mode to use for documents that are crowded away.
|
|
13244
|
+
*/
|
|
13245
|
+
mode?: string | null;
|
|
13246
|
+
}
|
|
13395
13247
|
/**
|
|
13396
13248
|
* 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.
|
|
13397
13249
|
*/
|
|
@@ -13595,6 +13447,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
13595
13447
|
* Promotions for site search.
|
|
13596
13448
|
*/
|
|
13597
13449
|
searchLinkPromotions?: Schema$GoogleCloudDiscoveryengineV1SearchLinkPromotion[];
|
|
13450
|
+
/**
|
|
13451
|
+
* Output only. Indicates the semantic state of the search response.
|
|
13452
|
+
*/
|
|
13453
|
+
semanticState?: string | null;
|
|
13598
13454
|
/**
|
|
13599
13455
|
* Session information. Only set if SearchRequest.session is provided. See its description for more details.
|
|
13600
13456
|
*/
|
|
@@ -14246,6 +14102,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
14246
14102
|
* A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
|
|
14247
14103
|
*/
|
|
14248
14104
|
assistToken?: string | null;
|
|
14105
|
+
/**
|
|
14106
|
+
* The tool names of the tools that were invoked.
|
|
14107
|
+
*/
|
|
14108
|
+
invocationTools?: string[] | null;
|
|
14249
14109
|
/**
|
|
14250
14110
|
* Session information. Only included in the final StreamAssistResponse of the response stream.
|
|
14251
14111
|
*/
|
|
@@ -14686,6 +14546,481 @@ export declare namespace discoveryengine_v1 {
|
|
|
14686
14546
|
*/
|
|
14687
14547
|
name?: string | null;
|
|
14688
14548
|
}
|
|
14549
|
+
/**
|
|
14550
|
+
* WidgetConfig captures configs at the Widget level.
|
|
14551
|
+
*/
|
|
14552
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfig {
|
|
14553
|
+
/**
|
|
14554
|
+
* Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
|
|
14555
|
+
*/
|
|
14556
|
+
accessSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings;
|
|
14557
|
+
/**
|
|
14558
|
+
* Allowlisted domains that can load this widget.
|
|
14559
|
+
*/
|
|
14560
|
+
allowlistedDomains?: string[] | null;
|
|
14561
|
+
/**
|
|
14562
|
+
* Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
|
|
14563
|
+
*/
|
|
14564
|
+
allowPublicAccess?: boolean | null;
|
|
14565
|
+
/**
|
|
14566
|
+
* Optional. Output only. Describes the assistant settings of the widget.
|
|
14567
|
+
*/
|
|
14568
|
+
assistantSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings;
|
|
14569
|
+
/**
|
|
14570
|
+
* Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
|
|
14571
|
+
*/
|
|
14572
|
+
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent[];
|
|
14573
|
+
/**
|
|
14574
|
+
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
14575
|
+
*/
|
|
14576
|
+
configId?: string | null;
|
|
14577
|
+
/**
|
|
14578
|
+
* The content search spec that configs the desired behavior of content search.
|
|
14579
|
+
*/
|
|
14580
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
14581
|
+
/**
|
|
14582
|
+
* Output only. Timestamp the WidgetConfig was created.
|
|
14583
|
+
*/
|
|
14584
|
+
createTime?: string | null;
|
|
14585
|
+
/**
|
|
14586
|
+
* Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
|
|
14587
|
+
*/
|
|
14588
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig;
|
|
14589
|
+
/**
|
|
14590
|
+
* Output only. The type of the parent data store.
|
|
14591
|
+
*/
|
|
14592
|
+
dataStoreType?: string | null;
|
|
14593
|
+
/**
|
|
14594
|
+
* Configurable UI configurations per data store.
|
|
14595
|
+
*/
|
|
14596
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
|
|
14597
|
+
/**
|
|
14598
|
+
* The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
|
|
14599
|
+
*/
|
|
14600
|
+
defaultSearchRequestOrderBy?: string | null;
|
|
14601
|
+
/**
|
|
14602
|
+
* Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
14603
|
+
*/
|
|
14604
|
+
displayName?: string | null;
|
|
14605
|
+
/**
|
|
14606
|
+
* Whether or not to enable autocomplete.
|
|
14607
|
+
*/
|
|
14608
|
+
enableAutocomplete?: boolean | null;
|
|
14609
|
+
/**
|
|
14610
|
+
* Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
|
|
14611
|
+
*/
|
|
14612
|
+
enableConversationalSearch?: boolean | null;
|
|
14613
|
+
/**
|
|
14614
|
+
* Optional. Output only. Whether to enable private knowledge graph.
|
|
14615
|
+
*/
|
|
14616
|
+
enablePrivateKnowledgeGraph?: boolean | null;
|
|
14617
|
+
/**
|
|
14618
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
14619
|
+
*/
|
|
14620
|
+
enableQualityFeedback?: boolean | null;
|
|
14621
|
+
/**
|
|
14622
|
+
* Whether to show the result score.
|
|
14623
|
+
*/
|
|
14624
|
+
enableResultScore?: boolean | null;
|
|
14625
|
+
/**
|
|
14626
|
+
* Whether to enable safe search.
|
|
14627
|
+
*/
|
|
14628
|
+
enableSafeSearch?: boolean | null;
|
|
14629
|
+
/**
|
|
14630
|
+
* Whether to enable search-as-you-type behavior for the search widget
|
|
14631
|
+
*/
|
|
14632
|
+
enableSearchAsYouType?: boolean | null;
|
|
14633
|
+
/**
|
|
14634
|
+
* Turn on or off summary for each snippets result.
|
|
14635
|
+
*/
|
|
14636
|
+
enableSnippetResultSummary?: boolean | null;
|
|
14637
|
+
/**
|
|
14638
|
+
* Turn on or off summarization for the search response.
|
|
14639
|
+
*/
|
|
14640
|
+
enableSummarization?: boolean | null;
|
|
14641
|
+
/**
|
|
14642
|
+
* Whether to enable standalone web app.
|
|
14643
|
+
*/
|
|
14644
|
+
enableWebApp?: boolean | null;
|
|
14645
|
+
/**
|
|
14646
|
+
* The configuration and appearance of facets in the end user view.
|
|
14647
|
+
*/
|
|
14648
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
|
|
14649
|
+
/**
|
|
14650
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
14651
|
+
*/
|
|
14652
|
+
fieldsUiComponentsMap?: {
|
|
14653
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
|
|
14654
|
+
} | null;
|
|
14655
|
+
/**
|
|
14656
|
+
* Output only. Whether the subscription is gemini bundle or not.
|
|
14657
|
+
*/
|
|
14658
|
+
geminiBundle?: boolean | null;
|
|
14659
|
+
/**
|
|
14660
|
+
* Optional. Describes the homepage settings of the widget.
|
|
14661
|
+
*/
|
|
14662
|
+
homepageSetting?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting;
|
|
14663
|
+
/**
|
|
14664
|
+
* Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
|
|
14665
|
+
*/
|
|
14666
|
+
industryVertical?: string | null;
|
|
14667
|
+
/**
|
|
14668
|
+
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
14669
|
+
*/
|
|
14670
|
+
llmEnabled?: boolean | null;
|
|
14671
|
+
/**
|
|
14672
|
+
* Output only. Whether the customer accepted data use terms.
|
|
14673
|
+
*/
|
|
14674
|
+
minimumDataTermAccepted?: boolean | null;
|
|
14675
|
+
/**
|
|
14676
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
14677
|
+
*/
|
|
14678
|
+
name?: string | null;
|
|
14679
|
+
/**
|
|
14680
|
+
* The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
|
|
14681
|
+
*/
|
|
14682
|
+
resultDisplayType?: string | null;
|
|
14683
|
+
/**
|
|
14684
|
+
* Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
|
|
14685
|
+
*/
|
|
14686
|
+
solutionType?: string | null;
|
|
14687
|
+
/**
|
|
14688
|
+
* Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
|
|
14689
|
+
*/
|
|
14690
|
+
uiBranding?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings;
|
|
14691
|
+
/**
|
|
14692
|
+
* Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
|
|
14693
|
+
*/
|
|
14694
|
+
uiSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings;
|
|
14695
|
+
/**
|
|
14696
|
+
* Output only. Timestamp the WidgetConfig was updated.
|
|
14697
|
+
*/
|
|
14698
|
+
updateTime?: string | null;
|
|
14699
|
+
}
|
|
14700
|
+
/**
|
|
14701
|
+
* Describes widget access settings.
|
|
14702
|
+
*/
|
|
14703
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings {
|
|
14704
|
+
/**
|
|
14705
|
+
* List of domains that are allowed to integrate the search widget.
|
|
14706
|
+
*/
|
|
14707
|
+
allowlistedDomains?: string[] | null;
|
|
14708
|
+
/**
|
|
14709
|
+
* Whether public unauthenticated access is allowed.
|
|
14710
|
+
*/
|
|
14711
|
+
allowPublicAccess?: boolean | null;
|
|
14712
|
+
/**
|
|
14713
|
+
* Whether web app access is enabled.
|
|
14714
|
+
*/
|
|
14715
|
+
enableWebApp?: boolean | null;
|
|
14716
|
+
/**
|
|
14717
|
+
* Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
|
|
14718
|
+
*/
|
|
14719
|
+
languageCode?: string | null;
|
|
14720
|
+
/**
|
|
14721
|
+
* Optional. The workforce identity pool provider used to access the widget.
|
|
14722
|
+
*/
|
|
14723
|
+
workforceIdentityPoolProvider?: string | null;
|
|
14724
|
+
}
|
|
14725
|
+
/**
|
|
14726
|
+
* Describes the assistant settings of the widget.
|
|
14727
|
+
*/
|
|
14728
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings {
|
|
14729
|
+
/**
|
|
14730
|
+
* Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
|
|
14731
|
+
*/
|
|
14732
|
+
defaultWebGroundingToggleOff?: boolean | null;
|
|
14733
|
+
/**
|
|
14734
|
+
* Optional. Output only. Whether to disable user location context.
|
|
14735
|
+
*/
|
|
14736
|
+
disableLocationContext?: boolean | null;
|
|
14737
|
+
/**
|
|
14738
|
+
* Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
|
|
14739
|
+
*/
|
|
14740
|
+
googleSearchGroundingEnabled?: boolean | null;
|
|
14741
|
+
/**
|
|
14742
|
+
* Optional. The type of web grounding to use.
|
|
14743
|
+
*/
|
|
14744
|
+
webGroundingType?: string | null;
|
|
14745
|
+
}
|
|
14746
|
+
/**
|
|
14747
|
+
* Read-only collection component that contains data store collections fields that may be used for filtering
|
|
14748
|
+
*/
|
|
14749
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent {
|
|
14750
|
+
/**
|
|
14751
|
+
* Output only. The icon link of the connector source.
|
|
14752
|
+
*/
|
|
14753
|
+
connectorIconLink?: string | null;
|
|
14754
|
+
/**
|
|
14755
|
+
* The name of the data source, retrieved from `Collection.data_connector.data_source`.
|
|
14756
|
+
*/
|
|
14757
|
+
dataSource?: string | null;
|
|
14758
|
+
/**
|
|
14759
|
+
* Output only. The display name of the data source.
|
|
14760
|
+
*/
|
|
14761
|
+
dataSourceDisplayName?: string | null;
|
|
14762
|
+
/**
|
|
14763
|
+
* For the data store collection, list of the children data stores.
|
|
14764
|
+
*/
|
|
14765
|
+
dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent[];
|
|
14766
|
+
/**
|
|
14767
|
+
* The display name of the collection.
|
|
14768
|
+
*/
|
|
14769
|
+
displayName?: string | null;
|
|
14770
|
+
/**
|
|
14771
|
+
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
|
|
14772
|
+
*/
|
|
14773
|
+
id?: string | null;
|
|
14774
|
+
/**
|
|
14775
|
+
* The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
14776
|
+
*/
|
|
14777
|
+
name?: string | null;
|
|
14778
|
+
}
|
|
14779
|
+
/**
|
|
14780
|
+
* Customer provided configurations.
|
|
14781
|
+
*/
|
|
14782
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig {
|
|
14783
|
+
/**
|
|
14784
|
+
* Customer type.
|
|
14785
|
+
*/
|
|
14786
|
+
customerType?: string | null;
|
|
14787
|
+
}
|
|
14788
|
+
/**
|
|
14789
|
+
* Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
|
|
14790
|
+
*/
|
|
14791
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent {
|
|
14792
|
+
/**
|
|
14793
|
+
* Output only. The type of the data store config.
|
|
14794
|
+
*/
|
|
14795
|
+
dataStoreConfigType?: string | null;
|
|
14796
|
+
/**
|
|
14797
|
+
* The display name of the data store.
|
|
14798
|
+
*/
|
|
14799
|
+
displayName?: string | null;
|
|
14800
|
+
/**
|
|
14801
|
+
* The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
|
|
14802
|
+
*/
|
|
14803
|
+
entityName?: string | null;
|
|
14804
|
+
/**
|
|
14805
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
14806
|
+
*/
|
|
14807
|
+
id?: string | null;
|
|
14808
|
+
/**
|
|
14809
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
14810
|
+
*/
|
|
14811
|
+
name?: string | null;
|
|
14812
|
+
}
|
|
14813
|
+
/**
|
|
14814
|
+
* UI component configuration for data store.
|
|
14815
|
+
*/
|
|
14816
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig {
|
|
14817
|
+
/**
|
|
14818
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
14819
|
+
*/
|
|
14820
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
|
|
14821
|
+
/**
|
|
14822
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
14823
|
+
*/
|
|
14824
|
+
fieldsUiComponentsMap?: {
|
|
14825
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
|
|
14826
|
+
} | null;
|
|
14827
|
+
/**
|
|
14828
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
14829
|
+
*/
|
|
14830
|
+
id?: string | null;
|
|
14831
|
+
/**
|
|
14832
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
14833
|
+
*/
|
|
14834
|
+
name?: string | null;
|
|
14835
|
+
}
|
|
14836
|
+
/**
|
|
14837
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
14838
|
+
*/
|
|
14839
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField {
|
|
14840
|
+
/**
|
|
14841
|
+
* Optional. The field name that end users will see.
|
|
14842
|
+
*/
|
|
14843
|
+
displayName?: string | null;
|
|
14844
|
+
/**
|
|
14845
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
14846
|
+
*/
|
|
14847
|
+
field?: string | null;
|
|
14848
|
+
}
|
|
14849
|
+
/**
|
|
14850
|
+
* Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.
|
|
14851
|
+
*/
|
|
14852
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting {
|
|
14853
|
+
/**
|
|
14854
|
+
* Optional. The shortcuts to display on the homepage.
|
|
14855
|
+
*/
|
|
14856
|
+
shortcuts?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut[];
|
|
14857
|
+
}
|
|
14858
|
+
/**
|
|
14859
|
+
* Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
|
|
14860
|
+
*/
|
|
14861
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut {
|
|
14862
|
+
/**
|
|
14863
|
+
* Optional. Destination URL of shortcut.
|
|
14864
|
+
*/
|
|
14865
|
+
destinationUri?: string | null;
|
|
14866
|
+
/**
|
|
14867
|
+
* Optional. Icon URL of shortcut.
|
|
14868
|
+
*/
|
|
14869
|
+
icon?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
|
|
14870
|
+
/**
|
|
14871
|
+
* Optional. Title of the shortcut.
|
|
14872
|
+
*/
|
|
14873
|
+
title?: string | null;
|
|
14874
|
+
}
|
|
14875
|
+
/**
|
|
14876
|
+
* Options to store an image.
|
|
14877
|
+
*/
|
|
14878
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage {
|
|
14879
|
+
/**
|
|
14880
|
+
* Image URL.
|
|
14881
|
+
*/
|
|
14882
|
+
url?: string | null;
|
|
14883
|
+
}
|
|
14884
|
+
/**
|
|
14885
|
+
* Describes widget UI branding settings.
|
|
14886
|
+
*/
|
|
14887
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings {
|
|
14888
|
+
/**
|
|
14889
|
+
* Logo image.
|
|
14890
|
+
*/
|
|
14891
|
+
logo?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
|
|
14892
|
+
}
|
|
14893
|
+
/**
|
|
14894
|
+
* Facet field that maps to a UI Component.
|
|
14895
|
+
*/
|
|
14896
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField {
|
|
14897
|
+
/**
|
|
14898
|
+
* The field visibility on different types of devices.
|
|
14899
|
+
*/
|
|
14900
|
+
deviceVisibility?: string[] | null;
|
|
14901
|
+
/**
|
|
14902
|
+
* The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
|
|
14903
|
+
*/
|
|
14904
|
+
displayTemplate?: string | null;
|
|
14905
|
+
/**
|
|
14906
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
14907
|
+
*/
|
|
14908
|
+
field?: string | null;
|
|
14909
|
+
}
|
|
14910
|
+
/**
|
|
14911
|
+
* Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.
|
|
14912
|
+
*/
|
|
14913
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings {
|
|
14914
|
+
/**
|
|
14915
|
+
* Per data store configuration.
|
|
14916
|
+
*/
|
|
14917
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
|
|
14918
|
+
/**
|
|
14919
|
+
* The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
|
|
14920
|
+
*/
|
|
14921
|
+
defaultSearchRequestOrderBy?: string | null;
|
|
14922
|
+
/**
|
|
14923
|
+
* If set to true, the widget will not collect user events.
|
|
14924
|
+
*/
|
|
14925
|
+
disableUserEventsCollection?: boolean | null;
|
|
14926
|
+
/**
|
|
14927
|
+
* Whether or not to enable autocomplete.
|
|
14928
|
+
*/
|
|
14929
|
+
enableAutocomplete?: boolean | null;
|
|
14930
|
+
/**
|
|
14931
|
+
* Optional. If set to true, the widget will enable the create agent button.
|
|
14932
|
+
*/
|
|
14933
|
+
enableCreateAgentButton?: boolean | null;
|
|
14934
|
+
/**
|
|
14935
|
+
* Optional. If set to true, the widget will enable people search.
|
|
14936
|
+
*/
|
|
14937
|
+
enablePeopleSearch?: boolean | null;
|
|
14938
|
+
/**
|
|
14939
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
14940
|
+
*/
|
|
14941
|
+
enableQualityFeedback?: boolean | null;
|
|
14942
|
+
/**
|
|
14943
|
+
* Whether to enable safe search.
|
|
14944
|
+
*/
|
|
14945
|
+
enableSafeSearch?: boolean | null;
|
|
14946
|
+
/**
|
|
14947
|
+
* Whether to enable search-as-you-type behavior for the search widget.
|
|
14948
|
+
*/
|
|
14949
|
+
enableSearchAsYouType?: boolean | null;
|
|
14950
|
+
/**
|
|
14951
|
+
* If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
|
|
14952
|
+
*/
|
|
14953
|
+
enableVisualContentSummary?: boolean | null;
|
|
14954
|
+
/**
|
|
14955
|
+
* Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
14956
|
+
*/
|
|
14957
|
+
features?: {
|
|
14958
|
+
[key: string]: string;
|
|
14959
|
+
} | null;
|
|
14960
|
+
/**
|
|
14961
|
+
* Describes generative answer configuration.
|
|
14962
|
+
*/
|
|
14963
|
+
generativeAnswerConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig;
|
|
14964
|
+
/**
|
|
14965
|
+
* Describes widget (or web app) interaction type
|
|
14966
|
+
*/
|
|
14967
|
+
interactionType?: string | null;
|
|
14968
|
+
/**
|
|
14969
|
+
* Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
14970
|
+
*/
|
|
14971
|
+
modelConfigs?: {
|
|
14972
|
+
[key: string]: string;
|
|
14973
|
+
} | null;
|
|
14974
|
+
/**
|
|
14975
|
+
* Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
|
|
14976
|
+
*/
|
|
14977
|
+
resultDescriptionType?: string | null;
|
|
14978
|
+
}
|
|
14979
|
+
/**
|
|
14980
|
+
* Describes configuration for generative answer.
|
|
14981
|
+
*/
|
|
14982
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig {
|
|
14983
|
+
/**
|
|
14984
|
+
* Whether generated answer contains suggested related questions.
|
|
14985
|
+
*/
|
|
14986
|
+
disableRelatedQuestions?: boolean | null;
|
|
14987
|
+
/**
|
|
14988
|
+
* Optional. Specifies whether to filter out queries that are adversarial.
|
|
14989
|
+
*/
|
|
14990
|
+
ignoreAdversarialQuery?: boolean | null;
|
|
14991
|
+
/**
|
|
14992
|
+
* Optional. Specifies whether to filter out queries that are not relevant to the content.
|
|
14993
|
+
*/
|
|
14994
|
+
ignoreLowRelevantContent?: boolean | null;
|
|
14995
|
+
/**
|
|
14996
|
+
* Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
|
|
14997
|
+
*/
|
|
14998
|
+
ignoreNonAnswerSeekingQuery?: boolean | null;
|
|
14999
|
+
/**
|
|
15000
|
+
* Optional. Source of image returned in the answer.
|
|
15001
|
+
*/
|
|
15002
|
+
imageSource?: string | null;
|
|
15003
|
+
/**
|
|
15004
|
+
* Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
15005
|
+
*/
|
|
15006
|
+
languageCode?: string | null;
|
|
15007
|
+
/**
|
|
15008
|
+
* Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
|
|
15009
|
+
*/
|
|
15010
|
+
maxRephraseSteps?: number | null;
|
|
15011
|
+
/**
|
|
15012
|
+
* Text at the beginning of the prompt that instructs the model that generates the answer.
|
|
15013
|
+
*/
|
|
15014
|
+
modelPromptPreamble?: string | null;
|
|
15015
|
+
/**
|
|
15016
|
+
* The model version used to generate the answer.
|
|
15017
|
+
*/
|
|
15018
|
+
modelVersion?: string | null;
|
|
15019
|
+
/**
|
|
15020
|
+
* The number of top results to generate the answer from. Up to 10.
|
|
15021
|
+
*/
|
|
15022
|
+
resultCount?: number | null;
|
|
15023
|
+
}
|
|
14689
15024
|
/**
|
|
14690
15025
|
* Config to store data store type configuration for workspace data
|
|
14691
15026
|
*/
|
|
@@ -14725,7 +15060,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
14725
15060
|
*/
|
|
14726
15061
|
operations?: Schema$GoogleLongrunningOperation[];
|
|
14727
15062
|
/**
|
|
14728
|
-
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections
|
|
15063
|
+
* 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.
|
|
14729
15064
|
*/
|
|
14730
15065
|
unreachable?: string[] | null;
|
|
14731
15066
|
}
|
|
@@ -14941,121 +15276,6 @@ export declare namespace discoveryengine_v1 {
|
|
|
14941
15276
|
*/
|
|
14942
15277
|
version?: string | null;
|
|
14943
15278
|
}
|
|
14944
|
-
export class Resource$Media {
|
|
14945
|
-
context: APIRequestContext;
|
|
14946
|
-
constructor(context: APIRequestContext);
|
|
14947
|
-
/**
|
|
14948
|
-
* Downloads a file from the session.
|
|
14949
|
-
* @example
|
|
14950
|
-
* ```js
|
|
14951
|
-
* // Before running the sample:
|
|
14952
|
-
* // - Enable the API at:
|
|
14953
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
14954
|
-
* // - Login into gcloud by running:
|
|
14955
|
-
* // ```sh
|
|
14956
|
-
* // $ gcloud auth application-default login
|
|
14957
|
-
* // ```
|
|
14958
|
-
* // - Install the npm module by running:
|
|
14959
|
-
* // ```sh
|
|
14960
|
-
* // $ npm install googleapis
|
|
14961
|
-
* // ```
|
|
14962
|
-
*
|
|
14963
|
-
* const {google} = require('googleapis');
|
|
14964
|
-
* const discoveryengine = google.discoveryengine('v1');
|
|
14965
|
-
*
|
|
14966
|
-
* async function main() {
|
|
14967
|
-
* const auth = new google.auth.GoogleAuth({
|
|
14968
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
14969
|
-
* scopes: [
|
|
14970
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
14971
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
14972
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
14973
|
-
* ],
|
|
14974
|
-
* });
|
|
14975
|
-
*
|
|
14976
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
14977
|
-
* const authClient = await auth.getClient();
|
|
14978
|
-
* google.options({auth: authClient});
|
|
14979
|
-
*
|
|
14980
|
-
* // Do the magic
|
|
14981
|
-
* const res = await discoveryengine.media.download({
|
|
14982
|
-
* // Required. The ID of the file to be downloaded.
|
|
14983
|
-
* fileId: 'placeholder-value',
|
|
14984
|
-
* // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
14985
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
14986
|
-
* // Optional. The ID of the view to be downloaded.
|
|
14987
|
-
* viewId: 'placeholder-value',
|
|
14988
|
-
* });
|
|
14989
|
-
* console.log(res.data);
|
|
14990
|
-
*
|
|
14991
|
-
* // Example response
|
|
14992
|
-
* // {
|
|
14993
|
-
* // "algorithm": "my_algorithm",
|
|
14994
|
-
* // "bigstoreObjectRef": "my_bigstoreObjectRef",
|
|
14995
|
-
* // "blobRef": "my_blobRef",
|
|
14996
|
-
* // "blobstore2Info": {},
|
|
14997
|
-
* // "compositeMedia": [],
|
|
14998
|
-
* // "contentType": "my_contentType",
|
|
14999
|
-
* // "contentTypeInfo": {},
|
|
15000
|
-
* // "cosmoBinaryReference": "my_cosmoBinaryReference",
|
|
15001
|
-
* // "crc32cHash": 0,
|
|
15002
|
-
* // "diffChecksumsResponse": {},
|
|
15003
|
-
* // "diffDownloadResponse": {},
|
|
15004
|
-
* // "diffUploadRequest": {},
|
|
15005
|
-
* // "diffUploadResponse": {},
|
|
15006
|
-
* // "diffVersionResponse": {},
|
|
15007
|
-
* // "downloadParameters": {},
|
|
15008
|
-
* // "filename": "my_filename",
|
|
15009
|
-
* // "hash": "my_hash",
|
|
15010
|
-
* // "hashVerified": false,
|
|
15011
|
-
* // "inline": "my_inline",
|
|
15012
|
-
* // "isPotentialRetry": false,
|
|
15013
|
-
* // "length": "my_length",
|
|
15014
|
-
* // "md5Hash": "my_md5Hash",
|
|
15015
|
-
* // "mediaId": "my_mediaId",
|
|
15016
|
-
* // "objectId": {},
|
|
15017
|
-
* // "path": "my_path",
|
|
15018
|
-
* // "referenceType": "my_referenceType",
|
|
15019
|
-
* // "sha1Hash": "my_sha1Hash",
|
|
15020
|
-
* // "sha256Hash": "my_sha256Hash",
|
|
15021
|
-
* // "timestamp": "my_timestamp",
|
|
15022
|
-
* // "token": "my_token"
|
|
15023
|
-
* // }
|
|
15024
|
-
* }
|
|
15025
|
-
*
|
|
15026
|
-
* main().catch(e => {
|
|
15027
|
-
* console.error(e);
|
|
15028
|
-
* throw e;
|
|
15029
|
-
* });
|
|
15030
|
-
*
|
|
15031
|
-
* ```
|
|
15032
|
-
*
|
|
15033
|
-
* @param params - Parameters for request
|
|
15034
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15035
|
-
* @param callback - Optional callback that handles the response.
|
|
15036
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15037
|
-
*/
|
|
15038
|
-
download(params: Params$Resource$Media$Download, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15039
|
-
download(params?: Params$Resource$Media$Download, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GdataMedia>>;
|
|
15040
|
-
download(params: Params$Resource$Media$Download, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15041
|
-
download(params: Params$Resource$Media$Download, options: MethodOptions | BodyResponseCallback<Schema$GdataMedia>, callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
15042
|
-
download(params: Params$Resource$Media$Download, callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
15043
|
-
download(callback: BodyResponseCallback<Schema$GdataMedia>): void;
|
|
15044
|
-
}
|
|
15045
|
-
export interface Params$Resource$Media$Download extends StandardParameters {
|
|
15046
|
-
/**
|
|
15047
|
-
* Required. The ID of the file to be downloaded.
|
|
15048
|
-
*/
|
|
15049
|
-
fileId?: string;
|
|
15050
|
-
/**
|
|
15051
|
-
* Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
15052
|
-
*/
|
|
15053
|
-
name?: string;
|
|
15054
|
-
/**
|
|
15055
|
-
* Optional. The ID of the view to be downloaded.
|
|
15056
|
-
*/
|
|
15057
|
-
viewId?: string;
|
|
15058
|
-
}
|
|
15059
15279
|
export class Resource$Projects {
|
|
15060
15280
|
context: APIRequestContext;
|
|
15061
15281
|
locations: Resource$Projects$Locations;
|
|
@@ -16512,7 +16732,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16512
16732
|
* pageSize: 'placeholder-value',
|
|
16513
16733
|
* // The standard list page token.
|
|
16514
16734
|
* pageToken: 'placeholder-value',
|
|
16515
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16735
|
+
* // 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.
|
|
16516
16736
|
* returnPartialSuccess: 'placeholder-value',
|
|
16517
16737
|
* },
|
|
16518
16738
|
* );
|
|
@@ -16569,7 +16789,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16569
16789
|
*/
|
|
16570
16790
|
pageToken?: string;
|
|
16571
16791
|
/**
|
|
16572
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
16792
|
+
* 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.
|
|
16573
16793
|
*/
|
|
16574
16794
|
returnPartialSuccess?: boolean;
|
|
16575
16795
|
}
|
|
@@ -16589,6 +16809,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16589
16809
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
16590
16810
|
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
16591
16811
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
16812
|
+
widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs;
|
|
16592
16813
|
constructor(context: APIRequestContext);
|
|
16593
16814
|
/**
|
|
16594
16815
|
* Completes the specified user input with keyword suggestions.
|
|
@@ -18316,7 +18537,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18316
18537
|
* pageSize: 'placeholder-value',
|
|
18317
18538
|
* // The standard list page token.
|
|
18318
18539
|
* pageToken: 'placeholder-value',
|
|
18319
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18540
|
+
* // 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.
|
|
18320
18541
|
* returnPartialSuccess: 'placeholder-value',
|
|
18321
18542
|
* },
|
|
18322
18543
|
* );
|
|
@@ -18383,7 +18604,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18383
18604
|
*/
|
|
18384
18605
|
pageToken?: string;
|
|
18385
18606
|
/**
|
|
18386
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
18607
|
+
* 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.
|
|
18387
18608
|
*/
|
|
18388
18609
|
returnPartialSuccess?: boolean;
|
|
18389
18610
|
}
|
|
@@ -19880,7 +20101,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
19880
20101
|
* pageSize: 'placeholder-value',
|
|
19881
20102
|
* // The standard list page token.
|
|
19882
20103
|
* pageToken: 'placeholder-value',
|
|
19883
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20104
|
+
* // 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.
|
|
19884
20105
|
* returnPartialSuccess: 'placeholder-value',
|
|
19885
20106
|
* },
|
|
19886
20107
|
* );
|
|
@@ -19937,7 +20158,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
19937
20158
|
*/
|
|
19938
20159
|
pageToken?: string;
|
|
19939
20160
|
/**
|
|
19940
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20161
|
+
* 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.
|
|
19941
20162
|
*/
|
|
19942
20163
|
returnPartialSuccess?: boolean;
|
|
19943
20164
|
}
|
|
@@ -20058,7 +20279,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20058
20279
|
* pageSize: 'placeholder-value',
|
|
20059
20280
|
* // The standard list page token.
|
|
20060
20281
|
* pageToken: 'placeholder-value',
|
|
20061
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20282
|
+
* // 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.
|
|
20062
20283
|
* returnPartialSuccess: 'placeholder-value',
|
|
20063
20284
|
* },
|
|
20064
20285
|
* );
|
|
@@ -20115,7 +20336,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20115
20336
|
*/
|
|
20116
20337
|
pageToken?: string;
|
|
20117
20338
|
/**
|
|
20118
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20339
|
+
* 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.
|
|
20119
20340
|
*/
|
|
20120
20341
|
returnPartialSuccess?: boolean;
|
|
20121
20342
|
}
|
|
@@ -20670,7 +20891,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20670
20891
|
* pageSize: 'placeholder-value',
|
|
20671
20892
|
* // The standard list page token.
|
|
20672
20893
|
* pageToken: 'placeholder-value',
|
|
20673
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20894
|
+
* // 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.
|
|
20674
20895
|
* returnPartialSuccess: 'placeholder-value',
|
|
20675
20896
|
* },
|
|
20676
20897
|
* );
|
|
@@ -20727,7 +20948,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
20727
20948
|
*/
|
|
20728
20949
|
pageToken?: string;
|
|
20729
20950
|
/**
|
|
20730
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
20951
|
+
* 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.
|
|
20731
20952
|
*/
|
|
20732
20953
|
returnPartialSuccess?: boolean;
|
|
20733
20954
|
}
|
|
@@ -21225,6 +21446,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21225
21446
|
* // "branch": "my_branch",
|
|
21226
21447
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
21227
21448
|
* // "contentSearchSpec": {},
|
|
21449
|
+
* // "crowdingSpecs": [],
|
|
21228
21450
|
* // "dataStoreSpecs": [],
|
|
21229
21451
|
* // "displaySpec": {},
|
|
21230
21452
|
* // "facetSpecs": [],
|
|
@@ -21235,6 +21457,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21235
21457
|
* // "offset": 0,
|
|
21236
21458
|
* // "oneBoxPageSize": 0,
|
|
21237
21459
|
* // "orderBy": "my_orderBy",
|
|
21460
|
+
* // "pageCategories": [],
|
|
21238
21461
|
* // "pageSize": 0,
|
|
21239
21462
|
* // "pageToken": "my_pageToken",
|
|
21240
21463
|
* // "params": {},
|
|
@@ -21268,6 +21491,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21268
21491
|
* // "redirectUri": "my_redirectUri",
|
|
21269
21492
|
* // "results": [],
|
|
21270
21493
|
* // "searchLinkPromotions": [],
|
|
21494
|
+
* // "semanticState": "my_semanticState",
|
|
21271
21495
|
* // "sessionInfo": {},
|
|
21272
21496
|
* // "summary": {},
|
|
21273
21497
|
* // "totalSize": 0
|
|
@@ -21341,6 +21565,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21341
21565
|
* // "branch": "my_branch",
|
|
21342
21566
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
21343
21567
|
* // "contentSearchSpec": {},
|
|
21568
|
+
* // "crowdingSpecs": [],
|
|
21344
21569
|
* // "dataStoreSpecs": [],
|
|
21345
21570
|
* // "displaySpec": {},
|
|
21346
21571
|
* // "facetSpecs": [],
|
|
@@ -21351,6 +21576,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21351
21576
|
* // "offset": 0,
|
|
21352
21577
|
* // "oneBoxPageSize": 0,
|
|
21353
21578
|
* // "orderBy": "my_orderBy",
|
|
21579
|
+
* // "pageCategories": [],
|
|
21354
21580
|
* // "pageSize": 0,
|
|
21355
21581
|
* // "pageToken": "my_pageToken",
|
|
21356
21582
|
* // "params": {},
|
|
@@ -21384,6 +21610,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
21384
21610
|
* // "redirectUri": "my_redirectUri",
|
|
21385
21611
|
* // "results": [],
|
|
21386
21612
|
* // "searchLinkPromotions": [],
|
|
21613
|
+
* // "semanticState": "my_semanticState",
|
|
21387
21614
|
* // "sessionInfo": {},
|
|
21388
21615
|
* // "summary": {},
|
|
21389
21616
|
* // "totalSize": 0
|
|
@@ -22703,7 +22930,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
22703
22930
|
* pageSize: 'placeholder-value',
|
|
22704
22931
|
* // The standard list page token.
|
|
22705
22932
|
* pageToken: 'placeholder-value',
|
|
22706
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
22933
|
+
* // 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.
|
|
22707
22934
|
* returnPartialSuccess: 'placeholder-value',
|
|
22708
22935
|
* },
|
|
22709
22936
|
* );
|
|
@@ -22760,7 +22987,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
22760
22987
|
*/
|
|
22761
22988
|
pageToken?: string;
|
|
22762
22989
|
/**
|
|
22763
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
22990
|
+
* 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.
|
|
22764
22991
|
*/
|
|
22765
22992
|
returnPartialSuccess?: boolean;
|
|
22766
22993
|
}
|
|
@@ -23664,7 +23891,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
23664
23891
|
* pageSize: 'placeholder-value',
|
|
23665
23892
|
* // The standard list page token.
|
|
23666
23893
|
* pageToken: 'placeholder-value',
|
|
23667
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
23894
|
+
* // 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.
|
|
23668
23895
|
* returnPartialSuccess: 'placeholder-value',
|
|
23669
23896
|
* },
|
|
23670
23897
|
* );
|
|
@@ -23721,7 +23948,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
23721
23948
|
*/
|
|
23722
23949
|
pageToken?: string;
|
|
23723
23950
|
/**
|
|
23724
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
23951
|
+
* 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.
|
|
23725
23952
|
*/
|
|
23726
23953
|
returnPartialSuccess?: boolean;
|
|
23727
23954
|
}
|
|
@@ -24324,6 +24551,292 @@ export declare namespace discoveryengine_v1 {
|
|
|
24324
24551
|
*/
|
|
24325
24552
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
|
|
24326
24553
|
}
|
|
24554
|
+
export class Resource$Projects$Locations$Collections$Datastores$Widgetconfigs {
|
|
24555
|
+
context: APIRequestContext;
|
|
24556
|
+
constructor(context: APIRequestContext);
|
|
24557
|
+
/**
|
|
24558
|
+
* Gets a WidgetConfig.
|
|
24559
|
+
* @example
|
|
24560
|
+
* ```js
|
|
24561
|
+
* // Before running the sample:
|
|
24562
|
+
* // - Enable the API at:
|
|
24563
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24564
|
+
* // - Login into gcloud by running:
|
|
24565
|
+
* // ```sh
|
|
24566
|
+
* // $ gcloud auth application-default login
|
|
24567
|
+
* // ```
|
|
24568
|
+
* // - Install the npm module by running:
|
|
24569
|
+
* // ```sh
|
|
24570
|
+
* // $ npm install googleapis
|
|
24571
|
+
* // ```
|
|
24572
|
+
*
|
|
24573
|
+
* const {google} = require('googleapis');
|
|
24574
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
24575
|
+
*
|
|
24576
|
+
* async function main() {
|
|
24577
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24578
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24579
|
+
* scopes: [
|
|
24580
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
24581
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
24582
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
24583
|
+
* ],
|
|
24584
|
+
* });
|
|
24585
|
+
*
|
|
24586
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
24587
|
+
* const authClient = await auth.getClient();
|
|
24588
|
+
* google.options({auth: authClient});
|
|
24589
|
+
*
|
|
24590
|
+
* // Do the magic
|
|
24591
|
+
* const res =
|
|
24592
|
+
* await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get(
|
|
24593
|
+
* {
|
|
24594
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
24595
|
+
* acceptCache: 'placeholder-value',
|
|
24596
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
24597
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
24598
|
+
* 'placeholder-value',
|
|
24599
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
24600
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
24601
|
+
* },
|
|
24602
|
+
* );
|
|
24603
|
+
* console.log(res.data);
|
|
24604
|
+
*
|
|
24605
|
+
* // Example response
|
|
24606
|
+
* // {
|
|
24607
|
+
* // "accessSettings": {},
|
|
24608
|
+
* // "allowPublicAccess": false,
|
|
24609
|
+
* // "allowlistedDomains": [],
|
|
24610
|
+
* // "assistantSettings": {},
|
|
24611
|
+
* // "collectionComponents": [],
|
|
24612
|
+
* // "configId": "my_configId",
|
|
24613
|
+
* // "contentSearchSpec": {},
|
|
24614
|
+
* // "createTime": "my_createTime",
|
|
24615
|
+
* // "customerProvidedConfig": {},
|
|
24616
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
24617
|
+
* // "dataStoreUiConfigs": [],
|
|
24618
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
24619
|
+
* // "displayName": "my_displayName",
|
|
24620
|
+
* // "enableAutocomplete": false,
|
|
24621
|
+
* // "enableConversationalSearch": false,
|
|
24622
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
24623
|
+
* // "enableQualityFeedback": false,
|
|
24624
|
+
* // "enableResultScore": false,
|
|
24625
|
+
* // "enableSafeSearch": false,
|
|
24626
|
+
* // "enableSearchAsYouType": false,
|
|
24627
|
+
* // "enableSnippetResultSummary": false,
|
|
24628
|
+
* // "enableSummarization": false,
|
|
24629
|
+
* // "enableWebApp": false,
|
|
24630
|
+
* // "facetField": [],
|
|
24631
|
+
* // "fieldsUiComponentsMap": {},
|
|
24632
|
+
* // "geminiBundle": false,
|
|
24633
|
+
* // "homepageSetting": {},
|
|
24634
|
+
* // "industryVertical": "my_industryVertical",
|
|
24635
|
+
* // "llmEnabled": false,
|
|
24636
|
+
* // "minimumDataTermAccepted": false,
|
|
24637
|
+
* // "name": "my_name",
|
|
24638
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
24639
|
+
* // "solutionType": "my_solutionType",
|
|
24640
|
+
* // "uiBranding": {},
|
|
24641
|
+
* // "uiSettings": {},
|
|
24642
|
+
* // "updateTime": "my_updateTime"
|
|
24643
|
+
* // }
|
|
24644
|
+
* }
|
|
24645
|
+
*
|
|
24646
|
+
* main().catch(e => {
|
|
24647
|
+
* console.error(e);
|
|
24648
|
+
* throw e;
|
|
24649
|
+
* });
|
|
24650
|
+
*
|
|
24651
|
+
* ```
|
|
24652
|
+
*
|
|
24653
|
+
* @param params - Parameters for request
|
|
24654
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24655
|
+
* @param callback - Optional callback that handles the response.
|
|
24656
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24657
|
+
*/
|
|
24658
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24659
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
24660
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24661
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24662
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24663
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24664
|
+
/**
|
|
24665
|
+
* Update a WidgetConfig.
|
|
24666
|
+
* @example
|
|
24667
|
+
* ```js
|
|
24668
|
+
* // Before running the sample:
|
|
24669
|
+
* // - Enable the API at:
|
|
24670
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24671
|
+
* // - Login into gcloud by running:
|
|
24672
|
+
* // ```sh
|
|
24673
|
+
* // $ gcloud auth application-default login
|
|
24674
|
+
* // ```
|
|
24675
|
+
* // - Install the npm module by running:
|
|
24676
|
+
* // ```sh
|
|
24677
|
+
* // $ npm install googleapis
|
|
24678
|
+
* // ```
|
|
24679
|
+
*
|
|
24680
|
+
* const {google} = require('googleapis');
|
|
24681
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
24682
|
+
*
|
|
24683
|
+
* async function main() {
|
|
24684
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24685
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24686
|
+
* scopes: [
|
|
24687
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
24688
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
24689
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
24690
|
+
* ],
|
|
24691
|
+
* });
|
|
24692
|
+
*
|
|
24693
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
24694
|
+
* const authClient = await auth.getClient();
|
|
24695
|
+
* google.options({auth: authClient});
|
|
24696
|
+
*
|
|
24697
|
+
* // Do the magic
|
|
24698
|
+
* const res =
|
|
24699
|
+
* await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch(
|
|
24700
|
+
* {
|
|
24701
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
24702
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
24703
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
24704
|
+
* updateMask: 'placeholder-value',
|
|
24705
|
+
*
|
|
24706
|
+
* // Request body metadata
|
|
24707
|
+
* requestBody: {
|
|
24708
|
+
* // request body parameters
|
|
24709
|
+
* // {
|
|
24710
|
+
* // "accessSettings": {},
|
|
24711
|
+
* // "allowPublicAccess": false,
|
|
24712
|
+
* // "allowlistedDomains": [],
|
|
24713
|
+
* // "assistantSettings": {},
|
|
24714
|
+
* // "collectionComponents": [],
|
|
24715
|
+
* // "configId": "my_configId",
|
|
24716
|
+
* // "contentSearchSpec": {},
|
|
24717
|
+
* // "createTime": "my_createTime",
|
|
24718
|
+
* // "customerProvidedConfig": {},
|
|
24719
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
24720
|
+
* // "dataStoreUiConfigs": [],
|
|
24721
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
24722
|
+
* // "displayName": "my_displayName",
|
|
24723
|
+
* // "enableAutocomplete": false,
|
|
24724
|
+
* // "enableConversationalSearch": false,
|
|
24725
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
24726
|
+
* // "enableQualityFeedback": false,
|
|
24727
|
+
* // "enableResultScore": false,
|
|
24728
|
+
* // "enableSafeSearch": false,
|
|
24729
|
+
* // "enableSearchAsYouType": false,
|
|
24730
|
+
* // "enableSnippetResultSummary": false,
|
|
24731
|
+
* // "enableSummarization": false,
|
|
24732
|
+
* // "enableWebApp": false,
|
|
24733
|
+
* // "facetField": [],
|
|
24734
|
+
* // "fieldsUiComponentsMap": {},
|
|
24735
|
+
* // "geminiBundle": false,
|
|
24736
|
+
* // "homepageSetting": {},
|
|
24737
|
+
* // "industryVertical": "my_industryVertical",
|
|
24738
|
+
* // "llmEnabled": false,
|
|
24739
|
+
* // "minimumDataTermAccepted": false,
|
|
24740
|
+
* // "name": "my_name",
|
|
24741
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
24742
|
+
* // "solutionType": "my_solutionType",
|
|
24743
|
+
* // "uiBranding": {},
|
|
24744
|
+
* // "uiSettings": {},
|
|
24745
|
+
* // "updateTime": "my_updateTime"
|
|
24746
|
+
* // }
|
|
24747
|
+
* },
|
|
24748
|
+
* },
|
|
24749
|
+
* );
|
|
24750
|
+
* console.log(res.data);
|
|
24751
|
+
*
|
|
24752
|
+
* // Example response
|
|
24753
|
+
* // {
|
|
24754
|
+
* // "accessSettings": {},
|
|
24755
|
+
* // "allowPublicAccess": false,
|
|
24756
|
+
* // "allowlistedDomains": [],
|
|
24757
|
+
* // "assistantSettings": {},
|
|
24758
|
+
* // "collectionComponents": [],
|
|
24759
|
+
* // "configId": "my_configId",
|
|
24760
|
+
* // "contentSearchSpec": {},
|
|
24761
|
+
* // "createTime": "my_createTime",
|
|
24762
|
+
* // "customerProvidedConfig": {},
|
|
24763
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
24764
|
+
* // "dataStoreUiConfigs": [],
|
|
24765
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
24766
|
+
* // "displayName": "my_displayName",
|
|
24767
|
+
* // "enableAutocomplete": false,
|
|
24768
|
+
* // "enableConversationalSearch": false,
|
|
24769
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
24770
|
+
* // "enableQualityFeedback": false,
|
|
24771
|
+
* // "enableResultScore": false,
|
|
24772
|
+
* // "enableSafeSearch": false,
|
|
24773
|
+
* // "enableSearchAsYouType": false,
|
|
24774
|
+
* // "enableSnippetResultSummary": false,
|
|
24775
|
+
* // "enableSummarization": false,
|
|
24776
|
+
* // "enableWebApp": false,
|
|
24777
|
+
* // "facetField": [],
|
|
24778
|
+
* // "fieldsUiComponentsMap": {},
|
|
24779
|
+
* // "geminiBundle": false,
|
|
24780
|
+
* // "homepageSetting": {},
|
|
24781
|
+
* // "industryVertical": "my_industryVertical",
|
|
24782
|
+
* // "llmEnabled": false,
|
|
24783
|
+
* // "minimumDataTermAccepted": false,
|
|
24784
|
+
* // "name": "my_name",
|
|
24785
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
24786
|
+
* // "solutionType": "my_solutionType",
|
|
24787
|
+
* // "uiBranding": {},
|
|
24788
|
+
* // "uiSettings": {},
|
|
24789
|
+
* // "updateTime": "my_updateTime"
|
|
24790
|
+
* // }
|
|
24791
|
+
* }
|
|
24792
|
+
*
|
|
24793
|
+
* main().catch(e => {
|
|
24794
|
+
* console.error(e);
|
|
24795
|
+
* throw e;
|
|
24796
|
+
* });
|
|
24797
|
+
*
|
|
24798
|
+
* ```
|
|
24799
|
+
*
|
|
24800
|
+
* @param params - Parameters for request
|
|
24801
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24802
|
+
* @param callback - Optional callback that handles the response.
|
|
24803
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24804
|
+
*/
|
|
24805
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24806
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
24807
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24808
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24809
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24810
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24811
|
+
}
|
|
24812
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
24813
|
+
/**
|
|
24814
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
24815
|
+
*/
|
|
24816
|
+
acceptCache?: boolean;
|
|
24817
|
+
/**
|
|
24818
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
24819
|
+
*/
|
|
24820
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
24821
|
+
/**
|
|
24822
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
24823
|
+
*/
|
|
24824
|
+
name?: string;
|
|
24825
|
+
}
|
|
24826
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
24827
|
+
/**
|
|
24828
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
24829
|
+
*/
|
|
24830
|
+
name?: string;
|
|
24831
|
+
/**
|
|
24832
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
24833
|
+
*/
|
|
24834
|
+
updateMask?: string;
|
|
24835
|
+
/**
|
|
24836
|
+
* Request body metadata
|
|
24837
|
+
*/
|
|
24838
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
24839
|
+
}
|
|
24327
24840
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
24328
24841
|
context: APIRequestContext;
|
|
24329
24842
|
assistants: Resource$Projects$Locations$Collections$Engines$Assistants;
|
|
@@ -24333,6 +24846,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24333
24846
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
24334
24847
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
24335
24848
|
sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
|
|
24849
|
+
widgetConfigs: Resource$Projects$Locations$Collections$Engines$Widgetconfigs;
|
|
24336
24850
|
constructor(context: APIRequestContext);
|
|
24337
24851
|
/**
|
|
24338
24852
|
* Creates a Engine.
|
|
@@ -24382,6 +24896,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24382
24896
|
* // "appType": "my_appType",
|
|
24383
24897
|
* // "chatEngineConfig": {},
|
|
24384
24898
|
* // "chatEngineMetadata": {},
|
|
24899
|
+
* // "cmekConfig": {},
|
|
24385
24900
|
* // "commonConfig": {},
|
|
24386
24901
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24387
24902
|
* // "createTime": "my_createTime",
|
|
@@ -24391,6 +24906,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24391
24906
|
* // "features": {},
|
|
24392
24907
|
* // "industryVertical": "my_industryVertical",
|
|
24393
24908
|
* // "mediaRecommendationEngineConfig": {},
|
|
24909
|
+
* // "modelConfigs": {},
|
|
24394
24910
|
* // "name": "my_name",
|
|
24395
24911
|
* // "searchEngineConfig": {},
|
|
24396
24912
|
* // "solutionType": "my_solutionType",
|
|
@@ -24540,6 +25056,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24540
25056
|
* // "appType": "my_appType",
|
|
24541
25057
|
* // "chatEngineConfig": {},
|
|
24542
25058
|
* // "chatEngineMetadata": {},
|
|
25059
|
+
* // "cmekConfig": {},
|
|
24543
25060
|
* // "commonConfig": {},
|
|
24544
25061
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24545
25062
|
* // "createTime": "my_createTime",
|
|
@@ -24549,6 +25066,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24549
25066
|
* // "features": {},
|
|
24550
25067
|
* // "industryVertical": "my_industryVertical",
|
|
24551
25068
|
* // "mediaRecommendationEngineConfig": {},
|
|
25069
|
+
* // "modelConfigs": {},
|
|
24552
25070
|
* // "name": "my_name",
|
|
24553
25071
|
* // "searchEngineConfig": {},
|
|
24554
25072
|
* // "solutionType": "my_solutionType",
|
|
@@ -24694,6 +25212,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24694
25212
|
* // "appType": "my_appType",
|
|
24695
25213
|
* // "chatEngineConfig": {},
|
|
24696
25214
|
* // "chatEngineMetadata": {},
|
|
25215
|
+
* // "cmekConfig": {},
|
|
24697
25216
|
* // "commonConfig": {},
|
|
24698
25217
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24699
25218
|
* // "createTime": "my_createTime",
|
|
@@ -24703,6 +25222,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24703
25222
|
* // "features": {},
|
|
24704
25223
|
* // "industryVertical": "my_industryVertical",
|
|
24705
25224
|
* // "mediaRecommendationEngineConfig": {},
|
|
25225
|
+
* // "modelConfigs": {},
|
|
24706
25226
|
* // "name": "my_name",
|
|
24707
25227
|
* // "searchEngineConfig": {},
|
|
24708
25228
|
* // "solutionType": "my_solutionType",
|
|
@@ -24717,6 +25237,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24717
25237
|
* // "appType": "my_appType",
|
|
24718
25238
|
* // "chatEngineConfig": {},
|
|
24719
25239
|
* // "chatEngineMetadata": {},
|
|
25240
|
+
* // "cmekConfig": {},
|
|
24720
25241
|
* // "commonConfig": {},
|
|
24721
25242
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24722
25243
|
* // "createTime": "my_createTime",
|
|
@@ -24726,6 +25247,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24726
25247
|
* // "features": {},
|
|
24727
25248
|
* // "industryVertical": "my_industryVertical",
|
|
24728
25249
|
* // "mediaRecommendationEngineConfig": {},
|
|
25250
|
+
* // "modelConfigs": {},
|
|
24729
25251
|
* // "name": "my_name",
|
|
24730
25252
|
* // "searchEngineConfig": {},
|
|
24731
25253
|
* // "solutionType": "my_solutionType",
|
|
@@ -24812,7 +25334,163 @@ export declare namespace discoveryengine_v1 {
|
|
|
24812
25334
|
}
|
|
24813
25335
|
export class Resource$Projects$Locations$Collections$Engines$Assistants {
|
|
24814
25336
|
context: APIRequestContext;
|
|
25337
|
+
agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
|
|
24815
25338
|
constructor(context: APIRequestContext);
|
|
25339
|
+
/**
|
|
25340
|
+
* Creates an Assistant.
|
|
25341
|
+
* @example
|
|
25342
|
+
* ```js
|
|
25343
|
+
* // Before running the sample:
|
|
25344
|
+
* // - Enable the API at:
|
|
25345
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25346
|
+
* // - Login into gcloud by running:
|
|
25347
|
+
* // ```sh
|
|
25348
|
+
* // $ gcloud auth application-default login
|
|
25349
|
+
* // ```
|
|
25350
|
+
* // - Install the npm module by running:
|
|
25351
|
+
* // ```sh
|
|
25352
|
+
* // $ npm install googleapis
|
|
25353
|
+
* // ```
|
|
25354
|
+
*
|
|
25355
|
+
* const {google} = require('googleapis');
|
|
25356
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25357
|
+
*
|
|
25358
|
+
* async function main() {
|
|
25359
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25360
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25361
|
+
* scopes: [
|
|
25362
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25363
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25364
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25365
|
+
* ],
|
|
25366
|
+
* });
|
|
25367
|
+
*
|
|
25368
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25369
|
+
* const authClient = await auth.getClient();
|
|
25370
|
+
* google.options({auth: authClient});
|
|
25371
|
+
*
|
|
25372
|
+
* // Do the magic
|
|
25373
|
+
* const res =
|
|
25374
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.create(
|
|
25375
|
+
* {
|
|
25376
|
+
* // 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.
|
|
25377
|
+
* assistantId: 'placeholder-value',
|
|
25378
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25379
|
+
* parent:
|
|
25380
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
25381
|
+
*
|
|
25382
|
+
* // Request body metadata
|
|
25383
|
+
* requestBody: {
|
|
25384
|
+
* // request body parameters
|
|
25385
|
+
* // {
|
|
25386
|
+
* // "customerPolicy": {},
|
|
25387
|
+
* // "description": "my_description",
|
|
25388
|
+
* // "displayName": "my_displayName",
|
|
25389
|
+
* // "enabledTools": {},
|
|
25390
|
+
* // "generationConfig": {},
|
|
25391
|
+
* // "name": "my_name",
|
|
25392
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25393
|
+
* // }
|
|
25394
|
+
* },
|
|
25395
|
+
* },
|
|
25396
|
+
* );
|
|
25397
|
+
* console.log(res.data);
|
|
25398
|
+
*
|
|
25399
|
+
* // Example response
|
|
25400
|
+
* // {
|
|
25401
|
+
* // "customerPolicy": {},
|
|
25402
|
+
* // "description": "my_description",
|
|
25403
|
+
* // "displayName": "my_displayName",
|
|
25404
|
+
* // "enabledTools": {},
|
|
25405
|
+
* // "generationConfig": {},
|
|
25406
|
+
* // "name": "my_name",
|
|
25407
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25408
|
+
* // }
|
|
25409
|
+
* }
|
|
25410
|
+
*
|
|
25411
|
+
* main().catch(e => {
|
|
25412
|
+
* console.error(e);
|
|
25413
|
+
* throw e;
|
|
25414
|
+
* });
|
|
25415
|
+
*
|
|
25416
|
+
* ```
|
|
25417
|
+
*
|
|
25418
|
+
* @param params - Parameters for request
|
|
25419
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25420
|
+
* @param callback - Optional callback that handles the response.
|
|
25421
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25422
|
+
*/
|
|
25423
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25424
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Assistant>>;
|
|
25425
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25426
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25427
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25428
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25429
|
+
/**
|
|
25430
|
+
* Deletes an Assistant.
|
|
25431
|
+
* @example
|
|
25432
|
+
* ```js
|
|
25433
|
+
* // Before running the sample:
|
|
25434
|
+
* // - Enable the API at:
|
|
25435
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25436
|
+
* // - Login into gcloud by running:
|
|
25437
|
+
* // ```sh
|
|
25438
|
+
* // $ gcloud auth application-default login
|
|
25439
|
+
* // ```
|
|
25440
|
+
* // - Install the npm module by running:
|
|
25441
|
+
* // ```sh
|
|
25442
|
+
* // $ npm install googleapis
|
|
25443
|
+
* // ```
|
|
25444
|
+
*
|
|
25445
|
+
* const {google} = require('googleapis');
|
|
25446
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25447
|
+
*
|
|
25448
|
+
* async function main() {
|
|
25449
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25450
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25451
|
+
* scopes: [
|
|
25452
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25453
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25454
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25455
|
+
* ],
|
|
25456
|
+
* });
|
|
25457
|
+
*
|
|
25458
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25459
|
+
* const authClient = await auth.getClient();
|
|
25460
|
+
* google.options({auth: authClient});
|
|
25461
|
+
*
|
|
25462
|
+
* // Do the magic
|
|
25463
|
+
* const res =
|
|
25464
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.delete(
|
|
25465
|
+
* {
|
|
25466
|
+
* // 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.
|
|
25467
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25468
|
+
* },
|
|
25469
|
+
* );
|
|
25470
|
+
* console.log(res.data);
|
|
25471
|
+
*
|
|
25472
|
+
* // Example response
|
|
25473
|
+
* // {}
|
|
25474
|
+
* }
|
|
25475
|
+
*
|
|
25476
|
+
* main().catch(e => {
|
|
25477
|
+
* console.error(e);
|
|
25478
|
+
* throw e;
|
|
25479
|
+
* });
|
|
25480
|
+
*
|
|
25481
|
+
* ```
|
|
25482
|
+
*
|
|
25483
|
+
* @param params - Parameters for request
|
|
25484
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25485
|
+
* @param callback - Optional callback that handles the response.
|
|
25486
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25487
|
+
*/
|
|
25488
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25489
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
25490
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25491
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25492
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25493
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
24816
25494
|
/**
|
|
24817
25495
|
* Gets an Assistant.
|
|
24818
25496
|
* @example
|
|
@@ -24848,21 +25526,96 @@ export declare namespace discoveryengine_v1 {
|
|
|
24848
25526
|
*
|
|
24849
25527
|
* // Do the magic
|
|
24850
25528
|
* const res =
|
|
24851
|
-
* await discoveryengine.projects.locations.collections.engines.assistants.get(
|
|
25529
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.get(
|
|
25530
|
+
* {
|
|
25531
|
+
* // Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25532
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
|
|
25533
|
+
* },
|
|
25534
|
+
* );
|
|
25535
|
+
* console.log(res.data);
|
|
25536
|
+
*
|
|
25537
|
+
* // Example response
|
|
25538
|
+
* // {
|
|
25539
|
+
* // "customerPolicy": {},
|
|
25540
|
+
* // "description": "my_description",
|
|
25541
|
+
* // "displayName": "my_displayName",
|
|
25542
|
+
* // "enabledTools": {},
|
|
25543
|
+
* // "generationConfig": {},
|
|
25544
|
+
* // "name": "my_name",
|
|
25545
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
25546
|
+
* // }
|
|
25547
|
+
* }
|
|
25548
|
+
*
|
|
25549
|
+
* main().catch(e => {
|
|
25550
|
+
* console.error(e);
|
|
25551
|
+
* throw e;
|
|
25552
|
+
* });
|
|
25553
|
+
*
|
|
25554
|
+
* ```
|
|
25555
|
+
*
|
|
25556
|
+
* @param params - Parameters for request
|
|
25557
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25558
|
+
* @param callback - Optional callback that handles the response.
|
|
25559
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25560
|
+
*/
|
|
25561
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25562
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Assistant>>;
|
|
25563
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25564
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25565
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25566
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
|
|
25567
|
+
/**
|
|
25568
|
+
* Lists all Assistants under an Engine.
|
|
25569
|
+
* @example
|
|
25570
|
+
* ```js
|
|
25571
|
+
* // Before running the sample:
|
|
25572
|
+
* // - Enable the API at:
|
|
25573
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25574
|
+
* // - Login into gcloud by running:
|
|
25575
|
+
* // ```sh
|
|
25576
|
+
* // $ gcloud auth application-default login
|
|
25577
|
+
* // ```
|
|
25578
|
+
* // - Install the npm module by running:
|
|
25579
|
+
* // ```sh
|
|
25580
|
+
* // $ npm install googleapis
|
|
25581
|
+
* // ```
|
|
25582
|
+
*
|
|
25583
|
+
* const {google} = require('googleapis');
|
|
25584
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25585
|
+
*
|
|
25586
|
+
* async function main() {
|
|
25587
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25588
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25589
|
+
* scopes: [
|
|
25590
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25591
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
25592
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25593
|
+
* ],
|
|
25594
|
+
* });
|
|
25595
|
+
*
|
|
25596
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25597
|
+
* const authClient = await auth.getClient();
|
|
25598
|
+
* google.options({auth: authClient});
|
|
25599
|
+
*
|
|
25600
|
+
* // Do the magic
|
|
25601
|
+
* const res =
|
|
25602
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.list(
|
|
24852
25603
|
* {
|
|
24853
|
-
* //
|
|
24854
|
-
*
|
|
25604
|
+
* // 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.
|
|
25605
|
+
* pageSize: 'placeholder-value',
|
|
25606
|
+
* // 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.
|
|
25607
|
+
* pageToken: 'placeholder-value',
|
|
25608
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25609
|
+
* parent:
|
|
25610
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
24855
25611
|
* },
|
|
24856
25612
|
* );
|
|
24857
25613
|
* console.log(res.data);
|
|
24858
25614
|
*
|
|
24859
25615
|
* // Example response
|
|
24860
25616
|
* // {
|
|
24861
|
-
* // "
|
|
24862
|
-
* // "
|
|
24863
|
-
* // "generationConfig": {},
|
|
24864
|
-
* // "name": "my_name",
|
|
24865
|
-
* // "webGroundingType": "my_webGroundingType"
|
|
25617
|
+
* // "assistants": [],
|
|
25618
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
24866
25619
|
* // }
|
|
24867
25620
|
* }
|
|
24868
25621
|
*
|
|
@@ -24878,12 +25631,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
24878
25631
|
* @param callback - Optional callback that handles the response.
|
|
24879
25632
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24880
25633
|
*/
|
|
24881
|
-
|
|
24882
|
-
|
|
24883
|
-
|
|
24884
|
-
|
|
24885
|
-
|
|
24886
|
-
|
|
25634
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25635
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>>;
|
|
25636
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25637
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>): void;
|
|
25638
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>): void;
|
|
25639
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListAssistantsResponse>): void;
|
|
24887
25640
|
/**
|
|
24888
25641
|
* Updates an Assistant
|
|
24889
25642
|
* @example
|
|
@@ -24931,6 +25684,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
24931
25684
|
* // request body parameters
|
|
24932
25685
|
* // {
|
|
24933
25686
|
* // "customerPolicy": {},
|
|
25687
|
+
* // "description": "my_description",
|
|
25688
|
+
* // "displayName": "my_displayName",
|
|
24934
25689
|
* // "enabledTools": {},
|
|
24935
25690
|
* // "generationConfig": {},
|
|
24936
25691
|
* // "name": "my_name",
|
|
@@ -24944,6 +25699,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
24944
25699
|
* // Example response
|
|
24945
25700
|
* // {
|
|
24946
25701
|
* // "customerPolicy": {},
|
|
25702
|
+
* // "description": "my_description",
|
|
25703
|
+
* // "displayName": "my_displayName",
|
|
24947
25704
|
* // "enabledTools": {},
|
|
24948
25705
|
* // "generationConfig": {},
|
|
24949
25706
|
* // "name": "my_name",
|
|
@@ -25028,6 +25785,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25028
25785
|
* // {
|
|
25029
25786
|
* // "answer": {},
|
|
25030
25787
|
* // "assistToken": "my_assistToken",
|
|
25788
|
+
* // "invocationTools": [],
|
|
25031
25789
|
* // "sessionInfo": {}
|
|
25032
25790
|
* // }
|
|
25033
25791
|
* }
|
|
@@ -25051,12 +25809,46 @@ export declare namespace discoveryengine_v1 {
|
|
|
25051
25809
|
streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>): void;
|
|
25052
25810
|
streamAssist(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>): void;
|
|
25053
25811
|
}
|
|
25812
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create extends StandardParameters {
|
|
25813
|
+
/**
|
|
25814
|
+
* 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.
|
|
25815
|
+
*/
|
|
25816
|
+
assistantId?: string;
|
|
25817
|
+
/**
|
|
25818
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25819
|
+
*/
|
|
25820
|
+
parent?: string;
|
|
25821
|
+
/**
|
|
25822
|
+
* Request body metadata
|
|
25823
|
+
*/
|
|
25824
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1Assistant;
|
|
25825
|
+
}
|
|
25826
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete extends StandardParameters {
|
|
25827
|
+
/**
|
|
25828
|
+
* 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.
|
|
25829
|
+
*/
|
|
25830
|
+
name?: string;
|
|
25831
|
+
}
|
|
25054
25832
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
|
|
25055
25833
|
/**
|
|
25056
25834
|
* Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
|
|
25057
25835
|
*/
|
|
25058
25836
|
name?: string;
|
|
25059
25837
|
}
|
|
25838
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$List extends StandardParameters {
|
|
25839
|
+
/**
|
|
25840
|
+
* 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.
|
|
25841
|
+
*/
|
|
25842
|
+
pageSize?: number;
|
|
25843
|
+
/**
|
|
25844
|
+
* 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.
|
|
25845
|
+
*/
|
|
25846
|
+
pageToken?: string;
|
|
25847
|
+
/**
|
|
25848
|
+
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25849
|
+
*/
|
|
25850
|
+
parent?: string;
|
|
25851
|
+
}
|
|
25060
25852
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
|
|
25061
25853
|
/**
|
|
25062
25854
|
* 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.
|
|
@@ -25081,6 +25873,91 @@ export declare namespace discoveryengine_v1 {
|
|
|
25081
25873
|
*/
|
|
25082
25874
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1StreamAssistRequest;
|
|
25083
25875
|
}
|
|
25876
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents {
|
|
25877
|
+
context: APIRequestContext;
|
|
25878
|
+
operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations;
|
|
25879
|
+
constructor(context: APIRequestContext);
|
|
25880
|
+
}
|
|
25881
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations {
|
|
25882
|
+
context: APIRequestContext;
|
|
25883
|
+
constructor(context: APIRequestContext);
|
|
25884
|
+
/**
|
|
25885
|
+
* 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.
|
|
25886
|
+
* @example
|
|
25887
|
+
* ```js
|
|
25888
|
+
* // Before running the sample:
|
|
25889
|
+
* // - Enable the API at:
|
|
25890
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25891
|
+
* // - Login into gcloud by running:
|
|
25892
|
+
* // ```sh
|
|
25893
|
+
* // $ gcloud auth application-default login
|
|
25894
|
+
* // ```
|
|
25895
|
+
* // - Install the npm module by running:
|
|
25896
|
+
* // ```sh
|
|
25897
|
+
* // $ npm install googleapis
|
|
25898
|
+
* // ```
|
|
25899
|
+
*
|
|
25900
|
+
* const {google} = require('googleapis');
|
|
25901
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
25902
|
+
*
|
|
25903
|
+
* async function main() {
|
|
25904
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25905
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25906
|
+
* scopes: [
|
|
25907
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25908
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25909
|
+
* ],
|
|
25910
|
+
* });
|
|
25911
|
+
*
|
|
25912
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25913
|
+
* const authClient = await auth.getClient();
|
|
25914
|
+
* google.options({auth: authClient});
|
|
25915
|
+
*
|
|
25916
|
+
* // Do the magic
|
|
25917
|
+
* const res =
|
|
25918
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get(
|
|
25919
|
+
* {
|
|
25920
|
+
* // The name of the operation resource.
|
|
25921
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent/operations/my-operation',
|
|
25922
|
+
* },
|
|
25923
|
+
* );
|
|
25924
|
+
* console.log(res.data);
|
|
25925
|
+
*
|
|
25926
|
+
* // Example response
|
|
25927
|
+
* // {
|
|
25928
|
+
* // "done": false,
|
|
25929
|
+
* // "error": {},
|
|
25930
|
+
* // "metadata": {},
|
|
25931
|
+
* // "name": "my_name",
|
|
25932
|
+
* // "response": {}
|
|
25933
|
+
* // }
|
|
25934
|
+
* }
|
|
25935
|
+
*
|
|
25936
|
+
* main().catch(e => {
|
|
25937
|
+
* console.error(e);
|
|
25938
|
+
* throw e;
|
|
25939
|
+
* });
|
|
25940
|
+
*
|
|
25941
|
+
* ```
|
|
25942
|
+
*
|
|
25943
|
+
* @param params - Parameters for request
|
|
25944
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25945
|
+
* @param callback - Optional callback that handles the response.
|
|
25946
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25947
|
+
*/
|
|
25948
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25949
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
25950
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25951
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
25952
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
25953
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
25954
|
+
}
|
|
25955
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get extends StandardParameters {
|
|
25956
|
+
/**
|
|
25957
|
+
* The name of the operation resource.
|
|
25958
|
+
*/
|
|
25959
|
+
name?: string;
|
|
25960
|
+
}
|
|
25084
25961
|
export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
|
|
25085
25962
|
context: APIRequestContext;
|
|
25086
25963
|
constructor(context: APIRequestContext);
|
|
@@ -26373,7 +27250,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
26373
27250
|
* pageSize: 'placeholder-value',
|
|
26374
27251
|
* // The standard list page token.
|
|
26375
27252
|
* pageToken: 'placeholder-value',
|
|
26376
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
27253
|
+
* // 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.
|
|
26377
27254
|
* returnPartialSuccess: 'placeholder-value',
|
|
26378
27255
|
* },
|
|
26379
27256
|
* );
|
|
@@ -26440,7 +27317,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
26440
27317
|
*/
|
|
26441
27318
|
pageToken?: string;
|
|
26442
27319
|
/**
|
|
26443
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
27320
|
+
* 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.
|
|
26444
27321
|
*/
|
|
26445
27322
|
returnPartialSuccess?: boolean;
|
|
26446
27323
|
}
|
|
@@ -26938,6 +27815,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
26938
27815
|
* // "branch": "my_branch",
|
|
26939
27816
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
26940
27817
|
* // "contentSearchSpec": {},
|
|
27818
|
+
* // "crowdingSpecs": [],
|
|
26941
27819
|
* // "dataStoreSpecs": [],
|
|
26942
27820
|
* // "displaySpec": {},
|
|
26943
27821
|
* // "facetSpecs": [],
|
|
@@ -26948,6 +27826,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
26948
27826
|
* // "offset": 0,
|
|
26949
27827
|
* // "oneBoxPageSize": 0,
|
|
26950
27828
|
* // "orderBy": "my_orderBy",
|
|
27829
|
+
* // "pageCategories": [],
|
|
26951
27830
|
* // "pageSize": 0,
|
|
26952
27831
|
* // "pageToken": "my_pageToken",
|
|
26953
27832
|
* // "params": {},
|
|
@@ -26981,6 +27860,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
26981
27860
|
* // "redirectUri": "my_redirectUri",
|
|
26982
27861
|
* // "results": [],
|
|
26983
27862
|
* // "searchLinkPromotions": [],
|
|
27863
|
+
* // "semanticState": "my_semanticState",
|
|
26984
27864
|
* // "sessionInfo": {},
|
|
26985
27865
|
* // "summary": {},
|
|
26986
27866
|
* // "totalSize": 0
|
|
@@ -27054,6 +27934,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27054
27934
|
* // "branch": "my_branch",
|
|
27055
27935
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
27056
27936
|
* // "contentSearchSpec": {},
|
|
27937
|
+
* // "crowdingSpecs": [],
|
|
27057
27938
|
* // "dataStoreSpecs": [],
|
|
27058
27939
|
* // "displaySpec": {},
|
|
27059
27940
|
* // "facetSpecs": [],
|
|
@@ -27064,6 +27945,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27064
27945
|
* // "offset": 0,
|
|
27065
27946
|
* // "oneBoxPageSize": 0,
|
|
27066
27947
|
* // "orderBy": "my_orderBy",
|
|
27948
|
+
* // "pageCategories": [],
|
|
27067
27949
|
* // "pageSize": 0,
|
|
27068
27950
|
* // "pageToken": "my_pageToken",
|
|
27069
27951
|
* // "params": {},
|
|
@@ -27097,6 +27979,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27097
27979
|
* // "redirectUri": "my_redirectUri",
|
|
27098
27980
|
* // "results": [],
|
|
27099
27981
|
* // "searchLinkPromotions": [],
|
|
27982
|
+
* // "semanticState": "my_semanticState",
|
|
27100
27983
|
* // "sessionInfo": {},
|
|
27101
27984
|
* // "summary": {},
|
|
27102
27985
|
* // "totalSize": 0
|
|
@@ -27798,30 +28681,294 @@ export declare namespace discoveryengine_v1 {
|
|
|
27798
28681
|
*
|
|
27799
28682
|
* // Do the magic
|
|
27800
28683
|
* const res =
|
|
27801
|
-
* await discoveryengine.projects.locations.collections.engines.sessions.answers.get(
|
|
28684
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.answers.get(
|
|
28685
|
+
* {
|
|
28686
|
+
* // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
28687
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/answers/my-answer',
|
|
28688
|
+
* },
|
|
28689
|
+
* );
|
|
28690
|
+
* console.log(res.data);
|
|
28691
|
+
*
|
|
28692
|
+
* // Example response
|
|
28693
|
+
* // {
|
|
28694
|
+
* // "answerSkippedReasons": [],
|
|
28695
|
+
* // "answerText": "my_answerText",
|
|
28696
|
+
* // "citations": [],
|
|
28697
|
+
* // "completeTime": "my_completeTime",
|
|
28698
|
+
* // "createTime": "my_createTime",
|
|
28699
|
+
* // "groundingScore": {},
|
|
28700
|
+
* // "groundingSupports": [],
|
|
28701
|
+
* // "name": "my_name",
|
|
28702
|
+
* // "queryUnderstandingInfo": {},
|
|
28703
|
+
* // "references": [],
|
|
28704
|
+
* // "relatedQuestions": [],
|
|
28705
|
+
* // "safetyRatings": [],
|
|
28706
|
+
* // "state": "my_state",
|
|
28707
|
+
* // "steps": []
|
|
28708
|
+
* // }
|
|
28709
|
+
* }
|
|
28710
|
+
*
|
|
28711
|
+
* main().catch(e => {
|
|
28712
|
+
* console.error(e);
|
|
28713
|
+
* throw e;
|
|
28714
|
+
* });
|
|
28715
|
+
*
|
|
28716
|
+
* ```
|
|
28717
|
+
*
|
|
28718
|
+
* @param params - Parameters for request
|
|
28719
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
28720
|
+
* @param callback - Optional callback that handles the response.
|
|
28721
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
28722
|
+
*/
|
|
28723
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28724
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Answer>>;
|
|
28725
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28726
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>): void;
|
|
28727
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>): void;
|
|
28728
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Answer>): void;
|
|
28729
|
+
}
|
|
28730
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
|
|
28731
|
+
/**
|
|
28732
|
+
* Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
28733
|
+
*/
|
|
28734
|
+
name?: string;
|
|
28735
|
+
}
|
|
28736
|
+
export class Resource$Projects$Locations$Collections$Engines$Widgetconfigs {
|
|
28737
|
+
context: APIRequestContext;
|
|
28738
|
+
constructor(context: APIRequestContext);
|
|
28739
|
+
/**
|
|
28740
|
+
* Gets a WidgetConfig.
|
|
28741
|
+
* @example
|
|
28742
|
+
* ```js
|
|
28743
|
+
* // Before running the sample:
|
|
28744
|
+
* // - Enable the API at:
|
|
28745
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
28746
|
+
* // - Login into gcloud by running:
|
|
28747
|
+
* // ```sh
|
|
28748
|
+
* // $ gcloud auth application-default login
|
|
28749
|
+
* // ```
|
|
28750
|
+
* // - Install the npm module by running:
|
|
28751
|
+
* // ```sh
|
|
28752
|
+
* // $ npm install googleapis
|
|
28753
|
+
* // ```
|
|
28754
|
+
*
|
|
28755
|
+
* const {google} = require('googleapis');
|
|
28756
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
28757
|
+
*
|
|
28758
|
+
* async function main() {
|
|
28759
|
+
* const auth = new google.auth.GoogleAuth({
|
|
28760
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
28761
|
+
* scopes: [
|
|
28762
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
28763
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
28764
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
28765
|
+
* ],
|
|
28766
|
+
* });
|
|
28767
|
+
*
|
|
28768
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
28769
|
+
* const authClient = await auth.getClient();
|
|
28770
|
+
* google.options({auth: authClient});
|
|
28771
|
+
*
|
|
28772
|
+
* // Do the magic
|
|
28773
|
+
* const res =
|
|
28774
|
+
* await discoveryengine.projects.locations.collections.engines.widgetConfigs.get(
|
|
28775
|
+
* {
|
|
28776
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
28777
|
+
* acceptCache: 'placeholder-value',
|
|
28778
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
28779
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
28780
|
+
* 'placeholder-value',
|
|
28781
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
28782
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
28783
|
+
* },
|
|
28784
|
+
* );
|
|
28785
|
+
* console.log(res.data);
|
|
28786
|
+
*
|
|
28787
|
+
* // Example response
|
|
28788
|
+
* // {
|
|
28789
|
+
* // "accessSettings": {},
|
|
28790
|
+
* // "allowPublicAccess": false,
|
|
28791
|
+
* // "allowlistedDomains": [],
|
|
28792
|
+
* // "assistantSettings": {},
|
|
28793
|
+
* // "collectionComponents": [],
|
|
28794
|
+
* // "configId": "my_configId",
|
|
28795
|
+
* // "contentSearchSpec": {},
|
|
28796
|
+
* // "createTime": "my_createTime",
|
|
28797
|
+
* // "customerProvidedConfig": {},
|
|
28798
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28799
|
+
* // "dataStoreUiConfigs": [],
|
|
28800
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28801
|
+
* // "displayName": "my_displayName",
|
|
28802
|
+
* // "enableAutocomplete": false,
|
|
28803
|
+
* // "enableConversationalSearch": false,
|
|
28804
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28805
|
+
* // "enableQualityFeedback": false,
|
|
28806
|
+
* // "enableResultScore": false,
|
|
28807
|
+
* // "enableSafeSearch": false,
|
|
28808
|
+
* // "enableSearchAsYouType": false,
|
|
28809
|
+
* // "enableSnippetResultSummary": false,
|
|
28810
|
+
* // "enableSummarization": false,
|
|
28811
|
+
* // "enableWebApp": false,
|
|
28812
|
+
* // "facetField": [],
|
|
28813
|
+
* // "fieldsUiComponentsMap": {},
|
|
28814
|
+
* // "geminiBundle": false,
|
|
28815
|
+
* // "homepageSetting": {},
|
|
28816
|
+
* // "industryVertical": "my_industryVertical",
|
|
28817
|
+
* // "llmEnabled": false,
|
|
28818
|
+
* // "minimumDataTermAccepted": false,
|
|
28819
|
+
* // "name": "my_name",
|
|
28820
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28821
|
+
* // "solutionType": "my_solutionType",
|
|
28822
|
+
* // "uiBranding": {},
|
|
28823
|
+
* // "uiSettings": {},
|
|
28824
|
+
* // "updateTime": "my_updateTime"
|
|
28825
|
+
* // }
|
|
28826
|
+
* }
|
|
28827
|
+
*
|
|
28828
|
+
* main().catch(e => {
|
|
28829
|
+
* console.error(e);
|
|
28830
|
+
* throw e;
|
|
28831
|
+
* });
|
|
28832
|
+
*
|
|
28833
|
+
* ```
|
|
28834
|
+
*
|
|
28835
|
+
* @param params - Parameters for request
|
|
28836
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
28837
|
+
* @param callback - Optional callback that handles the response.
|
|
28838
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
28839
|
+
*/
|
|
28840
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28841
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
28842
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28843
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28844
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28845
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28846
|
+
/**
|
|
28847
|
+
* Update a WidgetConfig.
|
|
28848
|
+
* @example
|
|
28849
|
+
* ```js
|
|
28850
|
+
* // Before running the sample:
|
|
28851
|
+
* // - Enable the API at:
|
|
28852
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
28853
|
+
* // - Login into gcloud by running:
|
|
28854
|
+
* // ```sh
|
|
28855
|
+
* // $ gcloud auth application-default login
|
|
28856
|
+
* // ```
|
|
28857
|
+
* // - Install the npm module by running:
|
|
28858
|
+
* // ```sh
|
|
28859
|
+
* // $ npm install googleapis
|
|
28860
|
+
* // ```
|
|
28861
|
+
*
|
|
28862
|
+
* const {google} = require('googleapis');
|
|
28863
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
28864
|
+
*
|
|
28865
|
+
* async function main() {
|
|
28866
|
+
* const auth = new google.auth.GoogleAuth({
|
|
28867
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
28868
|
+
* scopes: [
|
|
28869
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
28870
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
28871
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
28872
|
+
* ],
|
|
28873
|
+
* });
|
|
28874
|
+
*
|
|
28875
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
28876
|
+
* const authClient = await auth.getClient();
|
|
28877
|
+
* google.options({auth: authClient});
|
|
28878
|
+
*
|
|
28879
|
+
* // Do the magic
|
|
28880
|
+
* const res =
|
|
28881
|
+
* await discoveryengine.projects.locations.collections.engines.widgetConfigs.patch(
|
|
27802
28882
|
* {
|
|
27803
|
-
* //
|
|
27804
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/
|
|
28883
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
28884
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
28885
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
28886
|
+
* updateMask: 'placeholder-value',
|
|
28887
|
+
*
|
|
28888
|
+
* // Request body metadata
|
|
28889
|
+
* requestBody: {
|
|
28890
|
+
* // request body parameters
|
|
28891
|
+
* // {
|
|
28892
|
+
* // "accessSettings": {},
|
|
28893
|
+
* // "allowPublicAccess": false,
|
|
28894
|
+
* // "allowlistedDomains": [],
|
|
28895
|
+
* // "assistantSettings": {},
|
|
28896
|
+
* // "collectionComponents": [],
|
|
28897
|
+
* // "configId": "my_configId",
|
|
28898
|
+
* // "contentSearchSpec": {},
|
|
28899
|
+
* // "createTime": "my_createTime",
|
|
28900
|
+
* // "customerProvidedConfig": {},
|
|
28901
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28902
|
+
* // "dataStoreUiConfigs": [],
|
|
28903
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28904
|
+
* // "displayName": "my_displayName",
|
|
28905
|
+
* // "enableAutocomplete": false,
|
|
28906
|
+
* // "enableConversationalSearch": false,
|
|
28907
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28908
|
+
* // "enableQualityFeedback": false,
|
|
28909
|
+
* // "enableResultScore": false,
|
|
28910
|
+
* // "enableSafeSearch": false,
|
|
28911
|
+
* // "enableSearchAsYouType": false,
|
|
28912
|
+
* // "enableSnippetResultSummary": false,
|
|
28913
|
+
* // "enableSummarization": false,
|
|
28914
|
+
* // "enableWebApp": false,
|
|
28915
|
+
* // "facetField": [],
|
|
28916
|
+
* // "fieldsUiComponentsMap": {},
|
|
28917
|
+
* // "geminiBundle": false,
|
|
28918
|
+
* // "homepageSetting": {},
|
|
28919
|
+
* // "industryVertical": "my_industryVertical",
|
|
28920
|
+
* // "llmEnabled": false,
|
|
28921
|
+
* // "minimumDataTermAccepted": false,
|
|
28922
|
+
* // "name": "my_name",
|
|
28923
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28924
|
+
* // "solutionType": "my_solutionType",
|
|
28925
|
+
* // "uiBranding": {},
|
|
28926
|
+
* // "uiSettings": {},
|
|
28927
|
+
* // "updateTime": "my_updateTime"
|
|
28928
|
+
* // }
|
|
28929
|
+
* },
|
|
27805
28930
|
* },
|
|
27806
28931
|
* );
|
|
27807
28932
|
* console.log(res.data);
|
|
27808
28933
|
*
|
|
27809
28934
|
* // Example response
|
|
27810
28935
|
* // {
|
|
27811
|
-
* // "
|
|
27812
|
-
* // "
|
|
27813
|
-
* // "
|
|
27814
|
-
* // "
|
|
28936
|
+
* // "accessSettings": {},
|
|
28937
|
+
* // "allowPublicAccess": false,
|
|
28938
|
+
* // "allowlistedDomains": [],
|
|
28939
|
+
* // "assistantSettings": {},
|
|
28940
|
+
* // "collectionComponents": [],
|
|
28941
|
+
* // "configId": "my_configId",
|
|
28942
|
+
* // "contentSearchSpec": {},
|
|
27815
28943
|
* // "createTime": "my_createTime",
|
|
27816
|
-
* // "
|
|
27817
|
-
* // "
|
|
28944
|
+
* // "customerProvidedConfig": {},
|
|
28945
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28946
|
+
* // "dataStoreUiConfigs": [],
|
|
28947
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28948
|
+
* // "displayName": "my_displayName",
|
|
28949
|
+
* // "enableAutocomplete": false,
|
|
28950
|
+
* // "enableConversationalSearch": false,
|
|
28951
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28952
|
+
* // "enableQualityFeedback": false,
|
|
28953
|
+
* // "enableResultScore": false,
|
|
28954
|
+
* // "enableSafeSearch": false,
|
|
28955
|
+
* // "enableSearchAsYouType": false,
|
|
28956
|
+
* // "enableSnippetResultSummary": false,
|
|
28957
|
+
* // "enableSummarization": false,
|
|
28958
|
+
* // "enableWebApp": false,
|
|
28959
|
+
* // "facetField": [],
|
|
28960
|
+
* // "fieldsUiComponentsMap": {},
|
|
28961
|
+
* // "geminiBundle": false,
|
|
28962
|
+
* // "homepageSetting": {},
|
|
28963
|
+
* // "industryVertical": "my_industryVertical",
|
|
28964
|
+
* // "llmEnabled": false,
|
|
28965
|
+
* // "minimumDataTermAccepted": false,
|
|
27818
28966
|
* // "name": "my_name",
|
|
27819
|
-
* // "
|
|
27820
|
-
* // "
|
|
27821
|
-
* // "
|
|
27822
|
-
* // "
|
|
27823
|
-
* // "
|
|
27824
|
-
* // "steps": []
|
|
28967
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28968
|
+
* // "solutionType": "my_solutionType",
|
|
28969
|
+
* // "uiBranding": {},
|
|
28970
|
+
* // "uiSettings": {},
|
|
28971
|
+
* // "updateTime": "my_updateTime"
|
|
27825
28972
|
* // }
|
|
27826
28973
|
* }
|
|
27827
28974
|
*
|
|
@@ -27837,19 +28984,41 @@ export declare namespace discoveryengine_v1 {
|
|
|
27837
28984
|
* @param callback - Optional callback that handles the response.
|
|
27838
28985
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27839
28986
|
*/
|
|
27840
|
-
|
|
27841
|
-
|
|
27842
|
-
|
|
27843
|
-
|
|
27844
|
-
|
|
27845
|
-
|
|
28987
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28988
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
28989
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28990
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28991
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28992
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
27846
28993
|
}
|
|
27847
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
28994
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get extends StandardParameters {
|
|
27848
28995
|
/**
|
|
27849
|
-
*
|
|
28996
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
28997
|
+
*/
|
|
28998
|
+
acceptCache?: boolean;
|
|
28999
|
+
/**
|
|
29000
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
29001
|
+
*/
|
|
29002
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
29003
|
+
/**
|
|
29004
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
27850
29005
|
*/
|
|
27851
29006
|
name?: string;
|
|
27852
29007
|
}
|
|
29008
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch extends StandardParameters {
|
|
29009
|
+
/**
|
|
29010
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
29011
|
+
*/
|
|
29012
|
+
name?: string;
|
|
29013
|
+
/**
|
|
29014
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
29015
|
+
*/
|
|
29016
|
+
updateMask?: string;
|
|
29017
|
+
/**
|
|
29018
|
+
* Request body metadata
|
|
29019
|
+
*/
|
|
29020
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
29021
|
+
}
|
|
27853
29022
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
27854
29023
|
context: APIRequestContext;
|
|
27855
29024
|
constructor(context: APIRequestContext);
|
|
@@ -27964,7 +29133,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27964
29133
|
* pageSize: 'placeholder-value',
|
|
27965
29134
|
* // The standard list page token.
|
|
27966
29135
|
* pageToken: 'placeholder-value',
|
|
27967
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
29136
|
+
* // 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.
|
|
27968
29137
|
* returnPartialSuccess: 'placeholder-value',
|
|
27969
29138
|
* });
|
|
27970
29139
|
* console.log(res.data);
|
|
@@ -28020,7 +29189,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28020
29189
|
*/
|
|
28021
29190
|
pageToken?: string;
|
|
28022
29191
|
/**
|
|
28023
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
29192
|
+
* 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.
|
|
28024
29193
|
*/
|
|
28025
29194
|
returnPartialSuccess?: boolean;
|
|
28026
29195
|
}
|
|
@@ -28039,6 +29208,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28039
29208
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
28040
29209
|
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
28041
29210
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
29211
|
+
widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs;
|
|
28042
29212
|
constructor(context: APIRequestContext);
|
|
28043
29213
|
/**
|
|
28044
29214
|
* Completes the specified user input with keyword suggestions.
|
|
@@ -29662,7 +30832,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29662
30832
|
* pageSize: 'placeholder-value',
|
|
29663
30833
|
* // The standard list page token.
|
|
29664
30834
|
* pageToken: 'placeholder-value',
|
|
29665
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
30835
|
+
* // 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.
|
|
29666
30836
|
* returnPartialSuccess: 'placeholder-value',
|
|
29667
30837
|
* },
|
|
29668
30838
|
* );
|
|
@@ -29729,7 +30899,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29729
30899
|
*/
|
|
29730
30900
|
pageToken?: string;
|
|
29731
30901
|
/**
|
|
29732
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
30902
|
+
* 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.
|
|
29733
30903
|
*/
|
|
29734
30904
|
returnPartialSuccess?: boolean;
|
|
29735
30905
|
}
|
|
@@ -31124,7 +32294,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
31124
32294
|
* pageSize: 'placeholder-value',
|
|
31125
32295
|
* // The standard list page token.
|
|
31126
32296
|
* pageToken: 'placeholder-value',
|
|
31127
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32297
|
+
* // 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.
|
|
31128
32298
|
* returnPartialSuccess: 'placeholder-value',
|
|
31129
32299
|
* });
|
|
31130
32300
|
* console.log(res.data);
|
|
@@ -31180,7 +32350,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
31180
32350
|
*/
|
|
31181
32351
|
pageToken?: string;
|
|
31182
32352
|
/**
|
|
31183
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32353
|
+
* 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.
|
|
31184
32354
|
*/
|
|
31185
32355
|
returnPartialSuccess?: boolean;
|
|
31186
32356
|
}
|
|
@@ -31298,7 +32468,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
31298
32468
|
* pageSize: 'placeholder-value',
|
|
31299
32469
|
* // The standard list page token.
|
|
31300
32470
|
* pageToken: 'placeholder-value',
|
|
31301
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32471
|
+
* // 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.
|
|
31302
32472
|
* returnPartialSuccess: 'placeholder-value',
|
|
31303
32473
|
* });
|
|
31304
32474
|
* console.log(res.data);
|
|
@@ -31354,7 +32524,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
31354
32524
|
*/
|
|
31355
32525
|
pageToken?: string;
|
|
31356
32526
|
/**
|
|
31357
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
32527
|
+
* 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.
|
|
31358
32528
|
*/
|
|
31359
32529
|
returnPartialSuccess?: boolean;
|
|
31360
32530
|
}
|
|
@@ -32264,6 +33434,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32264
33434
|
* // "branch": "my_branch",
|
|
32265
33435
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
32266
33436
|
* // "contentSearchSpec": {},
|
|
33437
|
+
* // "crowdingSpecs": [],
|
|
32267
33438
|
* // "dataStoreSpecs": [],
|
|
32268
33439
|
* // "displaySpec": {},
|
|
32269
33440
|
* // "facetSpecs": [],
|
|
@@ -32274,6 +33445,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32274
33445
|
* // "offset": 0,
|
|
32275
33446
|
* // "oneBoxPageSize": 0,
|
|
32276
33447
|
* // "orderBy": "my_orderBy",
|
|
33448
|
+
* // "pageCategories": [],
|
|
32277
33449
|
* // "pageSize": 0,
|
|
32278
33450
|
* // "pageToken": "my_pageToken",
|
|
32279
33451
|
* // "params": {},
|
|
@@ -32306,6 +33478,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32306
33478
|
* // "redirectUri": "my_redirectUri",
|
|
32307
33479
|
* // "results": [],
|
|
32308
33480
|
* // "searchLinkPromotions": [],
|
|
33481
|
+
* // "semanticState": "my_semanticState",
|
|
32309
33482
|
* // "sessionInfo": {},
|
|
32310
33483
|
* // "summary": {},
|
|
32311
33484
|
* // "totalSize": 0
|
|
@@ -32379,6 +33552,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32379
33552
|
* // "branch": "my_branch",
|
|
32380
33553
|
* // "canonicalFilter": "my_canonicalFilter",
|
|
32381
33554
|
* // "contentSearchSpec": {},
|
|
33555
|
+
* // "crowdingSpecs": [],
|
|
32382
33556
|
* // "dataStoreSpecs": [],
|
|
32383
33557
|
* // "displaySpec": {},
|
|
32384
33558
|
* // "facetSpecs": [],
|
|
@@ -32389,6 +33563,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32389
33563
|
* // "offset": 0,
|
|
32390
33564
|
* // "oneBoxPageSize": 0,
|
|
32391
33565
|
* // "orderBy": "my_orderBy",
|
|
33566
|
+
* // "pageCategories": [],
|
|
32392
33567
|
* // "pageSize": 0,
|
|
32393
33568
|
* // "pageToken": "my_pageToken",
|
|
32394
33569
|
* // "params": {},
|
|
@@ -32422,6 +33597,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32422
33597
|
* // "redirectUri": "my_redirectUri",
|
|
32423
33598
|
* // "results": [],
|
|
32424
33599
|
* // "searchLinkPromotions": [],
|
|
33600
|
+
* // "semanticState": "my_semanticState",
|
|
32425
33601
|
* // "sessionInfo": {},
|
|
32426
33602
|
* // "summary": {},
|
|
32427
33603
|
* // "totalSize": 0
|
|
@@ -34809,6 +35985,288 @@ export declare namespace discoveryengine_v1 {
|
|
|
34809
35985
|
*/
|
|
34810
35986
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
|
|
34811
35987
|
}
|
|
35988
|
+
export class Resource$Projects$Locations$Datastores$Widgetconfigs {
|
|
35989
|
+
context: APIRequestContext;
|
|
35990
|
+
constructor(context: APIRequestContext);
|
|
35991
|
+
/**
|
|
35992
|
+
* Gets a WidgetConfig.
|
|
35993
|
+
* @example
|
|
35994
|
+
* ```js
|
|
35995
|
+
* // Before running the sample:
|
|
35996
|
+
* // - Enable the API at:
|
|
35997
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
35998
|
+
* // - Login into gcloud by running:
|
|
35999
|
+
* // ```sh
|
|
36000
|
+
* // $ gcloud auth application-default login
|
|
36001
|
+
* // ```
|
|
36002
|
+
* // - Install the npm module by running:
|
|
36003
|
+
* // ```sh
|
|
36004
|
+
* // $ npm install googleapis
|
|
36005
|
+
* // ```
|
|
36006
|
+
*
|
|
36007
|
+
* const {google} = require('googleapis');
|
|
36008
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
36009
|
+
*
|
|
36010
|
+
* async function main() {
|
|
36011
|
+
* const auth = new google.auth.GoogleAuth({
|
|
36012
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
36013
|
+
* scopes: [
|
|
36014
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
36015
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
36016
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
36017
|
+
* ],
|
|
36018
|
+
* });
|
|
36019
|
+
*
|
|
36020
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
36021
|
+
* const authClient = await auth.getClient();
|
|
36022
|
+
* google.options({auth: authClient});
|
|
36023
|
+
*
|
|
36024
|
+
* // Do the magic
|
|
36025
|
+
* const res =
|
|
36026
|
+
* await discoveryengine.projects.locations.dataStores.widgetConfigs.get({
|
|
36027
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
36028
|
+
* acceptCache: 'placeholder-value',
|
|
36029
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
36030
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
36031
|
+
* 'placeholder-value',
|
|
36032
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
36033
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
36034
|
+
* });
|
|
36035
|
+
* console.log(res.data);
|
|
36036
|
+
*
|
|
36037
|
+
* // Example response
|
|
36038
|
+
* // {
|
|
36039
|
+
* // "accessSettings": {},
|
|
36040
|
+
* // "allowPublicAccess": false,
|
|
36041
|
+
* // "allowlistedDomains": [],
|
|
36042
|
+
* // "assistantSettings": {},
|
|
36043
|
+
* // "collectionComponents": [],
|
|
36044
|
+
* // "configId": "my_configId",
|
|
36045
|
+
* // "contentSearchSpec": {},
|
|
36046
|
+
* // "createTime": "my_createTime",
|
|
36047
|
+
* // "customerProvidedConfig": {},
|
|
36048
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
36049
|
+
* // "dataStoreUiConfigs": [],
|
|
36050
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
36051
|
+
* // "displayName": "my_displayName",
|
|
36052
|
+
* // "enableAutocomplete": false,
|
|
36053
|
+
* // "enableConversationalSearch": false,
|
|
36054
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36055
|
+
* // "enableQualityFeedback": false,
|
|
36056
|
+
* // "enableResultScore": false,
|
|
36057
|
+
* // "enableSafeSearch": false,
|
|
36058
|
+
* // "enableSearchAsYouType": false,
|
|
36059
|
+
* // "enableSnippetResultSummary": false,
|
|
36060
|
+
* // "enableSummarization": false,
|
|
36061
|
+
* // "enableWebApp": false,
|
|
36062
|
+
* // "facetField": [],
|
|
36063
|
+
* // "fieldsUiComponentsMap": {},
|
|
36064
|
+
* // "geminiBundle": false,
|
|
36065
|
+
* // "homepageSetting": {},
|
|
36066
|
+
* // "industryVertical": "my_industryVertical",
|
|
36067
|
+
* // "llmEnabled": false,
|
|
36068
|
+
* // "minimumDataTermAccepted": false,
|
|
36069
|
+
* // "name": "my_name",
|
|
36070
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36071
|
+
* // "solutionType": "my_solutionType",
|
|
36072
|
+
* // "uiBranding": {},
|
|
36073
|
+
* // "uiSettings": {},
|
|
36074
|
+
* // "updateTime": "my_updateTime"
|
|
36075
|
+
* // }
|
|
36076
|
+
* }
|
|
36077
|
+
*
|
|
36078
|
+
* main().catch(e => {
|
|
36079
|
+
* console.error(e);
|
|
36080
|
+
* throw e;
|
|
36081
|
+
* });
|
|
36082
|
+
*
|
|
36083
|
+
* ```
|
|
36084
|
+
*
|
|
36085
|
+
* @param params - Parameters for request
|
|
36086
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
36087
|
+
* @param callback - Optional callback that handles the response.
|
|
36088
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
36089
|
+
*/
|
|
36090
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
36091
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
36092
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
36093
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36094
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36095
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36096
|
+
/**
|
|
36097
|
+
* Update a WidgetConfig.
|
|
36098
|
+
* @example
|
|
36099
|
+
* ```js
|
|
36100
|
+
* // Before running the sample:
|
|
36101
|
+
* // - Enable the API at:
|
|
36102
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
36103
|
+
* // - Login into gcloud by running:
|
|
36104
|
+
* // ```sh
|
|
36105
|
+
* // $ gcloud auth application-default login
|
|
36106
|
+
* // ```
|
|
36107
|
+
* // - Install the npm module by running:
|
|
36108
|
+
* // ```sh
|
|
36109
|
+
* // $ npm install googleapis
|
|
36110
|
+
* // ```
|
|
36111
|
+
*
|
|
36112
|
+
* const {google} = require('googleapis');
|
|
36113
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
36114
|
+
*
|
|
36115
|
+
* async function main() {
|
|
36116
|
+
* const auth = new google.auth.GoogleAuth({
|
|
36117
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
36118
|
+
* scopes: [
|
|
36119
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
36120
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
36121
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
36122
|
+
* ],
|
|
36123
|
+
* });
|
|
36124
|
+
*
|
|
36125
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
36126
|
+
* const authClient = await auth.getClient();
|
|
36127
|
+
* google.options({auth: authClient});
|
|
36128
|
+
*
|
|
36129
|
+
* // Do the magic
|
|
36130
|
+
* const res =
|
|
36131
|
+
* await discoveryengine.projects.locations.dataStores.widgetConfigs.patch({
|
|
36132
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
36133
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
36134
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
36135
|
+
* updateMask: 'placeholder-value',
|
|
36136
|
+
*
|
|
36137
|
+
* // Request body metadata
|
|
36138
|
+
* requestBody: {
|
|
36139
|
+
* // request body parameters
|
|
36140
|
+
* // {
|
|
36141
|
+
* // "accessSettings": {},
|
|
36142
|
+
* // "allowPublicAccess": false,
|
|
36143
|
+
* // "allowlistedDomains": [],
|
|
36144
|
+
* // "assistantSettings": {},
|
|
36145
|
+
* // "collectionComponents": [],
|
|
36146
|
+
* // "configId": "my_configId",
|
|
36147
|
+
* // "contentSearchSpec": {},
|
|
36148
|
+
* // "createTime": "my_createTime",
|
|
36149
|
+
* // "customerProvidedConfig": {},
|
|
36150
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
36151
|
+
* // "dataStoreUiConfigs": [],
|
|
36152
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
36153
|
+
* // "displayName": "my_displayName",
|
|
36154
|
+
* // "enableAutocomplete": false,
|
|
36155
|
+
* // "enableConversationalSearch": false,
|
|
36156
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36157
|
+
* // "enableQualityFeedback": false,
|
|
36158
|
+
* // "enableResultScore": false,
|
|
36159
|
+
* // "enableSafeSearch": false,
|
|
36160
|
+
* // "enableSearchAsYouType": false,
|
|
36161
|
+
* // "enableSnippetResultSummary": false,
|
|
36162
|
+
* // "enableSummarization": false,
|
|
36163
|
+
* // "enableWebApp": false,
|
|
36164
|
+
* // "facetField": [],
|
|
36165
|
+
* // "fieldsUiComponentsMap": {},
|
|
36166
|
+
* // "geminiBundle": false,
|
|
36167
|
+
* // "homepageSetting": {},
|
|
36168
|
+
* // "industryVertical": "my_industryVertical",
|
|
36169
|
+
* // "llmEnabled": false,
|
|
36170
|
+
* // "minimumDataTermAccepted": false,
|
|
36171
|
+
* // "name": "my_name",
|
|
36172
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36173
|
+
* // "solutionType": "my_solutionType",
|
|
36174
|
+
* // "uiBranding": {},
|
|
36175
|
+
* // "uiSettings": {},
|
|
36176
|
+
* // "updateTime": "my_updateTime"
|
|
36177
|
+
* // }
|
|
36178
|
+
* },
|
|
36179
|
+
* });
|
|
36180
|
+
* console.log(res.data);
|
|
36181
|
+
*
|
|
36182
|
+
* // Example response
|
|
36183
|
+
* // {
|
|
36184
|
+
* // "accessSettings": {},
|
|
36185
|
+
* // "allowPublicAccess": false,
|
|
36186
|
+
* // "allowlistedDomains": [],
|
|
36187
|
+
* // "assistantSettings": {},
|
|
36188
|
+
* // "collectionComponents": [],
|
|
36189
|
+
* // "configId": "my_configId",
|
|
36190
|
+
* // "contentSearchSpec": {},
|
|
36191
|
+
* // "createTime": "my_createTime",
|
|
36192
|
+
* // "customerProvidedConfig": {},
|
|
36193
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
36194
|
+
* // "dataStoreUiConfigs": [],
|
|
36195
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
36196
|
+
* // "displayName": "my_displayName",
|
|
36197
|
+
* // "enableAutocomplete": false,
|
|
36198
|
+
* // "enableConversationalSearch": false,
|
|
36199
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36200
|
+
* // "enableQualityFeedback": false,
|
|
36201
|
+
* // "enableResultScore": false,
|
|
36202
|
+
* // "enableSafeSearch": false,
|
|
36203
|
+
* // "enableSearchAsYouType": false,
|
|
36204
|
+
* // "enableSnippetResultSummary": false,
|
|
36205
|
+
* // "enableSummarization": false,
|
|
36206
|
+
* // "enableWebApp": false,
|
|
36207
|
+
* // "facetField": [],
|
|
36208
|
+
* // "fieldsUiComponentsMap": {},
|
|
36209
|
+
* // "geminiBundle": false,
|
|
36210
|
+
* // "homepageSetting": {},
|
|
36211
|
+
* // "industryVertical": "my_industryVertical",
|
|
36212
|
+
* // "llmEnabled": false,
|
|
36213
|
+
* // "minimumDataTermAccepted": false,
|
|
36214
|
+
* // "name": "my_name",
|
|
36215
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36216
|
+
* // "solutionType": "my_solutionType",
|
|
36217
|
+
* // "uiBranding": {},
|
|
36218
|
+
* // "uiSettings": {},
|
|
36219
|
+
* // "updateTime": "my_updateTime"
|
|
36220
|
+
* // }
|
|
36221
|
+
* }
|
|
36222
|
+
*
|
|
36223
|
+
* main().catch(e => {
|
|
36224
|
+
* console.error(e);
|
|
36225
|
+
* throw e;
|
|
36226
|
+
* });
|
|
36227
|
+
*
|
|
36228
|
+
* ```
|
|
36229
|
+
*
|
|
36230
|
+
* @param params - Parameters for request
|
|
36231
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
36232
|
+
* @param callback - Optional callback that handles the response.
|
|
36233
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
36234
|
+
*/
|
|
36235
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
36236
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
36237
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
36238
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36239
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36240
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36241
|
+
}
|
|
36242
|
+
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
36243
|
+
/**
|
|
36244
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
36245
|
+
*/
|
|
36246
|
+
acceptCache?: boolean;
|
|
36247
|
+
/**
|
|
36248
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
36249
|
+
*/
|
|
36250
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
36251
|
+
/**
|
|
36252
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
36253
|
+
*/
|
|
36254
|
+
name?: string;
|
|
36255
|
+
}
|
|
36256
|
+
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
36257
|
+
/**
|
|
36258
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
36259
|
+
*/
|
|
36260
|
+
name?: string;
|
|
36261
|
+
/**
|
|
36262
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
36263
|
+
*/
|
|
36264
|
+
updateMask?: string;
|
|
36265
|
+
/**
|
|
36266
|
+
* Request body metadata
|
|
36267
|
+
*/
|
|
36268
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
36269
|
+
}
|
|
34812
36270
|
export class Resource$Projects$Locations$Groundingconfigs {
|
|
34813
36271
|
context: APIRequestContext;
|
|
34814
36272
|
constructor(context: APIRequestContext);
|
|
@@ -35622,7 +37080,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
35622
37080
|
* pageSize: 'placeholder-value',
|
|
35623
37081
|
* // The standard list page token.
|
|
35624
37082
|
* pageToken: 'placeholder-value',
|
|
35625
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37083
|
+
* // 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.
|
|
35626
37084
|
* returnPartialSuccess: 'placeholder-value',
|
|
35627
37085
|
* },
|
|
35628
37086
|
* );
|
|
@@ -35679,7 +37137,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
35679
37137
|
*/
|
|
35680
37138
|
pageToken?: string;
|
|
35681
37139
|
/**
|
|
35682
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37140
|
+
* 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.
|
|
35683
37141
|
*/
|
|
35684
37142
|
returnPartialSuccess?: boolean;
|
|
35685
37143
|
}
|
|
@@ -36087,7 +37545,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
36087
37545
|
* pageSize: 'placeholder-value',
|
|
36088
37546
|
* // The standard list page token.
|
|
36089
37547
|
* pageToken: 'placeholder-value',
|
|
36090
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37548
|
+
* // 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.
|
|
36091
37549
|
* returnPartialSuccess: 'placeholder-value',
|
|
36092
37550
|
* });
|
|
36093
37551
|
* console.log(res.data);
|
|
@@ -36143,7 +37601,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
36143
37601
|
*/
|
|
36144
37602
|
pageToken?: string;
|
|
36145
37603
|
/**
|
|
36146
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
37604
|
+
* 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.
|
|
36147
37605
|
*/
|
|
36148
37606
|
returnPartialSuccess?: boolean;
|
|
36149
37607
|
}
|
|
@@ -36635,6 +38093,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
36635
38093
|
}
|
|
36636
38094
|
export class Resource$Projects$Locations$Userstores {
|
|
36637
38095
|
context: APIRequestContext;
|
|
38096
|
+
licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
|
|
36638
38097
|
userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
|
|
36639
38098
|
constructor(context: APIRequestContext);
|
|
36640
38099
|
/**
|
|
@@ -37064,6 +38523,83 @@ export declare namespace discoveryengine_v1 {
|
|
|
37064
38523
|
*/
|
|
37065
38524
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserStore;
|
|
37066
38525
|
}
|
|
38526
|
+
export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
|
|
38527
|
+
context: APIRequestContext;
|
|
38528
|
+
constructor(context: APIRequestContext);
|
|
38529
|
+
/**
|
|
38530
|
+
* Lists all the LicenseConfigUsageStatss associated with the project.
|
|
38531
|
+
* @example
|
|
38532
|
+
* ```js
|
|
38533
|
+
* // Before running the sample:
|
|
38534
|
+
* // - Enable the API at:
|
|
38535
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38536
|
+
* // - Login into gcloud by running:
|
|
38537
|
+
* // ```sh
|
|
38538
|
+
* // $ gcloud auth application-default login
|
|
38539
|
+
* // ```
|
|
38540
|
+
* // - Install the npm module by running:
|
|
38541
|
+
* // ```sh
|
|
38542
|
+
* // $ npm install googleapis
|
|
38543
|
+
* // ```
|
|
38544
|
+
*
|
|
38545
|
+
* const {google} = require('googleapis');
|
|
38546
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
38547
|
+
*
|
|
38548
|
+
* async function main() {
|
|
38549
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38550
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38551
|
+
* scopes: [
|
|
38552
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38553
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38554
|
+
* ],
|
|
38555
|
+
* });
|
|
38556
|
+
*
|
|
38557
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38558
|
+
* const authClient = await auth.getClient();
|
|
38559
|
+
* google.options({auth: authClient});
|
|
38560
|
+
*
|
|
38561
|
+
* // Do the magic
|
|
38562
|
+
* const res =
|
|
38563
|
+
* await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
|
|
38564
|
+
* {
|
|
38565
|
+
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
|
|
38566
|
+
* parent:
|
|
38567
|
+
* 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
38568
|
+
* },
|
|
38569
|
+
* );
|
|
38570
|
+
* console.log(res.data);
|
|
38571
|
+
*
|
|
38572
|
+
* // Example response
|
|
38573
|
+
* // {
|
|
38574
|
+
* // "licenseConfigUsageStats": []
|
|
38575
|
+
* // }
|
|
38576
|
+
* }
|
|
38577
|
+
*
|
|
38578
|
+
* main().catch(e => {
|
|
38579
|
+
* console.error(e);
|
|
38580
|
+
* throw e;
|
|
38581
|
+
* });
|
|
38582
|
+
*
|
|
38583
|
+
* ```
|
|
38584
|
+
*
|
|
38585
|
+
* @param params - Parameters for request
|
|
38586
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38587
|
+
* @param callback - Optional callback that handles the response.
|
|
38588
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38589
|
+
*/
|
|
38590
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38591
|
+
list(params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>>;
|
|
38592
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38593
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38594
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38595
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38596
|
+
}
|
|
38597
|
+
export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List extends StandardParameters {
|
|
38598
|
+
/**
|
|
38599
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
|
|
38600
|
+
*/
|
|
38601
|
+
parent?: string;
|
|
38602
|
+
}
|
|
37067
38603
|
export class Resource$Projects$Locations$Userstores$Userlicenses {
|
|
37068
38604
|
context: APIRequestContext;
|
|
37069
38605
|
constructor(context: APIRequestContext);
|
|
@@ -37102,8 +38638,8 @@ export declare namespace discoveryengine_v1 {
|
|
|
37102
38638
|
* // Do the magic
|
|
37103
38639
|
* const res =
|
|
37104
38640
|
* await discoveryengine.projects.locations.userStores.userLicenses.list({
|
|
37105
|
-
* // Optional.
|
|
37106
|
-
*
|
|
38641
|
+
* // 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.
|
|
38642
|
+
* orderBy: 'placeholder-value',
|
|
37107
38643
|
* // 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.
|
|
37108
38644
|
* pageSize: 'placeholder-value',
|
|
37109
38645
|
* // 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.
|
|
@@ -37142,9 +38678,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
37142
38678
|
}
|
|
37143
38679
|
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
|
|
37144
38680
|
/**
|
|
37145
|
-
* Optional.
|
|
38681
|
+
* 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.
|
|
37146
38682
|
*/
|
|
37147
|
-
|
|
38683
|
+
orderBy?: string;
|
|
37148
38684
|
/**
|
|
37149
38685
|
* 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.
|
|
37150
38686
|
*/
|
|
@@ -37337,7 +38873,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37337
38873
|
* pageSize: 'placeholder-value',
|
|
37338
38874
|
* // The standard list page token.
|
|
37339
38875
|
* pageToken: 'placeholder-value',
|
|
37340
|
-
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
38876
|
+
* // 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.
|
|
37341
38877
|
* returnPartialSuccess: 'placeholder-value',
|
|
37342
38878
|
* });
|
|
37343
38879
|
* console.log(res.data);
|
|
@@ -37403,7 +38939,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
37403
38939
|
*/
|
|
37404
38940
|
pageToken?: string;
|
|
37405
38941
|
/**
|
|
37406
|
-
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
38942
|
+
* 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.
|
|
37407
38943
|
*/
|
|
37408
38944
|
returnPartialSuccess?: boolean;
|
|
37409
38945
|
}
|