@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20250107 → 0.0.20250116

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20250107
+// Revision: 20250116
 
 /// <reference types="gapi.client" />
 
@@ -171,7 +171,7 @@ declare namespace gapi.client {
       name?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaActionConfig {
-      /** Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. */
+      /** Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. */
       actionParams?: {[P in string]: any};
       /** Output only. The connector contains the necessary parameters and is configured to support actions. */
       isActionConfigured?: boolean;
@@ -1163,7 +1163,7 @@ declare namespace gapi.client {
       name?: string;
       /** The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. */
       nextSyncTime?: GoogleTypeDateTime;
-      /** Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. */
+      /** Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. */
       params?: {[P in string]: any};
       /** Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. */
       privateConnectivityProjectId?: string;
@@ -1187,7 +1187,7 @@ declare namespace gapi.client {
       entityName?: string;
       /** Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. */
       keyPropertyMappings?: {[P in string]: string};
-      /** The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. */
+      /** The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. */
       params?: {[P in string]: any};
     }
     interface GoogleCloudDiscoveryengineV1alphaDataStore {
@@ -1912,6 +1912,8 @@ declare namespace gapi.client {
       fhirStoreSource?: GoogleCloudDiscoveryengineV1alphaFhirStoreSource;
       /** Firestore input source. */
       firestoreSource?: GoogleCloudDiscoveryengineV1alphaFirestoreSource;
+      /** Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. */
+      forceRefreshContent?: boolean;
       /** Cloud Storage location for the input content. */
       gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
       /** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
@@ -2184,7 +2186,7 @@ declare namespace gapi.client {
       mode?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest {
-      /** Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. */
+      /** Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. */
       crawlRateScope?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse {
@@ -2494,7 +2496,7 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest {
-      /** Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. */
+      /** Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. */
       crawlRateScope?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse {
@@ -2928,6 +2930,8 @@ declare namespace gapi.client {
       searchLinkPromotions?: GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion[];
       /** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
       sessionInfo?: GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo;
+      /** Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). */
+      suggestedQuery?: string;
       /** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
       summary?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummary;
       /** The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */
@@ -2972,9 +2976,15 @@ declare namespace gapi.client {
       extractedFilters?: string;
       /** Rewritten input query minus the extracted filters. */
       rewrittenQuery?: string;
+      /** Optional. The SQL request that was generated from the natural language query understanding phase. */
+      sqlRequest?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest;
       /** The filters that were extracted from the input query represented in a structured form. */
       structuredExtractedFilter?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter;
     }
+    interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest {
+      /** Optional. The SQL query in text format. */
+      sqlQuery?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter {
       /** The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. */
       expression?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression;
@@ -3214,9 +3224,9 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest {
       /** Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website. */
       crawlRate?: number;
-      /** Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. */
+      /** Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. */
       crawlRateScope?: string;
-      /** Optional. Whether it’s the crawl rate of user-triggered or auto-refresh. */
+      /** Optional. Whether it's the crawl rate of user-triggered or auto-refresh. */
       crawlType?: string;
       /** Optional. Whether the rate is explicitly set by users, or set by vertex AI. */
       mode?: string;
@@ -3288,6 +3298,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest {
       /** Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced. */
       entities?: string[];
+      /** Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. */
+      forceRefreshContent?: boolean;
       /** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
       healthcareFhirResourceTypes?: string[];
       /** If true, trigger Identity sync. */

package/package.json

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