@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.1.20260204 → 0.1.20260209

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.
Files changed (2) hide show
  1. package/index.d.ts +258 -301
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20260204
12
+ // Revision: 20260209
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -429,60 +429,6 @@ declare namespace gapi.client {
429
429
  /** Required. The text of the starter prompt. */
430
430
  text?: string;
431
431
  }
432
- interface GoogleCloudDiscoveryengineV1alphaAgentView {
433
- /** Immutable. The origin of the Agent. */
434
- agentOrigin?: string;
435
- /** Output only. The sharing state of the agent. */
436
- agentSharingState?: string;
437
- /** Output only. The type of the agent. */
438
- agentType?: string;
439
- /** The custom placeholder text that appears in the text box before the user enters any text. */
440
- customPlaceholderText?: string;
441
- /** The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. */
442
- deploymentFailureReason?: string;
443
- /** 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. */
444
- description?: string;
445
- /** Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled. */
446
- displayName?: string;
447
- /** Optional. The icon that represents the agent on the UI. */
448
- icon?: GoogleCloudDiscoveryengineV1alphaAgentImage;
449
- /** Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` */
450
- name?: string;
451
- /** The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection. */
452
- rejectionReason?: string;
453
- /** Output only. The state of the Agent. */
454
- state?: string;
455
- /** Optional. The suggested prompts for the agent, to be shown on the agent landing page. */
456
- suggestedPrompts?: GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt[];
457
- /** The reason why the agent was suspended. Only set if the state is SUSPENDED. */
458
- suspensionReason?: string;
459
- /** Output only. The timestamp when the agent was last updated. */
460
- updateTime?: string;
461
- /** Optional. Per-user annotations of the current caller for the agent. */
462
- userAnnotations?: GoogleCloudDiscoveryengineV1alphaUserAnnotations;
463
- /** The permissions of the user for this Agent. */
464
- userPermissions?: GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions;
465
- }
466
- interface GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt {
467
- /** Required. The text of the suggested prompt. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled. */
468
- text?: string;
469
- }
470
- interface GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions {
471
- /** If the user can delete this Agent. */
472
- canDelete?: boolean;
473
- /** If the user can edit this Agent. */
474
- canEdit?: boolean;
475
- /** If the user can propose other users to share the Agent with. */
476
- canProposeUsers?: boolean;
477
- /** If the user can request a review for this Agent. */
478
- canRequestReview?: boolean;
479
- /** If the user can run this Agent. */
480
- canRun?: boolean;
481
- /** If the user can view the source of this Agent. */
482
- canView?: boolean;
483
- /** If the user can withdraw this Agent. */
484
- canWithdraw?: boolean;
485
- }
486
432
  interface GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig {
487
433
  /** Optional. The enrollment states of each alert. */
488
434
  alertEnrollments?: GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment[];
@@ -504,6 +450,8 @@ declare namespace gapi.client {
504
450
  contactDetails?: GoogleCloudDiscoveryengineV1alphaContactDetails[];
505
451
  /** Optional. The language code used for notifications */
506
452
  languageCode?: string;
453
+ /** Optional. The region code used of the user that subscribed to the alert policy. */
454
+ regionCode?: string;
507
455
  }
508
456
  interface GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment {
509
457
  /** Immutable. The id of an alert. */
@@ -1315,6 +1263,10 @@ declare namespace gapi.client {
1315
1263
  interface GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig {
1316
1264
  /** Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date. */
1317
1265
  autoRenew?: boolean;
1266
+ /** Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. */
1267
+ earlyTerminated?: boolean;
1268
+ /** The date when the subscription is terminated earlier than the expiration date. */
1269
+ earlyTerminationDate?: GoogleTypeDate;
1318
1270
  /** Optional. The planed subscription end date. */
1319
1271
  endDate?: GoogleTypeDate;
1320
1272
  /** Whether the license config is for Gemini bundle. */
@@ -1586,6 +1538,10 @@ declare namespace gapi.client {
1586
1538
  /** Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1587
1539
  name?: string;
1588
1540
  }
1541
+ interface GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse {
1542
+ /** The list of external identities that match the query. */
1543
+ externalIdentities?: GoogleCloudDiscoveryengineV1alphaExternalIdentity[];
1544
+ }
1589
1545
  interface GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse {
1590
1546
  /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
1591
1547
  querySuggestions?: GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion[];
@@ -1920,6 +1876,8 @@ declare namespace gapi.client {
1920
1876
  createEuaSaas?: boolean;
1921
1877
  /** Output only. Timestamp the DataConnector was created at. */
1922
1878
  createTime?: string;
1879
+ /** Optional. Specifies the data protection policy for the connector. */
1880
+ dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
1923
1881
  /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
1924
1882
  dataSource?: string;
1925
1883
  /** Optional. Any target destinations used to connect to third-party services. */
@@ -2025,6 +1983,14 @@ declare namespace gapi.client {
2025
1983
  /** Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
2026
1984
  startingSchema?: GoogleCloudDiscoveryengineV1alphaSchema;
2027
1985
  }
1986
+ interface GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy {
1987
+ /** Optional. The sensitive data protection policy for the connector source. */
1988
+ sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy;
1989
+ }
1990
+ interface GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy {
1991
+ /** Optional. The Sensitive Data Protection content policy resource name. */
1992
+ policy?: string;
1993
+ }
2028
1994
  interface GoogleCloudDiscoveryengineV1alphaDataStore {
2029
1995
  /** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
2030
1996
  aclEnabled?: boolean;
@@ -2570,6 +2536,25 @@ declare namespace gapi.client {
2570
2536
  outputConfig?: GoogleCloudDiscoveryengineV1alphaOutputConfig;
2571
2537
  }
2572
2538
  interface GoogleCloudDiscoveryengineV1alphaExportMetricsResponse {}
2539
+ interface GoogleCloudDiscoveryengineV1alphaExternalIdentity {
2540
+ /** The display name of the user or group. */
2541
+ displayName?: string;
2542
+ /** The unique 3P ID(external_id) of the entity (user or group). */
2543
+ externalId?: string;
2544
+ /** Metadata corresponding to the external user. */
2545
+ groupMetadata?: any;
2546
+ /** Metadata corresponding to the external user. */
2547
+ userMetadata?: GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata;
2548
+ }
2549
+ interface GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata {}
2550
+ interface GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata {
2551
+ /** The user's family name. */
2552
+ familyName?: string;
2553
+ /** The user's given name. */
2554
+ givenName?: string;
2555
+ /** The user's primary email address. */
2556
+ primaryEmail?: string;
2557
+ }
2573
2558
  interface GoogleCloudDiscoveryengineV1alphaFactChunk {
2574
2559
  /** Text content of the fact chunk. Can be at most 10K characters long. */
2575
2560
  chunkText?: string;
@@ -2702,10 +2687,6 @@ declare namespace gapi.client {
2702
2687
  /** Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
2703
2688
  inputUris?: string[];
2704
2689
  }
2705
- interface GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse {
2706
- /** The data for displaying an Agent. */
2707
- agentView?: GoogleCloudDiscoveryengineV1alphaAgentView;
2708
- }
2709
2690
  interface GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse {
2710
2691
  /** The app name of the associated Connector. */
2711
2692
  app?: string;
@@ -3031,6 +3012,10 @@ declare namespace gapi.client {
3031
3012
  alertPolicyResourceConfig?: GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig;
3032
3013
  /** Optional. Whether the license config should be auto renewed when it reaches the end date. */
3033
3014
  autoRenew?: boolean;
3015
+ /** Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. */
3016
+ earlyTerminated?: boolean;
3017
+ /** Output only. The date when the subscription is terminated earlier than the expiration date. */
3018
+ earlyTerminationDate?: GoogleTypeDate;
3034
3019
  /** Optional. The planed end date. */
3035
3020
  endDate?: GoogleTypeDate;
3036
3021
  /** Optional. Whether the license config is for free trial. */
@@ -3074,12 +3059,6 @@ declare namespace gapi.client {
3074
3059
  /** A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
3075
3060
  nextPageToken?: string;
3076
3061
  }
3077
- interface GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse {
3078
- /** The agent sources visible to the caller under the parent Assistant. */
3079
- agentViews?: GoogleCloudDiscoveryengineV1alphaAgentView[];
3080
- /** 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. */
3081
- nextPageToken?: string;
3082
- }
3083
3062
  interface GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse {
3084
3063
  /** All BillingAccountLicenseConfigs for the given billing account. */
3085
3064
  billingAccountLicenseConfigs?: GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig[];
@@ -3371,6 +3350,8 @@ declare namespace gapi.client {
3371
3350
  notebooklmConfig?: GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
3372
3351
  }
3373
3352
  interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig {
3353
+ /** Optional. Specifies the data protection policy for NotebookLM. */
3354
+ dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy;
3374
3355
  /** Model Armor configuration to be used for sanitizing user prompts and LLM responses. */
3375
3356
  modelArmorConfig?: GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
3376
3357
  /** Optional. Observability config for NotebookLM. */
@@ -3378,6 +3359,14 @@ declare namespace gapi.client {
3378
3359
  /** Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. */
3379
3360
  optOutNotebookSharing?: boolean;
3380
3361
  }
3362
+ interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy {
3363
+ /** Optional. The sensitive data protection policy. */
3364
+ sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy;
3365
+ }
3366
+ interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy {
3367
+ /** Optional. The Sensitive Data Protection policy resource name. */
3368
+ policy?: string;
3369
+ }
3381
3370
  interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
3382
3371
  /** Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response. */
3383
3372
  responseTemplate?: string;
@@ -3530,6 +3519,8 @@ declare namespace gapi.client {
3530
3519
  top5?: number;
3531
3520
  }
3532
3521
  interface GoogleCloudDiscoveryengineV1alphaQuery {
3522
+ /** Query content parts. */
3523
+ parts?: GoogleCloudDiscoveryengineV1alphaQueryPart[];
3533
3524
  /** Output only. Unique Id for the query. */
3534
3525
  queryId?: string;
3535
3526
  /** Plain text. */
@@ -3553,6 +3544,64 @@ declare namespace gapi.client {
3553
3544
  /** The total usage for this resource type. This is populated for metrics like TOTAL_STORAGE. */
3554
3545
  totalUsage?: number;
3555
3546
  }
3547
+ interface GoogleCloudDiscoveryengineV1alphaQueryPart {
3548
+ /** Other VAIS Document references. */
3549
+ documentReference?: GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference;
3550
+ /** Reference to a Google Drive document. */
3551
+ driveDocumentReference?: GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference;
3552
+ /** Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field. */
3553
+ mimeType?: string;
3554
+ /** Reference to a person. */
3555
+ personReference?: GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference;
3556
+ /** Text content. */
3557
+ text?: string;
3558
+ /** This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages. */
3559
+ uiJsonPayload?: string;
3560
+ }
3561
+ interface GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference {
3562
+ /** The destination uri of the reference. */
3563
+ destinationUri?: string;
3564
+ /** The display title of the reference. */
3565
+ displayTitle?: string;
3566
+ /** The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. */
3567
+ documentName?: string;
3568
+ /** Output only. The file id of the document data stored in the session context files. */
3569
+ fileId?: string;
3570
+ /** The icon uri of the reference. */
3571
+ iconUri?: string;
3572
+ /** Input only. The url_for_connector of the document returned by Federated Search. */
3573
+ urlForConnector?: string;
3574
+ }
3575
+ interface GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference {
3576
+ /** The destination uri of the reference. */
3577
+ destinationUri?: string;
3578
+ /** The display title of the reference. */
3579
+ displayTitle?: string;
3580
+ /** The full resource name of the document. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/branches/*‍/documents/*`. */
3581
+ documentName?: string;
3582
+ /** The Drive id of the document. */
3583
+ driveId?: string;
3584
+ /** Output only. The file id of the Drive document data stored in the session context files. */
3585
+ fileId?: string;
3586
+ /** The icon uri of the Drive document reference. */
3587
+ iconUri?: string;
3588
+ }
3589
+ interface GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference {
3590
+ /** The destination uri of the person. */
3591
+ destinationUri?: string;
3592
+ /** The display name of the person. */
3593
+ displayName?: string;
3594
+ /** The display photo url of the person. */
3595
+ displayPhotoUri?: string;
3596
+ /** The full resource name of the person. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/branches/*‍/documents/*`. */
3597
+ documentName?: string;
3598
+ /** The email of the person. */
3599
+ email?: string;
3600
+ /** Output only. The file id of the person data stored in the session context files. */
3601
+ fileId?: string;
3602
+ /** The person id of the person. */
3603
+ personId?: string;
3604
+ }
3556
3605
  interface GoogleCloudDiscoveryengineV1alphaRankingRecord {
3557
3606
  /** The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
3558
3607
  content?: string;
@@ -3908,6 +3957,8 @@ declare namespace gapi.client {
3908
3957
  languageCode?: string;
3909
3958
  /** Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */
3910
3959
  naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
3960
+ /** Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit. */
3961
+ numResultsPerDataStore?: number;
3911
3962
  /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */
3912
3963
  offset?: number;
3913
3964
  /** The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. */
@@ -4082,6 +4133,8 @@ declare namespace gapi.client {
4082
4133
  dataStore?: string;
4083
4134
  /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
4084
4135
  filter?: string;
4136
+ /** Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used. */
4137
+ numResults?: number;
4085
4138
  }
4086
4139
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec {
4087
4140
  /** The condition under which match highlighting should occur. */
@@ -4641,6 +4694,8 @@ declare namespace gapi.client {
4641
4694
  syncSinceTimestamp?: string;
4642
4695
  }
4643
4696
  interface GoogleCloudDiscoveryengineV1alphaStreamAssistRequest {
4697
+ /** Optional. Specification of actions for the request. */
4698
+ actionSpec?: GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec;
4644
4699
  /** Optional. Specification of the generation configuration for the request. */
4645
4700
  generationSpec?: GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec;
4646
4701
  /** Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. */
@@ -4652,6 +4707,10 @@ declare namespace gapi.client {
4652
4707
  /** Optional. Information about the user initiating the query. */
4653
4708
  userMetadata?: GoogleCloudDiscoveryengineV1alphaAssistUserMetadata;
4654
4709
  }
4710
+ interface GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec {
4711
+ /** Optional. If true, actions will not be served for the request. This only works for enterprise edition. */
4712
+ actionDisabled?: boolean;
4713
+ }
4655
4714
  interface GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec {
4656
4715
  /** Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. */
4657
4716
  modelId?: string;
@@ -4827,12 +4886,6 @@ declare namespace gapi.client {
4827
4886
  /** Operation last update time. If the operation is done, this is also the finish time. */
4828
4887
  updateTime?: string;
4829
4888
  }
4830
- interface GoogleCloudDiscoveryengineV1alphaUserAnnotations {
4831
- /** Optional. Whether the agent is pinned, pinned agent will be displayed on the top of the agent list. */
4832
- pinned?: boolean;
4833
- /** Optional. Whether the agent has been viewed by the user. */
4834
- viewed?: boolean;
4835
- }
4836
4889
  interface GoogleCloudDiscoveryengineV1alphaUserEvent {
4837
4890
  /** Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. */
4838
4891
  attributes?: {
@@ -5994,6 +6047,10 @@ declare namespace gapi.client {
5994
6047
  interface GoogleCloudDiscoveryengineV1betaLicenseConfig {
5995
6048
  /** Optional. Whether the license config should be auto renewed when it reaches the end date. */
5996
6049
  autoRenew?: boolean;
6050
+ /** Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. */
6051
+ earlyTerminated?: boolean;
6052
+ /** Output only. The date when the subscription is terminated earlier than the expiration date. */
6053
+ earlyTerminationDate?: GoogleTypeDate;
5997
6054
  /** Optional. The planed end date. */
5998
6055
  endDate?: GoogleTypeDate;
5999
6056
  /** Optional. Whether the license config is for free trial. */
@@ -6074,6 +6131,8 @@ declare namespace gapi.client {
6074
6131
  notebooklmConfig?: GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
6075
6132
  }
6076
6133
  interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig {
6134
+ /** Optional. Specifies the data protection policy for NotebookLM. */
6135
+ dataProtectionPolicy?: GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy;
6077
6136
  /** Model Armor configuration to be used for sanitizing user prompts and LLM responses. */
6078
6137
  modelArmorConfig?: GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
6079
6138
  /** Optional. Observability config for NotebookLM. */
@@ -6081,6 +6140,14 @@ declare namespace gapi.client {
6081
6140
  /** Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. */
6082
6141
  optOutNotebookSharing?: boolean;
6083
6142
  }
6143
+ interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy {
6144
+ /** Optional. The sensitive data protection policy. */
6145
+ sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy;
6146
+ }
6147
+ interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy {
6148
+ /** Optional. The Sensitive Data Protection policy resource name. */
6149
+ policy?: string;
6150
+ }
6084
6151
  interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
6085
6152
  /** Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response. */
6086
6153
  responseTemplate?: string;
@@ -6213,6 +6280,8 @@ declare namespace gapi.client {
6213
6280
  languageCode?: string;
6214
6281
  /** Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */
6215
6282
  naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
6283
+ /** Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit. */
6284
+ numResultsPerDataStore?: number;
6216
6285
  /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. */
6217
6286
  offset?: number;
6218
6287
  /** The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. */
@@ -6385,6 +6454,8 @@ declare namespace gapi.client {
6385
6454
  dataStore?: string;
6386
6455
  /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
6387
6456
  filter?: string;
6457
+ /** Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used. */
6458
+ numResults?: number;
6388
6459
  }
6389
6460
  interface GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec {
6390
6461
  /** The condition under which match highlighting should occur. */
@@ -7343,6 +7414,10 @@ declare namespace gapi.client {
7343
7414
  interface GoogleCloudDiscoveryengineV1LicenseConfig {
7344
7415
  /** Optional. Whether the license config should be auto renewed when it reaches the end date. */
7345
7416
  autoRenew?: boolean;
7417
+ /** Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. */
7418
+ earlyTerminated?: boolean;
7419
+ /** Output only. The date when the subscription is terminated earlier than the expiration date. */
7420
+ earlyTerminationDate?: GoogleTypeDate;
7346
7421
  /** Optional. The planed end date. */
7347
7422
  endDate?: GoogleTypeDate;
7348
7423
  /** Optional. Whether the license config is for free trial. */
@@ -7407,6 +7482,8 @@ declare namespace gapi.client {
7407
7482
  notebooklmConfig?: GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
7408
7483
  }
7409
7484
  interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig {
7485
+ /** Optional. Specifies the data protection policy for NotebookLM. */
7486
+ dataProtectionPolicy?: GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy;
7410
7487
  /** Model Armor configuration to be used for sanitizing user prompts and LLM responses. */
7411
7488
  modelArmorConfig?: GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
7412
7489
  /** Optional. Observability config for NotebookLM. */
@@ -7414,6 +7491,14 @@ declare namespace gapi.client {
7414
7491
  /** Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. */
7415
7492
  optOutNotebookSharing?: boolean;
7416
7493
  }
7494
+ interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy {
7495
+ /** Optional. The sensitive data protection policy. */
7496
+ sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy;
7497
+ }
7498
+ interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy {
7499
+ /** Optional. The Sensitive Data Protection policy resource name. */
7500
+ policy?: string;
7501
+ }
7417
7502
  interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
7418
7503
  /** Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response. */
7419
7504
  responseTemplate?: string;
@@ -8911,7 +8996,7 @@ declare namespace gapi.client {
8911
8996
  key?: string;
8912
8997
  /** OAuth 2.0 token for the current user. */
8913
8998
  oauth_token?: string;
8914
- /** Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collection_id}/dataConnector */
8999
+ /** Required. Connector name of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector` */
8915
9000
  parent: string;
8916
9001
  /** Returns response with indentations and line breaks. */
8917
9002
  prettyPrint?: boolean;
@@ -8940,7 +9025,7 @@ declare namespace gapi.client {
8940
9025
  key?: string;
8941
9026
  /** OAuth 2.0 token for the current user. */
8942
9027
  oauth_token?: string;
8943
- /** Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collection_id}/dataConnector */
9028
+ /** Required. Connector name of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector` */
8944
9029
  parent: string;
8945
9030
  /** Returns response with indentations and line breaks. */
8946
9031
  prettyPrint?: boolean;
@@ -13730,64 +13815,6 @@ declare namespace gapi.client {
13730
13815
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13731
13816
  uploadType?: string;
13732
13817
  }): Request<GoogleLongrunningOperation>;
13733
- /** 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. */
13734
- disableAgent(request?: {
13735
- /** V1 error format. */
13736
- '$.xgafv'?: string;
13737
- /** OAuth access token. */
13738
- access_token?: string;
13739
- /** Data format for response. */
13740
- alt?: string;
13741
- /** JSONP */
13742
- callback?: string;
13743
- /** Selector specifying which fields to include in a partial response. */
13744
- fields?: string;
13745
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
13746
- key?: string;
13747
- /** Required. The name of the Agent to disable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` */
13748
- name: string;
13749
- /** OAuth 2.0 token for the current user. */
13750
- oauth_token?: string;
13751
- /** Returns response with indentations and line breaks. */
13752
- prettyPrint?: boolean;
13753
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
13754
- quotaUser?: string;
13755
- /** Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled. */
13756
- revisionId?: string;
13757
- /** Upload protocol for media (e.g. "raw", "multipart"). */
13758
- upload_protocol?: string;
13759
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13760
- uploadType?: string;
13761
- }): Request<GoogleCloudDiscoveryengineV1alphaAgent>;
13762
- /** 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. */
13763
- enableAgent(request?: {
13764
- /** V1 error format. */
13765
- '$.xgafv'?: string;
13766
- /** OAuth access token. */
13767
- access_token?: string;
13768
- /** Data format for response. */
13769
- alt?: string;
13770
- /** JSONP */
13771
- callback?: string;
13772
- /** Selector specifying which fields to include in a partial response. */
13773
- fields?: string;
13774
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
13775
- key?: string;
13776
- /** Required. The name of the Agent to enable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` */
13777
- name: string;
13778
- /** OAuth 2.0 token for the current user. */
13779
- oauth_token?: string;
13780
- /** Returns response with indentations and line breaks. */
13781
- prettyPrint?: boolean;
13782
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
13783
- quotaUser?: string;
13784
- /** Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled. */
13785
- revisionId?: string;
13786
- /** Upload protocol for media (e.g. "raw", "multipart"). */
13787
- upload_protocol?: string;
13788
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13789
- uploadType?: string;
13790
- }): Request<GoogleCloudDiscoveryengineV1alphaAgent>;
13791
13818
  /** Gets an Agent. */
13792
13819
  get(request?: {
13793
13820
  /** V1 error format. */
@@ -13815,68 +13842,6 @@ declare namespace gapi.client {
13815
13842
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13816
13843
  uploadType?: string;
13817
13844
  }): Request<GoogleCloudDiscoveryengineV1alphaAgent>;
13818
- /** Returns a AgentView for a given Agent, which contains additional information about the Agent. */
13819
- getAgentView(request?: {
13820
- /** V1 error format. */
13821
- '$.xgafv'?: string;
13822
- /** OAuth access token. */
13823
- access_token?: string;
13824
- /** Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user. */
13825
- adminView?: boolean;
13826
- /** Data format for response. */
13827
- alt?: string;
13828
- /** JSONP */
13829
- callback?: string;
13830
- /** Selector specifying which fields to include in a partial response. */
13831
- fields?: string;
13832
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
13833
- key?: string;
13834
- /** 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. */
13835
- languageCode?: string;
13836
- /** Optional. The maximum number of suggested prompts to return per agent. */
13837
- maxSuggestedPrompts?: number;
13838
- /** Required. The name of the Agent to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` */
13839
- name: string;
13840
- /** OAuth 2.0 token for the current user. */
13841
- oauth_token?: string;
13842
- /** Returns response with indentations and line breaks. */
13843
- prettyPrint?: boolean;
13844
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
13845
- quotaUser?: string;
13846
- /** Upload protocol for media (e.g. "raw", "multipart"). */
13847
- upload_protocol?: string;
13848
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13849
- uploadType?: string;
13850
- }): Request<GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse>;
13851
- /** 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. */
13852
- getIamPolicy(request?: {
13853
- /** V1 error format. */
13854
- '$.xgafv'?: string;
13855
- /** OAuth access token. */
13856
- access_token?: string;
13857
- /** Data format for response. */
13858
- alt?: string;
13859
- /** JSONP */
13860
- callback?: string;
13861
- /** Selector specifying which fields to include in a partial response. */
13862
- fields?: string;
13863
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
13864
- key?: string;
13865
- /** OAuth 2.0 token for the current user. */
13866
- oauth_token?: string;
13867
- /** 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). */
13868
- 'options.requestedPolicyVersion'?: number;
13869
- /** Returns response with indentations and line breaks. */
13870
- prettyPrint?: boolean;
13871
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
13872
- quotaUser?: string;
13873
- /** 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. */
13874
- resource: string;
13875
- /** Upload protocol for media (e.g. "raw", "multipart"). */
13876
- upload_protocol?: string;
13877
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
13878
- uploadType?: string;
13879
- }): Request<GoogleIamV1Policy>;
13880
13845
  /** Lists all Agents under an Assistant which were created by the caller. */
13881
13846
  list(request?: {
13882
13847
  /** V1 error format. */
@@ -13972,65 +13937,6 @@ declare namespace gapi.client {
13972
13937
  },
13973
13938
  body: GoogleCloudDiscoveryengineV1alphaAgent,
13974
13939
  ): Request<GoogleCloudDiscoveryengineV1alphaAgent>;
13975
- /** 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. */
13976
- setIamPolicy(
13977
- request: {
13978
- /** V1 error format. */
13979
- '$.xgafv'?: string;
13980
- /** OAuth access token. */
13981
- access_token?: string;
13982
- /** Data format for response. */
13983
- alt?: string;
13984
- /** JSONP */
13985
- callback?: string;
13986
- /** Selector specifying which fields to include in a partial response. */
13987
- fields?: string;
13988
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
13989
- key?: string;
13990
- /** OAuth 2.0 token for the current user. */
13991
- oauth_token?: string;
13992
- /** Returns response with indentations and line breaks. */
13993
- prettyPrint?: boolean;
13994
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
13995
- quotaUser?: string;
13996
- /** 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. */
13997
- resource: string;
13998
- /** Upload protocol for media (e.g. "raw", "multipart"). */
13999
- upload_protocol?: string;
14000
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14001
- uploadType?: string;
14002
- },
14003
- body: GoogleIamV1SetIamPolicyRequest,
14004
- ): Request<GoogleIamV1Policy>;
14005
- /** 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. */
14006
- suspendAgent(request?: {
14007
- /** V1 error format. */
14008
- '$.xgafv'?: string;
14009
- /** OAuth access token. */
14010
- access_token?: string;
14011
- /** Data format for response. */
14012
- alt?: string;
14013
- /** JSONP */
14014
- callback?: string;
14015
- /** Selector specifying which fields to include in a partial response. */
14016
- fields?: string;
14017
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
14018
- key?: string;
14019
- /** Required. The name of the Agent to suspend. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` */
14020
- name: string;
14021
- /** OAuth 2.0 token for the current user. */
14022
- oauth_token?: string;
14023
- /** Returns response with indentations and line breaks. */
14024
- prettyPrint?: boolean;
14025
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
14026
- quotaUser?: string;
14027
- /** Required. The reason for suspending the Agent. This will be shown to the users of the Agent. */
14028
- suspensionReason?: string;
14029
- /** Upload protocol for media (e.g. "raw", "multipart"). */
14030
- upload_protocol?: string;
14031
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14032
- uploadType?: string;
14033
- }): Request<GoogleCloudDiscoveryengineV1alphaAgent>;
14034
13940
  files: FilesResource;
14035
13941
  operations: OperationsResource;
14036
13942
  }
@@ -14395,49 +14301,6 @@ declare namespace gapi.client {
14395
14301
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14396
14302
  uploadType?: string;
14397
14303
  }): Request<GoogleCloudDiscoveryengineV1alphaListAssistantsResponse>;
14398
- /** Lists the data for displaying the Agents under an Assistant which are available to the caller. */
14399
- listAvailableAgentViews(request?: {
14400
- /** V1 error format. */
14401
- '$.xgafv'?: string;
14402
- /** OAuth access token. */
14403
- access_token?: string;
14404
- /** Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user. */
14405
- adminView?: boolean;
14406
- /** Optional. The origin of the Agent. */
14407
- agentOrigin?: string;
14408
- /** Data format for response. */
14409
- alt?: string;
14410
- /** JSONP */
14411
- callback?: string;
14412
- /** Selector specifying which fields to include in a partial response. */
14413
- fields?: string;
14414
- /** 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. */
14415
- filter?: string;
14416
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
14417
- key?: string;
14418
- /** 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. */
14419
- languageCode?: string;
14420
- /** Optional. The maximum number of suggested prompts to return per agent. */
14421
- maxSuggestedPrompts?: number;
14422
- /** OAuth 2.0 token for the current user. */
14423
- oauth_token?: string;
14424
- /** Optional. Maximum number of AgentViews to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. */
14425
- pageSize?: number;
14426
- /** 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. */
14427
- pageToken?: string;
14428
- /** Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` */
14429
- parent: string;
14430
- /** Returns response with indentations and line breaks. */
14431
- prettyPrint?: boolean;
14432
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
14433
- quotaUser?: string;
14434
- /** 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. */
14435
- sortBy?: string;
14436
- /** Upload protocol for media (e.g. "raw", "multipart"). */
14437
- upload_protocol?: string;
14438
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14439
- uploadType?: string;
14440
- }): Request<GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse>;
14441
14304
  /** Updates an Assistant */
14442
14305
  patch(request: {
14443
14306
  /** V1 error format. */
@@ -16166,7 +16029,7 @@ declare namespace gapi.client {
16166
16029
  ): Request<GoogleCloudDiscoveryengineV1alphaWidgetConfig>;
16167
16030
  }
16168
16031
  interface EnginesResource {
16169
- /** Creates a Engine. */
16032
+ /** Creates an Engine. */
16170
16033
  create(request: {
16171
16034
  /** V1 error format. */
16172
16035
  '$.xgafv'?: string;
@@ -16228,7 +16091,7 @@ declare namespace gapi.client {
16228
16091
  },
16229
16092
  body: GoogleCloudDiscoveryengineV1alphaEngine,
16230
16093
  ): Request<GoogleLongrunningOperation>;
16231
- /** Deletes a Engine. */
16094
+ /** Deletes an Engine. */
16232
16095
  delete(request?: {
16233
16096
  /** V1 error format. */
16234
16097
  '$.xgafv'?: string;
@@ -16255,7 +16118,7 @@ declare namespace gapi.client {
16255
16118
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
16256
16119
  uploadType?: string;
16257
16120
  }): Request<GoogleLongrunningOperation>;
16258
- /** Gets a Engine. */
16121
+ /** Gets an Engine. */
16259
16122
  get(request?: {
16260
16123
  /** V1 error format. */
16261
16124
  '$.xgafv'?: string;
@@ -16282,6 +16145,35 @@ declare namespace gapi.client {
16282
16145
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
16283
16146
  uploadType?: string;
16284
16147
  }): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
16148
+ /** Gets the IAM access control policy for an Engine. 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. */
16149
+ getIamPolicy(request?: {
16150
+ /** V1 error format. */
16151
+ '$.xgafv'?: string;
16152
+ /** OAuth access token. */
16153
+ access_token?: string;
16154
+ /** Data format for response. */
16155
+ alt?: string;
16156
+ /** JSONP */
16157
+ callback?: string;
16158
+ /** Selector specifying which fields to include in a partial response. */
16159
+ fields?: string;
16160
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
16161
+ key?: string;
16162
+ /** OAuth 2.0 token for the current user. */
16163
+ oauth_token?: string;
16164
+ /** 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). */
16165
+ 'options.requestedPolicyVersion'?: number;
16166
+ /** Returns response with indentations and line breaks. */
16167
+ prettyPrint?: boolean;
16168
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
16169
+ quotaUser?: string;
16170
+ /** 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. */
16171
+ resource: string;
16172
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
16173
+ upload_protocol?: string;
16174
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
16175
+ uploadType?: string;
16176
+ }): Request<GoogleIamV1Policy>;
16285
16177
  /** Get Workspace settings for the end user. */
16286
16178
  getWorkspaceSettings(request?: {
16287
16179
  /** V1 error format. */
@@ -16404,7 +16296,7 @@ declare namespace gapi.client {
16404
16296
  },
16405
16297
  body: GoogleCloudDiscoveryengineV1alphaEngine,
16406
16298
  ): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
16407
- /** Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
16299
+ /** Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
16408
16300
  pause(request: {
16409
16301
  /** V1 error format. */
16410
16302
  '$.xgafv'?: string;
@@ -16462,7 +16354,7 @@ declare namespace gapi.client {
16462
16354
  },
16463
16355
  body: GoogleCloudDiscoveryengineV1alphaPauseEngineRequest,
16464
16356
  ): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
16465
- /** Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
16357
+ /** Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
16466
16358
  resume(request: {
16467
16359
  /** V1 error format. */
16468
16360
  '$.xgafv'?: string;
@@ -16520,7 +16412,37 @@ declare namespace gapi.client {
16520
16412
  },
16521
16413
  body: GoogleCloudDiscoveryengineV1alphaResumeEngineRequest,
16522
16414
  ): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
16523
- /** Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
16415
+ /** Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging. */
16416
+ setIamPolicy(
16417
+ request: {
16418
+ /** V1 error format. */
16419
+ '$.xgafv'?: string;
16420
+ /** OAuth access token. */
16421
+ access_token?: string;
16422
+ /** Data format for response. */
16423
+ alt?: string;
16424
+ /** JSONP */
16425
+ callback?: string;
16426
+ /** Selector specifying which fields to include in a partial response. */
16427
+ fields?: string;
16428
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
16429
+ key?: string;
16430
+ /** OAuth 2.0 token for the current user. */
16431
+ oauth_token?: string;
16432
+ /** Returns response with indentations and line breaks. */
16433
+ prettyPrint?: boolean;
16434
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
16435
+ quotaUser?: string;
16436
+ /** 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. */
16437
+ resource: string;
16438
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
16439
+ upload_protocol?: string;
16440
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
16441
+ uploadType?: string;
16442
+ },
16443
+ body: GoogleIamV1SetIamPolicyRequest,
16444
+ ): Request<GoogleIamV1Policy>;
16445
+ /** Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
16524
16446
  tune(request: {
16525
16447
  /** V1 error format. */
16526
16448
  '$.xgafv'?: string;
@@ -23370,6 +23292,41 @@ declare namespace gapi.client {
23370
23292
  userLicenses: UserLicensesResource;
23371
23293
  }
23372
23294
  interface LocationsResource {
23295
+ /** This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix. */
23296
+ completeExternalIdentities(request?: {
23297
+ /** V1 error format. */
23298
+ '$.xgafv'?: string;
23299
+ /** OAuth access token. */
23300
+ access_token?: string;
23301
+ /** Data format for response. */
23302
+ alt?: string;
23303
+ /** JSONP */
23304
+ callback?: string;
23305
+ /** Optional. The type of entities to fetch. If not set, all entity types will be returned. */
23306
+ entityTypeFilter?: string;
23307
+ /** Selector specifying which fields to include in a partial response. */
23308
+ fields?: string;
23309
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
23310
+ key?: string;
23311
+ /** Optional. The maximum number of user and group results to return. The service may return fewer than this value. If unspecified, at most 6 results will be returned. The limit is distributed as evenly as possible across users and groups. For example, if max_suggestions is 7, the service may return 4 users and 3 groups. If there are fewer suggestions of one type than half the limit, the other type may return more suggestions up to the max_suggestions limit. */
23312
+ maxSuggestions?: number;
23313
+ /** OAuth 2.0 token for the current user. */
23314
+ oauth_token?: string;
23315
+ /** Required. The parent location resource name, such as `projects/*‍/locations/global`. */
23316
+ parent: string;
23317
+ /** Required. The prefix to search for. For users, this prefix is matched against the `primary_email`. For groups, this prefix is matched against the `display_name`. The matching is case-insensitive. */
23318
+ prefixQuery?: string;
23319
+ /** Returns response with indentations and line breaks. */
23320
+ prettyPrint?: boolean;
23321
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
23322
+ quotaUser?: string;
23323
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
23324
+ upload_protocol?: string;
23325
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
23326
+ uploadType?: string;
23327
+ /** Optional. Whether to use scim identities for external identity completion. If false, we will call the Microsoft graph API to fetch the external identities. */
23328
+ useScimIdentities?: boolean;
23329
+ }): Request<GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse>;
23373
23330
  /** Estimates the data size to be used by a customer. */
23374
23331
  estimateDataSize(request: {
23375
23332
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.1.20260204",
3
+ "version": "0.1.20260209",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",