@maxim_mazurok/gapi.client.discoveryengine-v1 0.3.20260914 → 0.3.20260927
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 +72 -6
- package/package.json +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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260927
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1149,6 +1149,8 @@ declare namespace gapi.client {
|
|
|
1149
1149
|
| 'ASSIST_SKIPPED_REASON_UNSPECIFIED'
|
|
1150
1150
|
| 'NON_ASSIST_SEEKING_QUERY_IGNORED'
|
|
1151
1151
|
| 'CUSTOMER_POLICY_VIOLATION'[];
|
|
1152
|
+
/** 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. */
|
|
1153
|
+
connectorDisplayNames?: {[P in string]: string};
|
|
1152
1154
|
/** 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. */
|
|
1153
1155
|
customerPolicyEnforcementResult?: GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult;
|
|
1154
1156
|
/** Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
@@ -1775,7 +1777,7 @@ declare namespace gapi.client {
|
|
|
1775
1777
|
staticIpEnabled?: boolean;
|
|
1776
1778
|
/** The data synchronization mode supported by the data connector. */
|
|
1777
1779
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
1778
|
-
/** 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. */
|
|
1780
|
+
/** 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. */
|
|
1779
1781
|
tag?: string;
|
|
1780
1782
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
1781
1783
|
updateTime?: string;
|
|
@@ -2646,6 +2648,8 @@ declare namespace gapi.client {
|
|
|
2646
2648
|
alertPolicyResourceConfig?: GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig;
|
|
2647
2649
|
/** Optional. Whether the license config should be auto renewed when it reaches the end date. */
|
|
2648
2650
|
autoRenew?: boolean;
|
|
2651
|
+
/** Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set. */
|
|
2652
|
+
billingAccountLicenseConfig?: string;
|
|
2649
2653
|
/** 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. */
|
|
2650
2654
|
earlyTerminated?: boolean;
|
|
2651
2655
|
/** Output only. The date when the subscription is terminated earlier than the expiration date. */
|
|
@@ -2813,6 +2817,8 @@ declare namespace gapi.client {
|
|
|
2813
2817
|
interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig {
|
|
2814
2818
|
/** Optional. Configuration for NotebookLM settings. */
|
|
2815
2819
|
notebooklmConfig?: GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
2820
|
+
/** Optional. Resource-level access control config for Gemini Enterprise users. */
|
|
2821
|
+
resourceAccessControlConfig?: GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
2816
2822
|
}
|
|
2817
2823
|
interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig {
|
|
2818
2824
|
/** Optional. Specifies the data protection policy for NotebookLM. */
|
|
@@ -2838,6 +2844,10 @@ declare namespace gapi.client {
|
|
|
2838
2844
|
/** Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. */
|
|
2839
2845
|
userPromptTemplate?: string;
|
|
2840
2846
|
}
|
|
2847
|
+
interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
2848
|
+
/** 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. */
|
|
2849
|
+
dataStoreAccessControlEnabled?: boolean;
|
|
2850
|
+
}
|
|
2841
2851
|
interface GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
|
|
2842
2852
|
/** The last time when the project agreed to the terms of service. */
|
|
2843
2853
|
acceptTime?: string;
|
|
@@ -2956,6 +2966,8 @@ declare namespace gapi.client {
|
|
|
2956
2966
|
text?: string;
|
|
2957
2967
|
/** 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. */
|
|
2958
2968
|
uiJsonPayload?: string;
|
|
2969
|
+
/** Reference to a user-supplied file attached to a long-running-agent (Sobi) task. See `UserSuppliedSobiArtifactReference` above. */
|
|
2970
|
+
userSuppliedSobiArtifactReference?: GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference;
|
|
2959
2971
|
}
|
|
2960
2972
|
interface GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference {
|
|
2961
2973
|
/** The destination uri of the reference. */
|
|
@@ -3001,6 +3013,12 @@ declare namespace gapi.client {
|
|
|
3001
3013
|
/** The person id of the person. */
|
|
3002
3014
|
personId?: string;
|
|
3003
3015
|
}
|
|
3016
|
+
interface GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference {
|
|
3017
|
+
/** 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. */
|
|
3018
|
+
fileName?: string;
|
|
3019
|
+
/** Optional. IANA MIME type. Used for icon/preview rendering. */
|
|
3020
|
+
mimeType?: string;
|
|
3021
|
+
}
|
|
3004
3022
|
interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
3005
3023
|
/** Operation create time. */
|
|
3006
3024
|
createTime?: string;
|
|
@@ -3464,6 +3482,16 @@ declare namespace gapi.client {
|
|
|
3464
3482
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec {
|
|
3465
3483
|
/** The condition under which search as you type should occur. Default to Condition.DISABLED. */
|
|
3466
3484
|
condition?: 'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED' | 'AUTO';
|
|
3485
|
+
/** Optional. The list of fields to be used for Search As You Type scoring. */
|
|
3486
|
+
fields?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField[];
|
|
3487
|
+
/** Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` >= `score_threshold`. */
|
|
3488
|
+
scoreThreshold?: number;
|
|
3489
|
+
}
|
|
3490
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField {
|
|
3491
|
+
/** Required. A field key that has been indexed for Search As You Type. */
|
|
3492
|
+
key?: string;
|
|
3493
|
+
/** Optional. Weight for scores from this field. Defaults to 1.0 if not specified. */
|
|
3494
|
+
weight?: number;
|
|
3467
3495
|
}
|
|
3468
3496
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec {
|
|
3469
3497
|
/** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
|
|
@@ -4181,6 +4209,8 @@ declare namespace gapi.client {
|
|
|
4181
4209
|
| 'ASSIST_SKIPPED_REASON_UNSPECIFIED'
|
|
4182
4210
|
| 'NON_ASSIST_SEEKING_QUERY_IGNORED'
|
|
4183
4211
|
| 'CUSTOMER_POLICY_VIOLATION'[];
|
|
4212
|
+
/** 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. */
|
|
4213
|
+
connectorDisplayNames?: {[P in string]: string};
|
|
4184
4214
|
/** 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. */
|
|
4185
4215
|
customerPolicyEnforcementResult?: GoogleCloudDiscoveryengineV1AssistAnswerCustomerPolicyEnforcementResult;
|
|
4186
4216
|
/** Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
@@ -5466,6 +5496,8 @@ declare namespace gapi.client {
|
|
|
5466
5496
|
interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig {
|
|
5467
5497
|
/** Optional. Configuration for NotebookLM settings. */
|
|
5468
5498
|
notebooklmConfig?: GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
5499
|
+
/** Optional. Resource-level access control config for Gemini Enterprise users. */
|
|
5500
|
+
resourceAccessControlConfig?: GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
5469
5501
|
}
|
|
5470
5502
|
interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig {
|
|
5471
5503
|
/** Optional. Specifies the data protection policy for NotebookLM. */
|
|
@@ -5491,6 +5523,10 @@ declare namespace gapi.client {
|
|
|
5491
5523
|
/** Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. */
|
|
5492
5524
|
userPromptTemplate?: string;
|
|
5493
5525
|
}
|
|
5526
|
+
interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
5527
|
+
/** 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. */
|
|
5528
|
+
dataStoreAccessControlEnabled?: boolean;
|
|
5529
|
+
}
|
|
5494
5530
|
interface GoogleCloudDiscoveryengineV1betaProjectServiceTerms {
|
|
5495
5531
|
/** The last time when the project agreed to the terms of service. */
|
|
5496
5532
|
acceptTime?: string;
|
|
@@ -5925,6 +5961,16 @@ declare namespace gapi.client {
|
|
|
5925
5961
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec {
|
|
5926
5962
|
/** The condition under which search as you type should occur. Default to Condition.DISABLED. */
|
|
5927
5963
|
condition?: 'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED' | 'AUTO';
|
|
5964
|
+
/** Optional. The list of fields to be used for Search As You Type scoring. */
|
|
5965
|
+
fields?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField[];
|
|
5966
|
+
/** Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` >= `score_threshold`. */
|
|
5967
|
+
scoreThreshold?: number;
|
|
5968
|
+
}
|
|
5969
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField {
|
|
5970
|
+
/** Required. A field key that has been indexed for Search As You Type. */
|
|
5971
|
+
key?: string;
|
|
5972
|
+
/** Optional. Weight for scores from this field. Defaults to 1.0 if not specified. */
|
|
5973
|
+
weight?: number;
|
|
5928
5974
|
}
|
|
5929
5975
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec {
|
|
5930
5976
|
/** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
|
|
@@ -6392,7 +6438,7 @@ declare namespace gapi.client {
|
|
|
6392
6438
|
interface GoogleCloudDiscoveryengineV1CompletionInfo {
|
|
6393
6439
|
/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. */
|
|
6394
6440
|
selectedPosition?: number;
|
|
6395
|
-
/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
|
|
6441
|
+
/** Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */
|
|
6396
6442
|
selectedSuggestion?: string;
|
|
6397
6443
|
}
|
|
6398
6444
|
interface GoogleCloudDiscoveryengineV1CompletionSuggestion {
|
|
@@ -6775,7 +6821,7 @@ declare namespace gapi.client {
|
|
|
6775
6821
|
staticIpEnabled?: boolean;
|
|
6776
6822
|
/** The data synchronization mode supported by the data connector. */
|
|
6777
6823
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
6778
|
-
/** 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. */
|
|
6824
|
+
/** 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. */
|
|
6779
6825
|
tag?: string;
|
|
6780
6826
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
6781
6827
|
updateTime?: string;
|
|
@@ -7998,6 +8044,8 @@ declare namespace gapi.client {
|
|
|
7998
8044
|
interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig {
|
|
7999
8045
|
/** Optional. Configuration for NotebookLM settings. */
|
|
8000
8046
|
notebooklmConfig?: GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
|
|
8047
|
+
/** Optional. Resource-level access control config for Gemini Enterprise users. */
|
|
8048
|
+
resourceAccessControlConfig?: GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig;
|
|
8001
8049
|
}
|
|
8002
8050
|
interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig {
|
|
8003
8051
|
/** Optional. Specifies the data protection policy for NotebookLM. */
|
|
@@ -8023,6 +8071,10 @@ declare namespace gapi.client {
|
|
|
8023
8071
|
/** Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. */
|
|
8024
8072
|
userPromptTemplate?: string;
|
|
8025
8073
|
}
|
|
8074
|
+
interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig {
|
|
8075
|
+
/** 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. */
|
|
8076
|
+
dataStoreAccessControlEnabled?: boolean;
|
|
8077
|
+
}
|
|
8026
8078
|
interface GoogleCloudDiscoveryengineV1ProjectServiceTerms {
|
|
8027
8079
|
/** The last time when the project agreed to the terms of service. */
|
|
8028
8080
|
acceptTime?: string;
|
|
@@ -8267,7 +8319,7 @@ declare namespace gapi.client {
|
|
|
8267
8319
|
offset?: number;
|
|
8268
8320
|
/** The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
8269
8321
|
orderBy?: string;
|
|
8270
|
-
/** 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. */
|
|
8322
|
+
/** 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. */
|
|
8271
8323
|
searchQuery?: string;
|
|
8272
8324
|
}
|
|
8273
8325
|
interface GoogleCloudDiscoveryengineV1SearchLinkPromotion {
|
|
@@ -8583,6 +8635,16 @@ declare namespace gapi.client {
|
|
|
8583
8635
|
interface GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec {
|
|
8584
8636
|
/** The condition under which search as you type should occur. Default to Condition.DISABLED. */
|
|
8585
8637
|
condition?: 'CONDITION_UNSPECIFIED' | 'DISABLED' | 'ENABLED' | 'AUTO';
|
|
8638
|
+
/** Optional. The list of fields to be used for Search As You Type scoring. */
|
|
8639
|
+
fields?: GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpecField[];
|
|
8640
|
+
/** Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` >= `score_threshold`. */
|
|
8641
|
+
scoreThreshold?: number;
|
|
8642
|
+
}
|
|
8643
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpecField {
|
|
8644
|
+
/** Required. A field key that has been indexed for Search As You Type. */
|
|
8645
|
+
key?: string;
|
|
8646
|
+
/** Optional. Weight for scores from this field. Defaults to 1.0 if not specified. */
|
|
8647
|
+
weight?: number;
|
|
8586
8648
|
}
|
|
8587
8649
|
interface GoogleCloudDiscoveryengineV1SearchRequestSessionSpec {
|
|
8588
8650
|
/** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
|
|
@@ -9201,7 +9263,7 @@ declare namespace gapi.client {
|
|
|
9201
9263
|
updateTime?: string;
|
|
9202
9264
|
}
|
|
9203
9265
|
interface GoogleCloudDiscoveryengineV1UserEvent {
|
|
9204
|
-
/** 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. */
|
|
9266
|
+
/** 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. */
|
|
9205
9267
|
attributes?: {[P in string]: GoogleCloudDiscoveryengineV1CustomAttribute};
|
|
9206
9268
|
/** Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field. */
|
|
9207
9269
|
attributionToken?: string;
|
|
@@ -9455,6 +9517,8 @@ declare namespace gapi.client {
|
|
|
9455
9517
|
metadata?: GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata;
|
|
9456
9518
|
/** 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. */
|
|
9457
9519
|
name?: string;
|
|
9520
|
+
/** 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. */
|
|
9521
|
+
tag?: string;
|
|
9458
9522
|
}
|
|
9459
9523
|
interface GoogleCloudDiscoveryengineV1WidgetConfigConnectorAuthState {
|
|
9460
9524
|
/** Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. */
|
|
@@ -9650,6 +9714,8 @@ declare namespace gapi.client {
|
|
|
9650
9714
|
description?: string;
|
|
9651
9715
|
/** Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. */
|
|
9652
9716
|
displayName?: string;
|
|
9717
|
+
/** Output only. Groups models that render together in the selector. Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized. */
|
|
9718
|
+
family?: string;
|
|
9653
9719
|
/** Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). */
|
|
9654
9720
|
icon?: string;
|
|
9655
9721
|
/** Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. */
|