@maxim_mazurok/gapi.client.discoveryengine-v1beta 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 +139 -54
  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=v1beta
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;
@@ -759,7 +772,7 @@ declare namespace gapi.client {
759
772
  completeTime?: string;
760
773
  /** Output only. Answer creation timestamp. */
761
774
  createTime?: string;
762
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
775
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
763
776
  name?: string;
764
777
  /** Query understanding information. */
765
778
  queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo;
@@ -839,7 +852,7 @@ declare namespace gapi.client {
839
852
  interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
840
853
  /** Disable query rephraser. */
841
854
  disable?: boolean;
842
- /** Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default. */
855
+ /** Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */
843
856
  maxRephraseSteps?: number;
844
857
  }
845
858
  interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec {
@@ -917,6 +930,8 @@ declare namespace gapi.client {
917
930
  interface GoogleCloudDiscoveryengineV1betaAnswerQueryResponse {
918
931
  /** Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
919
932
  answer?: GoogleCloudDiscoveryengineV1betaAnswer;
933
+ /** A global unique ID used for logging. */
934
+ answerQueryToken?: string;
920
935
  /** Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */
921
936
  session?: GoogleCloudDiscoveryengineV1betaSession;
922
937
  }
@@ -1112,7 +1127,7 @@ declare namespace gapi.client {
1112
1127
  claimText?: string;
1113
1128
  /** Position indicating the end of the claim in the answer candidate, exclusive. */
1114
1129
  endPos?: number;
1115
- /** Position indicating the start of the claim in the answer candidate, measured in bytes/unicode. */
1130
+ /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
1116
1131
  startPos?: number;
1117
1132
  }
1118
1133
  interface GoogleCloudDiscoveryengineV1betaCheckGroundingSpec {
@@ -1122,7 +1137,7 @@ declare namespace gapi.client {
1122
1137
  interface GoogleCloudDiscoveryengineV1betaCloudSqlSource {
1123
1138
  /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
1124
1139
  databaseId?: string;
1125
- /** 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. */
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. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
1126
1141
  gcsStagingDir?: string;
1127
1142
  /** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
1128
1143
  instanceId?: string;
@@ -1156,7 +1171,7 @@ declare namespace gapi.client {
1156
1171
  endTime?: string;
1157
1172
  /** Conversation messages. */
1158
1173
  messages?: GoogleCloudDiscoveryengineV1betaConversationMessage[];
1159
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
1174
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
1160
1175
  name?: string;
1161
1176
  /** Output only. The time the conversation started. */
1162
1177
  startTime?: string;
@@ -1353,7 +1368,7 @@ declare namespace gapi.client {
1353
1368
  }
1354
1369
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
1355
1370
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
1356
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
1371
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
1357
1372
  enhancedDocumentElements?: string[];
1358
1373
  /** If true, will use native text instead of OCR text on pages containing native text. */
1359
1374
  useNativeText?: boolean;
@@ -1401,7 +1416,7 @@ declare namespace gapi.client {
1401
1416
  interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
1402
1417
  /** 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. */
1403
1418
  agentCreationConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
1404
- /** 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. */
1419
+ /** 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. */
1405
1420
  dialogflowAgentToLink?: string;
1406
1421
  }
1407
1422
  interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
@@ -1425,7 +1440,7 @@ declare namespace gapi.client {
1425
1440
  interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
1426
1441
  /** The add-on that this search engine enables. */
1427
1442
  searchAddOns?: string[];
1428
- /** 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. */
1443
+ /** 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. */
1429
1444
  searchTier?: string;
1430
1445
  }
1431
1446
  interface GoogleCloudDiscoveryengineV1betaFactChunk {
@@ -1455,7 +1470,7 @@ declare namespace gapi.client {
1455
1470
  collectionId?: string;
1456
1471
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
1457
1472
  databaseId?: string;
1458
- /** 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. */
1473
+ /** 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. */
1459
1474
  gcsStagingDir?: string;
1460
1475
  /** 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. */
1461
1476
  projectId?: string;
@@ -1651,7 +1666,7 @@ declare namespace gapi.client {
1651
1666
  mediaProgressPercentage?: number;
1652
1667
  }
1653
1668
  interface GoogleCloudDiscoveryengineV1betaPageInfo {
1654
- /** 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. */
1669
+ /** 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. */
1655
1670
  pageCategory?: string;
1656
1671
  /** 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. */
1657
1672
  pageviewId?: string;
@@ -1731,7 +1746,7 @@ declare namespace gapi.client {
1731
1746
  model?: string;
1732
1747
  /** The query to use. */
1733
1748
  query?: string;
1734
- /** Required. A list of records to rank. At most 100 records to rank. */
1749
+ /** Required. A list of records to rank. At most 200 records to rank. */
1735
1750
  records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
1736
1751
  /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
1737
1752
  topN?: number;
@@ -1902,7 +1917,7 @@ declare namespace gapi.client {
1902
1917
  numNextSegments?: number;
1903
1918
  /** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
1904
1919
  numPreviousSegments?: number;
1905
- /** 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`. */
1920
+ /** 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`. */
1906
1921
  returnExtractiveSegmentScore?: boolean;
1907
1922
  }
1908
1923
  interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec {
@@ -1926,9 +1941,9 @@ declare namespace gapi.client {
1926
1941
  modelPromptSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
1927
1942
  /** If specified, the spec will be used to modify the model specification provided to the LLM. */
1928
1943
  modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
1929
- /** 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. */
1944
+ /** 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. */
1930
1945
  summaryResultCount?: number;
1931
- /** 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. */
1946
+ /** 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. */
1932
1947
  useSemanticChunks?: boolean;
1933
1948
  }
1934
1949
  interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
@@ -2179,7 +2194,7 @@ declare namespace gapi.client {
2179
2194
  interface GoogleCloudDiscoveryengineV1betaSession {
2180
2195
  /** Output only. The time the session finished. */
2181
2196
  endTime?: string;
2182
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
2197
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
2183
2198
  name?: string;
2184
2199
  /** Output only. The time the session started. */
2185
2200
  startTime?: string;
@@ -2311,6 +2326,7 @@ declare namespace gapi.client {
2311
2326
  engine?: string;
2312
2327
  }
2313
2328
  interface GoogleCloudDiscoveryengineV1betaTuneEngineRequest {}
2329
+ interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
2314
2330
  interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
2315
2331
  /** Operation create time. */
2316
2332
  createTime?: string;
@@ -2462,7 +2478,7 @@ declare namespace gapi.client {
2462
2478
  }
2463
2479
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
2464
2480
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
2465
- /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
2481
+ /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
2466
2482
  enhancedDocumentElements?: string[];
2467
2483
  /** If true, will use native text instead of OCR text on pages containing native text. */
2468
2484
  useNativeText?: boolean;
@@ -2501,7 +2517,7 @@ declare namespace gapi.client {
2501
2517
  interface GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
2502
2518
  /** 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. */
2503
2519
  agentCreationConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
2504
- /** 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. */
2520
+ /** 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. */
2505
2521
  dialogflowAgentToLink?: string;
2506
2522
  }
2507
2523
  interface GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
@@ -2525,7 +2541,7 @@ declare namespace gapi.client {
2525
2541
  interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
2526
2542
  /** The add-on that this search engine enables. */
2527
2543
  searchAddOns?: string[];
2528
- /** 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. */
2544
+ /** 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. */
2529
2545
  searchTier?: string;
2530
2546
  }
2531
2547
  interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
@@ -2998,6 +3014,8 @@ declare namespace gapi.client {
2998
3014
  prettyPrint?: boolean;
2999
3015
  /** 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. */
3000
3016
  quotaUser?: string;
3017
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3018
+ updateMask?: string;
3001
3019
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3002
3020
  upload_protocol?: string;
3003
3021
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -3029,6 +3047,8 @@ declare namespace gapi.client {
3029
3047
  prettyPrint?: boolean;
3030
3048
  /** 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. */
3031
3049
  quotaUser?: string;
3050
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
3051
+ updateMask?: string;
3032
3052
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3033
3053
  upload_protocol?: string;
3034
3054
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -3381,7 +3401,7 @@ declare namespace gapi.client {
3381
3401
  fields?: string;
3382
3402
  /** 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. */
3383
3403
  key?: string;
3384
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3404
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3385
3405
  name: string;
3386
3406
  /** OAuth 2.0 token for the current user. */
3387
3407
  oauth_token?: string;
@@ -3412,7 +3432,7 @@ declare namespace gapi.client {
3412
3432
  fields?: string;
3413
3433
  /** 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. */
3414
3434
  key?: string;
3415
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3435
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
3416
3436
  name: string;
3417
3437
  /** OAuth 2.0 token for the current user. */
3418
3438
  oauth_token?: string;
@@ -4318,7 +4338,7 @@ declare namespace gapi.client {
4318
4338
  fields?: string;
4319
4339
  /** 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. */
4320
4340
  key?: string;
4321
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4341
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4322
4342
  name: string;
4323
4343
  /** OAuth 2.0 token for the current user. */
4324
4344
  oauth_token?: string;
@@ -4349,7 +4369,7 @@ declare namespace gapi.client {
4349
4369
  fields?: string;
4350
4370
  /** 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. */
4351
4371
  key?: string;
4352
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4372
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4353
4373
  name: string;
4354
4374
  /** OAuth 2.0 token for the current user. */
4355
4375
  oauth_token?: string;
@@ -5247,7 +5267,7 @@ declare namespace gapi.client {
5247
5267
  key?: string;
5248
5268
  /** OAuth 2.0 token for the current user. */
5249
5269
  oauth_token?: string;
5250
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
5270
+ /** 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}`. */
5251
5271
  parent: string;
5252
5272
  /** Returns response with indentations and line breaks. */
5253
5273
  prettyPrint?: boolean;
@@ -5276,7 +5296,7 @@ declare namespace gapi.client {
5276
5296
  key?: string;
5277
5297
  /** OAuth 2.0 token for the current user. */
5278
5298
  oauth_token?: string;
5279
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
5299
+ /** 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}`. */
5280
5300
  parent: string;
5281
5301
  /** Returns response with indentations and line breaks. */
5282
5302
  prettyPrint?: boolean;
@@ -5857,7 +5877,7 @@ declare namespace gapi.client {
5857
5877
  fields?: string;
5858
5878
  /** 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. */
5859
5879
  key?: string;
5860
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
5880
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
5861
5881
  name: string;
5862
5882
  /** OAuth 2.0 token for the current user. */
5863
5883
  oauth_token?: string;
@@ -5888,7 +5908,7 @@ declare namespace gapi.client {
5888
5908
  fields?: string;
5889
5909
  /** 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. */
5890
5910
  key?: string;
5891
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
5911
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
5892
5912
  name: string;
5893
5913
  /** OAuth 2.0 token for the current user. */
5894
5914
  oauth_token?: string;
@@ -6455,7 +6475,7 @@ declare namespace gapi.client {
6455
6475
  fields?: string;
6456
6476
  /** 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. */
6457
6477
  key?: string;
6458
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
6478
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
6459
6479
  name: string;
6460
6480
  /** OAuth 2.0 token for the current user. */
6461
6481
  oauth_token?: string;
@@ -6486,7 +6506,7 @@ declare namespace gapi.client {
6486
6506
  fields?: string;
6487
6507
  /** 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. */
6488
6508
  key?: string;
6489
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
6509
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
6490
6510
  name: string;
6491
6511
  /** OAuth 2.0 token for the current user. */
6492
6512
  oauth_token?: string;
@@ -7194,6 +7214,8 @@ declare namespace gapi.client {
7194
7214
  prettyPrint?: boolean;
7195
7215
  /** 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. */
7196
7216
  quotaUser?: string;
7217
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
7218
+ updateMask?: string;
7197
7219
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7198
7220
  upload_protocol?: string;
7199
7221
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -7225,6 +7247,8 @@ declare namespace gapi.client {
7225
7247
  prettyPrint?: boolean;
7226
7248
  /** 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. */
7227
7249
  quotaUser?: string;
7250
+ /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
7251
+ updateMask?: string;
7228
7252
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7229
7253
  upload_protocol?: string;
7230
7254
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -7577,7 +7601,7 @@ declare namespace gapi.client {
7577
7601
  fields?: string;
7578
7602
  /** 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. */
7579
7603
  key?: string;
7580
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
7604
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
7581
7605
  name: string;
7582
7606
  /** OAuth 2.0 token for the current user. */
7583
7607
  oauth_token?: string;
@@ -7608,7 +7632,7 @@ declare namespace gapi.client {
7608
7632
  fields?: string;
7609
7633
  /** 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. */
7610
7634
  key?: string;
7611
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
7635
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
7612
7636
  name: string;
7613
7637
  /** OAuth 2.0 token for the current user. */
7614
7638
  oauth_token?: string;
@@ -8451,7 +8475,7 @@ declare namespace gapi.client {
8451
8475
  fields?: string;
8452
8476
  /** 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. */
8453
8477
  key?: string;
8454
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
8478
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
8455
8479
  name: string;
8456
8480
  /** OAuth 2.0 token for the current user. */
8457
8481
  oauth_token?: string;
@@ -8482,7 +8506,7 @@ declare namespace gapi.client {
8482
8506
  fields?: string;
8483
8507
  /** 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. */
8484
8508
  key?: string;
8485
- /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
8509
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
8486
8510
  name: string;
8487
8511
  /** OAuth 2.0 token for the current user. */
8488
8512
  oauth_token?: string;
@@ -9165,7 +9189,7 @@ declare namespace gapi.client {
9165
9189
  key?: string;
9166
9190
  /** OAuth 2.0 token for the current user. */
9167
9191
  oauth_token?: string;
9168
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
9192
+ /** 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}`. */
9169
9193
  parent: string;
9170
9194
  /** Returns response with indentations and line breaks. */
9171
9195
  prettyPrint?: boolean;
@@ -9194,7 +9218,7 @@ declare namespace gapi.client {
9194
9218
  key?: string;
9195
9219
  /** OAuth 2.0 token for the current user. */
9196
9220
  oauth_token?: string;
9197
- /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
9221
+ /** 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}`. */
9198
9222
  parent: string;
9199
9223
  /** Returns response with indentations and line breaks. */
9200
9224
  prettyPrint?: boolean;
@@ -9679,12 +9703,73 @@ declare namespace gapi.client {
9679
9703
  body: GoogleCloudDiscoveryengineV1betaRankRequest
9680
9704
  ): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
9681
9705
  }
9706
+ interface UserEventsResource {
9707
+ /** Writes a single user event. */
9708
+ write(request: {
9709
+ /** V1 error format. */
9710
+ '$.xgafv'?: string;
9711
+ /** OAuth access token. */
9712
+ access_token?: string;
9713
+ /** Data format for response. */
9714
+ alt?: string;
9715
+ /** JSONP */
9716
+ callback?: string;
9717
+ /** Selector specifying which fields to include in a partial response. */
9718
+ fields?: string;
9719
+ /** 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. */
9720
+ key?: string;
9721
+ /** OAuth 2.0 token for the current user. */
9722
+ oauth_token?: string;
9723
+ /** 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}`. */
9724
+ parent: string;
9725
+ /** Returns response with indentations and line breaks. */
9726
+ prettyPrint?: boolean;
9727
+ /** 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. */
9728
+ quotaUser?: string;
9729
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9730
+ upload_protocol?: string;
9731
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9732
+ uploadType?: string;
9733
+ /** Request body */
9734
+ resource: GoogleCloudDiscoveryengineV1betaUserEvent;
9735
+ }): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
9736
+ write(
9737
+ request: {
9738
+ /** V1 error format. */
9739
+ '$.xgafv'?: string;
9740
+ /** OAuth access token. */
9741
+ access_token?: string;
9742
+ /** Data format for response. */
9743
+ alt?: string;
9744
+ /** JSONP */
9745
+ callback?: string;
9746
+ /** Selector specifying which fields to include in a partial response. */
9747
+ fields?: string;
9748
+ /** 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. */
9749
+ key?: string;
9750
+ /** OAuth 2.0 token for the current user. */
9751
+ oauth_token?: string;
9752
+ /** 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}`. */
9753
+ parent: string;
9754
+ /** Returns response with indentations and line breaks. */
9755
+ prettyPrint?: boolean;
9756
+ /** 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. */
9757
+ quotaUser?: string;
9758
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9759
+ upload_protocol?: string;
9760
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9761
+ uploadType?: string;
9762
+ },
9763
+ body: GoogleCloudDiscoveryengineV1betaUserEvent
9764
+ ): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
9765
+ }
9682
9766
  interface LocationsResource {
9683
9767
  collections: CollectionsResource;
9684
9768
  dataStores: DataStoresResource;
9685
9769
  groundingConfigs: GroundingConfigsResource;
9686
9770
  operations: OperationsResource;
9687
9771
  rankingConfigs: RankingConfigsResource;
9772
+ userEvents: UserEventsResource;
9688
9773
  }
9689
9774
  interface OperationsResource {
9690
9775
  /** 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-v1beta",
3
- "version": "0.0.20240409",
3
+ "version": "0.0.20240415",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",