@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240409 → 0.0.20240502

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=v1
-// Revision: 20240409
+// Revision: 20240502
 
 /// <reference types="gapi.client" />
 
@@ -99,7 +99,7 @@ declare namespace gapi.client {
       completeTime?: string;
       /** Output only. Answer creation timestamp. */
       createTime?: string;
-      /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
+      /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
       name?: string;
       /** Query understanding information. */
       queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
@@ -260,6 +260,19 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
+      /** Timestamp the Model was created at. */
+      createTime?: string;
+      /** The display name of the model. */
+      displayName?: string;
+      /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
+      modelState?: string;
+      modelVersion?: string;
+      /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
+      name?: string;
+      /** Timestamp the model training was initiated. */
+      trainingStartTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDataStore {
       /** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
       aclEnabled?: boolean;
@@ -348,7 +361,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
     interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
-      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
       enhancedDocumentElements?: string[];
       /** If true, will use native text instead of OCR text on pages containing native text. */
       useNativeText?: boolean;
@@ -393,7 +406,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
       /** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
       agentCreationConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
-      /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
+      /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
       dialogflowAgentToLink?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
@@ -443,7 +456,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
       /** The add-on that this search engine enables. */
       searchAddOns?: string[];
-      /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
+      /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
       searchTier?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
@@ -458,6 +471,8 @@ declare namespace gapi.client {
       documentCount?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
+      /** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
+      advancedSiteSearchDataSources?: string[];
       /** If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. */
       completableOption?: string;
       /** If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. */
@@ -487,20 +502,6 @@ declare namespace gapi.client {
       /** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
       workforcePoolName?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
-      /** Operation create time. */
-      createTime?: string;
-      /** Operation last update time. If the operation is done, this is also the finish time. */
-      updateTime?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
-      /** A sample of errors encountered while processing the request. */
-      errorSamples?: GoogleRpcStatus[];
-      /** Count of CompletionSuggestions that failed to be imported. */
-      failureCount?: string;
-      /** Count of CompletionSuggestions successfully imported. */
-      successCount?: string;
-    }
     interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -557,6 +558,35 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse {
+      /** List of custom tuning models. */
+      models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
+    }
+    interface GoogleCloudDiscoveryengineV1alphaProject {
+      /** Output only. The timestamp when this project is created. */
+      createTime?: string;
+      /** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
+      name?: string;
+      /** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
+      provisionCompletionTime?: string;
+      /** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
+      serviceTermsMap?: {
+        [P in string]: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
+      };
+    }
+    interface GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
+      /** The last time when the project agreed to the terms of service. */
+      acceptTime?: string;
+      /** The last time when the project declined or revoked the agreement to terms of service. */
+      declineTime?: string;
+      /** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
+      id?: string;
+      /** Whether the project has accepted/rejected the service terms or it is still pending. */
+      state?: string;
+      /** The version string of the terms of service. For acceptable values, see the comments for id above. */
+      version?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {}
     interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -654,7 +684,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSession {
       /** Output only. The time the session finished. */
       endTime?: string;
-      /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
+      /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
       name?: string;
       /** Output only. The time the session started. */
       startTime?: string;
@@ -690,6 +720,8 @@ declare namespace gapi.client {
       name?: string;
       /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
       providedUriPattern?: string;
+      /** Output only. Root domain of the provided_uri_pattern. */
+      rootDomainUri?: string;
       /** Output only. Site ownership and validity verification status. */
       siteVerificationInfo?: GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
       /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -718,6 +750,8 @@ declare namespace gapi.client {
       errorSamples?: GoogleRpcStatus[];
       /** The metrics of the trained model. */
       metrics?: {[P in string]: number};
+      /** Fully qualified name of the CustomTuningModel. */
+      modelName?: string;
       /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
       modelStatus?: string;
     }
@@ -787,6 +821,19 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaCustomTuningModel {
+      /** Timestamp the Model was created at. */
+      createTime?: string;
+      /** The display name of the model. */
+      displayName?: string;
+      /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
+      modelState?: string;
+      modelVersion?: string;
+      /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
+      name?: string;
+      /** Timestamp the model training was initiated. */
+      trainingStartTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaDataStore {
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
@@ -856,7 +903,7 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
-      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
       enhancedDocumentElements?: string[];
       /** If true, will use native text instead of OCR text on pages containing native text. */
       useNativeText?: boolean;
@@ -895,7 +942,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
       /** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
       agentCreationConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
-      /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
+      /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
       dialogflowAgentToLink?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
@@ -919,7 +966,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
       /** The add-on that this search engine enables. */
       searchAddOns?: string[];
-      /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
+      /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
       searchTier?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
@@ -978,6 +1025,10 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaListCustomModelsResponse {
+      /** List of custom tuning models. */
+      models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
+    }
     interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1035,6 +1086,8 @@ declare namespace gapi.client {
       name?: string;
       /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
       providedUriPattern?: string;
+      /** Output only. Root domain of the provided_uri_pattern. */
+      rootDomainUri?: string;
       /** Output only. Site ownership and validity verification status. */
       siteVerificationInfo?: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
       /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -1063,6 +1116,8 @@ declare namespace gapi.client {
       errorSamples?: GoogleRpcStatus[];
       /** The metrics of the trained model. */
       metrics?: {[P in string]: number};
+      /** Fully qualified name of the CustomTuningModel. */
+      modelName?: string;
       /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
       modelStatus?: string;
     }
@@ -1070,6 +1125,7 @@ declare namespace gapi.client {
       /** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
       engine?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
     interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1137,7 +1193,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1CloudSqlSource {
       /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
       databaseId?: string;
-      /** 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 Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
+      /** 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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
       gcsStagingDir?: string;
       /** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
       instanceId?: string;
@@ -1171,7 +1227,7 @@ declare namespace gapi.client {
       endTime?: string;
       /** Conversation messages. */
       messages?: GoogleCloudDiscoveryengineV1ConversationMessage[];
-      /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
+      /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
       name?: string;
       /** Output only. The time the conversation started. */
       startTime?: string;
@@ -1366,7 +1422,7 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
-      /** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
+      /** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
       enhancedDocumentElements?: string[];
       /** If true, will use native text instead of OCR text on pages containing native text. */
       useNativeText?: boolean;
@@ -1406,7 +1462,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
       /** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
       agentCreationConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
-      /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
+      /** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
       dialogflowAgentToLink?: string;
     }
     interface GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
@@ -1430,7 +1486,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
       /** The add-on that this search engine enables. */
       searchAddOns?: string[];
-      /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
+      /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
       searchTier?: string;
     }
     interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
@@ -1452,7 +1508,7 @@ declare namespace gapi.client {
       collectionId?: string;
       /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
       databaseId?: string;
-      /** 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 Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
+      /** 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 Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
       gcsStagingDir?: string;
       /** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
       projectId?: string;
@@ -1630,7 +1686,7 @@ declare namespace gapi.client {
       mediaProgressPercentage?: number;
     }
     interface GoogleCloudDiscoveryengineV1PageInfo {
-      /** 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. */
+      /** 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, 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;
       /** A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. */
       pageviewId?: string;
@@ -1761,7 +1817,7 @@ declare namespace gapi.client {
       imageQuery?: GoogleCloudDiscoveryengineV1SearchRequestImageQuery;
       /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       offset?: number;
-      /** 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. */
+      /** 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
       /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       pageSize?: number;
@@ -1811,7 +1867,7 @@ 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`. */
+      /** 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, contact your Customer Engineer. The default value is `false`. */
       returnExtractiveSegmentScore?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec {
@@ -1835,9 +1891,9 @@ declare namespace gapi.client {
       modelPromptSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec;
       /** If specified, the spec will be used to modify the model specification provided to the LLM. */
       modelSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec;
-      /** 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. */
+      /** 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 for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
       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. */
+      /** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. 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 GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec {
@@ -2037,6 +2093,8 @@ declare namespace gapi.client {
       name?: string;
       /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
       providedUriPattern?: string;
+      /** Output only. Root domain of the provided_uri_pattern. */
+      rootDomainUri?: string;
       /** Output only. Site ownership and validity verification status. */
       siteVerificationInfo?: GoogleCloudDiscoveryengineV1SiteVerificationInfo;
       /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -2458,6 +2516,8 @@ declare namespace gapi.client {
         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;
+        /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+        updateMask?: string;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -2489,6 +2549,8 @@ declare namespace gapi.client {
           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;
+          /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+          updateMask?: string;
           /** Upload protocol for media (e.g. "raw", "multipart"). */
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -2841,7 +2903,7 @@ declare namespace gapi.client {
         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;
-        /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
+        /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -2872,7 +2934,7 @@ declare namespace gapi.client {
           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;
-          /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
+          /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -4288,7 +4350,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
+        /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -4317,7 +4379,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
+          /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -4526,7 +4588,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
+        /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
         filter?: 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;
@@ -4839,7 +4901,7 @@ declare namespace gapi.client {
         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;
-        /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
+        /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -4870,7 +4932,7 @@ declare namespace gapi.client {
           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;
-          /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
+          /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -5582,6 +5644,8 @@ declare namespace gapi.client {
         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;
+        /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+        updateMask?: string;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -5613,6 +5677,8 @@ declare namespace gapi.client {
           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;
+          /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
+          updateMask?: string;
           /** Upload protocol for media (e.g. "raw", "multipart"). */
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -5965,7 +6031,7 @@ declare namespace gapi.client {
         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;
-        /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
+        /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -5996,7 +6062,7 @@ declare namespace gapi.client {
           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;
-          /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `project/*‍/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
+          /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -7134,7 +7200,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
+        /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -7163,7 +7229,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
+          /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -7372,7 +7438,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
+        /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
         filter?: 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;
@@ -7527,10 +7593,71 @@ declare namespace gapi.client {
         uploadType?: string;
       }): Request<GoogleLongrunningListOperationsResponse>;
     }
+    interface UserEventsResource {
+      /** Writes a single user event. */
+      write(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: 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;
+        /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
+        parent: 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: GoogleCloudDiscoveryengineV1UserEvent;
+      }): Request<GoogleCloudDiscoveryengineV1UserEvent>;
+      write(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: 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;
+          /** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
+          parent: 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: GoogleCloudDiscoveryengineV1UserEvent
+      ): Request<GoogleCloudDiscoveryengineV1UserEvent>;
+    }
     interface LocationsResource {
       collections: CollectionsResource;
       dataStores: DataStoresResource;
       operations: OperationsResource;
+      userEvents: UserEventsResource;
     }
     interface OperationsResource {
       /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */

package/package.json

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