@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.2.20260317 → 0.2.20260606
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 +646 -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: 20260606
|
|
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,12 @@ 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 tool/action name being executed. If provided, the server will check the required scopes of the action and dynamically trigger incremental authorization if they are missing. */
|
|
253
|
+
action?: string;
|
|
254
|
+
/** Optional. The scope to request for the access token. Scope will override default scope if specified. */
|
|
255
|
+
scope?: string;
|
|
256
|
+
}
|
|
250
257
|
interface GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse {
|
|
251
258
|
/** The created access token. */
|
|
252
259
|
accessToken?: string;
|
|
@@ -256,6 +263,8 @@ declare namespace gapi.client {
|
|
|
256
263
|
interface GoogleCloudDiscoveryengineV1alphaActionConfig {
|
|
257
264
|
/** Optional. Action parameters in structured json format. */
|
|
258
265
|
actionParams?: {[P in string]: any};
|
|
266
|
+
/** Optional. Whether to create a BAP connection for the connector. */
|
|
267
|
+
createBapConnection?: boolean;
|
|
259
268
|
/** Output only. The connector contains the necessary parameters and is configured to support actions. */
|
|
260
269
|
isActionConfigured?: boolean;
|
|
261
270
|
/** Optional. Action parameters in json string format. */
|
|
@@ -453,7 +462,8 @@ declare namespace gapi.client {
|
|
|
453
462
|
| 'DEPLOYMENT_FAILED'
|
|
454
463
|
| 'PRIVATE'
|
|
455
464
|
| 'ENABLED'
|
|
456
|
-
| 'SUSPENDED'
|
|
465
|
+
| 'SUSPENDED'
|
|
466
|
+
| 'CREATING';
|
|
457
467
|
/** Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED. */
|
|
458
468
|
suspensionReason?: string;
|
|
459
469
|
/** Output only. Timestamp when this Agent was most recently updated. */
|
|
@@ -558,7 +568,7 @@ declare namespace gapi.client {
|
|
|
558
568
|
| 'UNHELPFUL_ANSWER'[];
|
|
559
569
|
/** The textual answer. */
|
|
560
570
|
answerText?: string;
|
|
561
|
-
/** List of blob attachments in the answer. */
|
|
571
|
+
/** Output only. List of blob attachments in the answer. */
|
|
562
572
|
blobAttachments?: GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment[];
|
|
563
573
|
/** Citations. */
|
|
564
574
|
citations?: GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
@@ -804,7 +814,7 @@ declare namespace gapi.client {
|
|
|
804
814
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams {
|
|
805
815
|
/** 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
816
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
807
|
-
/** Custom fine tuning configs. */
|
|
817
|
+
/** Optional. Custom fine tuning configs. */
|
|
808
818
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
809
819
|
/** 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
820
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
@@ -1036,7 +1046,8 @@ declare namespace gapi.client {
|
|
|
1036
1046
|
| 'IN_PROGRESS'
|
|
1037
1047
|
| 'FAILED'
|
|
1038
1048
|
| 'SUCCEEDED'
|
|
1039
|
-
| 'SKIPPED'
|
|
1049
|
+
| 'SKIPPED'
|
|
1050
|
+
| 'CANCELLED';
|
|
1040
1051
|
}
|
|
1041
1052
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult {
|
|
1042
1053
|
/** 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 +1072,16 @@ declare namespace gapi.client {
|
|
|
1061
1072
|
modelArmorEnforcementResult?: GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
1062
1073
|
}
|
|
1063
1074
|
interface GoogleCloudDiscoveryengineV1alphaAssistAnswerReply {
|
|
1075
|
+
/** The time when the reply was created. */
|
|
1076
|
+
createTime?: string;
|
|
1064
1077
|
/** Possibly grounded response text or media from the assistant. */
|
|
1065
1078
|
groundedContent?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
|
|
1066
1079
|
/** 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
1080
|
replyId?: string;
|
|
1068
1081
|
}
|
|
1069
1082
|
interface GoogleCloudDiscoveryengineV1alphaAssistant {
|
|
1083
|
+
/** Output only. Represents the time when this Assistant was created. */
|
|
1084
|
+
createTime?: string;
|
|
1070
1085
|
/** Optional. Customer policy for the assistant. */
|
|
1071
1086
|
customerPolicy?: GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy;
|
|
1072
1087
|
/** 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 +1100,8 @@ declare namespace gapi.client {
|
|
|
1085
1100
|
generationConfig?: GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig;
|
|
1086
1101
|
/** 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
1102
|
name?: string;
|
|
1103
|
+
/** Output only. Represents the time when this Assistant was most recently updated. */
|
|
1104
|
+
updateTime?: string;
|
|
1088
1105
|
/** Optional. The type of web grounding to use. */
|
|
1089
1106
|
webGroundingType?:
|
|
1090
1107
|
| 'WEB_GROUNDING_TYPE_UNSPECIFIED'
|
|
@@ -1137,6 +1154,8 @@ declare namespace gapi.client {
|
|
|
1137
1154
|
interface GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy {
|
|
1138
1155
|
/** Optional. List of banned phrases. */
|
|
1139
1156
|
bannedPhrases?: GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase[];
|
|
1157
|
+
/** Optional. Data protection policy to be used for sanitizing file uploads. */
|
|
1158
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
1140
1159
|
/** Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. */
|
|
1141
1160
|
modelArmorConfig?: GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig;
|
|
1142
1161
|
}
|
|
@@ -1186,8 +1205,12 @@ declare namespace gapi.client {
|
|
|
1186
1205
|
references?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
1187
1206
|
/** Grounding information for parts of the text. */
|
|
1188
1207
|
segments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
1208
|
+
/** Grounding information for parts of the visual content. */
|
|
1209
|
+
visualSegments?: GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment[];
|
|
1189
1210
|
}
|
|
1190
1211
|
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference {
|
|
1212
|
+
/** Chunk of code snippet from the referenced document. */
|
|
1213
|
+
codeSnippet?: string;
|
|
1191
1214
|
/** Referenced text content. */
|
|
1192
1215
|
content?: string;
|
|
1193
1216
|
/** Document metadata. */
|
|
@@ -1198,6 +1221,7 @@ declare namespace gapi.client {
|
|
|
1198
1221
|
document?: string;
|
|
1199
1222
|
/** 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
1223
|
domain?: string;
|
|
1224
|
+
language?: 'LANGUAGE_UNSPECIFIED' | 'PYTHON' | 'SQL';
|
|
1201
1225
|
/** The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
1202
1226
|
mimeType?: string;
|
|
1203
1227
|
/** Page identifier. */
|
|
@@ -1219,6 +1243,12 @@ declare namespace gapi.client {
|
|
|
1219
1243
|
/** The text segment itself. */
|
|
1220
1244
|
text?: string;
|
|
1221
1245
|
}
|
|
1246
|
+
interface GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataVisualSegment {
|
|
1247
|
+
/** 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. */
|
|
1248
|
+
contentId?: string;
|
|
1249
|
+
/** References for the visual segment. */
|
|
1250
|
+
referenceIndices?: number[];
|
|
1251
|
+
}
|
|
1222
1252
|
interface GoogleCloudDiscoveryengineV1alphaAssistantToolInfo {
|
|
1223
1253
|
/** The display name of the tool. */
|
|
1224
1254
|
toolDisplayName?: string;
|
|
@@ -1272,6 +1302,14 @@ declare namespace gapi.client {
|
|
|
1272
1302
|
| 'DATA_INGESTION'
|
|
1273
1303
|
| 'ACTIONS'
|
|
1274
1304
|
| 'END_USER_AUTHENTICATION'[];
|
|
1305
|
+
/** 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). */
|
|
1306
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride;
|
|
1307
|
+
}
|
|
1308
|
+
interface GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride {
|
|
1309
|
+
/** 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. */
|
|
1310
|
+
baseVersion?: string;
|
|
1311
|
+
/** 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. */
|
|
1312
|
+
tools?: {[P in string]: any}[];
|
|
1275
1313
|
}
|
|
1276
1314
|
interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
1277
1315
|
/** Operation create time. */
|
|
@@ -1678,6 +1716,10 @@ declare namespace gapi.client {
|
|
|
1678
1716
|
/** Output only. List of citations. */
|
|
1679
1717
|
citations?: GoogleCloudDiscoveryengineV1alphaCitation[];
|
|
1680
1718
|
}
|
|
1719
|
+
interface GoogleCloudDiscoveryengineV1alphaCliConfig {
|
|
1720
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
1721
|
+
enabledActions?: string[];
|
|
1722
|
+
}
|
|
1681
1723
|
interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
|
|
1682
1724
|
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
1683
1725
|
databaseId?: string;
|
|
@@ -1750,6 +1792,28 @@ declare namespace gapi.client {
|
|
|
1750
1792
|
/** The suggestion for the query. */
|
|
1751
1793
|
suggestion?: string;
|
|
1752
1794
|
}
|
|
1795
|
+
interface GoogleCloudDiscoveryengineV1alphaCompletionConfig {
|
|
1796
|
+
/** The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine. */
|
|
1797
|
+
enableMode?: 'ENABLE_MODE_UNSPECIFIED' | 'AUTOMATIC' | 'MANUAL';
|
|
1798
|
+
/** If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by [DLP](https://cloud.google.com/security/products/dlp) under the hood. */
|
|
1799
|
+
filterPiiSuggestionsUsingDlp?: boolean;
|
|
1800
|
+
/** The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: * `out-of-order` * `exact-prefix` Default value: `exact-prefix`. */
|
|
1801
|
+
matchingOrder?: string;
|
|
1802
|
+
/** The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. */
|
|
1803
|
+
maxSuggestions?: number;
|
|
1804
|
+
/** The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. */
|
|
1805
|
+
minPrefixLength?: number;
|
|
1806
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
1807
|
+
name?: string;
|
|
1808
|
+
/** This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. */
|
|
1809
|
+
numUniqueUsersThreshold?: number;
|
|
1810
|
+
/** This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. */
|
|
1811
|
+
queryFrequencyThreshold?: number;
|
|
1812
|
+
/** The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. */
|
|
1813
|
+
queryModel?: string;
|
|
1814
|
+
/** Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. */
|
|
1815
|
+
shouldServeContentSuggestions?: boolean;
|
|
1816
|
+
}
|
|
1753
1817
|
interface GoogleCloudDiscoveryengineV1alphaCompletionInfo {
|
|
1754
1818
|
/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. */
|
|
1755
1819
|
selectedPosition?: number;
|
|
@@ -2121,6 +2185,8 @@ declare namespace gapi.client {
|
|
|
2121
2185
|
| 'ALLOWLIST_STATIC_IP'
|
|
2122
2186
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
2123
2187
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
2188
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
2189
|
+
cliConfig?: GoogleCloudDiscoveryengineV1alphaCliConfig;
|
|
2124
2190
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
2125
2191
|
connectorModes?:
|
|
2126
2192
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -2129,6 +2195,8 @@ declare namespace gapi.client {
|
|
|
2129
2195
|
| 'FEDERATED'
|
|
2130
2196
|
| 'EUA'
|
|
2131
2197
|
| 'FEDERATED_AND_EUA'[];
|
|
2198
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
2199
|
+
connectorSourceId?: string;
|
|
2132
2200
|
/** 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
2201
|
connectorType?:
|
|
2134
2202
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -2158,7 +2226,7 @@ declare namespace gapi.client {
|
|
|
2158
2226
|
destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
|
|
2159
2227
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
2160
2228
|
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.
|
|
2229
|
+
/** 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
2230
|
egressFqdns?: string[];
|
|
2163
2231
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
2164
2232
|
endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
|
|
@@ -2186,7 +2254,7 @@ declare namespace gapi.client {
|
|
|
2186
2254
|
lastSyncTime?: string;
|
|
2187
2255
|
/** 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
2256
|
latestPauseTime?: string;
|
|
2189
|
-
/**
|
|
2257
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
2190
2258
|
name?: string;
|
|
2191
2259
|
/** 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
2260
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -2228,7 +2296,7 @@ declare namespace gapi.client {
|
|
|
2228
2296
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
2229
2297
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
2230
2298
|
updateTime?: string;
|
|
2231
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
2299
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
2232
2300
|
vpcscEnabled?: boolean;
|
|
2233
2301
|
}
|
|
2234
2302
|
interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
|
|
@@ -2316,6 +2384,8 @@ declare namespace gapi.client {
|
|
|
2316
2384
|
| 'GOOGLE_WORKSPACE';
|
|
2317
2385
|
/** Output only. Timestamp the DataStore was created at. */
|
|
2318
2386
|
createTime?: string;
|
|
2387
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
2388
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
2319
2389
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
2320
2390
|
defaultSchemaId?: string;
|
|
2321
2391
|
/** 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 +2627,7 @@ declare namespace gapi.client {
|
|
|
2557
2627
|
id?: string;
|
|
2558
2628
|
/** 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
2629
|
indexStatus?: GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus;
|
|
2560
|
-
/** Output only. The
|
|
2630
|
+
/** 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
2631
|
indexTime?: string;
|
|
2562
2632
|
/** The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
|
|
2563
2633
|
jsonData?: string;
|
|
@@ -2591,7 +2661,7 @@ declare namespace gapi.client {
|
|
|
2591
2661
|
interface GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus {
|
|
2592
2662
|
/** A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. */
|
|
2593
2663
|
errorSamples?: GoogleRpcStatus[];
|
|
2594
|
-
/** The time when the document was indexed. If this field is populated, it means the document has been indexed. */
|
|
2664
|
+
/** 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
2665
|
indexTime?: string;
|
|
2596
2666
|
/** Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. */
|
|
2597
2667
|
pendingMessage?: string;
|
|
@@ -2720,7 +2790,7 @@ declare namespace gapi.client {
|
|
|
2720
2790
|
disableAnalytics?: boolean;
|
|
2721
2791
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
2722
2792
|
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` */
|
|
2793
|
+
/** 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` * `cross-product-intelligence` */
|
|
2724
2794
|
features?: {
|
|
2725
2795
|
[P in string]:
|
|
2726
2796
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -2981,6 +3051,8 @@ declare namespace gapi.client {
|
|
|
2981
3051
|
externalId?: string;
|
|
2982
3052
|
/** Metadata corresponding to the external user. */
|
|
2983
3053
|
groupMetadata?: any;
|
|
3054
|
+
/** 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. */
|
|
3055
|
+
subject?: string;
|
|
2984
3056
|
/** Metadata corresponding to the external user. */
|
|
2985
3057
|
userMetadata?: GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata;
|
|
2986
3058
|
}
|
|
@@ -2990,7 +3062,7 @@ declare namespace gapi.client {
|
|
|
2990
3062
|
familyName?: string;
|
|
2991
3063
|
/** The user's given name. */
|
|
2992
3064
|
givenName?: string;
|
|
2993
|
-
/** The user's primary email address. */
|
|
3065
|
+
/** The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject. */
|
|
2994
3066
|
primaryEmail?: string;
|
|
2995
3067
|
}
|
|
2996
3068
|
interface GoogleCloudDiscoveryengineV1alphaFactChunk {
|
|
@@ -3009,6 +3081,51 @@ declare namespace gapi.client {
|
|
|
3009
3081
|
/** The URI of the source. */
|
|
3010
3082
|
uri?: string;
|
|
3011
3083
|
}
|
|
3084
|
+
interface GoogleCloudDiscoveryengineV1alphaFeedback {
|
|
3085
|
+
/** Optional. The additional user comment of the feedback if user gives a thumb down. */
|
|
3086
|
+
comment?: string;
|
|
3087
|
+
/** Optional. The version of the component that this report is being sent from. */
|
|
3088
|
+
componentVersion?: string;
|
|
3089
|
+
/** The related conversation information when user gives feedback. */
|
|
3090
|
+
conversationInfo?: GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo;
|
|
3091
|
+
/** Optional. Whether the customer accepted data use terms. */
|
|
3092
|
+
dataTermsAccepted?: boolean;
|
|
3093
|
+
/** Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. */
|
|
3094
|
+
feedbackSource?:
|
|
3095
|
+
| 'FEEDBACK_SOURCE_UNSPECIFIED'
|
|
3096
|
+
| 'GOOGLE_CONSOLE'
|
|
3097
|
+
| 'GOOGLE_WIDGET'
|
|
3098
|
+
| 'GOOGLE_WEBAPP'
|
|
3099
|
+
| 'GOOGLE_AGENTSPACE_MOBILE';
|
|
3100
|
+
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
3101
|
+
feedbackType?: 'FEEDBACK_TYPE_UNSPECIFIED' | 'LIKE' | 'DISLIKE';
|
|
3102
|
+
/** The version of the LLM model that was used to generate the response. */
|
|
3103
|
+
llmModelVersion?: string;
|
|
3104
|
+
/** Optional. The reason if user gives a thumb down. */
|
|
3105
|
+
reasons?:
|
|
3106
|
+
| 'REASON_UNSPECIFIED'
|
|
3107
|
+
| 'INACCURATE_RESPONSE'
|
|
3108
|
+
| 'NOT_RELEVANT'
|
|
3109
|
+
| 'INCOMPREHENSIVE'
|
|
3110
|
+
| 'OFFENSIVE_OR_UNSAFE'
|
|
3111
|
+
| 'FORMAT_AND_STYLES'
|
|
3112
|
+
| 'BAD_CITATION'
|
|
3113
|
+
| 'CANVAS_NOT_GENERATED'
|
|
3114
|
+
| 'CANVAS_QUALITY_BAD'
|
|
3115
|
+
| 'CANVAS_EXPORT_FAILED'[];
|
|
3116
|
+
}
|
|
3117
|
+
interface GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo {
|
|
3118
|
+
/** Optional. The token which could be used to fetch the answer log. */
|
|
3119
|
+
answerQueryToken?: string;
|
|
3120
|
+
/** Optional. The token which could be used to fetch the assistant log. */
|
|
3121
|
+
assistToken?: string;
|
|
3122
|
+
/** Required. The user's search query. */
|
|
3123
|
+
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
3124
|
+
/** The index of the user input within the conversation messages. */
|
|
3125
|
+
questionIndex?: number;
|
|
3126
|
+
/** Name of the newly generated or continued session. */
|
|
3127
|
+
session?: string;
|
|
3128
|
+
}
|
|
3012
3129
|
interface GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
|
|
3013
3130
|
/** 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
3131
|
nextPageToken?: string;
|
|
@@ -3086,7 +3203,7 @@ declare namespace gapi.client {
|
|
|
3086
3203
|
| 'RETRIEVABLE_DISABLED';
|
|
3087
3204
|
/** 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
3205
|
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`. */
|
|
3206
|
+
/** 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
3207
|
searchableFieldImportance?:
|
|
3091
3208
|
| 'SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED'
|
|
3092
3209
|
| 'VERY_LOW_IMPORTANCE'
|
|
@@ -3456,7 +3573,7 @@ declare namespace gapi.client {
|
|
|
3456
3573
|
failureCount?: string;
|
|
3457
3574
|
/** Count of entries that were processed successfully. */
|
|
3458
3575
|
successCount?: string;
|
|
3459
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3576
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
3460
3577
|
updateTime?: string;
|
|
3461
3578
|
}
|
|
3462
3579
|
interface GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest {
|
|
@@ -3688,6 +3805,12 @@ declare namespace gapi.client {
|
|
|
3688
3805
|
/** 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
3806
|
nextPageToken?: string;
|
|
3690
3807
|
}
|
|
3808
|
+
interface GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse {
|
|
3809
|
+
/** All the customer's LicenseConfigs. */
|
|
3810
|
+
licenseConfigs?: GoogleCloudDiscoveryengineV1alphaLicenseConfig[];
|
|
3811
|
+
/** Not supported. */
|
|
3812
|
+
nextPageToken?: string;
|
|
3813
|
+
}
|
|
3691
3814
|
interface GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse {
|
|
3692
3815
|
/** All the customer's LicenseConfigUsageStats. */
|
|
3693
3816
|
licenseConfigUsageStats?: GoogleCloudDiscoveryengineV1alphaLicenseConfigUsageStats[];
|
|
@@ -3719,7 +3842,7 @@ declare namespace gapi.client {
|
|
|
3719
3842
|
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
3720
3843
|
/** 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
3844
|
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. */
|
|
3845
|
+
/** 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
3846
|
orderBy?: string;
|
|
3724
3847
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
3725
3848
|
pageSize?: number;
|
|
@@ -3865,6 +3988,13 @@ declare namespace gapi.client {
|
|
|
3865
3988
|
startTime?: string;
|
|
3866
3989
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
3867
3990
|
terminateTime?: string;
|
|
3991
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
3992
|
+
updateType?:
|
|
3993
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
3994
|
+
| 'CREATE'
|
|
3995
|
+
| 'DELETE'
|
|
3996
|
+
| 'SCALE_UP'
|
|
3997
|
+
| 'SCALE_DOWN';
|
|
3868
3998
|
}
|
|
3869
3999
|
interface GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig {
|
|
3870
4000
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -4044,6 +4174,8 @@ declare namespace gapi.client {
|
|
|
4044
4174
|
top5?: number;
|
|
4045
4175
|
}
|
|
4046
4176
|
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
4177
|
+
/** Output only. The time at which the server accepted this query. */
|
|
4178
|
+
createTime?: string;
|
|
4047
4179
|
/** Query content parts. */
|
|
4048
4180
|
parts?: GoogleCloudDiscoveryengineV1alphaQueryPart[];
|
|
4049
4181
|
/** Output only. Unique Id for the query. */
|
|
@@ -4138,7 +4270,7 @@ declare namespace gapi.client {
|
|
|
4138
4270
|
content?: string;
|
|
4139
4271
|
/** The unique ID to represent the record. */
|
|
4140
4272
|
id?: string;
|
|
4141
|
-
/** The score of this record based on the given query and selected model. The score will be rounded to
|
|
4273
|
+
/** 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
4274
|
score?: number;
|
|
4143
4275
|
/** 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
4276
|
title?: string;
|
|
@@ -4488,12 +4620,16 @@ declare namespace gapi.client {
|
|
|
4488
4620
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec[];
|
|
4489
4621
|
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
4490
4622
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
4623
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
4624
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams;
|
|
4491
4625
|
/** 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
4626
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
4493
4627
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
4494
4628
|
displaySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec;
|
|
4495
4629
|
/** 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
4630
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
4631
|
+
/** 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. */
|
|
4632
|
+
entity?: string;
|
|
4497
4633
|
/** 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
4634
|
facetSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
4499
4635
|
/** 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 +4662,7 @@ declare namespace gapi.client {
|
|
|
4526
4662
|
query?: string;
|
|
4527
4663
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
4528
4664
|
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 */
|
|
4665
|
+
/** 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
4666
|
rankingExpression?: string;
|
|
4531
4667
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
4532
4668
|
rankingExpressionBackend?:
|
|
@@ -4691,6 +4827,10 @@ declare namespace gapi.client {
|
|
|
4691
4827
|
| 'DROP_CROWDED_RESULTS'
|
|
4692
4828
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
4693
4829
|
}
|
|
4830
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams {
|
|
4831
|
+
/** 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. */
|
|
4832
|
+
expressionsToPrecompute?: string[];
|
|
4833
|
+
}
|
|
4694
4834
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
4695
4835
|
/** 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
4836
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
@@ -4763,7 +4903,7 @@ declare namespace gapi.client {
|
|
|
4763
4903
|
| 'CONDITION_UNSPECIFIED'
|
|
4764
4904
|
| 'DISABLED'
|
|
4765
4905
|
| '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`.
|
|
4906
|
+
/** 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
4907
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
4768
4908
|
}
|
|
4769
4909
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec {
|
|
@@ -5004,6 +5144,8 @@ declare namespace gapi.client {
|
|
|
5004
5144
|
keywordSimilarityScore?: number;
|
|
5005
5145
|
/** Optional. Predicted conversion rate adjustment as a rank. */
|
|
5006
5146
|
pctrRank?: number;
|
|
5147
|
+
/** 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`. */
|
|
5148
|
+
precomputedExpressionValues?: number[];
|
|
5007
5149
|
/** Optional. Semantic relevance adjustment. */
|
|
5008
5150
|
relevanceScore?: number;
|
|
5009
5151
|
/** Optional. Semantic similarity adjustment. */
|
|
@@ -5189,6 +5331,8 @@ declare namespace gapi.client {
|
|
|
5189
5331
|
labels?: string[];
|
|
5190
5332
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
5191
5333
|
name?: string;
|
|
5334
|
+
/** 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. */
|
|
5335
|
+
pendingAsyncAssistOperationId?: string;
|
|
5192
5336
|
/** Output only. The time the session started. */
|
|
5193
5337
|
startTime?: string;
|
|
5194
5338
|
/** The state of the session. */
|
|
@@ -5205,6 +5349,8 @@ declare namespace gapi.client {
|
|
|
5205
5349
|
detailedAnswer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
5206
5350
|
/** 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
5351
|
detailedAssistAnswer?: GoogleCloudDiscoveryengineV1alphaAssistAnswer;
|
|
5352
|
+
/** Optional. Indicates whether this turn is a live turn. */
|
|
5353
|
+
live?: boolean;
|
|
5208
5354
|
/** Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn */
|
|
5209
5355
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
5210
5356
|
/** 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 +5500,17 @@ declare namespace gapi.client {
|
|
|
5354
5500
|
assistToken?: string;
|
|
5355
5501
|
/** The tool names of the tools that were invoked. */
|
|
5356
5502
|
invocationTools?: string[];
|
|
5503
|
+
/** The skills executed during the turn. */
|
|
5504
|
+
invokedSkills?: GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill[];
|
|
5357
5505
|
/** Session information. Only included in the final StreamAssistResponse of the response stream. */
|
|
5358
5506
|
sessionInfo?: GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo;
|
|
5359
5507
|
}
|
|
5508
|
+
interface GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill {
|
|
5509
|
+
/** The display name of the skill. */
|
|
5510
|
+
displayName?: string;
|
|
5511
|
+
/** The resource name of the skill. */
|
|
5512
|
+
name?: string;
|
|
5513
|
+
}
|
|
5360
5514
|
interface GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo {
|
|
5361
5515
|
/** Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. */
|
|
5362
5516
|
session?: string;
|
|
@@ -5531,6 +5685,8 @@ declare namespace gapi.client {
|
|
|
5531
5685
|
eventTime?: string;
|
|
5532
5686
|
/** 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
5687
|
eventType?: string;
|
|
5688
|
+
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
5689
|
+
feedback?: GoogleCloudDiscoveryengineV1alphaFeedback;
|
|
5534
5690
|
/** 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
5691
|
filter?: string;
|
|
5536
5692
|
/** Media-specific info. */
|
|
@@ -5557,6 +5713,8 @@ declare namespace gapi.client {
|
|
|
5557
5713
|
userPseudoId?: string;
|
|
5558
5714
|
}
|
|
5559
5715
|
interface GoogleCloudDiscoveryengineV1alphaUserInfo {
|
|
5716
|
+
/** 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. */
|
|
5717
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation;
|
|
5560
5718
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
5561
5719
|
timeZone?: string;
|
|
5562
5720
|
/** 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 +5722,12 @@ declare namespace gapi.client {
|
|
|
5564
5722
|
/** 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
5723
|
userId?: string;
|
|
5566
5724
|
}
|
|
5725
|
+
interface GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation {
|
|
5726
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
5727
|
+
address?: string;
|
|
5728
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
5729
|
+
point?: GoogleTypeLatLng;
|
|
5730
|
+
}
|
|
5567
5731
|
interface GoogleCloudDiscoveryengineV1alphaUserLicense {
|
|
5568
5732
|
/** Output only. User created timestamp. */
|
|
5569
5733
|
createTime?: string;
|
|
@@ -5876,7 +6040,7 @@ declare namespace gapi.client {
|
|
|
5876
6040
|
enableSearchAsYouType?: boolean;
|
|
5877
6041
|
/** If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. */
|
|
5878
6042
|
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` */
|
|
6043
|
+
/** 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` * `cross-product-intelligence` */
|
|
5880
6044
|
features?: {
|
|
5881
6045
|
[P in string]:
|
|
5882
6046
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -5891,6 +6055,8 @@ declare namespace gapi.client {
|
|
|
5891
6055
|
| 'SEARCH_ONLY'
|
|
5892
6056
|
| 'SEARCH_WITH_ANSWER'
|
|
5893
6057
|
| 'SEARCH_WITH_FOLLOW_UPS';
|
|
6058
|
+
/** 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. */
|
|
6059
|
+
modelConfigInfo?: GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo;
|
|
5894
6060
|
/** 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
6061
|
modelConfigs?: {
|
|
5896
6062
|
[P in string]:
|
|
@@ -5932,6 +6098,24 @@ declare namespace gapi.client {
|
|
|
5932
6098
|
/** The number of top results to generate the answer from. Up to 10. */
|
|
5933
6099
|
resultCount?: number;
|
|
5934
6100
|
}
|
|
6101
|
+
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo {
|
|
6102
|
+
/** 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`. */
|
|
6103
|
+
defaultModelId?: string;
|
|
6104
|
+
/** 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. */
|
|
6105
|
+
resolvedModels?: GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel[];
|
|
6106
|
+
}
|
|
6107
|
+
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel {
|
|
6108
|
+
/** Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. */
|
|
6109
|
+
description?: string;
|
|
6110
|
+
/** 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. */
|
|
6111
|
+
displayName?: string;
|
|
6112
|
+
/** Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). */
|
|
6113
|
+
icon?: string;
|
|
6114
|
+
/** Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. */
|
|
6115
|
+
isPreview?: boolean;
|
|
6116
|
+
/** 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. */
|
|
6117
|
+
modelId?: string;
|
|
6118
|
+
}
|
|
5935
6119
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec {
|
|
5936
6120
|
/** Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. */
|
|
5937
6121
|
generativeAnswerAddOnDisabled?: boolean;
|
|
@@ -5941,7 +6125,7 @@ declare namespace gapi.client {
|
|
|
5941
6125
|
semanticAddOnDisabled?: boolean;
|
|
5942
6126
|
}
|
|
5943
6127
|
interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
|
|
5944
|
-
/** Obfuscated Dasher customer ID. */
|
|
6128
|
+
/** 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
6129
|
dasherCustomerId?: string;
|
|
5946
6130
|
/** 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
6131
|
superAdminEmailAddress?: string;
|
|
@@ -5960,6 +6144,8 @@ declare namespace gapi.client {
|
|
|
5960
6144
|
| 'GOOGLE_PEOPLE';
|
|
5961
6145
|
}
|
|
5962
6146
|
interface GoogleCloudDiscoveryengineV1alphaWorkspaceSettings {
|
|
6147
|
+
/** Whether the calling user's customer domain matches the workspace data stores under this engine. */
|
|
6148
|
+
customerDomainValid?: boolean;
|
|
5963
6149
|
/** Whether an end user has workspace access enabled. */
|
|
5964
6150
|
workspaceAccessEnabled?: boolean;
|
|
5965
6151
|
}
|
|
@@ -5986,6 +6172,8 @@ declare namespace gapi.client {
|
|
|
5986
6172
|
topP?: number;
|
|
5987
6173
|
}
|
|
5988
6174
|
interface GoogleCloudDiscoveryengineV1Assistant {
|
|
6175
|
+
/** Output only. Represents the time when this Assistant was created. */
|
|
6176
|
+
createTime?: string;
|
|
5989
6177
|
/** Optional. Customer policy for the assistant. */
|
|
5990
6178
|
customerPolicy?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
5991
6179
|
/** 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 +6190,8 @@ declare namespace gapi.client {
|
|
|
6002
6190
|
generationConfig?: GoogleCloudDiscoveryengineV1AssistantGenerationConfig;
|
|
6003
6191
|
/** 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
6192
|
name?: string;
|
|
6193
|
+
/** Output only. Represents the time when this Assistant was most recently updated. */
|
|
6194
|
+
updateTime?: string;
|
|
6005
6195
|
/** Optional. The type of web grounding to use. */
|
|
6006
6196
|
webGroundingType?:
|
|
6007
6197
|
| 'WEB_GROUNDING_TYPE_UNSPECIFIED'
|
|
@@ -6067,6 +6257,14 @@ declare namespace gapi.client {
|
|
|
6067
6257
|
| 'DATA_INGESTION'
|
|
6068
6258
|
| 'ACTIONS'
|
|
6069
6259
|
| 'END_USER_AUTHENTICATION'[];
|
|
6260
|
+
/** 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). */
|
|
6261
|
+
toolspecOverride?: GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride;
|
|
6262
|
+
}
|
|
6263
|
+
interface GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride {
|
|
6264
|
+
/** 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. */
|
|
6265
|
+
baseVersion?: string;
|
|
6266
|
+
/** 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. */
|
|
6267
|
+
tools?: {[P in string]: any}[];
|
|
6070
6268
|
}
|
|
6071
6269
|
interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
6072
6270
|
/** Operation create time. */
|
|
@@ -6583,7 +6781,7 @@ declare namespace gapi.client {
|
|
|
6583
6781
|
disableAnalytics?: boolean;
|
|
6584
6782
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
6585
6783
|
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` */
|
|
6784
|
+
/** 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` * `cross-product-intelligence` */
|
|
6587
6785
|
features?: {
|
|
6588
6786
|
[P in string]:
|
|
6589
6787
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -6878,7 +7076,7 @@ declare namespace gapi.client {
|
|
|
6878
7076
|
failureCount?: string;
|
|
6879
7077
|
/** Count of entries that were processed successfully. */
|
|
6880
7078
|
successCount?: string;
|
|
6881
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
7079
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
6882
7080
|
updateTime?: string;
|
|
6883
7081
|
}
|
|
6884
7082
|
interface GoogleCloudDiscoveryengineV1betaImportUserEventsResponse {
|
|
@@ -7017,6 +7215,13 @@ declare namespace gapi.client {
|
|
|
7017
7215
|
startTime?: string;
|
|
7018
7216
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
7019
7217
|
terminateTime?: string;
|
|
7218
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
7219
|
+
updateType?:
|
|
7220
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
7221
|
+
| 'CREATE'
|
|
7222
|
+
| 'DELETE'
|
|
7223
|
+
| 'SCALE_UP'
|
|
7224
|
+
| 'SCALE_DOWN';
|
|
7020
7225
|
}
|
|
7021
7226
|
interface GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig {
|
|
7022
7227
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -7160,12 +7365,16 @@ declare namespace gapi.client {
|
|
|
7160
7365
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
7161
7366
|
/** 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
7367
|
crowdingSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec[];
|
|
7368
|
+
/** Optional. Optional configuration for the Custom Ranking feature. */
|
|
7369
|
+
customRankingParams?: GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams;
|
|
7163
7370
|
/** 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
7371
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
7165
7372
|
/** Optional. Config for display feature, like match highlighting on search results. */
|
|
7166
7373
|
displaySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec;
|
|
7167
7374
|
/** 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
7375
|
embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
7376
|
+
/** 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. */
|
|
7377
|
+
entity?: string;
|
|
7169
7378
|
/** 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
7379
|
facetSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
7171
7380
|
/** 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 +7407,7 @@ declare namespace gapi.client {
|
|
|
7198
7407
|
query?: string;
|
|
7199
7408
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
7200
7409
|
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 */
|
|
7410
|
+
/** 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
7411
|
rankingExpression?: string;
|
|
7203
7412
|
/** Optional. The backend to use for the ranking expression evaluation. */
|
|
7204
7413
|
rankingExpressionBackend?:
|
|
@@ -7361,6 +7570,10 @@ declare namespace gapi.client {
|
|
|
7361
7570
|
| 'DROP_CROWDED_RESULTS'
|
|
7362
7571
|
| 'DEMOTE_CROWDED_RESULTS_TO_END';
|
|
7363
7572
|
}
|
|
7573
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams {
|
|
7574
|
+
/** 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. */
|
|
7575
|
+
expressionsToPrecompute?: string[];
|
|
7576
|
+
}
|
|
7364
7577
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
7365
7578
|
/** 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
7579
|
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
@@ -7433,7 +7646,7 @@ declare namespace gapi.client {
|
|
|
7433
7646
|
| 'CONDITION_UNSPECIFIED'
|
|
7434
7647
|
| 'DISABLED'
|
|
7435
7648
|
| '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`.
|
|
7649
|
+
/** 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
7650
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
7438
7651
|
}
|
|
7439
7652
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec {
|
|
@@ -7596,6 +7809,8 @@ declare namespace gapi.client {
|
|
|
7596
7809
|
updateTime?: string;
|
|
7597
7810
|
}
|
|
7598
7811
|
interface GoogleCloudDiscoveryengineV1betaUserInfo {
|
|
7812
|
+
/** 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. */
|
|
7813
|
+
preciseLocation?: GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation;
|
|
7599
7814
|
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
7600
7815
|
timeZone?: string;
|
|
7601
7816
|
/** 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 +7818,12 @@ declare namespace gapi.client {
|
|
|
7603
7818
|
/** 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
7819
|
userId?: string;
|
|
7605
7820
|
}
|
|
7821
|
+
interface GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation {
|
|
7822
|
+
/** Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. */
|
|
7823
|
+
address?: string;
|
|
7824
|
+
/** Optional. Location represented by a latitude/longitude point. */
|
|
7825
|
+
point?: GoogleTypeLatLng;
|
|
7826
|
+
}
|
|
7606
7827
|
interface GoogleCloudDiscoveryengineV1betaUserLicense {
|
|
7607
7828
|
/** Output only. User created timestamp. */
|
|
7608
7829
|
createTime?: string;
|
|
@@ -7638,7 +7859,7 @@ declare namespace gapi.client {
|
|
|
7638
7859
|
name?: string;
|
|
7639
7860
|
}
|
|
7640
7861
|
interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
|
|
7641
|
-
/** Obfuscated Dasher customer ID. */
|
|
7862
|
+
/** 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
7863
|
dasherCustomerId?: string;
|
|
7643
7864
|
/** 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
7865
|
superAdminEmailAddress?: string;
|
|
@@ -7656,6 +7877,10 @@ declare namespace gapi.client {
|
|
|
7656
7877
|
| 'GOOGLE_KEEP'
|
|
7657
7878
|
| 'GOOGLE_PEOPLE';
|
|
7658
7879
|
}
|
|
7880
|
+
interface GoogleCloudDiscoveryengineV1CliConfig {
|
|
7881
|
+
/** Optional. The actions enabled on the associated CLI connection. */
|
|
7882
|
+
enabledActions?: string[];
|
|
7883
|
+
}
|
|
7659
7884
|
interface GoogleCloudDiscoveryengineV1CmekConfig {
|
|
7660
7885
|
/** Output only. The default CmekConfig for the Customer. */
|
|
7661
7886
|
isDefault?: boolean;
|
|
@@ -7854,6 +8079,8 @@ declare namespace gapi.client {
|
|
|
7854
8079
|
| 'ALLOWLIST_STATIC_IP'
|
|
7855
8080
|
| 'ALLOWLIST_IN_SERVICE_ATTACHMENT'
|
|
7856
8081
|
| 'ALLOWLIST_SERVICE_ACCOUNT'[];
|
|
8082
|
+
/** Optional. The configuration for establishing a CLI connection. */
|
|
8083
|
+
cliConfig?: GoogleCloudDiscoveryengineV1CliConfig;
|
|
7857
8084
|
/** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
|
|
7858
8085
|
connectorModes?:
|
|
7859
8086
|
| 'CONNECTOR_MODE_UNSPECIFIED'
|
|
@@ -7862,6 +8089,8 @@ declare namespace gapi.client {
|
|
|
7862
8089
|
| 'FEDERATED'
|
|
7863
8090
|
| 'EUA'
|
|
7864
8091
|
| 'FEDERATED_AND_EUA'[];
|
|
8092
|
+
/** Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. */
|
|
8093
|
+
connectorSourceId?: string;
|
|
7865
8094
|
/** 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
8095
|
connectorType?:
|
|
7867
8096
|
| 'CONNECTOR_TYPE_UNSPECIFIED'
|
|
@@ -7889,7 +8118,7 @@ declare namespace gapi.client {
|
|
|
7889
8118
|
destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
7890
8119
|
/** Output only. The dynamic tools fetched for this connector. */
|
|
7891
8120
|
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.
|
|
8121
|
+
/** 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
8122
|
egressFqdns?: string[];
|
|
7894
8123
|
/** Optional. Any params and credentials used specifically for EUA connectors. */
|
|
7895
8124
|
endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
@@ -7917,7 +8146,7 @@ declare namespace gapi.client {
|
|
|
7917
8146
|
lastSyncTime?: string;
|
|
7918
8147
|
/** 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
8148
|
latestPauseTime?: string;
|
|
7920
|
-
/**
|
|
8149
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
7921
8150
|
name?: string;
|
|
7922
8151
|
/** 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
8152
|
nextSyncTime?: GoogleTypeDateTime;
|
|
@@ -7959,7 +8188,7 @@ declare namespace gapi.client {
|
|
|
7959
8188
|
syncMode?: 'PERIODIC' | 'STREAMING' | 'UNSPECIFIED';
|
|
7960
8189
|
/** Output only. Timestamp the DataConnector was last updated. */
|
|
7961
8190
|
updateTime?: string;
|
|
7962
|
-
/** Output only. Whether the connector is created with VPC-SC enabled.
|
|
8191
|
+
/** Output only. Whether the connector is created with VPC-SC enabled. */
|
|
7963
8192
|
vpcscEnabled?: boolean;
|
|
7964
8193
|
}
|
|
7965
8194
|
interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
@@ -8315,7 +8544,7 @@ declare namespace gapi.client {
|
|
|
8315
8544
|
disableAnalytics?: boolean;
|
|
8316
8545
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
8317
8546
|
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` */
|
|
8547
|
+
/** 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` * `cross-product-intelligence` */
|
|
8319
8548
|
features?: {
|
|
8320
8549
|
[P in string]:
|
|
8321
8550
|
| 'FEATURE_STATE_UNSPECIFIED'
|
|
@@ -8565,7 +8794,7 @@ declare namespace gapi.client {
|
|
|
8565
8794
|
failureCount?: string;
|
|
8566
8795
|
/** Count of entries that were processed successfully. */
|
|
8567
8796
|
successCount?: string;
|
|
8568
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
8797
|
+
/** Output only. Operation last update time. If the operation is done, this is also the finish time. */
|
|
8569
8798
|
updateTime?: string;
|
|
8570
8799
|
}
|
|
8571
8800
|
interface GoogleCloudDiscoveryengineV1ImportUserEventsResponse {
|
|
@@ -8668,6 +8897,13 @@ declare namespace gapi.client {
|
|
|
8668
8897
|
startTime?: string;
|
|
8669
8898
|
/** Output only. The latest terminate effective time of search qpm and indexing core subscriptions. */
|
|
8670
8899
|
terminateTime?: string;
|
|
8900
|
+
/** Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. */
|
|
8901
|
+
updateType?:
|
|
8902
|
+
| 'UPDATE_TYPE_UNSPECIFIED'
|
|
8903
|
+
| 'CREATE'
|
|
8904
|
+
| 'DELETE'
|
|
8905
|
+
| 'SCALE_UP'
|
|
8906
|
+
| 'SCALE_DOWN';
|
|
8671
8907
|
}
|
|
8672
8908
|
interface GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig {
|
|
8673
8909
|
/** Optional. Configuration for NotebookLM settings. */
|
|
@@ -9052,7 +9288,7 @@ declare namespace gapi.client {
|
|
|
9052
9288
|
name?: string;
|
|
9053
9289
|
}
|
|
9054
9290
|
interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
|
|
9055
|
-
/** Obfuscated Dasher customer ID. */
|
|
9291
|
+
/** 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
9292
|
dasherCustomerId?: string;
|
|
9057
9293
|
/** 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
9294
|
superAdminEmailAddress?: string;
|
|
@@ -9449,7 +9685,7 @@ declare namespace gapi.client {
|
|
|
9449
9685
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
9450
9686
|
code?: number;
|
|
9451
9687
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
9452
|
-
details?:
|
|
9688
|
+
details?: {[P in string]: any}[];
|
|
9453
9689
|
/** 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
9690
|
message?: string;
|
|
9455
9691
|
}
|
|
@@ -9491,6 +9727,12 @@ declare namespace gapi.client {
|
|
|
9491
9727
|
/** 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
9728
|
title?: string;
|
|
9493
9729
|
}
|
|
9730
|
+
interface GoogleTypeLatLng {
|
|
9731
|
+
/** The latitude in degrees. It must be in the range [-90.0, +90.0]. */
|
|
9732
|
+
latitude?: number;
|
|
9733
|
+
/** The longitude in degrees. It must be in the range [-180.0, +180.0]. */
|
|
9734
|
+
longitude?: number;
|
|
9735
|
+
}
|
|
9494
9736
|
interface GoogleTypeTimeZone {
|
|
9495
9737
|
/** IANA Time Zone Database time zone. For example "America/New_York". */
|
|
9496
9738
|
id?: string;
|
|
@@ -10242,6 +10484,40 @@ declare namespace gapi.client {
|
|
|
10242
10484
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10243
10485
|
uploadType?: string;
|
|
10244
10486
|
}): Request<GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse>;
|
|
10487
|
+
/** ServeMcpDeleteRequest serves a MCP DELETE request. */
|
|
10488
|
+
mcp(request?: {
|
|
10489
|
+
/** V1 error format. */
|
|
10490
|
+
'$.xgafv'?: '1' | '2';
|
|
10491
|
+
/** OAuth access token. */
|
|
10492
|
+
access_token?: string;
|
|
10493
|
+
/** Data format for response. */
|
|
10494
|
+
alt?: 'json' | 'media' | 'proto';
|
|
10495
|
+
/** JSONP */
|
|
10496
|
+
callback?: string;
|
|
10497
|
+
collectionsId: string;
|
|
10498
|
+
/** The HTTP Content-Type header value specifying the content type of the body. */
|
|
10499
|
+
contentType?: string;
|
|
10500
|
+
/** The HTTP request/response body as raw binary. */
|
|
10501
|
+
data?: string;
|
|
10502
|
+
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
10503
|
+
extensions?: {[P in string]: any};
|
|
10504
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10505
|
+
fields?: string;
|
|
10506
|
+
/** 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. */
|
|
10507
|
+
key?: string;
|
|
10508
|
+
locationsId: string;
|
|
10509
|
+
/** OAuth 2.0 token for the current user. */
|
|
10510
|
+
oauth_token?: string;
|
|
10511
|
+
/** Returns response with indentations and line breaks. */
|
|
10512
|
+
prettyPrint?: boolean;
|
|
10513
|
+
projectsId: string;
|
|
10514
|
+
/** 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. */
|
|
10515
|
+
quotaUser?: string;
|
|
10516
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10517
|
+
upload_protocol?: string;
|
|
10518
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10519
|
+
uploadType?: string;
|
|
10520
|
+
}): Request<GoogleApiHttpBody>;
|
|
10245
10521
|
/** 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
10522
|
startConnectorRun(request: {
|
|
10247
10523
|
/** V1 error format. */
|
|
@@ -12073,7 +12349,7 @@ declare namespace gapi.client {
|
|
|
12073
12349
|
prettyPrint?: boolean;
|
|
12074
12350
|
/** 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
12351
|
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. */
|
|
12352
|
+
/** 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
12353
|
servingConfig: string;
|
|
12078
12354
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12079
12355
|
upload_protocol?: string;
|
|
@@ -12102,7 +12378,7 @@ declare namespace gapi.client {
|
|
|
12102
12378
|
prettyPrint?: boolean;
|
|
12103
12379
|
/** 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
12380
|
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. */
|
|
12381
|
+
/** 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
12382
|
servingConfig: string;
|
|
12107
12383
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12108
12384
|
upload_protocol?: string;
|
|
@@ -12514,7 +12790,7 @@ declare namespace gapi.client {
|
|
|
12514
12790
|
prettyPrint?: boolean;
|
|
12515
12791
|
/** 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
12792
|
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. */
|
|
12793
|
+
/** 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
12794
|
servingConfig: string;
|
|
12519
12795
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12520
12796
|
upload_protocol?: string;
|
|
@@ -12543,7 +12819,7 @@ declare namespace gapi.client {
|
|
|
12543
12819
|
prettyPrint?: boolean;
|
|
12544
12820
|
/** 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
12821
|
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. */
|
|
12822
|
+
/** 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
12823
|
servingConfig: string;
|
|
12548
12824
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12549
12825
|
upload_protocol?: string;
|
|
@@ -12605,6 +12881,8 @@ declare namespace gapi.client {
|
|
|
12605
12881
|
prettyPrint?: boolean;
|
|
12606
12882
|
/** 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
12883
|
quotaUser?: string;
|
|
12884
|
+
/** 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. */
|
|
12885
|
+
sessionId?: string;
|
|
12608
12886
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12609
12887
|
upload_protocol?: string;
|
|
12610
12888
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -12634,6 +12912,8 @@ declare namespace gapi.client {
|
|
|
12634
12912
|
prettyPrint?: boolean;
|
|
12635
12913
|
/** 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
12914
|
quotaUser?: string;
|
|
12915
|
+
/** 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. */
|
|
12916
|
+
sessionId?: string;
|
|
12637
12917
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12638
12918
|
upload_protocol?: string;
|
|
12639
12919
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -12715,7 +12995,7 @@ declare namespace gapi.client {
|
|
|
12715
12995
|
key?: string;
|
|
12716
12996
|
/** OAuth 2.0 token for the current user. */
|
|
12717
12997
|
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. */
|
|
12998
|
+
/** 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
12999
|
orderBy?: string;
|
|
12720
13000
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
12721
13001
|
pageSize?: number;
|
|
@@ -14365,6 +14645,33 @@ declare namespace gapi.client {
|
|
|
14365
14645
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
14366
14646
|
uploadType?: string;
|
|
14367
14647
|
}): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
|
|
14648
|
+
/** Gets a CompletionConfig */
|
|
14649
|
+
getCompletionConfig(request?: {
|
|
14650
|
+
/** V1 error format. */
|
|
14651
|
+
'$.xgafv'?: '1' | '2';
|
|
14652
|
+
/** OAuth access token. */
|
|
14653
|
+
access_token?: string;
|
|
14654
|
+
/** Data format for response. */
|
|
14655
|
+
alt?: 'json' | 'media' | 'proto';
|
|
14656
|
+
/** JSONP */
|
|
14657
|
+
callback?: string;
|
|
14658
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
14659
|
+
fields?: string;
|
|
14660
|
+
/** 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. */
|
|
14661
|
+
key?: string;
|
|
14662
|
+
/** Required. Full CompletionConfig resource name. Format: `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
14663
|
+
name: string;
|
|
14664
|
+
/** OAuth 2.0 token for the current user. */
|
|
14665
|
+
oauth_token?: string;
|
|
14666
|
+
/** Returns response with indentations and line breaks. */
|
|
14667
|
+
prettyPrint?: boolean;
|
|
14668
|
+
/** 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. */
|
|
14669
|
+
quotaUser?: string;
|
|
14670
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14671
|
+
upload_protocol?: string;
|
|
14672
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
14673
|
+
uploadType?: string;
|
|
14674
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
14368
14675
|
/** Gets a DocumentProcessingConfig. */
|
|
14369
14676
|
getDocumentProcessingConfig(request?: {
|
|
14370
14677
|
/** V1 error format. */
|
|
@@ -14688,6 +14995,68 @@ declare namespace gapi.client {
|
|
|
14688
14995
|
},
|
|
14689
14996
|
body: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest,
|
|
14690
14997
|
): Request<GoogleLongrunningOperation>;
|
|
14998
|
+
/** Updates the CompletionConfigs. */
|
|
14999
|
+
updateCompletionConfig(request: {
|
|
15000
|
+
/** V1 error format. */
|
|
15001
|
+
'$.xgafv'?: '1' | '2';
|
|
15002
|
+
/** OAuth access token. */
|
|
15003
|
+
access_token?: string;
|
|
15004
|
+
/** Data format for response. */
|
|
15005
|
+
alt?: 'json' | 'media' | 'proto';
|
|
15006
|
+
/** JSONP */
|
|
15007
|
+
callback?: string;
|
|
15008
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
15009
|
+
fields?: string;
|
|
15010
|
+
/** 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. */
|
|
15011
|
+
key?: string;
|
|
15012
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
15013
|
+
name: string;
|
|
15014
|
+
/** OAuth 2.0 token for the current user. */
|
|
15015
|
+
oauth_token?: string;
|
|
15016
|
+
/** Returns response with indentations and line breaks. */
|
|
15017
|
+
prettyPrint?: boolean;
|
|
15018
|
+
/** 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. */
|
|
15019
|
+
quotaUser?: string;
|
|
15020
|
+
/** Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. */
|
|
15021
|
+
updateMask?: string;
|
|
15022
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15023
|
+
upload_protocol?: string;
|
|
15024
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
15025
|
+
uploadType?: string;
|
|
15026
|
+
/** Request body */
|
|
15027
|
+
resource: GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
15028
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
15029
|
+
updateCompletionConfig(
|
|
15030
|
+
request: {
|
|
15031
|
+
/** V1 error format. */
|
|
15032
|
+
'$.xgafv'?: '1' | '2';
|
|
15033
|
+
/** OAuth access token. */
|
|
15034
|
+
access_token?: string;
|
|
15035
|
+
/** Data format for response. */
|
|
15036
|
+
alt?: 'json' | 'media' | 'proto';
|
|
15037
|
+
/** JSONP */
|
|
15038
|
+
callback?: string;
|
|
15039
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
15040
|
+
fields?: string;
|
|
15041
|
+
/** 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. */
|
|
15042
|
+
key?: string;
|
|
15043
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
15044
|
+
name: string;
|
|
15045
|
+
/** OAuth 2.0 token for the current user. */
|
|
15046
|
+
oauth_token?: string;
|
|
15047
|
+
/** Returns response with indentations and line breaks. */
|
|
15048
|
+
prettyPrint?: boolean;
|
|
15049
|
+
/** 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. */
|
|
15050
|
+
quotaUser?: string;
|
|
15051
|
+
/** Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. */
|
|
15052
|
+
updateMask?: string;
|
|
15053
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
15054
|
+
upload_protocol?: string;
|
|
15055
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
15056
|
+
uploadType?: string;
|
|
15057
|
+
},
|
|
15058
|
+
body: GoogleCloudDiscoveryengineV1alphaCompletionConfig,
|
|
15059
|
+
): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
14691
15060
|
/** Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. */
|
|
14692
15061
|
updateDocumentProcessingConfig(request: {
|
|
14693
15062
|
/** V1 error format. */
|
|
@@ -15129,7 +15498,7 @@ declare namespace gapi.client {
|
|
|
15129
15498
|
callback?: string;
|
|
15130
15499
|
/** Selector specifying which fields to include in a partial response. */
|
|
15131
15500
|
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 `=`. * `
|
|
15501
|
+
/** 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
15502
|
filter?: string;
|
|
15134
15503
|
/** 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
15504
|
key?: string;
|
|
@@ -16386,7 +16755,7 @@ declare namespace gapi.client {
|
|
|
16386
16755
|
prettyPrint?: boolean;
|
|
16387
16756
|
/** 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
16757
|
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. */
|
|
16758
|
+
/** 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
16759
|
servingConfig: string;
|
|
16391
16760
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16392
16761
|
upload_protocol?: string;
|
|
@@ -16415,7 +16784,7 @@ declare namespace gapi.client {
|
|
|
16415
16784
|
prettyPrint?: boolean;
|
|
16416
16785
|
/** 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
16786
|
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. */
|
|
16787
|
+
/** 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
16788
|
servingConfig: string;
|
|
16420
16789
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16421
16790
|
upload_protocol?: string;
|
|
@@ -16827,7 +17196,7 @@ declare namespace gapi.client {
|
|
|
16827
17196
|
prettyPrint?: boolean;
|
|
16828
17197
|
/** 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
17198
|
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. */
|
|
17199
|
+
/** 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
17200
|
servingConfig: string;
|
|
16832
17201
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16833
17202
|
upload_protocol?: string;
|
|
@@ -16856,7 +17225,7 @@ declare namespace gapi.client {
|
|
|
16856
17225
|
prettyPrint?: boolean;
|
|
16857
17226
|
/** 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
17227
|
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. */
|
|
17228
|
+
/** 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
17229
|
servingConfig: string;
|
|
16861
17230
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
16862
17231
|
upload_protocol?: string;
|
|
@@ -17016,6 +17385,8 @@ declare namespace gapi.client {
|
|
|
17016
17385
|
prettyPrint?: boolean;
|
|
17017
17386
|
/** 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
17387
|
quotaUser?: string;
|
|
17388
|
+
/** 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. */
|
|
17389
|
+
sessionId?: string;
|
|
17019
17390
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17020
17391
|
upload_protocol?: string;
|
|
17021
17392
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -17045,6 +17416,8 @@ declare namespace gapi.client {
|
|
|
17045
17416
|
prettyPrint?: boolean;
|
|
17046
17417
|
/** 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
17418
|
quotaUser?: string;
|
|
17419
|
+
/** 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. */
|
|
17420
|
+
sessionId?: string;
|
|
17048
17421
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17049
17422
|
upload_protocol?: string;
|
|
17050
17423
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -17126,7 +17499,7 @@ declare namespace gapi.client {
|
|
|
17126
17499
|
key?: string;
|
|
17127
17500
|
/** OAuth 2.0 token for the current user. */
|
|
17128
17501
|
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. */
|
|
17502
|
+
/** 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
17503
|
orderBy?: string;
|
|
17131
17504
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
17132
17505
|
pageSize?: number;
|
|
@@ -17422,6 +17795,33 @@ declare namespace gapi.client {
|
|
|
17422
17795
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
17423
17796
|
uploadType?: string;
|
|
17424
17797
|
}): Request<GoogleCloudDiscoveryengineV1alphaEngine>;
|
|
17798
|
+
/** Gets a CompletionConfig */
|
|
17799
|
+
getCompletionConfig(request?: {
|
|
17800
|
+
/** V1 error format. */
|
|
17801
|
+
'$.xgafv'?: '1' | '2';
|
|
17802
|
+
/** OAuth access token. */
|
|
17803
|
+
access_token?: string;
|
|
17804
|
+
/** Data format for response. */
|
|
17805
|
+
alt?: 'json' | 'media' | 'proto';
|
|
17806
|
+
/** JSONP */
|
|
17807
|
+
callback?: string;
|
|
17808
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
17809
|
+
fields?: string;
|
|
17810
|
+
/** 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. */
|
|
17811
|
+
key?: string;
|
|
17812
|
+
/** Required. Full CompletionConfig resource name. Format: `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
17813
|
+
name: string;
|
|
17814
|
+
/** OAuth 2.0 token for the current user. */
|
|
17815
|
+
oauth_token?: string;
|
|
17816
|
+
/** Returns response with indentations and line breaks. */
|
|
17817
|
+
prettyPrint?: boolean;
|
|
17818
|
+
/** 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. */
|
|
17819
|
+
quotaUser?: string;
|
|
17820
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17821
|
+
upload_protocol?: string;
|
|
17822
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
17823
|
+
uploadType?: string;
|
|
17824
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
17425
17825
|
/** Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. */
|
|
17426
17826
|
getIamPolicy(request?: {
|
|
17427
17827
|
/** V1 error format. */
|
|
@@ -17689,7 +18089,7 @@ declare namespace gapi.client {
|
|
|
17689
18089
|
},
|
|
17690
18090
|
body: GoogleCloudDiscoveryengineV1alphaResumeEngineRequest,
|
|
17691
18091
|
): 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`
|
|
18092
|
+
/** 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
18093
|
setIamPolicy(
|
|
17694
18094
|
request: {
|
|
17695
18095
|
/** V1 error format. */
|
|
@@ -17777,6 +18177,68 @@ declare namespace gapi.client {
|
|
|
17777
18177
|
},
|
|
17778
18178
|
body: GoogleCloudDiscoveryengineV1alphaTuneEngineRequest,
|
|
17779
18179
|
): Request<GoogleLongrunningOperation>;
|
|
18180
|
+
/** Updates the CompletionConfigs. */
|
|
18181
|
+
updateCompletionConfig(request: {
|
|
18182
|
+
/** V1 error format. */
|
|
18183
|
+
'$.xgafv'?: '1' | '2';
|
|
18184
|
+
/** OAuth access token. */
|
|
18185
|
+
access_token?: string;
|
|
18186
|
+
/** Data format for response. */
|
|
18187
|
+
alt?: 'json' | 'media' | 'proto';
|
|
18188
|
+
/** JSONP */
|
|
18189
|
+
callback?: string;
|
|
18190
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18191
|
+
fields?: string;
|
|
18192
|
+
/** 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. */
|
|
18193
|
+
key?: string;
|
|
18194
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
18195
|
+
name: string;
|
|
18196
|
+
/** OAuth 2.0 token for the current user. */
|
|
18197
|
+
oauth_token?: string;
|
|
18198
|
+
/** Returns response with indentations and line breaks. */
|
|
18199
|
+
prettyPrint?: boolean;
|
|
18200
|
+
/** 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. */
|
|
18201
|
+
quotaUser?: string;
|
|
18202
|
+
/** Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. */
|
|
18203
|
+
updateMask?: string;
|
|
18204
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18205
|
+
upload_protocol?: string;
|
|
18206
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18207
|
+
uploadType?: string;
|
|
18208
|
+
/** Request body */
|
|
18209
|
+
resource: GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
18210
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
18211
|
+
updateCompletionConfig(
|
|
18212
|
+
request: {
|
|
18213
|
+
/** V1 error format. */
|
|
18214
|
+
'$.xgafv'?: '1' | '2';
|
|
18215
|
+
/** OAuth access token. */
|
|
18216
|
+
access_token?: string;
|
|
18217
|
+
/** Data format for response. */
|
|
18218
|
+
alt?: 'json' | 'media' | 'proto';
|
|
18219
|
+
/** JSONP */
|
|
18220
|
+
callback?: string;
|
|
18221
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
18222
|
+
fields?: string;
|
|
18223
|
+
/** 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. */
|
|
18224
|
+
key?: string;
|
|
18225
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
18226
|
+
name: string;
|
|
18227
|
+
/** OAuth 2.0 token for the current user. */
|
|
18228
|
+
oauth_token?: string;
|
|
18229
|
+
/** Returns response with indentations and line breaks. */
|
|
18230
|
+
prettyPrint?: boolean;
|
|
18231
|
+
/** 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. */
|
|
18232
|
+
quotaUser?: string;
|
|
18233
|
+
/** Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. */
|
|
18234
|
+
updateMask?: string;
|
|
18235
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
18236
|
+
upload_protocol?: string;
|
|
18237
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
18238
|
+
uploadType?: string;
|
|
18239
|
+
},
|
|
18240
|
+
body: GoogleCloudDiscoveryengineV1alphaCompletionConfig,
|
|
18241
|
+
): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
17780
18242
|
analytics: AnalyticsResource;
|
|
17781
18243
|
assistants: AssistantsResource;
|
|
17782
18244
|
completionConfig: CompletionConfigResource;
|
|
@@ -18042,7 +18504,7 @@ declare namespace gapi.client {
|
|
|
18042
18504
|
fields?: string;
|
|
18043
18505
|
/** 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
18506
|
key?: string;
|
|
18045
|
-
/**
|
|
18507
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
18046
18508
|
name: string;
|
|
18047
18509
|
/** OAuth 2.0 token for the current user. */
|
|
18048
18510
|
oauth_token?: string;
|
|
@@ -18073,7 +18535,7 @@ declare namespace gapi.client {
|
|
|
18073
18535
|
fields?: string;
|
|
18074
18536
|
/** 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
18537
|
key?: string;
|
|
18076
|
-
/**
|
|
18538
|
+
/** Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. */
|
|
18077
18539
|
name: string;
|
|
18078
18540
|
/** OAuth 2.0 token for the current user. */
|
|
18079
18541
|
oauth_token?: string;
|
|
@@ -19771,7 +20233,7 @@ declare namespace gapi.client {
|
|
|
19771
20233
|
prettyPrint?: boolean;
|
|
19772
20234
|
/** 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
20235
|
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. */
|
|
20236
|
+
/** 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
20237
|
servingConfig: string;
|
|
19776
20238
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19777
20239
|
upload_protocol?: string;
|
|
@@ -19800,7 +20262,7 @@ declare namespace gapi.client {
|
|
|
19800
20262
|
prettyPrint?: boolean;
|
|
19801
20263
|
/** 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
20264
|
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. */
|
|
20265
|
+
/** 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
20266
|
servingConfig: string;
|
|
19805
20267
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
19806
20268
|
upload_protocol?: string;
|
|
@@ -20212,7 +20674,7 @@ declare namespace gapi.client {
|
|
|
20212
20674
|
prettyPrint?: boolean;
|
|
20213
20675
|
/** 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
20676
|
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. */
|
|
20677
|
+
/** 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
20678
|
servingConfig: string;
|
|
20217
20679
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20218
20680
|
upload_protocol?: string;
|
|
@@ -20241,7 +20703,7 @@ declare namespace gapi.client {
|
|
|
20241
20703
|
prettyPrint?: boolean;
|
|
20242
20704
|
/** 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
20705
|
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. */
|
|
20706
|
+
/** 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
20707
|
servingConfig: string;
|
|
20246
20708
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20247
20709
|
upload_protocol?: string;
|
|
@@ -20303,6 +20765,8 @@ declare namespace gapi.client {
|
|
|
20303
20765
|
prettyPrint?: boolean;
|
|
20304
20766
|
/** 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
20767
|
quotaUser?: string;
|
|
20768
|
+
/** 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. */
|
|
20769
|
+
sessionId?: string;
|
|
20306
20770
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20307
20771
|
upload_protocol?: string;
|
|
20308
20772
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -20332,6 +20796,8 @@ declare namespace gapi.client {
|
|
|
20332
20796
|
prettyPrint?: boolean;
|
|
20333
20797
|
/** 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
20798
|
quotaUser?: string;
|
|
20799
|
+
/** 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. */
|
|
20800
|
+
sessionId?: string;
|
|
20335
20801
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
20336
20802
|
upload_protocol?: string;
|
|
20337
20803
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -20413,7 +20879,7 @@ declare namespace gapi.client {
|
|
|
20413
20879
|
key?: string;
|
|
20414
20880
|
/** OAuth 2.0 token for the current user. */
|
|
20415
20881
|
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. */
|
|
20882
|
+
/** 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
20883
|
orderBy?: string;
|
|
20418
20884
|
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
20419
20885
|
pageSize?: number;
|
|
@@ -21759,6 +22225,33 @@ declare namespace gapi.client {
|
|
|
21759
22225
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
21760
22226
|
uploadType?: string;
|
|
21761
22227
|
}): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
|
|
22228
|
+
/** Gets a CompletionConfig */
|
|
22229
|
+
getCompletionConfig(request?: {
|
|
22230
|
+
/** V1 error format. */
|
|
22231
|
+
'$.xgafv'?: '1' | '2';
|
|
22232
|
+
/** OAuth access token. */
|
|
22233
|
+
access_token?: string;
|
|
22234
|
+
/** Data format for response. */
|
|
22235
|
+
alt?: 'json' | 'media' | 'proto';
|
|
22236
|
+
/** JSONP */
|
|
22237
|
+
callback?: string;
|
|
22238
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
22239
|
+
fields?: string;
|
|
22240
|
+
/** 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. */
|
|
22241
|
+
key?: string;
|
|
22242
|
+
/** Required. Full CompletionConfig resource name. Format: `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
22243
|
+
name: string;
|
|
22244
|
+
/** OAuth 2.0 token for the current user. */
|
|
22245
|
+
oauth_token?: string;
|
|
22246
|
+
/** Returns response with indentations and line breaks. */
|
|
22247
|
+
prettyPrint?: boolean;
|
|
22248
|
+
/** 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. */
|
|
22249
|
+
quotaUser?: string;
|
|
22250
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
22251
|
+
upload_protocol?: string;
|
|
22252
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
22253
|
+
uploadType?: string;
|
|
22254
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
21762
22255
|
/** Gets a DocumentProcessingConfig. */
|
|
21763
22256
|
getDocumentProcessingConfig(request?: {
|
|
21764
22257
|
/** V1 error format. */
|
|
@@ -22024,6 +22517,68 @@ declare namespace gapi.client {
|
|
|
22024
22517
|
},
|
|
22025
22518
|
body: GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest,
|
|
22026
22519
|
): Request<GoogleLongrunningOperation>;
|
|
22520
|
+
/** Updates the CompletionConfigs. */
|
|
22521
|
+
updateCompletionConfig(request: {
|
|
22522
|
+
/** V1 error format. */
|
|
22523
|
+
'$.xgafv'?: '1' | '2';
|
|
22524
|
+
/** OAuth access token. */
|
|
22525
|
+
access_token?: string;
|
|
22526
|
+
/** Data format for response. */
|
|
22527
|
+
alt?: 'json' | 'media' | 'proto';
|
|
22528
|
+
/** JSONP */
|
|
22529
|
+
callback?: string;
|
|
22530
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
22531
|
+
fields?: string;
|
|
22532
|
+
/** 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. */
|
|
22533
|
+
key?: string;
|
|
22534
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
22535
|
+
name: string;
|
|
22536
|
+
/** OAuth 2.0 token for the current user. */
|
|
22537
|
+
oauth_token?: string;
|
|
22538
|
+
/** Returns response with indentations and line breaks. */
|
|
22539
|
+
prettyPrint?: boolean;
|
|
22540
|
+
/** 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. */
|
|
22541
|
+
quotaUser?: string;
|
|
22542
|
+
/** Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. */
|
|
22543
|
+
updateMask?: string;
|
|
22544
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
22545
|
+
upload_protocol?: string;
|
|
22546
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
22547
|
+
uploadType?: string;
|
|
22548
|
+
/** Request body */
|
|
22549
|
+
resource: GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
22550
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
22551
|
+
updateCompletionConfig(
|
|
22552
|
+
request: {
|
|
22553
|
+
/** V1 error format. */
|
|
22554
|
+
'$.xgafv'?: '1' | '2';
|
|
22555
|
+
/** OAuth access token. */
|
|
22556
|
+
access_token?: string;
|
|
22557
|
+
/** Data format for response. */
|
|
22558
|
+
alt?: 'json' | 'media' | 'proto';
|
|
22559
|
+
/** JSONP */
|
|
22560
|
+
callback?: string;
|
|
22561
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
22562
|
+
fields?: string;
|
|
22563
|
+
/** 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. */
|
|
22564
|
+
key?: string;
|
|
22565
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` */
|
|
22566
|
+
name: string;
|
|
22567
|
+
/** OAuth 2.0 token for the current user. */
|
|
22568
|
+
oauth_token?: string;
|
|
22569
|
+
/** Returns response with indentations and line breaks. */
|
|
22570
|
+
prettyPrint?: boolean;
|
|
22571
|
+
/** 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. */
|
|
22572
|
+
quotaUser?: string;
|
|
22573
|
+
/** Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated. */
|
|
22574
|
+
updateMask?: string;
|
|
22575
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
22576
|
+
upload_protocol?: string;
|
|
22577
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
22578
|
+
uploadType?: string;
|
|
22579
|
+
},
|
|
22580
|
+
body: GoogleCloudDiscoveryengineV1alphaCompletionConfig,
|
|
22581
|
+
): Request<GoogleCloudDiscoveryengineV1alphaCompletionConfig>;
|
|
22027
22582
|
/** Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. */
|
|
22028
22583
|
updateDocumentProcessingConfig(request: {
|
|
22029
22584
|
/** V1 error format. */
|
|
@@ -22799,6 +23354,39 @@ declare namespace gapi.client {
|
|
|
22799
23354
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
22800
23355
|
uploadType?: string;
|
|
22801
23356
|
}): Request<GoogleCloudDiscoveryengineV1alphaLicenseConfig>;
|
|
23357
|
+
/** Lists all the LicenseConfigs associated with the project. */
|
|
23358
|
+
list(request?: {
|
|
23359
|
+
/** V1 error format. */
|
|
23360
|
+
'$.xgafv'?: '1' | '2';
|
|
23361
|
+
/** OAuth access token. */
|
|
23362
|
+
access_token?: string;
|
|
23363
|
+
/** Data format for response. */
|
|
23364
|
+
alt?: 'json' | 'media' | 'proto';
|
|
23365
|
+
/** JSONP */
|
|
23366
|
+
callback?: string;
|
|
23367
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
23368
|
+
fields?: string;
|
|
23369
|
+
/** 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. */
|
|
23370
|
+
filter?: string;
|
|
23371
|
+
/** 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. */
|
|
23372
|
+
key?: string;
|
|
23373
|
+
/** OAuth 2.0 token for the current user. */
|
|
23374
|
+
oauth_token?: string;
|
|
23375
|
+
/** Optional. Not supported. */
|
|
23376
|
+
pageSize?: number;
|
|
23377
|
+
/** Optional. Not supported. */
|
|
23378
|
+
pageToken?: string;
|
|
23379
|
+
/** Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. */
|
|
23380
|
+
parent: string;
|
|
23381
|
+
/** Returns response with indentations and line breaks. */
|
|
23382
|
+
prettyPrint?: boolean;
|
|
23383
|
+
/** 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. */
|
|
23384
|
+
quotaUser?: string;
|
|
23385
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
23386
|
+
upload_protocol?: string;
|
|
23387
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
23388
|
+
uploadType?: string;
|
|
23389
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>;
|
|
22802
23390
|
/** Updates the LicenseConfig */
|
|
22803
23391
|
patch(request: {
|
|
22804
23392
|
/** V1 error format. */
|
|
@@ -24318,13 +24906,15 @@ declare namespace gapi.client {
|
|
|
24318
24906
|
callback?: string;
|
|
24319
24907
|
/** Selector specifying which fields to include in a partial response. */
|
|
24320
24908
|
fields?: string;
|
|
24909
|
+
/** 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`. */
|
|
24910
|
+
filter?: string;
|
|
24321
24911
|
/** 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
24912
|
key?: string;
|
|
24323
24913
|
/** OAuth 2.0 token for the current user. */
|
|
24324
24914
|
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
|
|
24915
|
+
/** 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
24916
|
orderBy?: string;
|
|
24327
|
-
/** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
24917
|
+
/** 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
24918
|
pageSize?: number;
|
|
24329
24919
|
/** 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
24920
|
pageToken?: string;
|