@maxim_mazurok/gapi.client.discoveryengine-v1beta 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260226
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -890,6 +890,8 @@ declare namespace gapi.client {
|
|
|
890
890
|
dataSource?: string;
|
|
891
891
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
892
892
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
893
|
+
/** 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. */
|
|
894
|
+
egressFqdns?: string[];
|
|
893
895
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
894
896
|
endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
|
|
895
897
|
/** List of entities from the connected data source to ingest. */
|
|
@@ -942,6 +944,8 @@ declare namespace gapi.client {
|
|
|
942
944
|
syncMode?: string;
|
|
943
945
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
944
946
|
updateTime?: string;
|
|
947
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
|
|
948
|
+
vpcscEnabled?: boolean;
|
|
945
949
|
}
|
|
946
950
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
|
|
947
951
|
/** Optional. Any additional parameters needed for EUA. */
|
|
@@ -1243,6 +1247,8 @@ declare namespace gapi.client {
|
|
|
1243
1247
|
commonConfig?: GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
|
|
1244
1248
|
/** Optional. Configuration for configurable billing approach. */
|
|
1245
1249
|
configurableBillingApproach?: string;
|
|
1250
|
+
/** 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. */
|
|
1251
|
+
connectorTenantInfo?: {[P in string]: string};
|
|
1246
1252
|
/** Output only. Timestamp the Recommendation Engine was created at. */
|
|
1247
1253
|
createTime?: string;
|
|
1248
1254
|
/** 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. */
|
|
@@ -1257,6 +1263,8 @@ declare namespace gapi.client {
|
|
|
1257
1263
|
industryVertical?: string;
|
|
1258
1264
|
/** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
1259
1265
|
knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
|
|
1266
|
+
/** Optional. The visibility of marketplace agents in the agent gallery. */
|
|
1267
|
+
marketplaceAgentVisibility?: string;
|
|
1260
1268
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
1261
1269
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
1262
1270
|
/** 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. */
|
|
@@ -1265,6 +1273,8 @@ declare namespace gapi.client {
|
|
|
1265
1273
|
name?: string;
|
|
1266
1274
|
/** Optional. Observability config for the engine. */
|
|
1267
1275
|
observabilityConfig?: GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
|
|
1276
|
+
/** Optional. The email of the procurement contact. */
|
|
1277
|
+
procurementContactEmail?: string;
|
|
1268
1278
|
/** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
|
|
1269
1279
|
recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
1270
1280
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
@@ -1633,7 +1643,7 @@ declare namespace gapi.client {
|
|
|
1633
1643
|
subscriptionTier?: string;
|
|
1634
1644
|
}
|
|
1635
1645
|
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
1636
|
-
/** 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"` */
|
|
1646
|
+
/** 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"` */
|
|
1637
1647
|
filter?: string;
|
|
1638
1648
|
/** 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. */
|
|
1639
1649
|
orderBy?: string;
|
|
@@ -2036,7 +2046,7 @@ declare namespace gapi.client {
|
|
|
2036
2046
|
languageCode?: string;
|
|
2037
2047
|
/** 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. */
|
|
2038
2048
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
2039
|
-
/** Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.
|
|
2049
|
+
/** 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. */
|
|
2040
2050
|
numResultsPerDataStore?: number;
|
|
2041
2051
|
/** 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. */
|
|
2042
2052
|
offset?: number;
|
|
@@ -4158,6 +4168,8 @@ declare namespace gapi.client {
|
|
|
4158
4168
|
commonConfig?: GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
4159
4169
|
/** Optional. Configuration for configurable billing approach. */
|
|
4160
4170
|
configurableBillingApproach?: string;
|
|
4171
|
+
/** 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. */
|
|
4172
|
+
connectorTenantInfo?: {[P in string]: string};
|
|
4161
4173
|
/** Output only. Timestamp the Recommendation Engine was created at. */
|
|
4162
4174
|
createTime?: string;
|
|
4163
4175
|
/** 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. */
|
|
@@ -4172,6 +4184,8 @@ declare namespace gapi.client {
|
|
|
4172
4184
|
industryVertical?: string;
|
|
4173
4185
|
/** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
4174
4186
|
knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
|
|
4187
|
+
/** Optional. The visibility of marketplace agents in the agent gallery. */
|
|
4188
|
+
marketplaceAgentVisibility?: string;
|
|
4175
4189
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
4176
4190
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
|
|
4177
4191
|
/** 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. */
|
|
@@ -4180,6 +4194,8 @@ declare namespace gapi.client {
|
|
|
4180
4194
|
name?: string;
|
|
4181
4195
|
/** Optional. Observability config for the engine. */
|
|
4182
4196
|
observabilityConfig?: GoogleCloudDiscoveryengineV1betaObservabilityConfig;
|
|
4197
|
+
/** Optional. The email of the procurement contact. */
|
|
4198
|
+
procurementContactEmail?: string;
|
|
4183
4199
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
4184
4200
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
4185
4201
|
/** Required. The solutions of the engine. */
|
|
@@ -5242,7 +5258,7 @@ declare namespace gapi.client {
|
|
|
5242
5258
|
languageCode?: string;
|
|
5243
5259
|
/** 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. */
|
|
5244
5260
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
5245
|
-
/** Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.
|
|
5261
|
+
/** 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. */
|
|
5246
5262
|
numResultsPerDataStore?: number;
|
|
5247
5263
|
/** 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. */
|
|
5248
5264
|
offset?: number;
|
|
@@ -6364,6 +6380,8 @@ declare namespace gapi.client {
|
|
|
6364
6380
|
dataSource?: string;
|
|
6365
6381
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
6366
6382
|
destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
6383
|
+
/** 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. */
|
|
6384
|
+
egressFqdns?: string[];
|
|
6367
6385
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
6368
6386
|
endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
6369
6387
|
/** List of entities from the connected data source to ingest. */
|
|
@@ -6416,6 +6434,8 @@ declare namespace gapi.client {
|
|
|
6416
6434
|
syncMode?: string;
|
|
6417
6435
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
6418
6436
|
updateTime?: string;
|
|
6437
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
|
|
6438
|
+
vpcscEnabled?: boolean;
|
|
6419
6439
|
}
|
|
6420
6440
|
interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
6421
6441
|
/** Optional. Any additional parameters needed for EUA. */
|
|
@@ -6675,6 +6695,8 @@ declare namespace gapi.client {
|
|
|
6675
6695
|
commonConfig?: GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
6676
6696
|
/** Optional. Configuration for configurable billing approach. */
|
|
6677
6697
|
configurableBillingApproach?: string;
|
|
6698
|
+
/** 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. */
|
|
6699
|
+
connectorTenantInfo?: {[P in string]: string};
|
|
6678
6700
|
/** Output only. Timestamp the Recommendation Engine was created at. */
|
|
6679
6701
|
createTime?: string;
|
|
6680
6702
|
/** 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. */
|
|
@@ -6689,6 +6711,8 @@ declare namespace gapi.client {
|
|
|
6689
6711
|
industryVertical?: string;
|
|
6690
6712
|
/** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
6691
6713
|
knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
|
|
6714
|
+
/** Optional. The visibility of marketplace agents in the agent gallery. */
|
|
6715
|
+
marketplaceAgentVisibility?: string;
|
|
6692
6716
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
6693
6717
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
|
|
6694
6718
|
/** 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. */
|
|
@@ -6697,6 +6721,8 @@ declare namespace gapi.client {
|
|
|
6697
6721
|
name?: string;
|
|
6698
6722
|
/** Optional. Observability config for the engine. */
|
|
6699
6723
|
observabilityConfig?: GoogleCloudDiscoveryengineV1ObservabilityConfig;
|
|
6724
|
+
/** Optional. The email of the procurement contact. */
|
|
6725
|
+
procurementContactEmail?: string;
|
|
6700
6726
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
6701
6727
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
6702
6728
|
/** Required. The solutions of the engine. */
|
|
@@ -9917,7 +9943,7 @@ declare namespace gapi.client {
|
|
|
9917
9943
|
callback?: string;
|
|
9918
9944
|
/** Selector specifying which fields to include in a partial response. */
|
|
9919
9945
|
fields?: string;
|
|
9920
|
-
/** 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"` */
|
|
9946
|
+
/** 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"` */
|
|
9921
9947
|
filter?: string;
|
|
9922
9948
|
/** 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. */
|
|
9923
9949
|
key?: string;
|
|
@@ -13095,7 +13121,7 @@ declare namespace gapi.client {
|
|
|
13095
13121
|
callback?: string;
|
|
13096
13122
|
/** Selector specifying which fields to include in a partial response. */
|
|
13097
13123
|
fields?: string;
|
|
13098
|
-
/** 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"` */
|
|
13124
|
+
/** 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"` */
|
|
13099
13125
|
filter?: string;
|
|
13100
13126
|
/** 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. */
|
|
13101
13127
|
key?: string;
|
|
@@ -15852,7 +15878,7 @@ declare namespace gapi.client {
|
|
|
15852
15878
|
callback?: string;
|
|
15853
15879
|
/** Selector specifying which fields to include in a partial response. */
|
|
15854
15880
|
fields?: string;
|
|
15855
|
-
/** 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"` */
|
|
15881
|
+
/** 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"` */
|
|
15856
15882
|
filter?: string;
|
|
15857
15883
|
/** 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. */
|
|
15858
15884
|
key?: string;
|
|
@@ -17738,7 +17764,7 @@ declare namespace gapi.client {
|
|
|
17738
17764
|
operations: OperationsResource;
|
|
17739
17765
|
}
|
|
17740
17766
|
interface LicenseConfigsResource {
|
|
17741
|
-
/** Creates a LicenseConfig */
|
|
17767
|
+
/** Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. */
|
|
17742
17768
|
create(request: {
|
|
17743
17769
|
/** V1 error format. */
|
|
17744
17770
|
'$.xgafv'?: string;
|