@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240912 → 0.0.20240930

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: 20240912
+// Revision: 20240930
 
 /// <reference types="gapi.client" />
 
@@ -362,6 +362,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
+      /** Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. */
+      errorMessage?: string;
       /** The metrics of the trained model. */
       metrics?: {[P in string]: number};
       /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
@@ -376,6 +378,8 @@ declare namespace gapi.client {
     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;
+      /** Output only. Data size estimation for billing. */
+      billingEstimation?: GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation;
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
       /** Output only. Timestamp the DataStore was created at. */
@@ -405,6 +409,20 @@ declare namespace gapi.client {
       /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
       workspaceConfig?: GoogleCloudDiscoveryengineV1alphaWorkspaceConfig;
     }
+    interface GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation {
+      /** Data size for structured data in terms of bytes. */
+      structuredDataSize?: string;
+      /** Last updated timestamp for structured data. */
+      structuredDataUpdateTime?: string;
+      /** Data size for unstructured data in terms of bytes. */
+      unstructuredDataSize?: string;
+      /** Last updated timestamp for unstructured data. */
+      unstructuredDataUpdateTime?: string;
+      /** Data size for websites in terms of bytes. */
+      websiteDataSize?: string;
+      /** Last updated timestamp for websites. */
+      websiteDataUpdateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -492,6 +510,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */
       dataStoreIds?: string[];
+      /** Optional. Whether to disable analytics for searches performed on this engine. */
+      disableAnalytics?: boolean;
       /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
       displayName?: string;
       /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
@@ -621,6 +641,8 @@ declare namespace gapi.client {
       indexableOption?: string;
       /** Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. */
       keyPropertyType?: string;
+      /** Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. */
+      metatagName?: string;
       /** If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. */
       recsFilterableOption?: string;
       /** If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. */
@@ -950,6 +972,8 @@ declare namespace gapi.client {
       pageToken?: string;
       /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */
       params?: {[P in string]: any};
+      /** The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. */
+      personalizationSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec;
       /** Raw search query. */
       query?: string;
       /** The query expansion specification that specifies the conditions under which query expansion occurs. */
@@ -1078,6 +1102,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
+      /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
+      filter?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
       /** The embedding vector used for retrieval. Limit to 1. */
@@ -1125,6 +1151,10 @@ declare namespace gapi.client {
       /** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
       geoSearchQueryDetectionFieldNames?: string[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec {
+      /** The personalization mode of the search request. Defaults to Mode.AUTO. */
+      mode?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec {
       /** The condition under which query expansion should occur. Default to Condition.DISABLED. */
       condition?: string;
@@ -1256,6 +1286,10 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
       /** Obfuscated Dasher customer ID. */
       dasherCustomerId?: string;
+      /** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
+      superAdminEmailAddress?: string;
+      /** Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
+      superAdminServiceAccount?: string;
       /** The Google Workspace data source. */
       type?: string;
     }
@@ -1706,6 +1740,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
+      /** Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. */
+      errorMessage?: string;
       /** The metrics of the trained model. */
       metrics?: {[P in string]: number};
       /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
@@ -1718,6 +1754,8 @@ declare namespace gapi.client {
       trainingStartTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaDataStore {
+      /** Output only. Data size estimation for billing. */
+      billingEstimation?: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation;
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
       /** Output only. Timestamp the DataStore was created at. */
@@ -1745,6 +1783,20 @@ declare namespace gapi.client {
       /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
       workspaceConfig?: GoogleCloudDiscoveryengineV1betaWorkspaceConfig;
     }
+    interface GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation {
+      /** Data size for structured data in terms of bytes. */
+      structuredDataSize?: string;
+      /** Last updated timestamp for structured data. */
+      structuredDataUpdateTime?: string;
+      /** Data size for unstructured data in terms of bytes. */
+      unstructuredDataSize?: string;
+      /** Last updated timestamp for unstructured data. */
+      unstructuredDataUpdateTime?: string;
+      /** Data size for websites in terms of bytes. */
+      websiteDataSize?: string;
+      /** Last updated timestamp for websites. */
+      websiteDataUpdateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1832,6 +1884,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */
       dataStoreIds?: string[];
+      /** Optional. Whether to disable analytics for searches performed on this engine. */
+      disableAnalytics?: boolean;
       /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
       displayName?: string;
       /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
@@ -2139,6 +2193,8 @@ declare namespace gapi.client {
       pageToken?: string;
       /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */
       params?: {[P in string]: any};
+      /** The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. */
+      personalizationSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec;
       /** Raw search query. */
       query?: string;
       /** The query expansion specification that specifies the conditions under which query expansion occurs. */
@@ -2267,6 +2323,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
+      /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
+      filter?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec {
       /** The embedding vector used for retrieval. Limit to 1. */
@@ -2314,6 +2372,10 @@ declare namespace gapi.client {
       /** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
       geoSearchQueryDetectionFieldNames?: string[];
     }
+    interface GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec {
+      /** The personalization mode of the search request. Defaults to Mode.AUTO. */
+      mode?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec {
       /** The condition under which query expansion should occur. Default to Condition.DISABLED. */
       condition?: string;
@@ -2418,6 +2480,10 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
       /** Obfuscated Dasher customer ID. */
       dasherCustomerId?: string;
+      /** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
+      superAdminEmailAddress?: string;
+      /** Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
+      superAdminServiceAccount?: string;
       /** The Google Workspace data source. */
       type?: string;
     }
@@ -2750,6 +2816,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
+      /** Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. */
+      errorMessage?: string;
       /** The metrics of the trained model. */
       metrics?: {[P in string]: number};
       /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
@@ -2762,6 +2830,8 @@ declare namespace gapi.client {
       trainingStartTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1DataStore {
+      /** Output only. Data size estimation for billing. */
+      billingEstimation?: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation;
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
       /** Output only. Timestamp the DataStore was created at. */
@@ -2785,6 +2855,20 @@ declare namespace gapi.client {
       /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
       workspaceConfig?: GoogleCloudDiscoveryengineV1WorkspaceConfig;
     }
+    interface GoogleCloudDiscoveryengineV1DataStoreBillingEstimation {
+      /** Data size for structured data in terms of bytes. */
+      structuredDataSize?: string;
+      /** Last updated timestamp for structured data. */
+      structuredDataUpdateTime?: string;
+      /** Data size for unstructured data in terms of bytes. */
+      unstructuredDataSize?: string;
+      /** Last updated timestamp for unstructured data. */
+      unstructuredDataUpdateTime?: string;
+      /** Data size for websites in terms of bytes. */
+      websiteDataSize?: string;
+      /** Last updated timestamp for websites. */
+      websiteDataUpdateTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2924,6 +3008,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */
       dataStoreIds?: string[];
+      /** Optional. Whether to disable analytics for searches performed on this engine. */
+      disableAnalytics?: boolean;
       /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
       displayName?: string;
       /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
@@ -3591,6 +3677,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec {
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
+      /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
+      filter?: string;
     }
     interface GoogleCloudDiscoveryengineV1SearchRequestFacetSpec {
       /** Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. */
@@ -3959,6 +4047,10 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
       /** Obfuscated Dasher customer ID. */
       dasherCustomerId?: string;
+      /** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
+      superAdminEmailAddress?: string;
+      /** Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
+      superAdminServiceAccount?: string;
       /** The Google Workspace data source. */
       type?: string;
     }
@@ -11608,7 +11700,7 @@ declare namespace gapi.client {
         uploadType?: string;
       }): Request<GoogleLongrunningListOperationsResponse>;
     }
-    interface Identity_mapping_storesResource {
+    interface IdentityMappingStoresResource {
       operations: OperationsResource;
     }
     interface OperationsResource {
@@ -11834,7 +11926,7 @@ declare namespace gapi.client {
       collections: CollectionsResource;
       dataStores: DataStoresResource;
       groundingConfigs: GroundingConfigsResource;
-      identity_mapping_stores: Identity_mapping_storesResource;
+      identityMappingStores: IdentityMappingStoresResource;
       operations: OperationsResource;
       rankingConfigs: RankingConfigsResource;
       userEvents: UserEventsResource;

package/package.json

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