@googleapis/discoveryengine 37.1.0 → 37.3.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/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +33 -5
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +221 -6
- package/build/v1alpha.js +116 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +25 -5
- package/build/v1beta.js.map +1 -1
- package/package.json +2 -2
- package/tsconfig.build.json +10 -0
- package/v1.ts +29 -5
- package/v1alpha.ts +414 -6
- package/v1beta.ts +21 -5
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@googleapis/discoveryengine",
|
|
3
|
-
"version": "37.
|
|
3
|
+
"version": "37.3.0",
|
|
4
4
|
"description": "discoveryengine",
|
|
5
5
|
"main": "build/index.js",
|
|
6
6
|
"types": "build/index.d.ts",
|
|
@@ -38,6 +38,6 @@
|
|
|
38
38
|
"ts-loader": "^9.0.0",
|
|
39
39
|
"typescript": "5.7.3",
|
|
40
40
|
"webpack": "^5.0.0",
|
|
41
|
-
"webpack-cli": "^
|
|
41
|
+
"webpack-cli": "^7.0.0"
|
|
42
42
|
}
|
|
43
43
|
}
|
package/v1.ts
CHANGED
|
@@ -2291,6 +2291,10 @@ export namespace discoveryengine_v1 {
|
|
|
2291
2291
|
* Reasons for not answering the assist call.
|
|
2292
2292
|
*/
|
|
2293
2293
|
assistSkippedReasons?: string[] | null;
|
|
2294
|
+
/**
|
|
2295
|
+
* 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.
|
|
2296
|
+
*/
|
|
2297
|
+
connectorDisplayNames?: {[key: string]: string} | null;
|
|
2294
2298
|
/**
|
|
2295
2299
|
* 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.
|
|
2296
2300
|
*/
|
|
@@ -3363,7 +3367,7 @@ export namespace discoveryengine_v1 {
|
|
|
3363
3367
|
*/
|
|
3364
3368
|
syncMode?: string | null;
|
|
3365
3369
|
/**
|
|
3366
|
-
* 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.
|
|
3370
|
+
* 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.
|
|
3367
3371
|
*/
|
|
3368
3372
|
tag?: string | null;
|
|
3369
3373
|
/**
|
|
@@ -4978,6 +4982,10 @@ export namespace discoveryengine_v1 {
|
|
|
4978
4982
|
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
4979
4983
|
*/
|
|
4980
4984
|
autoRenew?: boolean | null;
|
|
4985
|
+
/**
|
|
4986
|
+
* Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
|
|
4987
|
+
*/
|
|
4988
|
+
billingAccountLicenseConfig?: string | null;
|
|
4981
4989
|
/**
|
|
4982
4990
|
* 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.
|
|
4983
4991
|
*/
|
|
@@ -7930,6 +7938,10 @@ export namespace discoveryengine_v1 {
|
|
|
7930
7938
|
* Reasons for not answering the assist call.
|
|
7931
7939
|
*/
|
|
7932
7940
|
assistSkippedReasons?: string[] | null;
|
|
7941
|
+
/**
|
|
7942
|
+
* 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.
|
|
7943
|
+
*/
|
|
7944
|
+
connectorDisplayNames?: {[key: string]: string} | null;
|
|
7933
7945
|
/**
|
|
7934
7946
|
* 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.
|
|
7935
7947
|
*/
|
|
@@ -12122,7 +12134,7 @@ export namespace discoveryengine_v1 {
|
|
|
12122
12134
|
*/
|
|
12123
12135
|
selectedPosition?: number | null;
|
|
12124
12136
|
/**
|
|
12125
|
-
* End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
12137
|
+
* Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
|
|
12126
12138
|
*/
|
|
12127
12139
|
selectedSuggestion?: string | null;
|
|
12128
12140
|
}
|
|
@@ -12780,7 +12792,7 @@ export namespace discoveryengine_v1 {
|
|
|
12780
12792
|
*/
|
|
12781
12793
|
syncMode?: string | null;
|
|
12782
12794
|
/**
|
|
12783
|
-
* 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.
|
|
12795
|
+
* 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.
|
|
12784
12796
|
*/
|
|
12785
12797
|
tag?: string | null;
|
|
12786
12798
|
/**
|
|
@@ -14056,6 +14068,10 @@ export namespace discoveryengine_v1 {
|
|
|
14056
14068
|
* Name of the newly generated or continued session.
|
|
14057
14069
|
*/
|
|
14058
14070
|
session?: string | null;
|
|
14071
|
+
/**
|
|
14072
|
+
* Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project\}/locations/{location\}/tasks/{task_id\}
|
|
14073
|
+
*/
|
|
14074
|
+
taskName?: string | null;
|
|
14059
14075
|
}
|
|
14060
14076
|
/**
|
|
14061
14077
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
@@ -15661,7 +15677,7 @@ export namespace discoveryengine_v1 {
|
|
|
15661
15677
|
*/
|
|
15662
15678
|
orderBy?: string | null;
|
|
15663
15679
|
/**
|
|
15664
|
-
* 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.
|
|
15680
|
+
* 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.
|
|
15665
15681
|
*/
|
|
15666
15682
|
searchQuery?: string | null;
|
|
15667
15683
|
}
|
|
@@ -17528,7 +17544,7 @@ export namespace discoveryengine_v1 {
|
|
|
17528
17544
|
*/
|
|
17529
17545
|
export interface Schema$GoogleCloudDiscoveryengineV1UserEvent {
|
|
17530
17546
|
/**
|
|
17531
|
-
* 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.
|
|
17547
|
+
* 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.
|
|
17532
17548
|
*/
|
|
17533
17549
|
attributes?: {
|
|
17534
17550
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1CustomAttribute;
|
|
@@ -17994,6 +18010,10 @@ export namespace discoveryengine_v1 {
|
|
|
17994
18010
|
* 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.
|
|
17995
18011
|
*/
|
|
17996
18012
|
name?: string | null;
|
|
18013
|
+
/**
|
|
18014
|
+
* Output only. The version-independent label of the connector backing this collection, mirroring `DataConnector.tag`. Unlike the version-pinned data store id it survives a connector version upgrade, so an upgraded connector keeps the same tag. Not a unique key. As `DataConnector.tag` documents, several connectors may share a tag under the same (project, location, collection, data_source), and tag-based lookup resolves to the one with the greatest create_time. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying `DataConnector`. Populated only when `ConnectorsFeature.enable_connector_tag` is on.
|
|
18015
|
+
*/
|
|
18016
|
+
tag?: string | null;
|
|
17997
18017
|
}
|
|
17998
18018
|
/**
|
|
17999
18019
|
* Read-only connector in CollectionComponent auth state.
|
|
@@ -18312,6 +18332,10 @@ export namespace discoveryengine_v1 {
|
|
|
18312
18332
|
* The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization.
|
|
18313
18333
|
*/
|
|
18314
18334
|
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfo {
|
|
18335
|
+
/**
|
|
18336
|
+
* Output only. The `model_id` a client must send when the end-user picks the "Auto" entry (the empty `model_id`). Populated only for surfaces known to have no true "Auto" mode, where leaving the model unset would fall back to a platform default rather than a backend-chosen model. Empty on every other surface, where "Auto" is resolved server-side, and when none of the surface's ranked models is available. When set, it is always one of the non-empty `model_id`s present in `resolved_models`.
|
|
18337
|
+
*/
|
|
18338
|
+
autoModelId?: string | null;
|
|
18315
18339
|
/**
|
|
18316
18340
|
* Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`.
|
|
18317
18341
|
*/
|