@googleapis/discoveryengine 28.0.0 → 28.2.0
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/CHANGELOG.md +15 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +691 -17
- package/build/v1.js +198 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +1136 -406
- package/build/v1alpha.js +198 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +720 -36
- package/build/v1beta.js +198 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +1554 -382
- package/v1alpha.ts +1483 -256
- package/v1beta.ts +1561 -379
package/build/v1alpha.d.ts
CHANGED
|
@@ -484,11 +484,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
484
484
|
* Stored definition of an agent that uses A2A.
|
|
485
485
|
*/
|
|
486
486
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition {
|
|
487
|
+
/**
|
|
488
|
+
* Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
|
|
489
|
+
*/
|
|
490
|
+
cloudMarketplaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig;
|
|
487
491
|
/**
|
|
488
492
|
* Optional. The agent card is a JSON string.
|
|
489
493
|
*/
|
|
490
494
|
jsonAgentCard?: string | null;
|
|
491
495
|
}
|
|
496
|
+
/**
|
|
497
|
+
* Configuration specific to agents that are deployed from Cloud Marketplace.
|
|
498
|
+
*/
|
|
499
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig {
|
|
500
|
+
/**
|
|
501
|
+
* Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project\}/entitlements/{entitlement\}`.
|
|
502
|
+
*/
|
|
503
|
+
entitlement?: string | null;
|
|
504
|
+
/**
|
|
505
|
+
* Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account\}/orders/{order\}`
|
|
506
|
+
*/
|
|
507
|
+
order?: string | null;
|
|
508
|
+
}
|
|
492
509
|
/**
|
|
493
510
|
* Access Control Configuration.
|
|
494
511
|
*/
|
|
@@ -831,6 +848,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
831
848
|
* Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
|
|
832
849
|
*/
|
|
833
850
|
languageCode?: string | null;
|
|
851
|
+
/**
|
|
852
|
+
* Optional. The behavior of the Google managed agent.
|
|
853
|
+
*/
|
|
854
|
+
managedAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition;
|
|
834
855
|
/**
|
|
835
856
|
* Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
836
857
|
*/
|
|
@@ -6855,6 +6876,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6855
6876
|
*/
|
|
6856
6877
|
userLicenses?: Schema$GoogleCloudDiscoveryengineV1alphaUserLicense[];
|
|
6857
6878
|
}
|
|
6879
|
+
/**
|
|
6880
|
+
* Stores the definition of a Google managed agent.
|
|
6881
|
+
*/
|
|
6882
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition {
|
|
6883
|
+
}
|
|
6858
6884
|
/**
|
|
6859
6885
|
* Media-specific user event information.
|
|
6860
6886
|
*/
|
|
@@ -8214,7 +8240,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8214
8240
|
*/
|
|
8215
8241
|
orderBy?: string | null;
|
|
8216
8242
|
/**
|
|
8217
|
-
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
8243
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
8218
8244
|
*/
|
|
8219
8245
|
pageCategories?: string[] | null;
|
|
8220
8246
|
/**
|
|
@@ -8255,12 +8281,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8255
8281
|
* The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
|
|
8256
8282
|
*/
|
|
8257
8283
|
regionCode?: string | null;
|
|
8284
|
+
/**
|
|
8285
|
+
* Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
|
|
8286
|
+
*/
|
|
8287
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec;
|
|
8258
8288
|
/**
|
|
8259
8289
|
* Optional. The specification for returning the relevance score.
|
|
8260
8290
|
*/
|
|
8261
8291
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec;
|
|
8262
8292
|
/**
|
|
8263
|
-
* The relevance threshold of the search results.
|
|
8293
|
+
* The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.
|
|
8264
8294
|
*/
|
|
8265
8295
|
relevanceThreshold?: string | null;
|
|
8266
8296
|
/**
|
|
@@ -8701,6 +8731,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8701
8731
|
*/
|
|
8702
8732
|
pinUnexpandedResults?: boolean | null;
|
|
8703
8733
|
}
|
|
8734
|
+
/**
|
|
8735
|
+
* Relevance filtering specification.
|
|
8736
|
+
*/
|
|
8737
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec {
|
|
8738
|
+
/**
|
|
8739
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
8740
|
+
*/
|
|
8741
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
8742
|
+
/**
|
|
8743
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
8744
|
+
*/
|
|
8745
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
8746
|
+
}
|
|
8747
|
+
/**
|
|
8748
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
8749
|
+
*/
|
|
8750
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
8751
|
+
/**
|
|
8752
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
8753
|
+
*/
|
|
8754
|
+
relevanceThreshold?: string | null;
|
|
8755
|
+
/**
|
|
8756
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
8757
|
+
*/
|
|
8758
|
+
semanticRelevanceThreshold?: number | null;
|
|
8759
|
+
}
|
|
8704
8760
|
/**
|
|
8705
8761
|
* The specification for returning the document relevance score.
|
|
8706
8762
|
*/
|
|
@@ -10200,7 +10256,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10200
10256
|
*/
|
|
10201
10257
|
eventType?: string | null;
|
|
10202
10258
|
/**
|
|
10203
|
-
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
10259
|
+
* Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
10204
10260
|
*/
|
|
10205
10261
|
filter?: string | null;
|
|
10206
10262
|
/**
|
|
@@ -12953,7 +13009,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12953
13009
|
*/
|
|
12954
13010
|
orderBy?: string | null;
|
|
12955
13011
|
/**
|
|
12956
|
-
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
13012
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
12957
13013
|
*/
|
|
12958
13014
|
pageCategories?: string[] | null;
|
|
12959
13015
|
/**
|
|
@@ -12994,12 +13050,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12994
13050
|
* The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
|
|
12995
13051
|
*/
|
|
12996
13052
|
regionCode?: string | null;
|
|
13053
|
+
/**
|
|
13054
|
+
* Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
|
|
13055
|
+
*/
|
|
13056
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec;
|
|
12997
13057
|
/**
|
|
12998
13058
|
* Optional. The specification for returning the relevance score.
|
|
12999
13059
|
*/
|
|
13000
13060
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec;
|
|
13001
13061
|
/**
|
|
13002
|
-
* The relevance threshold of the search results.
|
|
13062
|
+
* The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.
|
|
13003
13063
|
*/
|
|
13004
13064
|
relevanceThreshold?: string | null;
|
|
13005
13065
|
/**
|
|
@@ -13436,6 +13496,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13436
13496
|
*/
|
|
13437
13497
|
pinUnexpandedResults?: boolean | null;
|
|
13438
13498
|
}
|
|
13499
|
+
/**
|
|
13500
|
+
* Relevance filtering specification.
|
|
13501
|
+
*/
|
|
13502
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec {
|
|
13503
|
+
/**
|
|
13504
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
13505
|
+
*/
|
|
13506
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
13507
|
+
/**
|
|
13508
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
13509
|
+
*/
|
|
13510
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
13511
|
+
}
|
|
13512
|
+
/**
|
|
13513
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
13514
|
+
*/
|
|
13515
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
13516
|
+
/**
|
|
13517
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
13518
|
+
*/
|
|
13519
|
+
relevanceThreshold?: string | null;
|
|
13520
|
+
/**
|
|
13521
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
13522
|
+
*/
|
|
13523
|
+
semanticRelevanceThreshold?: number | null;
|
|
13524
|
+
}
|
|
13439
13525
|
/**
|
|
13440
13526
|
* The specification for returning the document relevance score.
|
|
13441
13527
|
*/
|
|
@@ -14459,6 +14545,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14459
14545
|
* Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
14460
14546
|
*/
|
|
14461
14547
|
name?: string | null;
|
|
14548
|
+
/**
|
|
14549
|
+
* Optional. Configuration for Natural Language Query Understanding.
|
|
14550
|
+
*/
|
|
14551
|
+
naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig;
|
|
14462
14552
|
/**
|
|
14463
14553
|
* Optional. Stores serving config at DataStore level.
|
|
14464
14554
|
*/
|
|
@@ -15302,6 +15392,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15302
15392
|
*/
|
|
15303
15393
|
subscriptionTier?: string | null;
|
|
15304
15394
|
}
|
|
15395
|
+
/**
|
|
15396
|
+
* Configuration for Natural Language Query Understanding.
|
|
15397
|
+
*/
|
|
15398
|
+
export interface Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig {
|
|
15399
|
+
/**
|
|
15400
|
+
* Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
|
|
15401
|
+
*/
|
|
15402
|
+
mode?: string | null;
|
|
15403
|
+
}
|
|
15305
15404
|
/**
|
|
15306
15405
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
15307
15406
|
*/
|
|
@@ -19866,7 +19965,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19866
19965
|
* await discoveryengine.projects.locations.collections.updateDataConnector({
|
|
19867
19966
|
* // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
19868
19967
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector',
|
|
19869
|
-
* // 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 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.
|
|
19968
|
+
* // 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.
|
|
19870
19969
|
* updateMask: 'placeholder-value',
|
|
19871
19970
|
*
|
|
19872
19971
|
* // Request body metadata
|
|
@@ -20036,7 +20135,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
20036
20135
|
*/
|
|
20037
20136
|
name?: string;
|
|
20038
20137
|
/**
|
|
20039
|
-
* 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 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.
|
|
20138
|
+
* 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.
|
|
20040
20139
|
*/
|
|
20041
20140
|
updateMask?: string;
|
|
20042
20141
|
/**
|
|
@@ -25519,7 +25618,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
25519
25618
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
25520
25619
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
25521
25620
|
/**
|
|
25522
|
-
*
|
|
25621
|
+
* Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.
|
|
25523
25622
|
* @example
|
|
25524
25623
|
* ```js
|
|
25525
25624
|
* // Before running the sample:
|
|
@@ -25552,173 +25651,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
25552
25651
|
*
|
|
25553
25652
|
* // Do the magic
|
|
25554
25653
|
* const res =
|
|
25555
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.
|
|
25654
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.create(
|
|
25556
25655
|
* {
|
|
25557
|
-
* // Required.
|
|
25558
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
25559
|
-
* },
|
|
25560
|
-
* );
|
|
25561
|
-
* console.log(res.data);
|
|
25562
|
-
*
|
|
25563
|
-
* // Example response
|
|
25564
|
-
* // {
|
|
25565
|
-
* // "answerGenerationSpec": {},
|
|
25566
|
-
* // "boostControlIds": [],
|
|
25567
|
-
* // "createTime": "my_createTime",
|
|
25568
|
-
* // "customFineTuningSpec": {},
|
|
25569
|
-
* // "displayName": "my_displayName",
|
|
25570
|
-
* // "dissociateControlIds": [],
|
|
25571
|
-
* // "diversityLevel": "my_diversityLevel",
|
|
25572
|
-
* // "embeddingConfig": {},
|
|
25573
|
-
* // "filterControlIds": [],
|
|
25574
|
-
* // "genericConfig": {},
|
|
25575
|
-
* // "guidedSearchSpec": {},
|
|
25576
|
-
* // "ignoreControlIds": [],
|
|
25577
|
-
* // "mediaConfig": {},
|
|
25578
|
-
* // "modelId": "my_modelId",
|
|
25579
|
-
* // "name": "my_name",
|
|
25580
|
-
* // "onewaySynonymsControlIds": [],
|
|
25581
|
-
* // "personalizationSpec": {},
|
|
25582
|
-
* // "promoteControlIds": [],
|
|
25583
|
-
* // "rankingExpression": "my_rankingExpression",
|
|
25584
|
-
* // "redirectControlIds": [],
|
|
25585
|
-
* // "replacementControlIds": [],
|
|
25586
|
-
* // "solutionType": "my_solutionType",
|
|
25587
|
-
* // "synonymsControlIds": [],
|
|
25588
|
-
* // "updateTime": "my_updateTime"
|
|
25589
|
-
* // }
|
|
25590
|
-
* }
|
|
25591
|
-
*
|
|
25592
|
-
* main().catch(e => {
|
|
25593
|
-
* console.error(e);
|
|
25594
|
-
* throw e;
|
|
25595
|
-
* });
|
|
25596
|
-
*
|
|
25597
|
-
* ```
|
|
25598
|
-
*
|
|
25599
|
-
* @param params - Parameters for request
|
|
25600
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25601
|
-
* @param callback - Optional callback that handles the response.
|
|
25602
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25603
|
-
*/
|
|
25604
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25605
|
-
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
|
|
25606
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25607
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25608
|
-
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25609
|
-
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25610
|
-
/**
|
|
25611
|
-
* Lists all ServingConfigs linked to this dataStore.
|
|
25612
|
-
* @example
|
|
25613
|
-
* ```js
|
|
25614
|
-
* // Before running the sample:
|
|
25615
|
-
* // - Enable the API at:
|
|
25616
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25617
|
-
* // - Login into gcloud by running:
|
|
25618
|
-
* // ```sh
|
|
25619
|
-
* // $ gcloud auth application-default login
|
|
25620
|
-
* // ```
|
|
25621
|
-
* // - Install the npm module by running:
|
|
25622
|
-
* // ```sh
|
|
25623
|
-
* // $ npm install googleapis
|
|
25624
|
-
* // ```
|
|
25625
|
-
*
|
|
25626
|
-
* const {google} = require('googleapis');
|
|
25627
|
-
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
25628
|
-
*
|
|
25629
|
-
* async function main() {
|
|
25630
|
-
* const auth = new google.auth.GoogleAuth({
|
|
25631
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25632
|
-
* scopes: [
|
|
25633
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25634
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25635
|
-
* ],
|
|
25636
|
-
* });
|
|
25637
|
-
*
|
|
25638
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
25639
|
-
* const authClient = await auth.getClient();
|
|
25640
|
-
* google.options({auth: authClient});
|
|
25641
|
-
*
|
|
25642
|
-
* // Do the magic
|
|
25643
|
-
* const res =
|
|
25644
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list(
|
|
25645
|
-
* {
|
|
25646
|
-
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
25647
|
-
* pageSize: 'placeholder-value',
|
|
25648
|
-
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
25649
|
-
* pageToken: 'placeholder-value',
|
|
25650
|
-
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25656
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25651
25657
|
* parent:
|
|
25652
25658
|
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
25653
|
-
*
|
|
25654
|
-
*
|
|
25655
|
-
* console.log(res.data);
|
|
25656
|
-
*
|
|
25657
|
-
* // Example response
|
|
25658
|
-
* // {
|
|
25659
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
25660
|
-
* // "servingConfigs": []
|
|
25661
|
-
* // }
|
|
25662
|
-
* }
|
|
25663
|
-
*
|
|
25664
|
-
* main().catch(e => {
|
|
25665
|
-
* console.error(e);
|
|
25666
|
-
* throw e;
|
|
25667
|
-
* });
|
|
25668
|
-
*
|
|
25669
|
-
* ```
|
|
25670
|
-
*
|
|
25671
|
-
* @param params - Parameters for request
|
|
25672
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25673
|
-
* @param callback - Optional callback that handles the response.
|
|
25674
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25675
|
-
*/
|
|
25676
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25677
|
-
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>>;
|
|
25678
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25679
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
25680
|
-
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
25681
|
-
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
25682
|
-
/**
|
|
25683
|
-
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
25684
|
-
* @example
|
|
25685
|
-
* ```js
|
|
25686
|
-
* // Before running the sample:
|
|
25687
|
-
* // - Enable the API at:
|
|
25688
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25689
|
-
* // - Login into gcloud by running:
|
|
25690
|
-
* // ```sh
|
|
25691
|
-
* // $ gcloud auth application-default login
|
|
25692
|
-
* // ```
|
|
25693
|
-
* // - Install the npm module by running:
|
|
25694
|
-
* // ```sh
|
|
25695
|
-
* // $ npm install googleapis
|
|
25696
|
-
* // ```
|
|
25697
|
-
*
|
|
25698
|
-
* const {google} = require('googleapis');
|
|
25699
|
-
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
25700
|
-
*
|
|
25701
|
-
* async function main() {
|
|
25702
|
-
* const auth = new google.auth.GoogleAuth({
|
|
25703
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25704
|
-
* scopes: [
|
|
25705
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25706
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25707
|
-
* ],
|
|
25708
|
-
* });
|
|
25709
|
-
*
|
|
25710
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
25711
|
-
* const authClient = await auth.getClient();
|
|
25712
|
-
* google.options({auth: authClient});
|
|
25713
|
-
*
|
|
25714
|
-
* // Do the magic
|
|
25715
|
-
* const res =
|
|
25716
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch(
|
|
25717
|
-
* {
|
|
25718
|
-
* // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
25719
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
25720
|
-
* // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
25721
|
-
* updateMask: 'placeholder-value',
|
|
25659
|
+
* // Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
|
|
25660
|
+
* servingConfigId: 'placeholder-value',
|
|
25722
25661
|
*
|
|
25723
25662
|
* // Request body metadata
|
|
25724
25663
|
* requestBody: {
|
|
@@ -25795,14 +25734,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
25795
25734
|
* @param callback - Optional callback that handles the response.
|
|
25796
25735
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25797
25736
|
*/
|
|
25798
|
-
|
|
25799
|
-
|
|
25800
|
-
|
|
25801
|
-
|
|
25802
|
-
|
|
25803
|
-
|
|
25737
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25738
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
|
|
25739
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25740
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25741
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25742
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25804
25743
|
/**
|
|
25805
|
-
*
|
|
25744
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
25806
25745
|
* @example
|
|
25807
25746
|
* ```js
|
|
25808
25747
|
* // Before running the sample:
|
|
@@ -25835,35 +25774,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
25835
25774
|
*
|
|
25836
25775
|
* // Do the magic
|
|
25837
25776
|
* const res =
|
|
25838
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.
|
|
25777
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete(
|
|
25839
25778
|
* {
|
|
25840
|
-
* // Required.
|
|
25841
|
-
* servingConfig
|
|
25842
|
-
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
25843
|
-
*
|
|
25844
|
-
* // Request body metadata
|
|
25845
|
-
* requestBody: {
|
|
25846
|
-
* // request body parameters
|
|
25847
|
-
* // {
|
|
25848
|
-
* // "filter": "my_filter",
|
|
25849
|
-
* // "pageSize": 0,
|
|
25850
|
-
* // "params": {},
|
|
25851
|
-
* // "userEvent": {},
|
|
25852
|
-
* // "userLabels": {},
|
|
25853
|
-
* // "validateOnly": false
|
|
25854
|
-
* // }
|
|
25855
|
-
* },
|
|
25779
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
25780
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
25856
25781
|
* },
|
|
25857
25782
|
* );
|
|
25858
25783
|
* console.log(res.data);
|
|
25859
25784
|
*
|
|
25860
25785
|
* // Example response
|
|
25861
|
-
* // {
|
|
25862
|
-
* // "attributionToken": "my_attributionToken",
|
|
25863
|
-
* // "missingIds": [],
|
|
25864
|
-
* // "results": [],
|
|
25865
|
-
* // "validateOnly": false
|
|
25866
|
-
* // }
|
|
25786
|
+
* // {}
|
|
25867
25787
|
* }
|
|
25868
25788
|
*
|
|
25869
25789
|
* main().catch(e => {
|
|
@@ -25878,14 +25798,380 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
25878
25798
|
* @param callback - Optional callback that handles the response.
|
|
25879
25799
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25880
25800
|
*/
|
|
25881
|
-
|
|
25882
|
-
|
|
25883
|
-
|
|
25884
|
-
|
|
25885
|
-
|
|
25886
|
-
|
|
25801
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25802
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
25803
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25804
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25805
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25806
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
25887
25807
|
/**
|
|
25888
|
-
*
|
|
25808
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
25809
|
+
* @example
|
|
25810
|
+
* ```js
|
|
25811
|
+
* // Before running the sample:
|
|
25812
|
+
* // - Enable the API at:
|
|
25813
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25814
|
+
* // - Login into gcloud by running:
|
|
25815
|
+
* // ```sh
|
|
25816
|
+
* // $ gcloud auth application-default login
|
|
25817
|
+
* // ```
|
|
25818
|
+
* // - Install the npm module by running:
|
|
25819
|
+
* // ```sh
|
|
25820
|
+
* // $ npm install googleapis
|
|
25821
|
+
* // ```
|
|
25822
|
+
*
|
|
25823
|
+
* const {google} = require('googleapis');
|
|
25824
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
25825
|
+
*
|
|
25826
|
+
* async function main() {
|
|
25827
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25828
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25829
|
+
* scopes: [
|
|
25830
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25831
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25832
|
+
* ],
|
|
25833
|
+
* });
|
|
25834
|
+
*
|
|
25835
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25836
|
+
* const authClient = await auth.getClient();
|
|
25837
|
+
* google.options({auth: authClient});
|
|
25838
|
+
*
|
|
25839
|
+
* // Do the magic
|
|
25840
|
+
* const res =
|
|
25841
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.get(
|
|
25842
|
+
* {
|
|
25843
|
+
* // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
25844
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
25845
|
+
* },
|
|
25846
|
+
* );
|
|
25847
|
+
* console.log(res.data);
|
|
25848
|
+
*
|
|
25849
|
+
* // Example response
|
|
25850
|
+
* // {
|
|
25851
|
+
* // "answerGenerationSpec": {},
|
|
25852
|
+
* // "boostControlIds": [],
|
|
25853
|
+
* // "createTime": "my_createTime",
|
|
25854
|
+
* // "customFineTuningSpec": {},
|
|
25855
|
+
* // "displayName": "my_displayName",
|
|
25856
|
+
* // "dissociateControlIds": [],
|
|
25857
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
25858
|
+
* // "embeddingConfig": {},
|
|
25859
|
+
* // "filterControlIds": [],
|
|
25860
|
+
* // "genericConfig": {},
|
|
25861
|
+
* // "guidedSearchSpec": {},
|
|
25862
|
+
* // "ignoreControlIds": [],
|
|
25863
|
+
* // "mediaConfig": {},
|
|
25864
|
+
* // "modelId": "my_modelId",
|
|
25865
|
+
* // "name": "my_name",
|
|
25866
|
+
* // "onewaySynonymsControlIds": [],
|
|
25867
|
+
* // "personalizationSpec": {},
|
|
25868
|
+
* // "promoteControlIds": [],
|
|
25869
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
25870
|
+
* // "redirectControlIds": [],
|
|
25871
|
+
* // "replacementControlIds": [],
|
|
25872
|
+
* // "solutionType": "my_solutionType",
|
|
25873
|
+
* // "synonymsControlIds": [],
|
|
25874
|
+
* // "updateTime": "my_updateTime"
|
|
25875
|
+
* // }
|
|
25876
|
+
* }
|
|
25877
|
+
*
|
|
25878
|
+
* main().catch(e => {
|
|
25879
|
+
* console.error(e);
|
|
25880
|
+
* throw e;
|
|
25881
|
+
* });
|
|
25882
|
+
*
|
|
25883
|
+
* ```
|
|
25884
|
+
*
|
|
25885
|
+
* @param params - Parameters for request
|
|
25886
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25887
|
+
* @param callback - Optional callback that handles the response.
|
|
25888
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25889
|
+
*/
|
|
25890
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25891
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
|
|
25892
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25893
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25894
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25895
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
25896
|
+
/**
|
|
25897
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
25898
|
+
* @example
|
|
25899
|
+
* ```js
|
|
25900
|
+
* // Before running the sample:
|
|
25901
|
+
* // - Enable the API at:
|
|
25902
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25903
|
+
* // - Login into gcloud by running:
|
|
25904
|
+
* // ```sh
|
|
25905
|
+
* // $ gcloud auth application-default login
|
|
25906
|
+
* // ```
|
|
25907
|
+
* // - Install the npm module by running:
|
|
25908
|
+
* // ```sh
|
|
25909
|
+
* // $ npm install googleapis
|
|
25910
|
+
* // ```
|
|
25911
|
+
*
|
|
25912
|
+
* const {google} = require('googleapis');
|
|
25913
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
25914
|
+
*
|
|
25915
|
+
* async function main() {
|
|
25916
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25917
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25918
|
+
* scopes: [
|
|
25919
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25920
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25921
|
+
* ],
|
|
25922
|
+
* });
|
|
25923
|
+
*
|
|
25924
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25925
|
+
* const authClient = await auth.getClient();
|
|
25926
|
+
* google.options({auth: authClient});
|
|
25927
|
+
*
|
|
25928
|
+
* // Do the magic
|
|
25929
|
+
* const res =
|
|
25930
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list(
|
|
25931
|
+
* {
|
|
25932
|
+
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
25933
|
+
* pageSize: 'placeholder-value',
|
|
25934
|
+
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
25935
|
+
* pageToken: 'placeholder-value',
|
|
25936
|
+
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
25937
|
+
* parent:
|
|
25938
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
25939
|
+
* },
|
|
25940
|
+
* );
|
|
25941
|
+
* console.log(res.data);
|
|
25942
|
+
*
|
|
25943
|
+
* // Example response
|
|
25944
|
+
* // {
|
|
25945
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
25946
|
+
* // "servingConfigs": []
|
|
25947
|
+
* // }
|
|
25948
|
+
* }
|
|
25949
|
+
*
|
|
25950
|
+
* main().catch(e => {
|
|
25951
|
+
* console.error(e);
|
|
25952
|
+
* throw e;
|
|
25953
|
+
* });
|
|
25954
|
+
*
|
|
25955
|
+
* ```
|
|
25956
|
+
*
|
|
25957
|
+
* @param params - Parameters for request
|
|
25958
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25959
|
+
* @param callback - Optional callback that handles the response.
|
|
25960
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25961
|
+
*/
|
|
25962
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25963
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>>;
|
|
25964
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25965
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
25966
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
25967
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
|
|
25968
|
+
/**
|
|
25969
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
25970
|
+
* @example
|
|
25971
|
+
* ```js
|
|
25972
|
+
* // Before running the sample:
|
|
25973
|
+
* // - Enable the API at:
|
|
25974
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
25975
|
+
* // - Login into gcloud by running:
|
|
25976
|
+
* // ```sh
|
|
25977
|
+
* // $ gcloud auth application-default login
|
|
25978
|
+
* // ```
|
|
25979
|
+
* // - Install the npm module by running:
|
|
25980
|
+
* // ```sh
|
|
25981
|
+
* // $ npm install googleapis
|
|
25982
|
+
* // ```
|
|
25983
|
+
*
|
|
25984
|
+
* const {google} = require('googleapis');
|
|
25985
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
25986
|
+
*
|
|
25987
|
+
* async function main() {
|
|
25988
|
+
* const auth = new google.auth.GoogleAuth({
|
|
25989
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
25990
|
+
* scopes: [
|
|
25991
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
25992
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
25993
|
+
* ],
|
|
25994
|
+
* });
|
|
25995
|
+
*
|
|
25996
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
25997
|
+
* const authClient = await auth.getClient();
|
|
25998
|
+
* google.options({auth: authClient});
|
|
25999
|
+
*
|
|
26000
|
+
* // Do the magic
|
|
26001
|
+
* const res =
|
|
26002
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch(
|
|
26003
|
+
* {
|
|
26004
|
+
* // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
26005
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
26006
|
+
* // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
26007
|
+
* updateMask: 'placeholder-value',
|
|
26008
|
+
*
|
|
26009
|
+
* // Request body metadata
|
|
26010
|
+
* requestBody: {
|
|
26011
|
+
* // request body parameters
|
|
26012
|
+
* // {
|
|
26013
|
+
* // "answerGenerationSpec": {},
|
|
26014
|
+
* // "boostControlIds": [],
|
|
26015
|
+
* // "createTime": "my_createTime",
|
|
26016
|
+
* // "customFineTuningSpec": {},
|
|
26017
|
+
* // "displayName": "my_displayName",
|
|
26018
|
+
* // "dissociateControlIds": [],
|
|
26019
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
26020
|
+
* // "embeddingConfig": {},
|
|
26021
|
+
* // "filterControlIds": [],
|
|
26022
|
+
* // "genericConfig": {},
|
|
26023
|
+
* // "guidedSearchSpec": {},
|
|
26024
|
+
* // "ignoreControlIds": [],
|
|
26025
|
+
* // "mediaConfig": {},
|
|
26026
|
+
* // "modelId": "my_modelId",
|
|
26027
|
+
* // "name": "my_name",
|
|
26028
|
+
* // "onewaySynonymsControlIds": [],
|
|
26029
|
+
* // "personalizationSpec": {},
|
|
26030
|
+
* // "promoteControlIds": [],
|
|
26031
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
26032
|
+
* // "redirectControlIds": [],
|
|
26033
|
+
* // "replacementControlIds": [],
|
|
26034
|
+
* // "solutionType": "my_solutionType",
|
|
26035
|
+
* // "synonymsControlIds": [],
|
|
26036
|
+
* // "updateTime": "my_updateTime"
|
|
26037
|
+
* // }
|
|
26038
|
+
* },
|
|
26039
|
+
* },
|
|
26040
|
+
* );
|
|
26041
|
+
* console.log(res.data);
|
|
26042
|
+
*
|
|
26043
|
+
* // Example response
|
|
26044
|
+
* // {
|
|
26045
|
+
* // "answerGenerationSpec": {},
|
|
26046
|
+
* // "boostControlIds": [],
|
|
26047
|
+
* // "createTime": "my_createTime",
|
|
26048
|
+
* // "customFineTuningSpec": {},
|
|
26049
|
+
* // "displayName": "my_displayName",
|
|
26050
|
+
* // "dissociateControlIds": [],
|
|
26051
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
26052
|
+
* // "embeddingConfig": {},
|
|
26053
|
+
* // "filterControlIds": [],
|
|
26054
|
+
* // "genericConfig": {},
|
|
26055
|
+
* // "guidedSearchSpec": {},
|
|
26056
|
+
* // "ignoreControlIds": [],
|
|
26057
|
+
* // "mediaConfig": {},
|
|
26058
|
+
* // "modelId": "my_modelId",
|
|
26059
|
+
* // "name": "my_name",
|
|
26060
|
+
* // "onewaySynonymsControlIds": [],
|
|
26061
|
+
* // "personalizationSpec": {},
|
|
26062
|
+
* // "promoteControlIds": [],
|
|
26063
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
26064
|
+
* // "redirectControlIds": [],
|
|
26065
|
+
* // "replacementControlIds": [],
|
|
26066
|
+
* // "solutionType": "my_solutionType",
|
|
26067
|
+
* // "synonymsControlIds": [],
|
|
26068
|
+
* // "updateTime": "my_updateTime"
|
|
26069
|
+
* // }
|
|
26070
|
+
* }
|
|
26071
|
+
*
|
|
26072
|
+
* main().catch(e => {
|
|
26073
|
+
* console.error(e);
|
|
26074
|
+
* throw e;
|
|
26075
|
+
* });
|
|
26076
|
+
*
|
|
26077
|
+
* ```
|
|
26078
|
+
*
|
|
26079
|
+
* @param params - Parameters for request
|
|
26080
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
26081
|
+
* @param callback - Optional callback that handles the response.
|
|
26082
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
26083
|
+
*/
|
|
26084
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
26085
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
|
|
26086
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
26087
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
26088
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
26089
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
26090
|
+
/**
|
|
26091
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
26092
|
+
* @example
|
|
26093
|
+
* ```js
|
|
26094
|
+
* // Before running the sample:
|
|
26095
|
+
* // - Enable the API at:
|
|
26096
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
26097
|
+
* // - Login into gcloud by running:
|
|
26098
|
+
* // ```sh
|
|
26099
|
+
* // $ gcloud auth application-default login
|
|
26100
|
+
* // ```
|
|
26101
|
+
* // - Install the npm module by running:
|
|
26102
|
+
* // ```sh
|
|
26103
|
+
* // $ npm install googleapis
|
|
26104
|
+
* // ```
|
|
26105
|
+
*
|
|
26106
|
+
* const {google} = require('googleapis');
|
|
26107
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
26108
|
+
*
|
|
26109
|
+
* async function main() {
|
|
26110
|
+
* const auth = new google.auth.GoogleAuth({
|
|
26111
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
26112
|
+
* scopes: [
|
|
26113
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
26114
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
26115
|
+
* ],
|
|
26116
|
+
* });
|
|
26117
|
+
*
|
|
26118
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
26119
|
+
* const authClient = await auth.getClient();
|
|
26120
|
+
* google.options({auth: authClient});
|
|
26121
|
+
*
|
|
26122
|
+
* // Do the magic
|
|
26123
|
+
* const res =
|
|
26124
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend(
|
|
26125
|
+
* {
|
|
26126
|
+
* // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
26127
|
+
* servingConfig:
|
|
26128
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
26129
|
+
*
|
|
26130
|
+
* // Request body metadata
|
|
26131
|
+
* requestBody: {
|
|
26132
|
+
* // request body parameters
|
|
26133
|
+
* // {
|
|
26134
|
+
* // "filter": "my_filter",
|
|
26135
|
+
* // "pageSize": 0,
|
|
26136
|
+
* // "params": {},
|
|
26137
|
+
* // "userEvent": {},
|
|
26138
|
+
* // "userLabels": {},
|
|
26139
|
+
* // "validateOnly": false
|
|
26140
|
+
* // }
|
|
26141
|
+
* },
|
|
26142
|
+
* },
|
|
26143
|
+
* );
|
|
26144
|
+
* console.log(res.data);
|
|
26145
|
+
*
|
|
26146
|
+
* // Example response
|
|
26147
|
+
* // {
|
|
26148
|
+
* // "attributionToken": "my_attributionToken",
|
|
26149
|
+
* // "missingIds": [],
|
|
26150
|
+
* // "results": [],
|
|
26151
|
+
* // "validateOnly": false
|
|
26152
|
+
* // }
|
|
26153
|
+
* }
|
|
26154
|
+
*
|
|
26155
|
+
* main().catch(e => {
|
|
26156
|
+
* console.error(e);
|
|
26157
|
+
* throw e;
|
|
26158
|
+
* });
|
|
26159
|
+
*
|
|
26160
|
+
* ```
|
|
26161
|
+
*
|
|
26162
|
+
* @param params - Parameters for request
|
|
26163
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
26164
|
+
* @param callback - Optional callback that handles the response.
|
|
26165
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
26166
|
+
*/
|
|
26167
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
26168
|
+
recommend(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>>;
|
|
26169
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
26170
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
26171
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
26172
|
+
recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>): void;
|
|
26173
|
+
/**
|
|
26174
|
+
* Performs a search.
|
|
25889
26175
|
* @example
|
|
25890
26176
|
* ```js
|
|
25891
26177
|
* // Before running the sample:
|
|
@@ -25956,6 +26242,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
25956
26242
|
* // "rankingExpression": "my_rankingExpression",
|
|
25957
26243
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
25958
26244
|
* // "regionCode": "my_regionCode",
|
|
26245
|
+
* // "relevanceFilterSpec": {},
|
|
25959
26246
|
* // "relevanceScoreSpec": {},
|
|
25960
26247
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
25961
26248
|
* // "safeSearch": false,
|
|
@@ -26088,6 +26375,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
26088
26375
|
* // "rankingExpression": "my_rankingExpression",
|
|
26089
26376
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
26090
26377
|
* // "regionCode": "my_regionCode",
|
|
26378
|
+
* // "relevanceFilterSpec": {},
|
|
26091
26379
|
* // "relevanceScoreSpec": {},
|
|
26092
26380
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
26093
26381
|
* // "safeSearch": false,
|
|
@@ -26248,6 +26536,26 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
26248
26536
|
*/
|
|
26249
26537
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
26250
26538
|
}
|
|
26539
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
26540
|
+
/**
|
|
26541
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
26542
|
+
*/
|
|
26543
|
+
parent?: string;
|
|
26544
|
+
/**
|
|
26545
|
+
* Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
|
|
26546
|
+
*/
|
|
26547
|
+
servingConfigId?: string;
|
|
26548
|
+
/**
|
|
26549
|
+
* Request body metadata
|
|
26550
|
+
*/
|
|
26551
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
26552
|
+
}
|
|
26553
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
26554
|
+
/**
|
|
26555
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
26556
|
+
*/
|
|
26557
|
+
name?: string;
|
|
26558
|
+
}
|
|
26251
26559
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
26252
26560
|
/**
|
|
26253
26561
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -31199,6 +31507,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31199
31507
|
* // "displayName": "my_displayName",
|
|
31200
31508
|
* // "icon": {},
|
|
31201
31509
|
* // "languageCode": "my_languageCode",
|
|
31510
|
+
* // "managedAgentDefinition": {},
|
|
31202
31511
|
* // "name": "my_name",
|
|
31203
31512
|
* // "rejectionReason": "my_rejectionReason",
|
|
31204
31513
|
* // "sharingConfig": {},
|
|
@@ -31225,6 +31534,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31225
31534
|
* // "displayName": "my_displayName",
|
|
31226
31535
|
* // "icon": {},
|
|
31227
31536
|
* // "languageCode": "my_languageCode",
|
|
31537
|
+
* // "managedAgentDefinition": {},
|
|
31228
31538
|
* // "name": "my_name",
|
|
31229
31539
|
* // "rejectionReason": "my_rejectionReason",
|
|
31230
31540
|
* // "sharingConfig": {},
|
|
@@ -31380,6 +31690,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31380
31690
|
* // "displayName": "my_displayName",
|
|
31381
31691
|
* // "icon": {},
|
|
31382
31692
|
* // "languageCode": "my_languageCode",
|
|
31693
|
+
* // "managedAgentDefinition": {},
|
|
31383
31694
|
* // "name": "my_name",
|
|
31384
31695
|
* // "rejectionReason": "my_rejectionReason",
|
|
31385
31696
|
* // "sharingConfig": {},
|
|
@@ -31464,6 +31775,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31464
31775
|
* // "displayName": "my_displayName",
|
|
31465
31776
|
* // "icon": {},
|
|
31466
31777
|
* // "languageCode": "my_languageCode",
|
|
31778
|
+
* // "managedAgentDefinition": {},
|
|
31467
31779
|
* // "name": "my_name",
|
|
31468
31780
|
* // "rejectionReason": "my_rejectionReason",
|
|
31469
31781
|
* // "sharingConfig": {},
|
|
@@ -31548,6 +31860,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31548
31860
|
* // "displayName": "my_displayName",
|
|
31549
31861
|
* // "icon": {},
|
|
31550
31862
|
* // "languageCode": "my_languageCode",
|
|
31863
|
+
* // "managedAgentDefinition": {},
|
|
31551
31864
|
* // "name": "my_name",
|
|
31552
31865
|
* // "rejectionReason": "my_rejectionReason",
|
|
31553
31866
|
* // "sharingConfig": {},
|
|
@@ -31853,6 +32166,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31853
32166
|
* // "displayName": "my_displayName",
|
|
31854
32167
|
* // "icon": {},
|
|
31855
32168
|
* // "languageCode": "my_languageCode",
|
|
32169
|
+
* // "managedAgentDefinition": {},
|
|
31856
32170
|
* // "name": "my_name",
|
|
31857
32171
|
* // "rejectionReason": "my_rejectionReason",
|
|
31858
32172
|
* // "sharingConfig": {},
|
|
@@ -31879,6 +32193,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31879
32193
|
* // "displayName": "my_displayName",
|
|
31880
32194
|
* // "icon": {},
|
|
31881
32195
|
* // "languageCode": "my_languageCode",
|
|
32196
|
+
* // "managedAgentDefinition": {},
|
|
31882
32197
|
* // "name": "my_name",
|
|
31883
32198
|
* // "rejectionReason": "my_rejectionReason",
|
|
31884
32199
|
* // "sharingConfig": {},
|
|
@@ -32043,6 +32358,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32043
32358
|
* // "displayName": "my_displayName",
|
|
32044
32359
|
* // "icon": {},
|
|
32045
32360
|
* // "languageCode": "my_languageCode",
|
|
32361
|
+
* // "managedAgentDefinition": {},
|
|
32046
32362
|
* // "name": "my_name",
|
|
32047
32363
|
* // "rejectionReason": "my_rejectionReason",
|
|
32048
32364
|
* // "sharingConfig": {},
|
|
@@ -34275,6 +34591,193 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34275
34591
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
34276
34592
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
34277
34593
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
34594
|
+
/**
|
|
34595
|
+
* Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.
|
|
34596
|
+
* @example
|
|
34597
|
+
* ```js
|
|
34598
|
+
* // Before running the sample:
|
|
34599
|
+
* // - Enable the API at:
|
|
34600
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
34601
|
+
* // - Login into gcloud by running:
|
|
34602
|
+
* // ```sh
|
|
34603
|
+
* // $ gcloud auth application-default login
|
|
34604
|
+
* // ```
|
|
34605
|
+
* // - Install the npm module by running:
|
|
34606
|
+
* // ```sh
|
|
34607
|
+
* // $ npm install googleapis
|
|
34608
|
+
* // ```
|
|
34609
|
+
*
|
|
34610
|
+
* const {google} = require('googleapis');
|
|
34611
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
34612
|
+
*
|
|
34613
|
+
* async function main() {
|
|
34614
|
+
* const auth = new google.auth.GoogleAuth({
|
|
34615
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
34616
|
+
* scopes: [
|
|
34617
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
34618
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
34619
|
+
* ],
|
|
34620
|
+
* });
|
|
34621
|
+
*
|
|
34622
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
34623
|
+
* const authClient = await auth.getClient();
|
|
34624
|
+
* google.options({auth: authClient});
|
|
34625
|
+
*
|
|
34626
|
+
* // Do the magic
|
|
34627
|
+
* const res =
|
|
34628
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.create(
|
|
34629
|
+
* {
|
|
34630
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
34631
|
+
* parent:
|
|
34632
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
34633
|
+
* // Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
|
|
34634
|
+
* servingConfigId: 'placeholder-value',
|
|
34635
|
+
*
|
|
34636
|
+
* // Request body metadata
|
|
34637
|
+
* requestBody: {
|
|
34638
|
+
* // request body parameters
|
|
34639
|
+
* // {
|
|
34640
|
+
* // "answerGenerationSpec": {},
|
|
34641
|
+
* // "boostControlIds": [],
|
|
34642
|
+
* // "createTime": "my_createTime",
|
|
34643
|
+
* // "customFineTuningSpec": {},
|
|
34644
|
+
* // "displayName": "my_displayName",
|
|
34645
|
+
* // "dissociateControlIds": [],
|
|
34646
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
34647
|
+
* // "embeddingConfig": {},
|
|
34648
|
+
* // "filterControlIds": [],
|
|
34649
|
+
* // "genericConfig": {},
|
|
34650
|
+
* // "guidedSearchSpec": {},
|
|
34651
|
+
* // "ignoreControlIds": [],
|
|
34652
|
+
* // "mediaConfig": {},
|
|
34653
|
+
* // "modelId": "my_modelId",
|
|
34654
|
+
* // "name": "my_name",
|
|
34655
|
+
* // "onewaySynonymsControlIds": [],
|
|
34656
|
+
* // "personalizationSpec": {},
|
|
34657
|
+
* // "promoteControlIds": [],
|
|
34658
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
34659
|
+
* // "redirectControlIds": [],
|
|
34660
|
+
* // "replacementControlIds": [],
|
|
34661
|
+
* // "solutionType": "my_solutionType",
|
|
34662
|
+
* // "synonymsControlIds": [],
|
|
34663
|
+
* // "updateTime": "my_updateTime"
|
|
34664
|
+
* // }
|
|
34665
|
+
* },
|
|
34666
|
+
* },
|
|
34667
|
+
* );
|
|
34668
|
+
* console.log(res.data);
|
|
34669
|
+
*
|
|
34670
|
+
* // Example response
|
|
34671
|
+
* // {
|
|
34672
|
+
* // "answerGenerationSpec": {},
|
|
34673
|
+
* // "boostControlIds": [],
|
|
34674
|
+
* // "createTime": "my_createTime",
|
|
34675
|
+
* // "customFineTuningSpec": {},
|
|
34676
|
+
* // "displayName": "my_displayName",
|
|
34677
|
+
* // "dissociateControlIds": [],
|
|
34678
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
34679
|
+
* // "embeddingConfig": {},
|
|
34680
|
+
* // "filterControlIds": [],
|
|
34681
|
+
* // "genericConfig": {},
|
|
34682
|
+
* // "guidedSearchSpec": {},
|
|
34683
|
+
* // "ignoreControlIds": [],
|
|
34684
|
+
* // "mediaConfig": {},
|
|
34685
|
+
* // "modelId": "my_modelId",
|
|
34686
|
+
* // "name": "my_name",
|
|
34687
|
+
* // "onewaySynonymsControlIds": [],
|
|
34688
|
+
* // "personalizationSpec": {},
|
|
34689
|
+
* // "promoteControlIds": [],
|
|
34690
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
34691
|
+
* // "redirectControlIds": [],
|
|
34692
|
+
* // "replacementControlIds": [],
|
|
34693
|
+
* // "solutionType": "my_solutionType",
|
|
34694
|
+
* // "synonymsControlIds": [],
|
|
34695
|
+
* // "updateTime": "my_updateTime"
|
|
34696
|
+
* // }
|
|
34697
|
+
* }
|
|
34698
|
+
*
|
|
34699
|
+
* main().catch(e => {
|
|
34700
|
+
* console.error(e);
|
|
34701
|
+
* throw e;
|
|
34702
|
+
* });
|
|
34703
|
+
*
|
|
34704
|
+
* ```
|
|
34705
|
+
*
|
|
34706
|
+
* @param params - Parameters for request
|
|
34707
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
34708
|
+
* @param callback - Optional callback that handles the response.
|
|
34709
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
34710
|
+
*/
|
|
34711
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34712
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
|
|
34713
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34714
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
34715
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
34716
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
34717
|
+
/**
|
|
34718
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
34719
|
+
* @example
|
|
34720
|
+
* ```js
|
|
34721
|
+
* // Before running the sample:
|
|
34722
|
+
* // - Enable the API at:
|
|
34723
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
34724
|
+
* // - Login into gcloud by running:
|
|
34725
|
+
* // ```sh
|
|
34726
|
+
* // $ gcloud auth application-default login
|
|
34727
|
+
* // ```
|
|
34728
|
+
* // - Install the npm module by running:
|
|
34729
|
+
* // ```sh
|
|
34730
|
+
* // $ npm install googleapis
|
|
34731
|
+
* // ```
|
|
34732
|
+
*
|
|
34733
|
+
* const {google} = require('googleapis');
|
|
34734
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
34735
|
+
*
|
|
34736
|
+
* async function main() {
|
|
34737
|
+
* const auth = new google.auth.GoogleAuth({
|
|
34738
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
34739
|
+
* scopes: [
|
|
34740
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
34741
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
34742
|
+
* ],
|
|
34743
|
+
* });
|
|
34744
|
+
*
|
|
34745
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
34746
|
+
* const authClient = await auth.getClient();
|
|
34747
|
+
* google.options({auth: authClient});
|
|
34748
|
+
*
|
|
34749
|
+
* // Do the magic
|
|
34750
|
+
* const res =
|
|
34751
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.delete(
|
|
34752
|
+
* {
|
|
34753
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
34754
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig',
|
|
34755
|
+
* },
|
|
34756
|
+
* );
|
|
34757
|
+
* console.log(res.data);
|
|
34758
|
+
*
|
|
34759
|
+
* // Example response
|
|
34760
|
+
* // {}
|
|
34761
|
+
* }
|
|
34762
|
+
*
|
|
34763
|
+
* main().catch(e => {
|
|
34764
|
+
* console.error(e);
|
|
34765
|
+
* throw e;
|
|
34766
|
+
* });
|
|
34767
|
+
*
|
|
34768
|
+
* ```
|
|
34769
|
+
*
|
|
34770
|
+
* @param params - Parameters for request
|
|
34771
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
34772
|
+
* @param callback - Optional callback that handles the response.
|
|
34773
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
34774
|
+
*/
|
|
34775
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34776
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
34777
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34778
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
34779
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
34780
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
34278
34781
|
/**
|
|
34279
34782
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
34280
34783
|
* @example
|
|
@@ -34713,6 +35216,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34713
35216
|
* // "rankingExpression": "my_rankingExpression",
|
|
34714
35217
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
34715
35218
|
* // "regionCode": "my_regionCode",
|
|
35219
|
+
* // "relevanceFilterSpec": {},
|
|
34716
35220
|
* // "relevanceScoreSpec": {},
|
|
34717
35221
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
34718
35222
|
* // "safeSearch": false,
|
|
@@ -34845,6 +35349,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34845
35349
|
* // "rankingExpression": "my_rankingExpression",
|
|
34846
35350
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
34847
35351
|
* // "regionCode": "my_regionCode",
|
|
35352
|
+
* // "relevanceFilterSpec": {},
|
|
34848
35353
|
* // "relevanceScoreSpec": {},
|
|
34849
35354
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
34850
35355
|
* // "safeSearch": false,
|
|
@@ -35005,6 +35510,26 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
35005
35510
|
*/
|
|
35006
35511
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
35007
35512
|
}
|
|
35513
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create extends StandardParameters {
|
|
35514
|
+
/**
|
|
35515
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
35516
|
+
*/
|
|
35517
|
+
parent?: string;
|
|
35518
|
+
/**
|
|
35519
|
+
* Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
|
|
35520
|
+
*/
|
|
35521
|
+
servingConfigId?: string;
|
|
35522
|
+
/**
|
|
35523
|
+
* Request body metadata
|
|
35524
|
+
*/
|
|
35525
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
35526
|
+
}
|
|
35527
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
|
|
35528
|
+
/**
|
|
35529
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
35530
|
+
*/
|
|
35531
|
+
name?: string;
|
|
35532
|
+
}
|
|
35008
35533
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
35009
35534
|
/**
|
|
35010
35535
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -40496,86 +41021,313 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40496
41021
|
* google.options({auth: authClient});
|
|
40497
41022
|
*
|
|
40498
41023
|
* // Do the magic
|
|
40499
|
-
* const res = await discoveryengine.projects.locations.dataStores.schemas.get({
|
|
40500
|
-
* // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
40501
|
-
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema',
|
|
40502
|
-
* });
|
|
40503
|
-
* console.log(res.data);
|
|
40504
|
-
*
|
|
40505
|
-
* // Example response
|
|
40506
|
-
* // {
|
|
40507
|
-
* // "fieldConfigs": [],
|
|
40508
|
-
* // "jsonSchema": "my_jsonSchema",
|
|
40509
|
-
* // "name": "my_name",
|
|
40510
|
-
* // "structSchema": {}
|
|
40511
|
-
* // }
|
|
40512
|
-
* }
|
|
40513
|
-
*
|
|
40514
|
-
* main().catch(e => {
|
|
40515
|
-
* console.error(e);
|
|
40516
|
-
* throw e;
|
|
40517
|
-
* });
|
|
40518
|
-
*
|
|
40519
|
-
* ```
|
|
40520
|
-
*
|
|
40521
|
-
* @param params - Parameters for request
|
|
40522
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40523
|
-
* @param callback - Optional callback that handles the response.
|
|
40524
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40525
|
-
*/
|
|
40526
|
-
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40527
|
-
get(params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaSchema>>;
|
|
40528
|
-
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40529
|
-
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>): void;
|
|
40530
|
-
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>): void;
|
|
40531
|
-
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>): void;
|
|
40532
|
-
/**
|
|
40533
|
-
* Gets a list of Schemas.
|
|
40534
|
-
* @example
|
|
40535
|
-
* ```js
|
|
40536
|
-
* // Before running the sample:
|
|
40537
|
-
* // - Enable the API at:
|
|
40538
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40539
|
-
* // - Login into gcloud by running:
|
|
40540
|
-
* // ```sh
|
|
40541
|
-
* // $ gcloud auth application-default login
|
|
40542
|
-
* // ```
|
|
40543
|
-
* // - Install the npm module by running:
|
|
40544
|
-
* // ```sh
|
|
40545
|
-
* // $ npm install googleapis
|
|
40546
|
-
* // ```
|
|
40547
|
-
*
|
|
40548
|
-
* const {google} = require('googleapis');
|
|
40549
|
-
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40550
|
-
*
|
|
40551
|
-
* async function main() {
|
|
40552
|
-
* const auth = new google.auth.GoogleAuth({
|
|
40553
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40554
|
-
* scopes: [
|
|
40555
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40556
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40557
|
-
* ],
|
|
40558
|
-
* });
|
|
40559
|
-
*
|
|
40560
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
40561
|
-
* const authClient = await auth.getClient();
|
|
40562
|
-
* google.options({auth: authClient});
|
|
41024
|
+
* const res = await discoveryengine.projects.locations.dataStores.schemas.get({
|
|
41025
|
+
* // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
41026
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema',
|
|
41027
|
+
* });
|
|
41028
|
+
* console.log(res.data);
|
|
41029
|
+
*
|
|
41030
|
+
* // Example response
|
|
41031
|
+
* // {
|
|
41032
|
+
* // "fieldConfigs": [],
|
|
41033
|
+
* // "jsonSchema": "my_jsonSchema",
|
|
41034
|
+
* // "name": "my_name",
|
|
41035
|
+
* // "structSchema": {}
|
|
41036
|
+
* // }
|
|
41037
|
+
* }
|
|
41038
|
+
*
|
|
41039
|
+
* main().catch(e => {
|
|
41040
|
+
* console.error(e);
|
|
41041
|
+
* throw e;
|
|
41042
|
+
* });
|
|
41043
|
+
*
|
|
41044
|
+
* ```
|
|
41045
|
+
*
|
|
41046
|
+
* @param params - Parameters for request
|
|
41047
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
41048
|
+
* @param callback - Optional callback that handles the response.
|
|
41049
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
41050
|
+
*/
|
|
41051
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41052
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaSchema>>;
|
|
41053
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41054
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>): void;
|
|
41055
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>): void;
|
|
41056
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSchema>): void;
|
|
41057
|
+
/**
|
|
41058
|
+
* Gets a list of Schemas.
|
|
41059
|
+
* @example
|
|
41060
|
+
* ```js
|
|
41061
|
+
* // Before running the sample:
|
|
41062
|
+
* // - Enable the API at:
|
|
41063
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
41064
|
+
* // - Login into gcloud by running:
|
|
41065
|
+
* // ```sh
|
|
41066
|
+
* // $ gcloud auth application-default login
|
|
41067
|
+
* // ```
|
|
41068
|
+
* // - Install the npm module by running:
|
|
41069
|
+
* // ```sh
|
|
41070
|
+
* // $ npm install googleapis
|
|
41071
|
+
* // ```
|
|
41072
|
+
*
|
|
41073
|
+
* const {google} = require('googleapis');
|
|
41074
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
41075
|
+
*
|
|
41076
|
+
* async function main() {
|
|
41077
|
+
* const auth = new google.auth.GoogleAuth({
|
|
41078
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
41079
|
+
* scopes: [
|
|
41080
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
41081
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
41082
|
+
* ],
|
|
41083
|
+
* });
|
|
41084
|
+
*
|
|
41085
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
41086
|
+
* const authClient = await auth.getClient();
|
|
41087
|
+
* google.options({auth: authClient});
|
|
41088
|
+
*
|
|
41089
|
+
* // Do the magic
|
|
41090
|
+
* const res = await discoveryengine.projects.locations.dataStores.schemas.list({
|
|
41091
|
+
* // The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.
|
|
41092
|
+
* pageSize: 'placeholder-value',
|
|
41093
|
+
* // A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
|
|
41094
|
+
* pageToken: 'placeholder-value',
|
|
41095
|
+
* // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
41096
|
+
* parent: 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
41097
|
+
* });
|
|
41098
|
+
* console.log(res.data);
|
|
41099
|
+
*
|
|
41100
|
+
* // Example response
|
|
41101
|
+
* // {
|
|
41102
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
41103
|
+
* // "schemas": []
|
|
41104
|
+
* // }
|
|
41105
|
+
* }
|
|
41106
|
+
*
|
|
41107
|
+
* main().catch(e => {
|
|
41108
|
+
* console.error(e);
|
|
41109
|
+
* throw e;
|
|
41110
|
+
* });
|
|
41111
|
+
*
|
|
41112
|
+
* ```
|
|
41113
|
+
*
|
|
41114
|
+
* @param params - Parameters for request
|
|
41115
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
41116
|
+
* @param callback - Optional callback that handles the response.
|
|
41117
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
41118
|
+
*/
|
|
41119
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41120
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListSchemasResponse>>;
|
|
41121
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41122
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSchemasResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSchemasResponse>): void;
|
|
41123
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Schemas$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSchemasResponse>): void;
|
|
41124
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSchemasResponse>): void;
|
|
41125
|
+
/**
|
|
41126
|
+
* Updates a Schema.
|
|
41127
|
+
* @example
|
|
41128
|
+
* ```js
|
|
41129
|
+
* // Before running the sample:
|
|
41130
|
+
* // - Enable the API at:
|
|
41131
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
41132
|
+
* // - Login into gcloud by running:
|
|
41133
|
+
* // ```sh
|
|
41134
|
+
* // $ gcloud auth application-default login
|
|
41135
|
+
* // ```
|
|
41136
|
+
* // - Install the npm module by running:
|
|
41137
|
+
* // ```sh
|
|
41138
|
+
* // $ npm install googleapis
|
|
41139
|
+
* // ```
|
|
41140
|
+
*
|
|
41141
|
+
* const {google} = require('googleapis');
|
|
41142
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
41143
|
+
*
|
|
41144
|
+
* async function main() {
|
|
41145
|
+
* const auth = new google.auth.GoogleAuth({
|
|
41146
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
41147
|
+
* scopes: [
|
|
41148
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
41149
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
41150
|
+
* ],
|
|
41151
|
+
* });
|
|
41152
|
+
*
|
|
41153
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
41154
|
+
* const authClient = await auth.getClient();
|
|
41155
|
+
* google.options({auth: authClient});
|
|
41156
|
+
*
|
|
41157
|
+
* // Do the magic
|
|
41158
|
+
* const res = await discoveryengine.projects.locations.dataStores.schemas.patch(
|
|
41159
|
+
* {
|
|
41160
|
+
* // If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
|
|
41161
|
+
* allowMissing: 'placeholder-value',
|
|
41162
|
+
* // Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
41163
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema',
|
|
41164
|
+
*
|
|
41165
|
+
* // Request body metadata
|
|
41166
|
+
* requestBody: {
|
|
41167
|
+
* // request body parameters
|
|
41168
|
+
* // {
|
|
41169
|
+
* // "fieldConfigs": [],
|
|
41170
|
+
* // "jsonSchema": "my_jsonSchema",
|
|
41171
|
+
* // "name": "my_name",
|
|
41172
|
+
* // "structSchema": {}
|
|
41173
|
+
* // }
|
|
41174
|
+
* },
|
|
41175
|
+
* },
|
|
41176
|
+
* );
|
|
41177
|
+
* console.log(res.data);
|
|
41178
|
+
*
|
|
41179
|
+
* // Example response
|
|
41180
|
+
* // {
|
|
41181
|
+
* // "done": false,
|
|
41182
|
+
* // "error": {},
|
|
41183
|
+
* // "metadata": {},
|
|
41184
|
+
* // "name": "my_name",
|
|
41185
|
+
* // "response": {}
|
|
41186
|
+
* // }
|
|
41187
|
+
* }
|
|
41188
|
+
*
|
|
41189
|
+
* main().catch(e => {
|
|
41190
|
+
* console.error(e);
|
|
41191
|
+
* throw e;
|
|
41192
|
+
* });
|
|
41193
|
+
*
|
|
41194
|
+
* ```
|
|
41195
|
+
*
|
|
41196
|
+
* @param params - Parameters for request
|
|
41197
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
41198
|
+
* @param callback - Optional callback that handles the response.
|
|
41199
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
41200
|
+
*/
|
|
41201
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41202
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
41203
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41204
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41205
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41206
|
+
patch(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41207
|
+
}
|
|
41208
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create extends StandardParameters {
|
|
41209
|
+
/**
|
|
41210
|
+
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
41211
|
+
*/
|
|
41212
|
+
parent?: string;
|
|
41213
|
+
/**
|
|
41214
|
+
* Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
|
41215
|
+
*/
|
|
41216
|
+
schemaId?: string;
|
|
41217
|
+
/**
|
|
41218
|
+
* Request body metadata
|
|
41219
|
+
*/
|
|
41220
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
41221
|
+
}
|
|
41222
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete extends StandardParameters {
|
|
41223
|
+
/**
|
|
41224
|
+
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
41225
|
+
*/
|
|
41226
|
+
name?: string;
|
|
41227
|
+
}
|
|
41228
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get extends StandardParameters {
|
|
41229
|
+
/**
|
|
41230
|
+
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
41231
|
+
*/
|
|
41232
|
+
name?: string;
|
|
41233
|
+
}
|
|
41234
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$List extends StandardParameters {
|
|
41235
|
+
/**
|
|
41236
|
+
* The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.
|
|
41237
|
+
*/
|
|
41238
|
+
pageSize?: number;
|
|
41239
|
+
/**
|
|
41240
|
+
* A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
|
|
41241
|
+
*/
|
|
41242
|
+
pageToken?: string;
|
|
41243
|
+
/**
|
|
41244
|
+
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
41245
|
+
*/
|
|
41246
|
+
parent?: string;
|
|
41247
|
+
}
|
|
41248
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch extends StandardParameters {
|
|
41249
|
+
/**
|
|
41250
|
+
* If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
|
|
41251
|
+
*/
|
|
41252
|
+
allowMissing?: boolean;
|
|
41253
|
+
/**
|
|
41254
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
41255
|
+
*/
|
|
41256
|
+
name?: string;
|
|
41257
|
+
/**
|
|
41258
|
+
* Request body metadata
|
|
41259
|
+
*/
|
|
41260
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
41261
|
+
}
|
|
41262
|
+
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
41263
|
+
context: APIRequestContext;
|
|
41264
|
+
constructor(context: APIRequestContext);
|
|
41265
|
+
/**
|
|
41266
|
+
* Answer query method.
|
|
41267
|
+
* @example
|
|
41268
|
+
* ```js
|
|
41269
|
+
* // Before running the sample:
|
|
41270
|
+
* // - Enable the API at:
|
|
41271
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
41272
|
+
* // - Login into gcloud by running:
|
|
41273
|
+
* // ```sh
|
|
41274
|
+
* // $ gcloud auth application-default login
|
|
41275
|
+
* // ```
|
|
41276
|
+
* // - Install the npm module by running:
|
|
41277
|
+
* // ```sh
|
|
41278
|
+
* // $ npm install googleapis
|
|
41279
|
+
* // ```
|
|
41280
|
+
*
|
|
41281
|
+
* const {google} = require('googleapis');
|
|
41282
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
41283
|
+
*
|
|
41284
|
+
* async function main() {
|
|
41285
|
+
* const auth = new google.auth.GoogleAuth({
|
|
41286
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
41287
|
+
* scopes: [
|
|
41288
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
41289
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
41290
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
41291
|
+
* ],
|
|
41292
|
+
* });
|
|
41293
|
+
*
|
|
41294
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
41295
|
+
* const authClient = await auth.getClient();
|
|
41296
|
+
* google.options({auth: authClient});
|
|
41297
|
+
*
|
|
41298
|
+
* // Do the magic
|
|
41299
|
+
* const res =
|
|
41300
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.answer({
|
|
41301
|
+
* // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
41302
|
+
* servingConfig:
|
|
41303
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
40563
41304
|
*
|
|
40564
|
-
*
|
|
40565
|
-
*
|
|
40566
|
-
*
|
|
40567
|
-
*
|
|
40568
|
-
*
|
|
40569
|
-
*
|
|
40570
|
-
*
|
|
40571
|
-
*
|
|
40572
|
-
* }
|
|
41305
|
+
* // Request body metadata
|
|
41306
|
+
* requestBody: {
|
|
41307
|
+
* // request body parameters
|
|
41308
|
+
* // {
|
|
41309
|
+
* // "answerGenerationSpec": {},
|
|
41310
|
+
* // "asynchronousMode": false,
|
|
41311
|
+
* // "endUserSpec": {},
|
|
41312
|
+
* // "groundingSpec": {},
|
|
41313
|
+
* // "query": {},
|
|
41314
|
+
* // "queryUnderstandingSpec": {},
|
|
41315
|
+
* // "relatedQuestionsSpec": {},
|
|
41316
|
+
* // "safetySpec": {},
|
|
41317
|
+
* // "searchSpec": {},
|
|
41318
|
+
* // "session": "my_session",
|
|
41319
|
+
* // "userLabels": {},
|
|
41320
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
41321
|
+
* // }
|
|
41322
|
+
* },
|
|
41323
|
+
* });
|
|
40573
41324
|
* console.log(res.data);
|
|
40574
41325
|
*
|
|
40575
41326
|
* // Example response
|
|
40576
41327
|
* // {
|
|
40577
|
-
* // "
|
|
40578
|
-
* // "
|
|
41328
|
+
* // "answer": {},
|
|
41329
|
+
* // "answerQueryToken": "my_answerQueryToken",
|
|
41330
|
+
* // "session": {}
|
|
40579
41331
|
* // }
|
|
40580
41332
|
* }
|
|
40581
41333
|
*
|
|
@@ -40591,14 +41343,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40591
41343
|
* @param callback - Optional callback that handles the response.
|
|
40592
41344
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40593
41345
|
*/
|
|
40594
|
-
|
|
40595
|
-
|
|
40596
|
-
|
|
40597
|
-
|
|
40598
|
-
|
|
40599
|
-
|
|
41346
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41347
|
+
answer(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>>;
|
|
41348
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41349
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
41350
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
41351
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
40600
41352
|
/**
|
|
40601
|
-
*
|
|
41353
|
+
* Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.
|
|
40602
41354
|
* @example
|
|
40603
41355
|
* ```js
|
|
40604
41356
|
* // Before running the sample:
|
|
@@ -40630,34 +41382,73 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40630
41382
|
* google.options({auth: authClient});
|
|
40631
41383
|
*
|
|
40632
41384
|
* // Do the magic
|
|
40633
|
-
* const res =
|
|
40634
|
-
* {
|
|
40635
|
-
* //
|
|
40636
|
-
*
|
|
40637
|
-
*
|
|
40638
|
-
* name
|
|
41385
|
+
* const res =
|
|
41386
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.create({
|
|
41387
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
41388
|
+
* parent:
|
|
41389
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
41390
|
+
* // Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
|
|
41391
|
+
* servingConfigId: 'placeholder-value',
|
|
40639
41392
|
*
|
|
40640
41393
|
* // Request body metadata
|
|
40641
41394
|
* requestBody: {
|
|
40642
41395
|
* // request body parameters
|
|
40643
41396
|
* // {
|
|
40644
|
-
* // "
|
|
40645
|
-
* // "
|
|
41397
|
+
* // "answerGenerationSpec": {},
|
|
41398
|
+
* // "boostControlIds": [],
|
|
41399
|
+
* // "createTime": "my_createTime",
|
|
41400
|
+
* // "customFineTuningSpec": {},
|
|
41401
|
+
* // "displayName": "my_displayName",
|
|
41402
|
+
* // "dissociateControlIds": [],
|
|
41403
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
41404
|
+
* // "embeddingConfig": {},
|
|
41405
|
+
* // "filterControlIds": [],
|
|
41406
|
+
* // "genericConfig": {},
|
|
41407
|
+
* // "guidedSearchSpec": {},
|
|
41408
|
+
* // "ignoreControlIds": [],
|
|
41409
|
+
* // "mediaConfig": {},
|
|
41410
|
+
* // "modelId": "my_modelId",
|
|
40646
41411
|
* // "name": "my_name",
|
|
40647
|
-
* // "
|
|
41412
|
+
* // "onewaySynonymsControlIds": [],
|
|
41413
|
+
* // "personalizationSpec": {},
|
|
41414
|
+
* // "promoteControlIds": [],
|
|
41415
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
41416
|
+
* // "redirectControlIds": [],
|
|
41417
|
+
* // "replacementControlIds": [],
|
|
41418
|
+
* // "solutionType": "my_solutionType",
|
|
41419
|
+
* // "synonymsControlIds": [],
|
|
41420
|
+
* // "updateTime": "my_updateTime"
|
|
40648
41421
|
* // }
|
|
40649
41422
|
* },
|
|
40650
|
-
* }
|
|
40651
|
-
* );
|
|
41423
|
+
* });
|
|
40652
41424
|
* console.log(res.data);
|
|
40653
41425
|
*
|
|
40654
41426
|
* // Example response
|
|
40655
41427
|
* // {
|
|
40656
|
-
* // "
|
|
40657
|
-
* // "
|
|
40658
|
-
* // "
|
|
41428
|
+
* // "answerGenerationSpec": {},
|
|
41429
|
+
* // "boostControlIds": [],
|
|
41430
|
+
* // "createTime": "my_createTime",
|
|
41431
|
+
* // "customFineTuningSpec": {},
|
|
41432
|
+
* // "displayName": "my_displayName",
|
|
41433
|
+
* // "dissociateControlIds": [],
|
|
41434
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
41435
|
+
* // "embeddingConfig": {},
|
|
41436
|
+
* // "filterControlIds": [],
|
|
41437
|
+
* // "genericConfig": {},
|
|
41438
|
+
* // "guidedSearchSpec": {},
|
|
41439
|
+
* // "ignoreControlIds": [],
|
|
41440
|
+
* // "mediaConfig": {},
|
|
41441
|
+
* // "modelId": "my_modelId",
|
|
40659
41442
|
* // "name": "my_name",
|
|
40660
|
-
* // "
|
|
41443
|
+
* // "onewaySynonymsControlIds": [],
|
|
41444
|
+
* // "personalizationSpec": {},
|
|
41445
|
+
* // "promoteControlIds": [],
|
|
41446
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
41447
|
+
* // "redirectControlIds": [],
|
|
41448
|
+
* // "replacementControlIds": [],
|
|
41449
|
+
* // "solutionType": "my_solutionType",
|
|
41450
|
+
* // "synonymsControlIds": [],
|
|
41451
|
+
* // "updateTime": "my_updateTime"
|
|
40661
41452
|
* // }
|
|
40662
41453
|
* }
|
|
40663
41454
|
*
|
|
@@ -40673,72 +41464,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40673
41464
|
* @param callback - Optional callback that handles the response.
|
|
40674
41465
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40675
41466
|
*/
|
|
40676
|
-
|
|
40677
|
-
|
|
40678
|
-
|
|
40679
|
-
|
|
40680
|
-
|
|
40681
|
-
|
|
40682
|
-
}
|
|
40683
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create extends StandardParameters {
|
|
40684
|
-
/**
|
|
40685
|
-
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
40686
|
-
*/
|
|
40687
|
-
parent?: string;
|
|
40688
|
-
/**
|
|
40689
|
-
* Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
|
40690
|
-
*/
|
|
40691
|
-
schemaId?: string;
|
|
41467
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41468
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
|
|
41469
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41470
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
41471
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
41472
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
|
|
40692
41473
|
/**
|
|
40693
|
-
*
|
|
40694
|
-
*/
|
|
40695
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
40696
|
-
}
|
|
40697
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete extends StandardParameters {
|
|
40698
|
-
/**
|
|
40699
|
-
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
40700
|
-
*/
|
|
40701
|
-
name?: string;
|
|
40702
|
-
}
|
|
40703
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get extends StandardParameters {
|
|
40704
|
-
/**
|
|
40705
|
-
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
40706
|
-
*/
|
|
40707
|
-
name?: string;
|
|
40708
|
-
}
|
|
40709
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$List extends StandardParameters {
|
|
40710
|
-
/**
|
|
40711
|
-
* The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.
|
|
40712
|
-
*/
|
|
40713
|
-
pageSize?: number;
|
|
40714
|
-
/**
|
|
40715
|
-
* A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
|
|
40716
|
-
*/
|
|
40717
|
-
pageToken?: string;
|
|
40718
|
-
/**
|
|
40719
|
-
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
40720
|
-
*/
|
|
40721
|
-
parent?: string;
|
|
40722
|
-
}
|
|
40723
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch extends StandardParameters {
|
|
40724
|
-
/**
|
|
40725
|
-
* If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
|
|
40726
|
-
*/
|
|
40727
|
-
allowMissing?: boolean;
|
|
40728
|
-
/**
|
|
40729
|
-
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
40730
|
-
*/
|
|
40731
|
-
name?: string;
|
|
40732
|
-
/**
|
|
40733
|
-
* Request body metadata
|
|
40734
|
-
*/
|
|
40735
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
|
|
40736
|
-
}
|
|
40737
|
-
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
40738
|
-
context: APIRequestContext;
|
|
40739
|
-
constructor(context: APIRequestContext);
|
|
40740
|
-
/**
|
|
40741
|
-
* Answer query method.
|
|
41474
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
40742
41475
|
* @example
|
|
40743
41476
|
* ```js
|
|
40744
41477
|
* // Before running the sample:
|
|
@@ -40761,7 +41494,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40761
41494
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40762
41495
|
* scopes: [
|
|
40763
41496
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40764
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
40765
41497
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40766
41498
|
* ],
|
|
40767
41499
|
* });
|
|
@@ -40772,38 +41504,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40772
41504
|
*
|
|
40773
41505
|
* // Do the magic
|
|
40774
41506
|
* const res =
|
|
40775
|
-
* await discoveryengine.projects.locations.dataStores.servingConfigs.
|
|
40776
|
-
* // Required. The resource name of the
|
|
40777
|
-
* servingConfig
|
|
40778
|
-
* 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
40779
|
-
*
|
|
40780
|
-
* // Request body metadata
|
|
40781
|
-
* requestBody: {
|
|
40782
|
-
* // request body parameters
|
|
40783
|
-
* // {
|
|
40784
|
-
* // "answerGenerationSpec": {},
|
|
40785
|
-
* // "asynchronousMode": false,
|
|
40786
|
-
* // "endUserSpec": {},
|
|
40787
|
-
* // "groundingSpec": {},
|
|
40788
|
-
* // "query": {},
|
|
40789
|
-
* // "queryUnderstandingSpec": {},
|
|
40790
|
-
* // "relatedQuestionsSpec": {},
|
|
40791
|
-
* // "safetySpec": {},
|
|
40792
|
-
* // "searchSpec": {},
|
|
40793
|
-
* // "session": "my_session",
|
|
40794
|
-
* // "userLabels": {},
|
|
40795
|
-
* // "userPseudoId": "my_userPseudoId"
|
|
40796
|
-
* // }
|
|
40797
|
-
* },
|
|
41507
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.delete({
|
|
41508
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
41509
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
40798
41510
|
* });
|
|
40799
41511
|
* console.log(res.data);
|
|
40800
41512
|
*
|
|
40801
41513
|
* // Example response
|
|
40802
|
-
* // {
|
|
40803
|
-
* // "answer": {},
|
|
40804
|
-
* // "answerQueryToken": "my_answerQueryToken",
|
|
40805
|
-
* // "session": {}
|
|
40806
|
-
* // }
|
|
41514
|
+
* // {}
|
|
40807
41515
|
* }
|
|
40808
41516
|
*
|
|
40809
41517
|
* main().catch(e => {
|
|
@@ -40818,12 +41526,12 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40818
41526
|
* @param callback - Optional callback that handles the response.
|
|
40819
41527
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40820
41528
|
*/
|
|
40821
|
-
|
|
40822
|
-
|
|
40823
|
-
|
|
40824
|
-
|
|
40825
|
-
|
|
40826
|
-
|
|
41529
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41530
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
41531
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41532
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
41533
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
41534
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
40827
41535
|
/**
|
|
40828
41536
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
40829
41537
|
* @example
|
|
@@ -41255,6 +41963,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
41255
41963
|
* // "rankingExpression": "my_rankingExpression",
|
|
41256
41964
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
41257
41965
|
* // "regionCode": "my_regionCode",
|
|
41966
|
+
* // "relevanceFilterSpec": {},
|
|
41258
41967
|
* // "relevanceScoreSpec": {},
|
|
41259
41968
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
41260
41969
|
* // "safeSearch": false,
|
|
@@ -41386,6 +42095,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
41386
42095
|
* // "rankingExpression": "my_rankingExpression",
|
|
41387
42096
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
41388
42097
|
* // "regionCode": "my_regionCode",
|
|
42098
|
+
* // "relevanceFilterSpec": {},
|
|
41389
42099
|
* // "relevanceScoreSpec": {},
|
|
41390
42100
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
41391
42101
|
* // "safeSearch": false,
|
|
@@ -41546,6 +42256,26 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
41546
42256
|
*/
|
|
41547
42257
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
41548
42258
|
}
|
|
42259
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
42260
|
+
/**
|
|
42261
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
42262
|
+
*/
|
|
42263
|
+
parent?: string;
|
|
42264
|
+
/**
|
|
42265
|
+
* Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
|
|
42266
|
+
*/
|
|
42267
|
+
servingConfigId?: string;
|
|
42268
|
+
/**
|
|
42269
|
+
* Request body metadata
|
|
42270
|
+
*/
|
|
42271
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
|
|
42272
|
+
}
|
|
42273
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
42274
|
+
/**
|
|
42275
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
42276
|
+
*/
|
|
42277
|
+
name?: string;
|
|
42278
|
+
}
|
|
41549
42279
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
41550
42280
|
/**
|
|
41551
42281
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|