@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240307 → 0.0.20240318

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=v1beta
-// Revision: 20240307
+// Revision: 20240318
 
 /// <reference types="gapi.client" />
 
@@ -170,7 +170,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;
@@ -206,7 +205,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 GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata {
       /** Operation create time. */
@@ -396,13 +403,6 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {}
-    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 GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -749,7 +749,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;
@@ -812,7 +811,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 GoogleCloudDiscoveryengineV1betaDoubleList {
       /** Double values. */
@@ -1056,12 +1062,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 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 GoogleCloudDiscoveryengineV1betaPageInfo {
       /** 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;
@@ -1240,9 +1240,9 @@ declare namespace gapi.client {
       conditionBoostSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[];
     }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
-      /** 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. */
+      /** 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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */
       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 GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec {
@@ -1262,6 +1262,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 GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec {
       /** [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. */
@@ -1286,13 +1288,15 @@ declare namespace gapi.client {
       modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
       /** 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. */
       summaryResultCount?: number;
+      /** 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. */
+      useSemanticChunks?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
       /** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
       preamble?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
-      /** 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 GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
@@ -1517,8 +1521,6 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig {
       /** 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. */
@@ -1582,6 +1584,24 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest {
+      /** The desired location of errors incurred during the data ingestion and training. */
+      errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
+      /** Cloud Storage training input. */
+      gcsTrainingInput?: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput;
+      /** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
+      modelType?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput {
+      /** 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"} */
+      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` */
+      trainDataPath?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
       /** Echoes the destination for the complete errors in the request if set. */
       errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
@@ -1730,7 +1750,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;
@@ -1752,7 +1771,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. */
@@ -1869,12 +1895,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;
@@ -4560,6 +4580,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1betaDataStore
       ): Request<GoogleCloudDiscoveryengineV1betaDataStore>;
+      /** Trains a custom model. */
+      trainCustomModel(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
+        dataStore: 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. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
+      }): Request<GoogleLongrunningOperation>;
+      trainCustomModel(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
+          dataStore: 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. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** 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. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest
+      ): Request<GoogleLongrunningOperation>;
       branches: BranchesResource;
       conversations: ConversationsResource;
       models: ModelsResource;

package/package.json

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