@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240409 → 0.0.20240415

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 +126 -43
  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=v1
12
- // Revision: 20240409
12
+ // Revision: 20240415
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -99,7 +99,7 @@ declare namespace gapi.client {
99
99
  completeTime?: string;
100
100
  /** Output only. Answer creation timestamp. */
101
101
  createTime?: string;
102
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
102
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
103
103
  name?: string;
104
104
  /** Query understanding information. */
105
105
  queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
@@ -348,7 +348,7 @@ declare namespace gapi.client {
348
348
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
349
349
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
350
350
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
351
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
351
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
352
352
  enhancedDocumentElements?: string[];
353
353
  /** If true, will use native text instead of OCR text on pages containing native text. */
354
354
  useNativeText?: boolean;
@@ -393,7 +393,7 @@ declare namespace gapi.client {
393
393
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
394
394
  /** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
395
395
  agentCreationConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
396
- /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
396
+ /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
397
397
  dialogflowAgentToLink?: string;
398
398
  }
399
399
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
@@ -443,7 +443,7 @@ declare namespace gapi.client {
443
443
  interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
444
444
  /** The add-on that this search engine enables. */
445
445
  searchAddOns?: string[];
446
- /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
446
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
447
447
  searchTier?: string;
448
448
  }
449
449
  interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
@@ -458,6 +458,8 @@ declare namespace gapi.client {
458
458
  documentCount?: string;
459
459
  }
460
460
  interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
461
+ /** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
462
+ advancedSiteSearchDataSources?: string[];
461
463
  /** If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. */
462
464
  completableOption?: string;
463
465
  /** If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. */
@@ -487,20 +489,6 @@ declare namespace gapi.client {
487
489
  /** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
488
490
  workforcePoolName?: string;
489
491
  }
490
- interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
491
- /** Operation create time. */
492
- createTime?: string;
493
- /** Operation last update time. If the operation is done, this is also the finish time. */
494
- updateTime?: string;
495
- }
496
- interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
497
- /** A sample of errors encountered while processing the request. */
498
- errorSamples?: GoogleRpcStatus[];
499
- /** Count of CompletionSuggestions that failed to be imported. */
500
- failureCount?: string;
501
- /** Count of CompletionSuggestions successfully imported. */
502
- successCount?: string;
503
- }
504
492
  interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
505
493
  /** Operation create time. */
506
494
  createTime?: string;
@@ -557,6 +545,31 @@ declare namespace gapi.client {
557
545
  /** Count of user events imported, but with Document information not found in the existing Branch. */
558
546
  unjoinedEventsCount?: string;
559
547
  }
548
+ interface GoogleCloudDiscoveryengineV1alphaProject {
549
+ /** Output only. The timestamp when this project is created. */
550
+ createTime?: string;
551
+ /** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
552
+ name?: string;
553
+ /** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
554
+ provisionCompletionTime?: string;
555
+ /** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
556
+ serviceTermsMap?: {
557
+ [P in string]: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
558
+ };
559
+ }
560
+ interface GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
561
+ /** The last time when the project agreed to the terms of service. */
562
+ acceptTime?: string;
563
+ /** The last time when the project declined or revoked the agreement to terms of service. */
564
+ declineTime?: string;
565
+ /** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
566
+ id?: string;
567
+ /** Whether the project has accepted/rejected the service terms or it is still pending. */
568
+ state?: string;
569
+ /** The version string of the terms of service. For acceptable values, see the comments for id above. */
570
+ version?: string;
571
+ }
572
+ interface GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {}
560
573
  interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
561
574
  /** Operation create time. */
562
575
  createTime?: string;
@@ -654,7 +667,7 @@ declare namespace gapi.client {
654
667
  interface GoogleCloudDiscoveryengineV1alphaSession {
655
668
  /** Output only. The time the session finished. */
656
669
  endTime?: string;
657
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
670
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
658
671
  name?: string;
659
672
  /** Output only. The time the session started. */
660
673
  startTime?: string;
@@ -856,7 +869,7 @@ declare namespace gapi.client {
856
869
  }
857
870
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
858
871
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
859
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
872
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
860
873
  enhancedDocumentElements?: string[];
861
874
  /** If true, will use native text instead of OCR text on pages containing native text. */
862
875
  useNativeText?: boolean;
@@ -895,7 +908,7 @@ declare namespace gapi.client {
895
908
  interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
896
909
  /** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
897
910
  agentCreationConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
898
- /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
911
+ /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
899
912
  dialogflowAgentToLink?: string;
900
913
  }
901
914
  interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
@@ -919,7 +932,7 @@ declare namespace gapi.client {
919
932
  interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
920
933
  /** The add-on that this search engine enables. */
921
934
  searchAddOns?: string[];
922
- /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
935
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
923
936
  searchTier?: string;
924
937
  }
925
938
  interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
@@ -1070,6 +1083,7 @@ declare namespace gapi.client {
1070
1083
  /** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
1071
1084
  engine?: string;
1072
1085
  }
1086
+ interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
1073
1087
  interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
1074
1088
  /** Operation create time. */
1075
1089
  createTime?: string;
@@ -1137,7 +1151,7 @@ declare namespace gapi.client {
1137
1151
  interface GoogleCloudDiscoveryengineV1CloudSqlSource {
1138
1152
  /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
1139
1153
  databaseId?: string;
1140
- /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
1154
+ /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
1141
1155
  gcsStagingDir?: string;
1142
1156
  /** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
1143
1157
  instanceId?: string;
@@ -1171,7 +1185,7 @@ declare namespace gapi.client {
1171
1185
  endTime?: string;
1172
1186
  /** Conversation messages. */
1173
1187
  messages?: GoogleCloudDiscoveryengineV1ConversationMessage[];
1174
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
1188
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
1175
1189
  name?: string;
1176
1190
  /** Output only. The time the conversation started. */
1177
1191
  startTime?: string;
@@ -1366,7 +1380,7 @@ declare namespace gapi.client {
1366
1380
  }
1367
1381
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
1368
1382
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
1369
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
1383
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
1370
1384
  enhancedDocumentElements?: string[];
1371
1385
  /** If true, will use native text instead of OCR text on pages containing native text. */
1372
1386
  useNativeText?: boolean;
@@ -1406,7 +1420,7 @@ declare namespace gapi.client {
1406
1420
  interface GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
1407
1421
  /** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
1408
1422
  agentCreationConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
1409
- /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
1423
+ /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
1410
1424
  dialogflowAgentToLink?: string;
1411
1425
  }
1412
1426
  interface GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
@@ -1430,7 +1444,7 @@ declare namespace gapi.client {
1430
1444
  interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
1431
1445
  /** The add-on that this search engine enables. */
1432
1446
  searchAddOns?: string[];
1433
- /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
1447
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
1434
1448
  searchTier?: string;
1435
1449
  }
1436
1450
  interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
@@ -1452,7 +1466,7 @@ declare namespace gapi.client {
1452
1466
  collectionId?: string;
1453
1467
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
1454
1468
  databaseId?: string;
1455
- /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
1469
+ /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
1456
1470
  gcsStagingDir?: string;
1457
1471
  /** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
1458
1472
  projectId?: string;
@@ -1630,7 +1644,7 @@ declare namespace gapi.client {
1630
1644
  mediaProgressPercentage?: number;
1631
1645
  }
1632
1646
  interface GoogleCloudDiscoveryengineV1PageInfo {
1633
- /** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1647
+ /** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1634
1648
  pageCategory?: string;
1635
1649
  /** A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. */
1636
1650
  pageviewId?: string;
@@ -1811,7 +1825,7 @@ declare namespace gapi.client {
1811
1825
  numNextSegments?: number;
1812
1826
  /** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
1813
1827
  numPreviousSegments?: number;
1814
- /** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`. */
1828
+ /** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. */
1815
1829
  returnExtractiveSegmentScore?: boolean;
1816
1830
  }
1817
1831
  interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec {
@@ -1835,9 +1849,9 @@ declare namespace gapi.client {
1835
1849
  modelPromptSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec;
1836
1850
  /** If specified, the spec will be used to modify the model specification provided to the LLM. */
1837
1851
  modelSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec;
1838
- /** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */
1852
+ /** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
1839
1853
  summaryResultCount?: number;
1840
- /** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
1854
+ /** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
1841
1855
  useSemanticChunks?: boolean;
1842
1856
  }
1843
1857
  interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec {
@@ -2458,6 +2472,8 @@ declare namespace gapi.client {
2458
2472
  prettyPrint?: boolean;
2459
2473
  /** 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. */
2460
2474
  quotaUser?: string;
2475
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
2476
+ updateMask?: string;
2461
2477
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2462
2478
  upload_protocol?: string;
2463
2479
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -2489,6 +2505,8 @@ declare namespace gapi.client {
2489
2505
  prettyPrint?: boolean;
2490
2506
  /** 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. */
2491
2507
  quotaUser?: string;
2508
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
2509
+ updateMask?: string;
2492
2510
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2493
2511
  upload_protocol?: string;
2494
2512
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -2841,7 +2859,7 @@ declare namespace gapi.client {
2841
2859
  fields?: string;
2842
2860
  /** 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. */
2843
2861
  key?: string;
2844
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
2862
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
2845
2863
  name: string;
2846
2864
  /** OAuth 2.0 token for the current user. */
2847
2865
  oauth_token?: string;
@@ -2872,7 +2890,7 @@ declare namespace gapi.client {
2872
2890
  fields?: string;
2873
2891
  /** 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. */
2874
2892
  key?: string;
2875
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
2893
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
2876
2894
  name: string;
2877
2895
  /** OAuth 2.0 token for the current user. */
2878
2896
  oauth_token?: string;
@@ -4288,7 +4306,7 @@ declare namespace gapi.client {
4288
4306
  key?: string;
4289
4307
  /** OAuth 2.0 token for the current user. */
4290
4308
  oauth_token?: string;
4291
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
4309
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
4292
4310
  parent: string;
4293
4311
  /** Returns response with indentations and line breaks. */
4294
4312
  prettyPrint?: boolean;
@@ -4317,7 +4335,7 @@ declare namespace gapi.client {
4317
4335
  key?: string;
4318
4336
  /** OAuth 2.0 token for the current user. */
4319
4337
  oauth_token?: string;
4320
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
4338
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
4321
4339
  parent: string;
4322
4340
  /** Returns response with indentations and line breaks. */
4323
4341
  prettyPrint?: boolean;
@@ -4839,7 +4857,7 @@ declare namespace gapi.client {
4839
4857
  fields?: string;
4840
4858
  /** 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. */
4841
4859
  key?: string;
4842
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
4860
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
4843
4861
  name: string;
4844
4862
  /** OAuth 2.0 token for the current user. */
4845
4863
  oauth_token?: string;
@@ -4870,7 +4888,7 @@ declare namespace gapi.client {
4870
4888
  fields?: string;
4871
4889
  /** 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. */
4872
4890
  key?: string;
4873
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
4891
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
4874
4892
  name: string;
4875
4893
  /** OAuth 2.0 token for the current user. */
4876
4894
  oauth_token?: string;
@@ -5582,6 +5600,8 @@ declare namespace gapi.client {
5582
5600
  prettyPrint?: boolean;
5583
5601
  /** 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. */
5584
5602
  quotaUser?: string;
5603
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
5604
+ updateMask?: string;
5585
5605
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5586
5606
  upload_protocol?: string;
5587
5607
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -5613,6 +5633,8 @@ declare namespace gapi.client {
5613
5633
  prettyPrint?: boolean;
5614
5634
  /** 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. */
5615
5635
  quotaUser?: string;
5636
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
5637
+ updateMask?: string;
5616
5638
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5617
5639
  upload_protocol?: string;
5618
5640
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -5965,7 +5987,7 @@ declare namespace gapi.client {
5965
5987
  fields?: string;
5966
5988
  /** 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. */
5967
5989
  key?: string;
5968
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
5990
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
5969
5991
  name: string;
5970
5992
  /** OAuth 2.0 token for the current user. */
5971
5993
  oauth_token?: string;
@@ -5996,7 +6018,7 @@ declare namespace gapi.client {
5996
6018
  fields?: string;
5997
6019
  /** 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. */
5998
6020
  key?: string;
5999
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6021
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6000
6022
  name: string;
6001
6023
  /** OAuth 2.0 token for the current user. */
6002
6024
  oauth_token?: string;
@@ -7134,7 +7156,7 @@ declare namespace gapi.client {
7134
7156
  key?: string;
7135
7157
  /** OAuth 2.0 token for the current user. */
7136
7158
  oauth_token?: string;
7137
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7159
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
7138
7160
  parent: string;
7139
7161
  /** Returns response with indentations and line breaks. */
7140
7162
  prettyPrint?: boolean;
@@ -7163,7 +7185,7 @@ declare namespace gapi.client {
7163
7185
  key?: string;
7164
7186
  /** OAuth 2.0 token for the current user. */
7165
7187
  oauth_token?: string;
7166
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7188
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
7167
7189
  parent: string;
7168
7190
  /** Returns response with indentations and line breaks. */
7169
7191
  prettyPrint?: boolean;
@@ -7527,10 +7549,71 @@ declare namespace gapi.client {
7527
7549
  uploadType?: string;
7528
7550
  }): Request<GoogleLongrunningListOperationsResponse>;
7529
7551
  }
7552
+ interface UserEventsResource {
7553
+ /** Writes a single user event. */
7554
+ write(request: {
7555
+ /** V1 error format. */
7556
+ '$.xgafv'?: string;
7557
+ /** OAuth access token. */
7558
+ access_token?: string;
7559
+ /** Data format for response. */
7560
+ alt?: string;
7561
+ /** JSONP */
7562
+ callback?: string;
7563
+ /** Selector specifying which fields to include in a partial response. */
7564
+ fields?: string;
7565
+ /** 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. */
7566
+ key?: string;
7567
+ /** OAuth 2.0 token for the current user. */
7568
+ oauth_token?: string;
7569
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
7570
+ parent: string;
7571
+ /** Returns response with indentations and line breaks. */
7572
+ prettyPrint?: boolean;
7573
+ /** 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. */
7574
+ quotaUser?: string;
7575
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7576
+ upload_protocol?: string;
7577
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7578
+ uploadType?: string;
7579
+ /** Request body */
7580
+ resource: GoogleCloudDiscoveryengineV1UserEvent;
7581
+ }): Request<GoogleCloudDiscoveryengineV1UserEvent>;
7582
+ write(
7583
+ request: {
7584
+ /** V1 error format. */
7585
+ '$.xgafv'?: string;
7586
+ /** OAuth access token. */
7587
+ access_token?: string;
7588
+ /** Data format for response. */
7589
+ alt?: string;
7590
+ /** JSONP */
7591
+ callback?: string;
7592
+ /** Selector specifying which fields to include in a partial response. */
7593
+ fields?: string;
7594
+ /** 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. */
7595
+ key?: string;
7596
+ /** OAuth 2.0 token for the current user. */
7597
+ oauth_token?: string;
7598
+ /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
7599
+ parent: string;
7600
+ /** Returns response with indentations and line breaks. */
7601
+ prettyPrint?: boolean;
7602
+ /** 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. */
7603
+ quotaUser?: string;
7604
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7605
+ upload_protocol?: string;
7606
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7607
+ uploadType?: string;
7608
+ },
7609
+ body: GoogleCloudDiscoveryengineV1UserEvent
7610
+ ): Request<GoogleCloudDiscoveryengineV1UserEvent>;
7611
+ }
7530
7612
  interface LocationsResource {
7531
7613
  collections: CollectionsResource;
7532
7614
  dataStores: DataStoresResource;
7533
7615
  operations: OperationsResource;
7616
+ userEvents: UserEventsResource;
7534
7617
  }
7535
7618
  interface OperationsResource {
7536
7619
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
3
- "version": "0.0.20240409",
3
+ "version": "0.0.20240415",
4
4
  "description": "TypeScript typings for Discovery Engine API v1",
5
5
  "repository": {
6
6
  "type": "git",