@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.3.20260804 → 0.3.20260815
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +82 -12
- package/package.json +1 -1
- package/readme.md +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260815
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -392,7 +392,10 @@ declare namespace gapi.client {
|
|
|
392
392
|
document?: GoogleCloudDiscoveryengineV1alphaDocument;
|
|
393
393
|
/** The type of the person. */
|
|
394
394
|
personType?:
|
|
395
|
-
|
|
395
|
+
| 'PERSON_TYPE_UNSPECIFIED'
|
|
396
|
+
| 'CLOUD_IDENTITY'
|
|
397
|
+
| 'THIRD_PARTY_IDENTITY'
|
|
398
|
+
| 'GOOGLE_GROUP';
|
|
396
399
|
/** The score of each suggestion. The score is in the range of [0, 1]. */
|
|
397
400
|
score?: number;
|
|
398
401
|
/** The suggestion for the query. */
|
|
@@ -1208,6 +1211,9 @@ declare namespace gapi.client {
|
|
|
1208
1211
|
policyResults?: GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
|
|
1209
1212
|
/** Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. */
|
|
1210
1213
|
verdict?: 'UNSPECIFIED' | 'ALLOW' | 'BLOCK';
|
|
1214
|
+
/** Output only. The source of the violation. */
|
|
1215
|
+
violationSource?:
|
|
1216
|
+
'VIOLATION_SOURCE_UNSPECIFIED' | 'SYSTEM' | 'PROMPT' | 'ATTACHMENT';
|
|
1211
1217
|
}
|
|
1212
1218
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
|
|
1213
1219
|
/** The banned phrases that were found in the query or the answer. */
|
|
@@ -1513,7 +1519,7 @@ declare namespace gapi.client {
|
|
|
1513
1519
|
interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest {
|
|
1514
1520
|
/** Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. */
|
|
1515
1521
|
deleteUnassignedUserLicenses?: boolean;
|
|
1516
|
-
/** The inline source for the input content for
|
|
1522
|
+
/** The inline source for the input content for license assignment. */
|
|
1517
1523
|
inlineSource?: GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource;
|
|
1518
1524
|
}
|
|
1519
1525
|
interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource {
|
|
@@ -2464,8 +2470,6 @@ declare namespace gapi.client {
|
|
|
2464
2470
|
vpcscEnabled?: boolean;
|
|
2465
2471
|
}
|
|
2466
2472
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
|
|
2467
|
-
/** 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. */
|
|
2468
|
-
authenticatedAccount?: string;
|
|
2469
2473
|
/** 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). */
|
|
2470
2474
|
author?: string;
|
|
2471
2475
|
/** Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. */
|
|
@@ -2976,7 +2980,7 @@ declare namespace gapi.client {
|
|
|
2976
2980
|
disableAnalytics?: boolean;
|
|
2977
2981
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2978
2982
|
displayName?: string;
|
|
2979
|
-
/** 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` * `
|
|
2983
|
+
/** 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` */
|
|
2980
2984
|
features?: {
|
|
2981
2985
|
[P in string]:
|
|
2982
2986
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -5180,7 +5184,7 @@ declare namespace gapi.client {
|
|
|
5180
5184
|
mode?: 'MODE_UNSPECIFIED' | 'SUGGESTION_ONLY' | 'AUTO';
|
|
5181
5185
|
}
|
|
5182
5186
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponse {
|
|
5183
|
-
/** Controls applied as part of the Control service. */
|
|
5187
|
+
/** Optional. Controls applied as part of the Control service. */
|
|
5184
5188
|
appliedControls?: string[];
|
|
5185
5189
|
/** 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. */
|
|
5186
5190
|
attributionToken?: string;
|
|
@@ -6173,12 +6177,20 @@ declare namespace gapi.client {
|
|
|
6173
6177
|
dataSource?: string;
|
|
6174
6178
|
/** Output only. The display name of the data source. */
|
|
6175
6179
|
dataSourceDisplayName?: string;
|
|
6180
|
+
/** 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`. */
|
|
6181
|
+
dataSourceEndUserDisplayName?: string;
|
|
6182
|
+
/** Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`. */
|
|
6183
|
+
dataSourceVersion?: number;
|
|
6176
6184
|
/** For the data store collection, list of the children data stores. */
|
|
6177
6185
|
dataStoreComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
|
|
6178
6186
|
/** The display name of the collection. */
|
|
6179
6187
|
displayName?: string;
|
|
6180
6188
|
/** 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. */
|
|
6181
6189
|
id?: string;
|
|
6190
|
+
/** 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`. */
|
|
6191
|
+
isFirstParty?: boolean;
|
|
6192
|
+
/** 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. */
|
|
6193
|
+
metadata?: GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata;
|
|
6182
6194
|
/** 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. */
|
|
6183
6195
|
name?: string;
|
|
6184
6196
|
}
|
|
@@ -6318,7 +6330,7 @@ declare namespace gapi.client {
|
|
|
6318
6330
|
enableSearchAsYouType?: boolean;
|
|
6319
6331
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
6320
6332
|
enableVisualContentSummary?: boolean;
|
|
6321
|
-
/** 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` * `
|
|
6333
|
+
/** 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` */
|
|
6322
6334
|
features?: {
|
|
6323
6335
|
[P in string]:
|
|
6324
6336
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -6395,6 +6407,8 @@ declare namespace gapi.client {
|
|
|
6395
6407
|
icon?: string;
|
|
6396
6408
|
/** Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. */
|
|
6397
6409
|
isPreview?: boolean;
|
|
6410
|
+
/** 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. */
|
|
6411
|
+
label?: string;
|
|
6398
6412
|
/** 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. */
|
|
6399
6413
|
modelId?: string;
|
|
6400
6414
|
}
|
|
@@ -7076,7 +7090,7 @@ declare namespace gapi.client {
|
|
|
7076
7090
|
disableAnalytics?: boolean;
|
|
7077
7091
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
7078
7092
|
displayName?: string;
|
|
7079
|
-
/** 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` * `
|
|
7093
|
+
/** 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` */
|
|
7080
7094
|
features?: {
|
|
7081
7095
|
[P in string]:
|
|
7082
7096
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -8510,8 +8524,6 @@ declare namespace gapi.client {
|
|
|
8510
8524
|
vpcscEnabled?: boolean;
|
|
8511
8525
|
}
|
|
8512
8526
|
interface GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
|
|
8513
|
-
/** 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. */
|
|
8514
|
-
authenticatedAccount?: string;
|
|
8515
8527
|
/** 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). */
|
|
8516
8528
|
author?: string;
|
|
8517
8529
|
/** Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. */
|
|
@@ -8880,7 +8892,7 @@ declare namespace gapi.client {
|
|
|
8880
8892
|
disableAnalytics?: boolean;
|
|
8881
8893
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
8882
8894
|
displayName?: string;
|
|
8883
|
-
/** 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` * `
|
|
8895
|
+
/** 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` */
|
|
8884
8896
|
features?: {
|
|
8885
8897
|
[P in string]:
|
|
8886
8898
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -26235,6 +26247,64 @@ declare namespace gapi.client {
|
|
|
26235
26247
|
},
|
|
26236
26248
|
body: GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest,
|
|
26237
26249
|
): Request<GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>;
|
|
26250
|
+
/** 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. */
|
|
26251
|
+
provision(request: {
|
|
26252
|
+
/** V1 error format. */
|
|
26253
|
+
'$.xgafv'?: '1' | '2';
|
|
26254
|
+
/** OAuth access token. */
|
|
26255
|
+
access_token?: string;
|
|
26256
|
+
/** Data format for response. */
|
|
26257
|
+
alt?: 'json' | 'media' | 'proto';
|
|
26258
|
+
/** JSONP */
|
|
26259
|
+
callback?: string;
|
|
26260
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26261
|
+
fields?: string;
|
|
26262
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
26263
|
+
key?: string;
|
|
26264
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
26265
|
+
name: string;
|
|
26266
|
+
/** OAuth 2.0 token for the current user. */
|
|
26267
|
+
oauth_token?: string;
|
|
26268
|
+
/** Returns response with indentations and line breaks. */
|
|
26269
|
+
prettyPrint?: boolean;
|
|
26270
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
26271
|
+
quotaUser?: string;
|
|
26272
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26273
|
+
upload_protocol?: string;
|
|
26274
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26275
|
+
uploadType?: string;
|
|
26276
|
+
/** Request body */
|
|
26277
|
+
resource: GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
|
|
26278
|
+
}): Request<GoogleLongrunningOperation>;
|
|
26279
|
+
provision(
|
|
26280
|
+
request: {
|
|
26281
|
+
/** V1 error format. */
|
|
26282
|
+
'$.xgafv'?: '1' | '2';
|
|
26283
|
+
/** OAuth access token. */
|
|
26284
|
+
access_token?: string;
|
|
26285
|
+
/** Data format for response. */
|
|
26286
|
+
alt?: 'json' | 'media' | 'proto';
|
|
26287
|
+
/** JSONP */
|
|
26288
|
+
callback?: string;
|
|
26289
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26290
|
+
fields?: string;
|
|
26291
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
26292
|
+
key?: string;
|
|
26293
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
26294
|
+
name: string;
|
|
26295
|
+
/** OAuth 2.0 token for the current user. */
|
|
26296
|
+
oauth_token?: string;
|
|
26297
|
+
/** Returns response with indentations and line breaks. */
|
|
26298
|
+
prettyPrint?: boolean;
|
|
26299
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
26300
|
+
quotaUser?: string;
|
|
26301
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26302
|
+
upload_protocol?: string;
|
|
26303
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26304
|
+
uploadType?: string;
|
|
26305
|
+
},
|
|
26306
|
+
body: GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest,
|
|
26307
|
+
): Request<GoogleLongrunningOperation>;
|
|
26238
26308
|
/** Queries configurable pricing usage stats for a project. */
|
|
26239
26309
|
queryConfigurablePricingUsageStats(request?: {
|
|
26240
26310
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -71,7 +71,7 @@ var client_id = '',
|
|
|
71
71
|
// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
|
|
72
72
|
'https://www.googleapis.com/auth/cloud-platform',
|
|
73
73
|
|
|
74
|
-
// View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf.
|
|
74
|
+
// View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf. Also view the artifacts you access through NotebookLM Enterprise.
|
|
75
75
|
'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
76
76
|
|
|
77
77
|
// View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data.
|