@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.1.20260209 → 0.1.20260226
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 +34 -8
- 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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260226
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1882,6 +1882,8 @@ declare namespace gapi.client {
|
|
|
1882
1882
|
dataSource?: string;
|
|
1883
1883
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
1884
1884
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
1885
|
+
/** 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. */
|
|
1886
|
+
egressFqdns?: string[];
|
|
1885
1887
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
1886
1888
|
endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
|
|
1887
1889
|
/** List of entities from the connected data source to ingest. */
|
|
@@ -1934,6 +1936,8 @@ declare namespace gapi.client {
|
|
|
1934
1936
|
syncMode?: string;
|
|
1935
1937
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
1936
1938
|
updateTime?: string;
|
|
1939
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
|
|
1940
|
+
vpcscEnabled?: boolean;
|
|
1937
1941
|
}
|
|
1938
1942
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
|
|
1939
1943
|
/** Optional. Any additional parameters needed for EUA. */
|
|
@@ -2329,6 +2333,8 @@ declare namespace gapi.client {
|
|
|
2329
2333
|
commonConfig?: GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
|
|
2330
2334
|
/** Optional. Configuration for configurable billing approach. */
|
|
2331
2335
|
configurableBillingApproach?: string;
|
|
2336
|
+
/** Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent. */
|
|
2337
|
+
connectorTenantInfo?: {[P in string]: string};
|
|
2332
2338
|
/** Output only. Timestamp the Recommendation Engine was created at. */
|
|
2333
2339
|
createTime?: string;
|
|
2334
2340
|
/** Optional. 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. */
|
|
@@ -2343,6 +2349,8 @@ declare namespace gapi.client {
|
|
|
2343
2349
|
industryVertical?: string;
|
|
2344
2350
|
/** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
2345
2351
|
knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
|
|
2352
|
+
/** Optional. The visibility of marketplace agents in the agent gallery. */
|
|
2353
|
+
marketplaceAgentVisibility?: string;
|
|
2346
2354
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
2347
2355
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
2348
2356
|
/** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
@@ -2351,6 +2359,8 @@ declare namespace gapi.client {
|
|
|
2351
2359
|
name?: string;
|
|
2352
2360
|
/** Optional. Observability config for the engine. */
|
|
2353
2361
|
observabilityConfig?: GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
|
|
2362
|
+
/** Optional. The email of the procurement contact. */
|
|
2363
|
+
procurementContactEmail?: string;
|
|
2354
2364
|
/** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
|
|
2355
2365
|
recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
2356
2366
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
@@ -3196,7 +3206,7 @@ declare namespace gapi.client {
|
|
|
3196
3206
|
servingConfigs?: GoogleCloudDiscoveryengineV1alphaServingConfig[];
|
|
3197
3207
|
}
|
|
3198
3208
|
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
3199
|
-
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
|
|
3209
|
+
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
|
|
3200
3210
|
filter?: string;
|
|
3201
3211
|
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
3202
3212
|
orderBy?: string;
|
|
@@ -3957,7 +3967,7 @@ declare namespace gapi.client {
|
|
|
3957
3967
|
languageCode?: string;
|
|
3958
3968
|
/** 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. */
|
|
3959
3969
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
3960
|
-
/** Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.
|
|
3970
|
+
/** 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. */
|
|
3961
3971
|
numResultsPerDataStore?: number;
|
|
3962
3972
|
/** 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. */
|
|
3963
3973
|
offset?: number;
|
|
@@ -5759,6 +5769,8 @@ declare namespace gapi.client {
|
|
|
5759
5769
|
commonConfig?: GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
5760
5770
|
/** Optional. Configuration for configurable billing approach. */
|
|
5761
5771
|
configurableBillingApproach?: string;
|
|
5772
|
+
/** Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent. */
|
|
5773
|
+
connectorTenantInfo?: {[P in string]: string};
|
|
5762
5774
|
/** Output only. Timestamp the Recommendation Engine was created at. */
|
|
5763
5775
|
createTime?: string;
|
|
5764
5776
|
/** Optional. 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. */
|
|
@@ -5773,6 +5785,8 @@ declare namespace gapi.client {
|
|
|
5773
5785
|
industryVertical?: string;
|
|
5774
5786
|
/** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
5775
5787
|
knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
|
|
5788
|
+
/** Optional. The visibility of marketplace agents in the agent gallery. */
|
|
5789
|
+
marketplaceAgentVisibility?: string;
|
|
5776
5790
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
5777
5791
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
|
|
5778
5792
|
/** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
@@ -5781,6 +5795,8 @@ declare namespace gapi.client {
|
|
|
5781
5795
|
name?: string;
|
|
5782
5796
|
/** Optional. Observability config for the engine. */
|
|
5783
5797
|
observabilityConfig?: GoogleCloudDiscoveryengineV1betaObservabilityConfig;
|
|
5798
|
+
/** Optional. The email of the procurement contact. */
|
|
5799
|
+
procurementContactEmail?: string;
|
|
5784
5800
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
5785
5801
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
5786
5802
|
/** Required. The solutions of the engine. */
|
|
@@ -6280,7 +6296,7 @@ declare namespace gapi.client {
|
|
|
6280
6296
|
languageCode?: string;
|
|
6281
6297
|
/** 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. */
|
|
6282
6298
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
6283
|
-
/** Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.
|
|
6299
|
+
/** 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. */
|
|
6284
6300
|
numResultsPerDataStore?: number;
|
|
6285
6301
|
/** 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. */
|
|
6286
6302
|
offset?: number;
|
|
@@ -6875,6 +6891,8 @@ declare namespace gapi.client {
|
|
|
6875
6891
|
dataSource?: string;
|
|
6876
6892
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
6877
6893
|
destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
6894
|
+
/** 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. */
|
|
6895
|
+
egressFqdns?: string[];
|
|
6878
6896
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
6879
6897
|
endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
6880
6898
|
/** List of entities from the connected data source to ingest. */
|
|
@@ -6927,6 +6945,8 @@ declare namespace gapi.client {
|
|
|
6927
6945
|
syncMode?: string;
|
|
6928
6946
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
6929
6947
|
updateTime?: string;
|
|
6948
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
|
|
6949
|
+
vpcscEnabled?: boolean;
|
|
6930
6950
|
}
|
|
6931
6951
|
interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
6932
6952
|
/** Optional. Any additional parameters needed for EUA. */
|
|
@@ -7186,6 +7206,8 @@ declare namespace gapi.client {
|
|
|
7186
7206
|
commonConfig?: GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
7187
7207
|
/** Optional. Configuration for configurable billing approach. */
|
|
7188
7208
|
configurableBillingApproach?: string;
|
|
7209
|
+
/** Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent. */
|
|
7210
|
+
connectorTenantInfo?: {[P in string]: string};
|
|
7189
7211
|
/** Output only. Timestamp the Recommendation Engine was created at. */
|
|
7190
7212
|
createTime?: string;
|
|
7191
7213
|
/** Optional. 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. */
|
|
@@ -7200,6 +7222,8 @@ declare namespace gapi.client {
|
|
|
7200
7222
|
industryVertical?: string;
|
|
7201
7223
|
/** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
7202
7224
|
knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
|
|
7225
|
+
/** Optional. The visibility of marketplace agents in the agent gallery. */
|
|
7226
|
+
marketplaceAgentVisibility?: string;
|
|
7203
7227
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
7204
7228
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
|
|
7205
7229
|
/** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
@@ -7208,6 +7232,8 @@ declare namespace gapi.client {
|
|
|
7208
7232
|
name?: string;
|
|
7209
7233
|
/** Optional. Observability config for the engine. */
|
|
7210
7234
|
observabilityConfig?: GoogleCloudDiscoveryengineV1ObservabilityConfig;
|
|
7235
|
+
/** Optional. The email of the procurement contact. */
|
|
7236
|
+
procurementContactEmail?: string;
|
|
7211
7237
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
7212
7238
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
7213
7239
|
/** Required. The solutions of the engine. */
|
|
@@ -11434,7 +11460,7 @@ declare namespace gapi.client {
|
|
|
11434
11460
|
callback?: string;
|
|
11435
11461
|
/** Selector specifying which fields to include in a partial response. */
|
|
11436
11462
|
fields?: string;
|
|
11437
|
-
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
|
|
11463
|
+
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
|
|
11438
11464
|
filter?: string;
|
|
11439
11465
|
/** 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. */
|
|
11440
11466
|
key?: string;
|
|
@@ -15843,7 +15869,7 @@ declare namespace gapi.client {
|
|
|
15843
15869
|
callback?: string;
|
|
15844
15870
|
/** Selector specifying which fields to include in a partial response. */
|
|
15845
15871
|
fields?: string;
|
|
15846
|
-
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
|
|
15872
|
+
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
|
|
15847
15873
|
filter?: string;
|
|
15848
15874
|
/** 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. */
|
|
15849
15875
|
key?: string;
|
|
@@ -19117,7 +19143,7 @@ declare namespace gapi.client {
|
|
|
19117
19143
|
callback?: string;
|
|
19118
19144
|
/** Selector specifying which fields to include in a partial response. */
|
|
19119
19145
|
fields?: string;
|
|
19120
|
-
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
|
|
19146
|
+
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
|
|
19121
19147
|
filter?: string;
|
|
19122
19148
|
/** 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. */
|
|
19123
19149
|
key?: string;
|
|
@@ -21420,7 +21446,7 @@ declare namespace gapi.client {
|
|
|
21420
21446
|
operations: OperationsResource;
|
|
21421
21447
|
}
|
|
21422
21448
|
interface LicenseConfigsResource {
|
|
21423
|
-
/** Creates a LicenseConfig */
|
|
21449
|
+
/** Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. */
|
|
21424
21450
|
create(request: {
|
|
21425
21451
|
/** V1 error format. */
|
|
21426
21452
|
'$.xgafv'?: string;
|