@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/build/v1beta.d.ts
CHANGED
|
@@ -1393,6 +1393,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1393
1393
|
* Reasons for not answering the assist call.
|
|
1394
1394
|
*/
|
|
1395
1395
|
assistSkippedReasons?: string[] | null;
|
|
1396
|
+
/**
|
|
1397
|
+
* 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.
|
|
1398
|
+
*/
|
|
1399
|
+
connectorDisplayNames?: {
|
|
1400
|
+
[key: string]: string;
|
|
1401
|
+
} | null;
|
|
1396
1402
|
/**
|
|
1397
1403
|
* 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.
|
|
1398
1404
|
*/
|
|
@@ -2472,7 +2478,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2472
2478
|
*/
|
|
2473
2479
|
syncMode?: string | null;
|
|
2474
2480
|
/**
|
|
2475
|
-
* 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.
|
|
2481
|
+
* 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.
|
|
2476
2482
|
*/
|
|
2477
2483
|
tag?: string | null;
|
|
2478
2484
|
/**
|
|
@@ -4114,6 +4120,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4114
4120
|
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
4115
4121
|
*/
|
|
4116
4122
|
autoRenew?: boolean | null;
|
|
4123
|
+
/**
|
|
4124
|
+
* Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
|
|
4125
|
+
*/
|
|
4126
|
+
billingAccountLicenseConfig?: string | null;
|
|
4117
4127
|
/**
|
|
4118
4128
|
* 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.
|
|
4119
4129
|
*/
|
|
@@ -4383,6 +4393,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4383
4393
|
* Optional. Configuration for NotebookLM settings.
|
|
4384
4394
|
*/
|
|
4385
4395
|
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
4396
|
+
/**
|
|
4397
|
+
* Optional. Resource-level access control config for Gemini Enterprise users.
|
|
4398
|
+
*/
|
|
4399
|
+
resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
4386
4400
|
}
|
|
4387
4401
|
/**
|
|
4388
4402
|
* Configuration for NotebookLM.
|
|
@@ -4436,6 +4450,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4436
4450
|
*/
|
|
4437
4451
|
userPromptTemplate?: string | null;
|
|
4438
4452
|
}
|
|
4453
|
+
/**
|
|
4454
|
+
* Controls resource-level access control for Gemini Enterprise users.
|
|
4455
|
+
*/
|
|
4456
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
4457
|
+
/**
|
|
4458
|
+
* 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.
|
|
4459
|
+
*/
|
|
4460
|
+
dataStoreAccessControlEnabled?: boolean | null;
|
|
4461
|
+
}
|
|
4439
4462
|
/**
|
|
4440
4463
|
* Metadata about the terms of service.
|
|
4441
4464
|
*/
|
|
@@ -4681,6 +4704,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4681
4704
|
* 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.
|
|
4682
4705
|
*/
|
|
4683
4706
|
uiJsonPayload?: string | null;
|
|
4707
|
+
/**
|
|
4708
|
+
* Reference to a user-supplied file attached to a long-running-agent (Sobi) task. See `UserSuppliedSobiArtifactReference` above.
|
|
4709
|
+
*/
|
|
4710
|
+
userSuppliedSobiArtifactReference?: Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference;
|
|
4684
4711
|
}
|
|
4685
4712
|
/**
|
|
4686
4713
|
* Represents a document reference.
|
|
@@ -4773,6 +4800,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4773
4800
|
*/
|
|
4774
4801
|
personId?: string | null;
|
|
4775
4802
|
}
|
|
4803
|
+
/**
|
|
4804
|
+
* 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.
|
|
4805
|
+
*/
|
|
4806
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference {
|
|
4807
|
+
/**
|
|
4808
|
+
* 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.
|
|
4809
|
+
*/
|
|
4810
|
+
fileName?: string | null;
|
|
4811
|
+
/**
|
|
4812
|
+
* Optional. IANA MIME type. Used for icon/preview rendering.
|
|
4813
|
+
*/
|
|
4814
|
+
mimeType?: string | null;
|
|
4815
|
+
}
|
|
4776
4816
|
/**
|
|
4777
4817
|
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4778
4818
|
*/
|
|
@@ -5660,6 +5700,27 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5660
5700
|
* The condition under which search as you type should occur. Default to Condition.DISABLED.
|
|
5661
5701
|
*/
|
|
5662
5702
|
condition?: string | null;
|
|
5703
|
+
/**
|
|
5704
|
+
* Optional. The list of fields to be used for Search As You Type scoring.
|
|
5705
|
+
*/
|
|
5706
|
+
fields?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField[];
|
|
5707
|
+
/**
|
|
5708
|
+
* Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
|
|
5709
|
+
*/
|
|
5710
|
+
scoreThreshold?: number | null;
|
|
5711
|
+
}
|
|
5712
|
+
/**
|
|
5713
|
+
* 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.
|
|
5714
|
+
*/
|
|
5715
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField {
|
|
5716
|
+
/**
|
|
5717
|
+
* Required. A field key that has been indexed for Search As You Type.
|
|
5718
|
+
*/
|
|
5719
|
+
key?: string | null;
|
|
5720
|
+
/**
|
|
5721
|
+
* Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
|
|
5722
|
+
*/
|
|
5723
|
+
weight?: number | null;
|
|
5663
5724
|
}
|
|
5664
5725
|
/**
|
|
5665
5726
|
* Session specification.
|
|
@@ -7654,6 +7715,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7654
7715
|
* Reasons for not answering the assist call.
|
|
7655
7716
|
*/
|
|
7656
7717
|
assistSkippedReasons?: string[] | null;
|
|
7718
|
+
/**
|
|
7719
|
+
* 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.
|
|
7720
|
+
*/
|
|
7721
|
+
connectorDisplayNames?: {
|
|
7722
|
+
[key: string]: string;
|
|
7723
|
+
} | null;
|
|
7657
7724
|
/**
|
|
7658
7725
|
* 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.
|
|
7659
7726
|
*/
|
|
@@ -8711,7 +8778,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
8711
8778
|
*/
|
|
8712
8779
|
selectedPosition?: number | null;
|
|
8713
8780
|
/**
|
|
8714
|
-
* End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
8781
|
+
* Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
8715
8782
|
*/
|
|
8716
8783
|
selectedSuggestion?: string | null;
|
|
8717
8784
|
}
|
|
@@ -11616,6 +11683,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11616
11683
|
* Optional. Configuration for NotebookLM settings.
|
|
11617
11684
|
*/
|
|
11618
11685
|
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
11686
|
+
/**
|
|
11687
|
+
* Optional. Resource-level access control config for Gemini Enterprise users.
|
|
11688
|
+
*/
|
|
11689
|
+
resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
11619
11690
|
}
|
|
11620
11691
|
/**
|
|
11621
11692
|
* Configuration for NotebookLM.
|
|
@@ -11669,6 +11740,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11669
11740
|
*/
|
|
11670
11741
|
userPromptTemplate?: string | null;
|
|
11671
11742
|
}
|
|
11743
|
+
/**
|
|
11744
|
+
* Controls resource-level access control for Gemini Enterprise users.
|
|
11745
|
+
*/
|
|
11746
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
11747
|
+
/**
|
|
11748
|
+
* 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.
|
|
11749
|
+
*/
|
|
11750
|
+
dataStoreAccessControlEnabled?: boolean | null;
|
|
11751
|
+
}
|
|
11672
11752
|
/**
|
|
11673
11753
|
* Metadata about the terms of service.
|
|
11674
11754
|
*/
|
|
@@ -12354,7 +12434,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12354
12434
|
*/
|
|
12355
12435
|
orderBy?: string | null;
|
|
12356
12436
|
/**
|
|
12357
|
-
* 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.
|
|
12437
|
+
* 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.
|
|
12358
12438
|
*/
|
|
12359
12439
|
searchQuery?: string | null;
|
|
12360
12440
|
}
|
|
@@ -13028,6 +13108,27 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13028
13108
|
* The condition under which search as you type should occur. Default to Condition.DISABLED.
|
|
13029
13109
|
*/
|
|
13030
13110
|
condition?: string | null;
|
|
13111
|
+
/**
|
|
13112
|
+
* Optional. The list of fields to be used for Search As You Type scoring.
|
|
13113
|
+
*/
|
|
13114
|
+
fields?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField[];
|
|
13115
|
+
/**
|
|
13116
|
+
* Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
|
|
13117
|
+
*/
|
|
13118
|
+
scoreThreshold?: number | null;
|
|
13119
|
+
}
|
|
13120
|
+
/**
|
|
13121
|
+
* 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.
|
|
13122
|
+
*/
|
|
13123
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField {
|
|
13124
|
+
/**
|
|
13125
|
+
* Required. A field key that has been indexed for Search As You Type.
|
|
13126
|
+
*/
|
|
13127
|
+
key?: string | null;
|
|
13128
|
+
/**
|
|
13129
|
+
* Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
|
|
13130
|
+
*/
|
|
13131
|
+
weight?: number | null;
|
|
13031
13132
|
}
|
|
13032
13133
|
/**
|
|
13033
13134
|
* Session specification.
|
|
@@ -14393,7 +14494,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14393
14494
|
*/
|
|
14394
14495
|
export interface Schema$GoogleCloudDiscoveryengineV1betaUserEvent {
|
|
14395
14496
|
/**
|
|
14396
|
-
* 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.
|
|
14497
|
+
* 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.
|
|
14397
14498
|
*/
|
|
14398
14499
|
attributes?: {
|
|
14399
14500
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute;
|
|
@@ -15114,7 +15215,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15114
15215
|
*/
|
|
15115
15216
|
syncMode?: string | null;
|
|
15116
15217
|
/**
|
|
15117
|
-
* 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.
|
|
15218
|
+
* 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.
|
|
15118
15219
|
*/
|
|
15119
15220
|
tag?: string | null;
|
|
15120
15221
|
/**
|
|
@@ -16547,6 +16648,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16547
16648
|
* Optional. Configuration for NotebookLM settings.
|
|
16548
16649
|
*/
|
|
16549
16650
|
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
|
|
16651
|
+
/**
|
|
16652
|
+
* Optional. Resource-level access control config for Gemini Enterprise users.
|
|
16653
|
+
*/
|
|
16654
|
+
resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
16550
16655
|
}
|
|
16551
16656
|
/**
|
|
16552
16657
|
* Configuration for NotebookLM.
|
|
@@ -16600,6 +16705,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16600
16705
|
*/
|
|
16601
16706
|
userPromptTemplate?: string | null;
|
|
16602
16707
|
}
|
|
16708
|
+
/**
|
|
16709
|
+
* Controls resource-level access control for Gemini Enterprise users.
|
|
16710
|
+
*/
|
|
16711
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
16712
|
+
/**
|
|
16713
|
+
* 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.
|
|
16714
|
+
*/
|
|
16715
|
+
dataStoreAccessControlEnabled?: boolean | null;
|
|
16716
|
+
}
|
|
16603
16717
|
/**
|
|
16604
16718
|
* Metadata about the terms of service.
|
|
16605
16719
|
*/
|