@maxim_mazurok/gapi.client.discoveryengine-v1 0.1.20260310 → 0.1.20260317
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 +35 -100
- 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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260317
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -833,8 +833,6 @@ declare namespace gapi.client {
|
|
|
833
833
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
|
|
834
834
|
/** Chunk information. */
|
|
835
835
|
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
|
|
836
|
-
/** Output only. The search queries that produced this reference. */
|
|
837
|
-
queries?: string[];
|
|
838
836
|
/** Structured document information. */
|
|
839
837
|
structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
|
|
840
838
|
/** Unstructured document information. */
|
|
@@ -1370,6 +1368,8 @@ declare namespace gapi.client {
|
|
|
1370
1368
|
dataSource?: string;
|
|
1371
1369
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
1372
1370
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
1371
|
+
/** Output only. The dynamic tools fetched for this connector. */
|
|
1372
|
+
dynamicTools?: GoogleCloudDiscoveryengineV1alphaDynamicTool[];
|
|
1373
1373
|
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Note: This field is derived from both the DataConnector.params, and connector source spec. It should only be used for CAIS and Org Policy evaluation purposes. */
|
|
1374
1374
|
egressFqdns?: string[];
|
|
1375
1375
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
@@ -1753,6 +1753,16 @@ declare namespace gapi.client {
|
|
|
1753
1753
|
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1754
1754
|
useNativeText?: boolean;
|
|
1755
1755
|
}
|
|
1756
|
+
interface GoogleCloudDiscoveryengineV1alphaDynamicTool {
|
|
1757
|
+
/** Optional. The description of the tool. */
|
|
1758
|
+
description?: string;
|
|
1759
|
+
/** Optional. The display name of the tool. */
|
|
1760
|
+
displayName?: string;
|
|
1761
|
+
/** Optional. Whether the tool is enabled. */
|
|
1762
|
+
enabled?: boolean;
|
|
1763
|
+
/** Required. The name of the tool. */
|
|
1764
|
+
name?: string;
|
|
1765
|
+
}
|
|
1756
1766
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata {
|
|
1757
1767
|
/** Operation create time. */
|
|
1758
1768
|
createTime?: string;
|
|
@@ -3341,8 +3351,6 @@ declare namespace gapi.client {
|
|
|
3341
3351
|
interface GoogleCloudDiscoveryengineV1AnswerReference {
|
|
3342
3352
|
/** Chunk information. */
|
|
3343
3353
|
chunkInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo;
|
|
3344
|
-
/** Output only. The search queries that produced this reference. */
|
|
3345
|
-
queries?: string[];
|
|
3346
3354
|
/** Structured document information. */
|
|
3347
3355
|
structuredDocumentInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo;
|
|
3348
3356
|
/** Unstructured document information. */
|
|
@@ -5574,6 +5582,8 @@ declare namespace gapi.client {
|
|
|
5574
5582
|
dataSource?: string;
|
|
5575
5583
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
5576
5584
|
destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
5585
|
+
/** Output only. The dynamic tools fetched for this connector. */
|
|
5586
|
+
dynamicTools?: GoogleCloudDiscoveryengineV1DynamicTool[];
|
|
5577
5587
|
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Note: This field is derived from both the DataConnector.params, and connector source spec. It should only be used for CAIS and Org Policy evaluation purposes. */
|
|
5578
5588
|
egressFqdns?: string[];
|
|
5579
5589
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
@@ -5986,6 +5996,16 @@ declare namespace gapi.client {
|
|
|
5986
5996
|
/** Double values. */
|
|
5987
5997
|
values?: number[];
|
|
5988
5998
|
}
|
|
5999
|
+
interface GoogleCloudDiscoveryengineV1DynamicTool {
|
|
6000
|
+
/** Optional. The description of the tool. */
|
|
6001
|
+
description?: string;
|
|
6002
|
+
/** Optional. The display name of the tool. */
|
|
6003
|
+
displayName?: string;
|
|
6004
|
+
/** Optional. Whether the tool is enabled. */
|
|
6005
|
+
enabled?: boolean;
|
|
6006
|
+
/** Required. The name of the tool. */
|
|
6007
|
+
name?: string;
|
|
6008
|
+
}
|
|
5989
6009
|
interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
5990
6010
|
/** Operation create time. */
|
|
5991
6011
|
createTime?: string;
|
|
@@ -6896,6 +6916,8 @@ declare namespace gapi.client {
|
|
|
6896
6916
|
languageCode?: string;
|
|
6897
6917
|
/** Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */
|
|
6898
6918
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
6919
|
+
/** Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.DataStoreSpec.num_results if provided, otherwise there is no limit. */
|
|
6920
|
+
numResultsPerDataStore?: number;
|
|
6899
6921
|
/** 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. A large offset may be capped to a reasonable threshold. */
|
|
6900
6922
|
offset?: number;
|
|
6901
6923
|
/** The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. */
|
|
@@ -7052,6 +7074,8 @@ declare namespace gapi.client {
|
|
|
7052
7074
|
dataStore?: string;
|
|
7053
7075
|
/** 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) */
|
|
7054
7076
|
filter?: string;
|
|
7077
|
+
/** Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used. */
|
|
7078
|
+
numResults?: number;
|
|
7055
7079
|
}
|
|
7056
7080
|
interface GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec {
|
|
7057
7081
|
/** The condition under which match highlighting should occur. */
|
|
@@ -7429,7 +7453,7 @@ declare namespace gapi.client {
|
|
|
7429
7453
|
interface GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest {
|
|
7430
7454
|
/** Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. */
|
|
7431
7455
|
collectionDisplayName?: string;
|
|
7432
|
-
/** Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection.
|
|
7456
|
+
/** Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
7433
7457
|
collectionId?: string;
|
|
7434
7458
|
/** Required. The DataConnector to initialize in the newly created Collection. */
|
|
7435
7459
|
dataConnector?: GoogleCloudDiscoveryengineV1DataConnector;
|
|
@@ -14839,7 +14863,7 @@ declare namespace gapi.client {
|
|
|
14839
14863
|
fields?: string;
|
|
14840
14864
|
/** 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. */
|
|
14841
14865
|
key?: string;
|
|
14842
|
-
/** Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. */
|
|
14866
|
+
/** Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested DataConnector does not exist, a `NOT_FOUND` error is returned. */
|
|
14843
14867
|
name: string;
|
|
14844
14868
|
/** OAuth 2.0 token for the current user. */
|
|
14845
14869
|
oauth_token?: string;
|
|
@@ -14874,7 +14898,7 @@ declare namespace gapi.client {
|
|
|
14874
14898
|
prettyPrint?: boolean;
|
|
14875
14899
|
/** 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. */
|
|
14876
14900
|
quotaUser?: string;
|
|
14877
|
-
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */
|
|
14901
|
+
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an `INVALID_ARGUMENT` error. */
|
|
14878
14902
|
updateMask?: string;
|
|
14879
14903
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14880
14904
|
upload_protocol?: string;
|
|
@@ -14905,7 +14929,7 @@ declare namespace gapi.client {
|
|
|
14905
14929
|
prettyPrint?: boolean;
|
|
14906
14930
|
/** 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. */
|
|
14907
14931
|
quotaUser?: string;
|
|
14908
|
-
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */
|
|
14932
|
+
/** Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an `INVALID_ARGUMENT` error. */
|
|
14909
14933
|
updateMask?: string;
|
|
14910
14934
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14911
14935
|
upload_protocol?: string;
|
|
@@ -19455,95 +19479,6 @@ declare namespace gapi.client {
|
|
|
19455
19479
|
},
|
|
19456
19480
|
body: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest,
|
|
19457
19481
|
): Request<GoogleLongrunningOperation>;
|
|
19458
|
-
/** Creates a new User Store. */
|
|
19459
|
-
create(request: {
|
|
19460
|
-
/** V1 error format. */
|
|
19461
|
-
'$.xgafv'?: string;
|
|
19462
|
-
/** OAuth access token. */
|
|
19463
|
-
access_token?: string;
|
|
19464
|
-
/** Data format for response. */
|
|
19465
|
-
alt?: string;
|
|
19466
|
-
/** JSONP */
|
|
19467
|
-
callback?: string;
|
|
19468
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
19469
|
-
fields?: string;
|
|
19470
|
-
/** 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. */
|
|
19471
|
-
key?: string;
|
|
19472
|
-
/** OAuth 2.0 token for the current user. */
|
|
19473
|
-
oauth_token?: string;
|
|
19474
|
-
/** Required. The parent collection resource name, such as `projects/{project}/locations/{location}`. */
|
|
19475
|
-
parent: string;
|
|
19476
|
-
/** Returns response with indentations and line breaks. */
|
|
19477
|
-
prettyPrint?: boolean;
|
|
19478
|
-
/** 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. */
|
|
19479
|
-
quotaUser?: string;
|
|
19480
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19481
|
-
upload_protocol?: string;
|
|
19482
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19483
|
-
uploadType?: string;
|
|
19484
|
-
/** Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. */
|
|
19485
|
-
userStoreId?: string;
|
|
19486
|
-
/** Request body */
|
|
19487
|
-
resource: GoogleCloudDiscoveryengineV1UserStore;
|
|
19488
|
-
}): Request<GoogleCloudDiscoveryengineV1UserStore>;
|
|
19489
|
-
create(
|
|
19490
|
-
request: {
|
|
19491
|
-
/** V1 error format. */
|
|
19492
|
-
'$.xgafv'?: string;
|
|
19493
|
-
/** OAuth access token. */
|
|
19494
|
-
access_token?: string;
|
|
19495
|
-
/** Data format for response. */
|
|
19496
|
-
alt?: string;
|
|
19497
|
-
/** JSONP */
|
|
19498
|
-
callback?: string;
|
|
19499
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
19500
|
-
fields?: string;
|
|
19501
|
-
/** 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. */
|
|
19502
|
-
key?: string;
|
|
19503
|
-
/** OAuth 2.0 token for the current user. */
|
|
19504
|
-
oauth_token?: string;
|
|
19505
|
-
/** Required. The parent collection resource name, such as `projects/{project}/locations/{location}`. */
|
|
19506
|
-
parent: string;
|
|
19507
|
-
/** Returns response with indentations and line breaks. */
|
|
19508
|
-
prettyPrint?: boolean;
|
|
19509
|
-
/** 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. */
|
|
19510
|
-
quotaUser?: string;
|
|
19511
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19512
|
-
upload_protocol?: string;
|
|
19513
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19514
|
-
uploadType?: string;
|
|
19515
|
-
/** Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. */
|
|
19516
|
-
userStoreId?: string;
|
|
19517
|
-
},
|
|
19518
|
-
body: GoogleCloudDiscoveryengineV1UserStore,
|
|
19519
|
-
): Request<GoogleCloudDiscoveryengineV1UserStore>;
|
|
19520
|
-
/** Deletes the User Store. */
|
|
19521
|
-
delete(request?: {
|
|
19522
|
-
/** V1 error format. */
|
|
19523
|
-
'$.xgafv'?: string;
|
|
19524
|
-
/** OAuth access token. */
|
|
19525
|
-
access_token?: string;
|
|
19526
|
-
/** Data format for response. */
|
|
19527
|
-
alt?: string;
|
|
19528
|
-
/** JSONP */
|
|
19529
|
-
callback?: string;
|
|
19530
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
19531
|
-
fields?: string;
|
|
19532
|
-
/** 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. */
|
|
19533
|
-
key?: string;
|
|
19534
|
-
/** Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` */
|
|
19535
|
-
name: string;
|
|
19536
|
-
/** OAuth 2.0 token for the current user. */
|
|
19537
|
-
oauth_token?: string;
|
|
19538
|
-
/** Returns response with indentations and line breaks. */
|
|
19539
|
-
prettyPrint?: boolean;
|
|
19540
|
-
/** 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. */
|
|
19541
|
-
quotaUser?: string;
|
|
19542
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19543
|
-
upload_protocol?: string;
|
|
19544
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
19545
|
-
uploadType?: string;
|
|
19546
|
-
}): Request<GoogleLongrunningOperation>;
|
|
19547
19482
|
/** Gets the User Store. */
|
|
19548
19483
|
get(request?: {
|
|
19549
19484
|
/** V1 error format. */
|
|
@@ -19761,7 +19696,7 @@ declare namespace gapi.client {
|
|
|
19761
19696
|
callback?: string;
|
|
19762
19697
|
/** Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. */
|
|
19763
19698
|
collectionDisplayName?: string;
|
|
19764
|
-
/** Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection.
|
|
19699
|
+
/** Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
19765
19700
|
collectionId?: string;
|
|
19766
19701
|
/** Selector specifying which fields to include in a partial response. */
|
|
19767
19702
|
fields?: string;
|
|
@@ -19794,7 +19729,7 @@ declare namespace gapi.client {
|
|
|
19794
19729
|
callback?: string;
|
|
19795
19730
|
/** Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. */
|
|
19796
19731
|
collectionDisplayName?: string;
|
|
19797
|
-
/** Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection.
|
|
19732
|
+
/** Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
19798
19733
|
collectionId?: string;
|
|
19799
19734
|
/** Selector specifying which fields to include in a partial response. */
|
|
19800
19735
|
fields?: string;
|