@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.2.20260317 → 0.2.20260531
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 +353 -56
- package/package.json +1 -1
- package/readme.md +20 -0
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: 20260531
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -74,7 +74,7 @@ declare namespace gapi.client {
|
|
|
74
74
|
}
|
|
75
75
|
interface GoogleApiDistributionExemplar {
|
|
76
76
|
/** Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. */
|
|
77
|
-
attachments?:
|
|
77
|
+
attachments?: {[P in string]: any}[];
|
|
78
78
|
/** The observation (sampling) time of the above value. */
|
|
79
79
|
timestamp?: string;
|
|
80
80
|
/** Value of the exemplar point. This value determines to which bucket the exemplar belongs. */
|
|
@@ -92,7 +92,7 @@ declare namespace gapi.client {
|
|
|
92
92
|
/** The HTTP request/response body as raw binary. */
|
|
93
93
|
data?: string;
|
|
94
94
|
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
95
|
-
extensions?:
|
|
95
|
+
extensions?: {[P in string]: any}[];
|
|
96
96
|
}
|
|
97
97
|
interface GoogleApiMetric {
|
|
98
98
|
/** The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values. */
|
|
@@ -185,6 +185,8 @@ declare namespace gapi.client {
|
|
|
185
185
|
interface GoogleCloudDiscoveryengineV1ActionConfig {
|
|
186
186
|
/** Optional. Action parameters in structured json format. */
|
|
187
187
|
actionParams?: {[P in string]: any};
|
|
188
|
+
/** Optional. Whether to create a BAP connection for the connector. */
|
|
189
|
+
createBapConnection?: boolean;
|
|
188
190
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
189
191
|
isActionConfigured?: boolean;
|
|
190
192
|
/** Optional. Action parameters in json string format. */
|
|
@@ -246,7 +248,10 @@ declare namespace gapi.client {
|
|
|
246
248
|
/** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
247
249
|
name?: string;
|
|
248
250
|
}
|
|
249
|
-
interface GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest {
|
|
251
|
+
interface GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest {
|
|
252
|
+
/** Optional. The scope to request for the access token. Scope will override default scope if specified. */
|
|
253
|
+
scope?: string;
|
|
254
|
+
}
|
|
250
255
|
interface GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse {
|
|
251
256
|
/** The created access token. */
|
|
252
257
|
accessToken?: string;
|
|
@@ -256,6 +261,8 @@ declare namespace gapi.client {
|
|
|
256
261
|
interface GoogleCloudDiscoveryengineV1alphaActionConfig {
|
|
257
262
|
/** Optional. Action parameters in structured json format. */
|
|
258
263
|
actionParams?: {[P in string]: any};
|
|
264
|
+
/** Optional. Whether to create a BAP connection for the connector. */
|
|
265
|
+
createBapConnection?: boolean;
|
|
259
266
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
260
267
|
isActionConfigured?: boolean;
|
|
261
268
|
/** Optional. Action parameters in json string format. */
|
|
@@ -453,7 +460,8 @@ declare namespace gapi.client {
|
|
|
453
460
|
| 'DEPLOYMENT_FAILED'
|
|
454
461
|
| 'PRIVATE'
|
|
455
462
|
| 'ENABLED'
|
|
456
|
-
| 'SUSPENDED'
|
|
463
|
+
| 'SUSPENDED'
|
|
464
|
+
| 'CREATING';
|
|
457
465
|
/** Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED. */
|
|
458
466
|
suspensionReason?: string;
|
|
459
467
|
/** Output only. Timestamp when this Agent was most recently updated. */
|
|
@@ -558,7 +566,7 @@ declare namespace gapi.client {
|
|
|
558
566
|
| 'UNHELPFUL_ANSWER'[];
|
|
559
567
|
/** The textual answer. */
|
|
560
568
|
answerText?: string;
|
|
561
|
-
/** List of blob attachments in the answer. */
|
|
569
|
+
/** Output only. List of blob attachments in the answer. */
|
|
562
570
|
blobAttachments?: GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment[];
|
|
563
571
|
/** Citations. */
|
|
564
572
|
citations?: GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
@@ -804,7 +812,7 @@ declare namespace gapi.client {
|
|
|
804
812
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams {
|
|
805
813
|
/** Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
|
|
806
814
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
807
|
-
/** Custom fine tuning configs. */
|
|
815
|
+
/** Optional. Custom fine tuning configs. */
|
|
808
816
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
809
817
|
/** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
|
|
810
818
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
@@ -1036,7 +1044,8 @@ declare namespace gapi.client {
|
|
|
1036
1044
|
| 'IN_PROGRESS'
|
|
1037
1045
|
| 'FAILED'
|
|
1038
1046
|
| 'SUCCEEDED'
|
|
1039
|
-
| 'SKIPPED'
|
|
1047
|
+
| 'SKIPPED'
|
|
1048
|
+
| 'CANCELLED';
|
|
1040
1049
|
}
|
|
1041
1050
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult {
|
|
1042
1051
|
/** Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. */
|
|
@@ -1061,12 +1070,16 @@ declare namespace gapi.client {
|
|
|
1061
1070
|
modelArmorEnforcementResult?: GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
1062
1071
|
}
|
|
1063
1072
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerReply {
|
|
1073
|
+
/** The time when the reply was created. */
|
|
1074
|
+
createTime?: string;
|
|
1064
1075
|
/** Possibly grounded response text or media from the assistant. */
|
|
1065
1076
|
groundedContent?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
|
|
1066
1077
|
/** Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. */
|
|
1067
1078
|
replyId?: string;
|
|
1068
1079
|
}
|
|
1069
1080
|
interface GoogleCloudDiscoveryengineV1alphaAssistant {
|
|
1081
|
+
/** Output only. Represents the time when this Assistant was created. */
|
|
1082
|
+
createTime?: string;
|
|
1070
1083
|
/** Optional. Customer policy for the assistant. */
|
|
1071
1084
|
customerPolicy?: GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy;
|
|
1072
1085
|
/** Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. */
|
|
@@ -1085,6 +1098,8 @@ declare namespace gapi.client {
|
|
|
1085
1098
|
generationConfig?: GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig;
|
|
1086
1099
|
/** Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1087
1100
|
name?: string;
|
|
1101
|
+
/** Output only. Represents the time when this Assistant was most recently updated. */
|
|
1102
|
+
updateTime?: string;
|
|
1088
1103
|
/** Optional. The type of web grounding to use. */
|
|
1089
1104
|
webGroundingType?:
|
|
1090
1105
|
| 'WEB_GROUNDING_TYPE_UNSPECIFIED'
|
|
@@ -1186,8 +1201,12 @@ declare namespace gapi.client {
|
|
|
1186
1201
|
references?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
1187
1202
|
/** Grounding information for parts of the text. */
|
|
1188
1203
|
segments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
1204
|
+
/** Grounding information for parts of the visual content. */
|
|
1205
|
+
visualSegments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment[];
|
|
1189
1206
|
}
|
|
1190
1207
|
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference {
|
|
1208
|
+
/** Chunk of code snippet from the referenced document. */
|
|
1209
|
+
codeSnippet?: string;
|
|
1191
1210
|
/** Referenced text content. */
|
|
1192
1211
|
content?: string;
|
|
1193
1212
|
/** Document metadata. */
|
|
@@ -1198,6 +1217,7 @@ declare namespace gapi.client {
|
|
|
1198
1217
|
document?: string;
|
|
1199
1218
|
/** Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */
|
|
1200
1219
|
domain?: string;
|
|
1220
|
+
language?: 'LANGUAGE_UNSPECIFIED' | 'PYTHON' | 'SQL';
|
|
1201
1221
|
/** The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
1202
1222
|
mimeType?: string;
|
|
1203
1223
|
/** Page identifier. */
|
|
@@ -1219,6 +1239,12 @@ declare namespace gapi.client {
|
|
|
1219
1239
|
/** The text segment itself. */
|
|
1220
1240
|
text?: string;
|
|
1221
1241
|
}
|
|
1242
|
+
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment {
|
|
1243
|
+
/** The content id of the visual segment. In order to display the citation of the visual element, this content_id needs to match with the `grounded_content.content_metadata.content_id` field. */
|
|
1244
|
+
contentId?: string;
|
|
1245
|
+
/** References for the visual segment. */
|
|
1246
|
+
referenceIndices?: number[];
|
|
1247
|
+
}
|
|
1222
1248
|
interface GoogleCloudDiscoveryengineV1alphaAssistantToolInfo {
|
|
1223
1249
|
/** The display name of the tool. */
|
|
1224
1250
|
toolDisplayName?: string;
|
|
@@ -1272,6 +1298,14 @@ declare namespace gapi.client {
|
|
|
1272
1298
|
| 'DATA_INGESTION'
|
|
1273
1299
|
| 'ACTIONS'
|
|
1274
1300
|
| 'END_USER_AUTHENTICATION'[];
|
|
1301
|
+
/** Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first). */
|
|
1302
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride;
|
|
1303
|
+
}
|
|
1304
|
+
interface GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride {
|
|
1305
|
+
/** Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first. */
|
|
1306
|
+
baseVersion?: string;
|
|
1307
|
+
/** Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool. */
|
|
1308
|
+
tools?: {[P in string]: any}[];
|
|
1275
1309
|
}
|
|
1276
1310
|
interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
1277
1311
|
/** Operation create time. */
|
|
@@ -1678,6 +1712,10 @@ declare namespace gapi.client {
|
|
|
1678
1712
|
/** Output only. List of citations. */
|
|
1679
1713
|
citations?: GoogleCloudDiscoveryengineV1alphaCitation[];
|
|
1680
1714
|
}
|
|
1715
|
+
interface GoogleCloudDiscoveryengineV1alphaCliConfig {
|
|
1716
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
1717
|
+
enabledActions?: string[];
|
|
1718
|
+
}
|
|
1681
1719
|
interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
|
|
1682
1720
|
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
1683
1721
|
databaseId?: string;
|
|
@@ -2121,6 +2159,8 @@ declare namespace gapi.client {
|
|
|
2121
2159
|
| 'ALLOWLIST_STATIC_IP'
|
|
2122
2160
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
2123
2161
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
2162
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
2163
|
+
cliConfig?: GoogleCloudDiscoveryengineV1alphaCliConfig;
|
|
2124
2164
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
2125
2165
|
connectorModes?:
|
|
2126
2166
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -2129,6 +2169,8 @@ declare namespace gapi.client {
|
|
|
2129
2169
|
| 'FEDERATED'
|
|
2130
2170
|
| 'EUA'
|
|
2131
2171
|
| 'FEDERATED_AND_EUA'[];
|
|
2172
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
2173
|
+
connectorSourceId?: string;
|
|
2132
2174
|
/** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */
|
|
2133
2175
|
connectorType?:
|
|
2134
2176
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -2158,7 +2200,7 @@ declare namespace gapi.client {
|
|
|
2158
2200
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
2159
2201
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
2160
2202
|
dynamicTools?: GoogleCloudDiscoveryengineV1alphaDynamicTool[];
|
|
2161
|
-
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.
|
|
2203
|
+
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. */
|
|
2162
2204
|
egressFqdns?: string[];
|
|
2163
2205
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
2164
2206
|
endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
|
|
@@ -2186,7 +2228,7 @@ declare namespace gapi.client {
|
|
|
2186
2228
|
lastSyncTime?: string;
|
|
2187
2229
|
/** Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. */
|
|
2188
2230
|
latestPauseTime?: string;
|
|
2189
|
-
/**
|
|
2231
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
2190
2232
|
name?: string;
|
|
2191
2233
|
/** Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. */
|
|
2192
2234
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -2228,7 +2270,7 @@ declare namespace gapi.client {
|
|
|
2228
2270
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
2229
2271
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
2230
2272
|
updateTime?: string;
|
|
2231
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
2273
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
2232
2274
|
vpcscEnabled?: boolean;
|
|
2233
2275
|
}
|
|
2234
2276
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
|
|
@@ -2316,6 +2358,8 @@ declare namespace gapi.client {
|
|
|
2316
2358
|
| 'GOOGLE_WORKSPACE';
|
|
2317
2359
|
/** Output only. Timestamp the DataStore was created at. */
|
|
2318
2360
|
createTime?: string;
|
|
2361
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
2362
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
2319
2363
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
2320
2364
|
defaultSchemaId?: string;
|
|
2321
2365
|
/** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
@@ -2557,7 +2601,7 @@ declare namespace gapi.client {
|
|
|
2557
2601
|
id?: string;
|
|
2558
2602
|
/** Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. */
|
|
2559
2603
|
indexStatus?: GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus;
|
|
2560
|
-
/** Output only. The
|
|
2604
|
+
/** Output only. The time when the document was last indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. If this field is not populated, it means the document has never been indexed. */
|
|
2561
2605
|
indexTime?: string;
|
|
2562
2606
|
/** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
|
|
2563
2607
|
jsonData?: string;
|
|
@@ -2591,7 +2635,7 @@ declare namespace gapi.client {
|
|
|
2591
2635
|
interface GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus {
|
|
2592
2636
|
/** A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. */
|
|
2593
2637
|
errorSamples?: GoogleRpcStatus[];
|
|
2594
|
-
/** The time when the document was indexed. If this field is populated, it means the document has been indexed. */
|
|
2638
|
+
/** The time when the document was indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. */
|
|
2595
2639
|
indexTime?: string;
|
|
2596
2640
|
/** Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. */
|
|
2597
2641
|
pendingMessage?: string;
|
|
@@ -2720,7 +2764,7 @@ declare namespace gapi.client {
|
|
|
2720
2764
|
disableAnalytics?: boolean;
|
|
2721
2765
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2722
2766
|
displayName?: string;
|
|
2723
|
-
/** 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` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
2767
|
+
/** 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` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
2724
2768
|
features?: {
|
|
2725
2769
|
[P in string]:
|
|
2726
2770
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -2981,6 +3025,8 @@ declare namespace gapi.client {
|
|
|
2981
3025
|
externalId?: string;
|
|
2982
3026
|
/** Metadata corresponding to the external user. */
|
|
2983
3027
|
groupMetadata?: any;
|
|
3028
|
+
/** Output only. Represents the canonical IAM subject identifier (for users) or group identifier (for groups), derived from the workforce-pool claim mapping. Falls back to custom logic if not set. This must be used for IAM bindings. */
|
|
3029
|
+
subject?: string;
|
|
2984
3030
|
/** Metadata corresponding to the external user. */
|
|
2985
3031
|
userMetadata?: GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata;
|
|
2986
3032
|
}
|
|
@@ -2990,7 +3036,7 @@ declare namespace gapi.client {
|
|
|
2990
3036
|
familyName?: string;
|
|
2991
3037
|
/** The user's given name. */
|
|
2992
3038
|
givenName?: string;
|
|
2993
|
-
/** The user's primary email address. */
|
|
3039
|
+
/** The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject. */
|
|
2994
3040
|
primaryEmail?: string;
|
|
2995
3041
|
}
|
|
2996
3042
|
interface GoogleCloudDiscoveryengineV1alphaFactChunk {
|
|
@@ -3009,6 +3055,51 @@ declare namespace gapi.client {
|
|
|
3009
3055
|
/** The URI of the source. */
|
|
3010
3056
|
uri?: string;
|
|
3011
3057
|
}
|
|
3058
|
+
interface GoogleCloudDiscoveryengineV1alphaFeedback {
|
|
3059
|
+
/** Optional. The additional user comment of the feedback if user gives a thumb down. */
|
|
3060
|
+
comment?: string;
|
|
3061
|
+
/** Optional. The version of the component that this report is being sent from. */
|
|
3062
|
+
componentVersion?: string;
|
|
3063
|
+
/** The related conversation information when user gives feedback. */
|
|
3064
|
+
conversationInfo?: GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo;
|
|
3065
|
+
/** Optional. Whether the customer accepted data use terms. */
|
|
3066
|
+
dataTermsAccepted?: boolean;
|
|
3067
|
+
/** Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. */
|
|
3068
|
+
feedbackSource?:
|
|
3069
|
+
| 'FEEDBACK_SOURCE_UNSPECIFIED'
|
|
3070
|
+
| 'GOOGLE_CONSOLE'
|
|
3071
|
+
| 'GOOGLE_WIDGET'
|
|
3072
|
+
| 'GOOGLE_WEBAPP'
|
|
3073
|
+
| 'GOOGLE_AGENTSPACE_MOBILE';
|
|
3074
|
+
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
3075
|
+
feedbackType?: 'FEEDBACK_TYPE_UNSPECIFIED' | 'LIKE' | 'DISLIKE';
|
|
3076
|
+
/** The version of the LLM model that was used to generate the response. */
|
|
3077
|
+
llmModelVersion?: string;
|
|
3078
|
+
/** Optional. The reason if user gives a thumb down. */
|
|
3079
|
+
reasons?:
|
|
3080
|
+
| 'REASON_UNSPECIFIED'
|
|
3081
|
+
| 'INACCURATE_RESPONSE'
|
|
3082
|
+
| 'NOT_RELEVANT'
|
|
3083
|
+
| 'INCOMPREHENSIVE'
|
|
3084
|
+
| 'OFFENSIVE_OR_UNSAFE'
|
|
3085
|
+
| 'FORMAT_AND_STYLES'
|
|
3086
|
+
| 'BAD_CITATION'
|
|
3087
|
+
| 'CANVAS_NOT_GENERATED'
|
|
3088
|
+
| 'CANVAS_QUALITY_BAD'
|
|
3089
|
+
| 'CANVAS_EXPORT_FAILED'[];
|
|
3090
|
+
}
|
|
3091
|
+
interface GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo {
|
|
3092
|
+
/** Optional. The token which could be used to fetch the answer log. */
|
|
3093
|
+
answerQueryToken?: string;
|
|
3094
|
+
/** Optional. The token which could be used to fetch the assistant log. */
|
|
3095
|
+
assistToken?: string;
|
|
3096
|
+
/** Required. The user's search query. */
|
|
3097
|
+
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
3098
|
+
/** The index of the user input within the conversation messages. */
|
|
3099
|
+
questionIndex?: number;
|
|
3100
|
+
/** Name of the newly generated or continued session. */
|
|
3101
|
+
session?: string;
|
|
3102
|
+
}
|
|
3012
3103
|
interface GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
|
|
3013
3104
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
3014
3105
|
nextPageToken?: string;
|
|
@@ -3086,7 +3177,7 @@ declare namespace gapi.client {
|
|
|
3086
3177
|
| 'RETRIEVABLE_DISABLED';
|
|
3087
3178
|
/** Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished */
|
|
3088
3179
|
schemaOrgPaths?: string[];
|
|
3089
|
-
/** Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. */
|
|
3180
|
+
/** Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). */
|
|
3090
3181
|
searchableFieldImportance?:
|
|
3091
3182
|
| 'SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED'
|
|
3092
3183
|
| 'VERY_LOW_IMPORTANCE'
|
|
@@ -3456,7 +3547,7 @@ declare namespace gapi.client {
|
|
|
3456
3547
|
failureCount?: string;
|
|
3457
3548
|
/** Count of entries that were processed successfully. */
|
|
3458
3549
|
successCount?: string;
|
|
3459
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3550
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
3460
3551
|
updateTime?: string;
|
|
3461
3552
|
}
|
|
3462
3553
|
interface GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest {
|
|
@@ -3688,6 +3779,12 @@ declare namespace gapi.client {
|
|
|
3688
3779
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
3689
3780
|
nextPageToken?: string;
|
|
3690
3781
|
}
|
|
3782
|
+
interface GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse {
|
|
3783
|
+
/** All the customer's LicenseConfigs. */
|
|
3784
|
+
licenseConfigs?: GoogleCloudDiscoveryengineV1alphaLicenseConfig[];
|
|
3785
|
+
/** Not supported. */
|
|
3786
|
+
nextPageToken?: string;
|
|
3787
|
+
}
|
|
3691
3788
|
interface GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse {
|
|
3692
3789
|
/** All the customer's LicenseConfigUsageStats. */
|
|
3693
3790
|
licenseConfigUsageStats?: GoogleCloudDiscoveryengineV1alphaLicenseConfigUsageStats[];
|
|
@@ -3719,7 +3816,7 @@ declare namespace gapi.client {
|
|
|
3719
3816
|
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
3720
3817
|
/** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
|
|
3721
3818
|
filter?: string;
|
|
3722
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
3819
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
3723
3820
|
orderBy?: string;
|
|
3724
3821
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
3725
3822
|
pageSize?: number;
|
|
@@ -3865,6 +3962,13 @@ declare namespace gapi.client {
|
|
|
3865
3962
|
startTime?: string;
|
|
3866
3963
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
3867
3964
|
terminateTime?: string;
|
|
3965
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
3966
|
+
updateType?:
|
|
3967
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
3968
|
+
| 'CREATE'
|
|
3969
|
+
| 'DELETE'
|
|
3970
|
+
| 'SCALE_UP'
|
|
3971
|
+
| 'SCALE_DOWN';
|
|
3868
3972
|
}
|
|
3869
3973
|
interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig {
|
|
3870
3974
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -4044,6 +4148,8 @@ declare namespace gapi.client {
|
|
|
4044
4148
|
top5?: number;
|
|
4045
4149
|
}
|
|
4046
4150
|
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
4151
|
+
/** Output only. The time at which the server accepted this query. */
|
|
4152
|
+
createTime?: string;
|
|
4047
4153
|
/** Query content parts. */
|
|
4048
4154
|
parts?: GoogleCloudDiscoveryengineV1alphaQueryPart[];
|
|
4049
4155
|
/** Output only. Unique Id for the query. */
|
|
@@ -4138,7 +4244,7 @@ declare namespace gapi.client {
|
|
|
4138
4244
|
content?: string;
|
|
4139
4245
|
/** The unique ID to represent the record. */
|
|
4140
4246
|
id?: string;
|
|
4141
|
-
/** The score of this record based on the given query and selected model. The score will be rounded to
|
|
4247
|
+
/** The score of this record based on the given query and selected model. The score will be rounded to 4 decimal places. If the score is close to 0, it will be rounded to 0.00001 to avoid returning unset. */
|
|
4142
4248
|
score?: number;
|
|
4143
4249
|
/** The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
|
|
4144
4250
|
title?: string;
|
|
@@ -4488,12 +4594,16 @@ declare namespace gapi.client {
|
|
|
4488
4594
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
4489
4595
|
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
4490
4596
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
4597
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
4598
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams;
|
|
4491
4599
|
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
4492
4600
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
4493
4601
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
4494
4602
|
displaySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec;
|
|
4495
4603
|
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
4496
4604
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
4605
|
+
/** Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. */
|
|
4606
|
+
entity?: string;
|
|
4497
4607
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
4498
4608
|
facetSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
4499
4609
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -4526,7 +4636,7 @@ declare namespace gapi.client {
|
|
|
4526
4636
|
query?: string;
|
|
4527
4637
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
4528
4638
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
4529
|
-
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result */
|
|
4639
|
+
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results */
|
|
4530
4640
|
rankingExpression?: string;
|
|
4531
4641
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
4532
4642
|
rankingExpressionBackend?:
|
|
@@ -4691,6 +4801,10 @@ declare namespace gapi.client {
|
|
|
4691
4801
|
| 'DROP_CROWDED_RESULTS'
|
|
4692
4802
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
4693
4803
|
}
|
|
4804
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams {
|
|
4805
|
+
/** Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. */
|
|
4806
|
+
expressionsToPrecompute?: string[];
|
|
4807
|
+
}
|
|
4694
4808
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
4695
4809
|
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
4696
4810
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
@@ -4763,7 +4877,7 @@ declare namespace gapi.client {
|
|
|
4763
4877
|
| 'CONDITION_UNSPECIFIED'
|
|
4764
4878
|
| 'DISABLED'
|
|
4765
4879
|
| 'ENABLED';
|
|
4766
|
-
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.
|
|
4880
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. */
|
|
4767
4881
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
4768
4882
|
}
|
|
4769
4883
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec {
|
|
@@ -5004,6 +5118,8 @@ declare namespace gapi.client {
|
|
|
5004
5118
|
keywordSimilarityScore?: number;
|
|
5005
5119
|
/** Optional. Predicted conversion rate adjustment as a rank. */
|
|
5006
5120
|
pctrRank?: number;
|
|
5121
|
+
/** Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. */
|
|
5122
|
+
precomputedExpressionValues?: number[];
|
|
5007
5123
|
/** Optional. Semantic relevance adjustment. */
|
|
5008
5124
|
relevanceScore?: number;
|
|
5009
5125
|
/** Optional. Semantic similarity adjustment. */
|
|
@@ -5189,6 +5305,8 @@ declare namespace gapi.client {
|
|
|
5189
5305
|
labels?: string[];
|
|
5190
5306
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
5191
5307
|
name?: string;
|
|
5308
|
+
/** Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes. */
|
|
5309
|
+
pendingAsyncAssistOperationId?: string;
|
|
5192
5310
|
/** Output only. The time the session started. */
|
|
5193
5311
|
startTime?: string;
|
|
5194
5312
|
/** The state of the session. */
|
|
@@ -5205,6 +5323,8 @@ declare namespace gapi.client {
|
|
|
5205
5323
|
detailedAnswer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
5206
5324
|
/** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session. */
|
|
5207
5325
|
detailedAssistAnswer?: GoogleCloudDiscoveryengineV1alphaAssistAnswer;
|
|
5326
|
+
/** Optional. Indicates whether this turn is a live turn. */
|
|
5327
|
+
live?: boolean;
|
|
5208
5328
|
/** Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn */
|
|
5209
5329
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
5210
5330
|
/** Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix "google." is reserved for Google-developed functionality. */
|
|
@@ -5354,9 +5474,17 @@ declare namespace gapi.client {
|
|
|
5354
5474
|
assistToken?: string;
|
|
5355
5475
|
/** The tool names of the tools that were invoked. */
|
|
5356
5476
|
invocationTools?: string[];
|
|
5477
|
+
/** The skills executed during the turn. */
|
|
5478
|
+
invokedSkills?: GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill[];
|
|
5357
5479
|
/** Session information. Only included in the final StreamAssistResponse of the response stream. */
|
|
5358
5480
|
sessionInfo?: GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo;
|
|
5359
5481
|
}
|
|
5482
|
+
interface GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill {
|
|
5483
|
+
/** The display name of the skill. */
|
|
5484
|
+
displayName?: string;
|
|
5485
|
+
/** The resource name of the skill. */
|
|
5486
|
+
name?: string;
|
|
5487
|
+
}
|
|
5360
5488
|
interface GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo {
|
|
5361
5489
|
/** Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. */
|
|
5362
5490
|
session?: string;
|
|
@@ -5531,6 +5659,8 @@ declare namespace gapi.client {
|
|
|
5531
5659
|
eventTime?: string;
|
|
5532
5660
|
/** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */
|
|
5533
5661
|
eventType?: string;
|
|
5662
|
+
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
5663
|
+
feedback?: GoogleCloudDiscoveryengineV1alphaFeedback;
|
|
5534
5664
|
/** Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
5535
5665
|
filter?: string;
|
|
5536
5666
|
/** Media-specific info. */
|
|
@@ -5557,6 +5687,8 @@ declare namespace gapi.client {
|
|
|
5557
5687
|
userPseudoId?: string;
|
|
5558
5688
|
}
|
|
5559
5689
|
interface GoogleCloudDiscoveryengineV1alphaUserInfo {
|
|
5690
|
+
/** Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. */
|
|
5691
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation;
|
|
5560
5692
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
5561
5693
|
timeZone?: string;
|
|
5562
5694
|
/** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
|
|
@@ -5564,6 +5696,12 @@ declare namespace gapi.client {
|
|
|
5564
5696
|
/** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. */
|
|
5565
5697
|
userId?: string;
|
|
5566
5698
|
}
|
|
5699
|
+
interface GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation {
|
|
5700
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
5701
|
+
address?: string;
|
|
5702
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
5703
|
+
point?: GoogleTypeLatLng;
|
|
5704
|
+
}
|
|
5567
5705
|
interface GoogleCloudDiscoveryengineV1alphaUserLicense {
|
|
5568
5706
|
/** Output only. User created timestamp. */
|
|
5569
5707
|
createTime?: string;
|
|
@@ -5876,7 +6014,7 @@ declare namespace gapi.client {
|
|
|
5876
6014
|
enableSearchAsYouType?: boolean;
|
|
5877
6015
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
5878
6016
|
enableVisualContentSummary?: boolean;
|
|
5879
|
-
/** 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` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
6017
|
+
/** 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` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
5880
6018
|
features?: {
|
|
5881
6019
|
[P in string]:
|
|
5882
6020
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -5891,6 +6029,8 @@ declare namespace gapi.client {
|
|
|
5891
6029
|
| 'SEARCH_ONLY'
|
|
5892
6030
|
| 'SEARCH_WITH_ANSWER'
|
|
5893
6031
|
| 'SEARCH_WITH_FOLLOW_UPS';
|
|
6032
|
+
/** Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. */
|
|
6033
|
+
modelConfigInfo?: GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo;
|
|
5894
6034
|
/** Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
|
|
5895
6035
|
modelConfigs?: {
|
|
5896
6036
|
[P in string]:
|
|
@@ -5932,6 +6072,24 @@ declare namespace gapi.client {
|
|
|
5932
6072
|
/** The number of top results to generate the answer from. Up to 10. */
|
|
5933
6073
|
resultCount?: number;
|
|
5934
6074
|
}
|
|
6075
|
+
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo {
|
|
6076
|
+
/** 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`. */
|
|
6077
|
+
defaultModelId?: string;
|
|
6078
|
+
/** Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. */
|
|
6079
|
+
resolvedModels?: GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel[];
|
|
6080
|
+
}
|
|
6081
|
+
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel {
|
|
6082
|
+
/** Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. */
|
|
6083
|
+
description?: string;
|
|
6084
|
+
/** 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. */
|
|
6085
|
+
displayName?: string;
|
|
6086
|
+
/** Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). */
|
|
6087
|
+
icon?: string;
|
|
6088
|
+
/** Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. */
|
|
6089
|
+
isPreview?: boolean;
|
|
6090
|
+
/** 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. */
|
|
6091
|
+
modelId?: string;
|
|
6092
|
+
}
|
|
5935
6093
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec {
|
|
5936
6094
|
/** Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. */
|
|
5937
6095
|
generativeAnswerAddOnDisabled?: boolean;
|
|
@@ -5941,7 +6099,7 @@ declare namespace gapi.client {
|
|
|
5941
6099
|
semanticAddOnDisabled?: boolean;
|
|
5942
6100
|
}
|
|
5943
6101
|
interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
|
|
5944
|
-
/** Obfuscated Dasher customer ID. */
|
|
6102
|
+
/** Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. */
|
|
5945
6103
|
dasherCustomerId?: string;
|
|
5946
6104
|
/** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
|
|
5947
6105
|
superAdminEmailAddress?: string;
|
|
@@ -5960,6 +6118,8 @@ declare namespace gapi.client {
|
|
|
5960
6118
|
| 'GOOGLE_PEOPLE';
|
|
5961
6119
|
}
|
|
5962
6120
|
interface GoogleCloudDiscoveryengineV1alphaWorkspaceSettings {
|
|
6121
|
+
/** Whether the calling user's customer domain matches the workspace data stores under this engine. */
|
|
6122
|
+
customerDomainValid?: boolean;
|
|
5963
6123
|
/** Whether an end user has workspace access enabled. */
|
|
5964
6124
|
workspaceAccessEnabled?: boolean;
|
|
5965
6125
|
}
|
|
@@ -5986,6 +6146,8 @@ declare namespace gapi.client {
|
|
|
5986
6146
|
topP?: number;
|
|
5987
6147
|
}
|
|
5988
6148
|
interface GoogleCloudDiscoveryengineV1Assistant {
|
|
6149
|
+
/** Output only. Represents the time when this Assistant was created. */
|
|
6150
|
+
createTime?: string;
|
|
5989
6151
|
/** Optional. Customer policy for the assistant. */
|
|
5990
6152
|
customerPolicy?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
5991
6153
|
/** Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. */
|
|
@@ -6002,6 +6164,8 @@ declare namespace gapi.client {
|
|
|
6002
6164
|
generationConfig?: GoogleCloudDiscoveryengineV1AssistantGenerationConfig;
|
|
6003
6165
|
/** Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
6004
6166
|
name?: string;
|
|
6167
|
+
/** Output only. Represents the time when this Assistant was most recently updated. */
|
|
6168
|
+
updateTime?: string;
|
|
6005
6169
|
/** Optional. The type of web grounding to use. */
|
|
6006
6170
|
webGroundingType?:
|
|
6007
6171
|
| 'WEB_GROUNDING_TYPE_UNSPECIFIED'
|
|
@@ -6067,6 +6231,14 @@ declare namespace gapi.client {
|
|
|
6067
6231
|
| 'DATA_INGESTION'
|
|
6068
6232
|
| 'ACTIONS'
|
|
6069
6233
|
| 'END_USER_AUTHENTICATION'[];
|
|
6234
|
+
/** Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first). */
|
|
6235
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride;
|
|
6236
|
+
}
|
|
6237
|
+
interface GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride {
|
|
6238
|
+
/** Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first. */
|
|
6239
|
+
baseVersion?: string;
|
|
6240
|
+
/** Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool. */
|
|
6241
|
+
tools?: {[P in string]: any}[];
|
|
6070
6242
|
}
|
|
6071
6243
|
interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
6072
6244
|
/** Operation create time. */
|
|
@@ -6583,7 +6755,7 @@ declare namespace gapi.client {
|
|
|
6583
6755
|
disableAnalytics?: boolean;
|
|
6584
6756
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
6585
6757
|
displayName?: string;
|
|
6586
|
-
/** 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` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
6758
|
+
/** 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` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
6587
6759
|
features?: {
|
|
6588
6760
|
[P in string]:
|
|
6589
6761
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -6878,7 +7050,7 @@ declare namespace gapi.client {
|
|
|
6878
7050
|
failureCount?: string;
|
|
6879
7051
|
/** Count of entries that were processed successfully. */
|
|
6880
7052
|
successCount?: string;
|
|
6881
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
7053
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
6882
7054
|
updateTime?: string;
|
|
6883
7055
|
}
|
|
6884
7056
|
interface GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
|
|
@@ -7017,6 +7189,13 @@ declare namespace gapi.client {
|
|
|
7017
7189
|
startTime?: string;
|
|
7018
7190
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
7019
7191
|
terminateTime?: string;
|
|
7192
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
7193
|
+
updateType?:
|
|
7194
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
7195
|
+
| 'CREATE'
|
|
7196
|
+
| 'DELETE'
|
|
7197
|
+
| 'SCALE_UP'
|
|
7198
|
+
| 'SCALE_DOWN';
|
|
7020
7199
|
}
|
|
7021
7200
|
interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig {
|
|
7022
7201
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -7160,12 +7339,16 @@ declare namespace gapi.client {
|
|
|
7160
7339
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
7161
7340
|
/** Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted. */
|
|
7162
7341
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
7342
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
7343
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams;
|
|
7163
7344
|
/** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used. */
|
|
7164
7345
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
7165
7346
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
7166
7347
|
displaySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec;
|
|
7167
7348
|
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
7168
7349
|
embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
7350
|
+
/** Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. */
|
|
7351
|
+
entity?: string;
|
|
7169
7352
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
7170
7353
|
facetSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
7171
7354
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -7198,7 +7381,7 @@ declare namespace gapi.client {
|
|
|
7198
7381
|
query?: string;
|
|
7199
7382
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
7200
7383
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
7201
|
-
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result */
|
|
7384
|
+
/** Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results */
|
|
7202
7385
|
rankingExpression?: string;
|
|
7203
7386
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
7204
7387
|
rankingExpressionBackend?:
|
|
@@ -7361,6 +7544,10 @@ declare namespace gapi.client {
|
|
|
7361
7544
|
| 'DROP_CROWDED_RESULTS'
|
|
7362
7545
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
7363
7546
|
}
|
|
7547
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams {
|
|
7548
|
+
/** Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. */
|
|
7549
|
+
expressionsToPrecompute?: string[];
|
|
7550
|
+
}
|
|
7364
7551
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
7365
7552
|
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
7366
7553
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
@@ -7433,7 +7620,7 @@ declare namespace gapi.client {
|
|
|
7433
7620
|
| 'CONDITION_UNSPECIFIED'
|
|
7434
7621
|
| 'DISABLED'
|
|
7435
7622
|
| 'ENABLED';
|
|
7436
|
-
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.
|
|
7623
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. */
|
|
7437
7624
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
7438
7625
|
}
|
|
7439
7626
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec {
|
|
@@ -7596,6 +7783,8 @@ declare namespace gapi.client {
|
|
|
7596
7783
|
updateTime?: string;
|
|
7597
7784
|
}
|
|
7598
7785
|
interface GoogleCloudDiscoveryengineV1betaUserInfo {
|
|
7786
|
+
/** Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. */
|
|
7787
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation;
|
|
7599
7788
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
7600
7789
|
timeZone?: string;
|
|
7601
7790
|
/** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
|
|
@@ -7603,6 +7792,12 @@ declare namespace gapi.client {
|
|
|
7603
7792
|
/** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. */
|
|
7604
7793
|
userId?: string;
|
|
7605
7794
|
}
|
|
7795
|
+
interface GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation {
|
|
7796
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
7797
|
+
address?: string;
|
|
7798
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
7799
|
+
point?: GoogleTypeLatLng;
|
|
7800
|
+
}
|
|
7606
7801
|
interface GoogleCloudDiscoveryengineV1betaUserLicense {
|
|
7607
7802
|
/** Output only. User created timestamp. */
|
|
7608
7803
|
createTime?: string;
|
|
@@ -7638,7 +7833,7 @@ declare namespace gapi.client {
|
|
|
7638
7833
|
name?: string;
|
|
7639
7834
|
}
|
|
7640
7835
|
interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
|
|
7641
|
-
/** Obfuscated Dasher customer ID. */
|
|
7836
|
+
/** Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. */
|
|
7642
7837
|
dasherCustomerId?: string;
|
|
7643
7838
|
/** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
|
|
7644
7839
|
superAdminEmailAddress?: string;
|
|
@@ -7656,6 +7851,10 @@ declare namespace gapi.client {
|
|
|
7656
7851
|
| 'GOOGLE_KEEP'
|
|
7657
7852
|
| 'GOOGLE_PEOPLE';
|
|
7658
7853
|
}
|
|
7854
|
+
interface GoogleCloudDiscoveryengineV1CliConfig {
|
|
7855
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
7856
|
+
enabledActions?: string[];
|
|
7857
|
+
}
|
|
7659
7858
|
interface GoogleCloudDiscoveryengineV1CmekConfig {
|
|
7660
7859
|
/** Output only. The default CmekConfig for the Customer. */
|
|
7661
7860
|
isDefault?: boolean;
|
|
@@ -7854,6 +8053,8 @@ declare namespace gapi.client {
|
|
|
7854
8053
|
| 'ALLOWLIST_STATIC_IP'
|
|
7855
8054
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
7856
8055
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
8056
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
8057
|
+
cliConfig?: GoogleCloudDiscoveryengineV1CliConfig;
|
|
7857
8058
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
7858
8059
|
connectorModes?:
|
|
7859
8060
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -7862,6 +8063,8 @@ declare namespace gapi.client {
|
|
|
7862
8063
|
| 'FEDERATED'
|
|
7863
8064
|
| 'EUA'
|
|
7864
8065
|
| 'FEDERATED_AND_EUA'[];
|
|
8066
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
8067
|
+
connectorSourceId?: string;
|
|
7865
8068
|
/** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */
|
|
7866
8069
|
connectorType?:
|
|
7867
8070
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -7889,7 +8092,7 @@ declare namespace gapi.client {
|
|
|
7889
8092
|
destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
7890
8093
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
7891
8094
|
dynamicTools?: GoogleCloudDiscoveryengineV1DynamicTool[];
|
|
7892
|
-
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs.
|
|
8095
|
+
/** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. */
|
|
7893
8096
|
egressFqdns?: string[];
|
|
7894
8097
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
7895
8098
|
endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
@@ -7917,7 +8120,7 @@ declare namespace gapi.client {
|
|
|
7917
8120
|
lastSyncTime?: string;
|
|
7918
8121
|
/** Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. */
|
|
7919
8122
|
latestPauseTime?: string;
|
|
7920
|
-
/**
|
|
8123
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
7921
8124
|
name?: string;
|
|
7922
8125
|
/** Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. */
|
|
7923
8126
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -7959,7 +8162,7 @@ declare namespace gapi.client {
|
|
|
7959
8162
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
7960
8163
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
7961
8164
|
updateTime?: string;
|
|
7962
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
8165
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
7963
8166
|
vpcscEnabled?: boolean;
|
|
7964
8167
|
}
|
|
7965
8168
|
interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
@@ -8315,7 +8518,7 @@ declare namespace gapi.client {
|
|
|
8315
8518
|
disableAnalytics?: boolean;
|
|
8316
8519
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
8317
8520
|
displayName?: string;
|
|
8318
|
-
/** 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` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` */
|
|
8521
|
+
/** 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` * `disable-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` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` */
|
|
8319
8522
|
features?: {
|
|
8320
8523
|
[P in string]:
|
|
8321
8524
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -8565,7 +8768,7 @@ declare namespace gapi.client {
|
|
|
8565
8768
|
failureCount?: string;
|
|
8566
8769
|
/** Count of entries that were processed successfully. */
|
|
8567
8770
|
successCount?: string;
|
|
8568
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
8771
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
8569
8772
|
updateTime?: string;
|
|
8570
8773
|
}
|
|
8571
8774
|
interface GoogleCloudDiscoveryengineV1ImportUserEventsResponse {
|
|
@@ -8668,6 +8871,13 @@ declare namespace gapi.client {
|
|
|
8668
8871
|
startTime?: string;
|
|
8669
8872
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
8670
8873
|
terminateTime?: string;
|
|
8874
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
8875
|
+
updateType?:
|
|
8876
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
8877
|
+
| 'CREATE'
|
|
8878
|
+
| 'DELETE'
|
|
8879
|
+
| 'SCALE_UP'
|
|
8880
|
+
| 'SCALE_DOWN';
|
|
8671
8881
|
}
|
|
8672
8882
|
interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig {
|
|
8673
8883
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -9052,7 +9262,7 @@ declare namespace gapi.client {
|
|
|
9052
9262
|
name?: string;
|
|
9053
9263
|
}
|
|
9054
9264
|
interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
|
|
9055
|
-
/** Obfuscated Dasher customer ID. */
|
|
9265
|
+
/** Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. */
|
|
9056
9266
|
dasherCustomerId?: string;
|
|
9057
9267
|
/** Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. */
|
|
9058
9268
|
superAdminEmailAddress?: string;
|
|
@@ -9449,7 +9659,7 @@ declare namespace gapi.client {
|
|
|
9449
9659
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
9450
9660
|
code?: number;
|
|
9451
9661
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
9452
|
-
details?:
|
|
9662
|
+
details?: {[P in string]: any}[];
|
|
9453
9663
|
/** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
|
|
9454
9664
|
message?: string;
|
|
9455
9665
|
}
|
|
@@ -9491,6 +9701,12 @@ declare namespace gapi.client {
|
|
|
9491
9701
|
/** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
|
|
9492
9702
|
title?: string;
|
|
9493
9703
|
}
|
|
9704
|
+
interface GoogleTypeLatLng {
|
|
9705
|
+
/** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
|
|
9706
|
+
latitude?: number;
|
|
9707
|
+
/** The longitude in degrees. It must be in the range [-180.0, +180.0]. */
|
|
9708
|
+
longitude?: number;
|
|
9709
|
+
}
|
|
9494
9710
|
interface GoogleTypeTimeZone {
|
|
9495
9711
|
/** IANA Time Zone Database time zone. For example "America/New_York". */
|
|
9496
9712
|
id?: string;
|
|
@@ -10242,6 +10458,40 @@ declare namespace gapi.client {
|
|
|
10242
10458
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10243
10459
|
uploadType?: string;
|
|
10244
10460
|
}): Request<GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse>;
|
|
10461
|
+
/** ServeMcpDeleteRequest serves a MCP DELETE request. */
|
|
10462
|
+
mcp(request?: {
|
|
10463
|
+
/** V1 error format. */
|
|
10464
|
+
'$.xgafv'?: '1' | '2';
|
|
10465
|
+
/** OAuth access token. */
|
|
10466
|
+
access_token?: string;
|
|
10467
|
+
/** Data format for response. */
|
|
10468
|
+
alt?: 'json' | 'media' | 'proto';
|
|
10469
|
+
/** JSONP */
|
|
10470
|
+
callback?: string;
|
|
10471
|
+
collectionsId: string;
|
|
10472
|
+
/** The HTTP Content-Type header value specifying the content type of the body. */
|
|
10473
|
+
contentType?: string;
|
|
10474
|
+
/** The HTTP request/response body as raw binary. */
|
|
10475
|
+
data?: string;
|
|
10476
|
+
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
10477
|
+
extensions?: {[P in string]: any};
|
|
10478
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10479
|
+
fields?: string;
|
|
10480
|
+
/** 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. */
|
|
10481
|
+
key?: string;
|
|
10482
|
+
locationsId: string;
|
|
10483
|
+
/** OAuth 2.0 token for the current user. */
|
|
10484
|
+
oauth_token?: string;
|
|
10485
|
+
/** Returns response with indentations and line breaks. */
|
|
10486
|
+
prettyPrint?: boolean;
|
|
10487
|
+
projectsId: string;
|
|
10488
|
+
/** 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. */
|
|
10489
|
+
quotaUser?: string;
|
|
10490
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10491
|
+
upload_protocol?: string;
|
|
10492
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10493
|
+
uploadType?: string;
|
|
10494
|
+
}): Request<GoogleApiHttpBody>;
|
|
10245
10495
|
/** Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced. */
|
|
10246
10496
|
startConnectorRun(request: {
|
|
10247
10497
|
/** V1 error format. */
|
|
@@ -12073,7 +12323,7 @@ declare namespace gapi.client {
|
|
|
12073
12323
|
prettyPrint?: boolean;
|
|
12074
12324
|
/** 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. */
|
|
12075
12325
|
quotaUser?: string;
|
|
12076
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12326
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12077
12327
|
servingConfig: string;
|
|
12078
12328
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12079
12329
|
upload_protocol?: string;
|
|
@@ -12102,7 +12352,7 @@ declare namespace gapi.client {
|
|
|
12102
12352
|
prettyPrint?: boolean;
|
|
12103
12353
|
/** 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. */
|
|
12104
12354
|
quotaUser?: string;
|
|
12105
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12355
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12106
12356
|
servingConfig: string;
|
|
12107
12357
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12108
12358
|
upload_protocol?: string;
|
|
@@ -12514,7 +12764,7 @@ declare namespace gapi.client {
|
|
|
12514
12764
|
prettyPrint?: boolean;
|
|
12515
12765
|
/** 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. */
|
|
12516
12766
|
quotaUser?: string;
|
|
12517
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12767
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12518
12768
|
servingConfig: string;
|
|
12519
12769
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12520
12770
|
upload_protocol?: string;
|
|
@@ -12543,7 +12793,7 @@ declare namespace gapi.client {
|
|
|
12543
12793
|
prettyPrint?: boolean;
|
|
12544
12794
|
/** 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. */
|
|
12545
12795
|
quotaUser?: string;
|
|
12546
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12796
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12547
12797
|
servingConfig: string;
|
|
12548
12798
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12549
12799
|
upload_protocol?: string;
|
|
@@ -12605,6 +12855,8 @@ declare namespace gapi.client {
|
|
|
12605
12855
|
prettyPrint?: boolean;
|
|
12606
12856
|
/** 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. */
|
|
12607
12857
|
quotaUser?: string;
|
|
12858
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
12859
|
+
sessionId?: string;
|
|
12608
12860
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12609
12861
|
upload_protocol?: string;
|
|
12610
12862
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -12634,6 +12886,8 @@ declare namespace gapi.client {
|
|
|
12634
12886
|
prettyPrint?: boolean;
|
|
12635
12887
|
/** 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. */
|
|
12636
12888
|
quotaUser?: string;
|
|
12889
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
12890
|
+
sessionId?: string;
|
|
12637
12891
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12638
12892
|
upload_protocol?: string;
|
|
12639
12893
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -12715,7 +12969,7 @@ declare namespace gapi.client {
|
|
|
12715
12969
|
key?: string;
|
|
12716
12970
|
/** OAuth 2.0 token for the current user. */
|
|
12717
12971
|
oauth_token?: string;
|
|
12718
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
12972
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
12719
12973
|
orderBy?: string;
|
|
12720
12974
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
12721
12975
|
pageSize?: number;
|
|
@@ -15129,7 +15383,7 @@ declare namespace gapi.client {
|
|
|
15129
15383
|
callback?: string;
|
|
15130
15384
|
/** Selector specifying which fields to include in a partial response. */
|
|
15131
15385
|
fields?: string;
|
|
15132
|
-
/** Optional. Filters the Agents list. Supported fields: * `display_name`: display name of the agent. Supports `=`, `:`. * `id`: ID of the agent. Supports `=`. * `state`: state of the agent. Supports `=`. * `
|
|
15386
|
+
/** Optional. Filters the Agents list. Supported fields: * `display_name`: display name of the agent. Supports `=`, `:`. * `id`: ID of the agent. Supports `=`. * `state`: state of the agent. Supports `=`. * `create_time`: timestamp when the agent was created. Supports `=`, `>`, `<`, `>=`, `<=`. * `update_time`: timestamp when the agent was last updated. Supports `=`, `>`, `<`, `>=`, `<=`. Examples: * `display_name = "My Agent"` * `create_time > "2023-01-01T00:00:00Z"` */
|
|
15133
15387
|
filter?: string;
|
|
15134
15388
|
/** 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. */
|
|
15135
15389
|
key?: string;
|
|
@@ -16386,7 +16640,7 @@ declare namespace gapi.client {
|
|
|
16386
16640
|
prettyPrint?: boolean;
|
|
16387
16641
|
/** 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. */
|
|
16388
16642
|
quotaUser?: string;
|
|
16389
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
16643
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
16390
16644
|
servingConfig: string;
|
|
16391
16645
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16392
16646
|
upload_protocol?: string;
|
|
@@ -16415,7 +16669,7 @@ declare namespace gapi.client {
|
|
|
16415
16669
|
prettyPrint?: boolean;
|
|
16416
16670
|
/** 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. */
|
|
16417
16671
|
quotaUser?: string;
|
|
16418
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
16672
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
16419
16673
|
servingConfig: string;
|
|
16420
16674
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16421
16675
|
upload_protocol?: string;
|
|
@@ -16827,7 +17081,7 @@ declare namespace gapi.client {
|
|
|
16827
17081
|
prettyPrint?: boolean;
|
|
16828
17082
|
/** 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. */
|
|
16829
17083
|
quotaUser?: string;
|
|
16830
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17084
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
16831
17085
|
servingConfig: string;
|
|
16832
17086
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16833
17087
|
upload_protocol?: string;
|
|
@@ -16856,7 +17110,7 @@ declare namespace gapi.client {
|
|
|
16856
17110
|
prettyPrint?: boolean;
|
|
16857
17111
|
/** 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. */
|
|
16858
17112
|
quotaUser?: string;
|
|
16859
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
17113
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
16860
17114
|
servingConfig: string;
|
|
16861
17115
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16862
17116
|
upload_protocol?: string;
|
|
@@ -17016,6 +17270,8 @@ declare namespace gapi.client {
|
|
|
17016
17270
|
prettyPrint?: boolean;
|
|
17017
17271
|
/** 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. */
|
|
17018
17272
|
quotaUser?: string;
|
|
17273
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
17274
|
+
sessionId?: string;
|
|
17019
17275
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17020
17276
|
upload_protocol?: string;
|
|
17021
17277
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -17045,6 +17301,8 @@ declare namespace gapi.client {
|
|
|
17045
17301
|
prettyPrint?: boolean;
|
|
17046
17302
|
/** 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. */
|
|
17047
17303
|
quotaUser?: string;
|
|
17304
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
17305
|
+
sessionId?: string;
|
|
17048
17306
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17049
17307
|
upload_protocol?: string;
|
|
17050
17308
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -17126,7 +17384,7 @@ declare namespace gapi.client {
|
|
|
17126
17384
|
key?: string;
|
|
17127
17385
|
/** OAuth 2.0 token for the current user. */
|
|
17128
17386
|
oauth_token?: string;
|
|
17129
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
17387
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
17130
17388
|
orderBy?: string;
|
|
17131
17389
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
17132
17390
|
pageSize?: number;
|
|
@@ -17689,7 +17947,7 @@ declare namespace gapi.client {
|
|
|
17689
17947
|
},
|
|
17690
17948
|
body: GoogleCloudDiscoveryengineV1alphaResumeEngineRequest,
|
|
17691
17949
|
): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
|
|
17692
|
-
/** Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user`
|
|
17950
|
+
/** Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging. */
|
|
17693
17951
|
setIamPolicy(
|
|
17694
17952
|
request: {
|
|
17695
17953
|
/** V1 error format. */
|
|
@@ -18042,7 +18300,7 @@ declare namespace gapi.client {
|
|
|
18042
18300
|
fields?: string;
|
|
18043
18301
|
/** 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. */
|
|
18044
18302
|
key?: string;
|
|
18045
|
-
/**
|
|
18303
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
18046
18304
|
name: string;
|
|
18047
18305
|
/** OAuth 2.0 token for the current user. */
|
|
18048
18306
|
oauth_token?: string;
|
|
@@ -18073,7 +18331,7 @@ declare namespace gapi.client {
|
|
|
18073
18331
|
fields?: string;
|
|
18074
18332
|
/** 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. */
|
|
18075
18333
|
key?: string;
|
|
18076
|
-
/**
|
|
18334
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
18077
18335
|
name: string;
|
|
18078
18336
|
/** OAuth 2.0 token for the current user. */
|
|
18079
18337
|
oauth_token?: string;
|
|
@@ -19771,7 +20029,7 @@ declare namespace gapi.client {
|
|
|
19771
20029
|
prettyPrint?: boolean;
|
|
19772
20030
|
/** 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. */
|
|
19773
20031
|
quotaUser?: string;
|
|
19774
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
20032
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
19775
20033
|
servingConfig: string;
|
|
19776
20034
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19777
20035
|
upload_protocol?: string;
|
|
@@ -19800,7 +20058,7 @@ declare namespace gapi.client {
|
|
|
19800
20058
|
prettyPrint?: boolean;
|
|
19801
20059
|
/** 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. */
|
|
19802
20060
|
quotaUser?: string;
|
|
19803
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
20061
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
19804
20062
|
servingConfig: string;
|
|
19805
20063
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19806
20064
|
upload_protocol?: string;
|
|
@@ -20212,7 +20470,7 @@ declare namespace gapi.client {
|
|
|
20212
20470
|
prettyPrint?: boolean;
|
|
20213
20471
|
/** 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. */
|
|
20214
20472
|
quotaUser?: string;
|
|
20215
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
20473
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
20216
20474
|
servingConfig: string;
|
|
20217
20475
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20218
20476
|
upload_protocol?: string;
|
|
@@ -20241,7 +20499,7 @@ declare namespace gapi.client {
|
|
|
20241
20499
|
prettyPrint?: boolean;
|
|
20242
20500
|
/** 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. */
|
|
20243
20501
|
quotaUser?: string;
|
|
20244
|
-
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
20502
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
20245
20503
|
servingConfig: string;
|
|
20246
20504
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20247
20505
|
upload_protocol?: string;
|
|
@@ -20303,6 +20561,8 @@ declare namespace gapi.client {
|
|
|
20303
20561
|
prettyPrint?: boolean;
|
|
20304
20562
|
/** 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. */
|
|
20305
20563
|
quotaUser?: string;
|
|
20564
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
20565
|
+
sessionId?: string;
|
|
20306
20566
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20307
20567
|
upload_protocol?: string;
|
|
20308
20568
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -20332,6 +20592,8 @@ declare namespace gapi.client {
|
|
|
20332
20592
|
prettyPrint?: boolean;
|
|
20333
20593
|
/** 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. */
|
|
20334
20594
|
quotaUser?: string;
|
|
20595
|
+
/** Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. */
|
|
20596
|
+
sessionId?: string;
|
|
20335
20597
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20336
20598
|
upload_protocol?: string;
|
|
20337
20599
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -20413,7 +20675,7 @@ declare namespace gapi.client {
|
|
|
20413
20675
|
key?: string;
|
|
20414
20676
|
/** OAuth 2.0 token for the current user. */
|
|
20415
20677
|
oauth_token?: string;
|
|
20416
|
-
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
20678
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
|
|
20417
20679
|
orderBy?: string;
|
|
20418
20680
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
20419
20681
|
pageSize?: number;
|
|
@@ -22799,6 +23061,39 @@ declare namespace gapi.client {
|
|
|
22799
23061
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
22800
23062
|
uploadType?: string;
|
|
22801
23063
|
}): Request<GoogleCloudDiscoveryengineV1alphaLicenseConfig>;
|
|
23064
|
+
/** Lists all the LicenseConfigs associated with the project. */
|
|
23065
|
+
list(request?: {
|
|
23066
|
+
/** V1 error format. */
|
|
23067
|
+
'$.xgafv'?: '1' | '2';
|
|
23068
|
+
/** OAuth access token. */
|
|
23069
|
+
access_token?: string;
|
|
23070
|
+
/** Data format for response. */
|
|
23071
|
+
alt?: 'json' | 'media' | 'proto';
|
|
23072
|
+
/** JSONP */
|
|
23073
|
+
callback?: string;
|
|
23074
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
23075
|
+
fields?: string;
|
|
23076
|
+
/** Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. */
|
|
23077
|
+
filter?: string;
|
|
23078
|
+
/** 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. */
|
|
23079
|
+
key?: string;
|
|
23080
|
+
/** OAuth 2.0 token for the current user. */
|
|
23081
|
+
oauth_token?: string;
|
|
23082
|
+
/** Optional. Not supported. */
|
|
23083
|
+
pageSize?: number;
|
|
23084
|
+
/** Optional. Not supported. */
|
|
23085
|
+
pageToken?: string;
|
|
23086
|
+
/** Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. */
|
|
23087
|
+
parent: string;
|
|
23088
|
+
/** Returns response with indentations and line breaks. */
|
|
23089
|
+
prettyPrint?: boolean;
|
|
23090
|
+
/** 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. */
|
|
23091
|
+
quotaUser?: string;
|
|
23092
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
23093
|
+
upload_protocol?: string;
|
|
23094
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
23095
|
+
uploadType?: string;
|
|
23096
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>;
|
|
22802
23097
|
/** Updates the LicenseConfig */
|
|
22803
23098
|
patch(request: {
|
|
22804
23099
|
/** V1 error format. */
|
|
@@ -24318,13 +24613,15 @@ declare namespace gapi.client {
|
|
|
24318
24613
|
callback?: string;
|
|
24319
24614
|
/** Selector specifying which fields to include in a partial response. */
|
|
24320
24615
|
fields?: string;
|
|
24616
|
+
/** Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@example.com` to list user license for `user1@example.com`. */
|
|
24617
|
+
filter?: string;
|
|
24321
24618
|
/** 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. */
|
|
24322
24619
|
key?: string;
|
|
24323
24620
|
/** OAuth 2.0 token for the current user. */
|
|
24324
24621
|
oauth_token?: string;
|
|
24325
|
-
/** Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields
|
|
24622
|
+
/** Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order. */
|
|
24326
24623
|
orderBy?: string;
|
|
24327
|
-
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
24624
|
+
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. */
|
|
24328
24625
|
pageSize?: number;
|
|
24329
24626
|
/** Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. */
|
|
24330
24627
|
pageToken?: string;
|