@googleapis/discoveryengine 37.0.0 → 37.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 +14 -0
- package/build/index.js +0 -1
- package/build/index.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +148 -5
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +1434 -31
- package/build/v1alpha.js +331 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +119 -5
- package/build/v1beta.js.map +1 -1
- package/index.ts +0 -1
- package/package.json +1 -1
- package/tsconfig.build.json +10 -0
- package/v1.ts +144 -5
- package/v1alpha.ts +2447 -262
- package/v1beta.ts +115 -5
package/v1beta.ts
CHANGED
|
@@ -1420,6 +1420,10 @@ export namespace discoveryengine_v1beta {
|
|
|
1420
1420
|
* Reasons for not answering the assist call.
|
|
1421
1421
|
*/
|
|
1422
1422
|
assistSkippedReasons?: string[] | null;
|
|
1423
|
+
/**
|
|
1424
|
+
* Output only. Maps an internal connector agent name (the machine identifier embedded in tool names, e.g. `custom_mcp__agent`) to the connector's human-readable display name. Populated at serving time for custom MCP / agent gateway connectors so user-facing surfaces (e.g. the tool-call chip) can show the connector name instead of its internal identifier. Empty when there are no such connectors.
|
|
1425
|
+
*/
|
|
1426
|
+
connectorDisplayNames?: {[key: string]: string} | null;
|
|
1423
1427
|
/**
|
|
1424
1428
|
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
|
|
1425
1429
|
*/
|
|
@@ -2492,7 +2496,7 @@ export namespace discoveryengine_v1beta {
|
|
|
2492
2496
|
*/
|
|
2493
2497
|
syncMode?: string | null;
|
|
2494
2498
|
/**
|
|
2495
|
-
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
2499
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits `tag`, the server auto-derives one from the collection_id (falling back to data_source, else a time-based `t-` sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
2496
2500
|
*/
|
|
2497
2501
|
tag?: string | null;
|
|
2498
2502
|
/**
|
|
@@ -4107,6 +4111,10 @@ export namespace discoveryengine_v1beta {
|
|
|
4107
4111
|
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
4108
4112
|
*/
|
|
4109
4113
|
autoRenew?: boolean | null;
|
|
4114
|
+
/**
|
|
4115
|
+
* Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
|
|
4116
|
+
*/
|
|
4117
|
+
billingAccountLicenseConfig?: string | null;
|
|
4110
4118
|
/**
|
|
4111
4119
|
* Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
|
|
4112
4120
|
*/
|
|
@@ -4378,6 +4386,10 @@ export namespace discoveryengine_v1beta {
|
|
|
4378
4386
|
* Optional. Configuration for NotebookLM settings.
|
|
4379
4387
|
*/
|
|
4380
4388
|
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
4389
|
+
/**
|
|
4390
|
+
* Optional. Resource-level access control config for Gemini Enterprise users.
|
|
4391
|
+
*/
|
|
4392
|
+
resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
4381
4393
|
}
|
|
4382
4394
|
/**
|
|
4383
4395
|
* Configuration for NotebookLM.
|
|
@@ -4431,6 +4443,15 @@ export namespace discoveryengine_v1beta {
|
|
|
4431
4443
|
*/
|
|
4432
4444
|
userPromptTemplate?: string | null;
|
|
4433
4445
|
}
|
|
4446
|
+
/**
|
|
4447
|
+
* Controls resource-level access control for Gemini Enterprise users.
|
|
4448
|
+
*/
|
|
4449
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
4450
|
+
/**
|
|
4451
|
+
* Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
|
|
4452
|
+
*/
|
|
4453
|
+
dataStoreAccessControlEnabled?: boolean | null;
|
|
4454
|
+
}
|
|
4434
4455
|
/**
|
|
4435
4456
|
* Metadata about the terms of service.
|
|
4436
4457
|
*/
|
|
@@ -4675,6 +4696,10 @@ export namespace discoveryengine_v1beta {
|
|
|
4675
4696
|
* This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
|
|
4676
4697
|
*/
|
|
4677
4698
|
uiJsonPayload?: string | null;
|
|
4699
|
+
/**
|
|
4700
|
+
* Reference to a user-supplied file attached to a long-running-agent (Sobi) task. See `UserSuppliedSobiArtifactReference` above.
|
|
4701
|
+
*/
|
|
4702
|
+
userSuppliedSobiArtifactReference?: Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference;
|
|
4678
4703
|
}
|
|
4679
4704
|
/**
|
|
4680
4705
|
* Represents a document reference.
|
|
@@ -4767,6 +4792,19 @@ export namespace discoveryengine_v1beta {
|
|
|
4767
4792
|
*/
|
|
4768
4793
|
personId?: string | null;
|
|
4769
4794
|
}
|
|
4795
|
+
/**
|
|
4796
|
+
* Reference to a user-supplied file attached to a long-running-agent (Sobi) task. Rendered by the client as an attachment chip on the user turn's bubble. The file itself is stored on the task's `AgentArtifact` list; the client resolves full metadata (source URI, size, ...) for download or preview by calling `GetTask` on the Sobi Task API and matching `AgentArtifact.name` against `file_name`. Only `file_name` and `mime_type` appear on this wire deliberately: the backing `gs://` or Drive URI is not exposed to conversation-history readers. Same variant is used for both byte-uploaded and Drive-picked files -- "user attached a file" is one concept regardless of source.
|
|
4797
|
+
*/
|
|
4798
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference {
|
|
4799
|
+
/**
|
|
4800
|
+
* Required. Client-supplied filename. Unique per task within the user-supplied artifact set (UI dedupes before upload). Doubles as the artifact identifier used to look up the artifact on `Task.artifacts`. The `_name` suffix is deliberate and the AIP-122 lint is suppressed: this field is not a resource name (which is what AIP-122 reserves the bare `name` for). It is the literal filename, and it serves as the join key against `AgentArtifact.name` on the backing Sobi task -- a structural role that `title` or `display_name` would not communicate to a client picking what to send. The internal mirror (`cloud/ml/discoveryengine/schema/assistant.proto`) uses the same field name so the round-trip converter stays name-for-name.
|
|
4801
|
+
*/
|
|
4802
|
+
fileName?: string | null;
|
|
4803
|
+
/**
|
|
4804
|
+
* Optional. IANA MIME type. Used for icon/preview rendering.
|
|
4805
|
+
*/
|
|
4806
|
+
mimeType?: string | null;
|
|
4807
|
+
}
|
|
4770
4808
|
/**
|
|
4771
4809
|
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4772
4810
|
*/
|
|
@@ -5648,6 +5686,27 @@ export namespace discoveryengine_v1beta {
|
|
|
5648
5686
|
* The condition under which search as you type should occur. Default to Condition.DISABLED.
|
|
5649
5687
|
*/
|
|
5650
5688
|
condition?: string | null;
|
|
5689
|
+
/**
|
|
5690
|
+
* Optional. The list of fields to be used for Search As You Type scoring.
|
|
5691
|
+
*/
|
|
5692
|
+
fields?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField[];
|
|
5693
|
+
/**
|
|
5694
|
+
* Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
|
|
5695
|
+
*/
|
|
5696
|
+
scoreThreshold?: number | null;
|
|
5697
|
+
}
|
|
5698
|
+
/**
|
|
5699
|
+
* A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.
|
|
5700
|
+
*/
|
|
5701
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField {
|
|
5702
|
+
/**
|
|
5703
|
+
* Required. A field key that has been indexed for Search As You Type.
|
|
5704
|
+
*/
|
|
5705
|
+
key?: string | null;
|
|
5706
|
+
/**
|
|
5707
|
+
* Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
|
|
5708
|
+
*/
|
|
5709
|
+
weight?: number | null;
|
|
5651
5710
|
}
|
|
5652
5711
|
/**
|
|
5653
5712
|
* Session specification.
|
|
@@ -7623,6 +7682,10 @@ export namespace discoveryengine_v1beta {
|
|
|
7623
7682
|
* Reasons for not answering the assist call.
|
|
7624
7683
|
*/
|
|
7625
7684
|
assistSkippedReasons?: string[] | null;
|
|
7685
|
+
/**
|
|
7686
|
+
* Output only. Maps an internal connector agent name (the machine identifier embedded in tool names, e.g. `custom_mcp__agent`) to the connector's human-readable display name. Populated at serving time for custom MCP / agent gateway connectors so user-facing surfaces (e.g. the tool-call chip) can show the connector name instead of its internal identifier. Empty when there are no such connectors.
|
|
7687
|
+
*/
|
|
7688
|
+
connectorDisplayNames?: {[key: string]: string} | null;
|
|
7626
7689
|
/**
|
|
7627
7690
|
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
|
|
7628
7691
|
*/
|
|
@@ -8673,7 +8736,7 @@ export namespace discoveryengine_v1beta {
|
|
|
8673
8736
|
*/
|
|
8674
8737
|
selectedPosition?: number | null;
|
|
8675
8738
|
/**
|
|
8676
|
-
* End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
8739
|
+
* Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
8677
8740
|
*/
|
|
8678
8741
|
selectedSuggestion?: string | null;
|
|
8679
8742
|
}
|
|
@@ -11555,6 +11618,10 @@ export namespace discoveryengine_v1beta {
|
|
|
11555
11618
|
* Optional. Configuration for NotebookLM settings.
|
|
11556
11619
|
*/
|
|
11557
11620
|
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
11621
|
+
/**
|
|
11622
|
+
* Optional. Resource-level access control config for Gemini Enterprise users.
|
|
11623
|
+
*/
|
|
11624
|
+
resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
11558
11625
|
}
|
|
11559
11626
|
/**
|
|
11560
11627
|
* Configuration for NotebookLM.
|
|
@@ -11608,6 +11675,15 @@ export namespace discoveryengine_v1beta {
|
|
|
11608
11675
|
*/
|
|
11609
11676
|
userPromptTemplate?: string | null;
|
|
11610
11677
|
}
|
|
11678
|
+
/**
|
|
11679
|
+
* Controls resource-level access control for Gemini Enterprise users.
|
|
11680
|
+
*/
|
|
11681
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
11682
|
+
/**
|
|
11683
|
+
* Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
|
|
11684
|
+
*/
|
|
11685
|
+
dataStoreAccessControlEnabled?: boolean | null;
|
|
11686
|
+
}
|
|
11611
11687
|
/**
|
|
11612
11688
|
* Metadata about the terms of service.
|
|
11613
11689
|
*/
|
|
@@ -12278,7 +12354,7 @@ export namespace discoveryengine_v1beta {
|
|
|
12278
12354
|
*/
|
|
12279
12355
|
orderBy?: string | null;
|
|
12280
12356
|
/**
|
|
12281
|
-
* The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
12357
|
+
* Optional. The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
12282
12358
|
*/
|
|
12283
12359
|
searchQuery?: string | null;
|
|
12284
12360
|
}
|
|
@@ -12948,6 +13024,27 @@ export namespace discoveryengine_v1beta {
|
|
|
12948
13024
|
* The condition under which search as you type should occur. Default to Condition.DISABLED.
|
|
12949
13025
|
*/
|
|
12950
13026
|
condition?: string | null;
|
|
13027
|
+
/**
|
|
13028
|
+
* Optional. The list of fields to be used for Search As You Type scoring.
|
|
13029
|
+
*/
|
|
13030
|
+
fields?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField[];
|
|
13031
|
+
/**
|
|
13032
|
+
* Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
|
|
13033
|
+
*/
|
|
13034
|
+
scoreThreshold?: number | null;
|
|
13035
|
+
}
|
|
13036
|
+
/**
|
|
13037
|
+
* A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.
|
|
13038
|
+
*/
|
|
13039
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField {
|
|
13040
|
+
/**
|
|
13041
|
+
* Required. A field key that has been indexed for Search As You Type.
|
|
13042
|
+
*/
|
|
13043
|
+
key?: string | null;
|
|
13044
|
+
/**
|
|
13045
|
+
* Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
|
|
13046
|
+
*/
|
|
13047
|
+
weight?: number | null;
|
|
12951
13048
|
}
|
|
12952
13049
|
/**
|
|
12953
13050
|
* Session specification.
|
|
@@ -14304,7 +14401,7 @@ export namespace discoveryengine_v1beta {
|
|
|
14304
14401
|
*/
|
|
14305
14402
|
export interface Schema$GoogleCloudDiscoveryengineV1betaUserEvent {
|
|
14306
14403
|
/**
|
|
14307
|
-
* Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
|
|
14404
|
+
* Optional. Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
|
|
14308
14405
|
*/
|
|
14309
14406
|
attributes?: {
|
|
14310
14407
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute;
|
|
@@ -15023,7 +15120,7 @@ export namespace discoveryengine_v1beta {
|
|
|
15023
15120
|
*/
|
|
15024
15121
|
syncMode?: string | null;
|
|
15025
15122
|
/**
|
|
15026
|
-
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
15123
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits `tag`, the server auto-derives one from the collection_id (falling back to data_source, else a time-based `t-` sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
15027
15124
|
*/
|
|
15028
15125
|
tag?: string | null;
|
|
15029
15126
|
/**
|
|
@@ -16435,6 +16532,10 @@ export namespace discoveryengine_v1beta {
|
|
|
16435
16532
|
* Optional. Configuration for NotebookLM settings.
|
|
16436
16533
|
*/
|
|
16437
16534
|
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
|
|
16535
|
+
/**
|
|
16536
|
+
* Optional. Resource-level access control config for Gemini Enterprise users.
|
|
16537
|
+
*/
|
|
16538
|
+
resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
16438
16539
|
}
|
|
16439
16540
|
/**
|
|
16440
16541
|
* Configuration for NotebookLM.
|
|
@@ -16488,6 +16589,15 @@ export namespace discoveryengine_v1beta {
|
|
|
16488
16589
|
*/
|
|
16489
16590
|
userPromptTemplate?: string | null;
|
|
16490
16591
|
}
|
|
16592
|
+
/**
|
|
16593
|
+
* Controls resource-level access control for Gemini Enterprise users.
|
|
16594
|
+
*/
|
|
16595
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
16596
|
+
/**
|
|
16597
|
+
* Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
|
|
16598
|
+
*/
|
|
16599
|
+
dataStoreAccessControlEnabled?: boolean | null;
|
|
16600
|
+
}
|
|
16491
16601
|
/**
|
|
16492
16602
|
* Metadata about the terms of service.
|
|
16493
16603
|
*/
|