@maxim_mazurok/gapi.client.discoveryengine-v1beta 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=v1beta
-// Revision: 20240912
+// Revision: 20240930
 
 /// <reference types="gapi.client" />
 
@@ -348,6 +348,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`). */
@@ -362,6 +364,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. */
@@ -391,6 +395,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;
@@ -478,6 +496,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. */
@@ -607,6 +627,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. */
@@ -936,6 +958,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. */
@@ -1064,6 +1088,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. */
@@ -1111,6 +1137,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;
@@ -1242,6 +1272,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;
     }
@@ -1392,6 +1426,8 @@ declare namespace gapi.client {
       filter?: string;
       /** Number of search results to return. The default value is 10. */
       maxReturnResults?: number;
+      /** Optional. Specification to enable natural language understanding capabilities for search requests. */
+      naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
       /** 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. */
       orderBy?: string;
       /** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */
@@ -1946,6 +1982,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`). */
@@ -1958,6 +1996,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. */
@@ -1985,6 +2025,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;
@@ -2132,6 +2186,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. */
@@ -2851,6 +2907,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. */
@@ -2979,6 +3037,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. */
@@ -3026,6 +3086,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;
@@ -3284,6 +3348,8 @@ 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 specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. */
+      personalizationSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec;
       /** 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. */
@@ -3522,6 +3588,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;
     }
@@ -3612,6 +3682,8 @@ declare namespace gapi.client {
       updateTime?: 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. */
@@ -3635,6 +3707,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;
@@ -3722,6 +3808,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. */
@@ -3985,6 +4073,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;
     }
@@ -12347,6 +12439,71 @@ declare namespace gapi.client {
         uploadType?: string;
       }): Request<GoogleLongrunningListOperationsResponse>;
     }
+    interface IdentityMappingStoresResource {
+      operations: OperationsResource;
+    }
+    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. */
+      get(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;
+        /** The name of the operation resource. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GoogleLongrunningOperation>;
+      /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
+      list(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;
+        /** The standard list filter. */
+        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;
+        /** The name of the operation's parent resource. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** The standard list page size. */
+        pageSize?: number;
+        /** The standard list page token. */
+        pageToken?: 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<GoogleLongrunningListOperationsResponse>;
+    }
     interface RankingConfigsResource {
       /** Ranks a list of text records based on the given input query. */
       rank(request: {
@@ -13020,6 +13177,7 @@ declare namespace gapi.client {
       dataStores: DataStoresResource;
       evaluations: EvaluationsResource;
       groundingConfigs: GroundingConfigsResource;
+      identityMappingStores: IdentityMappingStoresResource;
       operations: OperationsResource;
       rankingConfigs: RankingConfigsResource;
       sampleQuerySets: SampleQuerySetsResource;

package/package.json

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