@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20250107 → 0.0.20250116
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +14 -4
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250116
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -171,7 +171,7 @@ declare namespace gapi.client {
|
|
|
171
171
|
name?: string;
|
|
172
172
|
}
|
|
173
173
|
interface GoogleCloudDiscoveryengineV1alphaActionConfig {
|
|
174
|
-
/** 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
|
|
174
|
+
/** 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. */
|
|
175
175
|
actionParams?: {[P in string]: any};
|
|
176
176
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
177
177
|
isActionConfigured?: boolean;
|
|
@@ -576,7 +576,7 @@ declare namespace gapi.client {
|
|
|
576
576
|
name?: string;
|
|
577
577
|
/** 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. */
|
|
578
578
|
nextSyncTime?: GoogleTypeDateTime;
|
|
579
|
-
/** 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
|
|
579
|
+
/** 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`. */
|
|
580
580
|
params?: {[P in string]: any};
|
|
581
581
|
/** Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. */
|
|
582
582
|
privateConnectivityProjectId?: string;
|
|
@@ -600,7 +600,7 @@ declare namespace gapi.client {
|
|
|
600
600
|
entityName?: string;
|
|
601
601
|
/** 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. */
|
|
602
602
|
keyPropertyMappings?: {[P in string]: string};
|
|
603
|
-
/** The parameters for the entity to facilitate data ingestion. E.g. for
|
|
603
|
+
/** 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. */
|
|
604
604
|
params?: {[P in string]: any};
|
|
605
605
|
}
|
|
606
606
|
interface GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
@@ -3141,6 +3141,8 @@ declare namespace gapi.client {
|
|
|
3141
3141
|
fhirStoreSource?: GoogleCloudDiscoveryengineV1betaFhirStoreSource;
|
|
3142
3142
|
/** Firestore input source. */
|
|
3143
3143
|
firestoreSource?: GoogleCloudDiscoveryengineV1betaFirestoreSource;
|
|
3144
|
+
/** 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. */
|
|
3145
|
+
forceRefreshContent?: boolean;
|
|
3144
3146
|
/** Cloud Storage location for the input content. */
|
|
3145
3147
|
gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
3146
3148
|
/** 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. */
|
|
@@ -3945,6 +3947,8 @@ declare namespace gapi.client {
|
|
|
3945
3947
|
searchLinkPromotions?: GoogleCloudDiscoveryengineV1betaSearchLinkPromotion[];
|
|
3946
3948
|
/** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
|
|
3947
3949
|
sessionInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo;
|
|
3950
|
+
/** 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). */
|
|
3951
|
+
suggestedQuery?: string;
|
|
3948
3952
|
/** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
|
|
3949
3953
|
summary?: GoogleCloudDiscoveryengineV1betaSearchResponseSummary;
|
|
3950
3954
|
/** 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. */
|
|
@@ -3989,9 +3993,15 @@ declare namespace gapi.client {
|
|
|
3989
3993
|
extractedFilters?: string;
|
|
3990
3994
|
/** Rewritten input query minus the extracted filters. */
|
|
3991
3995
|
rewrittenQuery?: string;
|
|
3996
|
+
/** Optional. The SQL request that was generated from the natural language query understanding phase. */
|
|
3997
|
+
sqlRequest?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest;
|
|
3992
3998
|
/** The filters that were extracted from the input query represented in a structured form. */
|
|
3993
3999
|
structuredExtractedFilter?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter;
|
|
3994
4000
|
}
|
|
4001
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest {
|
|
4002
|
+
/** Optional. The SQL query in text format. */
|
|
4003
|
+
sqlQuery?: string;
|
|
4004
|
+
}
|
|
3995
4005
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter {
|
|
3996
4006
|
/** 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. */
|
|
3997
4007
|
expression?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression;
|