@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240206 → 0.0.20240224

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: 20240206
+// Revision: 20240224
 
 /// <reference types="gapi.client" />
 
@@ -174,6 +174,8 @@ declare namespace gapi.client {
       userInput?: GoogleCloudDiscoveryengineV1alphaTextInput;
     }
     interface GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
+      /** Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
+      boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
       /** The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. */
       conversation?: GoogleCloudDiscoveryengineV1alphaConversation;
       /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -250,12 +252,16 @@ declare namespace gapi.client {
       defaultSchemaId?: string;
       /** Required. The data store display name. 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;
+      /** Configuration for Document understanding and enrichment. */
+      documentProcessingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
       /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
       solutionTypes?: string[];
+      /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
+      startingSchema?: GoogleCloudDiscoveryengineV1alphaSchema;
     }
     interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
       /** Operation create time. */
@@ -297,6 +303,8 @@ declare namespace gapi.client {
       derivedStructData?: {[P in string]: any};
       /** Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
       id?: string;
+      /** Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. */
+      indexTime?: string;
       /** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
       jsonData?: string;
       /** Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
@@ -335,7 +343,7 @@ declare namespace gapi.client {
       name?: string;
       /** [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. */
       ocrConfig?: GoogleCloudDiscoveryengineV1alphaOcrConfig;
-      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. */
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
       };
@@ -734,6 +742,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Count of entries that encountered errors while processing. */
       failureCount?: string;
+      /** Count of entries that were ignored as entries were not found. */
+      ignoredCount?: string;
       /** Count of entries that were deleted successfully. */
       successCount?: string;
       /** Operation last update time. If the operation is done, this is also the finish time. */
@@ -900,6 +910,8 @@ declare namespace gapi.client {
       canonicalFilter?: string;
       /** A specification for configuring the behavior of content search. */
       contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
+      /** Custom fine tuning configs. */
+      customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
       /** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
       embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
       /** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
@@ -944,7 +956,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": * (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 {
@@ -1129,6 +1141,7 @@ declare namespace gapi.client {
       summarySkippedReasons?: string[];
       /** The summary content. */
       summaryText?: string;
+      /** Summary with metadata information. */
       summaryWithMetadata?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation {
@@ -1200,6 +1213,7 @@ declare namespace gapi.client {
       name?: string;
       /** Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
       onewaySynonymsControlIds?: string[];
+      /** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding). */
       rankingExpression?: string;
       /** IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
       redirectControlIds?: string[];
@@ -1435,6 +1449,8 @@ declare namespace gapi.client {
       enableSnippetResultSummary?: boolean;
       /** Turn on or off summarization for the search response. */
       enableSummarization?: boolean;
+      /** Whether to enable standalone web app. */
+      enableWebApp?: boolean;
       /** The configuration and appearance of facets in the end user view. */
       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. */
@@ -1555,12 +1571,16 @@ declare namespace gapi.client {
       defaultSchemaId?: string;
       /** Required. The data store display name. 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;
+      /** Configuration for Document understanding and enrichment. */
+      documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
       /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
       solutionTypes?: string[];
+      /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
+      startingSchema?: GoogleCloudDiscoveryengineV1betaSchema;
     }
     interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
       /** Operation create time. */
@@ -1586,6 +1606,7 @@ 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;
@@ -1593,6 +1614,22 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
+      /** 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. */
+      defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
+      /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
+      name?: string;
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
+      parsingConfigOverrides?: {
+        [P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
+      };
+    }
+    interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
+      /** Configurations applied to digital parser. */
+      digitalParsingConfig?: any;
+      /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
+      ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
+    }
     interface GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1708,11 +1745,19 @@ 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;
       /** Count of entries that encountered errors while processing. */
       failureCount?: string;
+      /** Count of entries that were ignored as entries were not found. */
+      ignoredCount?: string;
       /** Count of entries that were deleted successfully. */
       successCount?: string;
       /** Operation last update time. If the operation is done, this is also the finish time. */
@@ -1823,12 +1868,16 @@ declare namespace gapi.client {
       defaultSchemaId?: string;
       /** Required. The data store display name. 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;
+      /** Configuration for Document understanding and enrichment. */
+      documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
       /** Immutable. The industry vertical that the data store registers. */
       industryVertical?: string;
       /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
       solutionTypes?: string[];
+      /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
+      startingSchema?: GoogleCloudDiscoveryengineV1Schema;
     }
     interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
       /** Operation create time. */
@@ -1854,6 +1903,7 @@ 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;
@@ -1861,6 +1911,22 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
+      /** 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. */
+      defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
+      /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
+      name?: string;
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
+      parsingConfigOverrides?: {
+        [P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
+      };
+    }
+    interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
+      /** Configurations applied to digital parser. */
+      digitalParsingConfig?: any;
+      /** Configurations applied to OCR parser. Currently it only applies to PDFs. */
+      ocrParsingConfig?: GoogleCloudDiscoveryengineV1OcrParsingConfig;
+    }
     interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1976,11 +2042,19 @@ 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;
       /** Count of entries that encountered errors while processing. */
       failureCount?: string;
+      /** Count of entries that were ignored as entries were not found. */
+      ignoredCount?: string;
       /** Count of entries that were deleted successfully. */
       successCount?: string;
       /** Operation last update time. If the operation is done, this is also the finish time. */

package/package.json

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