@googleapis/discoveryengine 27.0.0 → 27.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1269,6 +1269,10 @@ export declare namespace discoveryengine_v1alpha {
1269
1269
  * Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
1270
1270
  */
1271
1271
  rejectionReason?: string | null;
1272
+ /**
1273
+ * Optional. The sharing config of the agent.
1274
+ */
1275
+ sharingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAgentSharingConfig;
1272
1276
  /**
1273
1277
  * Optional. The starter prompt suggestions to show the user on the landing page of the agent.
1274
1278
  */
@@ -1316,6 +1320,15 @@ export declare namespace discoveryengine_v1alpha {
1316
1320
  */
1317
1321
  uri?: string | null;
1318
1322
  }
1323
+ /**
1324
+ * Sharing related configuration.
1325
+ */
1326
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentSharingConfig {
1327
+ /**
1328
+ * Optional. The sharing scope of the agent.
1329
+ */
1330
+ scope?: string | null;
1331
+ }
1319
1332
  /**
1320
1333
  * The starter prompt suggestion to show the user on the landing page of the agent.
1321
1334
  */
@@ -1325,6 +1338,113 @@ export declare namespace discoveryengine_v1alpha {
1325
1338
  */
1326
1339
  text?: string | null;
1327
1340
  }
1341
+ /**
1342
+ * The data for displaying an Agent.
1343
+ */
1344
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentView {
1345
+ /**
1346
+ * Immutable. The origin of the Agent.
1347
+ */
1348
+ agentOrigin?: string | null;
1349
+ /**
1350
+ * Output only. The sharing state of the agent.
1351
+ */
1352
+ agentSharingState?: string | null;
1353
+ /**
1354
+ * Output only. The type of the agent.
1355
+ */
1356
+ agentType?: string | null;
1357
+ /**
1358
+ * The custom placeholder text that appears in the text box before the user enters any text.
1359
+ */
1360
+ customPlaceholderText?: string | null;
1361
+ /**
1362
+ * The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
1363
+ */
1364
+ deploymentFailureReason?: string | null;
1365
+ /**
1366
+ * Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query and to generate the first version of the steps for the agent that can be modified by the user. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
1367
+ */
1368
+ description?: string | null;
1369
+ /**
1370
+ * Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
1371
+ */
1372
+ displayName?: string | null;
1373
+ /**
1374
+ * Optional. The icon that represents the agent on the UI.
1375
+ */
1376
+ icon?: Schema$GoogleCloudDiscoveryengineV1alphaAgentImage;
1377
+ /**
1378
+ * Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
1379
+ */
1380
+ name?: string | null;
1381
+ /**
1382
+ * The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
1383
+ */
1384
+ rejectionReason?: string | null;
1385
+ /**
1386
+ * Output only. The state of the Agent.
1387
+ */
1388
+ state?: string | null;
1389
+ /**
1390
+ * Optional. The suggested prompts for the agent, to be shown on the agent landing page.
1391
+ */
1392
+ suggestedPrompts?: Schema$GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt[];
1393
+ /**
1394
+ * The reason why the agent was suspended. Only set if the state is SUSPENDED.
1395
+ */
1396
+ suspensionReason?: string | null;
1397
+ /**
1398
+ * Optional. Per-user annotations of the current caller for the agent.
1399
+ */
1400
+ userAnnotations?: Schema$GoogleCloudDiscoveryengineV1alphaUserAnnotations;
1401
+ /**
1402
+ * The permissions of the user for this Agent.
1403
+ */
1404
+ userPermissions?: Schema$GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions;
1405
+ }
1406
+ /**
1407
+ * A suggested prompt for the agent, to be shown on the agent landing page.
1408
+ */
1409
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt {
1410
+ /**
1411
+ * Required. The text of the suggested prompt. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
1412
+ */
1413
+ text?: string | null;
1414
+ }
1415
+ /**
1416
+ * The permissions of the user on an Agent.
1417
+ */
1418
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions {
1419
+ /**
1420
+ * If the user can delete this Agent.
1421
+ */
1422
+ canDelete?: boolean | null;
1423
+ /**
1424
+ * If the user can edit this Agent.
1425
+ */
1426
+ canEdit?: boolean | null;
1427
+ /**
1428
+ * If the user can propose other users to share the Agent with.
1429
+ */
1430
+ canProposeUsers?: boolean | null;
1431
+ /**
1432
+ * If the user can request a review for this Agent.
1433
+ */
1434
+ canRequestReview?: boolean | null;
1435
+ /**
1436
+ * If the user can run this Agent.
1437
+ */
1438
+ canRun?: boolean | null;
1439
+ /**
1440
+ * If the user can view the source of this Agent.
1441
+ */
1442
+ canView?: boolean | null;
1443
+ /**
1444
+ * If the user can withdraw this Agent.
1445
+ */
1446
+ canWithdraw?: boolean | null;
1447
+ }
1328
1448
  /**
1329
1449
  * The connector level alert config.
1330
1450
  */
@@ -5235,6 +5355,10 @@ export declare namespace discoveryengine_v1alpha {
5235
5355
  * Optional. If true, the LLM based annotation is added to the image during parsing.
5236
5356
  */
5237
5357
  enableImageAnnotation?: boolean | null;
5358
+ /**
5359
+ * Optional. If true, the pdf layout will be refined using an LLM.
5360
+ */
5361
+ enableLlmLayoutParsing?: boolean | null;
5238
5362
  /**
5239
5363
  * Optional. If true, the LLM based annotation is added to the table during parsing.
5240
5364
  */
@@ -5326,6 +5450,10 @@ export declare namespace discoveryengine_v1alpha {
5326
5450
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
5327
5451
  */
5328
5452
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
5453
+ /**
5454
+ * Output only. CMEK-related information for the Engine.
5455
+ */
5456
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
5329
5457
  /**
5330
5458
  * Common config spec that specifies the metadata of the engine.
5331
5459
  */
@@ -5364,6 +5492,12 @@ export declare namespace discoveryengine_v1alpha {
5364
5492
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
5365
5493
  */
5366
5494
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
5495
+ /**
5496
+ * 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.
5497
+ */
5498
+ modelConfigs?: {
5499
+ [key: string]: string;
5500
+ } | null;
5367
5501
  /**
5368
5502
  * 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.
5369
5503
  */
@@ -6000,6 +6134,15 @@ export declare namespace discoveryengine_v1alpha {
6000
6134
  */
6001
6135
  inputUris?: string[] | null;
6002
6136
  }
6137
+ /**
6138
+ * Response message for the AgentService.GetAgentView method.
6139
+ */
6140
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse {
6141
+ /**
6142
+ * The data for displaying an Agent.
6143
+ */
6144
+ agentView?: Schema$GoogleCloudDiscoveryengineV1alphaAgentView;
6145
+ }
6003
6146
  /**
6004
6147
  * Response message for DataConnectorService.GetConnectorSecret.
6005
6148
  */
@@ -6728,6 +6871,19 @@ export declare namespace discoveryengine_v1alpha {
6728
6871
  */
6729
6872
  subscriptionTier?: string | null;
6730
6873
  }
6874
+ /**
6875
+ * Stats about users' licenses.
6876
+ */
6877
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfigUsageStats {
6878
+ /**
6879
+ * Required. The LicenseConfig name.
6880
+ */
6881
+ licenseConfig?: string | null;
6882
+ /**
6883
+ * Required. The number of licenses used.
6884
+ */
6885
+ usedLicenseCount?: string | null;
6886
+ }
6731
6887
  /**
6732
6888
  * Response message for the AgentService.ListAgents method.
6733
6889
  */
@@ -6754,6 +6910,19 @@ export declare namespace discoveryengine_v1alpha {
6754
6910
  */
6755
6911
  nextPageToken?: string | null;
6756
6912
  }
6913
+ /**
6914
+ * Response message for the AgentService.ListAvailableAgentViews method.
6915
+ */
6916
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse {
6917
+ /**
6918
+ * The agent sources visible to the caller under the parent Assistant.
6919
+ */
6920
+ agentViews?: Schema$GoogleCloudDiscoveryengineV1alphaAgentView[];
6921
+ /**
6922
+ * A token that can be sent as ListAvailableAgentViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
6923
+ */
6924
+ nextPageToken?: string | null;
6925
+ }
6757
6926
  /**
6758
6927
  * Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.
6759
6928
  */
@@ -6989,6 +7158,15 @@ export declare namespace discoveryengine_v1alpha {
6989
7158
  */
6990
7159
  nextPageToken?: string | null;
6991
7160
  }
7161
+ /**
7162
+ * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
7163
+ */
7164
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse {
7165
+ /**
7166
+ * All the customer's LicenseConfigUsageStats.
7167
+ */
7168
+ licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfigUsageStats[];
7169
+ }
6992
7170
  /**
6993
7171
  * Response message for SampleQueryService.ListSampleQueries method.
6994
7172
  */
@@ -10374,6 +10552,19 @@ export declare namespace discoveryengine_v1alpha {
10374
10552
  */
10375
10553
  mediaResponseInfo?: Schema$ApiservingMediaResponseInfo;
10376
10554
  }
10555
+ /**
10556
+ * Per-user annotations for an Agent, based on UserAnnotation.
10557
+ */
10558
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaUserAnnotations {
10559
+ /**
10560
+ * Optional. Whether the agent is pinned, pinned agent will be displayed on the top of the agent list.
10561
+ */
10562
+ pinned?: boolean | null;
10563
+ /**
10564
+ * Optional. Whether the agent has been viewed by the user.
10565
+ */
10566
+ viewed?: boolean | null;
10567
+ }
10377
10568
  /**
10378
10569
  * UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
10379
10570
  */
@@ -11008,6 +11199,12 @@ export declare namespace discoveryengine_v1alpha {
11008
11199
  * Describes widget (or web app) interaction type
11009
11200
  */
11010
11201
  interactionType?: string | null;
11202
+ /**
11203
+ * Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
11204
+ */
11205
+ modelConfigs?: {
11206
+ [key: string]: string;
11207
+ } | null;
11011
11208
  /**
11012
11209
  * Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
11013
11210
  */
@@ -12066,6 +12263,10 @@ export declare namespace discoveryengine_v1alpha {
12066
12263
  * Optional. If true, the LLM based annotation is added to the image during parsing.
12067
12264
  */
12068
12265
  enableImageAnnotation?: boolean | null;
12266
+ /**
12267
+ * Optional. If true, the pdf layout will be refined using an LLM.
12268
+ */
12269
+ enableLlmLayoutParsing?: boolean | null;
12069
12270
  /**
12070
12271
  * Optional. If true, the LLM based annotation is added to the table during parsing.
12071
12272
  */
@@ -12134,6 +12335,10 @@ export declare namespace discoveryengine_v1alpha {
12134
12335
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
12135
12336
  */
12136
12337
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
12338
+ /**
12339
+ * Output only. CMEK-related information for the Engine.
12340
+ */
12341
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
12137
12342
  /**
12138
12343
  * Common config spec that specifies the metadata of the engine.
12139
12344
  */
@@ -12172,6 +12377,12 @@ export declare namespace discoveryengine_v1alpha {
12172
12377
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
12173
12378
  */
12174
12379
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
12380
+ /**
12381
+ * 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.
12382
+ */
12383
+ modelConfigs?: {
12384
+ [key: string]: string;
12385
+ } | null;
12175
12386
  /**
12176
12387
  * 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.
12177
12388
  */
@@ -14907,6 +15118,10 @@ export declare namespace discoveryengine_v1alpha {
14907
15118
  * Optional. If true, the LLM based annotation is added to the image during parsing.
14908
15119
  */
14909
15120
  enableImageAnnotation?: boolean | null;
15121
+ /**
15122
+ * Optional. If true, the pdf layout will be refined using an LLM.
15123
+ */
15124
+ enableLlmLayoutParsing?: boolean | null;
14910
15125
  /**
14911
15126
  * Optional. If true, the LLM based annotation is added to the table during parsing.
14912
15127
  */
@@ -14975,6 +15190,10 @@ export declare namespace discoveryengine_v1alpha {
14975
15190
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
14976
15191
  */
14977
15192
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
15193
+ /**
15194
+ * Output only. CMEK-related information for the Engine.
15195
+ */
15196
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
14978
15197
  /**
14979
15198
  * Common config spec that specifies the metadata of the engine.
14980
15199
  */
@@ -15013,6 +15232,12 @@ export declare namespace discoveryengine_v1alpha {
15013
15232
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
15014
15233
  */
15015
15234
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
15235
+ /**
15236
+ * 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.
15237
+ */
15238
+ modelConfigs?: {
15239
+ [key: string]: string;
15240
+ } | null;
15016
15241
  /**
15017
15242
  * 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.
15018
15243
  */
@@ -16842,6 +17067,49 @@ export declare namespace discoveryengine_v1alpha {
16842
17067
  */
16843
17068
  videoId?: string | null;
16844
17069
  }
17070
+ /**
17071
+ * Associates `members`, or principals, with a `role`.
17072
+ */
17073
+ export interface Schema$GoogleIamV1Binding {
17074
+ /**
17075
+ * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
17076
+ */
17077
+ condition?: Schema$GoogleTypeExpr;
17078
+ /**
17079
+ * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
17080
+ */
17081
+ members?: string[] | null;
17082
+ /**
17083
+ * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
17084
+ */
17085
+ role?: string | null;
17086
+ }
17087
+ /**
17088
+ * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
17089
+ */
17090
+ export interface Schema$GoogleIamV1Policy {
17091
+ /**
17092
+ * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
17093
+ */
17094
+ bindings?: Schema$GoogleIamV1Binding[];
17095
+ /**
17096
+ * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
17097
+ */
17098
+ etag?: string | null;
17099
+ /**
17100
+ * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
17101
+ */
17102
+ version?: number | null;
17103
+ }
17104
+ /**
17105
+ * Request message for `SetIamPolicy` method.
17106
+ */
17107
+ export interface Schema$GoogleIamV1SetIamPolicyRequest {
17108
+ /**
17109
+ * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
17110
+ */
17111
+ policy?: Schema$GoogleIamV1Policy;
17112
+ }
16845
17113
  /**
16846
17114
  * The request message for Operations.CancelOperation.
16847
17115
  */
@@ -29899,6 +30167,7 @@ export declare namespace discoveryengine_v1alpha {
29899
30167
  * // "appType": "my_appType",
29900
30168
  * // "chatEngineConfig": {},
29901
30169
  * // "chatEngineMetadata": {},
30170
+ * // "cmekConfig": {},
29902
30171
  * // "commonConfig": {},
29903
30172
  * // "configurableBillingApproach": "my_configurableBillingApproach",
29904
30173
  * // "createTime": "my_createTime",
@@ -29908,6 +30177,7 @@ export declare namespace discoveryengine_v1alpha {
29908
30177
  * // "features": {},
29909
30178
  * // "industryVertical": "my_industryVertical",
29910
30179
  * // "mediaRecommendationEngineConfig": {},
30180
+ * // "modelConfigs": {},
29911
30181
  * // "name": "my_name",
29912
30182
  * // "recommendationMetadata": {},
29913
30183
  * // "searchEngineConfig": {},
@@ -30059,6 +30329,7 @@ export declare namespace discoveryengine_v1alpha {
30059
30329
  * // "appType": "my_appType",
30060
30330
  * // "chatEngineConfig": {},
30061
30331
  * // "chatEngineMetadata": {},
30332
+ * // "cmekConfig": {},
30062
30333
  * // "commonConfig": {},
30063
30334
  * // "configurableBillingApproach": "my_configurableBillingApproach",
30064
30335
  * // "createTime": "my_createTime",
@@ -30068,6 +30339,7 @@ export declare namespace discoveryengine_v1alpha {
30068
30339
  * // "features": {},
30069
30340
  * // "industryVertical": "my_industryVertical",
30070
30341
  * // "mediaRecommendationEngineConfig": {},
30342
+ * // "modelConfigs": {},
30071
30343
  * // "name": "my_name",
30072
30344
  * // "recommendationMetadata": {},
30073
30345
  * // "searchEngineConfig": {},
@@ -30281,6 +30553,7 @@ export declare namespace discoveryengine_v1alpha {
30281
30553
  * // "appType": "my_appType",
30282
30554
  * // "chatEngineConfig": {},
30283
30555
  * // "chatEngineMetadata": {},
30556
+ * // "cmekConfig": {},
30284
30557
  * // "commonConfig": {},
30285
30558
  * // "configurableBillingApproach": "my_configurableBillingApproach",
30286
30559
  * // "createTime": "my_createTime",
@@ -30290,6 +30563,7 @@ export declare namespace discoveryengine_v1alpha {
30290
30563
  * // "features": {},
30291
30564
  * // "industryVertical": "my_industryVertical",
30292
30565
  * // "mediaRecommendationEngineConfig": {},
30566
+ * // "modelConfigs": {},
30293
30567
  * // "name": "my_name",
30294
30568
  * // "recommendationMetadata": {},
30295
30569
  * // "searchEngineConfig": {},
@@ -30306,6 +30580,7 @@ export declare namespace discoveryengine_v1alpha {
30306
30580
  * // "appType": "my_appType",
30307
30581
  * // "chatEngineConfig": {},
30308
30582
  * // "chatEngineMetadata": {},
30583
+ * // "cmekConfig": {},
30309
30584
  * // "commonConfig": {},
30310
30585
  * // "configurableBillingApproach": "my_configurableBillingApproach",
30311
30586
  * // "createTime": "my_createTime",
@@ -30315,6 +30590,7 @@ export declare namespace discoveryengine_v1alpha {
30315
30590
  * // "features": {},
30316
30591
  * // "industryVertical": "my_industryVertical",
30317
30592
  * // "mediaRecommendationEngineConfig": {},
30593
+ * // "modelConfigs": {},
30318
30594
  * // "name": "my_name",
30319
30595
  * // "recommendationMetadata": {},
30320
30596
  * // "searchEngineConfig": {},
@@ -30393,6 +30669,7 @@ export declare namespace discoveryengine_v1alpha {
30393
30669
  * // "appType": "my_appType",
30394
30670
  * // "chatEngineConfig": {},
30395
30671
  * // "chatEngineMetadata": {},
30672
+ * // "cmekConfig": {},
30396
30673
  * // "commonConfig": {},
30397
30674
  * // "configurableBillingApproach": "my_configurableBillingApproach",
30398
30675
  * // "createTime": "my_createTime",
@@ -30402,6 +30679,7 @@ export declare namespace discoveryengine_v1alpha {
30402
30679
  * // "features": {},
30403
30680
  * // "industryVertical": "my_industryVertical",
30404
30681
  * // "mediaRecommendationEngineConfig": {},
30682
+ * // "modelConfigs": {},
30405
30683
  * // "name": "my_name",
30406
30684
  * // "recommendationMetadata": {},
30407
30685
  * // "searchEngineConfig": {},
@@ -30480,6 +30758,7 @@ export declare namespace discoveryengine_v1alpha {
30480
30758
  * // "appType": "my_appType",
30481
30759
  * // "chatEngineConfig": {},
30482
30760
  * // "chatEngineMetadata": {},
30761
+ * // "cmekConfig": {},
30483
30762
  * // "commonConfig": {},
30484
30763
  * // "configurableBillingApproach": "my_configurableBillingApproach",
30485
30764
  * // "createTime": "my_createTime",
@@ -30489,6 +30768,7 @@ export declare namespace discoveryengine_v1alpha {
30489
30768
  * // "features": {},
30490
30769
  * // "industryVertical": "my_industryVertical",
30491
30770
  * // "mediaRecommendationEngineConfig": {},
30771
+ * // "modelConfigs": {},
30492
30772
  * // "name": "my_name",
30493
30773
  * // "recommendationMetadata": {},
30494
30774
  * // "searchEngineConfig": {},
@@ -30855,6 +31135,89 @@ export declare namespace discoveryengine_v1alpha {
30855
31135
  get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>): void;
30856
31136
  get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>): void;
30857
31137
  get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>): void;
31138
+ /**
31139
+ * Lists the data for displaying the Agents under an Assistant which are available to the caller.
31140
+ * @example
31141
+ * ```js
31142
+ * // Before running the sample:
31143
+ * // - Enable the API at:
31144
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
31145
+ * // - Login into gcloud by running:
31146
+ * // ```sh
31147
+ * // $ gcloud auth application-default login
31148
+ * // ```
31149
+ * // - Install the npm module by running:
31150
+ * // ```sh
31151
+ * // $ npm install googleapis
31152
+ * // ```
31153
+ *
31154
+ * const {google} = require('googleapis');
31155
+ * const discoveryengine = google.discoveryengine('v1alpha');
31156
+ *
31157
+ * async function main() {
31158
+ * const auth = new google.auth.GoogleAuth({
31159
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
31160
+ * scopes: [
31161
+ * 'https://www.googleapis.com/auth/cloud-platform',
31162
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
31163
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
31164
+ * ],
31165
+ * });
31166
+ *
31167
+ * // Acquire an auth client, and bind it to all future calls
31168
+ * const authClient = await auth.getClient();
31169
+ * google.options({auth: authClient});
31170
+ *
31171
+ * // Do the magic
31172
+ * const res =
31173
+ * await discoveryengine.projects.locations.collections.engines.assistants.listAvailableAgentViews(
31174
+ * {
31175
+ * // Optional. The origin of the Agent.
31176
+ * agentOrigin: 'placeholder-value',
31177
+ * // Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Allowed fields are: * `display_name` * `state` Some examples of filters would be: * `display_name = 'agent_1'` * `display_name = 'agent_1' AND state = ENABLED` For a full description of the filter format, please see https://google.aip.dev/160.
31178
+ * filter: 'placeholder-value',
31179
+ * // Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentViews in the response should be translated to this language.
31180
+ * languageCode: 'placeholder-value',
31181
+ * // Optional. The maximum number of suggested prompts to return per agent.
31182
+ * maxSuggestedPrompts: 'placeholder-value',
31183
+ * // Optional. Maximum number of AgentViewss to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
31184
+ * pageSize: 'placeholder-value',
31185
+ * // Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableAgentViews must match the call that provided the page token.
31186
+ * pageToken: 'placeholder-value',
31187
+ * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
31188
+ * parent:
31189
+ * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant',
31190
+ * // Optional. The field to sort by. Can have the following values: - display-name: The display name of the agent. - description: The description of the agent. - create-time: The creation time of the agent. - state: The state of the agent.
31191
+ * sortBy: 'placeholder-value',
31192
+ * },
31193
+ * );
31194
+ * console.log(res.data);
31195
+ *
31196
+ * // Example response
31197
+ * // {
31198
+ * // "agentViews": [],
31199
+ * // "nextPageToken": "my_nextPageToken"
31200
+ * // }
31201
+ * }
31202
+ *
31203
+ * main().catch(e => {
31204
+ * console.error(e);
31205
+ * throw e;
31206
+ * });
31207
+ *
31208
+ * ```
31209
+ *
31210
+ * @param params - Parameters for request
31211
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
31212
+ * @param callback - Optional callback that handles the response.
31213
+ * @returns A promise if used with async/await, or void if used with a callback.
31214
+ */
31215
+ listAvailableAgentViews(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Listavailableagentviews, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31216
+ listAvailableAgentViews(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Listavailableagentviews, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse>>;
31217
+ listAvailableAgentViews(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Listavailableagentviews, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31218
+ listAvailableAgentViews(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Listavailableagentviews, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse>): void;
31219
+ listAvailableAgentViews(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Listavailableagentviews, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse>): void;
31220
+ listAvailableAgentViews(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse>): void;
30858
31221
  /**
30859
31222
  * Updates an Assistant
30860
31223
  * @example
@@ -31028,6 +31391,40 @@ export declare namespace discoveryengine_v1alpha {
31028
31391
  */
31029
31392
  name?: string;
31030
31393
  }
31394
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Listavailableagentviews extends StandardParameters {
31395
+ /**
31396
+ * Optional. The origin of the Agent.
31397
+ */
31398
+ agentOrigin?: string;
31399
+ /**
31400
+ * Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Allowed fields are: * `display_name` * `state` Some examples of filters would be: * `display_name = 'agent_1'` * `display_name = 'agent_1' AND state = ENABLED` For a full description of the filter format, please see https://google.aip.dev/160.
31401
+ */
31402
+ filter?: string;
31403
+ /**
31404
+ * Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentViews in the response should be translated to this language.
31405
+ */
31406
+ languageCode?: string;
31407
+ /**
31408
+ * Optional. The maximum number of suggested prompts to return per agent.
31409
+ */
31410
+ maxSuggestedPrompts?: number;
31411
+ /**
31412
+ * Optional. Maximum number of AgentViewss to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
31413
+ */
31414
+ pageSize?: number;
31415
+ /**
31416
+ * Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableAgentViews must match the call that provided the page token.
31417
+ */
31418
+ pageToken?: string;
31419
+ /**
31420
+ * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}`
31421
+ */
31422
+ parent?: string;
31423
+ /**
31424
+ * Optional. The field to sort by. Can have the following values: - display-name: The display name of the agent. - description: The description of the agent. - create-time: The creation time of the agent. - state: The state of the agent.
31425
+ */
31426
+ sortBy?: string;
31427
+ }
31031
31428
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch extends StandardParameters {
31032
31429
  /**
31033
31430
  * 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.
@@ -31114,6 +31511,7 @@ export declare namespace discoveryengine_v1alpha {
31114
31511
  * // "languageCode": "my_languageCode",
31115
31512
  * // "name": "my_name",
31116
31513
  * // "rejectionReason": "my_rejectionReason",
31514
+ * // "sharingConfig": {},
31117
31515
  * // "starterPrompts": [],
31118
31516
  * // "state": "my_state",
31119
31517
  * // "suspensionReason": "my_suspensionReason",
@@ -31139,6 +31537,7 @@ export declare namespace discoveryengine_v1alpha {
31139
31537
  * // "languageCode": "my_languageCode",
31140
31538
  * // "name": "my_name",
31141
31539
  * // "rejectionReason": "my_rejectionReason",
31540
+ * // "sharingConfig": {},
31142
31541
  * // "starterPrompts": [],
31143
31542
  * // "state": "my_state",
31144
31543
  * // "suspensionReason": "my_suspensionReason",
@@ -31235,6 +31634,174 @@ export declare namespace discoveryengine_v1alpha {
31235
31634
  delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
31236
31635
  delete(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
31237
31636
  delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
31637
+ /**
31638
+ * Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.
31639
+ * @example
31640
+ * ```js
31641
+ * // Before running the sample:
31642
+ * // - Enable the API at:
31643
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
31644
+ * // - Login into gcloud by running:
31645
+ * // ```sh
31646
+ * // $ gcloud auth application-default login
31647
+ * // ```
31648
+ * // - Install the npm module by running:
31649
+ * // ```sh
31650
+ * // $ npm install googleapis
31651
+ * // ```
31652
+ *
31653
+ * const {google} = require('googleapis');
31654
+ * const discoveryengine = google.discoveryengine('v1alpha');
31655
+ *
31656
+ * async function main() {
31657
+ * const auth = new google.auth.GoogleAuth({
31658
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
31659
+ * scopes: [
31660
+ * 'https://www.googleapis.com/auth/cloud-platform',
31661
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
31662
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
31663
+ * ],
31664
+ * });
31665
+ *
31666
+ * // Acquire an auth client, and bind it to all future calls
31667
+ * const authClient = await auth.getClient();
31668
+ * google.options({auth: authClient});
31669
+ *
31670
+ * // Do the magic
31671
+ * const res =
31672
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.disableAgent(
31673
+ * {
31674
+ * // Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31675
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
31676
+ * },
31677
+ * );
31678
+ * console.log(res.data);
31679
+ *
31680
+ * // Example response
31681
+ * // {
31682
+ * // "a2aAgentDefinition": {},
31683
+ * // "adkAgentDefinition": {},
31684
+ * // "authorizationConfig": {},
31685
+ * // "createTime": "my_createTime",
31686
+ * // "customPlaceholderText": "my_customPlaceholderText",
31687
+ * // "deploymentFailureReason": "my_deploymentFailureReason",
31688
+ * // "description": "my_description",
31689
+ * // "dialogflowAgentDefinition": {},
31690
+ * // "displayName": "my_displayName",
31691
+ * // "icon": {},
31692
+ * // "languageCode": "my_languageCode",
31693
+ * // "name": "my_name",
31694
+ * // "rejectionReason": "my_rejectionReason",
31695
+ * // "sharingConfig": {},
31696
+ * // "starterPrompts": [],
31697
+ * // "state": "my_state",
31698
+ * // "suspensionReason": "my_suspensionReason",
31699
+ * // "updateTime": "my_updateTime"
31700
+ * // }
31701
+ * }
31702
+ *
31703
+ * main().catch(e => {
31704
+ * console.error(e);
31705
+ * throw e;
31706
+ * });
31707
+ *
31708
+ * ```
31709
+ *
31710
+ * @param params - Parameters for request
31711
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
31712
+ * @param callback - Optional callback that handles the response.
31713
+ * @returns A promise if used with async/await, or void if used with a callback.
31714
+ */
31715
+ disableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Disableagent, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31716
+ disableAgent(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Disableagent, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
31717
+ disableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Disableagent, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31718
+ disableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Disableagent, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31719
+ disableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Disableagent, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31720
+ disableAgent(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31721
+ /**
31722
+ * Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.
31723
+ * @example
31724
+ * ```js
31725
+ * // Before running the sample:
31726
+ * // - Enable the API at:
31727
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
31728
+ * // - Login into gcloud by running:
31729
+ * // ```sh
31730
+ * // $ gcloud auth application-default login
31731
+ * // ```
31732
+ * // - Install the npm module by running:
31733
+ * // ```sh
31734
+ * // $ npm install googleapis
31735
+ * // ```
31736
+ *
31737
+ * const {google} = require('googleapis');
31738
+ * const discoveryengine = google.discoveryengine('v1alpha');
31739
+ *
31740
+ * async function main() {
31741
+ * const auth = new google.auth.GoogleAuth({
31742
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
31743
+ * scopes: [
31744
+ * 'https://www.googleapis.com/auth/cloud-platform',
31745
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
31746
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
31747
+ * ],
31748
+ * });
31749
+ *
31750
+ * // Acquire an auth client, and bind it to all future calls
31751
+ * const authClient = await auth.getClient();
31752
+ * google.options({auth: authClient});
31753
+ *
31754
+ * // Do the magic
31755
+ * const res =
31756
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.enableAgent(
31757
+ * {
31758
+ * // Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31759
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
31760
+ * },
31761
+ * );
31762
+ * console.log(res.data);
31763
+ *
31764
+ * // Example response
31765
+ * // {
31766
+ * // "a2aAgentDefinition": {},
31767
+ * // "adkAgentDefinition": {},
31768
+ * // "authorizationConfig": {},
31769
+ * // "createTime": "my_createTime",
31770
+ * // "customPlaceholderText": "my_customPlaceholderText",
31771
+ * // "deploymentFailureReason": "my_deploymentFailureReason",
31772
+ * // "description": "my_description",
31773
+ * // "dialogflowAgentDefinition": {},
31774
+ * // "displayName": "my_displayName",
31775
+ * // "icon": {},
31776
+ * // "languageCode": "my_languageCode",
31777
+ * // "name": "my_name",
31778
+ * // "rejectionReason": "my_rejectionReason",
31779
+ * // "sharingConfig": {},
31780
+ * // "starterPrompts": [],
31781
+ * // "state": "my_state",
31782
+ * // "suspensionReason": "my_suspensionReason",
31783
+ * // "updateTime": "my_updateTime"
31784
+ * // }
31785
+ * }
31786
+ *
31787
+ * main().catch(e => {
31788
+ * console.error(e);
31789
+ * throw e;
31790
+ * });
31791
+ *
31792
+ * ```
31793
+ *
31794
+ * @param params - Parameters for request
31795
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
31796
+ * @param callback - Optional callback that handles the response.
31797
+ * @returns A promise if used with async/await, or void if used with a callback.
31798
+ */
31799
+ enableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31800
+ enableAgent(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
31801
+ enableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31802
+ enableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31803
+ enableAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31804
+ enableAgent(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31238
31805
  /**
31239
31806
  * Gets an Agent.
31240
31807
  * @example
@@ -31270,33 +31837,177 @@ export declare namespace discoveryengine_v1alpha {
31270
31837
  *
31271
31838
  * // Do the magic
31272
31839
  * const res =
31273
- * await discoveryengine.projects.locations.collections.engines.assistants.agents.get(
31840
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.get(
31841
+ * {
31842
+ * // Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31843
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
31844
+ * },
31845
+ * );
31846
+ * console.log(res.data);
31847
+ *
31848
+ * // Example response
31849
+ * // {
31850
+ * // "a2aAgentDefinition": {},
31851
+ * // "adkAgentDefinition": {},
31852
+ * // "authorizationConfig": {},
31853
+ * // "createTime": "my_createTime",
31854
+ * // "customPlaceholderText": "my_customPlaceholderText",
31855
+ * // "deploymentFailureReason": "my_deploymentFailureReason",
31856
+ * // "description": "my_description",
31857
+ * // "dialogflowAgentDefinition": {},
31858
+ * // "displayName": "my_displayName",
31859
+ * // "icon": {},
31860
+ * // "languageCode": "my_languageCode",
31861
+ * // "name": "my_name",
31862
+ * // "rejectionReason": "my_rejectionReason",
31863
+ * // "sharingConfig": {},
31864
+ * // "starterPrompts": [],
31865
+ * // "state": "my_state",
31866
+ * // "suspensionReason": "my_suspensionReason",
31867
+ * // "updateTime": "my_updateTime"
31868
+ * // }
31869
+ * }
31870
+ *
31871
+ * main().catch(e => {
31872
+ * console.error(e);
31873
+ * throw e;
31874
+ * });
31875
+ *
31876
+ * ```
31877
+ *
31878
+ * @param params - Parameters for request
31879
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
31880
+ * @param callback - Optional callback that handles the response.
31881
+ * @returns A promise if used with async/await, or void if used with a callback.
31882
+ */
31883
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31884
+ get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
31885
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31886
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31887
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31888
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31889
+ /**
31890
+ * Returns a AgentView for a given Agent, which contains additional information about the Agent.
31891
+ * @example
31892
+ * ```js
31893
+ * // Before running the sample:
31894
+ * // - Enable the API at:
31895
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
31896
+ * // - Login into gcloud by running:
31897
+ * // ```sh
31898
+ * // $ gcloud auth application-default login
31899
+ * // ```
31900
+ * // - Install the npm module by running:
31901
+ * // ```sh
31902
+ * // $ npm install googleapis
31903
+ * // ```
31904
+ *
31905
+ * const {google} = require('googleapis');
31906
+ * const discoveryengine = google.discoveryengine('v1alpha');
31907
+ *
31908
+ * async function main() {
31909
+ * const auth = new google.auth.GoogleAuth({
31910
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
31911
+ * scopes: [
31912
+ * 'https://www.googleapis.com/auth/cloud-platform',
31913
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
31914
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
31915
+ * ],
31916
+ * });
31917
+ *
31918
+ * // Acquire an auth client, and bind it to all future calls
31919
+ * const authClient = await auth.getClient();
31920
+ * google.options({auth: authClient});
31921
+ *
31922
+ * // Do the magic
31923
+ * const res =
31924
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.getAgentView(
31925
+ * {
31926
+ * // Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.
31927
+ * languageCode: 'placeholder-value',
31928
+ * // Optional. The maximum number of suggested prompts to return per agent.
31929
+ * maxSuggestedPrompts: 'placeholder-value',
31930
+ * // Required. The name of the Agent to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31931
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
31932
+ * },
31933
+ * );
31934
+ * console.log(res.data);
31935
+ *
31936
+ * // Example response
31937
+ * // {
31938
+ * // "agentView": {}
31939
+ * // }
31940
+ * }
31941
+ *
31942
+ * main().catch(e => {
31943
+ * console.error(e);
31944
+ * throw e;
31945
+ * });
31946
+ *
31947
+ * ```
31948
+ *
31949
+ * @param params - Parameters for request
31950
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
31951
+ * @param callback - Optional callback that handles the response.
31952
+ * @returns A promise if used with async/await, or void if used with a callback.
31953
+ */
31954
+ getAgentView(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getagentview, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31955
+ getAgentView(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getagentview, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse>>;
31956
+ getAgentView(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getagentview, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31957
+ getAgentView(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getagentview, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse>): void;
31958
+ getAgentView(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getagentview, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse>): void;
31959
+ getAgentView(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse>): void;
31960
+ /**
31961
+ * Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
31962
+ * @example
31963
+ * ```js
31964
+ * // Before running the sample:
31965
+ * // - Enable the API at:
31966
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
31967
+ * // - Login into gcloud by running:
31968
+ * // ```sh
31969
+ * // $ gcloud auth application-default login
31970
+ * // ```
31971
+ * // - Install the npm module by running:
31972
+ * // ```sh
31973
+ * // $ npm install googleapis
31974
+ * // ```
31975
+ *
31976
+ * const {google} = require('googleapis');
31977
+ * const discoveryengine = google.discoveryengine('v1alpha');
31978
+ *
31979
+ * async function main() {
31980
+ * const auth = new google.auth.GoogleAuth({
31981
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
31982
+ * scopes: [
31983
+ * 'https://www.googleapis.com/auth/cloud-platform',
31984
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
31985
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
31986
+ * ],
31987
+ * });
31988
+ *
31989
+ * // Acquire an auth client, and bind it to all future calls
31990
+ * const authClient = await auth.getClient();
31991
+ * google.options({auth: authClient});
31992
+ *
31993
+ * // Do the magic
31994
+ * const res =
31995
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.getIamPolicy(
31274
31996
  * {
31275
- * // Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31276
- * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
31997
+ * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
31998
+ * 'options.requestedPolicyVersion': 'placeholder-value',
31999
+ * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
32000
+ * resource:
32001
+ * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
31277
32002
  * },
31278
32003
  * );
31279
32004
  * console.log(res.data);
31280
32005
  *
31281
32006
  * // Example response
31282
32007
  * // {
31283
- * // "a2aAgentDefinition": {},
31284
- * // "adkAgentDefinition": {},
31285
- * // "authorizationConfig": {},
31286
- * // "createTime": "my_createTime",
31287
- * // "customPlaceholderText": "my_customPlaceholderText",
31288
- * // "deploymentFailureReason": "my_deploymentFailureReason",
31289
- * // "description": "my_description",
31290
- * // "dialogflowAgentDefinition": {},
31291
- * // "displayName": "my_displayName",
31292
- * // "icon": {},
31293
- * // "languageCode": "my_languageCode",
31294
- * // "name": "my_name",
31295
- * // "rejectionReason": "my_rejectionReason",
31296
- * // "starterPrompts": [],
31297
- * // "state": "my_state",
31298
- * // "suspensionReason": "my_suspensionReason",
31299
- * // "updateTime": "my_updateTime"
32008
+ * // "bindings": [],
32009
+ * // "etag": "my_etag",
32010
+ * // "version": 0
31300
32011
  * // }
31301
32012
  * }
31302
32013
  *
@@ -31312,12 +32023,12 @@ export declare namespace discoveryengine_v1alpha {
31312
32023
  * @param callback - Optional callback that handles the response.
31313
32024
  * @returns A promise if used with async/await, or void if used with a callback.
31314
32025
  */
31315
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31316
- get(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
31317
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31318
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31319
- get(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31320
- get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
32026
+ getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getiampolicy, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
32027
+ getIamPolicy(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getiampolicy, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIamV1Policy>>;
32028
+ getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
32029
+ getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$GoogleIamV1Policy>, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
32030
+ getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getiampolicy, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
32031
+ getIamPolicy(callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
31321
32032
  /**
31322
32033
  * Lists all Agents under an Assistant which were created by the caller.
31323
32034
  * @example
@@ -31452,6 +32163,7 @@ export declare namespace discoveryengine_v1alpha {
31452
32163
  * // "languageCode": "my_languageCode",
31453
32164
  * // "name": "my_name",
31454
32165
  * // "rejectionReason": "my_rejectionReason",
32166
+ * // "sharingConfig": {},
31455
32167
  * // "starterPrompts": [],
31456
32168
  * // "state": "my_state",
31457
32169
  * // "suspensionReason": "my_suspensionReason",
@@ -31477,6 +32189,7 @@ export declare namespace discoveryengine_v1alpha {
31477
32189
  * // "languageCode": "my_languageCode",
31478
32190
  * // "name": "my_name",
31479
32191
  * // "rejectionReason": "my_rejectionReason",
32192
+ * // "sharingConfig": {},
31480
32193
  * // "starterPrompts": [],
31481
32194
  * // "state": "my_state",
31482
32195
  * // "suspensionReason": "my_suspensionReason",
@@ -31502,6 +32215,170 @@ export declare namespace discoveryengine_v1alpha {
31502
32215
  patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31503
32216
  patch(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31504
32217
  patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
32218
+ /**
32219
+ * Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.
32220
+ * @example
32221
+ * ```js
32222
+ * // Before running the sample:
32223
+ * // - Enable the API at:
32224
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
32225
+ * // - Login into gcloud by running:
32226
+ * // ```sh
32227
+ * // $ gcloud auth application-default login
32228
+ * // ```
32229
+ * // - Install the npm module by running:
32230
+ * // ```sh
32231
+ * // $ npm install googleapis
32232
+ * // ```
32233
+ *
32234
+ * const {google} = require('googleapis');
32235
+ * const discoveryengine = google.discoveryengine('v1alpha');
32236
+ *
32237
+ * async function main() {
32238
+ * const auth = new google.auth.GoogleAuth({
32239
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
32240
+ * scopes: [
32241
+ * 'https://www.googleapis.com/auth/cloud-platform',
32242
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
32243
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
32244
+ * ],
32245
+ * });
32246
+ *
32247
+ * // Acquire an auth client, and bind it to all future calls
32248
+ * const authClient = await auth.getClient();
32249
+ * google.options({auth: authClient});
32250
+ *
32251
+ * // Do the magic
32252
+ * const res =
32253
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.setIamPolicy(
32254
+ * {
32255
+ * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
32256
+ * resource:
32257
+ * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
32258
+ *
32259
+ * // Request body metadata
32260
+ * requestBody: {
32261
+ * // request body parameters
32262
+ * // {
32263
+ * // "policy": {}
32264
+ * // }
32265
+ * },
32266
+ * },
32267
+ * );
32268
+ * console.log(res.data);
32269
+ *
32270
+ * // Example response
32271
+ * // {
32272
+ * // "bindings": [],
32273
+ * // "etag": "my_etag",
32274
+ * // "version": 0
32275
+ * // }
32276
+ * }
32277
+ *
32278
+ * main().catch(e => {
32279
+ * console.error(e);
32280
+ * throw e;
32281
+ * });
32282
+ *
32283
+ * ```
32284
+ *
32285
+ * @param params - Parameters for request
32286
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
32287
+ * @param callback - Optional callback that handles the response.
32288
+ * @returns A promise if used with async/await, or void if used with a callback.
32289
+ */
32290
+ setIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Setiampolicy, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
32291
+ setIamPolicy(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Setiampolicy, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIamV1Policy>>;
32292
+ setIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
32293
+ setIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$GoogleIamV1Policy>, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
32294
+ setIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Setiampolicy, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
32295
+ setIamPolicy(callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
32296
+ /**
32297
+ * Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.
32298
+ * @example
32299
+ * ```js
32300
+ * // Before running the sample:
32301
+ * // - Enable the API at:
32302
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
32303
+ * // - Login into gcloud by running:
32304
+ * // ```sh
32305
+ * // $ gcloud auth application-default login
32306
+ * // ```
32307
+ * // - Install the npm module by running:
32308
+ * // ```sh
32309
+ * // $ npm install googleapis
32310
+ * // ```
32311
+ *
32312
+ * const {google} = require('googleapis');
32313
+ * const discoveryengine = google.discoveryengine('v1alpha');
32314
+ *
32315
+ * async function main() {
32316
+ * const auth = new google.auth.GoogleAuth({
32317
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
32318
+ * scopes: [
32319
+ * 'https://www.googleapis.com/auth/cloud-platform',
32320
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
32321
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
32322
+ * ],
32323
+ * });
32324
+ *
32325
+ * // Acquire an auth client, and bind it to all future calls
32326
+ * const authClient = await auth.getClient();
32327
+ * google.options({auth: authClient});
32328
+ *
32329
+ * // Do the magic
32330
+ * const res =
32331
+ * await discoveryengine.projects.locations.collections.engines.assistants.agents.suspendAgent(
32332
+ * {
32333
+ * // Required. The name of the Agent to suspend. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
32334
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
32335
+ * // Required. The reason for suspending the Agent. This will be shown to the users of the Agent.
32336
+ * suspensionReason: 'placeholder-value',
32337
+ * },
32338
+ * );
32339
+ * console.log(res.data);
32340
+ *
32341
+ * // Example response
32342
+ * // {
32343
+ * // "a2aAgentDefinition": {},
32344
+ * // "adkAgentDefinition": {},
32345
+ * // "authorizationConfig": {},
32346
+ * // "createTime": "my_createTime",
32347
+ * // "customPlaceholderText": "my_customPlaceholderText",
32348
+ * // "deploymentFailureReason": "my_deploymentFailureReason",
32349
+ * // "description": "my_description",
32350
+ * // "dialogflowAgentDefinition": {},
32351
+ * // "displayName": "my_displayName",
32352
+ * // "icon": {},
32353
+ * // "languageCode": "my_languageCode",
32354
+ * // "name": "my_name",
32355
+ * // "rejectionReason": "my_rejectionReason",
32356
+ * // "sharingConfig": {},
32357
+ * // "starterPrompts": [],
32358
+ * // "state": "my_state",
32359
+ * // "suspensionReason": "my_suspensionReason",
32360
+ * // "updateTime": "my_updateTime"
32361
+ * // }
32362
+ * }
32363
+ *
32364
+ * main().catch(e => {
32365
+ * console.error(e);
32366
+ * throw e;
32367
+ * });
32368
+ *
32369
+ * ```
32370
+ *
32371
+ * @param params - Parameters for request
32372
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
32373
+ * @param callback - Optional callback that handles the response.
32374
+ * @returns A promise if used with async/await, or void if used with a callback.
32375
+ */
32376
+ suspendAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Suspendagent, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
32377
+ suspendAgent(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Suspendagent, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAgent>>;
32378
+ suspendAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Suspendagent, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
32379
+ suspendAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Suspendagent, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
32380
+ suspendAgent(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Suspendagent, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
32381
+ suspendAgent(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAgent>): void;
31505
32382
  }
31506
32383
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Create extends StandardParameters {
31507
32384
  /**
@@ -31519,12 +32396,48 @@ export declare namespace discoveryengine_v1alpha {
31519
32396
  */
31520
32397
  name?: string;
31521
32398
  }
32399
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Disableagent extends StandardParameters {
32400
+ /**
32401
+ * Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
32402
+ */
32403
+ name?: string;
32404
+ }
32405
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent extends StandardParameters {
32406
+ /**
32407
+ * Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
32408
+ */
32409
+ name?: string;
32410
+ }
31522
32411
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get extends StandardParameters {
31523
32412
  /**
31524
32413
  * Required. Resource name of Agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31525
32414
  */
31526
32415
  name?: string;
31527
32416
  }
32417
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getagentview extends StandardParameters {
32418
+ /**
32419
+ * Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.
32420
+ */
32421
+ languageCode?: string;
32422
+ /**
32423
+ * Optional. The maximum number of suggested prompts to return per agent.
32424
+ */
32425
+ maxSuggestedPrompts?: number;
32426
+ /**
32427
+ * Required. The name of the Agent to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
32428
+ */
32429
+ name?: string;
32430
+ }
32431
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Getiampolicy extends StandardParameters {
32432
+ /**
32433
+ * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
32434
+ */
32435
+ 'options.requestedPolicyVersion'?: number;
32436
+ /**
32437
+ * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
32438
+ */
32439
+ resource?: string;
32440
+ }
31528
32441
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$List extends StandardParameters {
31529
32442
  /**
31530
32443
  * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time.
@@ -31557,6 +32470,26 @@ export declare namespace discoveryengine_v1alpha {
31557
32470
  */
31558
32471
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAgent;
31559
32472
  }
32473
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Setiampolicy extends StandardParameters {
32474
+ /**
32475
+ * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
32476
+ */
32477
+ resource?: string;
32478
+ /**
32479
+ * Request body metadata
32480
+ */
32481
+ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest;
32482
+ }
32483
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Suspendagent extends StandardParameters {
32484
+ /**
32485
+ * Required. The name of the Agent to suspend. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
32486
+ */
32487
+ name?: string;
32488
+ /**
32489
+ * Required. The reason for suspending the Agent. This will be shown to the users of the Agent.
32490
+ */
32491
+ suspensionReason?: string;
32492
+ }
31560
32493
  export class Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Files {
31561
32494
  context: APIRequestContext;
31562
32495
  constructor(context: APIRequestContext);
@@ -47443,6 +48376,7 @@ export declare namespace discoveryengine_v1alpha {
47443
48376
  }
47444
48377
  export class Resource$Projects$Locations$Userstores {
47445
48378
  context: APIRequestContext;
48379
+ licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
47446
48380
  operations: Resource$Projects$Locations$Userstores$Operations;
47447
48381
  userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
47448
48382
  constructor(context: APIRequestContext);
@@ -47873,6 +48807,83 @@ export declare namespace discoveryengine_v1alpha {
47873
48807
  */
47874
48808
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserStore;
47875
48809
  }
48810
+ export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
48811
+ context: APIRequestContext;
48812
+ constructor(context: APIRequestContext);
48813
+ /**
48814
+ * Lists all the LicenseConfigUsageStatss associated with the project.
48815
+ * @example
48816
+ * ```js
48817
+ * // Before running the sample:
48818
+ * // - Enable the API at:
48819
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
48820
+ * // - Login into gcloud by running:
48821
+ * // ```sh
48822
+ * // $ gcloud auth application-default login
48823
+ * // ```
48824
+ * // - Install the npm module by running:
48825
+ * // ```sh
48826
+ * // $ npm install googleapis
48827
+ * // ```
48828
+ *
48829
+ * const {google} = require('googleapis');
48830
+ * const discoveryengine = google.discoveryengine('v1alpha');
48831
+ *
48832
+ * async function main() {
48833
+ * const auth = new google.auth.GoogleAuth({
48834
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
48835
+ * scopes: [
48836
+ * 'https://www.googleapis.com/auth/cloud-platform',
48837
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
48838
+ * ],
48839
+ * });
48840
+ *
48841
+ * // Acquire an auth client, and bind it to all future calls
48842
+ * const authClient = await auth.getClient();
48843
+ * google.options({auth: authClient});
48844
+ *
48845
+ * // Do the magic
48846
+ * const res =
48847
+ * await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
48848
+ * {
48849
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
48850
+ * parent:
48851
+ * 'projects/my-project/locations/my-location/userStores/my-userStore',
48852
+ * },
48853
+ * );
48854
+ * console.log(res.data);
48855
+ *
48856
+ * // Example response
48857
+ * // {
48858
+ * // "licenseConfigUsageStats": []
48859
+ * // }
48860
+ * }
48861
+ *
48862
+ * main().catch(e => {
48863
+ * console.error(e);
48864
+ * throw e;
48865
+ * });
48866
+ *
48867
+ * ```
48868
+ *
48869
+ * @param params - Parameters for request
48870
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
48871
+ * @param callback - Optional callback that handles the response.
48872
+ * @returns A promise if used with async/await, or void if used with a callback.
48873
+ */
48874
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
48875
+ list(params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse>>;
48876
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
48877
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse>): void;
48878
+ list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse>): void;
48879
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse>): void;
48880
+ }
48881
+ export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List extends StandardParameters {
48882
+ /**
48883
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
48884
+ */
48885
+ parent?: string;
48886
+ }
47876
48887
  export class Resource$Projects$Locations$Userstores$Operations {
47877
48888
  context: APIRequestContext;
47878
48889
  constructor(context: APIRequestContext);
@@ -48085,7 +49096,7 @@ export declare namespace discoveryengine_v1alpha {
48085
49096
  * // Do the magic
48086
49097
  * const res =
48087
49098
  * await discoveryengine.projects.locations.userStores.userLicenses.list({
48088
- * // 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.
49099
+ * // Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
48089
49100
  * filter: 'placeholder-value',
48090
49101
  * // 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.
48091
49102
  * pageSize: 'placeholder-value',
@@ -48125,7 +49136,7 @@ export declare namespace discoveryengine_v1alpha {
48125
49136
  }
48126
49137
  export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
48127
49138
  /**
48128
- * 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.
49139
+ * Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
48129
49140
  */
48130
49141
  filter?: string;
48131
49142
  /**