@googleapis/discoveryengine 31.0.0 → 32.1.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 +18 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +186 -15
- package/build/v1.js +32 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +120 -16
- package/build/v1alpha.js +32 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +120 -15
- package/build/v1beta.js +32 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +268 -15
- package/v1alpha.ts +202 -16
- package/v1beta.ts +202 -15
package/build/v1.d.ts
CHANGED
|
@@ -2322,6 +2322,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2322
2322
|
* Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
|
|
2323
2323
|
*/
|
|
2324
2324
|
verdict?: string | null;
|
|
2325
|
+
/**
|
|
2326
|
+
* Output only. The source of the violation.
|
|
2327
|
+
*/
|
|
2328
|
+
violationSource?: string | null;
|
|
2325
2329
|
}
|
|
2326
2330
|
/**
|
|
2327
2331
|
* Customer policy enforcement result for the banned phrase policy.
|
|
@@ -3375,13 +3379,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
3375
3379
|
vpcscEnabled?: boolean | null;
|
|
3376
3380
|
}
|
|
3377
3381
|
/**
|
|
3378
|
-
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author,
|
|
3382
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
|
|
3379
3383
|
*/
|
|
3380
3384
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
|
|
3381
|
-
/**
|
|
3382
|
-
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
3383
|
-
*/
|
|
3384
|
-
authenticatedAccount?: string | null;
|
|
3385
3385
|
/**
|
|
3386
3386
|
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
3387
3387
|
*/
|
|
@@ -4221,7 +4221,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
4221
4221
|
*/
|
|
4222
4222
|
displayName?: string | null;
|
|
4223
4223
|
/**
|
|
4224
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `
|
|
4224
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
4225
4225
|
*/
|
|
4226
4226
|
features?: {
|
|
4227
4227
|
[key: string]: string;
|
|
@@ -7934,6 +7934,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7934
7934
|
* Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
|
|
7935
7935
|
*/
|
|
7936
7936
|
verdict?: string | null;
|
|
7937
|
+
/**
|
|
7938
|
+
* Output only. The source of the violation.
|
|
7939
|
+
*/
|
|
7940
|
+
violationSource?: string | null;
|
|
7937
7941
|
}
|
|
7938
7942
|
/**
|
|
7939
7943
|
* Customer policy enforcement result for the banned phrase policy.
|
|
@@ -8478,7 +8482,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
8478
8482
|
*/
|
|
8479
8483
|
deleteUnassignedUserLicenses?: boolean | null;
|
|
8480
8484
|
/**
|
|
8481
|
-
* The inline source for the input content for
|
|
8485
|
+
* The inline source for the input content for license assignment.
|
|
8482
8486
|
*/
|
|
8483
8487
|
inlineSource?: Schema$GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource;
|
|
8484
8488
|
}
|
|
@@ -9468,7 +9472,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
9468
9472
|
*/
|
|
9469
9473
|
displayName?: string | null;
|
|
9470
9474
|
/**
|
|
9471
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `
|
|
9475
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
9472
9476
|
*/
|
|
9473
9477
|
features?: {
|
|
9474
9478
|
[key: string]: string;
|
|
@@ -12701,13 +12705,9 @@ export declare namespace discoveryengine_v1 {
|
|
|
12701
12705
|
vpcscEnabled?: boolean | null;
|
|
12702
12706
|
}
|
|
12703
12707
|
/**
|
|
12704
|
-
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author,
|
|
12708
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
|
|
12705
12709
|
*/
|
|
12706
12710
|
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
|
|
12707
|
-
/**
|
|
12708
|
-
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
12709
|
-
*/
|
|
12710
|
-
authenticatedAccount?: string | null;
|
|
12711
12711
|
/**
|
|
12712
12712
|
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
12713
12713
|
*/
|
|
@@ -13635,7 +13635,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
13635
13635
|
*/
|
|
13636
13636
|
displayName?: string | null;
|
|
13637
13637
|
/**
|
|
13638
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `
|
|
13638
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
13639
13639
|
*/
|
|
13640
13640
|
features?: {
|
|
13641
13641
|
[key: string]: string;
|
|
@@ -15721,6 +15721,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
15721
15721
|
* Optional. The backend to use for the ranking expression evaluation.
|
|
15722
15722
|
*/
|
|
15723
15723
|
rankingExpressionBackend?: string | null;
|
|
15724
|
+
/**
|
|
15725
|
+
* 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.
|
|
15726
|
+
*/
|
|
15727
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpec;
|
|
15724
15728
|
/**
|
|
15725
15729
|
* Optional. The specification for returning the relevance score.
|
|
15726
15730
|
*/
|
|
@@ -16124,6 +16128,32 @@ export declare namespace discoveryengine_v1 {
|
|
|
16124
16128
|
*/
|
|
16125
16129
|
pinUnexpandedResults?: boolean | null;
|
|
16126
16130
|
}
|
|
16131
|
+
/**
|
|
16132
|
+
* Relevance filtering specification.
|
|
16133
|
+
*/
|
|
16134
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpec {
|
|
16135
|
+
/**
|
|
16136
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
16137
|
+
*/
|
|
16138
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
16139
|
+
/**
|
|
16140
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
16141
|
+
*/
|
|
16142
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
16143
|
+
}
|
|
16144
|
+
/**
|
|
16145
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
16146
|
+
*/
|
|
16147
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
16148
|
+
/**
|
|
16149
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
16150
|
+
*/
|
|
16151
|
+
relevanceThreshold?: string | null;
|
|
16152
|
+
/**
|
|
16153
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
16154
|
+
*/
|
|
16155
|
+
semanticRelevanceThreshold?: number | null;
|
|
16156
|
+
}
|
|
16127
16157
|
/**
|
|
16128
16158
|
* The specification for returning the document relevance score.
|
|
16129
16159
|
*/
|
|
@@ -16168,6 +16198,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
16168
16198
|
* Response message for SearchService.Search method.
|
|
16169
16199
|
*/
|
|
16170
16200
|
export interface Schema$GoogleCloudDiscoveryengineV1SearchResponse {
|
|
16201
|
+
/**
|
|
16202
|
+
* Optional. Controls applied as part of the Control service.
|
|
16203
|
+
*/
|
|
16204
|
+
appliedControls?: string[] | null;
|
|
16171
16205
|
/**
|
|
16172
16206
|
* A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.
|
|
16173
16207
|
*/
|
|
@@ -16430,6 +16464,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
16430
16464
|
* Optional. A set of ranking signals associated with the result.
|
|
16431
16465
|
*/
|
|
16432
16466
|
rankSignals?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals;
|
|
16467
|
+
/**
|
|
16468
|
+
* Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds.
|
|
16469
|
+
*/
|
|
16470
|
+
retrievalSignals?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResultRetrievalSignals;
|
|
16433
16471
|
}
|
|
16434
16472
|
/**
|
|
16435
16473
|
* A set of ranking signals.
|
|
@@ -16489,6 +16527,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
16489
16527
|
*/
|
|
16490
16528
|
value?: number | null;
|
|
16491
16529
|
}
|
|
16530
|
+
/**
|
|
16531
|
+
* Contains a set of signals used by the relevance filter.
|
|
16532
|
+
*/
|
|
16533
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResultRetrievalSignals {
|
|
16534
|
+
/**
|
|
16535
|
+
* Optional. Indicates how the result was retrieved.
|
|
16536
|
+
*/
|
|
16537
|
+
retrievalSources?: string[] | null;
|
|
16538
|
+
/**
|
|
16539
|
+
* Optional. Relevance score used by the filter when semantic_relevance_threshold is set.
|
|
16540
|
+
*/
|
|
16541
|
+
semanticRelevanceScore?: number | null;
|
|
16542
|
+
}
|
|
16492
16543
|
/**
|
|
16493
16544
|
* Information about the session.
|
|
16494
16545
|
*/
|
|
@@ -17752,6 +17803,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
17752
17803
|
* Output only. The display name of the data source.
|
|
17753
17804
|
*/
|
|
17754
17805
|
dataSourceDisplayName?: string | null;
|
|
17806
|
+
/**
|
|
17807
|
+
* Output only. The end-user-facing display name of the data source, sourced from `ConnectorSource.end_user_display_name`. When unset, clients fall back to `data_source_display_name`.
|
|
17808
|
+
*/
|
|
17809
|
+
dataSourceEndUserDisplayName?: string | null;
|
|
17810
|
+
/**
|
|
17811
|
+
* Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`.
|
|
17812
|
+
*/
|
|
17813
|
+
dataSourceVersion?: number | null;
|
|
17755
17814
|
/**
|
|
17756
17815
|
* For the data store collection, list of the children data stores.
|
|
17757
17816
|
*/
|
|
@@ -17764,6 +17823,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
17764
17823
|
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.
|
|
17765
17824
|
*/
|
|
17766
17825
|
id?: string | null;
|
|
17826
|
+
/**
|
|
17827
|
+
* Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector. Used by the frontend to group 1P vs 3P connectors. Sourced from `ConnectorSource.is_first_party` once that field is universally populated (b/534727761); until then derived from `ConnectorSource.connector_type == FIRST_PARTY`.
|
|
17828
|
+
*/
|
|
17829
|
+
isFirstParty?: boolean | null;
|
|
17830
|
+
/**
|
|
17831
|
+
* Output only. User-facing connector metadata (`title`, `description`, `short_description`, `author`, `note`), retrieved from the registry `ConnectorSource.metadata` (joined by data source). Shown on the connector detail page.
|
|
17832
|
+
*/
|
|
17833
|
+
metadata?: Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata;
|
|
17767
17834
|
/**
|
|
17768
17835
|
* The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.
|
|
17769
17836
|
*/
|
|
@@ -17995,7 +18062,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17995
18062
|
*/
|
|
17996
18063
|
enableVisualContentSummary?: boolean | null;
|
|
17997
18064
|
/**
|
|
17998
|
-
* Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `
|
|
18065
|
+
* Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
17999
18066
|
*/
|
|
18000
18067
|
features?: {
|
|
18001
18068
|
[key: string]: string;
|
|
@@ -18117,6 +18184,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
18117
18184
|
* Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI.
|
|
18118
18185
|
*/
|
|
18119
18186
|
isPreview?: boolean | null;
|
|
18187
|
+
/**
|
|
18188
|
+
* Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label.
|
|
18189
|
+
*/
|
|
18190
|
+
label?: string | null;
|
|
18120
18191
|
/**
|
|
18121
18192
|
* Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend.
|
|
18122
18193
|
*/
|
|
@@ -18901,6 +18972,84 @@ export declare namespace discoveryengine_v1 {
|
|
|
18901
18972
|
getCmekConfig(params: Params$Resource$Projects$Locations$Getcmekconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
18902
18973
|
getCmekConfig(params: Params$Resource$Projects$Locations$Getcmekconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
18903
18974
|
getCmekConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1CmekConfig>): void;
|
|
18975
|
+
/**
|
|
18976
|
+
* Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
|
|
18977
|
+
* @example
|
|
18978
|
+
* ```js
|
|
18979
|
+
* // Before running the sample:
|
|
18980
|
+
* // - Enable the API at:
|
|
18981
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
18982
|
+
* // - Login into gcloud by running:
|
|
18983
|
+
* // ```sh
|
|
18984
|
+
* // $ gcloud auth application-default login
|
|
18985
|
+
* // ```
|
|
18986
|
+
* // - Install the npm module by running:
|
|
18987
|
+
* // ```sh
|
|
18988
|
+
* // $ npm install googleapis
|
|
18989
|
+
* // ```
|
|
18990
|
+
*
|
|
18991
|
+
* const {google} = require('googleapis');
|
|
18992
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
18993
|
+
*
|
|
18994
|
+
* async function main() {
|
|
18995
|
+
* const auth = new google.auth.GoogleAuth({
|
|
18996
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
18997
|
+
* scopes: [
|
|
18998
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
18999
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
19000
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
19001
|
+
* ],
|
|
19002
|
+
* });
|
|
19003
|
+
*
|
|
19004
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
19005
|
+
* const authClient = await auth.getClient();
|
|
19006
|
+
* google.options({auth: authClient});
|
|
19007
|
+
*
|
|
19008
|
+
* // Do the magic
|
|
19009
|
+
* const res = await discoveryengine.projects.locations.provision({
|
|
19010
|
+
* // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
19011
|
+
* name: 'projects/my-project/locations/my-location',
|
|
19012
|
+
*
|
|
19013
|
+
* // Request body metadata
|
|
19014
|
+
* requestBody: {
|
|
19015
|
+
* // request body parameters
|
|
19016
|
+
* // {
|
|
19017
|
+
* // "acceptDataUseTerms": false,
|
|
19018
|
+
* // "dataUseTermsVersion": "my_dataUseTermsVersion",
|
|
19019
|
+
* // "saasParams": {}
|
|
19020
|
+
* // }
|
|
19021
|
+
* },
|
|
19022
|
+
* });
|
|
19023
|
+
* console.log(res.data);
|
|
19024
|
+
*
|
|
19025
|
+
* // Example response
|
|
19026
|
+
* // {
|
|
19027
|
+
* // "done": false,
|
|
19028
|
+
* // "error": {},
|
|
19029
|
+
* // "metadata": {},
|
|
19030
|
+
* // "name": "my_name",
|
|
19031
|
+
* // "response": {}
|
|
19032
|
+
* // }
|
|
19033
|
+
* }
|
|
19034
|
+
*
|
|
19035
|
+
* main().catch(e => {
|
|
19036
|
+
* console.error(e);
|
|
19037
|
+
* throw e;
|
|
19038
|
+
* });
|
|
19039
|
+
*
|
|
19040
|
+
* ```
|
|
19041
|
+
*
|
|
19042
|
+
* @param params - Parameters for request
|
|
19043
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
19044
|
+
* @param callback - Optional callback that handles the response.
|
|
19045
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
19046
|
+
*/
|
|
19047
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
19048
|
+
provision(params?: Params$Resource$Projects$Locations$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
19049
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
19050
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
19051
|
+
provision(params: Params$Resource$Projects$Locations$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
19052
|
+
provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
18904
19053
|
/**
|
|
18905
19054
|
* Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
|
|
18906
19055
|
* @example
|
|
@@ -19279,6 +19428,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
19279
19428
|
*/
|
|
19280
19429
|
name?: string;
|
|
19281
19430
|
}
|
|
19431
|
+
export interface Params$Resource$Projects$Locations$Provision extends StandardParameters {
|
|
19432
|
+
/**
|
|
19433
|
+
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
19434
|
+
*/
|
|
19435
|
+
name?: string;
|
|
19436
|
+
/**
|
|
19437
|
+
* Request body metadata
|
|
19438
|
+
*/
|
|
19439
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ProvisionProjectRequest;
|
|
19440
|
+
}
|
|
19282
19441
|
export interface Params$Resource$Projects$Locations$Setupdataconnector extends StandardParameters {
|
|
19283
19442
|
/**
|
|
19284
19443
|
* Required. The parent of Collection, in the format of `projects/{project\}/locations/{location\}`.
|
|
@@ -25241,6 +25400,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25241
25400
|
* // "queryExpansionSpec": {},
|
|
25242
25401
|
* // "rankingExpression": "my_rankingExpression",
|
|
25243
25402
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
25403
|
+
* // "relevanceFilterSpec": {},
|
|
25244
25404
|
* // "relevanceScoreSpec": {},
|
|
25245
25405
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
25246
25406
|
* // "safeSearch": false,
|
|
@@ -25259,6 +25419,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25259
25419
|
*
|
|
25260
25420
|
* // Example response
|
|
25261
25421
|
* // {
|
|
25422
|
+
* // "appliedControls": [],
|
|
25262
25423
|
* // "attributionToken": "my_attributionToken",
|
|
25263
25424
|
* // "correctedQuery": "my_correctedQuery",
|
|
25264
25425
|
* // "facets": [],
|
|
@@ -25365,6 +25526,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25365
25526
|
* // "queryExpansionSpec": {},
|
|
25366
25527
|
* // "rankingExpression": "my_rankingExpression",
|
|
25367
25528
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
25529
|
+
* // "relevanceFilterSpec": {},
|
|
25368
25530
|
* // "relevanceScoreSpec": {},
|
|
25369
25531
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
25370
25532
|
* // "safeSearch": false,
|
|
@@ -25383,6 +25545,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25383
25545
|
*
|
|
25384
25546
|
* // Example response
|
|
25385
25547
|
* // {
|
|
25548
|
+
* // "appliedControls": [],
|
|
25386
25549
|
* // "attributionToken": "my_attributionToken",
|
|
25387
25550
|
* // "correctedQuery": "my_correctedQuery",
|
|
25388
25551
|
* // "facets": [],
|
|
@@ -33047,6 +33210,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33047
33210
|
* // "queryExpansionSpec": {},
|
|
33048
33211
|
* // "rankingExpression": "my_rankingExpression",
|
|
33049
33212
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
33213
|
+
* // "relevanceFilterSpec": {},
|
|
33050
33214
|
* // "relevanceScoreSpec": {},
|
|
33051
33215
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
33052
33216
|
* // "safeSearch": false,
|
|
@@ -33065,6 +33229,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33065
33229
|
*
|
|
33066
33230
|
* // Example response
|
|
33067
33231
|
* // {
|
|
33232
|
+
* // "appliedControls": [],
|
|
33068
33233
|
* // "attributionToken": "my_attributionToken",
|
|
33069
33234
|
* // "correctedQuery": "my_correctedQuery",
|
|
33070
33235
|
* // "facets": [],
|
|
@@ -33171,6 +33336,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33171
33336
|
* // "queryExpansionSpec": {},
|
|
33172
33337
|
* // "rankingExpression": "my_rankingExpression",
|
|
33173
33338
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
33339
|
+
* // "relevanceFilterSpec": {},
|
|
33174
33340
|
* // "relevanceScoreSpec": {},
|
|
33175
33341
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
33176
33342
|
* // "safeSearch": false,
|
|
@@ -33189,6 +33355,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33189
33355
|
*
|
|
33190
33356
|
* // Example response
|
|
33191
33357
|
* // {
|
|
33358
|
+
* // "appliedControls": [],
|
|
33192
33359
|
* // "attributionToken": "my_attributionToken",
|
|
33193
33360
|
* // "correctedQuery": "my_correctedQuery",
|
|
33194
33361
|
* // "facets": [],
|
|
@@ -38967,6 +39134,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38967
39134
|
* // "queryExpansionSpec": {},
|
|
38968
39135
|
* // "rankingExpression": "my_rankingExpression",
|
|
38969
39136
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
39137
|
+
* // "relevanceFilterSpec": {},
|
|
38970
39138
|
* // "relevanceScoreSpec": {},
|
|
38971
39139
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
38972
39140
|
* // "safeSearch": false,
|
|
@@ -38984,6 +39152,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38984
39152
|
*
|
|
38985
39153
|
* // Example response
|
|
38986
39154
|
* // {
|
|
39155
|
+
* // "appliedControls": [],
|
|
38987
39156
|
* // "attributionToken": "my_attributionToken",
|
|
38988
39157
|
* // "correctedQuery": "my_correctedQuery",
|
|
38989
39158
|
* // "facets": [],
|
|
@@ -39090,6 +39259,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
39090
39259
|
* // "queryExpansionSpec": {},
|
|
39091
39260
|
* // "rankingExpression": "my_rankingExpression",
|
|
39092
39261
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
39262
|
+
* // "relevanceFilterSpec": {},
|
|
39093
39263
|
* // "relevanceScoreSpec": {},
|
|
39094
39264
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
39095
39265
|
* // "safeSearch": false,
|
|
@@ -39108,6 +39278,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
39108
39278
|
*
|
|
39109
39279
|
* // Example response
|
|
39110
39280
|
* // {
|
|
39281
|
+
* // "appliedControls": [],
|
|
39111
39282
|
* // "attributionToken": "my_attributionToken",
|
|
39112
39283
|
* // "correctedQuery": "my_correctedQuery",
|
|
39113
39284
|
* // "facets": [],
|
package/build/v1.js
CHANGED
|
@@ -266,6 +266,38 @@ var discoveryengine_v1;
|
|
|
266
266
|
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
267
267
|
}
|
|
268
268
|
}
|
|
269
|
+
provision(paramsOrCallback, optionsOrCallback, callback) {
|
|
270
|
+
let params = (paramsOrCallback ||
|
|
271
|
+
{});
|
|
272
|
+
let options = (optionsOrCallback || {});
|
|
273
|
+
if (typeof paramsOrCallback === 'function') {
|
|
274
|
+
callback = paramsOrCallback;
|
|
275
|
+
params = {};
|
|
276
|
+
options = {};
|
|
277
|
+
}
|
|
278
|
+
if (typeof optionsOrCallback === 'function') {
|
|
279
|
+
callback = optionsOrCallback;
|
|
280
|
+
options = {};
|
|
281
|
+
}
|
|
282
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
283
|
+
const parameters = {
|
|
284
|
+
options: Object.assign({
|
|
285
|
+
url: (rootUrl + '/v1/{+name}:provision').replace(/([^:]\/)\/+/g, '$1'),
|
|
286
|
+
method: 'POST',
|
|
287
|
+
apiVersion: '',
|
|
288
|
+
}, options),
|
|
289
|
+
params,
|
|
290
|
+
requiredParams: ['name'],
|
|
291
|
+
pathParams: ['name'],
|
|
292
|
+
context: this.context,
|
|
293
|
+
};
|
|
294
|
+
if (callback) {
|
|
295
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
296
|
+
}
|
|
297
|
+
else {
|
|
298
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
299
|
+
}
|
|
300
|
+
}
|
|
269
301
|
setUpDataConnector(paramsOrCallback, optionsOrCallback, callback) {
|
|
270
302
|
let params = (paramsOrCallback ||
|
|
271
303
|
{});
|