@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240307 → 0.0.20240312

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20240307
+// Revision: 20240312
 
 /// <reference types="gapi.client" />
 
@@ -315,7 +315,6 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -402,7 +401,15 @@ declare namespace gapi.client {
       /** Configurations applied to layout parser. */
       layoutParsingConfig?: any;
       /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
-      ocrParsingConfig?: GoogleCloudDiscoveryengineV1alphaOcrParsingConfig;
+      ocrParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
+    interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
+    interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
+      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      enhancedDocumentElements?: string[];
+      /** If true, will use native text instead of OCR text on pages containing native text. */
+      useNativeText?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1alphaDoubleList {
       /** Double values. */
@@ -701,7 +708,6 @@ declare namespace gapi.client {
       /** Inclusive lower bound. */
       minimum?: number;
     }
-    interface GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {}
     interface GoogleCloudDiscoveryengineV1alphaListChunksResponse {
       /** The Chunks. */
       chunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
@@ -766,12 +772,6 @@ declare namespace gapi.client {
       /** Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */
       mediaProgressPercentage?: number;
     }
-    interface GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
-      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
-      enhancedDocumentElements?: string[];
-      /** If true, will use native text instead of OCR text on pages containing native text. */
-      useNativeText?: boolean;
-    }
     interface GoogleCloudDiscoveryengineV1alphaPageInfo {
       /** 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. */
       pageCategory?: string;
@@ -1028,7 +1028,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
       /** Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
       boost?: number;
-      /** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) */
+      /** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */
       condition?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
@@ -1050,6 +1050,8 @@ declare namespace gapi.client {
       numNextSegments?: number;
       /** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
       numPreviousSegments?: number;
+      /** 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`. */
+      returnExtractiveSegmentScore?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec {
       /** [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. */
@@ -1080,7 +1082,7 @@ declare namespace gapi.client {
       preamble?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
-      /** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. */
+      /** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */
       version?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
@@ -1313,8 +1315,6 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
       /** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
       contentFreshnessCutoffDays?: number;
-      /** Specifies the content watched minutes threshold for demotion. */
-      contentWatchedMinutesThreshold?: number;
       /** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
       contentWatchedPercentageThreshold?: number;
       /** Specifies the content watched minutes threshold for demotion. */
@@ -1387,13 +1387,13 @@ declare namespace gapi.client {
       modelType?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
-      /** The Cloud Storage corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: {"_id": "doc1", title: "relevant doc", "text": "relevant text"} */
+      /** The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}` */
       corpusDataPath?: string;
-      /** The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
+      /** The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
       queryDataPath?: string;
       /** Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */
       testDataPath?: string;
-      /** Cloud Storage training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\tdoc1\t1 */
+      /** Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` */
       trainDataPath?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
@@ -1505,6 +1505,8 @@ declare namespace gapi.client {
       allowlistedDomains?: string[];
       /** Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. */
       allowPublicAccess?: boolean;
+      /** Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. */
+      collectionComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
       /** Output only. Unique obfuscated identifier of a WidgetConfig. */
       configId?: string;
       /** The content search spec that configs the desired behavior of content search. */
@@ -1513,6 +1515,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Output only. The type of the parent data store. */
       dataStoreType?: string;
+      /** Configurable UI configurations per data store. */
+      dataStoreUiConfigs?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[];
       /** Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
       displayName?: string;
       /** Whether or not to enable autocomplete. */
@@ -1552,6 +1556,36 @@ declare namespace gapi.client {
       /** Output only. Timestamp the WidgetConfig was updated. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
+      /** For the data store collection, list of the children data stores. */
+      dataStoreComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
+      /** The display name of the collection. */
+      displayName?: string;
+      /** Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. */
+      id?: string;
+      /** The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For widget service usage, such look up widget config, returned name should be skipped. */
+      name?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
+      /** The display name of the data store. */
+      displayName?: string;
+      /** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
+      id?: string;
+      /** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped. */
+      name?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
+      /** Facet fields that store the mapping of fields to end user widget appearance. */
+      facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
+      /** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
+      fieldsUiComponentsMap?: {
+        [P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
+      };
+      /** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
+      id?: string;
+      /** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped. */
+      name?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
       /** Optional. The field name that end users will see. */
       displayName?: string;
@@ -1686,7 +1720,6 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
-    interface GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1708,7 +1741,14 @@ declare namespace gapi.client {
       /** Configurations applied to digital parser. */
       digitalParsingConfig?: any;
       /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
-      ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
+      ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
+    }
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
+      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      enhancedDocumentElements?: string[];
+      /** If true, will use native text instead of OCR text on pages containing native text. */
+      useNativeText?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
       /** Operation create time. */
@@ -1825,12 +1865,6 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
-    interface GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
-      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
-      enhancedDocumentElements?: string[];
-      /** If true, will use native text instead of OCR text on pages containing native text. */
-      useNativeText?: boolean;
-    }
     interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1997,7 +2031,6 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
-    interface GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2019,7 +2052,14 @@ declare namespace gapi.client {
       /** Configurations applied to digital parser. */
       digitalParsingConfig?: any;
       /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
-      ocrParsingConfig?: GoogleCloudDiscoveryengineV1OcrParsingConfig;
+      ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
+    }
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
+      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      enhancedDocumentElements?: string[];
+      /** If true, will use native text instead of OCR text on pages containing native text. */
+      useNativeText?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
       /** Operation create time. */
@@ -2136,12 +2176,6 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
-    interface GoogleCloudDiscoveryengineV1OcrParsingConfig {
-      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
-      enhancedDocumentElements?: string[];
-      /** If true, will use native text instead of OCR text on pages containing native text. */
-      useNativeText?: boolean;
-    }
     interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2598,7 +2632,6 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
-        documentsId: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
         /** 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. */
@@ -6407,7 +6440,6 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
-        documentsId: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
         /** 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. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20240307",
+  "version": "0.0.20240312",
   "description": "TypeScript typings for Discovery Engine API v1alpha",
   "repository": {
     "type": "git",