@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240526 → 0.0.20240607

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 +143 -10
  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: 20240526
12
+ // Revision: 20240607
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -82,6 +82,20 @@ declare namespace gapi.client {
82
82
  /** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
83
83
  functionName?: string;
84
84
  }
85
+ interface GoogleCloudDiscoveryengineV1AlloyDbSource {
86
+ /** Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */
87
+ clusterId?: string;
88
+ /** Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */
89
+ databaseId?: string;
90
+ /** 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
91
+ gcsStagingDir?: string;
92
+ /** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
93
+ locationId?: string;
94
+ /** The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
95
+ projectId?: string;
96
+ /** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
97
+ tableId?: string;
98
+ }
85
99
  interface GoogleCloudDiscoveryengineV1alphaAclConfig {
86
100
  /** Identity provider config. */
87
101
  idpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfig;
@@ -894,6 +908,8 @@ declare namespace gapi.client {
894
908
  searchSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec;
895
909
  /** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
896
910
  session?: string;
911
+ /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
912
+ userLabels?: {[P in string]: string};
897
913
  /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
898
914
  userPseudoId?: string;
899
915
  }
@@ -960,6 +976,8 @@ declare namespace gapi.client {
960
976
  maxReturnResults?: number;
961
977
  /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
962
978
  orderBy?: string;
979
+ /** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */
980
+ searchResultMode?: string;
963
981
  }
964
982
  interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList {
965
983
  /** Search results. */
@@ -1300,6 +1318,8 @@ declare namespace gapi.client {
1300
1318
  }
1301
1319
  interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
1302
1320
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
1321
+ /** Whether chunking mode is enabled. */
1322
+ chunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig;
1303
1323
  /** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
1304
1324
  defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
1305
1325
  /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
@@ -1309,13 +1329,26 @@ declare namespace gapi.client {
1309
1329
  [P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
1310
1330
  };
1311
1331
  }
1332
+ interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig {
1333
+ /** Configuration for the layout based chunking. */
1334
+ layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
1335
+ }
1336
+ interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
1337
+ /** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
1338
+ chunkSize?: number;
1339
+ /** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
1340
+ includeAncestorHeadings?: boolean;
1341
+ }
1312
1342
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
1313
1343
  /** Configurations applied to digital parser. */
1314
1344
  digitalParsingConfig?: any;
1345
+ /** Configurations applied to layout parser. */
1346
+ layoutParsingConfig?: any;
1315
1347
  /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
1316
1348
  ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
1317
1349
  }
1318
1350
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
1351
+ interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
1319
1352
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
1320
1353
  /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
1321
1354
  enhancedDocumentElements?: string[];
@@ -1663,6 +1696,44 @@ declare namespace gapi.client {
1663
1696
  /** The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */
1664
1697
  citationThreshold?: number;
1665
1698
  }
1699
+ interface GoogleCloudDiscoveryengineV1Chunk {
1700
+ /** Output only. Metadata of the current chunk. */
1701
+ chunkMetadata?: GoogleCloudDiscoveryengineV1ChunkChunkMetadata;
1702
+ /** Content is a string from a document (parsed content). */
1703
+ content?: string;
1704
+ /** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
1705
+ derivedStructData?: {[P in string]: any};
1706
+ /** Metadata of the document from the current chunk. */
1707
+ documentMetadata?: GoogleCloudDiscoveryengineV1ChunkDocumentMetadata;
1708
+ /** Unique chunk ID of the current chunk. */
1709
+ id?: string;
1710
+ /** The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1711
+ name?: string;
1712
+ /** Page span of the chunk. */
1713
+ pageSpan?: GoogleCloudDiscoveryengineV1ChunkPageSpan;
1714
+ /** Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. */
1715
+ relevanceScore?: number;
1716
+ }
1717
+ interface GoogleCloudDiscoveryengineV1ChunkChunkMetadata {
1718
+ /** The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. */
1719
+ nextChunks?: GoogleCloudDiscoveryengineV1Chunk[];
1720
+ /** The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. */
1721
+ previousChunks?: GoogleCloudDiscoveryengineV1Chunk[];
1722
+ }
1723
+ interface GoogleCloudDiscoveryengineV1ChunkDocumentMetadata {
1724
+ /** Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
1725
+ structData?: {[P in string]: any};
1726
+ /** Title of the document. */
1727
+ title?: string;
1728
+ /** Uri of the document. */
1729
+ uri?: string;
1730
+ }
1731
+ interface GoogleCloudDiscoveryengineV1ChunkPageSpan {
1732
+ /** The end page of the chunk. */
1733
+ pageEnd?: number;
1734
+ /** The start page of the chunk. */
1735
+ pageStart?: number;
1736
+ }
1666
1737
  interface GoogleCloudDiscoveryengineV1CloudSqlSource {
1667
1738
  /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
1668
1739
  databaseId?: string;
@@ -1940,6 +2011,8 @@ declare namespace gapi.client {
1940
2011
  uri?: string;
1941
2012
  }
1942
2013
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
2014
+ /** Whether chunking mode is enabled. */
2015
+ chunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig;
1943
2016
  /** Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */
1944
2017
  defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
1945
2018
  /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
@@ -1949,13 +2022,26 @@ declare namespace gapi.client {
1949
2022
  [P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
1950
2023
  };
1951
2024
  }
2025
+ interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig {
2026
+ /** Configuration for the layout based chunking. */
2027
+ layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
2028
+ }
2029
+ interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
2030
+ /** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
2031
+ chunkSize?: number;
2032
+ /** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
2033
+ includeAncestorHeadings?: boolean;
2034
+ }
1952
2035
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
1953
2036
  /** Configurations applied to digital parser. */
1954
2037
  digitalParsingConfig?: any;
2038
+ /** Configurations applied to layout parser. */
2039
+ layoutParsingConfig?: any;
1955
2040
  /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
1956
2041
  ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
1957
2042
  }
1958
2043
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
2044
+ interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {}
1959
2045
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
1960
2046
  /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
1961
2047
  enhancedDocumentElements?: string[];
@@ -2083,6 +2169,8 @@ declare namespace gapi.client {
2083
2169
  updateTime?: string;
2084
2170
  }
2085
2171
  interface GoogleCloudDiscoveryengineV1ImportDocumentsRequest {
2172
+ /** AlloyDB input source. */
2173
+ alloyDbSource?: GoogleCloudDiscoveryengineV1AlloyDbSource;
2086
2174
  /** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
2087
2175
  autoGenerateIds?: boolean;
2088
2176
  /** BigQuery input source. */
@@ -2479,13 +2567,23 @@ declare namespace gapi.client {
2479
2567
  condition?: string;
2480
2568
  }
2481
2569
  interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec {
2570
+ /** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
2571
+ chunkSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec;
2482
2572
  /** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
2483
2573
  extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
2574
+ /** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. */
2575
+ searchResultMode?: string;
2484
2576
  /** If `snippetSpec` is not specified, snippets are not included in the search response. */
2485
2577
  snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
2486
2578
  /** If `summarySpec` is not specified, summaries are not included in the search response. */
2487
2579
  summarySpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec;
2488
2580
  }
2581
+ interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec {
2582
+ /** The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */
2583
+ numNextChunks?: number;
2584
+ /** The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */
2585
+ numPreviousChunks?: number;
2586
+ }
2489
2587
  interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec {
2490
2588
  /** The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */
2491
2589
  maxExtractiveAnswerCount?: number;
@@ -2619,6 +2717,8 @@ declare namespace gapi.client {
2619
2717
  pinnedResultCount?: string;
2620
2718
  }
2621
2719
  interface GoogleCloudDiscoveryengineV1SearchResponseSearchResult {
2720
+ /** The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
2721
+ chunk?: GoogleCloudDiscoveryengineV1Chunk;
2622
2722
  /** The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */
2623
2723
  document?: GoogleCloudDiscoveryengineV1Document;
2624
2724
  /** Document.id of the searched Document. */
@@ -3413,7 +3513,7 @@ declare namespace gapi.client {
3413
3513
  key?: string;
3414
3514
  /** OAuth 2.0 token for the current user. */
3415
3515
  oauth_token?: string;
3416
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3516
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
3417
3517
  parent: string;
3418
3518
  /** Returns response with indentations and line breaks. */
3419
3519
  prettyPrint?: boolean;
@@ -3444,7 +3544,7 @@ declare namespace gapi.client {
3444
3544
  key?: string;
3445
3545
  /** OAuth 2.0 token for the current user. */
3446
3546
  oauth_token?: string;
3447
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3547
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
3448
3548
  parent: string;
3449
3549
  /** Returns response with indentations and line breaks. */
3450
3550
  prettyPrint?: boolean;
@@ -3533,7 +3633,7 @@ declare namespace gapi.client {
3533
3633
  pageSize?: number;
3534
3634
  /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
3535
3635
  pageToken?: string;
3536
- /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
3636
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
3537
3637
  parent: string;
3538
3638
  /** Returns response with indentations and line breaks. */
3539
3639
  prettyPrint?: boolean;
@@ -5929,7 +6029,7 @@ declare namespace gapi.client {
5929
6029
  key?: string;
5930
6030
  /** OAuth 2.0 token for the current user. */
5931
6031
  oauth_token?: string;
5932
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6032
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
5933
6033
  parent: string;
5934
6034
  /** Returns response with indentations and line breaks. */
5935
6035
  prettyPrint?: boolean;
@@ -5960,7 +6060,7 @@ declare namespace gapi.client {
5960
6060
  key?: string;
5961
6061
  /** OAuth 2.0 token for the current user. */
5962
6062
  oauth_token?: string;
5963
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6063
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
5964
6064
  parent: string;
5965
6065
  /** Returns response with indentations and line breaks. */
5966
6066
  prettyPrint?: boolean;
@@ -6049,7 +6149,7 @@ declare namespace gapi.client {
6049
6149
  pageSize?: number;
6050
6150
  /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
6051
6151
  pageToken?: string;
6052
- /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
6152
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
6053
6153
  parent: string;
6054
6154
  /** Returns response with indentations and line breaks. */
6055
6155
  prettyPrint?: boolean;
@@ -7631,7 +7731,7 @@ declare namespace gapi.client {
7631
7731
  key?: string;
7632
7732
  /** OAuth 2.0 token for the current user. */
7633
7733
  oauth_token?: string;
7634
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
7734
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
7635
7735
  parent: string;
7636
7736
  /** Returns response with indentations and line breaks. */
7637
7737
  prettyPrint?: boolean;
@@ -7662,7 +7762,7 @@ declare namespace gapi.client {
7662
7762
  key?: string;
7663
7763
  /** OAuth 2.0 token for the current user. */
7664
7764
  oauth_token?: string;
7665
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
7765
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
7666
7766
  parent: string;
7667
7767
  /** Returns response with indentations and line breaks. */
7668
7768
  prettyPrint?: boolean;
@@ -7751,7 +7851,7 @@ declare namespace gapi.client {
7751
7851
  pageSize?: number;
7752
7852
  /** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
7753
7853
  pageToken?: string;
7754
- /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` */
7854
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. */
7755
7855
  parent: string;
7756
7856
  /** Returns response with indentations and line breaks. */
7757
7857
  prettyPrint?: boolean;
@@ -10033,6 +10133,39 @@ declare namespace gapi.client {
10033
10133
  ): Request<GoogleCloudDiscoveryengineV1RankResponse>;
10034
10134
  }
10035
10135
  interface UserEventsResource {
10136
+ /** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
10137
+ collect(request?: {
10138
+ /** V1 error format. */
10139
+ '$.xgafv'?: string;
10140
+ /** OAuth access token. */
10141
+ access_token?: string;
10142
+ /** Data format for response. */
10143
+ alt?: string;
10144
+ /** JSONP */
10145
+ callback?: string;
10146
+ /** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
10147
+ ets?: string;
10148
+ /** Selector specifying which fields to include in a partial response. */
10149
+ fields?: string;
10150
+ /** 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. */
10151
+ key?: string;
10152
+ /** OAuth 2.0 token for the current user. */
10153
+ oauth_token?: string;
10154
+ /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
10155
+ parent: string;
10156
+ /** Returns response with indentations and line breaks. */
10157
+ prettyPrint?: boolean;
10158
+ /** 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. */
10159
+ quotaUser?: string;
10160
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10161
+ upload_protocol?: string;
10162
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10163
+ uploadType?: string;
10164
+ /** The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. */
10165
+ uri?: string;
10166
+ /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
10167
+ userEvent?: string;
10168
+ }): Request<GoogleApiHttpBody>;
10036
10169
  /** Writes a single user event. */
10037
10170
  write(request: {
10038
10171
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
3
- "version": "0.0.20240526",
3
+ "version": "0.0.20240607",
4
4
  "description": "TypeScript typings for Discovery Engine API v1",
5
5
  "repository": {
6
6
  "type": "git",