@googleapis/discoveryengine 27.1.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/build/v1.d.ts CHANGED
@@ -67,341 +67,9 @@ export declare namespace discoveryengine_v1 {
67
67
  */
68
68
  export class Discoveryengine {
69
69
  context: APIRequestContext;
70
- media: Resource$Media;
71
70
  projects: Resource$Projects;
72
71
  constructor(options: GlobalOptions, google?: GoogleConfigurable);
73
72
  }
74
- /**
75
- * Information to read/write to blobstore2.
76
- */
77
- export interface Schema$GdataBlobstore2Info {
78
- /**
79
- * The blob generation id.
80
- */
81
- blobGeneration?: string | null;
82
- /**
83
- * The blob id, e.g., /blobstore/prod/playground/scotty
84
- */
85
- blobId?: string | null;
86
- /**
87
- * Read handle passed from Bigstore -\> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
88
- */
89
- downloadReadHandle?: string | null;
90
- /**
91
- * The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
92
- */
93
- readToken?: string | null;
94
- /**
95
- * Metadata passed from Blobstore -\> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
96
- */
97
- uploadMetadataContainer?: string | null;
98
- }
99
- /**
100
- * A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
101
- */
102
- export interface Schema$GdataCompositeMedia {
103
- /**
104
- * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
105
- */
106
- blobRef?: string | null;
107
- /**
108
- * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
109
- */
110
- blobstore2Info?: Schema$GdataBlobstore2Info;
111
- /**
112
- * A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
113
- */
114
- cosmoBinaryReference?: string | null;
115
- /**
116
- * crc32.c hash for the payload.
117
- */
118
- crc32cHash?: number | null;
119
- /**
120
- * Media data, set if reference_type is INLINE
121
- */
122
- inline?: string | null;
123
- /**
124
- * Size of the data, in bytes
125
- */
126
- length?: string | null;
127
- /**
128
- * MD5 hash for the payload.
129
- */
130
- md5Hash?: string | null;
131
- /**
132
- * Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
133
- */
134
- objectId?: Schema$GdataObjectId;
135
- /**
136
- * Path to the data, set if reference_type is PATH
137
- */
138
- path?: string | null;
139
- /**
140
- * Describes what the field reference contains.
141
- */
142
- referenceType?: string | null;
143
- /**
144
- * SHA-1 hash for the payload.
145
- */
146
- sha1Hash?: string | null;
147
- }
148
- /**
149
- * Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
150
- */
151
- export interface Schema$GdataContentTypeInfo {
152
- /**
153
- * Scotty's best guess of what the content type of the file is.
154
- */
155
- bestGuess?: string | null;
156
- /**
157
- * The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
158
- */
159
- fromBytes?: string | null;
160
- /**
161
- * The content type of the file derived from the file extension of the original file name used by the client.
162
- */
163
- fromFileName?: string | null;
164
- /**
165
- * The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
166
- */
167
- fromHeader?: string | null;
168
- /**
169
- * The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
170
- */
171
- fromUrlPath?: string | null;
172
- }
173
- /**
174
- * Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
175
- */
176
- export interface Schema$GdataDiffChecksumsResponse {
177
- /**
178
- * Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
179
- */
180
- checksumsLocation?: Schema$GdataCompositeMedia;
181
- /**
182
- * The chunk size of checksums. Must be a multiple of 256KB.
183
- */
184
- chunkSizeBytes?: string | null;
185
- /**
186
- * If set, calculate the checksums based on the contents and return them to the caller.
187
- */
188
- objectLocation?: Schema$GdataCompositeMedia;
189
- /**
190
- * The total size of the server object.
191
- */
192
- objectSizeBytes?: string | null;
193
- /**
194
- * The object version of the object the checksums are being returned for.
195
- */
196
- objectVersion?: string | null;
197
- }
198
- /**
199
- * Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
200
- */
201
- export interface Schema$GdataDiffDownloadResponse {
202
- /**
203
- * The original object location.
204
- */
205
- objectLocation?: Schema$GdataCompositeMedia;
206
- }
207
- /**
208
- * A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
209
- */
210
- export interface Schema$GdataDiffUploadRequest {
211
- /**
212
- * The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
213
- */
214
- checksumsInfo?: Schema$GdataCompositeMedia;
215
- /**
216
- * The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
217
- */
218
- objectInfo?: Schema$GdataCompositeMedia;
219
- /**
220
- * The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
221
- */
222
- objectVersion?: string | null;
223
- }
224
- /**
225
- * Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
226
- */
227
- export interface Schema$GdataDiffUploadResponse {
228
- /**
229
- * The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
230
- */
231
- objectVersion?: string | null;
232
- /**
233
- * The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
234
- */
235
- originalObject?: Schema$GdataCompositeMedia;
236
- }
237
- /**
238
- * Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
239
- */
240
- export interface Schema$GdataDiffVersionResponse {
241
- /**
242
- * The total size of the server object.
243
- */
244
- objectSizeBytes?: string | null;
245
- /**
246
- * The version of the object stored at the server.
247
- */
248
- objectVersion?: string | null;
249
- }
250
- /**
251
- * Parameters specific to media downloads.
252
- */
253
- export interface Schema$GdataDownloadParameters {
254
- /**
255
- * A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
256
- */
257
- allowGzipCompression?: boolean | null;
258
- /**
259
- * Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
260
- */
261
- ignoreRange?: boolean | null;
262
- }
263
- /**
264
- * A reference to data stored on the filesystem, on GFS or in blobstore.
265
- */
266
- export interface Schema$GdataMedia {
267
- /**
268
- * Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
269
- */
270
- algorithm?: string | null;
271
- /**
272
- * Use object_id instead.
273
- */
274
- bigstoreObjectRef?: string | null;
275
- /**
276
- * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
277
- */
278
- blobRef?: string | null;
279
- /**
280
- * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
281
- */
282
- blobstore2Info?: Schema$GdataBlobstore2Info;
283
- /**
284
- * A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
285
- */
286
- compositeMedia?: Schema$GdataCompositeMedia[];
287
- /**
288
- * MIME type of the data
289
- */
290
- contentType?: string | null;
291
- /**
292
- * Extended content type information provided for Scotty uploads.
293
- */
294
- contentTypeInfo?: Schema$GdataContentTypeInfo;
295
- /**
296
- * A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
297
- */
298
- cosmoBinaryReference?: string | null;
299
- /**
300
- * For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
301
- */
302
- crc32cHash?: number | null;
303
- /**
304
- * Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
305
- */
306
- diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse;
307
- /**
308
- * Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
309
- */
310
- diffDownloadResponse?: Schema$GdataDiffDownloadResponse;
311
- /**
312
- * Set if reference_type is DIFF_UPLOAD_REQUEST.
313
- */
314
- diffUploadRequest?: Schema$GdataDiffUploadRequest;
315
- /**
316
- * Set if reference_type is DIFF_UPLOAD_RESPONSE.
317
- */
318
- diffUploadResponse?: Schema$GdataDiffUploadResponse;
319
- /**
320
- * Set if reference_type is DIFF_VERSION_RESPONSE.
321
- */
322
- diffVersionResponse?: Schema$GdataDiffVersionResponse;
323
- /**
324
- * Parameters for a media download.
325
- */
326
- downloadParameters?: Schema$GdataDownloadParameters;
327
- /**
328
- * Original file name
329
- */
330
- filename?: string | null;
331
- /**
332
- * Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
333
- */
334
- hash?: string | null;
335
- /**
336
- * For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
337
- */
338
- hashVerified?: boolean | null;
339
- /**
340
- * Media data, set if reference_type is INLINE
341
- */
342
- inline?: string | null;
343
- /**
344
- * |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
345
- */
346
- isPotentialRetry?: boolean | null;
347
- /**
348
- * Size of the data, in bytes
349
- */
350
- length?: string | null;
351
- /**
352
- * Scotty-provided MD5 hash for an upload.
353
- */
354
- md5Hash?: string | null;
355
- /**
356
- * Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
357
- */
358
- mediaId?: string | null;
359
- /**
360
- * Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
361
- */
362
- objectId?: Schema$GdataObjectId;
363
- /**
364
- * Path to the data, set if reference_type is PATH
365
- */
366
- path?: string | null;
367
- /**
368
- * Describes what the field reference contains.
369
- */
370
- referenceType?: string | null;
371
- /**
372
- * Scotty-provided SHA1 hash for an upload.
373
- */
374
- sha1Hash?: string | null;
375
- /**
376
- * Scotty-provided SHA256 hash for an upload.
377
- */
378
- sha256Hash?: string | null;
379
- /**
380
- * Time at which the media data was last updated, in milliseconds since UNIX epoch
381
- */
382
- timestamp?: string | null;
383
- /**
384
- * A unique fingerprint/version id for the media data
385
- */
386
- token?: string | null;
387
- }
388
- /**
389
- * This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
390
- */
391
- export interface Schema$GdataObjectId {
392
- /**
393
- * The name of the bucket to which this object belongs.
394
- */
395
- bucketName?: string | null;
396
- /**
397
- * Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
398
- */
399
- generation?: string | null;
400
- /**
401
- * The name of the object.
402
- */
403
- objectName?: string | null;
404
- }
405
73
  /**
406
74
  * `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
407
75
  */
@@ -3421,6 +3089,10 @@ export declare namespace discoveryengine_v1 {
3421
3089
  * Configurations for a Search Engine.
3422
3090
  */
3423
3091
  export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
3092
+ /**
3093
+ * Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
3094
+ */
3095
+ requiredSubscriptionTier?: string | null;
3424
3096
  /**
3425
3097
  * The add-on that this search engine enables.
3426
3098
  */
@@ -4561,6 +4233,10 @@ export declare namespace discoveryengine_v1 {
4561
4233
  * A specification for configuring the behavior of content search.
4562
4234
  */
4563
4235
  contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
4236
+ /**
4237
+ * Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
4238
+ */
4239
+ crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
4564
4240
  /**
4565
4241
  * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
4566
4242
  */
@@ -4609,6 +4285,10 @@ export declare namespace discoveryengine_v1 {
4609
4285
  * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
4610
4286
  */
4611
4287
  orderBy?: string | null;
4288
+ /**
4289
+ * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
4290
+ */
4291
+ pageCategories?: string[] | null;
4612
4292
  /**
4613
4293
  * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
4614
4294
  */
@@ -4918,6 +4598,23 @@ export declare namespace discoveryengine_v1 {
4918
4598
  */
4919
4599
  imageSource?: string | null;
4920
4600
  }
4601
+ /**
4602
+ * Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
4603
+ */
4604
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec {
4605
+ /**
4606
+ * The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
4607
+ */
4608
+ field?: string | null;
4609
+ /**
4610
+ * The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
4611
+ */
4612
+ maxCount?: number | null;
4613
+ /**
4614
+ * Mode to use for documents that are crowded away.
4615
+ */
4616
+ mode?: string | null;
4617
+ }
4921
4618
  /**
4922
4619
  * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
4923
4620
  */
@@ -6500,6 +6197,14 @@ export declare namespace discoveryengine_v1 {
6500
6197
  * Optional. Customer policy for the assistant.
6501
6198
  */
6502
6199
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
6200
+ /**
6201
+ * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
6202
+ */
6203
+ description?: string | null;
6204
+ /**
6205
+ * Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
6206
+ */
6207
+ displayName?: string | null;
6503
6208
  /**
6504
6209
  * Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId\}/locations/{locationId\}/collections/{collectionId\}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] \}
6505
6210
  */
@@ -6651,10 +6356,18 @@ export declare namespace discoveryengine_v1 {
6651
6356
  * Configuration for the generation of the assistant response.
6652
6357
  */
6653
6358
  export interface Schema$GoogleCloudDiscoveryengineV1AssistantGenerationConfig {
6359
+ /**
6360
+ * Optional. The list of models that are allowed to be used for assistant.
6361
+ */
6362
+ allowedModelIds?: string[] | null;
6654
6363
  /**
6655
6364
  * The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.
6656
6365
  */
6657
6366
  defaultLanguage?: string | null;
6367
+ /**
6368
+ * Optional. The default model to use for assistant.
6369
+ */
6370
+ defaultModelId?: string | null;
6658
6371
  /**
6659
6372
  * System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
6660
6373
  */
@@ -7943,6 +7656,10 @@ export declare namespace discoveryengine_v1 {
7943
7656
  * Configurations for a Search Engine.
7944
7657
  */
7945
7658
  export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
7659
+ /**
7660
+ * Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
7661
+ */
7662
+ requiredSubscriptionTier?: string | null;
7946
7663
  /**
7947
7664
  * The add-on that this search engine enables.
7948
7665
  */
@@ -8710,6 +8427,10 @@ export declare namespace discoveryengine_v1 {
8710
8427
  * A specification for configuring the behavior of content search.
8711
8428
  */
8712
8429
  contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
8430
+ /**
8431
+ * Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
8432
+ */
8433
+ crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
8713
8434
  /**
8714
8435
  * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.
8715
8436
  */
@@ -8754,6 +8475,10 @@ export declare namespace discoveryengine_v1 {
8754
8475
  * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
8755
8476
  */
8756
8477
  orderBy?: string | null;
8478
+ /**
8479
+ * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
8480
+ */
8481
+ pageCategories?: string[] | null;
8757
8482
  /**
8758
8483
  * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
8759
8484
  */
@@ -9059,6 +8784,23 @@ export declare namespace discoveryengine_v1 {
9059
8784
  */
9060
8785
  imageSource?: string | null;
9061
8786
  }
8787
+ /**
8788
+ * Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
8789
+ */
8790
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec {
8791
+ /**
8792
+ * The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
8793
+ */
8794
+ field?: string | null;
8795
+ /**
8796
+ * The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
8797
+ */
8798
+ maxCount?: number | null;
8799
+ /**
8800
+ * Mode to use for documents that are crowded away.
8801
+ */
8802
+ mode?: string | null;
8803
+ }
9062
8804
  /**
9063
8805
  * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
9064
8806
  */
@@ -11606,6 +11348,10 @@ export declare namespace discoveryengine_v1 {
11606
11348
  * Configurations for a Search Engine.
11607
11349
  */
11608
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;
11609
11355
  /**
11610
11356
  * The add-on that this search engine enables.
11611
11357
  */
@@ -11776,6 +11522,10 @@ export declare namespace discoveryengine_v1 {
11776
11522
  * Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.
11777
11523
  */
11778
11524
  externalIdentity?: string | null;
11525
+ /**
11526
+ * Optional. The name of the external identity.
11527
+ */
11528
+ externalIdentityName?: string | null;
11779
11529
  /**
11780
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.
11781
11531
  */
@@ -12269,6 +12019,19 @@ export declare namespace discoveryengine_v1 {
12269
12019
  */
12270
12020
  usedLicenseCount?: string | null;
12271
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
+ }
12272
12035
  /**
12273
12036
  * Response message for CmekConfigService.ListCmekConfigs method.
12274
12037
  */
@@ -13140,6 +12903,10 @@ export declare namespace discoveryengine_v1 {
13140
12903
  * A specification for configuring the behavior of content search.
13141
12904
  */
13142
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[];
13143
12910
  /**
13144
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.
13145
12912
  */
@@ -13180,6 +12947,10 @@ export declare namespace discoveryengine_v1 {
13180
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.
13181
12948
  */
13182
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;
13183
12954
  /**
13184
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.
13185
12956
  */
@@ -13456,6 +13227,23 @@ export declare namespace discoveryengine_v1 {
13456
13227
  */
13457
13228
  version?: string | null;
13458
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
+ }
13459
13247
  /**
13460
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.
13461
13249
  */
@@ -13659,6 +13447,10 @@ export declare namespace discoveryengine_v1 {
13659
13447
  * Promotions for site search.
13660
13448
  */
13661
13449
  searchLinkPromotions?: Schema$GoogleCloudDiscoveryengineV1SearchLinkPromotion[];
13450
+ /**
13451
+ * Output only. Indicates the semantic state of the search response.
13452
+ */
13453
+ semanticState?: string | null;
13662
13454
  /**
13663
13455
  * Session information. Only set if SearchRequest.session is provided. See its description for more details.
13664
13456
  */
@@ -14310,6 +14102,10 @@ export declare namespace discoveryengine_v1 {
14310
14102
  * A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
14311
14103
  */
14312
14104
  assistToken?: string | null;
14105
+ /**
14106
+ * The tool names of the tools that were invoked.
14107
+ */
14108
+ invocationTools?: string[] | null;
14313
14109
  /**
14314
14110
  * Session information. Only included in the final StreamAssistResponse of the response stream.
14315
14111
  */
@@ -15264,7 +15060,7 @@ export declare namespace discoveryengine_v1 {
15264
15060
  */
15265
15061
  operations?: Schema$GoogleLongrunningOperation[];
15266
15062
  /**
15267
- * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
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.
15268
15064
  */
15269
15065
  unreachable?: string[] | null;
15270
15066
  }
@@ -15480,11 +15276,13 @@ export declare namespace discoveryengine_v1 {
15480
15276
  */
15481
15277
  version?: string | null;
15482
15278
  }
15483
- export class Resource$Media {
15279
+ export class Resource$Projects {
15484
15280
  context: APIRequestContext;
15281
+ locations: Resource$Projects$Locations;
15282
+ operations: Resource$Projects$Operations;
15485
15283
  constructor(context: APIRequestContext);
15486
15284
  /**
15487
- * Downloads a file from the session.
15285
+ * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
15488
15286
  * @example
15489
15287
  * ```js
15490
15288
  * // Before running the sample:
@@ -15507,7 +15305,6 @@ export declare namespace discoveryengine_v1 {
15507
15305
  * // Scopes can be specified either as an array or as a single, space-delimited string.
15508
15306
  * scopes: [
15509
15307
  * 'https://www.googleapis.com/auth/cloud-platform',
15510
- * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
15511
15308
  * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
15512
15309
  * ],
15513
15310
  * });
@@ -15517,48 +15314,29 @@ export declare namespace discoveryengine_v1 {
15517
15314
  * google.options({auth: authClient});
15518
15315
  *
15519
15316
  * // Do the magic
15520
- * const res = await discoveryengine.media.download({
15521
- * // Required. The ID of the file to be downloaded.
15522
- * fileId: 'placeholder-value',
15523
- * // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
15524
- * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
15525
- * // Optional. The ID of the view to be downloaded.
15526
- * viewId: 'placeholder-value',
15317
+ * const res = await discoveryengine.projects.provision({
15318
+ * // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
15319
+ * name: 'projects/my-project',
15320
+ *
15321
+ * // Request body metadata
15322
+ * requestBody: {
15323
+ * // request body parameters
15324
+ * // {
15325
+ * // "acceptDataUseTerms": false,
15326
+ * // "dataUseTermsVersion": "my_dataUseTermsVersion",
15327
+ * // "saasParams": {}
15328
+ * // }
15329
+ * },
15527
15330
  * });
15528
15331
  * console.log(res.data);
15529
15332
  *
15530
15333
  * // Example response
15531
15334
  * // {
15532
- * // "algorithm": "my_algorithm",
15533
- * // "bigstoreObjectRef": "my_bigstoreObjectRef",
15534
- * // "blobRef": "my_blobRef",
15535
- * // "blobstore2Info": {},
15536
- * // "compositeMedia": [],
15537
- * // "contentType": "my_contentType",
15538
- * // "contentTypeInfo": {},
15539
- * // "cosmoBinaryReference": "my_cosmoBinaryReference",
15540
- * // "crc32cHash": 0,
15541
- * // "diffChecksumsResponse": {},
15542
- * // "diffDownloadResponse": {},
15543
- * // "diffUploadRequest": {},
15544
- * // "diffUploadResponse": {},
15545
- * // "diffVersionResponse": {},
15546
- * // "downloadParameters": {},
15547
- * // "filename": "my_filename",
15548
- * // "hash": "my_hash",
15549
- * // "hashVerified": false,
15550
- * // "inline": "my_inline",
15551
- * // "isPotentialRetry": false,
15552
- * // "length": "my_length",
15553
- * // "md5Hash": "my_md5Hash",
15554
- * // "mediaId": "my_mediaId",
15555
- * // "objectId": {},
15556
- * // "path": "my_path",
15557
- * // "referenceType": "my_referenceType",
15558
- * // "sha1Hash": "my_sha1Hash",
15559
- * // "sha256Hash": "my_sha256Hash",
15560
- * // "timestamp": "my_timestamp",
15561
- * // "token": "my_token"
15335
+ * // "done": false,
15336
+ * // "error": {},
15337
+ * // "metadata": {},
15338
+ * // "name": "my_name",
15339
+ * // "response": {}
15562
15340
  * // }
15563
15341
  * }
15564
15342
  *
@@ -15574,136 +15352,39 @@ export declare namespace discoveryengine_v1 {
15574
15352
  * @param callback - Optional callback that handles the response.
15575
15353
  * @returns A promise if used with async/await, or void if used with a callback.
15576
15354
  */
15577
- download(params: Params$Resource$Media$Download, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
15578
- download(params?: Params$Resource$Media$Download, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GdataMedia>>;
15579
- download(params: Params$Resource$Media$Download, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
15580
- download(params: Params$Resource$Media$Download, options: MethodOptions | BodyResponseCallback<Schema$GdataMedia>, callback: BodyResponseCallback<Schema$GdataMedia>): void;
15581
- download(params: Params$Resource$Media$Download, callback: BodyResponseCallback<Schema$GdataMedia>): void;
15582
- download(callback: BodyResponseCallback<Schema$GdataMedia>): void;
15355
+ provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
15356
+ provision(params?: Params$Resource$Projects$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
15357
+ provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
15358
+ provision(params: Params$Resource$Projects$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
15359
+ provision(params: Params$Resource$Projects$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
15360
+ provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
15583
15361
  }
15584
- export interface Params$Resource$Media$Download extends StandardParameters {
15585
- /**
15586
- * Required. The ID of the file to be downloaded.
15587
- */
15588
- fileId?: string;
15362
+ export interface Params$Resource$Projects$Provision extends StandardParameters {
15589
15363
  /**
15590
- * Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
15364
+ * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
15591
15365
  */
15592
15366
  name?: string;
15593
15367
  /**
15594
- * Optional. The ID of the view to be downloaded.
15368
+ * Request body metadata
15595
15369
  */
15596
- viewId?: string;
15370
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1ProvisionProjectRequest;
15597
15371
  }
15598
- export class Resource$Projects {
15372
+ export class Resource$Projects$Locations {
15599
15373
  context: APIRequestContext;
15600
- locations: Resource$Projects$Locations;
15601
- operations: Resource$Projects$Operations;
15374
+ cmekConfigs: Resource$Projects$Locations$Cmekconfigs;
15375
+ collections: Resource$Projects$Locations$Collections;
15376
+ dataStores: Resource$Projects$Locations$Datastores;
15377
+ groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
15378
+ identityMappingStores: Resource$Projects$Locations$Identitymappingstores;
15379
+ licenseConfigs: Resource$Projects$Locations$Licenseconfigs;
15380
+ operations: Resource$Projects$Locations$Operations;
15381
+ podcasts: Resource$Projects$Locations$Podcasts;
15382
+ rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
15383
+ userEvents: Resource$Projects$Locations$Userevents;
15384
+ userStores: Resource$Projects$Locations$Userstores;
15602
15385
  constructor(context: APIRequestContext);
15603
15386
  /**
15604
- * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
15605
- * @example
15606
- * ```js
15607
- * // Before running the sample:
15608
- * // - Enable the API at:
15609
- * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
15610
- * // - Login into gcloud by running:
15611
- * // ```sh
15612
- * // $ gcloud auth application-default login
15613
- * // ```
15614
- * // - Install the npm module by running:
15615
- * // ```sh
15616
- * // $ npm install googleapis
15617
- * // ```
15618
- *
15619
- * const {google} = require('googleapis');
15620
- * const discoveryengine = google.discoveryengine('v1');
15621
- *
15622
- * async function main() {
15623
- * const auth = new google.auth.GoogleAuth({
15624
- * // Scopes can be specified either as an array or as a single, space-delimited string.
15625
- * scopes: [
15626
- * 'https://www.googleapis.com/auth/cloud-platform',
15627
- * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
15628
- * ],
15629
- * });
15630
- *
15631
- * // Acquire an auth client, and bind it to all future calls
15632
- * const authClient = await auth.getClient();
15633
- * google.options({auth: authClient});
15634
- *
15635
- * // Do the magic
15636
- * const res = await discoveryengine.projects.provision({
15637
- * // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
15638
- * name: 'projects/my-project',
15639
- *
15640
- * // Request body metadata
15641
- * requestBody: {
15642
- * // request body parameters
15643
- * // {
15644
- * // "acceptDataUseTerms": false,
15645
- * // "dataUseTermsVersion": "my_dataUseTermsVersion",
15646
- * // "saasParams": {}
15647
- * // }
15648
- * },
15649
- * });
15650
- * console.log(res.data);
15651
- *
15652
- * // Example response
15653
- * // {
15654
- * // "done": false,
15655
- * // "error": {},
15656
- * // "metadata": {},
15657
- * // "name": "my_name",
15658
- * // "response": {}
15659
- * // }
15660
- * }
15661
- *
15662
- * main().catch(e => {
15663
- * console.error(e);
15664
- * throw e;
15665
- * });
15666
- *
15667
- * ```
15668
- *
15669
- * @param params - Parameters for request
15670
- * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
15671
- * @param callback - Optional callback that handles the response.
15672
- * @returns A promise if used with async/await, or void if used with a callback.
15673
- */
15674
- provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
15675
- provision(params?: Params$Resource$Projects$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
15676
- provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
15677
- provision(params: Params$Resource$Projects$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
15678
- provision(params: Params$Resource$Projects$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
15679
- provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
15680
- }
15681
- export interface Params$Resource$Projects$Provision extends StandardParameters {
15682
- /**
15683
- * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
15684
- */
15685
- name?: string;
15686
- /**
15687
- * Request body metadata
15688
- */
15689
- requestBody?: Schema$GoogleCloudDiscoveryengineV1ProvisionProjectRequest;
15690
- }
15691
- export class Resource$Projects$Locations {
15692
- context: APIRequestContext;
15693
- cmekConfigs: Resource$Projects$Locations$Cmekconfigs;
15694
- collections: Resource$Projects$Locations$Collections;
15695
- dataStores: Resource$Projects$Locations$Datastores;
15696
- groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
15697
- identityMappingStores: Resource$Projects$Locations$Identitymappingstores;
15698
- licenseConfigs: Resource$Projects$Locations$Licenseconfigs;
15699
- operations: Resource$Projects$Locations$Operations;
15700
- podcasts: Resource$Projects$Locations$Podcasts;
15701
- rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
15702
- userEvents: Resource$Projects$Locations$Userevents;
15703
- userStores: Resource$Projects$Locations$Userstores;
15704
- constructor(context: APIRequestContext);
15705
- /**
15706
- * Gets the AclConfig.
15387
+ * Gets the AclConfig.
15707
15388
  * @example
15708
15389
  * ```js
15709
15390
  * // Before running the sample:
@@ -17051,7 +16732,7 @@ export declare namespace discoveryengine_v1 {
17051
16732
  * pageSize: 'placeholder-value',
17052
16733
  * // The standard list page token.
17053
16734
  * pageToken: 'placeholder-value',
17054
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
17055
16736
  * returnPartialSuccess: 'placeholder-value',
17056
16737
  * },
17057
16738
  * );
@@ -17108,7 +16789,7 @@ export declare namespace discoveryengine_v1 {
17108
16789
  */
17109
16790
  pageToken?: string;
17110
16791
  /**
17111
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
17112
16793
  */
17113
16794
  returnPartialSuccess?: boolean;
17114
16795
  }
@@ -18856,7 +18537,7 @@ export declare namespace discoveryengine_v1 {
18856
18537
  * pageSize: 'placeholder-value',
18857
18538
  * // The standard list page token.
18858
18539
  * pageToken: 'placeholder-value',
18859
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
18860
18541
  * returnPartialSuccess: 'placeholder-value',
18861
18542
  * },
18862
18543
  * );
@@ -18923,7 +18604,7 @@ export declare namespace discoveryengine_v1 {
18923
18604
  */
18924
18605
  pageToken?: string;
18925
18606
  /**
18926
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
18927
18608
  */
18928
18609
  returnPartialSuccess?: boolean;
18929
18610
  }
@@ -20420,7 +20101,7 @@ export declare namespace discoveryengine_v1 {
20420
20101
  * pageSize: 'placeholder-value',
20421
20102
  * // The standard list page token.
20422
20103
  * pageToken: 'placeholder-value',
20423
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
20424
20105
  * returnPartialSuccess: 'placeholder-value',
20425
20106
  * },
20426
20107
  * );
@@ -20477,7 +20158,7 @@ export declare namespace discoveryengine_v1 {
20477
20158
  */
20478
20159
  pageToken?: string;
20479
20160
  /**
20480
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
20481
20162
  */
20482
20163
  returnPartialSuccess?: boolean;
20483
20164
  }
@@ -20598,7 +20279,7 @@ export declare namespace discoveryengine_v1 {
20598
20279
  * pageSize: 'placeholder-value',
20599
20280
  * // The standard list page token.
20600
20281
  * pageToken: 'placeholder-value',
20601
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
20602
20283
  * returnPartialSuccess: 'placeholder-value',
20603
20284
  * },
20604
20285
  * );
@@ -20655,7 +20336,7 @@ export declare namespace discoveryengine_v1 {
20655
20336
  */
20656
20337
  pageToken?: string;
20657
20338
  /**
20658
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
20659
20340
  */
20660
20341
  returnPartialSuccess?: boolean;
20661
20342
  }
@@ -21210,7 +20891,7 @@ export declare namespace discoveryengine_v1 {
21210
20891
  * pageSize: 'placeholder-value',
21211
20892
  * // The standard list page token.
21212
20893
  * pageToken: 'placeholder-value',
21213
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
21214
20895
  * returnPartialSuccess: 'placeholder-value',
21215
20896
  * },
21216
20897
  * );
@@ -21267,7 +20948,7 @@ export declare namespace discoveryengine_v1 {
21267
20948
  */
21268
20949
  pageToken?: string;
21269
20950
  /**
21270
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
21271
20952
  */
21272
20953
  returnPartialSuccess?: boolean;
21273
20954
  }
@@ -21765,6 +21446,7 @@ export declare namespace discoveryengine_v1 {
21765
21446
  * // "branch": "my_branch",
21766
21447
  * // "canonicalFilter": "my_canonicalFilter",
21767
21448
  * // "contentSearchSpec": {},
21449
+ * // "crowdingSpecs": [],
21768
21450
  * // "dataStoreSpecs": [],
21769
21451
  * // "displaySpec": {},
21770
21452
  * // "facetSpecs": [],
@@ -21775,6 +21457,7 @@ export declare namespace discoveryengine_v1 {
21775
21457
  * // "offset": 0,
21776
21458
  * // "oneBoxPageSize": 0,
21777
21459
  * // "orderBy": "my_orderBy",
21460
+ * // "pageCategories": [],
21778
21461
  * // "pageSize": 0,
21779
21462
  * // "pageToken": "my_pageToken",
21780
21463
  * // "params": {},
@@ -21808,6 +21491,7 @@ export declare namespace discoveryengine_v1 {
21808
21491
  * // "redirectUri": "my_redirectUri",
21809
21492
  * // "results": [],
21810
21493
  * // "searchLinkPromotions": [],
21494
+ * // "semanticState": "my_semanticState",
21811
21495
  * // "sessionInfo": {},
21812
21496
  * // "summary": {},
21813
21497
  * // "totalSize": 0
@@ -21881,6 +21565,7 @@ export declare namespace discoveryengine_v1 {
21881
21565
  * // "branch": "my_branch",
21882
21566
  * // "canonicalFilter": "my_canonicalFilter",
21883
21567
  * // "contentSearchSpec": {},
21568
+ * // "crowdingSpecs": [],
21884
21569
  * // "dataStoreSpecs": [],
21885
21570
  * // "displaySpec": {},
21886
21571
  * // "facetSpecs": [],
@@ -21891,6 +21576,7 @@ export declare namespace discoveryengine_v1 {
21891
21576
  * // "offset": 0,
21892
21577
  * // "oneBoxPageSize": 0,
21893
21578
  * // "orderBy": "my_orderBy",
21579
+ * // "pageCategories": [],
21894
21580
  * // "pageSize": 0,
21895
21581
  * // "pageToken": "my_pageToken",
21896
21582
  * // "params": {},
@@ -21924,6 +21610,7 @@ export declare namespace discoveryengine_v1 {
21924
21610
  * // "redirectUri": "my_redirectUri",
21925
21611
  * // "results": [],
21926
21612
  * // "searchLinkPromotions": [],
21613
+ * // "semanticState": "my_semanticState",
21927
21614
  * // "sessionInfo": {},
21928
21615
  * // "summary": {},
21929
21616
  * // "totalSize": 0
@@ -23243,7 +22930,7 @@ export declare namespace discoveryengine_v1 {
23243
22930
  * pageSize: 'placeholder-value',
23244
22931
  * // The standard list page token.
23245
22932
  * pageToken: 'placeholder-value',
23246
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
23247
22934
  * returnPartialSuccess: 'placeholder-value',
23248
22935
  * },
23249
22936
  * );
@@ -23300,7 +22987,7 @@ export declare namespace discoveryengine_v1 {
23300
22987
  */
23301
22988
  pageToken?: string;
23302
22989
  /**
23303
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
23304
22991
  */
23305
22992
  returnPartialSuccess?: boolean;
23306
22993
  }
@@ -24204,7 +23891,7 @@ export declare namespace discoveryengine_v1 {
24204
23891
  * pageSize: 'placeholder-value',
24205
23892
  * // The standard list page token.
24206
23893
  * pageToken: 'placeholder-value',
24207
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
24208
23895
  * returnPartialSuccess: 'placeholder-value',
24209
23896
  * },
24210
23897
  * );
@@ -24261,7 +23948,7 @@ export declare namespace discoveryengine_v1 {
24261
23948
  */
24262
23949
  pageToken?: string;
24263
23950
  /**
24264
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
24265
23952
  */
24266
23953
  returnPartialSuccess?: boolean;
24267
23954
  }
@@ -25438,26 +25125,352 @@ export declare namespace discoveryengine_v1 {
25438
25125
  * google.options({auth: authClient});
25439
25126
  *
25440
25127
  * // Do the magic
25441
- * const res = await discoveryengine.projects.locations.collections.engines.list(
25442
- * {
25443
- * // Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
25444
- * filter: 'placeholder-value',
25445
- * // Optional. Not supported.
25446
- * pageSize: 'placeholder-value',
25447
- * // Optional. Not supported.
25448
- * pageToken: 'placeholder-value',
25449
- * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`.
25450
- * parent:
25451
- * 'projects/my-project/locations/my-location/collections/my-collection',
25452
- * },
25453
- * );
25128
+ * const res = await discoveryengine.projects.locations.collections.engines.list(
25129
+ * {
25130
+ * // Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
25131
+ * filter: 'placeholder-value',
25132
+ * // Optional. Not supported.
25133
+ * pageSize: 'placeholder-value',
25134
+ * // Optional. Not supported.
25135
+ * pageToken: 'placeholder-value',
25136
+ * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`.
25137
+ * parent:
25138
+ * 'projects/my-project/locations/my-location/collections/my-collection',
25139
+ * },
25140
+ * );
25141
+ * console.log(res.data);
25142
+ *
25143
+ * // Example response
25144
+ * // {
25145
+ * // "engines": [],
25146
+ * // "nextPageToken": "my_nextPageToken"
25147
+ * // }
25148
+ * }
25149
+ *
25150
+ * main().catch(e => {
25151
+ * console.error(e);
25152
+ * throw e;
25153
+ * });
25154
+ *
25155
+ * ```
25156
+ *
25157
+ * @param params - Parameters for request
25158
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25159
+ * @param callback - Optional callback that handles the response.
25160
+ * @returns A promise if used with async/await, or void if used with a callback.
25161
+ */
25162
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25163
+ list(params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>>;
25164
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25165
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>): void;
25166
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>): void;
25167
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>): void;
25168
+ /**
25169
+ * Updates an Engine
25170
+ * @example
25171
+ * ```js
25172
+ * // Before running the sample:
25173
+ * // - Enable the API at:
25174
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25175
+ * // - Login into gcloud by running:
25176
+ * // ```sh
25177
+ * // $ gcloud auth application-default login
25178
+ * // ```
25179
+ * // - Install the npm module by running:
25180
+ * // ```sh
25181
+ * // $ npm install googleapis
25182
+ * // ```
25183
+ *
25184
+ * const {google} = require('googleapis');
25185
+ * const discoveryengine = google.discoveryengine('v1');
25186
+ *
25187
+ * async function main() {
25188
+ * const auth = new google.auth.GoogleAuth({
25189
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25190
+ * scopes: [
25191
+ * 'https://www.googleapis.com/auth/cloud-platform',
25192
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25193
+ * ],
25194
+ * });
25195
+ *
25196
+ * // Acquire an auth client, and bind it to all future calls
25197
+ * const authClient = await auth.getClient();
25198
+ * google.options({auth: authClient});
25199
+ *
25200
+ * // Do the magic
25201
+ * const res =
25202
+ * await discoveryengine.projects.locations.collections.engines.patch({
25203
+ * // 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.
25204
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
25205
+ * // Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
25206
+ * updateMask: 'placeholder-value',
25207
+ *
25208
+ * // Request body metadata
25209
+ * requestBody: {
25210
+ * // request body parameters
25211
+ * // {
25212
+ * // "appType": "my_appType",
25213
+ * // "chatEngineConfig": {},
25214
+ * // "chatEngineMetadata": {},
25215
+ * // "cmekConfig": {},
25216
+ * // "commonConfig": {},
25217
+ * // "configurableBillingApproach": "my_configurableBillingApproach",
25218
+ * // "createTime": "my_createTime",
25219
+ * // "dataStoreIds": [],
25220
+ * // "disableAnalytics": false,
25221
+ * // "displayName": "my_displayName",
25222
+ * // "features": {},
25223
+ * // "industryVertical": "my_industryVertical",
25224
+ * // "mediaRecommendationEngineConfig": {},
25225
+ * // "modelConfigs": {},
25226
+ * // "name": "my_name",
25227
+ * // "searchEngineConfig": {},
25228
+ * // "solutionType": "my_solutionType",
25229
+ * // "updateTime": "my_updateTime"
25230
+ * // }
25231
+ * },
25232
+ * });
25233
+ * console.log(res.data);
25234
+ *
25235
+ * // Example response
25236
+ * // {
25237
+ * // "appType": "my_appType",
25238
+ * // "chatEngineConfig": {},
25239
+ * // "chatEngineMetadata": {},
25240
+ * // "cmekConfig": {},
25241
+ * // "commonConfig": {},
25242
+ * // "configurableBillingApproach": "my_configurableBillingApproach",
25243
+ * // "createTime": "my_createTime",
25244
+ * // "dataStoreIds": [],
25245
+ * // "disableAnalytics": false,
25246
+ * // "displayName": "my_displayName",
25247
+ * // "features": {},
25248
+ * // "industryVertical": "my_industryVertical",
25249
+ * // "mediaRecommendationEngineConfig": {},
25250
+ * // "modelConfigs": {},
25251
+ * // "name": "my_name",
25252
+ * // "searchEngineConfig": {},
25253
+ * // "solutionType": "my_solutionType",
25254
+ * // "updateTime": "my_updateTime"
25255
+ * // }
25256
+ * }
25257
+ *
25258
+ * main().catch(e => {
25259
+ * console.error(e);
25260
+ * throw e;
25261
+ * });
25262
+ *
25263
+ * ```
25264
+ *
25265
+ * @param params - Parameters for request
25266
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25267
+ * @param callback - Optional callback that handles the response.
25268
+ * @returns A promise if used with async/await, or void if used with a callback.
25269
+ */
25270
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25271
+ patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Engine>>;
25272
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25273
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
25274
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
25275
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
25276
+ }
25277
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
25278
+ /**
25279
+ * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
25280
+ */
25281
+ engineId?: string;
25282
+ /**
25283
+ * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
25284
+ */
25285
+ parent?: string;
25286
+ /**
25287
+ * Request body metadata
25288
+ */
25289
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1Engine;
25290
+ }
25291
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Delete extends StandardParameters {
25292
+ /**
25293
+ * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
25294
+ */
25295
+ name?: string;
25296
+ }
25297
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Get extends StandardParameters {
25298
+ /**
25299
+ * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`.
25300
+ */
25301
+ name?: string;
25302
+ }
25303
+ export interface Params$Resource$Projects$Locations$Collections$Engines$List extends StandardParameters {
25304
+ /**
25305
+ * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
25306
+ */
25307
+ filter?: string;
25308
+ /**
25309
+ * Optional. Not supported.
25310
+ */
25311
+ pageSize?: number;
25312
+ /**
25313
+ * Optional. Not supported.
25314
+ */
25315
+ pageToken?: string;
25316
+ /**
25317
+ * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`.
25318
+ */
25319
+ parent?: string;
25320
+ }
25321
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters {
25322
+ /**
25323
+ * 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.
25324
+ */
25325
+ name?: string;
25326
+ /**
25327
+ * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
25328
+ */
25329
+ updateMask?: string;
25330
+ /**
25331
+ * Request body metadata
25332
+ */
25333
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1Engine;
25334
+ }
25335
+ export class Resource$Projects$Locations$Collections$Engines$Assistants {
25336
+ context: APIRequestContext;
25337
+ agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
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
+ * );
25454
25470
  * console.log(res.data);
25455
25471
  *
25456
25472
  * // Example response
25457
- * // {
25458
- * // "engines": [],
25459
- * // "nextPageToken": "my_nextPageToken"
25460
- * // }
25473
+ * // {}
25461
25474
  * }
25462
25475
  *
25463
25476
  * main().catch(e => {
@@ -25472,14 +25485,14 @@ export declare namespace discoveryengine_v1 {
25472
25485
  * @param callback - Optional callback that handles the response.
25473
25486
  * @returns A promise if used with async/await, or void if used with a callback.
25474
25487
  */
25475
- list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25476
- list(params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>>;
25477
- list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25478
- list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>): void;
25479
- list(params: Params$Resource$Projects$Locations$Collections$Engines$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>): void;
25480
- list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListEnginesResponse>): void;
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;
25481
25494
  /**
25482
- * Updates an Engine
25495
+ * Gets an Assistant.
25483
25496
  * @example
25484
25497
  * ```js
25485
25498
  * // Before running the sample:
@@ -25502,6 +25515,7 @@ export declare namespace discoveryengine_v1 {
25502
25515
  * // Scopes can be specified either as an array or as a single, space-delimited string.
25503
25516
  * scopes: [
25504
25517
  * 'https://www.googleapis.com/auth/cloud-platform',
25518
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
25505
25519
  * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25506
25520
  * ],
25507
25521
  * });
@@ -25512,59 +25526,23 @@ export declare namespace discoveryengine_v1 {
25512
25526
  *
25513
25527
  * // Do the magic
25514
25528
  * const res =
25515
- * await discoveryengine.projects.locations.collections.engines.patch({
25516
- * // 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.
25517
- * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
25518
- * // Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
25519
- * updateMask: 'placeholder-value',
25520
- *
25521
- * // Request body metadata
25522
- * requestBody: {
25523
- * // request body parameters
25524
- * // {
25525
- * // "appType": "my_appType",
25526
- * // "chatEngineConfig": {},
25527
- * // "chatEngineMetadata": {},
25528
- * // "cmekConfig": {},
25529
- * // "commonConfig": {},
25530
- * // "configurableBillingApproach": "my_configurableBillingApproach",
25531
- * // "createTime": "my_createTime",
25532
- * // "dataStoreIds": [],
25533
- * // "disableAnalytics": false,
25534
- * // "displayName": "my_displayName",
25535
- * // "features": {},
25536
- * // "industryVertical": "my_industryVertical",
25537
- * // "mediaRecommendationEngineConfig": {},
25538
- * // "modelConfigs": {},
25539
- * // "name": "my_name",
25540
- * // "searchEngineConfig": {},
25541
- * // "solutionType": "my_solutionType",
25542
- * // "updateTime": "my_updateTime"
25543
- * // }
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',
25544
25533
  * },
25545
- * });
25534
+ * );
25546
25535
  * console.log(res.data);
25547
25536
  *
25548
25537
  * // Example response
25549
25538
  * // {
25550
- * // "appType": "my_appType",
25551
- * // "chatEngineConfig": {},
25552
- * // "chatEngineMetadata": {},
25553
- * // "cmekConfig": {},
25554
- * // "commonConfig": {},
25555
- * // "configurableBillingApproach": "my_configurableBillingApproach",
25556
- * // "createTime": "my_createTime",
25557
- * // "dataStoreIds": [],
25558
- * // "disableAnalytics": false,
25539
+ * // "customerPolicy": {},
25540
+ * // "description": "my_description",
25559
25541
  * // "displayName": "my_displayName",
25560
- * // "features": {},
25561
- * // "industryVertical": "my_industryVertical",
25562
- * // "mediaRecommendationEngineConfig": {},
25563
- * // "modelConfigs": {},
25542
+ * // "enabledTools": {},
25543
+ * // "generationConfig": {},
25564
25544
  * // "name": "my_name",
25565
- * // "searchEngineConfig": {},
25566
- * // "solutionType": "my_solutionType",
25567
- * // "updateTime": "my_updateTime"
25545
+ * // "webGroundingType": "my_webGroundingType"
25568
25546
  * // }
25569
25547
  * }
25570
25548
  *
@@ -25580,76 +25558,14 @@ export declare namespace discoveryengine_v1 {
25580
25558
  * @param callback - Optional callback that handles the response.
25581
25559
  * @returns A promise if used with async/await, or void if used with a callback.
25582
25560
  */
25583
- patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25584
- patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Engine>>;
25585
- patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25586
- patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
25587
- patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
25588
- patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
25589
- }
25590
- export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
25591
- /**
25592
- * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
25593
- */
25594
- engineId?: string;
25595
- /**
25596
- * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
25597
- */
25598
- parent?: string;
25599
- /**
25600
- * Request body metadata
25601
- */
25602
- requestBody?: Schema$GoogleCloudDiscoveryengineV1Engine;
25603
- }
25604
- export interface Params$Resource$Projects$Locations$Collections$Engines$Delete extends StandardParameters {
25605
- /**
25606
- * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
25607
- */
25608
- name?: string;
25609
- }
25610
- export interface Params$Resource$Projects$Locations$Collections$Engines$Get extends StandardParameters {
25611
- /**
25612
- * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`.
25613
- */
25614
- name?: string;
25615
- }
25616
- export interface Params$Resource$Projects$Locations$Collections$Engines$List extends StandardParameters {
25617
- /**
25618
- * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
25619
- */
25620
- filter?: string;
25621
- /**
25622
- * Optional. Not supported.
25623
- */
25624
- pageSize?: number;
25625
- /**
25626
- * Optional. Not supported.
25627
- */
25628
- pageToken?: string;
25629
- /**
25630
- * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`.
25631
- */
25632
- parent?: string;
25633
- }
25634
- export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters {
25635
- /**
25636
- * 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.
25637
- */
25638
- name?: string;
25639
- /**
25640
- * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
25641
- */
25642
- updateMask?: string;
25643
- /**
25644
- * Request body metadata
25645
- */
25646
- requestBody?: Schema$GoogleCloudDiscoveryengineV1Engine;
25647
- }
25648
- export class Resource$Projects$Locations$Collections$Engines$Assistants {
25649
- context: APIRequestContext;
25650
- constructor(context: APIRequestContext);
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;
25651
25567
  /**
25652
- * Gets an Assistant.
25568
+ * Lists all Assistants under an Engine.
25653
25569
  * @example
25654
25570
  * ```js
25655
25571
  * // Before running the sample:
@@ -25683,21 +25599,23 @@ export declare namespace discoveryengine_v1 {
25683
25599
  *
25684
25600
  * // Do the magic
25685
25601
  * const res =
25686
- * await discoveryengine.projects.locations.collections.engines.assistants.get(
25602
+ * await discoveryengine.projects.locations.collections.engines.assistants.list(
25687
25603
  * {
25688
- * // Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
25689
- * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
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',
25690
25611
  * },
25691
25612
  * );
25692
25613
  * console.log(res.data);
25693
25614
  *
25694
25615
  * // Example response
25695
25616
  * // {
25696
- * // "customerPolicy": {},
25697
- * // "enabledTools": {},
25698
- * // "generationConfig": {},
25699
- * // "name": "my_name",
25700
- * // "webGroundingType": "my_webGroundingType"
25617
+ * // "assistants": [],
25618
+ * // "nextPageToken": "my_nextPageToken"
25701
25619
  * // }
25702
25620
  * }
25703
25621
  *
@@ -25713,12 +25631,12 @@ export declare namespace discoveryengine_v1 {
25713
25631
  * @param callback - Optional callback that handles the response.
25714
25632
  * @returns A promise if used with async/await, or void if used with a callback.
25715
25633
  */
25716
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25717
- get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1Assistant>>;
25718
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25719
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
25720
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
25721
- get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Assistant>): void;
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;
25722
25640
  /**
25723
25641
  * Updates an Assistant
25724
25642
  * @example
@@ -25766,6 +25684,8 @@ export declare namespace discoveryengine_v1 {
25766
25684
  * // request body parameters
25767
25685
  * // {
25768
25686
  * // "customerPolicy": {},
25687
+ * // "description": "my_description",
25688
+ * // "displayName": "my_displayName",
25769
25689
  * // "enabledTools": {},
25770
25690
  * // "generationConfig": {},
25771
25691
  * // "name": "my_name",
@@ -25779,6 +25699,8 @@ export declare namespace discoveryengine_v1 {
25779
25699
  * // Example response
25780
25700
  * // {
25781
25701
  * // "customerPolicy": {},
25702
+ * // "description": "my_description",
25703
+ * // "displayName": "my_displayName",
25782
25704
  * // "enabledTools": {},
25783
25705
  * // "generationConfig": {},
25784
25706
  * // "name": "my_name",
@@ -25863,6 +25785,7 @@ export declare namespace discoveryengine_v1 {
25863
25785
  * // {
25864
25786
  * // "answer": {},
25865
25787
  * // "assistToken": "my_assistToken",
25788
+ * // "invocationTools": [],
25866
25789
  * // "sessionInfo": {}
25867
25790
  * // }
25868
25791
  * }
@@ -25886,12 +25809,46 @@ export declare namespace discoveryengine_v1 {
25886
25809
  streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>): void;
25887
25810
  streamAssist(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1StreamAssistResponse>): void;
25888
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
+ }
25889
25832
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
25890
25833
  /**
25891
25834
  * Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
25892
25835
  */
25893
25836
  name?: string;
25894
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
+ }
25895
25852
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
25896
25853
  /**
25897
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.
@@ -25916,6 +25873,91 @@ export declare namespace discoveryengine_v1 {
25916
25873
  */
25917
25874
  requestBody?: Schema$GoogleCloudDiscoveryengineV1StreamAssistRequest;
25918
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
+ }
25919
25961
  export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
25920
25962
  context: APIRequestContext;
25921
25963
  constructor(context: APIRequestContext);
@@ -27208,7 +27250,7 @@ export declare namespace discoveryengine_v1 {
27208
27250
  * pageSize: 'placeholder-value',
27209
27251
  * // The standard list page token.
27210
27252
  * pageToken: 'placeholder-value',
27211
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
27212
27254
  * returnPartialSuccess: 'placeholder-value',
27213
27255
  * },
27214
27256
  * );
@@ -27275,7 +27317,7 @@ export declare namespace discoveryengine_v1 {
27275
27317
  */
27276
27318
  pageToken?: string;
27277
27319
  /**
27278
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
27279
27321
  */
27280
27322
  returnPartialSuccess?: boolean;
27281
27323
  }
@@ -27773,6 +27815,7 @@ export declare namespace discoveryengine_v1 {
27773
27815
  * // "branch": "my_branch",
27774
27816
  * // "canonicalFilter": "my_canonicalFilter",
27775
27817
  * // "contentSearchSpec": {},
27818
+ * // "crowdingSpecs": [],
27776
27819
  * // "dataStoreSpecs": [],
27777
27820
  * // "displaySpec": {},
27778
27821
  * // "facetSpecs": [],
@@ -27783,6 +27826,7 @@ export declare namespace discoveryengine_v1 {
27783
27826
  * // "offset": 0,
27784
27827
  * // "oneBoxPageSize": 0,
27785
27828
  * // "orderBy": "my_orderBy",
27829
+ * // "pageCategories": [],
27786
27830
  * // "pageSize": 0,
27787
27831
  * // "pageToken": "my_pageToken",
27788
27832
  * // "params": {},
@@ -27816,6 +27860,7 @@ export declare namespace discoveryengine_v1 {
27816
27860
  * // "redirectUri": "my_redirectUri",
27817
27861
  * // "results": [],
27818
27862
  * // "searchLinkPromotions": [],
27863
+ * // "semanticState": "my_semanticState",
27819
27864
  * // "sessionInfo": {},
27820
27865
  * // "summary": {},
27821
27866
  * // "totalSize": 0
@@ -27889,6 +27934,7 @@ export declare namespace discoveryengine_v1 {
27889
27934
  * // "branch": "my_branch",
27890
27935
  * // "canonicalFilter": "my_canonicalFilter",
27891
27936
  * // "contentSearchSpec": {},
27937
+ * // "crowdingSpecs": [],
27892
27938
  * // "dataStoreSpecs": [],
27893
27939
  * // "displaySpec": {},
27894
27940
  * // "facetSpecs": [],
@@ -27899,6 +27945,7 @@ export declare namespace discoveryengine_v1 {
27899
27945
  * // "offset": 0,
27900
27946
  * // "oneBoxPageSize": 0,
27901
27947
  * // "orderBy": "my_orderBy",
27948
+ * // "pageCategories": [],
27902
27949
  * // "pageSize": 0,
27903
27950
  * // "pageToken": "my_pageToken",
27904
27951
  * // "params": {},
@@ -27932,6 +27979,7 @@ export declare namespace discoveryengine_v1 {
27932
27979
  * // "redirectUri": "my_redirectUri",
27933
27980
  * // "results": [],
27934
27981
  * // "searchLinkPromotions": [],
27982
+ * // "semanticState": "my_semanticState",
27935
27983
  * // "sessionInfo": {},
27936
27984
  * // "summary": {},
27937
27985
  * // "totalSize": 0
@@ -29085,7 +29133,7 @@ export declare namespace discoveryengine_v1 {
29085
29133
  * pageSize: 'placeholder-value',
29086
29134
  * // The standard list page token.
29087
29135
  * pageToken: 'placeholder-value',
29088
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
29089
29137
  * returnPartialSuccess: 'placeholder-value',
29090
29138
  * });
29091
29139
  * console.log(res.data);
@@ -29141,7 +29189,7 @@ export declare namespace discoveryengine_v1 {
29141
29189
  */
29142
29190
  pageToken?: string;
29143
29191
  /**
29144
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
29145
29193
  */
29146
29194
  returnPartialSuccess?: boolean;
29147
29195
  }
@@ -30784,7 +30832,7 @@ export declare namespace discoveryengine_v1 {
30784
30832
  * pageSize: 'placeholder-value',
30785
30833
  * // The standard list page token.
30786
30834
  * pageToken: 'placeholder-value',
30787
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
30788
30836
  * returnPartialSuccess: 'placeholder-value',
30789
30837
  * },
30790
30838
  * );
@@ -30851,7 +30899,7 @@ export declare namespace discoveryengine_v1 {
30851
30899
  */
30852
30900
  pageToken?: string;
30853
30901
  /**
30854
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
30855
30903
  */
30856
30904
  returnPartialSuccess?: boolean;
30857
30905
  }
@@ -32246,7 +32294,7 @@ export declare namespace discoveryengine_v1 {
32246
32294
  * pageSize: 'placeholder-value',
32247
32295
  * // The standard list page token.
32248
32296
  * pageToken: 'placeholder-value',
32249
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
32250
32298
  * returnPartialSuccess: 'placeholder-value',
32251
32299
  * });
32252
32300
  * console.log(res.data);
@@ -32302,7 +32350,7 @@ export declare namespace discoveryengine_v1 {
32302
32350
  */
32303
32351
  pageToken?: string;
32304
32352
  /**
32305
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
32306
32354
  */
32307
32355
  returnPartialSuccess?: boolean;
32308
32356
  }
@@ -32420,7 +32468,7 @@ export declare namespace discoveryengine_v1 {
32420
32468
  * pageSize: 'placeholder-value',
32421
32469
  * // The standard list page token.
32422
32470
  * pageToken: 'placeholder-value',
32423
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
32424
32472
  * returnPartialSuccess: 'placeholder-value',
32425
32473
  * });
32426
32474
  * console.log(res.data);
@@ -32476,7 +32524,7 @@ export declare namespace discoveryengine_v1 {
32476
32524
  */
32477
32525
  pageToken?: string;
32478
32526
  /**
32479
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
32480
32528
  */
32481
32529
  returnPartialSuccess?: boolean;
32482
32530
  }
@@ -33386,6 +33434,7 @@ export declare namespace discoveryengine_v1 {
33386
33434
  * // "branch": "my_branch",
33387
33435
  * // "canonicalFilter": "my_canonicalFilter",
33388
33436
  * // "contentSearchSpec": {},
33437
+ * // "crowdingSpecs": [],
33389
33438
  * // "dataStoreSpecs": [],
33390
33439
  * // "displaySpec": {},
33391
33440
  * // "facetSpecs": [],
@@ -33396,6 +33445,7 @@ export declare namespace discoveryengine_v1 {
33396
33445
  * // "offset": 0,
33397
33446
  * // "oneBoxPageSize": 0,
33398
33447
  * // "orderBy": "my_orderBy",
33448
+ * // "pageCategories": [],
33399
33449
  * // "pageSize": 0,
33400
33450
  * // "pageToken": "my_pageToken",
33401
33451
  * // "params": {},
@@ -33428,6 +33478,7 @@ export declare namespace discoveryengine_v1 {
33428
33478
  * // "redirectUri": "my_redirectUri",
33429
33479
  * // "results": [],
33430
33480
  * // "searchLinkPromotions": [],
33481
+ * // "semanticState": "my_semanticState",
33431
33482
  * // "sessionInfo": {},
33432
33483
  * // "summary": {},
33433
33484
  * // "totalSize": 0
@@ -33501,6 +33552,7 @@ export declare namespace discoveryengine_v1 {
33501
33552
  * // "branch": "my_branch",
33502
33553
  * // "canonicalFilter": "my_canonicalFilter",
33503
33554
  * // "contentSearchSpec": {},
33555
+ * // "crowdingSpecs": [],
33504
33556
  * // "dataStoreSpecs": [],
33505
33557
  * // "displaySpec": {},
33506
33558
  * // "facetSpecs": [],
@@ -33511,6 +33563,7 @@ export declare namespace discoveryengine_v1 {
33511
33563
  * // "offset": 0,
33512
33564
  * // "oneBoxPageSize": 0,
33513
33565
  * // "orderBy": "my_orderBy",
33566
+ * // "pageCategories": [],
33514
33567
  * // "pageSize": 0,
33515
33568
  * // "pageToken": "my_pageToken",
33516
33569
  * // "params": {},
@@ -33544,6 +33597,7 @@ export declare namespace discoveryengine_v1 {
33544
33597
  * // "redirectUri": "my_redirectUri",
33545
33598
  * // "results": [],
33546
33599
  * // "searchLinkPromotions": [],
33600
+ * // "semanticState": "my_semanticState",
33547
33601
  * // "sessionInfo": {},
33548
33602
  * // "summary": {},
33549
33603
  * // "totalSize": 0
@@ -37026,7 +37080,7 @@ export declare namespace discoveryengine_v1 {
37026
37080
  * pageSize: 'placeholder-value',
37027
37081
  * // The standard list page token.
37028
37082
  * pageToken: 'placeholder-value',
37029
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
37030
37084
  * returnPartialSuccess: 'placeholder-value',
37031
37085
  * },
37032
37086
  * );
@@ -37083,7 +37137,7 @@ export declare namespace discoveryengine_v1 {
37083
37137
  */
37084
37138
  pageToken?: string;
37085
37139
  /**
37086
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
37087
37141
  */
37088
37142
  returnPartialSuccess?: boolean;
37089
37143
  }
@@ -37491,7 +37545,7 @@ export declare namespace discoveryengine_v1 {
37491
37545
  * pageSize: 'placeholder-value',
37492
37546
  * // The standard list page token.
37493
37547
  * pageToken: 'placeholder-value',
37494
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
37495
37549
  * returnPartialSuccess: 'placeholder-value',
37496
37550
  * });
37497
37551
  * console.log(res.data);
@@ -37547,7 +37601,7 @@ export declare namespace discoveryengine_v1 {
37547
37601
  */
37548
37602
  pageToken?: string;
37549
37603
  /**
37550
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
37551
37605
  */
37552
37606
  returnPartialSuccess?: boolean;
37553
37607
  }
@@ -38584,8 +38638,8 @@ export declare namespace discoveryengine_v1 {
38584
38638
  * // Do the magic
38585
38639
  * const res =
38586
38640
  * await discoveryengine.projects.locations.userStores.userLicenses.list({
38587
- * // Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
38588
- * filter: 'placeholder-value',
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',
38589
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.
38590
38644
  * pageSize: 'placeholder-value',
38591
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.
@@ -38624,9 +38678,9 @@ export declare namespace discoveryengine_v1 {
38624
38678
  }
38625
38679
  export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
38626
38680
  /**
38627
- * Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
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.
38628
38682
  */
38629
- filter?: string;
38683
+ orderBy?: string;
38630
38684
  /**
38631
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.
38632
38686
  */
@@ -38819,7 +38873,7 @@ export declare namespace discoveryengine_v1 {
38819
38873
  * pageSize: 'placeholder-value',
38820
38874
  * // The standard list page token.
38821
38875
  * pageToken: 'placeholder-value',
38822
- * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
38823
38877
  * returnPartialSuccess: 'placeholder-value',
38824
38878
  * });
38825
38879
  * console.log(res.data);
@@ -38885,7 +38939,7 @@ export declare namespace discoveryengine_v1 {
38885
38939
  */
38886
38940
  pageToken?: string;
38887
38941
  /**
38888
- * 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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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.
38889
38943
  */
38890
38944
  returnPartialSuccess?: boolean;
38891
38945
  }