@googleapis/discoveryengine 27.0.0 → 28.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/v1beta.d.ts CHANGED
@@ -67,341 +67,9 @@ export declare namespace discoveryengine_v1beta {
67
67
  */
68
68
  export class Discoveryengine {
69
69
  context: APIRequestContext;
70
- media: Resource$Media;
71
70
  projects: Resource$Projects;
72
71
  constructor(options: GlobalOptions, google?: GoogleConfigurable);
73
72
  }
74
- /**
75
- * Information to read/write to blobstore2.
76
- */
77
- export interface Schema$GdataBlobstore2Info {
78
- /**
79
- * The blob generation id.
80
- */
81
- blobGeneration?: string | null;
82
- /**
83
- * The blob id, e.g., /blobstore/prod/playground/scotty
84
- */
85
- blobId?: string | null;
86
- /**
87
- * Read handle passed from Bigstore -\> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
88
- */
89
- downloadReadHandle?: string | null;
90
- /**
91
- * The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
92
- */
93
- readToken?: string | null;
94
- /**
95
- * Metadata passed from Blobstore -\> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
96
- */
97
- uploadMetadataContainer?: string | null;
98
- }
99
- /**
100
- * A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
101
- */
102
- export interface Schema$GdataCompositeMedia {
103
- /**
104
- * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
105
- */
106
- blobRef?: string | null;
107
- /**
108
- * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
109
- */
110
- blobstore2Info?: Schema$GdataBlobstore2Info;
111
- /**
112
- * A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
113
- */
114
- cosmoBinaryReference?: string | null;
115
- /**
116
- * crc32.c hash for the payload.
117
- */
118
- crc32cHash?: number | null;
119
- /**
120
- * Media data, set if reference_type is INLINE
121
- */
122
- inline?: string | null;
123
- /**
124
- * Size of the data, in bytes
125
- */
126
- length?: string | null;
127
- /**
128
- * MD5 hash for the payload.
129
- */
130
- md5Hash?: string | null;
131
- /**
132
- * Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
133
- */
134
- objectId?: Schema$GdataObjectId;
135
- /**
136
- * Path to the data, set if reference_type is PATH
137
- */
138
- path?: string | null;
139
- /**
140
- * Describes what the field reference contains.
141
- */
142
- referenceType?: string | null;
143
- /**
144
- * SHA-1 hash for the payload.
145
- */
146
- sha1Hash?: string | null;
147
- }
148
- /**
149
- * Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
150
- */
151
- export interface Schema$GdataContentTypeInfo {
152
- /**
153
- * Scotty's best guess of what the content type of the file is.
154
- */
155
- bestGuess?: string | null;
156
- /**
157
- * The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
158
- */
159
- fromBytes?: string | null;
160
- /**
161
- * The content type of the file derived from the file extension of the original file name used by the client.
162
- */
163
- fromFileName?: string | null;
164
- /**
165
- * The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
166
- */
167
- fromHeader?: string | null;
168
- /**
169
- * The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
170
- */
171
- fromUrlPath?: string | null;
172
- }
173
- /**
174
- * Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
175
- */
176
- export interface Schema$GdataDiffChecksumsResponse {
177
- /**
178
- * Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
179
- */
180
- checksumsLocation?: Schema$GdataCompositeMedia;
181
- /**
182
- * The chunk size of checksums. Must be a multiple of 256KB.
183
- */
184
- chunkSizeBytes?: string | null;
185
- /**
186
- * If set, calculate the checksums based on the contents and return them to the caller.
187
- */
188
- objectLocation?: Schema$GdataCompositeMedia;
189
- /**
190
- * The total size of the server object.
191
- */
192
- objectSizeBytes?: string | null;
193
- /**
194
- * The object version of the object the checksums are being returned for.
195
- */
196
- objectVersion?: string | null;
197
- }
198
- /**
199
- * Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
200
- */
201
- export interface Schema$GdataDiffDownloadResponse {
202
- /**
203
- * The original object location.
204
- */
205
- objectLocation?: Schema$GdataCompositeMedia;
206
- }
207
- /**
208
- * A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
209
- */
210
- export interface Schema$GdataDiffUploadRequest {
211
- /**
212
- * The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
213
- */
214
- checksumsInfo?: Schema$GdataCompositeMedia;
215
- /**
216
- * The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
217
- */
218
- objectInfo?: Schema$GdataCompositeMedia;
219
- /**
220
- * The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
221
- */
222
- objectVersion?: string | null;
223
- }
224
- /**
225
- * Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
226
- */
227
- export interface Schema$GdataDiffUploadResponse {
228
- /**
229
- * The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
230
- */
231
- objectVersion?: string | null;
232
- /**
233
- * The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
234
- */
235
- originalObject?: Schema$GdataCompositeMedia;
236
- }
237
- /**
238
- * Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
239
- */
240
- export interface Schema$GdataDiffVersionResponse {
241
- /**
242
- * The total size of the server object.
243
- */
244
- objectSizeBytes?: string | null;
245
- /**
246
- * The version of the object stored at the server.
247
- */
248
- objectVersion?: string | null;
249
- }
250
- /**
251
- * Parameters specific to media downloads.
252
- */
253
- export interface Schema$GdataDownloadParameters {
254
- /**
255
- * A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
256
- */
257
- allowGzipCompression?: boolean | null;
258
- /**
259
- * Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
260
- */
261
- ignoreRange?: boolean | null;
262
- }
263
- /**
264
- * A reference to data stored on the filesystem, on GFS or in blobstore.
265
- */
266
- export interface Schema$GdataMedia {
267
- /**
268
- * Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
269
- */
270
- algorithm?: string | null;
271
- /**
272
- * Use object_id instead.
273
- */
274
- bigstoreObjectRef?: string | null;
275
- /**
276
- * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
277
- */
278
- blobRef?: string | null;
279
- /**
280
- * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
281
- */
282
- blobstore2Info?: Schema$GdataBlobstore2Info;
283
- /**
284
- * A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
285
- */
286
- compositeMedia?: Schema$GdataCompositeMedia[];
287
- /**
288
- * MIME type of the data
289
- */
290
- contentType?: string | null;
291
- /**
292
- * Extended content type information provided for Scotty uploads.
293
- */
294
- contentTypeInfo?: Schema$GdataContentTypeInfo;
295
- /**
296
- * A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
297
- */
298
- cosmoBinaryReference?: string | null;
299
- /**
300
- * For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
301
- */
302
- crc32cHash?: number | null;
303
- /**
304
- * Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
305
- */
306
- diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse;
307
- /**
308
- * Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
309
- */
310
- diffDownloadResponse?: Schema$GdataDiffDownloadResponse;
311
- /**
312
- * Set if reference_type is DIFF_UPLOAD_REQUEST.
313
- */
314
- diffUploadRequest?: Schema$GdataDiffUploadRequest;
315
- /**
316
- * Set if reference_type is DIFF_UPLOAD_RESPONSE.
317
- */
318
- diffUploadResponse?: Schema$GdataDiffUploadResponse;
319
- /**
320
- * Set if reference_type is DIFF_VERSION_RESPONSE.
321
- */
322
- diffVersionResponse?: Schema$GdataDiffVersionResponse;
323
- /**
324
- * Parameters for a media download.
325
- */
326
- downloadParameters?: Schema$GdataDownloadParameters;
327
- /**
328
- * Original file name
329
- */
330
- filename?: string | null;
331
- /**
332
- * Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
333
- */
334
- hash?: string | null;
335
- /**
336
- * For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
337
- */
338
- hashVerified?: boolean | null;
339
- /**
340
- * Media data, set if reference_type is INLINE
341
- */
342
- inline?: string | null;
343
- /**
344
- * |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
345
- */
346
- isPotentialRetry?: boolean | null;
347
- /**
348
- * Size of the data, in bytes
349
- */
350
- length?: string | null;
351
- /**
352
- * Scotty-provided MD5 hash for an upload.
353
- */
354
- md5Hash?: string | null;
355
- /**
356
- * Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
357
- */
358
- mediaId?: string | null;
359
- /**
360
- * Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
361
- */
362
- objectId?: Schema$GdataObjectId;
363
- /**
364
- * Path to the data, set if reference_type is PATH
365
- */
366
- path?: string | null;
367
- /**
368
- * Describes what the field reference contains.
369
- */
370
- referenceType?: string | null;
371
- /**
372
- * Scotty-provided SHA1 hash for an upload.
373
- */
374
- sha1Hash?: string | null;
375
- /**
376
- * Scotty-provided SHA256 hash for an upload.
377
- */
378
- sha256Hash?: string | null;
379
- /**
380
- * Time at which the media data was last updated, in milliseconds since UNIX epoch
381
- */
382
- timestamp?: string | null;
383
- /**
384
- * A unique fingerprint/version id for the media data
385
- */
386
- token?: string | null;
387
- }
388
- /**
389
- * This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
390
- */
391
- export interface Schema$GdataObjectId {
392
- /**
393
- * The name of the bucket to which this object belongs.
394
- */
395
- bucketName?: string | null;
396
- /**
397
- * Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
398
- */
399
- generation?: string | null;
400
- /**
401
- * The name of the object.
402
- */
403
- objectName?: string | null;
404
- }
405
73
  /**
406
74
  * `Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
407
75
  */
@@ -2888,6 +2556,10 @@ export declare namespace discoveryengine_v1beta {
2888
2556
  * Optional. If true, the LLM based annotation is added to the image during parsing.
2889
2557
  */
2890
2558
  enableImageAnnotation?: boolean | null;
2559
+ /**
2560
+ * Optional. If true, the pdf layout will be refined using an LLM.
2561
+ */
2562
+ enableLlmLayoutParsing?: boolean | null;
2891
2563
  /**
2892
2564
  * Optional. If true, the LLM based annotation is added to the table during parsing.
2893
2565
  */
@@ -2956,6 +2628,10 @@ export declare namespace discoveryengine_v1beta {
2956
2628
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
2957
2629
  */
2958
2630
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
2631
+ /**
2632
+ * Output only. CMEK-related information for the Engine.
2633
+ */
2634
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
2959
2635
  /**
2960
2636
  * Common config spec that specifies the metadata of the engine.
2961
2637
  */
@@ -2994,6 +2670,12 @@ export declare namespace discoveryengine_v1beta {
2994
2670
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
2995
2671
  */
2996
2672
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
2673
+ /**
2674
+ * Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
2675
+ */
2676
+ modelConfigs?: {
2677
+ [key: string]: string;
2678
+ } | null;
2997
2679
  /**
2998
2680
  * 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.
2999
2681
  */
@@ -3173,6 +2855,10 @@ export declare namespace discoveryengine_v1beta {
3173
2855
  * Configurations for a Search Engine.
3174
2856
  */
3175
2857
  export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
2858
+ /**
2859
+ * Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
2860
+ */
2861
+ requiredSubscriptionTier?: string | null;
3176
2862
  /**
3177
2863
  * The add-on that this search engine enables.
3178
2864
  */
@@ -4313,6 +3999,10 @@ export declare namespace discoveryengine_v1beta {
4313
3999
  * A specification for configuring the behavior of content search.
4314
4000
  */
4315
4001
  contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
4002
+ /**
4003
+ * Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
4004
+ */
4005
+ crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
4316
4006
  /**
4317
4007
  * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
4318
4008
  */
@@ -4361,6 +4051,10 @@ export declare namespace discoveryengine_v1beta {
4361
4051
  * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
4362
4052
  */
4363
4053
  orderBy?: string | null;
4054
+ /**
4055
+ * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
4056
+ */
4057
+ pageCategories?: string[] | null;
4364
4058
  /**
4365
4059
  * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
4366
4060
  */
@@ -4670,6 +4364,23 @@ export declare namespace discoveryengine_v1beta {
4670
4364
  */
4671
4365
  imageSource?: string | null;
4672
4366
  }
4367
+ /**
4368
+ * Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
4369
+ */
4370
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec {
4371
+ /**
4372
+ * The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
4373
+ */
4374
+ field?: string | null;
4375
+ /**
4376
+ * The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
4377
+ */
4378
+ maxCount?: number | null;
4379
+ /**
4380
+ * Mode to use for documents that are crowded away.
4381
+ */
4382
+ mode?: string | null;
4383
+ }
4673
4384
  /**
4674
4385
  * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
4675
4386
  */
@@ -5365,6 +5076,14 @@ export declare namespace discoveryengine_v1beta {
5365
5076
  * Optional. Customer policy for the assistant.
5366
5077
  */
5367
5078
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
5079
+ /**
5080
+ * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
5081
+ */
5082
+ description?: string | null;
5083
+ /**
5084
+ * Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
5085
+ */
5086
+ displayName?: string | null;
5368
5087
  /**
5369
5088
  * Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId\}/locations/{locationId\}/collections/{collectionId\}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] \}
5370
5089
  */
@@ -5435,10 +5154,18 @@ export declare namespace discoveryengine_v1beta {
5435
5154
  * Configuration for the generation of the assistant response.
5436
5155
  */
5437
5156
  export interface Schema$GoogleCloudDiscoveryengineV1AssistantGenerationConfig {
5157
+ /**
5158
+ * Optional. The list of models that are allowed to be used for assistant.
5159
+ */
5160
+ allowedModelIds?: string[] | null;
5438
5161
  /**
5439
5162
  * The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.
5440
5163
  */
5441
5164
  defaultLanguage?: string | null;
5165
+ /**
5166
+ * Optional. The default model to use for assistant.
5167
+ */
5168
+ defaultModelId?: string | null;
5442
5169
  /**
5443
5170
  * System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
5444
5171
  */
@@ -6800,6 +6527,14 @@ export declare namespace discoveryengine_v1beta {
6800
6527
  * Optional. Customer policy for the assistant.
6801
6528
  */
6802
6529
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy;
6530
+ /**
6531
+ * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
6532
+ */
6533
+ description?: string | null;
6534
+ /**
6535
+ * Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
6536
+ */
6537
+ displayName?: string | null;
6803
6538
  /**
6804
6539
  * Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId\}/locations/{locationId\}/collections/{collectionId\}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] \}
6805
6540
  */
@@ -6951,10 +6686,18 @@ export declare namespace discoveryengine_v1beta {
6951
6686
  * Configuration for the generation of the assistant response.
6952
6687
  */
6953
6688
  export interface Schema$GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig {
6689
+ /**
6690
+ * Optional. The list of models that are allowed to be used for assistant.
6691
+ */
6692
+ allowedModelIds?: string[] | null;
6954
6693
  /**
6955
6694
  * The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.
6956
6695
  */
6957
6696
  defaultLanguage?: string | null;
6697
+ /**
6698
+ * Optional. The default model to use for assistant.
6699
+ */
6700
+ defaultModelId?: string | null;
6958
6701
  /**
6959
6702
  * System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
6960
6703
  */
@@ -8680,6 +8423,10 @@ export declare namespace discoveryengine_v1beta {
8680
8423
  * Optional. If true, the LLM based annotation is added to the image during parsing.
8681
8424
  */
8682
8425
  enableImageAnnotation?: boolean | null;
8426
+ /**
8427
+ * Optional. If true, the pdf layout will be refined using an LLM.
8428
+ */
8429
+ enableLlmLayoutParsing?: boolean | null;
8683
8430
  /**
8684
8431
  * Optional. If true, the LLM based annotation is added to the table during parsing.
8685
8432
  */
@@ -8771,6 +8518,10 @@ export declare namespace discoveryengine_v1beta {
8771
8518
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
8772
8519
  */
8773
8520
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
8521
+ /**
8522
+ * Output only. CMEK-related information for the Engine.
8523
+ */
8524
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
8774
8525
  /**
8775
8526
  * Common config spec that specifies the metadata of the engine.
8776
8527
  */
@@ -8809,6 +8560,12 @@ export declare namespace discoveryengine_v1beta {
8809
8560
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
8810
8561
  */
8811
8562
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
8563
+ /**
8564
+ * Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
8565
+ */
8566
+ modelConfigs?: {
8567
+ [key: string]: string;
8568
+ } | null;
8812
8569
  /**
8813
8570
  * 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.
8814
8571
  */
@@ -8955,6 +8712,10 @@ export declare namespace discoveryengine_v1beta {
8955
8712
  * Configurations for a Search Engine.
8956
8713
  */
8957
8714
  export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
8715
+ /**
8716
+ * Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
8717
+ */
8718
+ requiredSubscriptionTier?: string | null;
8958
8719
  /**
8959
8720
  * The add-on that this search engine enables.
8960
8721
  */
@@ -9184,6 +8945,10 @@ export declare namespace discoveryengine_v1beta {
9184
8945
  * Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.
9185
8946
  */
9186
8947
  externalIdentity?: string | null;
8948
+ /**
8949
+ * Optional. The name of the external identity.
8950
+ */
8951
+ externalIdentityName?: string | null;
9187
8952
  /**
9188
8953
  * Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.
9189
8954
  */
@@ -9740,6 +9505,32 @@ export declare namespace discoveryengine_v1beta {
9740
9505
  */
9741
9506
  subscriptionTier?: string | null;
9742
9507
  }
9508
+ /**
9509
+ * Stats about users' licenses.
9510
+ */
9511
+ export interface Schema$GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats {
9512
+ /**
9513
+ * Required. The LicenseConfig name.
9514
+ */
9515
+ licenseConfig?: string | null;
9516
+ /**
9517
+ * Required. The number of licenses used.
9518
+ */
9519
+ usedLicenseCount?: string | null;
9520
+ }
9521
+ /**
9522
+ * Response message for the AssistantService.ListAssistants method.
9523
+ */
9524
+ export interface Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse {
9525
+ /**
9526
+ * All the customer's Assistants.
9527
+ */
9528
+ assistants?: Schema$GoogleCloudDiscoveryengineV1betaAssistant[];
9529
+ /**
9530
+ * A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
9531
+ */
9532
+ nextPageToken?: string | null;
9533
+ }
9743
9534
  /**
9744
9535
  * Response message for CmekConfigService.ListCmekConfigs method.
9745
9536
  */
@@ -9888,6 +9679,15 @@ export declare namespace discoveryengine_v1beta {
9888
9679
  */
9889
9680
  nextPageToken?: string | null;
9890
9681
  }
9682
+ /**
9683
+ * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
9684
+ */
9685
+ export interface Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse {
9686
+ /**
9687
+ * All the customer's LicenseConfigUsageStats.
9688
+ */
9689
+ licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats[];
9690
+ }
9891
9691
  /**
9892
9692
  * Response message for SampleQueryService.ListSampleQueries method.
9893
9693
  */
@@ -10911,6 +10711,10 @@ export declare namespace discoveryengine_v1beta {
10911
10711
  * A specification for configuring the behavior of content search.
10912
10712
  */
10913
10713
  contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
10714
+ /**
10715
+ * Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
10716
+ */
10717
+ crowdingSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
10914
10718
  /**
10915
10719
  * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.
10916
10720
  */
@@ -10955,6 +10759,10 @@ export declare namespace discoveryengine_v1beta {
10955
10759
  * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
10956
10760
  */
10957
10761
  orderBy?: string | null;
10762
+ /**
10763
+ * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
10764
+ */
10765
+ pageCategories?: string[] | null;
10958
10766
  /**
10959
10767
  * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
10960
10768
  */
@@ -11260,6 +11068,23 @@ export declare namespace discoveryengine_v1beta {
11260
11068
  */
11261
11069
  imageSource?: string | null;
11262
11070
  }
11071
+ /**
11072
+ * Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.
11073
+ */
11074
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec {
11075
+ /**
11076
+ * The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.
11077
+ */
11078
+ field?: string | null;
11079
+ /**
11080
+ * The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
11081
+ */
11082
+ maxCount?: number | null;
11083
+ /**
11084
+ * Mode to use for documents that are crowded away.
11085
+ */
11086
+ mode?: string | null;
11087
+ }
11263
11088
  /**
11264
11089
  * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
11265
11090
  */
@@ -11528,6 +11353,10 @@ export declare namespace discoveryengine_v1beta {
11528
11353
  * Promotions for site search.
11529
11354
  */
11530
11355
  searchLinkPromotions?: Schema$GoogleCloudDiscoveryengineV1betaSearchLinkPromotion[];
11356
+ /**
11357
+ * Output only. Indicates the semantic state of the search response.
11358
+ */
11359
+ semanticState?: string | null;
11531
11360
  /**
11532
11361
  * Session information. Only set if SearchRequest.session is provided. See its description for more details.
11533
11362
  */
@@ -12438,6 +12267,10 @@ export declare namespace discoveryengine_v1beta {
12438
12267
  * A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
12439
12268
  */
12440
12269
  assistToken?: string | null;
12270
+ /**
12271
+ * The tool names of the tools that were invoked.
12272
+ */
12273
+ invocationTools?: string[] | null;
12441
12274
  /**
12442
12275
  * Session information. Only included in the final StreamAssistResponse of the response stream.
12443
12276
  */
@@ -13842,6 +13675,10 @@ export declare namespace discoveryengine_v1beta {
13842
13675
  * Optional. If true, the LLM based annotation is added to the image during parsing.
13843
13676
  */
13844
13677
  enableImageAnnotation?: boolean | null;
13678
+ /**
13679
+ * Optional. If true, the pdf layout will be refined using an LLM.
13680
+ */
13681
+ enableLlmLayoutParsing?: boolean | null;
13845
13682
  /**
13846
13683
  * Optional. If true, the LLM based annotation is added to the table during parsing.
13847
13684
  */
@@ -13910,6 +13747,10 @@ export declare namespace discoveryengine_v1beta {
13910
13747
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
13911
13748
  */
13912
13749
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
13750
+ /**
13751
+ * Output only. CMEK-related information for the Engine.
13752
+ */
13753
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
13913
13754
  /**
13914
13755
  * Common config spec that specifies the metadata of the engine.
13915
13756
  */
@@ -13948,6 +13789,12 @@ export declare namespace discoveryengine_v1beta {
13948
13789
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
13949
13790
  */
13950
13791
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
13792
+ /**
13793
+ * Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
13794
+ */
13795
+ modelConfigs?: {
13796
+ [key: string]: string;
13797
+ } | null;
13951
13798
  /**
13952
13799
  * 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.
13953
13800
  */
@@ -14094,6 +13941,10 @@ export declare namespace discoveryengine_v1beta {
14094
13941
  * Configurations for a Search Engine.
14095
13942
  */
14096
13943
  export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
13944
+ /**
13945
+ * 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.
13946
+ */
13947
+ requiredSubscriptionTier?: string | null;
14097
13948
  /**
14098
13949
  * The add-on that this search engine enables.
14099
13950
  */
@@ -15188,7 +15039,7 @@ export declare namespace discoveryengine_v1beta {
15188
15039
  */
15189
15040
  operations?: Schema$GoogleLongrunningOperation[];
15190
15041
  /**
15191
- * 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.
15042
+ * 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.
15192
15043
  */
15193
15044
  unreachable?: string[] | null;
15194
15045
  }
@@ -15404,121 +15255,6 @@ export declare namespace discoveryengine_v1beta {
15404
15255
  */
15405
15256
  version?: string | null;
15406
15257
  }
15407
- export class Resource$Media {
15408
- context: APIRequestContext;
15409
- constructor(context: APIRequestContext);
15410
- /**
15411
- * Downloads a file from the session.
15412
- * @example
15413
- * ```js
15414
- * // Before running the sample:
15415
- * // - Enable the API at:
15416
- * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
15417
- * // - Login into gcloud by running:
15418
- * // ```sh
15419
- * // $ gcloud auth application-default login
15420
- * // ```
15421
- * // - Install the npm module by running:
15422
- * // ```sh
15423
- * // $ npm install googleapis
15424
- * // ```
15425
- *
15426
- * const {google} = require('googleapis');
15427
- * const discoveryengine = google.discoveryengine('v1beta');
15428
- *
15429
- * async function main() {
15430
- * const auth = new google.auth.GoogleAuth({
15431
- * // Scopes can be specified either as an array or as a single, space-delimited string.
15432
- * scopes: [
15433
- * 'https://www.googleapis.com/auth/cloud-platform',
15434
- * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
15435
- * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
15436
- * ],
15437
- * });
15438
- *
15439
- * // Acquire an auth client, and bind it to all future calls
15440
- * const authClient = await auth.getClient();
15441
- * google.options({auth: authClient});
15442
- *
15443
- * // Do the magic
15444
- * const res = await discoveryengine.media.download({
15445
- * // Required. The ID of the file to be downloaded.
15446
- * fileId: 'placeholder-value',
15447
- * // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
15448
- * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
15449
- * // Optional. The ID of the view to be downloaded.
15450
- * viewId: 'placeholder-value',
15451
- * });
15452
- * console.log(res.data);
15453
- *
15454
- * // Example response
15455
- * // {
15456
- * // "algorithm": "my_algorithm",
15457
- * // "bigstoreObjectRef": "my_bigstoreObjectRef",
15458
- * // "blobRef": "my_blobRef",
15459
- * // "blobstore2Info": {},
15460
- * // "compositeMedia": [],
15461
- * // "contentType": "my_contentType",
15462
- * // "contentTypeInfo": {},
15463
- * // "cosmoBinaryReference": "my_cosmoBinaryReference",
15464
- * // "crc32cHash": 0,
15465
- * // "diffChecksumsResponse": {},
15466
- * // "diffDownloadResponse": {},
15467
- * // "diffUploadRequest": {},
15468
- * // "diffUploadResponse": {},
15469
- * // "diffVersionResponse": {},
15470
- * // "downloadParameters": {},
15471
- * // "filename": "my_filename",
15472
- * // "hash": "my_hash",
15473
- * // "hashVerified": false,
15474
- * // "inline": "my_inline",
15475
- * // "isPotentialRetry": false,
15476
- * // "length": "my_length",
15477
- * // "md5Hash": "my_md5Hash",
15478
- * // "mediaId": "my_mediaId",
15479
- * // "objectId": {},
15480
- * // "path": "my_path",
15481
- * // "referenceType": "my_referenceType",
15482
- * // "sha1Hash": "my_sha1Hash",
15483
- * // "sha256Hash": "my_sha256Hash",
15484
- * // "timestamp": "my_timestamp",
15485
- * // "token": "my_token"
15486
- * // }
15487
- * }
15488
- *
15489
- * main().catch(e => {
15490
- * console.error(e);
15491
- * throw e;
15492
- * });
15493
- *
15494
- * ```
15495
- *
15496
- * @param params - Parameters for request
15497
- * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
15498
- * @param callback - Optional callback that handles the response.
15499
- * @returns A promise if used with async/await, or void if used with a callback.
15500
- */
15501
- download(params: Params$Resource$Media$Download, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
15502
- download(params?: Params$Resource$Media$Download, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GdataMedia>>;
15503
- download(params: Params$Resource$Media$Download, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
15504
- download(params: Params$Resource$Media$Download, options: MethodOptions | BodyResponseCallback<Schema$GdataMedia>, callback: BodyResponseCallback<Schema$GdataMedia>): void;
15505
- download(params: Params$Resource$Media$Download, callback: BodyResponseCallback<Schema$GdataMedia>): void;
15506
- download(callback: BodyResponseCallback<Schema$GdataMedia>): void;
15507
- }
15508
- export interface Params$Resource$Media$Download extends StandardParameters {
15509
- /**
15510
- * Required. The ID of the file to be downloaded.
15511
- */
15512
- fileId?: string;
15513
- /**
15514
- * Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
15515
- */
15516
- name?: string;
15517
- /**
15518
- * Optional. The ID of the view to be downloaded.
15519
- */
15520
- viewId?: string;
15521
- }
15522
15258
  export class Resource$Projects {
15523
15259
  context: APIRequestContext;
15524
15260
  locations: Resource$Projects$Locations;
@@ -16665,7 +16401,7 @@ export declare namespace discoveryengine_v1beta {
16665
16401
  * pageSize: 'placeholder-value',
16666
16402
  * // The standard list page token.
16667
16403
  * pageToken: 'placeholder-value',
16668
- * // 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.
16404
+ * // 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.
16669
16405
  * returnPartialSuccess: 'placeholder-value',
16670
16406
  * },
16671
16407
  * );
@@ -16722,7 +16458,7 @@ export declare namespace discoveryengine_v1beta {
16722
16458
  */
16723
16459
  pageToken?: string;
16724
16460
  /**
16725
- * 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.
16461
+ * 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.
16726
16462
  */
16727
16463
  returnPartialSuccess?: boolean;
16728
16464
  }
@@ -18477,7 +18213,7 @@ export declare namespace discoveryengine_v1beta {
18477
18213
  * pageSize: 'placeholder-value',
18478
18214
  * // The standard list page token.
18479
18215
  * pageToken: 'placeholder-value',
18480
- * // 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.
18216
+ * // 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.
18481
18217
  * returnPartialSuccess: 'placeholder-value',
18482
18218
  * },
18483
18219
  * );
@@ -18544,7 +18280,7 @@ export declare namespace discoveryengine_v1beta {
18544
18280
  */
18545
18281
  pageToken?: string;
18546
18282
  /**
18547
- * 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.
18283
+ * 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.
18548
18284
  */
18549
18285
  returnPartialSuccess?: boolean;
18550
18286
  }
@@ -20042,7 +19778,7 @@ export declare namespace discoveryengine_v1beta {
20042
19778
  * pageSize: 'placeholder-value',
20043
19779
  * // The standard list page token.
20044
19780
  * pageToken: 'placeholder-value',
20045
- * // 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.
19781
+ * // 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.
20046
19782
  * returnPartialSuccess: 'placeholder-value',
20047
19783
  * },
20048
19784
  * );
@@ -20099,7 +19835,7 @@ export declare namespace discoveryengine_v1beta {
20099
19835
  */
20100
19836
  pageToken?: string;
20101
19837
  /**
20102
- * 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.
19838
+ * 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.
20103
19839
  */
20104
19840
  returnPartialSuccess?: boolean;
20105
19841
  }
@@ -20220,7 +19956,7 @@ export declare namespace discoveryengine_v1beta {
20220
19956
  * pageSize: 'placeholder-value',
20221
19957
  * // The standard list page token.
20222
19958
  * pageToken: 'placeholder-value',
20223
- * // 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.
19959
+ * // 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.
20224
19960
  * returnPartialSuccess: 'placeholder-value',
20225
19961
  * },
20226
19962
  * );
@@ -20277,7 +20013,7 @@ export declare namespace discoveryengine_v1beta {
20277
20013
  */
20278
20014
  pageToken?: string;
20279
20015
  /**
20280
- * 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.
20016
+ * 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.
20281
20017
  */
20282
20018
  returnPartialSuccess?: boolean;
20283
20019
  }
@@ -20832,7 +20568,7 @@ export declare namespace discoveryengine_v1beta {
20832
20568
  * pageSize: 'placeholder-value',
20833
20569
  * // The standard list page token.
20834
20570
  * pageToken: 'placeholder-value',
20835
- * // 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.
20571
+ * // 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.
20836
20572
  * returnPartialSuccess: 'placeholder-value',
20837
20573
  * },
20838
20574
  * );
@@ -20889,7 +20625,7 @@ export declare namespace discoveryengine_v1beta {
20889
20625
  */
20890
20626
  pageToken?: string;
20891
20627
  /**
20892
- * 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.
20628
+ * 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.
20893
20629
  */
20894
20630
  returnPartialSuccess?: boolean;
20895
20631
  }
@@ -21393,6 +21129,7 @@ export declare namespace discoveryengine_v1beta {
21393
21129
  * // "branch": "my_branch",
21394
21130
  * // "canonicalFilter": "my_canonicalFilter",
21395
21131
  * // "contentSearchSpec": {},
21132
+ * // "crowdingSpecs": [],
21396
21133
  * // "dataStoreSpecs": [],
21397
21134
  * // "displaySpec": {},
21398
21135
  * // "embeddingSpec": {},
@@ -21404,6 +21141,7 @@ export declare namespace discoveryengine_v1beta {
21404
21141
  * // "offset": 0,
21405
21142
  * // "oneBoxPageSize": 0,
21406
21143
  * // "orderBy": "my_orderBy",
21144
+ * // "pageCategories": [],
21407
21145
  * // "pageSize": 0,
21408
21146
  * // "pageToken": "my_pageToken",
21409
21147
  * // "params": {},
@@ -21446,6 +21184,7 @@ export declare namespace discoveryengine_v1beta {
21446
21184
  * // "redirectUri": "my_redirectUri",
21447
21185
  * // "results": [],
21448
21186
  * // "searchLinkPromotions": [],
21187
+ * // "semanticState": "my_semanticState",
21449
21188
  * // "sessionInfo": {},
21450
21189
  * // "suggestedQuery": "my_suggestedQuery",
21451
21190
  * // "summary": {},
@@ -21520,6 +21259,7 @@ export declare namespace discoveryengine_v1beta {
21520
21259
  * // "branch": "my_branch",
21521
21260
  * // "canonicalFilter": "my_canonicalFilter",
21522
21261
  * // "contentSearchSpec": {},
21262
+ * // "crowdingSpecs": [],
21523
21263
  * // "dataStoreSpecs": [],
21524
21264
  * // "displaySpec": {},
21525
21265
  * // "embeddingSpec": {},
@@ -21531,6 +21271,7 @@ export declare namespace discoveryengine_v1beta {
21531
21271
  * // "offset": 0,
21532
21272
  * // "oneBoxPageSize": 0,
21533
21273
  * // "orderBy": "my_orderBy",
21274
+ * // "pageCategories": [],
21534
21275
  * // "pageSize": 0,
21535
21276
  * // "pageToken": "my_pageToken",
21536
21277
  * // "params": {},
@@ -21573,6 +21314,7 @@ export declare namespace discoveryengine_v1beta {
21573
21314
  * // "redirectUri": "my_redirectUri",
21574
21315
  * // "results": [],
21575
21316
  * // "searchLinkPromotions": [],
21317
+ * // "semanticState": "my_semanticState",
21576
21318
  * // "sessionInfo": {},
21577
21319
  * // "suggestedQuery": "my_suggestedQuery",
21578
21320
  * // "summary": {},
@@ -22894,7 +22636,7 @@ export declare namespace discoveryengine_v1beta {
22894
22636
  * pageSize: 'placeholder-value',
22895
22637
  * // The standard list page token.
22896
22638
  * pageToken: 'placeholder-value',
22897
- * // 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.
22639
+ * // 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.
22898
22640
  * returnPartialSuccess: 'placeholder-value',
22899
22641
  * },
22900
22642
  * );
@@ -22951,7 +22693,7 @@ export declare namespace discoveryengine_v1beta {
22951
22693
  */
22952
22694
  pageToken?: string;
22953
22695
  /**
22954
- * 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.
22696
+ * 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.
22955
22697
  */
22956
22698
  returnPartialSuccess?: boolean;
22957
22699
  }
@@ -23855,7 +23597,7 @@ export declare namespace discoveryengine_v1beta {
23855
23597
  * pageSize: 'placeholder-value',
23856
23598
  * // The standard list page token.
23857
23599
  * pageToken: 'placeholder-value',
23858
- * // 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.
23600
+ * // 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.
23859
23601
  * returnPartialSuccess: 'placeholder-value',
23860
23602
  * },
23861
23603
  * );
@@ -23912,7 +23654,7 @@ export declare namespace discoveryengine_v1beta {
23912
23654
  */
23913
23655
  pageToken?: string;
23914
23656
  /**
23915
- * 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.
23657
+ * 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.
23916
23658
  */
23917
23659
  returnPartialSuccess?: boolean;
23918
23660
  }
@@ -24573,6 +24315,7 @@ export declare namespace discoveryengine_v1beta {
24573
24315
  * // "appType": "my_appType",
24574
24316
  * // "chatEngineConfig": {},
24575
24317
  * // "chatEngineMetadata": {},
24318
+ * // "cmekConfig": {},
24576
24319
  * // "commonConfig": {},
24577
24320
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24578
24321
  * // "createTime": "my_createTime",
@@ -24582,6 +24325,7 @@ export declare namespace discoveryengine_v1beta {
24582
24325
  * // "features": {},
24583
24326
  * // "industryVertical": "my_industryVertical",
24584
24327
  * // "mediaRecommendationEngineConfig": {},
24328
+ * // "modelConfigs": {},
24585
24329
  * // "name": "my_name",
24586
24330
  * // "searchEngineConfig": {},
24587
24331
  * // "solutionType": "my_solutionType",
@@ -24731,6 +24475,7 @@ export declare namespace discoveryengine_v1beta {
24731
24475
  * // "appType": "my_appType",
24732
24476
  * // "chatEngineConfig": {},
24733
24477
  * // "chatEngineMetadata": {},
24478
+ * // "cmekConfig": {},
24734
24479
  * // "commonConfig": {},
24735
24480
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24736
24481
  * // "createTime": "my_createTime",
@@ -24740,6 +24485,7 @@ export declare namespace discoveryengine_v1beta {
24740
24485
  * // "features": {},
24741
24486
  * // "industryVertical": "my_industryVertical",
24742
24487
  * // "mediaRecommendationEngineConfig": {},
24488
+ * // "modelConfigs": {},
24743
24489
  * // "name": "my_name",
24744
24490
  * // "searchEngineConfig": {},
24745
24491
  * // "solutionType": "my_solutionType",
@@ -24885,6 +24631,7 @@ export declare namespace discoveryengine_v1beta {
24885
24631
  * // "appType": "my_appType",
24886
24632
  * // "chatEngineConfig": {},
24887
24633
  * // "chatEngineMetadata": {},
24634
+ * // "cmekConfig": {},
24888
24635
  * // "commonConfig": {},
24889
24636
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24890
24637
  * // "createTime": "my_createTime",
@@ -24894,6 +24641,7 @@ export declare namespace discoveryengine_v1beta {
24894
24641
  * // "features": {},
24895
24642
  * // "industryVertical": "my_industryVertical",
24896
24643
  * // "mediaRecommendationEngineConfig": {},
24644
+ * // "modelConfigs": {},
24897
24645
  * // "name": "my_name",
24898
24646
  * // "searchEngineConfig": {},
24899
24647
  * // "solutionType": "my_solutionType",
@@ -24908,6 +24656,7 @@ export declare namespace discoveryengine_v1beta {
24908
24656
  * // "appType": "my_appType",
24909
24657
  * // "chatEngineConfig": {},
24910
24658
  * // "chatEngineMetadata": {},
24659
+ * // "cmekConfig": {},
24911
24660
  * // "commonConfig": {},
24912
24661
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24913
24662
  * // "createTime": "my_createTime",
@@ -24917,6 +24666,7 @@ export declare namespace discoveryengine_v1beta {
24917
24666
  * // "features": {},
24918
24667
  * // "industryVertical": "my_industryVertical",
24919
24668
  * // "mediaRecommendationEngineConfig": {},
24669
+ * // "modelConfigs": {},
24920
24670
  * // "name": "my_name",
24921
24671
  * // "searchEngineConfig": {},
24922
24672
  * // "solutionType": "my_solutionType",
@@ -24993,6 +24743,7 @@ export declare namespace discoveryengine_v1beta {
24993
24743
  * // "appType": "my_appType",
24994
24744
  * // "chatEngineConfig": {},
24995
24745
  * // "chatEngineMetadata": {},
24746
+ * // "cmekConfig": {},
24996
24747
  * // "commonConfig": {},
24997
24748
  * // "configurableBillingApproach": "my_configurableBillingApproach",
24998
24749
  * // "createTime": "my_createTime",
@@ -25002,6 +24753,7 @@ export declare namespace discoveryengine_v1beta {
25002
24753
  * // "features": {},
25003
24754
  * // "industryVertical": "my_industryVertical",
25004
24755
  * // "mediaRecommendationEngineConfig": {},
24756
+ * // "modelConfigs": {},
25005
24757
  * // "name": "my_name",
25006
24758
  * // "searchEngineConfig": {},
25007
24759
  * // "solutionType": "my_solutionType",
@@ -25078,6 +24830,7 @@ export declare namespace discoveryengine_v1beta {
25078
24830
  * // "appType": "my_appType",
25079
24831
  * // "chatEngineConfig": {},
25080
24832
  * // "chatEngineMetadata": {},
24833
+ * // "cmekConfig": {},
25081
24834
  * // "commonConfig": {},
25082
24835
  * // "configurableBillingApproach": "my_configurableBillingApproach",
25083
24836
  * // "createTime": "my_createTime",
@@ -25087,6 +24840,7 @@ export declare namespace discoveryengine_v1beta {
25087
24840
  * // "features": {},
25088
24841
  * // "industryVertical": "my_industryVertical",
25089
24842
  * // "mediaRecommendationEngineConfig": {},
24843
+ * // "modelConfigs": {},
25090
24844
  * // "name": "my_name",
25091
24845
  * // "searchEngineConfig": {},
25092
24846
  * // "solutionType": "my_solutionType",
@@ -25278,7 +25032,163 @@ export declare namespace discoveryengine_v1beta {
25278
25032
  }
25279
25033
  export class Resource$Projects$Locations$Collections$Engines$Assistants {
25280
25034
  context: APIRequestContext;
25035
+ agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
25281
25036
  constructor(context: APIRequestContext);
25037
+ /**
25038
+ * Creates an Assistant.
25039
+ * @example
25040
+ * ```js
25041
+ * // Before running the sample:
25042
+ * // - Enable the API at:
25043
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25044
+ * // - Login into gcloud by running:
25045
+ * // ```sh
25046
+ * // $ gcloud auth application-default login
25047
+ * // ```
25048
+ * // - Install the npm module by running:
25049
+ * // ```sh
25050
+ * // $ npm install googleapis
25051
+ * // ```
25052
+ *
25053
+ * const {google} = require('googleapis');
25054
+ * const discoveryengine = google.discoveryengine('v1beta');
25055
+ *
25056
+ * async function main() {
25057
+ * const auth = new google.auth.GoogleAuth({
25058
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25059
+ * scopes: [
25060
+ * 'https://www.googleapis.com/auth/cloud-platform',
25061
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
25062
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25063
+ * ],
25064
+ * });
25065
+ *
25066
+ * // Acquire an auth client, and bind it to all future calls
25067
+ * const authClient = await auth.getClient();
25068
+ * google.options({auth: authClient});
25069
+ *
25070
+ * // Do the magic
25071
+ * const res =
25072
+ * await discoveryengine.projects.locations.collections.engines.assistants.create(
25073
+ * {
25074
+ * // 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.
25075
+ * assistantId: 'placeholder-value',
25076
+ * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
25077
+ * parent:
25078
+ * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
25079
+ *
25080
+ * // Request body metadata
25081
+ * requestBody: {
25082
+ * // request body parameters
25083
+ * // {
25084
+ * // "customerPolicy": {},
25085
+ * // "description": "my_description",
25086
+ * // "displayName": "my_displayName",
25087
+ * // "enabledTools": {},
25088
+ * // "generationConfig": {},
25089
+ * // "name": "my_name",
25090
+ * // "webGroundingType": "my_webGroundingType"
25091
+ * // }
25092
+ * },
25093
+ * },
25094
+ * );
25095
+ * console.log(res.data);
25096
+ *
25097
+ * // Example response
25098
+ * // {
25099
+ * // "customerPolicy": {},
25100
+ * // "description": "my_description",
25101
+ * // "displayName": "my_displayName",
25102
+ * // "enabledTools": {},
25103
+ * // "generationConfig": {},
25104
+ * // "name": "my_name",
25105
+ * // "webGroundingType": "my_webGroundingType"
25106
+ * // }
25107
+ * }
25108
+ *
25109
+ * main().catch(e => {
25110
+ * console.error(e);
25111
+ * throw e;
25112
+ * });
25113
+ *
25114
+ * ```
25115
+ *
25116
+ * @param params - Parameters for request
25117
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25118
+ * @param callback - Optional callback that handles the response.
25119
+ * @returns A promise if used with async/await, or void if used with a callback.
25120
+ */
25121
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25122
+ create(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAssistant>>;
25123
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25124
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
25125
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
25126
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
25127
+ /**
25128
+ * Deletes an Assistant.
25129
+ * @example
25130
+ * ```js
25131
+ * // Before running the sample:
25132
+ * // - Enable the API at:
25133
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25134
+ * // - Login into gcloud by running:
25135
+ * // ```sh
25136
+ * // $ gcloud auth application-default login
25137
+ * // ```
25138
+ * // - Install the npm module by running:
25139
+ * // ```sh
25140
+ * // $ npm install googleapis
25141
+ * // ```
25142
+ *
25143
+ * const {google} = require('googleapis');
25144
+ * const discoveryengine = google.discoveryengine('v1beta');
25145
+ *
25146
+ * async function main() {
25147
+ * const auth = new google.auth.GoogleAuth({
25148
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25149
+ * scopes: [
25150
+ * 'https://www.googleapis.com/auth/cloud-platform',
25151
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
25152
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25153
+ * ],
25154
+ * });
25155
+ *
25156
+ * // Acquire an auth client, and bind it to all future calls
25157
+ * const authClient = await auth.getClient();
25158
+ * google.options({auth: authClient});
25159
+ *
25160
+ * // Do the magic
25161
+ * const res =
25162
+ * await discoveryengine.projects.locations.collections.engines.assistants.delete(
25163
+ * {
25164
+ * // 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.
25165
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
25166
+ * },
25167
+ * );
25168
+ * console.log(res.data);
25169
+ *
25170
+ * // Example response
25171
+ * // {}
25172
+ * }
25173
+ *
25174
+ * main().catch(e => {
25175
+ * console.error(e);
25176
+ * throw e;
25177
+ * });
25178
+ *
25179
+ * ```
25180
+ *
25181
+ * @param params - Parameters for request
25182
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25183
+ * @param callback - Optional callback that handles the response.
25184
+ * @returns A promise if used with async/await, or void if used with a callback.
25185
+ */
25186
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25187
+ delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
25188
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25189
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
25190
+ delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
25191
+ delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
25282
25192
  /**
25283
25193
  * Gets an Assistant.
25284
25194
  * @example
@@ -25325,6 +25235,8 @@ export declare namespace discoveryengine_v1beta {
25325
25235
  * // Example response
25326
25236
  * // {
25327
25237
  * // "customerPolicy": {},
25238
+ * // "description": "my_description",
25239
+ * // "displayName": "my_displayName",
25328
25240
  * // "enabledTools": {},
25329
25241
  * // "generationConfig": {},
25330
25242
  * // "name": "my_name",
@@ -25350,6 +25262,79 @@ export declare namespace discoveryengine_v1beta {
25350
25262
  get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
25351
25263
  get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
25352
25264
  get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAssistant>): void;
25265
+ /**
25266
+ * Lists all Assistants under an Engine.
25267
+ * @example
25268
+ * ```js
25269
+ * // Before running the sample:
25270
+ * // - Enable the API at:
25271
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25272
+ * // - Login into gcloud by running:
25273
+ * // ```sh
25274
+ * // $ gcloud auth application-default login
25275
+ * // ```
25276
+ * // - Install the npm module by running:
25277
+ * // ```sh
25278
+ * // $ npm install googleapis
25279
+ * // ```
25280
+ *
25281
+ * const {google} = require('googleapis');
25282
+ * const discoveryengine = google.discoveryengine('v1beta');
25283
+ *
25284
+ * async function main() {
25285
+ * const auth = new google.auth.GoogleAuth({
25286
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25287
+ * scopes: [
25288
+ * 'https://www.googleapis.com/auth/cloud-platform',
25289
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
25290
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25291
+ * ],
25292
+ * });
25293
+ *
25294
+ * // Acquire an auth client, and bind it to all future calls
25295
+ * const authClient = await auth.getClient();
25296
+ * google.options({auth: authClient});
25297
+ *
25298
+ * // Do the magic
25299
+ * const res =
25300
+ * await discoveryengine.projects.locations.collections.engines.assistants.list(
25301
+ * {
25302
+ * // 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.
25303
+ * pageSize: 'placeholder-value',
25304
+ * // 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.
25305
+ * pageToken: 'placeholder-value',
25306
+ * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
25307
+ * parent:
25308
+ * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
25309
+ * },
25310
+ * );
25311
+ * console.log(res.data);
25312
+ *
25313
+ * // Example response
25314
+ * // {
25315
+ * // "assistants": [],
25316
+ * // "nextPageToken": "my_nextPageToken"
25317
+ * // }
25318
+ * }
25319
+ *
25320
+ * main().catch(e => {
25321
+ * console.error(e);
25322
+ * throw e;
25323
+ * });
25324
+ *
25325
+ * ```
25326
+ *
25327
+ * @param params - Parameters for request
25328
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25329
+ * @param callback - Optional callback that handles the response.
25330
+ * @returns A promise if used with async/await, or void if used with a callback.
25331
+ */
25332
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25333
+ list(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>>;
25334
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25335
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>): void;
25336
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>): void;
25337
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListAssistantsResponse>): void;
25353
25338
  /**
25354
25339
  * Updates an Assistant
25355
25340
  * @example
@@ -25397,6 +25382,8 @@ export declare namespace discoveryengine_v1beta {
25397
25382
  * // request body parameters
25398
25383
  * // {
25399
25384
  * // "customerPolicy": {},
25385
+ * // "description": "my_description",
25386
+ * // "displayName": "my_displayName",
25400
25387
  * // "enabledTools": {},
25401
25388
  * // "generationConfig": {},
25402
25389
  * // "name": "my_name",
@@ -25410,6 +25397,8 @@ export declare namespace discoveryengine_v1beta {
25410
25397
  * // Example response
25411
25398
  * // {
25412
25399
  * // "customerPolicy": {},
25400
+ * // "description": "my_description",
25401
+ * // "displayName": "my_displayName",
25413
25402
  * // "enabledTools": {},
25414
25403
  * // "generationConfig": {},
25415
25404
  * // "name": "my_name",
@@ -25494,6 +25483,7 @@ export declare namespace discoveryengine_v1beta {
25494
25483
  * // {
25495
25484
  * // "answer": {},
25496
25485
  * // "assistToken": "my_assistToken",
25486
+ * // "invocationTools": [],
25497
25487
  * // "sessionInfo": {}
25498
25488
  * // }
25499
25489
  * }
@@ -25517,12 +25507,46 @@ export declare namespace discoveryengine_v1beta {
25517
25507
  streamAssist(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponse>): void;
25518
25508
  streamAssist(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponse>): void;
25519
25509
  }
25510
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create extends StandardParameters {
25511
+ /**
25512
+ * 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.
25513
+ */
25514
+ assistantId?: string;
25515
+ /**
25516
+ * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
25517
+ */
25518
+ parent?: string;
25519
+ /**
25520
+ * Request body metadata
25521
+ */
25522
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAssistant;
25523
+ }
25524
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Delete extends StandardParameters {
25525
+ /**
25526
+ * 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.
25527
+ */
25528
+ name?: string;
25529
+ }
25520
25530
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get extends StandardParameters {
25521
25531
  /**
25522
25532
  * Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
25523
25533
  */
25524
25534
  name?: string;
25525
25535
  }
25536
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$List extends StandardParameters {
25537
+ /**
25538
+ * 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.
25539
+ */
25540
+ pageSize?: number;
25541
+ /**
25542
+ * 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.
25543
+ */
25544
+ pageToken?: string;
25545
+ /**
25546
+ * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
25547
+ */
25548
+ parent?: string;
25549
+ }
25526
25550
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
25527
25551
  /**
25528
25552
  * 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.
@@ -25547,6 +25571,91 @@ export declare namespace discoveryengine_v1beta {
25547
25571
  */
25548
25572
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistRequest;
25549
25573
  }
25574
+ export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents {
25575
+ context: APIRequestContext;
25576
+ operations: Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations;
25577
+ constructor(context: APIRequestContext);
25578
+ }
25579
+ export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations {
25580
+ context: APIRequestContext;
25581
+ constructor(context: APIRequestContext);
25582
+ /**
25583
+ * 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.
25584
+ * @example
25585
+ * ```js
25586
+ * // Before running the sample:
25587
+ * // - Enable the API at:
25588
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25589
+ * // - Login into gcloud by running:
25590
+ * // ```sh
25591
+ * // $ gcloud auth application-default login
25592
+ * // ```
25593
+ * // - Install the npm module by running:
25594
+ * // ```sh
25595
+ * // $ npm install googleapis
25596
+ * // ```
25597
+ *
25598
+ * const {google} = require('googleapis');
25599
+ * const discoveryengine = google.discoveryengine('v1beta');
25600
+ *
25601
+ * async function main() {
25602
+ * const auth = new google.auth.GoogleAuth({
25603
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25604
+ * scopes: [
25605
+ * 'https://www.googleapis.com/auth/cloud-platform',
25606
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25607
+ * ],
25608
+ * });
25609
+ *
25610
+ * // Acquire an auth client, and bind it to all future calls
25611
+ * const authClient = await auth.getClient();
25612
+ * google.options({auth: authClient});
25613
+ *
25614
+ * // Do the magic
25615
+ * const res =
25616
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get(
25617
+ * {
25618
+ * // The name of the operation resource.
25619
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent/operations/my-operation',
25620
+ * },
25621
+ * );
25622
+ * console.log(res.data);
25623
+ *
25624
+ * // Example response
25625
+ * // {
25626
+ * // "done": false,
25627
+ * // "error": {},
25628
+ * // "metadata": {},
25629
+ * // "name": "my_name",
25630
+ * // "response": {}
25631
+ * // }
25632
+ * }
25633
+ *
25634
+ * main().catch(e => {
25635
+ * console.error(e);
25636
+ * throw e;
25637
+ * });
25638
+ *
25639
+ * ```
25640
+ *
25641
+ * @param params - Parameters for request
25642
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25643
+ * @param callback - Optional callback that handles the response.
25644
+ * @returns A promise if used with async/await, or void if used with a callback.
25645
+ */
25646
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25647
+ get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
25648
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25649
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
25650
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
25651
+ get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
25652
+ }
25653
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Operations$Get extends StandardParameters {
25654
+ /**
25655
+ * The name of the operation resource.
25656
+ */
25657
+ name?: string;
25658
+ }
25550
25659
  export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
25551
25660
  context: APIRequestContext;
25552
25661
  constructor(context: APIRequestContext);
@@ -26858,7 +26967,7 @@ export declare namespace discoveryengine_v1beta {
26858
26967
  * pageSize: 'placeholder-value',
26859
26968
  * // The standard list page token.
26860
26969
  * pageToken: 'placeholder-value',
26861
- * // 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.
26970
+ * // 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.
26862
26971
  * returnPartialSuccess: 'placeholder-value',
26863
26972
  * },
26864
26973
  * );
@@ -26915,7 +27024,7 @@ export declare namespace discoveryengine_v1beta {
26915
27024
  */
26916
27025
  pageToken?: string;
26917
27026
  /**
26918
- * 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.
27027
+ * 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.
26919
27028
  */
26920
27029
  returnPartialSuccess?: boolean;
26921
27030
  }
@@ -27419,6 +27528,7 @@ export declare namespace discoveryengine_v1beta {
27419
27528
  * // "branch": "my_branch",
27420
27529
  * // "canonicalFilter": "my_canonicalFilter",
27421
27530
  * // "contentSearchSpec": {},
27531
+ * // "crowdingSpecs": [],
27422
27532
  * // "dataStoreSpecs": [],
27423
27533
  * // "displaySpec": {},
27424
27534
  * // "embeddingSpec": {},
@@ -27430,6 +27540,7 @@ export declare namespace discoveryengine_v1beta {
27430
27540
  * // "offset": 0,
27431
27541
  * // "oneBoxPageSize": 0,
27432
27542
  * // "orderBy": "my_orderBy",
27543
+ * // "pageCategories": [],
27433
27544
  * // "pageSize": 0,
27434
27545
  * // "pageToken": "my_pageToken",
27435
27546
  * // "params": {},
@@ -27472,6 +27583,7 @@ export declare namespace discoveryengine_v1beta {
27472
27583
  * // "redirectUri": "my_redirectUri",
27473
27584
  * // "results": [],
27474
27585
  * // "searchLinkPromotions": [],
27586
+ * // "semanticState": "my_semanticState",
27475
27587
  * // "sessionInfo": {},
27476
27588
  * // "suggestedQuery": "my_suggestedQuery",
27477
27589
  * // "summary": {},
@@ -27546,6 +27658,7 @@ export declare namespace discoveryengine_v1beta {
27546
27658
  * // "branch": "my_branch",
27547
27659
  * // "canonicalFilter": "my_canonicalFilter",
27548
27660
  * // "contentSearchSpec": {},
27661
+ * // "crowdingSpecs": [],
27549
27662
  * // "dataStoreSpecs": [],
27550
27663
  * // "displaySpec": {},
27551
27664
  * // "embeddingSpec": {},
@@ -27557,6 +27670,7 @@ export declare namespace discoveryengine_v1beta {
27557
27670
  * // "offset": 0,
27558
27671
  * // "oneBoxPageSize": 0,
27559
27672
  * // "orderBy": "my_orderBy",
27673
+ * // "pageCategories": [],
27560
27674
  * // "pageSize": 0,
27561
27675
  * // "pageToken": "my_pageToken",
27562
27676
  * // "params": {},
@@ -27599,6 +27713,7 @@ export declare namespace discoveryengine_v1beta {
27599
27713
  * // "redirectUri": "my_redirectUri",
27600
27714
  * // "results": [],
27601
27715
  * // "searchLinkPromotions": [],
27716
+ * // "semanticState": "my_semanticState",
27602
27717
  * // "sessionInfo": {},
27603
27718
  * // "suggestedQuery": "my_suggestedQuery",
27604
27719
  * // "summary": {},
@@ -28468,7 +28583,7 @@ export declare namespace discoveryengine_v1beta {
28468
28583
  * pageSize: 'placeholder-value',
28469
28584
  * // The standard list page token.
28470
28585
  * pageToken: 'placeholder-value',
28471
- * // 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.
28586
+ * // 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.
28472
28587
  * returnPartialSuccess: 'placeholder-value',
28473
28588
  * });
28474
28589
  * console.log(res.data);
@@ -28524,7 +28639,7 @@ export declare namespace discoveryengine_v1beta {
28524
28639
  */
28525
28640
  pageToken?: string;
28526
28641
  /**
28527
- * 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.
28642
+ * 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.
28528
28643
  */
28529
28644
  returnPartialSuccess?: boolean;
28530
28645
  }
@@ -30174,7 +30289,7 @@ export declare namespace discoveryengine_v1beta {
30174
30289
  * pageSize: 'placeholder-value',
30175
30290
  * // The standard list page token.
30176
30291
  * pageToken: 'placeholder-value',
30177
- * // 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.
30292
+ * // 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.
30178
30293
  * returnPartialSuccess: 'placeholder-value',
30179
30294
  * },
30180
30295
  * );
@@ -30241,7 +30356,7 @@ export declare namespace discoveryengine_v1beta {
30241
30356
  */
30242
30357
  pageToken?: string;
30243
30358
  /**
30244
- * 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.
30359
+ * 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.
30245
30360
  */
30246
30361
  returnPartialSuccess?: boolean;
30247
30362
  }
@@ -31637,7 +31752,7 @@ export declare namespace discoveryengine_v1beta {
31637
31752
  * pageSize: 'placeholder-value',
31638
31753
  * // The standard list page token.
31639
31754
  * pageToken: 'placeholder-value',
31640
- * // 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.
31755
+ * // 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.
31641
31756
  * returnPartialSuccess: 'placeholder-value',
31642
31757
  * });
31643
31758
  * console.log(res.data);
@@ -31693,7 +31808,7 @@ export declare namespace discoveryengine_v1beta {
31693
31808
  */
31694
31809
  pageToken?: string;
31695
31810
  /**
31696
- * 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.
31811
+ * 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.
31697
31812
  */
31698
31813
  returnPartialSuccess?: boolean;
31699
31814
  }
@@ -31811,7 +31926,7 @@ export declare namespace discoveryengine_v1beta {
31811
31926
  * pageSize: 'placeholder-value',
31812
31927
  * // The standard list page token.
31813
31928
  * pageToken: 'placeholder-value',
31814
- * // 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.
31929
+ * // 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.
31815
31930
  * returnPartialSuccess: 'placeholder-value',
31816
31931
  * });
31817
31932
  * console.log(res.data);
@@ -31867,7 +31982,7 @@ export declare namespace discoveryengine_v1beta {
31867
31982
  */
31868
31983
  pageToken?: string;
31869
31984
  /**
31870
- * 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.
31985
+ * 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.
31871
31986
  */
31872
31987
  returnPartialSuccess?: boolean;
31873
31988
  }
@@ -32783,6 +32898,7 @@ export declare namespace discoveryengine_v1beta {
32783
32898
  * // "branch": "my_branch",
32784
32899
  * // "canonicalFilter": "my_canonicalFilter",
32785
32900
  * // "contentSearchSpec": {},
32901
+ * // "crowdingSpecs": [],
32786
32902
  * // "dataStoreSpecs": [],
32787
32903
  * // "displaySpec": {},
32788
32904
  * // "embeddingSpec": {},
@@ -32794,6 +32910,7 @@ export declare namespace discoveryengine_v1beta {
32794
32910
  * // "offset": 0,
32795
32911
  * // "oneBoxPageSize": 0,
32796
32912
  * // "orderBy": "my_orderBy",
32913
+ * // "pageCategories": [],
32797
32914
  * // "pageSize": 0,
32798
32915
  * // "pageToken": "my_pageToken",
32799
32916
  * // "params": {},
@@ -32835,6 +32952,7 @@ export declare namespace discoveryengine_v1beta {
32835
32952
  * // "redirectUri": "my_redirectUri",
32836
32953
  * // "results": [],
32837
32954
  * // "searchLinkPromotions": [],
32955
+ * // "semanticState": "my_semanticState",
32838
32956
  * // "sessionInfo": {},
32839
32957
  * // "suggestedQuery": "my_suggestedQuery",
32840
32958
  * // "summary": {},
@@ -32909,6 +33027,7 @@ export declare namespace discoveryengine_v1beta {
32909
33027
  * // "branch": "my_branch",
32910
33028
  * // "canonicalFilter": "my_canonicalFilter",
32911
33029
  * // "contentSearchSpec": {},
33030
+ * // "crowdingSpecs": [],
32912
33031
  * // "dataStoreSpecs": [],
32913
33032
  * // "displaySpec": {},
32914
33033
  * // "embeddingSpec": {},
@@ -32920,6 +33039,7 @@ export declare namespace discoveryengine_v1beta {
32920
33039
  * // "offset": 0,
32921
33040
  * // "oneBoxPageSize": 0,
32922
33041
  * // "orderBy": "my_orderBy",
33042
+ * // "pageCategories": [],
32923
33043
  * // "pageSize": 0,
32924
33044
  * // "pageToken": "my_pageToken",
32925
33045
  * // "params": {},
@@ -32962,6 +33082,7 @@ export declare namespace discoveryengine_v1beta {
32962
33082
  * // "redirectUri": "my_redirectUri",
32963
33083
  * // "results": [],
32964
33084
  * // "searchLinkPromotions": [],
33085
+ * // "semanticState": "my_semanticState",
32965
33086
  * // "sessionInfo": {},
32966
33087
  * // "suggestedQuery": "my_suggestedQuery",
32967
33088
  * // "summary": {},
@@ -35379,6 +35500,7 @@ export declare namespace discoveryengine_v1beta {
35379
35500
  * // Scopes can be specified either as an array or as a single, space-delimited string.
35380
35501
  * scopes: [
35381
35502
  * 'https://www.googleapis.com/auth/cloud-platform',
35503
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
35382
35504
  * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
35383
35505
  * ],
35384
35506
  * });
@@ -36580,7 +36702,7 @@ export declare namespace discoveryengine_v1beta {
36580
36702
  * pageSize: 'placeholder-value',
36581
36703
  * // The standard list page token.
36582
36704
  * pageToken: 'placeholder-value',
36583
- * // 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.
36705
+ * // 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.
36584
36706
  * returnPartialSuccess: 'placeholder-value',
36585
36707
  * },
36586
36708
  * );
@@ -36637,7 +36759,7 @@ export declare namespace discoveryengine_v1beta {
36637
36759
  */
36638
36760
  pageToken?: string;
36639
36761
  /**
36640
- * 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.
36762
+ * 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.
36641
36763
  */
36642
36764
  returnPartialSuccess?: boolean;
36643
36765
  }
@@ -37045,7 +37167,7 @@ export declare namespace discoveryengine_v1beta {
37045
37167
  * pageSize: 'placeholder-value',
37046
37168
  * // The standard list page token.
37047
37169
  * pageToken: 'placeholder-value',
37048
- * // 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.
37170
+ * // 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.
37049
37171
  * returnPartialSuccess: 'placeholder-value',
37050
37172
  * });
37051
37173
  * console.log(res.data);
@@ -37101,7 +37223,7 @@ export declare namespace discoveryengine_v1beta {
37101
37223
  */
37102
37224
  pageToken?: string;
37103
37225
  /**
37104
- * 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.
37226
+ * 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.
37105
37227
  */
37106
37228
  returnPartialSuccess?: boolean;
37107
37229
  }
@@ -38597,6 +38719,7 @@ export declare namespace discoveryengine_v1beta {
38597
38719
  }
38598
38720
  export class Resource$Projects$Locations$Userstores {
38599
38721
  context: APIRequestContext;
38722
+ licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
38600
38723
  userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
38601
38724
  constructor(context: APIRequestContext);
38602
38725
  /**
@@ -39026,6 +39149,83 @@ export declare namespace discoveryengine_v1beta {
39026
39149
  */
39027
39150
  requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore;
39028
39151
  }
39152
+ export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
39153
+ context: APIRequestContext;
39154
+ constructor(context: APIRequestContext);
39155
+ /**
39156
+ * Lists all the LicenseConfigUsageStatss associated with the project.
39157
+ * @example
39158
+ * ```js
39159
+ * // Before running the sample:
39160
+ * // - Enable the API at:
39161
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
39162
+ * // - Login into gcloud by running:
39163
+ * // ```sh
39164
+ * // $ gcloud auth application-default login
39165
+ * // ```
39166
+ * // - Install the npm module by running:
39167
+ * // ```sh
39168
+ * // $ npm install googleapis
39169
+ * // ```
39170
+ *
39171
+ * const {google} = require('googleapis');
39172
+ * const discoveryengine = google.discoveryengine('v1beta');
39173
+ *
39174
+ * async function main() {
39175
+ * const auth = new google.auth.GoogleAuth({
39176
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
39177
+ * scopes: [
39178
+ * 'https://www.googleapis.com/auth/cloud-platform',
39179
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
39180
+ * ],
39181
+ * });
39182
+ *
39183
+ * // Acquire an auth client, and bind it to all future calls
39184
+ * const authClient = await auth.getClient();
39185
+ * google.options({auth: authClient});
39186
+ *
39187
+ * // Do the magic
39188
+ * const res =
39189
+ * await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
39190
+ * {
39191
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
39192
+ * parent:
39193
+ * 'projects/my-project/locations/my-location/userStores/my-userStore',
39194
+ * },
39195
+ * );
39196
+ * console.log(res.data);
39197
+ *
39198
+ * // Example response
39199
+ * // {
39200
+ * // "licenseConfigUsageStats": []
39201
+ * // }
39202
+ * }
39203
+ *
39204
+ * main().catch(e => {
39205
+ * console.error(e);
39206
+ * throw e;
39207
+ * });
39208
+ *
39209
+ * ```
39210
+ *
39211
+ * @param params - Parameters for request
39212
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
39213
+ * @param callback - Optional callback that handles the response.
39214
+ * @returns A promise if used with async/await, or void if used with a callback.
39215
+ */
39216
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
39217
+ list(params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>>;
39218
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
39219
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>): void;
39220
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>): void;
39221
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse>): void;
39222
+ }
39223
+ export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List extends StandardParameters {
39224
+ /**
39225
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
39226
+ */
39227
+ parent?: string;
39228
+ }
39029
39229
  export class Resource$Projects$Locations$Userstores$Userlicenses {
39030
39230
  context: APIRequestContext;
39031
39231
  constructor(context: APIRequestContext);
@@ -39064,8 +39264,8 @@ export declare namespace discoveryengine_v1beta {
39064
39264
  * // Do the magic
39065
39265
  * const res =
39066
39266
  * await discoveryengine.projects.locations.userStores.userLicenses.list({
39067
- * // Optional. Filter for the list request. Supported fields: * `license_assignment_state` 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.
39068
- * filter: 'placeholder-value',
39267
+ * // 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.
39268
+ * orderBy: 'placeholder-value',
39069
39269
  * // 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.
39070
39270
  * pageSize: 'placeholder-value',
39071
39271
  * // 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.
@@ -39104,9 +39304,9 @@ export declare namespace discoveryengine_v1beta {
39104
39304
  }
39105
39305
  export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
39106
39306
  /**
39107
- * Optional. Filter for the list request. Supported fields: * `license_assignment_state` 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.
39307
+ * 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.
39108
39308
  */
39109
- filter?: string;
39309
+ orderBy?: string;
39110
39310
  /**
39111
39311
  * 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.
39112
39312
  */
@@ -39232,7 +39432,7 @@ export declare namespace discoveryengine_v1beta {
39232
39432
  * pageSize: 'placeholder-value',
39233
39433
  * // The standard list page token.
39234
39434
  * pageToken: 'placeholder-value',
39235
- * // 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.
39435
+ * // 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.
39236
39436
  * returnPartialSuccess: 'placeholder-value',
39237
39437
  * });
39238
39438
  * console.log(res.data);
@@ -39288,7 +39488,7 @@ export declare namespace discoveryengine_v1beta {
39288
39488
  */
39289
39489
  pageToken?: string;
39290
39490
  /**
39291
- * 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.
39491
+ * 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.
39292
39492
  */
39293
39493
  returnPartialSuccess?: boolean;
39294
39494
  }