@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240227 → 0.0.20240229

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 +38 -4
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20240227
12
+ // Revision: 20240229
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -121,6 +121,24 @@ declare namespace gapi.client {
121
121
  /** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
122
122
  tableId?: string;
123
123
  }
124
+ interface GoogleCloudDiscoveryengineV1alphaChunk {
125
+ /** Content is a string from a document (parsed content). */
126
+ content?: string;
127
+ /** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
128
+ derivedStructData?: {[P in string]: any};
129
+ /** Metadata of the document from the current chunk. */
130
+ documentMetadata?: GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata;
131
+ /** Unique chunk id of the current chunk. */
132
+ id?: string;
133
+ /** 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. */
134
+ name?: string;
135
+ }
136
+ interface GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
137
+ /** Title of the document. */
138
+ title?: string;
139
+ /** Uri of the document. */
140
+ uri?: string;
141
+ }
124
142
  interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
125
143
  /** Required. The parent data store resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. */
126
144
  dataStore?: string;
@@ -128,7 +146,7 @@ declare namespace gapi.client {
128
146
  includeTailSuggestions?: boolean;
129
147
  /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
130
148
  query?: string;
131
- /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
149
+ /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * */
132
150
  queryModel?: string;
133
151
  /** 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`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
134
152
  userPseudoId?: string;
@@ -356,6 +374,8 @@ declare namespace gapi.client {
356
374
  uri?: string;
357
375
  }
358
376
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
377
+ /** Whether chunking mode is enabled. */
378
+ chunkingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig;
359
379
  /** 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. */
360
380
  defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
361
381
  /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
@@ -367,6 +387,16 @@ declare namespace gapi.client {
367
387
  [P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
368
388
  };
369
389
  }
390
+ interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
391
+ /** Configuration for the layout based chunking. */
392
+ layoutBasedChunkingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
393
+ }
394
+ interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
395
+ /** The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */
396
+ chunkSize?: number;
397
+ /** Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */
398
+ includeAncestorHeadings?: boolean;
399
+ }
370
400
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig {
371
401
  /** Configurations applied to digital parser. */
372
402
  digitalParsingConfig?: any;
@@ -1007,6 +1037,8 @@ declare namespace gapi.client {
1007
1037
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
1008
1038
  /** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
1009
1039
  extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
1040
+ /** 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`. */
1041
+ searchResultMode?: string;
1010
1042
  /** If `snippetSpec` is not specified, snippets are not included in the search response. */
1011
1043
  snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
1012
1044
  /** If `summarySpec` is not specified, summaries are not included in the search response. */
@@ -1170,6 +1202,8 @@ declare namespace gapi.client {
1170
1202
  pinnedResultCount?: string;
1171
1203
  }
1172
1204
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult {
1205
+ /** The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
1206
+ chunk?: GoogleCloudDiscoveryengineV1alphaChunk;
1173
1207
  /** The document data snippet in the search response. Only fields that are marked as retrievable are populated. */
1174
1208
  document?: GoogleCloudDiscoveryengineV1alphaDocument;
1175
1209
  /** Document.id of the searched Document. */
@@ -4821,7 +4855,7 @@ declare namespace gapi.client {
4821
4855
  prettyPrint?: boolean;
4822
4856
  /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
4823
4857
  query?: string;
4824
- /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
4858
+ /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * */
4825
4859
  queryModel?: string;
4826
4860
  /** 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. */
4827
4861
  quotaUser?: string;
@@ -8290,7 +8324,7 @@ declare namespace gapi.client {
8290
8324
  prettyPrint?: boolean;
8291
8325
  /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
8292
8326
  query?: string;
8293
- /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
8327
+ /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * */
8294
8328
  queryModel?: string;
8295
8329
  /** 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. */
8296
8330
  quotaUser?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20240227",
3
+ "version": "0.0.20240229",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",