@googleapis/discoveryengine 30.0.0 → 32.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +956 -24
- package/build/v1.js +32 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +2964 -209
- package/build/v1alpha.js +710 -74
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +761 -17
- package/build/v1beta.js +32 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +1114 -184
- package/v1alpha.ts +5175 -878
- package/v1beta.ts +920 -179
package/build/v1alpha.d.ts
CHANGED
|
@@ -560,6 +560,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
560
560
|
* Request message for the DataConnectorService.AcquireAccessToken method.
|
|
561
561
|
*/
|
|
562
562
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest {
|
|
563
|
+
/**
|
|
564
|
+
* 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.
|
|
565
|
+
*/
|
|
566
|
+
action?: string | null;
|
|
563
567
|
/**
|
|
564
568
|
* Optional. The scope to request for the access token. Scope will override default scope if specified.
|
|
565
569
|
*/
|
|
@@ -578,6 +582,24 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
578
582
|
*/
|
|
579
583
|
refreshTokenInfo?: Schema$GoogleCloudDiscoveryengineV1alphaRefreshTokenInfo;
|
|
580
584
|
}
|
|
585
|
+
/**
|
|
586
|
+
* Request message for AlphaEvolveService.AcquirePrograms.
|
|
587
|
+
*/
|
|
588
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsRequest {
|
|
589
|
+
/**
|
|
590
|
+
* Optional. Number of evolved programs to acquire. If not set, the default value is 1.
|
|
591
|
+
*/
|
|
592
|
+
desiredProgramsCount?: number | null;
|
|
593
|
+
}
|
|
594
|
+
/**
|
|
595
|
+
* Response message for AlphaEvolveService.AcquirePrograms.
|
|
596
|
+
*/
|
|
597
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse {
|
|
598
|
+
/**
|
|
599
|
+
* Output only. List of acquired program candidates to be evaluated. Note: The number of programs acquired might be lower than requested.
|
|
600
|
+
*/
|
|
601
|
+
programs?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram[];
|
|
602
|
+
}
|
|
581
603
|
/**
|
|
582
604
|
* Informations to support actions on the connector.
|
|
583
605
|
*/
|
|
@@ -893,6 +915,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
893
915
|
* Output only. Timestamp when this Agent was created.
|
|
894
916
|
*/
|
|
895
917
|
createTime?: string | null;
|
|
918
|
+
/**
|
|
919
|
+
* Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED.
|
|
920
|
+
*/
|
|
921
|
+
creationFailureReason?: string | null;
|
|
896
922
|
/**
|
|
897
923
|
* Optional. The custom placeholder text that appears in the text box before the user enters any text.
|
|
898
924
|
*/
|
|
@@ -1123,6 +1149,300 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1123
1149
|
*/
|
|
1124
1150
|
tableId?: string | null;
|
|
1125
1151
|
}
|
|
1152
|
+
/**
|
|
1153
|
+
* Evaluation insights for a program.
|
|
1154
|
+
*/
|
|
1155
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights {
|
|
1156
|
+
/**
|
|
1157
|
+
* Optional. List of evaluation insights.
|
|
1158
|
+
*/
|
|
1159
|
+
insights?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight[];
|
|
1160
|
+
}
|
|
1161
|
+
/**
|
|
1162
|
+
* A single evaluation insight.
|
|
1163
|
+
*/
|
|
1164
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight {
|
|
1165
|
+
/**
|
|
1166
|
+
* Optional. Label of the insight.
|
|
1167
|
+
*/
|
|
1168
|
+
label?: string | null;
|
|
1169
|
+
/**
|
|
1170
|
+
* Optional. Text of the insight.
|
|
1171
|
+
*/
|
|
1172
|
+
text?: string | null;
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* Contains the evaluation scores for the target metrics to optimize.
|
|
1176
|
+
*/
|
|
1177
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores {
|
|
1178
|
+
/**
|
|
1179
|
+
* Required. List of evaluation scores.
|
|
1180
|
+
*/
|
|
1181
|
+
scores?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore[];
|
|
1182
|
+
}
|
|
1183
|
+
/**
|
|
1184
|
+
* Score for a single metric.
|
|
1185
|
+
*/
|
|
1186
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore {
|
|
1187
|
+
/**
|
|
1188
|
+
* Required. Name of the metric.
|
|
1189
|
+
*/
|
|
1190
|
+
metric?: string | null;
|
|
1191
|
+
/**
|
|
1192
|
+
* Required. Score of a program for this metric.
|
|
1193
|
+
*/
|
|
1194
|
+
score?: number | null;
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.
|
|
1198
|
+
*/
|
|
1199
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment {
|
|
1200
|
+
/**
|
|
1201
|
+
* Required. Experiment configuration.
|
|
1202
|
+
*/
|
|
1203
|
+
config?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig;
|
|
1204
|
+
/**
|
|
1205
|
+
* Output only. Time when the experiment was created.
|
|
1206
|
+
*/
|
|
1207
|
+
createTime?: string | null;
|
|
1208
|
+
/**
|
|
1209
|
+
* Output only. Specifies the name of the seed program used to start the experiment.
|
|
1210
|
+
*/
|
|
1211
|
+
initialAlphaEvolveProgram?: string | null;
|
|
1212
|
+
/**
|
|
1213
|
+
* Identifier. The full resource name of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
1214
|
+
*/
|
|
1215
|
+
name?: string | null;
|
|
1216
|
+
/**
|
|
1217
|
+
* Output only. The state of the experiment.
|
|
1218
|
+
*/
|
|
1219
|
+
state?: string | null;
|
|
1220
|
+
/**
|
|
1221
|
+
* Output only. Experiment stats.
|
|
1222
|
+
*/
|
|
1223
|
+
stats?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats;
|
|
1224
|
+
}
|
|
1225
|
+
/**
|
|
1226
|
+
* Configuration of an experiment.
|
|
1227
|
+
*/
|
|
1228
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig {
|
|
1229
|
+
/**
|
|
1230
|
+
* Optional. Evolution settings for the experiment.
|
|
1231
|
+
*/
|
|
1232
|
+
evolutionSettings?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings;
|
|
1233
|
+
/**
|
|
1234
|
+
* Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts.
|
|
1235
|
+
*/
|
|
1236
|
+
generationSettings?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings;
|
|
1237
|
+
/**
|
|
1238
|
+
* Required. Description of the problem to be solved by the experiment.
|
|
1239
|
+
*/
|
|
1240
|
+
problemDescription?: string | null;
|
|
1241
|
+
/**
|
|
1242
|
+
* Required. Primary programming language of the code being optimized.
|
|
1243
|
+
*/
|
|
1244
|
+
programLanguage?: string | null;
|
|
1245
|
+
/**
|
|
1246
|
+
* Required. Run settings for the experiment, controlling the overall behavior of the experiment run.
|
|
1247
|
+
*/
|
|
1248
|
+
runSettings?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings;
|
|
1249
|
+
/**
|
|
1250
|
+
* Required. Title of the experiment.
|
|
1251
|
+
*/
|
|
1252
|
+
title?: string | null;
|
|
1253
|
+
}
|
|
1254
|
+
/**
|
|
1255
|
+
* Evolution settings for the experiment.
|
|
1256
|
+
*/
|
|
1257
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings {
|
|
1258
|
+
/**
|
|
1259
|
+
* Optional. Parent sampling configuration.
|
|
1260
|
+
*/
|
|
1261
|
+
parentSamplingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig;
|
|
1262
|
+
}
|
|
1263
|
+
/**
|
|
1264
|
+
* Configuration for parent sampling.
|
|
1265
|
+
*/
|
|
1266
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig {
|
|
1267
|
+
/**
|
|
1268
|
+
* Optional. Pareto sampling configuration.
|
|
1269
|
+
*/
|
|
1270
|
+
paretoSamplingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig;
|
|
1271
|
+
}
|
|
1272
|
+
/**
|
|
1273
|
+
* Configuration for Pareto sampling.
|
|
1274
|
+
*/
|
|
1275
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig {
|
|
1276
|
+
/**
|
|
1277
|
+
* Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.
|
|
1278
|
+
*/
|
|
1279
|
+
paretoSamplingProbability?: number | null;
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* Generation settings for the experiment.
|
|
1283
|
+
*/
|
|
1284
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings {
|
|
1285
|
+
/**
|
|
1286
|
+
* Optional. Additional user-provided context to be used during generation.
|
|
1287
|
+
*/
|
|
1288
|
+
context?: string | null;
|
|
1289
|
+
/**
|
|
1290
|
+
* Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.
|
|
1291
|
+
*/
|
|
1292
|
+
includeFullProgramInPrompt?: boolean | null;
|
|
1293
|
+
/**
|
|
1294
|
+
* Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.
|
|
1295
|
+
*/
|
|
1296
|
+
models?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig[];
|
|
1297
|
+
}
|
|
1298
|
+
/**
|
|
1299
|
+
* Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.
|
|
1300
|
+
*/
|
|
1301
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig {
|
|
1302
|
+
/**
|
|
1303
|
+
* Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.
|
|
1304
|
+
*/
|
|
1305
|
+
name?: string | null;
|
|
1306
|
+
/**
|
|
1307
|
+
* Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.
|
|
1308
|
+
*/
|
|
1309
|
+
weight?: number | null;
|
|
1310
|
+
}
|
|
1311
|
+
/**
|
|
1312
|
+
* Run settings for the experiment.
|
|
1313
|
+
*/
|
|
1314
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings {
|
|
1315
|
+
/**
|
|
1316
|
+
* Required. Maximum number of programs that can be generated in parallel. Must be positive.
|
|
1317
|
+
*/
|
|
1318
|
+
concurrency?: number | null;
|
|
1319
|
+
/**
|
|
1320
|
+
* Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.
|
|
1321
|
+
*/
|
|
1322
|
+
maxDuration?: string | null;
|
|
1323
|
+
/**
|
|
1324
|
+
* Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.
|
|
1325
|
+
*/
|
|
1326
|
+
maxPrograms?: number | null;
|
|
1327
|
+
}
|
|
1328
|
+
/**
|
|
1329
|
+
* Stats about the experiment.
|
|
1330
|
+
*/
|
|
1331
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats {
|
|
1332
|
+
/**
|
|
1333
|
+
* Output only. Number of candidates generated.
|
|
1334
|
+
*/
|
|
1335
|
+
candidatesCount?: number | null;
|
|
1336
|
+
/**
|
|
1337
|
+
* Output only. Number of candidates evaluated.
|
|
1338
|
+
*/
|
|
1339
|
+
evaluatedCandidatesCount?: number | null;
|
|
1340
|
+
/**
|
|
1341
|
+
* Output only. Number of billed input tokens consumed by the experiment.
|
|
1342
|
+
*/
|
|
1343
|
+
inputTokenCount?: string | null;
|
|
1344
|
+
/**
|
|
1345
|
+
* Output only. Number of billed output tokens consumed by the experiment.
|
|
1346
|
+
*/
|
|
1347
|
+
outputTokenCount?: string | null;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* Represents a single program to be used within the context of an AlphaEvolve experiment.
|
|
1351
|
+
*/
|
|
1352
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram {
|
|
1353
|
+
/**
|
|
1354
|
+
* Optional. Content of the program.
|
|
1355
|
+
*/
|
|
1356
|
+
content?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent;
|
|
1357
|
+
/**
|
|
1358
|
+
* Output only. Time when the program was created.
|
|
1359
|
+
*/
|
|
1360
|
+
createTime?: string | null;
|
|
1361
|
+
/**
|
|
1362
|
+
* Optional. Evaluation results for the program.
|
|
1363
|
+
*/
|
|
1364
|
+
evaluation?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation;
|
|
1365
|
+
/**
|
|
1366
|
+
* Optional. Lock token for the program.
|
|
1367
|
+
*/
|
|
1368
|
+
lockToken?: string | null;
|
|
1369
|
+
/**
|
|
1370
|
+
* Identifier. Unique identifier for the program. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}/alphaEvolvePrograms/{alpha_evolve_program\}`
|
|
1371
|
+
*/
|
|
1372
|
+
name?: string | null;
|
|
1373
|
+
/**
|
|
1374
|
+
* Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}/alphaEvolvePrograms/{alpha_evolve_program\}`
|
|
1375
|
+
*/
|
|
1376
|
+
parentPrograms?: string[] | null;
|
|
1377
|
+
/**
|
|
1378
|
+
* Output only. State of the program.
|
|
1379
|
+
*/
|
|
1380
|
+
state?: string | null;
|
|
1381
|
+
}
|
|
1382
|
+
/**
|
|
1383
|
+
* A self-contained message containing the content of a program. Can represent a collection of files.
|
|
1384
|
+
*/
|
|
1385
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent {
|
|
1386
|
+
/**
|
|
1387
|
+
* Optional. Description of the program.
|
|
1388
|
+
*/
|
|
1389
|
+
description?: string | null;
|
|
1390
|
+
/**
|
|
1391
|
+
* Required. A list of source files that make up the overall program.
|
|
1392
|
+
*/
|
|
1393
|
+
files?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile[];
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* Evaluation results for a program candidate.
|
|
1397
|
+
*/
|
|
1398
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation {
|
|
1399
|
+
/**
|
|
1400
|
+
* Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
|
|
1401
|
+
*/
|
|
1402
|
+
insights?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights;
|
|
1403
|
+
/**
|
|
1404
|
+
* Optional. Contains the evaluation scores for the target metrics to optimize.
|
|
1405
|
+
*/
|
|
1406
|
+
scores?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores;
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
* Evaluation submission for a program candidate.
|
|
1410
|
+
*/
|
|
1411
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluationSubmission {
|
|
1412
|
+
/**
|
|
1413
|
+
* Required. Evaluation results for the program candidate.
|
|
1414
|
+
*/
|
|
1415
|
+
evaluation?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation;
|
|
1416
|
+
/**
|
|
1417
|
+
* Required. Lock token for the program obtained in the AcquireAlphaEvolvePrograms call.
|
|
1418
|
+
*/
|
|
1419
|
+
lockToken?: string | null;
|
|
1420
|
+
/**
|
|
1421
|
+
* Required. Unique identifier for the program. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}/alphaEvolvePrograms/{alpha_evolve_program\}`
|
|
1422
|
+
*/
|
|
1423
|
+
program?: string | null;
|
|
1424
|
+
}
|
|
1425
|
+
/**
|
|
1426
|
+
* A single source file with its path, content and metadata.
|
|
1427
|
+
*/
|
|
1428
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile {
|
|
1429
|
+
/**
|
|
1430
|
+
* Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.
|
|
1431
|
+
*/
|
|
1432
|
+
content?: string | null;
|
|
1433
|
+
/**
|
|
1434
|
+
* Optional. Additional description of the file.
|
|
1435
|
+
*/
|
|
1436
|
+
description?: string | null;
|
|
1437
|
+
/**
|
|
1438
|
+
* Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md"
|
|
1439
|
+
*/
|
|
1440
|
+
path?: string | null;
|
|
1441
|
+
/**
|
|
1442
|
+
* Optional. The programming language of the file.
|
|
1443
|
+
*/
|
|
1444
|
+
programLanguage?: string | null;
|
|
1445
|
+
}
|
|
1126
1446
|
/**
|
|
1127
1447
|
* The customer controllable config for Analytics.
|
|
1128
1448
|
*/
|
|
@@ -2276,6 +2596,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2276
2596
|
* Optional. List of banned phrases.
|
|
2277
2597
|
*/
|
|
2278
2598
|
bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase[];
|
|
2599
|
+
/**
|
|
2600
|
+
* Optional. Data protection policy to be used for sanitizing file uploads.
|
|
2601
|
+
*/
|
|
2602
|
+
dataProtectionPolicy?: Schema$GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
2279
2603
|
/**
|
|
2280
2604
|
* Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
|
|
2281
2605
|
*/
|
|
@@ -2570,6 +2894,25 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2570
2894
|
* Required. The supported connector modes for the associated BAP connection.
|
|
2571
2895
|
*/
|
|
2572
2896
|
supportedConnectorModes?: string[] | null;
|
|
2897
|
+
/**
|
|
2898
|
+
* 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).
|
|
2899
|
+
*/
|
|
2900
|
+
toolspecOverride?: Schema$GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride;
|
|
2901
|
+
}
|
|
2902
|
+
/**
|
|
2903
|
+
* Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI. Mirrors the shape of the backend `google.cloud.connectorexecution.v1.ToolspecOverride` message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.
|
|
2904
|
+
*/
|
|
2905
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfigToolspecOverride {
|
|
2906
|
+
/**
|
|
2907
|
+
* 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.
|
|
2908
|
+
*/
|
|
2909
|
+
baseVersion?: string | null;
|
|
2910
|
+
/**
|
|
2911
|
+
* 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.
|
|
2912
|
+
*/
|
|
2913
|
+
tools?: Array<{
|
|
2914
|
+
[key: string]: any;
|
|
2915
|
+
}> | null;
|
|
2573
2916
|
}
|
|
2574
2917
|
/**
|
|
2575
2918
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -2675,7 +3018,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2675
3018
|
*/
|
|
2676
3019
|
deleteUnassignedUserLicenses?: boolean | null;
|
|
2677
3020
|
/**
|
|
2678
|
-
* The inline source for the input content for
|
|
3021
|
+
* The inline source for the input content for license assignment.
|
|
2679
3022
|
*/
|
|
2680
3023
|
inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource;
|
|
2681
3024
|
}
|
|
@@ -3465,6 +3808,51 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3465
3808
|
*/
|
|
3466
3809
|
suggestion?: string | null;
|
|
3467
3810
|
}
|
|
3811
|
+
/**
|
|
3812
|
+
* Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them.
|
|
3813
|
+
*/
|
|
3814
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig {
|
|
3815
|
+
/**
|
|
3816
|
+
* 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.
|
|
3817
|
+
*/
|
|
3818
|
+
enableMode?: string | null;
|
|
3819
|
+
/**
|
|
3820
|
+
* Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store.
|
|
3821
|
+
*/
|
|
3822
|
+
filterPiiSuggestionsUsingDlp?: boolean | null;
|
|
3823
|
+
/**
|
|
3824
|
+
* 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`.
|
|
3825
|
+
*/
|
|
3826
|
+
matchingOrder?: string | null;
|
|
3827
|
+
/**
|
|
3828
|
+
* 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.
|
|
3829
|
+
*/
|
|
3830
|
+
maxSuggestions?: number | null;
|
|
3831
|
+
/**
|
|
3832
|
+
* 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.
|
|
3833
|
+
*/
|
|
3834
|
+
minPrefixLength?: number | null;
|
|
3835
|
+
/**
|
|
3836
|
+
* Required. Immutable. Fully qualified name `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
3837
|
+
*/
|
|
3838
|
+
name?: string | null;
|
|
3839
|
+
/**
|
|
3840
|
+
* 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.
|
|
3841
|
+
*/
|
|
3842
|
+
numUniqueUsersThreshold?: number | null;
|
|
3843
|
+
/**
|
|
3844
|
+
* 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 3 used in the generation pipeline.
|
|
3845
|
+
*/
|
|
3846
|
+
queryFrequencyThreshold?: number | null;
|
|
3847
|
+
/**
|
|
3848
|
+
* 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.
|
|
3849
|
+
*/
|
|
3850
|
+
queryModel?: string | null;
|
|
3851
|
+
/**
|
|
3852
|
+
* Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions.
|
|
3853
|
+
*/
|
|
3854
|
+
shouldServeContentSuggestions?: boolean | null;
|
|
3855
|
+
}
|
|
3468
3856
|
/**
|
|
3469
3857
|
* Detailed completion information including completion attribution token and clicked completion info.
|
|
3470
3858
|
*/
|
|
@@ -4163,7 +4551,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4163
4551
|
*/
|
|
4164
4552
|
dataProtectionPolicy?: Schema$GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
|
|
4165
4553
|
/**
|
|
4166
|
-
* Required. The identifier for the data source.
|
|
4554
|
+
* Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).
|
|
4167
4555
|
*/
|
|
4168
4556
|
dataSource?: string | null;
|
|
4169
4557
|
/**
|
|
@@ -4230,6 +4618,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4230
4618
|
* 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.
|
|
4231
4619
|
*/
|
|
4232
4620
|
latestPauseTime?: string | null;
|
|
4621
|
+
/**
|
|
4622
|
+
* Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`.
|
|
4623
|
+
*/
|
|
4624
|
+
metadata?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata;
|
|
4233
4625
|
/**
|
|
4234
4626
|
* Identifier. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
4235
4627
|
*/
|
|
@@ -4238,6 +4630,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4238
4630
|
* 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.
|
|
4239
4631
|
*/
|
|
4240
4632
|
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
4633
|
+
/**
|
|
4634
|
+
* Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.
|
|
4635
|
+
*/
|
|
4636
|
+
oauthStaticIpAddresses?: string[] | null;
|
|
4241
4637
|
/**
|
|
4242
4638
|
* Required data connector parameters in structured json format.
|
|
4243
4639
|
*/
|
|
@@ -4280,6 +4676,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4280
4676
|
* The data synchronization mode supported by the data connector.
|
|
4281
4677
|
*/
|
|
4282
4678
|
syncMode?: string | null;
|
|
4679
|
+
/**
|
|
4680
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
4681
|
+
*/
|
|
4682
|
+
tag?: string | null;
|
|
4283
4683
|
/**
|
|
4284
4684
|
* Output only. Timestamp the DataConnector was last updated.
|
|
4285
4685
|
*/
|
|
@@ -4289,6 +4689,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4289
4689
|
*/
|
|
4290
4690
|
vpcscEnabled?: boolean | null;
|
|
4291
4691
|
}
|
|
4692
|
+
/**
|
|
4693
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
|
|
4694
|
+
*/
|
|
4695
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
|
|
4696
|
+
/**
|
|
4697
|
+
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
4698
|
+
*/
|
|
4699
|
+
author?: string | null;
|
|
4700
|
+
/**
|
|
4701
|
+
* Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
|
|
4702
|
+
*/
|
|
4703
|
+
description?: string | null;
|
|
4704
|
+
/**
|
|
4705
|
+
* Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
|
|
4706
|
+
*/
|
|
4707
|
+
note?: string | null;
|
|
4708
|
+
/**
|
|
4709
|
+
* Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
|
|
4710
|
+
*/
|
|
4711
|
+
shortDescription?: string | null;
|
|
4712
|
+
/**
|
|
4713
|
+
* Optional. Display title of the connector.
|
|
4714
|
+
*/
|
|
4715
|
+
title?: string | null;
|
|
4716
|
+
}
|
|
4292
4717
|
/**
|
|
4293
4718
|
* Any params and credentials used specifically for EUA connectors.
|
|
4294
4719
|
*/
|
|
@@ -4480,6 +4905,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4480
4905
|
* Optional. Configuration for `HEALTHCARE_FHIR` vertical.
|
|
4481
4906
|
*/
|
|
4482
4907
|
healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
|
|
4908
|
+
/**
|
|
4909
|
+
* Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In DataStoreService.ListDataStores and DataStoreService.GetDataStore, this is only populated when DataStoreView.DATA_STORE_VIEW_FULL is requested via ListDataStoresRequest.view or GetDataStoreRequest.view respectively.
|
|
4910
|
+
*/
|
|
4911
|
+
iconUri?: string | null;
|
|
4483
4912
|
/**
|
|
4484
4913
|
* Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identity_mapping_store\}`.
|
|
4485
4914
|
*/
|
|
@@ -4829,6 +5258,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4829
5258
|
* The number of end users under the user store that were successfully deleted.
|
|
4830
5259
|
*/
|
|
4831
5260
|
successCount?: string | null;
|
|
5261
|
+
/**
|
|
5262
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
5263
|
+
*/
|
|
5264
|
+
updateTime?: string | null;
|
|
4832
5265
|
}
|
|
4833
5266
|
/**
|
|
4834
5267
|
* Defines target endpoints used to connect to third-party sources.
|
|
@@ -5261,6 +5694,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5261
5694
|
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
5262
5695
|
*/
|
|
5263
5696
|
appType?: string | null;
|
|
5697
|
+
/**
|
|
5698
|
+
* Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.
|
|
5699
|
+
*/
|
|
5700
|
+
associatedAgentRegistry?: string | null;
|
|
5264
5701
|
/**
|
|
5265
5702
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
5266
5703
|
*/
|
|
@@ -5304,7 +5741,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5304
5741
|
*/
|
|
5305
5742
|
displayName?: string | null;
|
|
5306
5743
|
/**
|
|
5307
|
-
* 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` * `
|
|
5744
|
+
* 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` * `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` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
5308
5745
|
*/
|
|
5309
5746
|
features?: {
|
|
5310
5747
|
[key: string]: string;
|
|
@@ -5565,7 +6002,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5565
6002
|
*/
|
|
5566
6003
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
5567
6004
|
/**
|
|
5568
|
-
* Optional. The required subscription tier of this engine.
|
|
6005
|
+
* Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.
|
|
5569
6006
|
*/
|
|
5570
6007
|
requiredSubscriptionTier?: string | null;
|
|
5571
6008
|
/**
|
|
@@ -5742,6 +6179,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5742
6179
|
*/
|
|
5743
6180
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsResponse {
|
|
5744
6181
|
}
|
|
6182
|
+
/**
|
|
6183
|
+
* Request message for UserLicenseService.ExportUserLicenses.
|
|
6184
|
+
*/
|
|
6185
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest {
|
|
6186
|
+
}
|
|
6187
|
+
/**
|
|
6188
|
+
* Response message for UserLicenseService.ExportUserLicenses.
|
|
6189
|
+
*/
|
|
6190
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse {
|
|
6191
|
+
/**
|
|
6192
|
+
* The full CSV document as raw bytes: the header row followed by one row per UserLicense. Contains user license data (e.g. user emails). An export with no matching licenses contains only the header row.
|
|
6193
|
+
*/
|
|
6194
|
+
csvData?: string | null;
|
|
6195
|
+
}
|
|
5745
6196
|
/**
|
|
5746
6197
|
* External identity representing either a user or group. This user or group is from an external identity provider (IdP).
|
|
5747
6198
|
*/
|
|
@@ -5824,6 +6275,68 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5824
6275
|
*/
|
|
5825
6276
|
uri?: string | null;
|
|
5826
6277
|
}
|
|
6278
|
+
/**
|
|
6279
|
+
* Information about the user feedback. This information will be used for logging and metrics purpose.
|
|
6280
|
+
*/
|
|
6281
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaFeedback {
|
|
6282
|
+
/**
|
|
6283
|
+
* Optional. The additional user comment of the feedback if user gives a thumb down.
|
|
6284
|
+
*/
|
|
6285
|
+
comment?: string | null;
|
|
6286
|
+
/**
|
|
6287
|
+
* Optional. The version of the component that this report is being sent from.
|
|
6288
|
+
*/
|
|
6289
|
+
componentVersion?: string | null;
|
|
6290
|
+
/**
|
|
6291
|
+
* The related conversation information when user gives feedback.
|
|
6292
|
+
*/
|
|
6293
|
+
conversationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo;
|
|
6294
|
+
/**
|
|
6295
|
+
* Optional. Whether the customer accepted data use terms.
|
|
6296
|
+
*/
|
|
6297
|
+
dataTermsAccepted?: boolean | null;
|
|
6298
|
+
/**
|
|
6299
|
+
* Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.
|
|
6300
|
+
*/
|
|
6301
|
+
feedbackSource?: string | null;
|
|
6302
|
+
/**
|
|
6303
|
+
* Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.
|
|
6304
|
+
*/
|
|
6305
|
+
feedbackType?: string | null;
|
|
6306
|
+
/**
|
|
6307
|
+
* The version of the LLM model that was used to generate the response.
|
|
6308
|
+
*/
|
|
6309
|
+
llmModelVersion?: string | null;
|
|
6310
|
+
/**
|
|
6311
|
+
* Optional. The reason if user gives a thumb down.
|
|
6312
|
+
*/
|
|
6313
|
+
reasons?: string[] | null;
|
|
6314
|
+
}
|
|
6315
|
+
/**
|
|
6316
|
+
* The conversation information such as the question index and session name.
|
|
6317
|
+
*/
|
|
6318
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo {
|
|
6319
|
+
/**
|
|
6320
|
+
* Optional. The token which could be used to fetch the answer log.
|
|
6321
|
+
*/
|
|
6322
|
+
answerQueryToken?: string | null;
|
|
6323
|
+
/**
|
|
6324
|
+
* Optional. The token which could be used to fetch the assistant log.
|
|
6325
|
+
*/
|
|
6326
|
+
assistToken?: string | null;
|
|
6327
|
+
/**
|
|
6328
|
+
* Required. The user's search query.
|
|
6329
|
+
*/
|
|
6330
|
+
query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery;
|
|
6331
|
+
/**
|
|
6332
|
+
* The index of the user input within the conversation messages.
|
|
6333
|
+
*/
|
|
6334
|
+
questionIndex?: number | null;
|
|
6335
|
+
/**
|
|
6336
|
+
* Name of the newly generated or continued session.
|
|
6337
|
+
*/
|
|
6338
|
+
session?: string | null;
|
|
6339
|
+
}
|
|
5827
6340
|
/**
|
|
5828
6341
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
5829
6342
|
*/
|
|
@@ -6795,6 +7308,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6795
7308
|
* Output only. Whether the license config is for Gemini bundle.
|
|
6796
7309
|
*/
|
|
6797
7310
|
geminiBundle?: boolean | null;
|
|
7311
|
+
/**
|
|
7312
|
+
* Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
|
|
7313
|
+
*/
|
|
7314
|
+
lastUserUpdateTime?: string | null;
|
|
6798
7315
|
/**
|
|
6799
7316
|
* Required. Number of licenses purchased.
|
|
6800
7317
|
*/
|
|
@@ -6846,6 +7363,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6846
7363
|
*/
|
|
6847
7364
|
nextPageToken?: string | null;
|
|
6848
7365
|
}
|
|
7366
|
+
/**
|
|
7367
|
+
* Response message for AlphaEvolveService.ListAlphaEvolveExperiments.
|
|
7368
|
+
*/
|
|
7369
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse {
|
|
7370
|
+
/**
|
|
7371
|
+
* Output only. List of experiments.
|
|
7372
|
+
*/
|
|
7373
|
+
alphaEvolveExperiments?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment[];
|
|
7374
|
+
/**
|
|
7375
|
+
* Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
7376
|
+
*/
|
|
7377
|
+
nextPageToken?: string | null;
|
|
7378
|
+
}
|
|
7379
|
+
/**
|
|
7380
|
+
* Response message for AlphaEvolveService.ListAlphaEvolvePrograms.
|
|
7381
|
+
*/
|
|
7382
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse {
|
|
7383
|
+
/**
|
|
7384
|
+
* Output only. List of programs matching the criteria provided in the request.
|
|
7385
|
+
*/
|
|
7386
|
+
alphaEvolvePrograms?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram[];
|
|
7387
|
+
/**
|
|
7388
|
+
* Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
7389
|
+
*/
|
|
7390
|
+
nextPageToken?: string | null;
|
|
7391
|
+
}
|
|
6849
7392
|
/**
|
|
6850
7393
|
* Response message for the AssistantService.ListAssistants method.
|
|
6851
7394
|
*/
|
|
@@ -7478,6 +8021,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7478
8021
|
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.
|
|
7479
8022
|
*/
|
|
7480
8023
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
|
|
8024
|
+
/**
|
|
8025
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
8026
|
+
*/
|
|
8027
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
7481
8028
|
/**
|
|
7482
8029
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
7483
8030
|
*/
|
|
@@ -7507,6 +8054,35 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7507
8054
|
*/
|
|
7508
8055
|
updateType?: string | null;
|
|
7509
8056
|
}
|
|
8057
|
+
/**
|
|
8058
|
+
* Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
|
|
8059
|
+
*/
|
|
8060
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
8061
|
+
/**
|
|
8062
|
+
* Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
|
|
8063
|
+
*/
|
|
8064
|
+
effectiveTpmThreshold?: string | null;
|
|
8065
|
+
/**
|
|
8066
|
+
* Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
|
|
8067
|
+
*/
|
|
8068
|
+
modelVersion?: string | null;
|
|
8069
|
+
/**
|
|
8070
|
+
* Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
|
|
8071
|
+
*/
|
|
8072
|
+
startTime?: string | null;
|
|
8073
|
+
/**
|
|
8074
|
+
* Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
|
|
8075
|
+
*/
|
|
8076
|
+
terminateTime?: string | null;
|
|
8077
|
+
/**
|
|
8078
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
8079
|
+
*/
|
|
8080
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
8081
|
+
/**
|
|
8082
|
+
* Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
|
|
8083
|
+
*/
|
|
8084
|
+
updateType?: string | null;
|
|
8085
|
+
}
|
|
7510
8086
|
/**
|
|
7511
8087
|
* Customer provided configurations.
|
|
7512
8088
|
*/
|
|
@@ -7647,7 +8223,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7647
8223
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest {
|
|
7648
8224
|
}
|
|
7649
8225
|
/**
|
|
7650
|
-
* Response message for CompletionService.PurgeCompletionSuggestions method.
|
|
8226
|
+
* Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
7651
8227
|
*/
|
|
7652
8228
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse {
|
|
7653
8229
|
/**
|
|
@@ -8578,6 +9154,24 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8578
9154
|
*/
|
|
8579
9155
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {
|
|
8580
9156
|
}
|
|
9157
|
+
/**
|
|
9158
|
+
* Metadata for AlphaEvolveService.ResumeExperiment long running operation.
|
|
9159
|
+
*/
|
|
9160
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata {
|
|
9161
|
+
/**
|
|
9162
|
+
* Output only. The time the operation was created.
|
|
9163
|
+
*/
|
|
9164
|
+
createTime?: string | null;
|
|
9165
|
+
/**
|
|
9166
|
+
* Output only. The time the operation was last updated.
|
|
9167
|
+
*/
|
|
9168
|
+
updateTime?: string | null;
|
|
9169
|
+
}
|
|
9170
|
+
/**
|
|
9171
|
+
* Request message for AlphaEvolveService.ResumeExperiment.
|
|
9172
|
+
*/
|
|
9173
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest {
|
|
9174
|
+
}
|
|
8581
9175
|
/**
|
|
8582
9176
|
* Request message for LicenseConfigService.RetractLicenseConfig method.
|
|
8583
9177
|
*/
|
|
@@ -9777,6 +10371,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
9777
10371
|
* Optional. A set of ranking signals associated with the result.
|
|
9778
10372
|
*/
|
|
9779
10373
|
rankSignals?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignals;
|
|
10374
|
+
/**
|
|
10375
|
+
* Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds.
|
|
10376
|
+
*/
|
|
10377
|
+
retrievalSignals?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals;
|
|
9780
10378
|
}
|
|
9781
10379
|
/**
|
|
9782
10380
|
* A set of ranking signals.
|
|
@@ -9836,6 +10434,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
9836
10434
|
*/
|
|
9837
10435
|
value?: number | null;
|
|
9838
10436
|
}
|
|
10437
|
+
/**
|
|
10438
|
+
* Contains a set of signals used by the relevance filter.
|
|
10439
|
+
*/
|
|
10440
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals {
|
|
10441
|
+
/**
|
|
10442
|
+
* Optional. Indicates how the result was retrieved.
|
|
10443
|
+
*/
|
|
10444
|
+
retrievalSources?: string[] | null;
|
|
10445
|
+
/**
|
|
10446
|
+
* Optional. Relevance score used by the filter when semantic_relevance_threshold is set.
|
|
10447
|
+
*/
|
|
10448
|
+
semanticRelevanceScore?: number | null;
|
|
10449
|
+
}
|
|
9839
10450
|
/**
|
|
9840
10451
|
* Information about the session.
|
|
9841
10452
|
*/
|
|
@@ -10422,6 +11033,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10422
11033
|
*/
|
|
10423
11034
|
syncSinceTimestamp?: string | null;
|
|
10424
11035
|
}
|
|
11036
|
+
/**
|
|
11037
|
+
* Metadata for AlphaEvolveService.StartExperiment long running operation.
|
|
11038
|
+
*/
|
|
11039
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata {
|
|
11040
|
+
/**
|
|
11041
|
+
* Output only. The time the operation was created.
|
|
11042
|
+
*/
|
|
11043
|
+
createTime?: string | null;
|
|
11044
|
+
/**
|
|
11045
|
+
* Output only. The time the operation was last updated.
|
|
11046
|
+
*/
|
|
11047
|
+
updateTime?: string | null;
|
|
11048
|
+
}
|
|
11049
|
+
/**
|
|
11050
|
+
* Request message for AlphaEvolveService.StartExperiment.
|
|
11051
|
+
*/
|
|
11052
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentRequest {
|
|
11053
|
+
/**
|
|
11054
|
+
* Required. Experiment to start. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
11055
|
+
*/
|
|
11056
|
+
name?: string | null;
|
|
11057
|
+
}
|
|
10425
11058
|
/**
|
|
10426
11059
|
* Request for the AssistantService.StreamAssist method.
|
|
10427
11060
|
*/
|
|
@@ -10530,6 +11163,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10530
11163
|
* A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
|
|
10531
11164
|
*/
|
|
10532
11165
|
assistToken?: string | null;
|
|
11166
|
+
/**
|
|
11167
|
+
* Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors.
|
|
11168
|
+
*/
|
|
11169
|
+
connectorAuthErrors?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseConnectorAuthError[];
|
|
10533
11170
|
/**
|
|
10534
11171
|
* The tool names of the tools that were invoked.
|
|
10535
11172
|
*/
|
|
@@ -10543,6 +11180,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10543
11180
|
*/
|
|
10544
11181
|
sessionInfo?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo;
|
|
10545
11182
|
}
|
|
11183
|
+
/**
|
|
11184
|
+
* Describes an authentication error for a specific data connector.
|
|
11185
|
+
*/
|
|
11186
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseConnectorAuthError {
|
|
11187
|
+
/**
|
|
11188
|
+
* Resource name of the data connector that failed authentication.
|
|
11189
|
+
*/
|
|
11190
|
+
dataConnector?: string | null;
|
|
11191
|
+
/**
|
|
11192
|
+
* Human-readable error message describing the auth failure.
|
|
11193
|
+
*/
|
|
11194
|
+
errorMessage?: string | null;
|
|
11195
|
+
}
|
|
10546
11196
|
/**
|
|
10547
11197
|
* Represents a skill used during the assist call.
|
|
10548
11198
|
*/
|
|
@@ -10565,6 +11215,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10565
11215
|
*/
|
|
10566
11216
|
session?: string | null;
|
|
10567
11217
|
}
|
|
11218
|
+
/**
|
|
11219
|
+
* Request message for AlphaEvolveService.SubmitProgramsEvaluations.
|
|
11220
|
+
*/
|
|
11221
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest {
|
|
11222
|
+
/**
|
|
11223
|
+
* Required. List of program evaluations to submit. At this time, only one evaluation submission is supported.
|
|
11224
|
+
*/
|
|
11225
|
+
evaluationSubmissions?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluationSubmission[];
|
|
11226
|
+
}
|
|
11227
|
+
/**
|
|
11228
|
+
* Response message for AlphaEvolveService.SubmitProgramsEvaluations.
|
|
11229
|
+
*/
|
|
11230
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse {
|
|
11231
|
+
}
|
|
10568
11232
|
/**
|
|
10569
11233
|
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
10570
11234
|
*/
|
|
@@ -10916,6 +11580,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10916
11580
|
* 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.
|
|
10917
11581
|
*/
|
|
10918
11582
|
eventType?: string | null;
|
|
11583
|
+
/**
|
|
11584
|
+
* Optional. This field is optional except for the `add-feedback` event types.
|
|
11585
|
+
*/
|
|
11586
|
+
feedback?: Schema$GoogleCloudDiscoveryengineV1alphaFeedback;
|
|
10919
11587
|
/**
|
|
10920
11588
|
* 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.
|
|
10921
11589
|
*/
|
|
@@ -10987,11 +11655,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10987
11655
|
userId?: string | null;
|
|
10988
11656
|
}
|
|
10989
11657
|
/**
|
|
10990
|
-
* Precise location info with multiple representation options.
|
|
11658
|
+
* Precise location info with multiple representation options.
|
|
10991
11659
|
*/
|
|
10992
11660
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation {
|
|
10993
11661
|
/**
|
|
10994
|
-
*
|
|
11662
|
+
* Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.
|
|
10995
11663
|
*/
|
|
10996
11664
|
address?: string | null;
|
|
10997
11665
|
/**
|
|
@@ -11115,7 +11783,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11115
11783
|
*/
|
|
11116
11784
|
assistantSettings?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings;
|
|
11117
11785
|
/**
|
|
11118
|
-
* Output only.
|
|
11786
|
+
* Output only. The batch authorization statuses for the widget's connectors.
|
|
11787
|
+
*/
|
|
11788
|
+
batchAuthStatuses?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus[];
|
|
11789
|
+
/**
|
|
11790
|
+
* Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior).
|
|
11119
11791
|
*/
|
|
11120
11792
|
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
|
|
11121
11793
|
/**
|
|
@@ -11296,9 +11968,30 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11296
11968
|
webGroundingType?: string | null;
|
|
11297
11969
|
}
|
|
11298
11970
|
/**
|
|
11299
|
-
*
|
|
11971
|
+
* Describes the batch authorization status for a batch_authorization_group.
|
|
11972
|
+
*/
|
|
11973
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus {
|
|
11974
|
+
/**
|
|
11975
|
+
* Output only. The batch authorization group the placeholder belongs to.
|
|
11976
|
+
*/
|
|
11977
|
+
batchAuthorizationGroup?: string | null;
|
|
11978
|
+
/**
|
|
11979
|
+
* Output only. The current authorization state for this connector.
|
|
11980
|
+
*/
|
|
11981
|
+
connectorAuthState?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigConnectorAuthState;
|
|
11982
|
+
/**
|
|
11983
|
+
* Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project\}/locations/{location\}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
|
|
11984
|
+
*/
|
|
11985
|
+
placeholder?: string | null;
|
|
11986
|
+
}
|
|
11987
|
+
/**
|
|
11988
|
+
* Read-only collection component that contains data store collections fields that may be used for filtering. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries.
|
|
11300
11989
|
*/
|
|
11301
11990
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
|
|
11991
|
+
/**
|
|
11992
|
+
* Output only. The auth uri of the connector source.
|
|
11993
|
+
*/
|
|
11994
|
+
connectorAuthState?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigConnectorAuthState;
|
|
11302
11995
|
/**
|
|
11303
11996
|
* Output only. The icon link of the connector source.
|
|
11304
11997
|
*/
|
|
@@ -11311,6 +12004,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11311
12004
|
* Output only. The display name of the data source.
|
|
11312
12005
|
*/
|
|
11313
12006
|
dataSourceDisplayName?: string | null;
|
|
12007
|
+
/**
|
|
12008
|
+
* Output only. The end-user-facing display name of the data source, sourced from `ConnectorSource.end_user_display_name`. When unset, clients fall back to `data_source_display_name`.
|
|
12009
|
+
*/
|
|
12010
|
+
dataSourceEndUserDisplayName?: string | null;
|
|
12011
|
+
/**
|
|
12012
|
+
* Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`.
|
|
12013
|
+
*/
|
|
12014
|
+
dataSourceVersion?: number | null;
|
|
11314
12015
|
/**
|
|
11315
12016
|
* For the data store collection, list of the children data stores.
|
|
11316
12017
|
*/
|
|
@@ -11320,14 +12021,39 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11320
12021
|
*/
|
|
11321
12022
|
displayName?: string | null;
|
|
11322
12023
|
/**
|
|
11323
|
-
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
|
|
12024
|
+
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.
|
|
11324
12025
|
*/
|
|
11325
12026
|
id?: string | null;
|
|
11326
12027
|
/**
|
|
11327
|
-
*
|
|
12028
|
+
* Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector. Used by the frontend to group 1P vs 3P connectors. Sourced from `ConnectorSource.is_first_party` once that field is universally populated (b/534727761); until then derived from `ConnectorSource.connector_type == FIRST_PARTY`.
|
|
12029
|
+
*/
|
|
12030
|
+
isFirstParty?: boolean | null;
|
|
12031
|
+
/**
|
|
12032
|
+
* Output only. User-facing connector metadata (`title`, `description`, `short_description`, `author`, `note`), retrieved from the registry `ConnectorSource.metadata` (joined by data source). Shown on the connector detail page.
|
|
12033
|
+
*/
|
|
12034
|
+
metadata?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata;
|
|
12035
|
+
/**
|
|
12036
|
+
* The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.
|
|
11328
12037
|
*/
|
|
11329
12038
|
name?: string | null;
|
|
11330
12039
|
}
|
|
12040
|
+
/**
|
|
12041
|
+
* Read-only connector in CollectionComponent auth state.
|
|
12042
|
+
*/
|
|
12043
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigConnectorAuthState {
|
|
12044
|
+
/**
|
|
12045
|
+
* Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL.
|
|
12046
|
+
*/
|
|
12047
|
+
authorizationUri?: string | null;
|
|
12048
|
+
/**
|
|
12049
|
+
* Output only. The authorization state of the data connector.
|
|
12050
|
+
*/
|
|
12051
|
+
authState?: string | null;
|
|
12052
|
+
/**
|
|
12053
|
+
* Output only. The authorization state update timestamp.
|
|
12054
|
+
*/
|
|
12055
|
+
updateTime?: string | null;
|
|
12056
|
+
}
|
|
11331
12057
|
/**
|
|
11332
12058
|
* Customer provided configurations.
|
|
11333
12059
|
*/
|
|
@@ -11545,7 +12271,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11545
12271
|
*/
|
|
11546
12272
|
enableVisualContentSummary?: boolean | null;
|
|
11547
12273
|
/**
|
|
11548
|
-
* 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` * `
|
|
12274
|
+
* 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` * `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` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
11549
12275
|
*/
|
|
11550
12276
|
features?: {
|
|
11551
12277
|
[key: string]: string;
|
|
@@ -11554,16 +12280,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11554
12280
|
* Describes generative answer configuration.
|
|
11555
12281
|
*/
|
|
11556
12282
|
generativeAnswerConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig;
|
|
12283
|
+
/**
|
|
12284
|
+
* Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above.
|
|
12285
|
+
*/
|
|
12286
|
+
googleDrivePickerEnabled?: boolean | null;
|
|
11557
12287
|
/**
|
|
11558
12288
|
* Describes widget (or web app) interaction type
|
|
11559
12289
|
*/
|
|
11560
12290
|
interactionType?: string | null;
|
|
12291
|
+
/**
|
|
12292
|
+
* 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.
|
|
12293
|
+
*/
|
|
12294
|
+
modelConfigInfo?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo;
|
|
11561
12295
|
/**
|
|
11562
12296
|
* 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.
|
|
11563
12297
|
*/
|
|
11564
12298
|
modelConfigs?: {
|
|
11565
12299
|
[key: string]: string;
|
|
11566
12300
|
} | null;
|
|
12301
|
+
/**
|
|
12302
|
+
* Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset).
|
|
12303
|
+
*/
|
|
12304
|
+
onedrivePickerEnabled?: boolean | null;
|
|
11567
12305
|
/**
|
|
11568
12306
|
* Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
|
|
11569
12307
|
*/
|
|
@@ -11572,6 +12310,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11572
12310
|
* Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
|
|
11573
12311
|
*/
|
|
11574
12312
|
searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec;
|
|
12313
|
+
/**
|
|
12314
|
+
* Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false.
|
|
12315
|
+
*/
|
|
12316
|
+
sourceAdminDisplayNameEnabled?: boolean | null;
|
|
11575
12317
|
}
|
|
11576
12318
|
/**
|
|
11577
12319
|
* Describes configuration for generative answer.
|
|
@@ -11618,6 +12360,65 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11618
12360
|
*/
|
|
11619
12361
|
resultCount?: number | null;
|
|
11620
12362
|
}
|
|
12363
|
+
/**
|
|
12364
|
+
* The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization.
|
|
12365
|
+
*/
|
|
12366
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo {
|
|
12367
|
+
/**
|
|
12368
|
+
* 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`.
|
|
12369
|
+
*/
|
|
12370
|
+
defaultModelId?: string | null;
|
|
12371
|
+
/**
|
|
12372
|
+
* 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.
|
|
12373
|
+
*/
|
|
12374
|
+
resolvedModels?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel[];
|
|
12375
|
+
}
|
|
12376
|
+
/**
|
|
12377
|
+
* A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.
|
|
12378
|
+
*/
|
|
12379
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel {
|
|
12380
|
+
/**
|
|
12381
|
+
* Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces.
|
|
12382
|
+
*/
|
|
12383
|
+
adminView?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView;
|
|
12384
|
+
/**
|
|
12385
|
+
* Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`.
|
|
12386
|
+
*/
|
|
12387
|
+
description?: string | null;
|
|
12388
|
+
/**
|
|
12389
|
+
* 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.
|
|
12390
|
+
*/
|
|
12391
|
+
displayName?: string | null;
|
|
12392
|
+
/**
|
|
12393
|
+
* Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`).
|
|
12394
|
+
*/
|
|
12395
|
+
icon?: string | null;
|
|
12396
|
+
/**
|
|
12397
|
+
* Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI.
|
|
12398
|
+
*/
|
|
12399
|
+
isPreview?: boolean | null;
|
|
12400
|
+
/**
|
|
12401
|
+
* 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.
|
|
12402
|
+
*/
|
|
12403
|
+
modelId?: string | null;
|
|
12404
|
+
}
|
|
12405
|
+
/**
|
|
12406
|
+
* Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.
|
|
12407
|
+
*/
|
|
12408
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView {
|
|
12409
|
+
/**
|
|
12410
|
+
* Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`.
|
|
12411
|
+
*/
|
|
12412
|
+
adminOverridable?: boolean | null;
|
|
12413
|
+
/**
|
|
12414
|
+
* Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`.
|
|
12415
|
+
*/
|
|
12416
|
+
enabledByDefault?: boolean | null;
|
|
12417
|
+
/**
|
|
12418
|
+
* Output only. Regions where this model is launched.
|
|
12419
|
+
*/
|
|
12420
|
+
regions?: string[] | null;
|
|
12421
|
+
}
|
|
11621
12422
|
/**
|
|
11622
12423
|
* SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.
|
|
11623
12424
|
*/
|
|
@@ -11660,6 +12461,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11660
12461
|
* Workspace settings for the end user.
|
|
11661
12462
|
*/
|
|
11662
12463
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceSettings {
|
|
12464
|
+
/**
|
|
12465
|
+
* Whether the calling user's customer domain matches the workspace data stores under this engine.
|
|
12466
|
+
*/
|
|
12467
|
+
customerDomainValid?: boolean | null;
|
|
11663
12468
|
/**
|
|
11664
12469
|
* Whether an end user has workspace access enabled.
|
|
11665
12470
|
*/
|
|
@@ -11869,6 +12674,25 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11869
12674
|
* Required. The supported connector modes for the associated BAP connection.
|
|
11870
12675
|
*/
|
|
11871
12676
|
supportedConnectorModes?: string[] | null;
|
|
12677
|
+
/**
|
|
12678
|
+
* 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).
|
|
12679
|
+
*/
|
|
12680
|
+
toolspecOverride?: Schema$GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride;
|
|
12681
|
+
}
|
|
12682
|
+
/**
|
|
12683
|
+
* Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI. Mirrors the shape of the backend `google.cloud.connectorexecution.v1.ToolspecOverride` message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.
|
|
12684
|
+
*/
|
|
12685
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride {
|
|
12686
|
+
/**
|
|
12687
|
+
* 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.
|
|
12688
|
+
*/
|
|
12689
|
+
baseVersion?: string | null;
|
|
12690
|
+
/**
|
|
12691
|
+
* 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.
|
|
12692
|
+
*/
|
|
12693
|
+
tools?: Array<{
|
|
12694
|
+
[key: string]: any;
|
|
12695
|
+
}> | null;
|
|
11872
12696
|
}
|
|
11873
12697
|
/**
|
|
11874
12698
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -12834,6 +13658,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12834
13658
|
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
12835
13659
|
*/
|
|
12836
13660
|
appType?: string | null;
|
|
13661
|
+
/**
|
|
13662
|
+
* Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.
|
|
13663
|
+
*/
|
|
13664
|
+
associatedAgentRegistry?: string | null;
|
|
12837
13665
|
/**
|
|
12838
13666
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
12839
13667
|
*/
|
|
@@ -12877,7 +13705,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12877
13705
|
*/
|
|
12878
13706
|
displayName?: string | null;
|
|
12879
13707
|
/**
|
|
12880
|
-
* 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` * `
|
|
13708
|
+
* 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` * `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` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
12881
13709
|
*/
|
|
12882
13710
|
features?: {
|
|
12883
13711
|
[key: string]: string;
|
|
@@ -13105,7 +13933,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13105
13933
|
*/
|
|
13106
13934
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
13107
13935
|
/**
|
|
13108
|
-
* Optional. The required subscription tier of this engine.
|
|
13936
|
+
* Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.
|
|
13109
13937
|
*/
|
|
13110
13938
|
requiredSubscriptionTier?: string | null;
|
|
13111
13939
|
/**
|
|
@@ -13502,6 +14330,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13502
14330
|
* Output only. Whether the license config is for Gemini bundle.
|
|
13503
14331
|
*/
|
|
13504
14332
|
geminiBundle?: boolean | null;
|
|
14333
|
+
/**
|
|
14334
|
+
* Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
|
|
14335
|
+
*/
|
|
14336
|
+
lastUserUpdateTime?: string | null;
|
|
13505
14337
|
/**
|
|
13506
14338
|
* Required. Number of licenses purchased.
|
|
13507
14339
|
*/
|
|
@@ -13618,6 +14450,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13618
14450
|
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.
|
|
13619
14451
|
*/
|
|
13620
14452
|
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
|
|
14453
|
+
/**
|
|
14454
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
14455
|
+
*/
|
|
14456
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
13621
14457
|
/**
|
|
13622
14458
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
13623
14459
|
*/
|
|
@@ -13647,6 +14483,35 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13647
14483
|
*/
|
|
13648
14484
|
updateType?: string | null;
|
|
13649
14485
|
}
|
|
14486
|
+
/**
|
|
14487
|
+
* Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
|
|
14488
|
+
*/
|
|
14489
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
14490
|
+
/**
|
|
14491
|
+
* Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
|
|
14492
|
+
*/
|
|
14493
|
+
effectiveTpmThreshold?: string | null;
|
|
14494
|
+
/**
|
|
14495
|
+
* Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
|
|
14496
|
+
*/
|
|
14497
|
+
modelVersion?: string | null;
|
|
14498
|
+
/**
|
|
14499
|
+
* Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
|
|
14500
|
+
*/
|
|
14501
|
+
startTime?: string | null;
|
|
14502
|
+
/**
|
|
14503
|
+
* Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
|
|
14504
|
+
*/
|
|
14505
|
+
terminateTime?: string | null;
|
|
14506
|
+
/**
|
|
14507
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
14508
|
+
*/
|
|
14509
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
14510
|
+
/**
|
|
14511
|
+
* Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
|
|
14512
|
+
*/
|
|
14513
|
+
updateType?: string | null;
|
|
14514
|
+
}
|
|
13650
14515
|
/**
|
|
13651
14516
|
* Customer provided configurations.
|
|
13652
14517
|
*/
|
|
@@ -14816,11 +15681,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14816
15681
|
userId?: string | null;
|
|
14817
15682
|
}
|
|
14818
15683
|
/**
|
|
14819
|
-
* Precise location info with multiple representation options.
|
|
15684
|
+
* Precise location info with multiple representation options.
|
|
14820
15685
|
*/
|
|
14821
15686
|
export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation {
|
|
14822
15687
|
/**
|
|
14823
|
-
*
|
|
15688
|
+
* Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.
|
|
14824
15689
|
*/
|
|
14825
15690
|
address?: string | null;
|
|
14826
15691
|
/**
|
|
@@ -15287,7 +16152,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15287
16152
|
*/
|
|
15288
16153
|
createTime?: string | null;
|
|
15289
16154
|
/**
|
|
15290
|
-
* Required. The identifier for the data source.
|
|
16155
|
+
* Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).
|
|
15291
16156
|
*/
|
|
15292
16157
|
dataSource?: string | null;
|
|
15293
16158
|
/**
|
|
@@ -15354,6 +16219,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15354
16219
|
* 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.
|
|
15355
16220
|
*/
|
|
15356
16221
|
latestPauseTime?: string | null;
|
|
16222
|
+
/**
|
|
16223
|
+
* Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`.
|
|
16224
|
+
*/
|
|
16225
|
+
metadata?: Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata;
|
|
15357
16226
|
/**
|
|
15358
16227
|
* Identifier. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
15359
16228
|
*/
|
|
@@ -15362,6 +16231,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15362
16231
|
* 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.
|
|
15363
16232
|
*/
|
|
15364
16233
|
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
16234
|
+
/**
|
|
16235
|
+
* Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.
|
|
16236
|
+
*/
|
|
16237
|
+
oauthStaticIpAddresses?: string[] | null;
|
|
15365
16238
|
/**
|
|
15366
16239
|
* Required data connector parameters in structured json format.
|
|
15367
16240
|
*/
|
|
@@ -15404,6 +16277,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15404
16277
|
* The data synchronization mode supported by the data connector.
|
|
15405
16278
|
*/
|
|
15406
16279
|
syncMode?: string | null;
|
|
16280
|
+
/**
|
|
16281
|
+
* Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
|
|
16282
|
+
*/
|
|
16283
|
+
tag?: string | null;
|
|
15407
16284
|
/**
|
|
15408
16285
|
* Output only. Timestamp the DataConnector was last updated.
|
|
15409
16286
|
*/
|
|
@@ -15413,6 +16290,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15413
16290
|
*/
|
|
15414
16291
|
vpcscEnabled?: boolean | null;
|
|
15415
16292
|
}
|
|
16293
|
+
/**
|
|
16294
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
|
|
16295
|
+
*/
|
|
16296
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
|
|
16297
|
+
/**
|
|
16298
|
+
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
16299
|
+
*/
|
|
16300
|
+
author?: string | null;
|
|
16301
|
+
/**
|
|
16302
|
+
* Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
|
|
16303
|
+
*/
|
|
16304
|
+
description?: string | null;
|
|
16305
|
+
/**
|
|
16306
|
+
* Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
|
|
16307
|
+
*/
|
|
16308
|
+
note?: string | null;
|
|
16309
|
+
/**
|
|
16310
|
+
* Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
|
|
16311
|
+
*/
|
|
16312
|
+
shortDescription?: string | null;
|
|
16313
|
+
/**
|
|
16314
|
+
* Optional. Display title of the connector.
|
|
16315
|
+
*/
|
|
16316
|
+
title?: string | null;
|
|
16317
|
+
}
|
|
15416
16318
|
/**
|
|
15417
16319
|
* Any params and credentials used specifically for EUA connectors.
|
|
15418
16320
|
*/
|
|
@@ -16081,6 +16983,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16081
16983
|
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
16082
16984
|
*/
|
|
16083
16985
|
appType?: string | null;
|
|
16986
|
+
/**
|
|
16987
|
+
* Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.
|
|
16988
|
+
*/
|
|
16989
|
+
associatedAgentRegistry?: string | null;
|
|
16084
16990
|
/**
|
|
16085
16991
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
16086
16992
|
*/
|
|
@@ -16124,7 +17030,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16124
17030
|
*/
|
|
16125
17031
|
displayName?: string | null;
|
|
16126
17032
|
/**
|
|
16127
|
-
* 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` * `
|
|
17033
|
+
* 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` * `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` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
16128
17034
|
*/
|
|
16129
17035
|
features?: {
|
|
16130
17036
|
[key: string]: string;
|
|
@@ -16352,7 +17258,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16352
17258
|
*/
|
|
16353
17259
|
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
16354
17260
|
/**
|
|
16355
|
-
* Optional. The required subscription tier of this engine.
|
|
17261
|
+
* Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.
|
|
16356
17262
|
*/
|
|
16357
17263
|
requiredSubscriptionTier?: string | null;
|
|
16358
17264
|
/**
|
|
@@ -16623,6 +17529,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16623
17529
|
* Output only. Whether the license config is for Gemini bundle.
|
|
16624
17530
|
*/
|
|
16625
17531
|
geminiBundle?: boolean | null;
|
|
17532
|
+
/**
|
|
17533
|
+
* Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).
|
|
17534
|
+
*/
|
|
17535
|
+
lastUserUpdateTime?: string | null;
|
|
16626
17536
|
/**
|
|
16627
17537
|
* Required. Number of licenses purchased.
|
|
16628
17538
|
*/
|
|
@@ -16705,6 +17615,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16705
17615
|
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.
|
|
16706
17616
|
*/
|
|
16707
17617
|
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
|
|
17618
|
+
/**
|
|
17619
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
17620
|
+
*/
|
|
17621
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
16708
17622
|
/**
|
|
16709
17623
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
16710
17624
|
*/
|
|
@@ -16734,6 +17648,35 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16734
17648
|
*/
|
|
16735
17649
|
updateType?: string | null;
|
|
16736
17650
|
}
|
|
17651
|
+
/**
|
|
17652
|
+
* Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject. The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) — siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.
|
|
17653
|
+
*/
|
|
17654
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
17655
|
+
/**
|
|
17656
|
+
* Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics.
|
|
17657
|
+
*/
|
|
17658
|
+
effectiveTpmThreshold?: string | null;
|
|
17659
|
+
/**
|
|
17660
|
+
* Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).
|
|
17661
|
+
*/
|
|
17662
|
+
modelVersion?: string | null;
|
|
17663
|
+
/**
|
|
17664
|
+
* Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.
|
|
17665
|
+
*/
|
|
17666
|
+
startTime?: string | null;
|
|
17667
|
+
/**
|
|
17668
|
+
* Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.
|
|
17669
|
+
*/
|
|
17670
|
+
terminateTime?: string | null;
|
|
17671
|
+
/**
|
|
17672
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
17673
|
+
*/
|
|
17674
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
17675
|
+
/**
|
|
17676
|
+
* Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).
|
|
17677
|
+
*/
|
|
17678
|
+
updateType?: string | null;
|
|
17679
|
+
}
|
|
16737
17680
|
/**
|
|
16738
17681
|
* Customer provided configurations.
|
|
16739
17682
|
*/
|
|
@@ -16839,7 +17782,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16839
17782
|
updateTime?: string | null;
|
|
16840
17783
|
}
|
|
16841
17784
|
/**
|
|
16842
|
-
* Response message for CompletionService.PurgeCompletionSuggestions method.
|
|
17785
|
+
* Response message for CompletionService.PurgeCompletionSuggestions method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
|
|
16843
17786
|
*/
|
|
16844
17787
|
export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse {
|
|
16845
17788
|
/**
|
|
@@ -19505,6 +20448,84 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19505
20448
|
obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
|
|
19506
20449
|
obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
|
|
19507
20450
|
obtainCrawlRate(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
|
|
20451
|
+
/**
|
|
20452
|
+
* Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
|
|
20453
|
+
* @example
|
|
20454
|
+
* ```js
|
|
20455
|
+
* // Before running the sample:
|
|
20456
|
+
* // - Enable the API at:
|
|
20457
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
20458
|
+
* // - Login into gcloud by running:
|
|
20459
|
+
* // ```sh
|
|
20460
|
+
* // $ gcloud auth application-default login
|
|
20461
|
+
* // ```
|
|
20462
|
+
* // - Install the npm module by running:
|
|
20463
|
+
* // ```sh
|
|
20464
|
+
* // $ npm install googleapis
|
|
20465
|
+
* // ```
|
|
20466
|
+
*
|
|
20467
|
+
* const {google} = require('googleapis');
|
|
20468
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
20469
|
+
*
|
|
20470
|
+
* async function main() {
|
|
20471
|
+
* const auth = new google.auth.GoogleAuth({
|
|
20472
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
20473
|
+
* scopes: [
|
|
20474
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
20475
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
20476
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
20477
|
+
* ],
|
|
20478
|
+
* });
|
|
20479
|
+
*
|
|
20480
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
20481
|
+
* const authClient = await auth.getClient();
|
|
20482
|
+
* google.options({auth: authClient});
|
|
20483
|
+
*
|
|
20484
|
+
* // Do the magic
|
|
20485
|
+
* const res = await discoveryengine.projects.locations.provision({
|
|
20486
|
+
* // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
20487
|
+
* name: 'projects/my-project/locations/my-location',
|
|
20488
|
+
*
|
|
20489
|
+
* // Request body metadata
|
|
20490
|
+
* requestBody: {
|
|
20491
|
+
* // request body parameters
|
|
20492
|
+
* // {
|
|
20493
|
+
* // "acceptDataUseTerms": false,
|
|
20494
|
+
* // "dataUseTermsVersion": "my_dataUseTermsVersion",
|
|
20495
|
+
* // "saasParams": {}
|
|
20496
|
+
* // }
|
|
20497
|
+
* },
|
|
20498
|
+
* });
|
|
20499
|
+
* console.log(res.data);
|
|
20500
|
+
*
|
|
20501
|
+
* // Example response
|
|
20502
|
+
* // {
|
|
20503
|
+
* // "done": false,
|
|
20504
|
+
* // "error": {},
|
|
20505
|
+
* // "metadata": {},
|
|
20506
|
+
* // "name": "my_name",
|
|
20507
|
+
* // "response": {}
|
|
20508
|
+
* // }
|
|
20509
|
+
* }
|
|
20510
|
+
*
|
|
20511
|
+
* main().catch(e => {
|
|
20512
|
+
* console.error(e);
|
|
20513
|
+
* throw e;
|
|
20514
|
+
* });
|
|
20515
|
+
*
|
|
20516
|
+
* ```
|
|
20517
|
+
*
|
|
20518
|
+
* @param params - Parameters for request
|
|
20519
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
20520
|
+
* @param callback - Optional callback that handles the response.
|
|
20521
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
20522
|
+
*/
|
|
20523
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
20524
|
+
provision(params?: Params$Resource$Projects$Locations$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
20525
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
20526
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
20527
|
+
provision(params: Params$Resource$Projects$Locations$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
20528
|
+
provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
19508
20529
|
/**
|
|
19509
20530
|
* Queries configurable pricing usage stats for a project.
|
|
19510
20531
|
* @example
|
|
@@ -19902,8 +20923,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19902
20923
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
19903
20924
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
19904
20925
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
20926
|
+
* // "metadata": {},
|
|
19905
20927
|
* // "name": "my_name",
|
|
19906
20928
|
* // "nextSyncTime": {},
|
|
20929
|
+
* // "oauthStaticIpAddresses": [],
|
|
19907
20930
|
* // "params": {},
|
|
19908
20931
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
19909
20932
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -19914,6 +20937,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19914
20937
|
* // "staticIpAddresses": [],
|
|
19915
20938
|
* // "staticIpEnabled": false,
|
|
19916
20939
|
* // "syncMode": "my_syncMode",
|
|
20940
|
+
* // "tag": "my_tag",
|
|
19917
20941
|
* // "updateTime": "my_updateTime",
|
|
19918
20942
|
* // "vpcscEnabled": false
|
|
19919
20943
|
* // }
|
|
@@ -20163,6 +21187,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
20163
21187
|
*/
|
|
20164
21188
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest;
|
|
20165
21189
|
}
|
|
21190
|
+
export interface Params$Resource$Projects$Locations$Provision extends StandardParameters {
|
|
21191
|
+
/**
|
|
21192
|
+
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
21193
|
+
*/
|
|
21194
|
+
name?: string;
|
|
21195
|
+
/**
|
|
21196
|
+
* Request body metadata
|
|
21197
|
+
*/
|
|
21198
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
|
|
21199
|
+
}
|
|
20166
21200
|
export interface Params$Resource$Projects$Locations$Queryconfigurablepricingusagestats extends StandardParameters {
|
|
20167
21201
|
/**
|
|
20168
21202
|
* Required. The location to query usage stats for.
|
|
@@ -21225,8 +22259,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21225
22259
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
21226
22260
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
21227
22261
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
22262
|
+
* // "metadata": {},
|
|
21228
22263
|
* // "name": "my_name",
|
|
21229
22264
|
* // "nextSyncTime": {},
|
|
22265
|
+
* // "oauthStaticIpAddresses": [],
|
|
21230
22266
|
* // "params": {},
|
|
21231
22267
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
21232
22268
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -21237,6 +22273,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21237
22273
|
* // "staticIpAddresses": [],
|
|
21238
22274
|
* // "staticIpEnabled": false,
|
|
21239
22275
|
* // "syncMode": "my_syncMode",
|
|
22276
|
+
* // "tag": "my_tag",
|
|
21240
22277
|
* // "updateTime": "my_updateTime",
|
|
21241
22278
|
* // "vpcscEnabled": false
|
|
21242
22279
|
* // }
|
|
@@ -21489,8 +22526,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21489
22526
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
21490
22527
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
21491
22528
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
22529
|
+
* // "metadata": {},
|
|
21492
22530
|
* // "name": "my_name",
|
|
21493
22531
|
* // "nextSyncTime": {},
|
|
22532
|
+
* // "oauthStaticIpAddresses": [],
|
|
21494
22533
|
* // "params": {},
|
|
21495
22534
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
21496
22535
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -21501,6 +22540,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21501
22540
|
* // "staticIpAddresses": [],
|
|
21502
22541
|
* // "staticIpEnabled": false,
|
|
21503
22542
|
* // "syncMode": "my_syncMode",
|
|
22543
|
+
* // "tag": "my_tag",
|
|
21504
22544
|
* // "updateTime": "my_updateTime",
|
|
21505
22545
|
* // "vpcscEnabled": false
|
|
21506
22546
|
* // }
|
|
@@ -21541,8 +22581,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21541
22581
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
21542
22582
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
21543
22583
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
22584
|
+
* // "metadata": {},
|
|
21544
22585
|
* // "name": "my_name",
|
|
21545
22586
|
* // "nextSyncTime": {},
|
|
22587
|
+
* // "oauthStaticIpAddresses": [],
|
|
21546
22588
|
* // "params": {},
|
|
21547
22589
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
21548
22590
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -21553,6 +22595,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21553
22595
|
* // "staticIpAddresses": [],
|
|
21554
22596
|
* // "staticIpEnabled": false,
|
|
21555
22597
|
* // "syncMode": "my_syncMode",
|
|
22598
|
+
* // "tag": "my_tag",
|
|
21556
22599
|
* // "updateTime": "my_updateTime",
|
|
21557
22600
|
* // "vpcscEnabled": false
|
|
21558
22601
|
* // }
|
|
@@ -21691,6 +22734,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21691
22734
|
* requestBody: {
|
|
21692
22735
|
* // request body parameters
|
|
21693
22736
|
* // {
|
|
22737
|
+
* // "action": "my_action",
|
|
21694
22738
|
* // "scope": "my_scope"
|
|
21695
22739
|
* // }
|
|
21696
22740
|
* },
|
|
@@ -22608,6 +23652,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22608
23652
|
* // "documentProcessingConfig": {},
|
|
22609
23653
|
* // "federatedSearchConfig": {},
|
|
22610
23654
|
* // "healthcareFhirConfig": {},
|
|
23655
|
+
* // "iconUri": "my_iconUri",
|
|
22611
23656
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
22612
23657
|
* // "idpConfig": {},
|
|
22613
23658
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -22842,6 +23887,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22842
23887
|
* await discoveryengine.projects.locations.collections.dataStores.get({
|
|
22843
23888
|
* // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
22844
23889
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
23890
|
+
* // Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.
|
|
23891
|
+
* view: 'placeholder-value',
|
|
22845
23892
|
* });
|
|
22846
23893
|
* console.log(res.data);
|
|
22847
23894
|
*
|
|
@@ -22861,6 +23908,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22861
23908
|
* // "documentProcessingConfig": {},
|
|
22862
23909
|
* // "federatedSearchConfig": {},
|
|
22863
23910
|
* // "healthcareFhirConfig": {},
|
|
23911
|
+
* // "iconUri": "my_iconUri",
|
|
22864
23912
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
22865
23913
|
* // "idpConfig": {},
|
|
22866
23914
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -22894,6 +23942,82 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22894
23942
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
22895
23943
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
22896
23944
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
23945
|
+
/**
|
|
23946
|
+
* Gets a CompletionConfig
|
|
23947
|
+
* @example
|
|
23948
|
+
* ```js
|
|
23949
|
+
* // Before running the sample:
|
|
23950
|
+
* // - Enable the API at:
|
|
23951
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
23952
|
+
* // - Login into gcloud by running:
|
|
23953
|
+
* // ```sh
|
|
23954
|
+
* // $ gcloud auth application-default login
|
|
23955
|
+
* // ```
|
|
23956
|
+
* // - Install the npm module by running:
|
|
23957
|
+
* // ```sh
|
|
23958
|
+
* // $ npm install googleapis
|
|
23959
|
+
* // ```
|
|
23960
|
+
*
|
|
23961
|
+
* const {google} = require('googleapis');
|
|
23962
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
23963
|
+
*
|
|
23964
|
+
* async function main() {
|
|
23965
|
+
* const auth = new google.auth.GoogleAuth({
|
|
23966
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
23967
|
+
* scopes: [
|
|
23968
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
23969
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
23970
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
23971
|
+
* ],
|
|
23972
|
+
* });
|
|
23973
|
+
*
|
|
23974
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
23975
|
+
* const authClient = await auth.getClient();
|
|
23976
|
+
* google.options({auth: authClient});
|
|
23977
|
+
*
|
|
23978
|
+
* // Do the magic
|
|
23979
|
+
* const res =
|
|
23980
|
+
* await discoveryengine.projects.locations.collections.dataStores.getCompletionConfig(
|
|
23981
|
+
* {
|
|
23982
|
+
* // Required. Full CompletionConfig resource name. Format: `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
23983
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/completionConfig',
|
|
23984
|
+
* },
|
|
23985
|
+
* );
|
|
23986
|
+
* console.log(res.data);
|
|
23987
|
+
*
|
|
23988
|
+
* // Example response
|
|
23989
|
+
* // {
|
|
23990
|
+
* // "enableMode": "my_enableMode",
|
|
23991
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
23992
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
23993
|
+
* // "maxSuggestions": 0,
|
|
23994
|
+
* // "minPrefixLength": 0,
|
|
23995
|
+
* // "name": "my_name",
|
|
23996
|
+
* // "numUniqueUsersThreshold": 0,
|
|
23997
|
+
* // "queryFrequencyThreshold": 0,
|
|
23998
|
+
* // "queryModel": "my_queryModel",
|
|
23999
|
+
* // "shouldServeContentSuggestions": false
|
|
24000
|
+
* // }
|
|
24001
|
+
* }
|
|
24002
|
+
*
|
|
24003
|
+
* main().catch(e => {
|
|
24004
|
+
* console.error(e);
|
|
24005
|
+
* throw e;
|
|
24006
|
+
* });
|
|
24007
|
+
*
|
|
24008
|
+
* ```
|
|
24009
|
+
*
|
|
24010
|
+
* @param params - Parameters for request
|
|
24011
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24012
|
+
* @param callback - Optional callback that handles the response.
|
|
24013
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24014
|
+
*/
|
|
24015
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24016
|
+
getCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
24017
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24018
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24019
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24020
|
+
getCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
22897
24021
|
/**
|
|
22898
24022
|
* Gets a DocumentProcessingConfig.
|
|
22899
24023
|
* @example
|
|
@@ -23076,6 +24200,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23076
24200
|
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
23077
24201
|
* parent:
|
|
23078
24202
|
* 'projects/my-project/locations/my-location/collections/my-collection',
|
|
24203
|
+
* // Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons.
|
|
24204
|
+
* view: 'placeholder-value',
|
|
23079
24205
|
* });
|
|
23080
24206
|
* console.log(res.data);
|
|
23081
24207
|
*
|
|
@@ -23163,6 +24289,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23163
24289
|
* // "documentProcessingConfig": {},
|
|
23164
24290
|
* // "federatedSearchConfig": {},
|
|
23165
24291
|
* // "healthcareFhirConfig": {},
|
|
24292
|
+
* // "iconUri": "my_iconUri",
|
|
23166
24293
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
23167
24294
|
* // "idpConfig": {},
|
|
23168
24295
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -23196,6 +24323,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23196
24323
|
* // "documentProcessingConfig": {},
|
|
23197
24324
|
* // "federatedSearchConfig": {},
|
|
23198
24325
|
* // "healthcareFhirConfig": {},
|
|
24326
|
+
* // "iconUri": "my_iconUri",
|
|
23199
24327
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
23200
24328
|
* // "idpConfig": {},
|
|
23201
24329
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -23475,7 +24603,102 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23475
24603
|
trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
23476
24604
|
trainCustomModel(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
23477
24605
|
/**
|
|
23478
|
-
* Updates the
|
|
24606
|
+
* Updates the CompletionConfigs.
|
|
24607
|
+
* @example
|
|
24608
|
+
* ```js
|
|
24609
|
+
* // Before running the sample:
|
|
24610
|
+
* // - Enable the API at:
|
|
24611
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24612
|
+
* // - Login into gcloud by running:
|
|
24613
|
+
* // ```sh
|
|
24614
|
+
* // $ gcloud auth application-default login
|
|
24615
|
+
* // ```
|
|
24616
|
+
* // - Install the npm module by running:
|
|
24617
|
+
* // ```sh
|
|
24618
|
+
* // $ npm install googleapis
|
|
24619
|
+
* // ```
|
|
24620
|
+
*
|
|
24621
|
+
* const {google} = require('googleapis');
|
|
24622
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
24623
|
+
*
|
|
24624
|
+
* async function main() {
|
|
24625
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24626
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24627
|
+
* scopes: [
|
|
24628
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
24629
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
24630
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
24631
|
+
* ],
|
|
24632
|
+
* });
|
|
24633
|
+
*
|
|
24634
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
24635
|
+
* const authClient = await auth.getClient();
|
|
24636
|
+
* google.options({auth: authClient});
|
|
24637
|
+
*
|
|
24638
|
+
* // Do the magic
|
|
24639
|
+
* const res =
|
|
24640
|
+
* await discoveryengine.projects.locations.collections.dataStores.updateCompletionConfig(
|
|
24641
|
+
* {
|
|
24642
|
+
* // Required. Immutable. Fully qualified name `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
24643
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/completionConfig',
|
|
24644
|
+
* // 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.
|
|
24645
|
+
* updateMask: 'placeholder-value',
|
|
24646
|
+
*
|
|
24647
|
+
* // Request body metadata
|
|
24648
|
+
* requestBody: {
|
|
24649
|
+
* // request body parameters
|
|
24650
|
+
* // {
|
|
24651
|
+
* // "enableMode": "my_enableMode",
|
|
24652
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
24653
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
24654
|
+
* // "maxSuggestions": 0,
|
|
24655
|
+
* // "minPrefixLength": 0,
|
|
24656
|
+
* // "name": "my_name",
|
|
24657
|
+
* // "numUniqueUsersThreshold": 0,
|
|
24658
|
+
* // "queryFrequencyThreshold": 0,
|
|
24659
|
+
* // "queryModel": "my_queryModel",
|
|
24660
|
+
* // "shouldServeContentSuggestions": false
|
|
24661
|
+
* // }
|
|
24662
|
+
* },
|
|
24663
|
+
* },
|
|
24664
|
+
* );
|
|
24665
|
+
* console.log(res.data);
|
|
24666
|
+
*
|
|
24667
|
+
* // Example response
|
|
24668
|
+
* // {
|
|
24669
|
+
* // "enableMode": "my_enableMode",
|
|
24670
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
24671
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
24672
|
+
* // "maxSuggestions": 0,
|
|
24673
|
+
* // "minPrefixLength": 0,
|
|
24674
|
+
* // "name": "my_name",
|
|
24675
|
+
* // "numUniqueUsersThreshold": 0,
|
|
24676
|
+
* // "queryFrequencyThreshold": 0,
|
|
24677
|
+
* // "queryModel": "my_queryModel",
|
|
24678
|
+
* // "shouldServeContentSuggestions": false
|
|
24679
|
+
* // }
|
|
24680
|
+
* }
|
|
24681
|
+
*
|
|
24682
|
+
* main().catch(e => {
|
|
24683
|
+
* console.error(e);
|
|
24684
|
+
* throw e;
|
|
24685
|
+
* });
|
|
24686
|
+
*
|
|
24687
|
+
* ```
|
|
24688
|
+
*
|
|
24689
|
+
* @param params - Parameters for request
|
|
24690
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24691
|
+
* @param callback - Optional callback that handles the response.
|
|
24692
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24693
|
+
*/
|
|
24694
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24695
|
+
updateCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
24696
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24697
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24698
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24699
|
+
updateCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24700
|
+
/**
|
|
24701
|
+
* Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.
|
|
23479
24702
|
* @example
|
|
23480
24703
|
* ```js
|
|
23481
24704
|
* // Before running the sample:
|
|
@@ -23513,7 +24736,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23513
24736
|
* {
|
|
23514
24737
|
* // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
23515
24738
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/documentProcessingConfig',
|
|
23516
|
-
* //
|
|
24739
|
+
* // Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details.
|
|
23517
24740
|
* updateMask: 'placeholder-value',
|
|
23518
24741
|
*
|
|
23519
24742
|
* // Request body metadata
|
|
@@ -23641,6 +24864,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23641
24864
|
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
23642
24865
|
*/
|
|
23643
24866
|
name?: string;
|
|
24867
|
+
/**
|
|
24868
|
+
* Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.
|
|
24869
|
+
*/
|
|
24870
|
+
view?: string;
|
|
24871
|
+
}
|
|
24872
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig extends StandardParameters {
|
|
24873
|
+
/**
|
|
24874
|
+
* Required. Full CompletionConfig resource name. Format: `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
24875
|
+
*/
|
|
24876
|
+
name?: string;
|
|
23644
24877
|
}
|
|
23645
24878
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig extends StandardParameters {
|
|
23646
24879
|
/**
|
|
@@ -23671,6 +24904,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23671
24904
|
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
23672
24905
|
*/
|
|
23673
24906
|
parent?: string;
|
|
24907
|
+
/**
|
|
24908
|
+
* Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons.
|
|
24909
|
+
*/
|
|
24910
|
+
view?: string;
|
|
23674
24911
|
}
|
|
23675
24912
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters {
|
|
23676
24913
|
/**
|
|
@@ -23716,13 +24953,27 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23716
24953
|
*/
|
|
23717
24954
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest;
|
|
23718
24955
|
}
|
|
24956
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig extends StandardParameters {
|
|
24957
|
+
/**
|
|
24958
|
+
* Required. Immutable. Fully qualified name `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
24959
|
+
*/
|
|
24960
|
+
name?: string;
|
|
24961
|
+
/**
|
|
24962
|
+
* 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.
|
|
24963
|
+
*/
|
|
24964
|
+
updateMask?: string;
|
|
24965
|
+
/**
|
|
24966
|
+
* Request body metadata
|
|
24967
|
+
*/
|
|
24968
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
24969
|
+
}
|
|
23719
24970
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
23720
24971
|
/**
|
|
23721
24972
|
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
23722
24973
|
*/
|
|
23723
24974
|
name?: string;
|
|
23724
24975
|
/**
|
|
23725
|
-
*
|
|
24976
|
+
* Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details.
|
|
23726
24977
|
*/
|
|
23727
24978
|
updateMask?: string;
|
|
23728
24979
|
/**
|
|
@@ -31516,6 +32767,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31516
32767
|
* // "entity": "my_entity",
|
|
31517
32768
|
* // "eventTime": "my_eventTime",
|
|
31518
32769
|
* // "eventType": "my_eventType",
|
|
32770
|
+
* // "feedback": {},
|
|
31519
32771
|
* // "filter": "my_filter",
|
|
31520
32772
|
* // "mediaInfo": {},
|
|
31521
32773
|
* // "pageInfo": {},
|
|
@@ -31547,6 +32799,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31547
32799
|
* // "entity": "my_entity",
|
|
31548
32800
|
* // "eventTime": "my_eventTime",
|
|
31549
32801
|
* // "eventType": "my_eventType",
|
|
32802
|
+
* // "feedback": {},
|
|
31550
32803
|
* // "filter": "my_filter",
|
|
31551
32804
|
* // "mediaInfo": {},
|
|
31552
32805
|
* // "pageInfo": {},
|
|
@@ -31679,6 +32932,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31679
32932
|
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
31680
32933
|
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
31681
32934
|
* 'placeholder-value',
|
|
32935
|
+
* // Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).
|
|
32936
|
+
* languageCode: 'placeholder-value',
|
|
32937
|
+
* // Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).
|
|
32938
|
+
* modelInfoView: 'placeholder-value',
|
|
31682
32939
|
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
31683
32940
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
31684
32941
|
* },
|
|
@@ -31691,6 +32948,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31691
32948
|
* // "allowPublicAccess": false,
|
|
31692
32949
|
* // "allowlistedDomains": [],
|
|
31693
32950
|
* // "assistantSettings": {},
|
|
32951
|
+
* // "batchAuthStatuses": [],
|
|
31694
32952
|
* // "collectionComponents": [],
|
|
31695
32953
|
* // "configId": "my_configId",
|
|
31696
32954
|
* // "contentSearchSpec": {},
|
|
@@ -31796,6 +33054,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31796
33054
|
* // "allowPublicAccess": false,
|
|
31797
33055
|
* // "allowlistedDomains": [],
|
|
31798
33056
|
* // "assistantSettings": {},
|
|
33057
|
+
* // "batchAuthStatuses": [],
|
|
31799
33058
|
* // "collectionComponents": [],
|
|
31800
33059
|
* // "configId": "my_configId",
|
|
31801
33060
|
* // "contentSearchSpec": {},
|
|
@@ -31841,6 +33100,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31841
33100
|
* // "allowPublicAccess": false,
|
|
31842
33101
|
* // "allowlistedDomains": [],
|
|
31843
33102
|
* // "assistantSettings": {},
|
|
33103
|
+
* // "batchAuthStatuses": [],
|
|
31844
33104
|
* // "collectionComponents": [],
|
|
31845
33105
|
* // "configId": "my_configId",
|
|
31846
33106
|
* // "contentSearchSpec": {},
|
|
@@ -31905,6 +33165,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31905
33165
|
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
31906
33166
|
*/
|
|
31907
33167
|
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
33168
|
+
/**
|
|
33169
|
+
* Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).
|
|
33170
|
+
*/
|
|
33171
|
+
languageCode?: string;
|
|
33172
|
+
/**
|
|
33173
|
+
* Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).
|
|
33174
|
+
*/
|
|
33175
|
+
modelInfoView?: string;
|
|
31908
33176
|
/**
|
|
31909
33177
|
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
31910
33178
|
*/
|
|
@@ -31984,6 +33252,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31984
33252
|
* // {
|
|
31985
33253
|
* // "agentGatewaySetting": {},
|
|
31986
33254
|
* // "appType": "my_appType",
|
|
33255
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
31987
33256
|
* // "chatEngineConfig": {},
|
|
31988
33257
|
* // "chatEngineMetadata": {},
|
|
31989
33258
|
* // "cmekConfig": {},
|
|
@@ -32154,6 +33423,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32154
33423
|
* // {
|
|
32155
33424
|
* // "agentGatewaySetting": {},
|
|
32156
33425
|
* // "appType": "my_appType",
|
|
33426
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32157
33427
|
* // "chatEngineConfig": {},
|
|
32158
33428
|
* // "chatEngineMetadata": {},
|
|
32159
33429
|
* // "cmekConfig": {},
|
|
@@ -32199,6 +33469,82 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32199
33469
|
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
32200
33470
|
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
32201
33471
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
33472
|
+
/**
|
|
33473
|
+
* Gets a CompletionConfig
|
|
33474
|
+
* @example
|
|
33475
|
+
* ```js
|
|
33476
|
+
* // Before running the sample:
|
|
33477
|
+
* // - Enable the API at:
|
|
33478
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33479
|
+
* // - Login into gcloud by running:
|
|
33480
|
+
* // ```sh
|
|
33481
|
+
* // $ gcloud auth application-default login
|
|
33482
|
+
* // ```
|
|
33483
|
+
* // - Install the npm module by running:
|
|
33484
|
+
* // ```sh
|
|
33485
|
+
* // $ npm install googleapis
|
|
33486
|
+
* // ```
|
|
33487
|
+
*
|
|
33488
|
+
* const {google} = require('googleapis');
|
|
33489
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
33490
|
+
*
|
|
33491
|
+
* async function main() {
|
|
33492
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33493
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33494
|
+
* scopes: [
|
|
33495
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33496
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33497
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
33498
|
+
* ],
|
|
33499
|
+
* });
|
|
33500
|
+
*
|
|
33501
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33502
|
+
* const authClient = await auth.getClient();
|
|
33503
|
+
* google.options({auth: authClient});
|
|
33504
|
+
*
|
|
33505
|
+
* // Do the magic
|
|
33506
|
+
* const res =
|
|
33507
|
+
* await discoveryengine.projects.locations.collections.engines.getCompletionConfig(
|
|
33508
|
+
* {
|
|
33509
|
+
* // Required. Full CompletionConfig resource name. Format: `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
33510
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig',
|
|
33511
|
+
* },
|
|
33512
|
+
* );
|
|
33513
|
+
* console.log(res.data);
|
|
33514
|
+
*
|
|
33515
|
+
* // Example response
|
|
33516
|
+
* // {
|
|
33517
|
+
* // "enableMode": "my_enableMode",
|
|
33518
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
33519
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
33520
|
+
* // "maxSuggestions": 0,
|
|
33521
|
+
* // "minPrefixLength": 0,
|
|
33522
|
+
* // "name": "my_name",
|
|
33523
|
+
* // "numUniqueUsersThreshold": 0,
|
|
33524
|
+
* // "queryFrequencyThreshold": 0,
|
|
33525
|
+
* // "queryModel": "my_queryModel",
|
|
33526
|
+
* // "shouldServeContentSuggestions": false
|
|
33527
|
+
* // }
|
|
33528
|
+
* }
|
|
33529
|
+
*
|
|
33530
|
+
* main().catch(e => {
|
|
33531
|
+
* console.error(e);
|
|
33532
|
+
* throw e;
|
|
33533
|
+
* });
|
|
33534
|
+
*
|
|
33535
|
+
* ```
|
|
33536
|
+
*
|
|
33537
|
+
* @param params - Parameters for request
|
|
33538
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33539
|
+
* @param callback - Optional callback that handles the response.
|
|
33540
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33541
|
+
*/
|
|
33542
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33543
|
+
getCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
33544
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33545
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
33546
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
33547
|
+
getCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
32202
33548
|
/**
|
|
32203
33549
|
* 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.
|
|
32204
33550
|
* @example
|
|
@@ -32314,6 +33660,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32314
33660
|
*
|
|
32315
33661
|
* // Example response
|
|
32316
33662
|
* // {
|
|
33663
|
+
* // "customerDomainValid": false,
|
|
32317
33664
|
* // "workspaceAccessEnabled": false
|
|
32318
33665
|
* // }
|
|
32319
33666
|
* }
|
|
@@ -32457,6 +33804,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32457
33804
|
* // {
|
|
32458
33805
|
* // "agentGatewaySetting": {},
|
|
32459
33806
|
* // "appType": "my_appType",
|
|
33807
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32460
33808
|
* // "chatEngineConfig": {},
|
|
32461
33809
|
* // "chatEngineMetadata": {},
|
|
32462
33810
|
* // "cmekConfig": {},
|
|
@@ -32490,6 +33838,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32490
33838
|
* // {
|
|
32491
33839
|
* // "agentGatewaySetting": {},
|
|
32492
33840
|
* // "appType": "my_appType",
|
|
33841
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32493
33842
|
* // "chatEngineConfig": {},
|
|
32494
33843
|
* // "chatEngineMetadata": {},
|
|
32495
33844
|
* // "cmekConfig": {},
|
|
@@ -32586,6 +33935,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32586
33935
|
* // {
|
|
32587
33936
|
* // "agentGatewaySetting": {},
|
|
32588
33937
|
* // "appType": "my_appType",
|
|
33938
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32589
33939
|
* // "chatEngineConfig": {},
|
|
32590
33940
|
* // "chatEngineMetadata": {},
|
|
32591
33941
|
* // "cmekConfig": {},
|
|
@@ -32682,6 +34032,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32682
34032
|
* // {
|
|
32683
34033
|
* // "agentGatewaySetting": {},
|
|
32684
34034
|
* // "appType": "my_appType",
|
|
34035
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32685
34036
|
* // "chatEngineConfig": {},
|
|
32686
34037
|
* // "chatEngineMetadata": {},
|
|
32687
34038
|
* // "cmekConfig": {},
|
|
@@ -32879,6 +34230,101 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32879
34230
|
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
32880
34231
|
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
32881
34232
|
tune(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34233
|
+
/**
|
|
34234
|
+
* Updates the CompletionConfigs.
|
|
34235
|
+
* @example
|
|
34236
|
+
* ```js
|
|
34237
|
+
* // Before running the sample:
|
|
34238
|
+
* // - Enable the API at:
|
|
34239
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
34240
|
+
* // - Login into gcloud by running:
|
|
34241
|
+
* // ```sh
|
|
34242
|
+
* // $ gcloud auth application-default login
|
|
34243
|
+
* // ```
|
|
34244
|
+
* // - Install the npm module by running:
|
|
34245
|
+
* // ```sh
|
|
34246
|
+
* // $ npm install googleapis
|
|
34247
|
+
* // ```
|
|
34248
|
+
*
|
|
34249
|
+
* const {google} = require('googleapis');
|
|
34250
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
34251
|
+
*
|
|
34252
|
+
* async function main() {
|
|
34253
|
+
* const auth = new google.auth.GoogleAuth({
|
|
34254
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
34255
|
+
* scopes: [
|
|
34256
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
34257
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
34258
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
34259
|
+
* ],
|
|
34260
|
+
* });
|
|
34261
|
+
*
|
|
34262
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
34263
|
+
* const authClient = await auth.getClient();
|
|
34264
|
+
* google.options({auth: authClient});
|
|
34265
|
+
*
|
|
34266
|
+
* // Do the magic
|
|
34267
|
+
* const res =
|
|
34268
|
+
* await discoveryengine.projects.locations.collections.engines.updateCompletionConfig(
|
|
34269
|
+
* {
|
|
34270
|
+
* // Required. Immutable. Fully qualified name `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
34271
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig',
|
|
34272
|
+
* // 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.
|
|
34273
|
+
* updateMask: 'placeholder-value',
|
|
34274
|
+
*
|
|
34275
|
+
* // Request body metadata
|
|
34276
|
+
* requestBody: {
|
|
34277
|
+
* // request body parameters
|
|
34278
|
+
* // {
|
|
34279
|
+
* // "enableMode": "my_enableMode",
|
|
34280
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
34281
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
34282
|
+
* // "maxSuggestions": 0,
|
|
34283
|
+
* // "minPrefixLength": 0,
|
|
34284
|
+
* // "name": "my_name",
|
|
34285
|
+
* // "numUniqueUsersThreshold": 0,
|
|
34286
|
+
* // "queryFrequencyThreshold": 0,
|
|
34287
|
+
* // "queryModel": "my_queryModel",
|
|
34288
|
+
* // "shouldServeContentSuggestions": false
|
|
34289
|
+
* // }
|
|
34290
|
+
* },
|
|
34291
|
+
* },
|
|
34292
|
+
* );
|
|
34293
|
+
* console.log(res.data);
|
|
34294
|
+
*
|
|
34295
|
+
* // Example response
|
|
34296
|
+
* // {
|
|
34297
|
+
* // "enableMode": "my_enableMode",
|
|
34298
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
34299
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
34300
|
+
* // "maxSuggestions": 0,
|
|
34301
|
+
* // "minPrefixLength": 0,
|
|
34302
|
+
* // "name": "my_name",
|
|
34303
|
+
* // "numUniqueUsersThreshold": 0,
|
|
34304
|
+
* // "queryFrequencyThreshold": 0,
|
|
34305
|
+
* // "queryModel": "my_queryModel",
|
|
34306
|
+
* // "shouldServeContentSuggestions": false
|
|
34307
|
+
* // }
|
|
34308
|
+
* }
|
|
34309
|
+
*
|
|
34310
|
+
* main().catch(e => {
|
|
34311
|
+
* console.error(e);
|
|
34312
|
+
* throw e;
|
|
34313
|
+
* });
|
|
34314
|
+
*
|
|
34315
|
+
* ```
|
|
34316
|
+
*
|
|
34317
|
+
* @param params - Parameters for request
|
|
34318
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
34319
|
+
* @param callback - Optional callback that handles the response.
|
|
34320
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
34321
|
+
*/
|
|
34322
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34323
|
+
updateCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
34324
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34325
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
34326
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
34327
|
+
updateCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
32882
34328
|
}
|
|
32883
34329
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
|
|
32884
34330
|
/**
|
|
@@ -32906,6 +34352,12 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32906
34352
|
*/
|
|
32907
34353
|
name?: string;
|
|
32908
34354
|
}
|
|
34355
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig extends StandardParameters {
|
|
34356
|
+
/**
|
|
34357
|
+
* Required. Full CompletionConfig resource name. Format: `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
34358
|
+
*/
|
|
34359
|
+
name?: string;
|
|
34360
|
+
}
|
|
32909
34361
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy extends StandardParameters {
|
|
32910
34362
|
/**
|
|
32911
34363
|
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
@@ -32994,6 +34446,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32994
34446
|
*/
|
|
32995
34447
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest;
|
|
32996
34448
|
}
|
|
34449
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig extends StandardParameters {
|
|
34450
|
+
/**
|
|
34451
|
+
* Required. Immutable. Fully qualified name `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
34452
|
+
*/
|
|
34453
|
+
name?: string;
|
|
34454
|
+
/**
|
|
34455
|
+
* 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.
|
|
34456
|
+
*/
|
|
34457
|
+
updateMask?: string;
|
|
34458
|
+
/**
|
|
34459
|
+
* Request body metadata
|
|
34460
|
+
*/
|
|
34461
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
34462
|
+
}
|
|
32997
34463
|
export class Resource$Projects$Locations$Collections$Engines$Analytics {
|
|
32998
34464
|
context: APIRequestContext;
|
|
32999
34465
|
constructor(context: APIRequestContext);
|
|
@@ -33736,6 +35202,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33736
35202
|
* // {
|
|
33737
35203
|
* // "answer": {},
|
|
33738
35204
|
* // "assistToken": "my_assistToken",
|
|
35205
|
+
* // "connectorAuthErrors": [],
|
|
33739
35206
|
* // "invocationTools": [],
|
|
33740
35207
|
* // "invokedSkills": [],
|
|
33741
35208
|
* // "sessionInfo": {}
|
|
@@ -33880,6 +35347,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33880
35347
|
* // "adkAgentDefinition": {},
|
|
33881
35348
|
* // "authorizationConfig": {},
|
|
33882
35349
|
* // "createTime": "my_createTime",
|
|
35350
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
33883
35351
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
33884
35352
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
33885
35353
|
* // "description": "my_description",
|
|
@@ -33908,6 +35376,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33908
35376
|
* // "adkAgentDefinition": {},
|
|
33909
35377
|
* // "authorizationConfig": {},
|
|
33910
35378
|
* // "createTime": "my_createTime",
|
|
35379
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
33911
35380
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
33912
35381
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
33913
35382
|
* // "description": "my_description",
|
|
@@ -34067,6 +35536,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34067
35536
|
* // "adkAgentDefinition": {},
|
|
34068
35537
|
* // "authorizationConfig": {},
|
|
34069
35538
|
* // "createTime": "my_createTime",
|
|
35539
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
34070
35540
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
34071
35541
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
34072
35542
|
* // "description": "my_description",
|
|
@@ -34233,6 +35703,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34233
35703
|
* // "adkAgentDefinition": {},
|
|
34234
35704
|
* // "authorizationConfig": {},
|
|
34235
35705
|
* // "createTime": "my_createTime",
|
|
35706
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
34236
35707
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
34237
35708
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
34238
35709
|
* // "description": "my_description",
|
|
@@ -34261,6 +35732,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34261
35732
|
* // "adkAgentDefinition": {},
|
|
34262
35733
|
* // "authorizationConfig": {},
|
|
34263
35734
|
* // "createTime": "my_createTime",
|
|
35735
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
34264
35736
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
34265
35737
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
34266
35738
|
* // "description": "my_description",
|
|
@@ -37985,14 +39457,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37985
39457
|
}
|
|
37986
39458
|
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments {
|
|
37987
39459
|
context: APIRequestContext;
|
|
39460
|
+
alphaEvolvePrograms: Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms;
|
|
37988
39461
|
operations: Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations;
|
|
37989
39462
|
constructor(context: APIRequestContext);
|
|
37990
|
-
}
|
|
37991
|
-
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations {
|
|
37992
|
-
context: APIRequestContext;
|
|
37993
|
-
constructor(context: APIRequestContext);
|
|
37994
39463
|
/**
|
|
37995
|
-
*
|
|
39464
|
+
* Acquires one or more AlphaEvolveProgram from the generated queue of programs for evaluation.
|
|
37996
39465
|
* @example
|
|
37997
39466
|
* ```js
|
|
37998
39467
|
* // Before running the sample:
|
|
@@ -38026,112 +39495,26 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38026
39495
|
*
|
|
38027
39496
|
* // Do the magic
|
|
38028
39497
|
* const res =
|
|
38029
|
-
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.
|
|
39498
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.acquirePrograms(
|
|
38030
39499
|
* {
|
|
38031
|
-
* // The name of the
|
|
38032
|
-
*
|
|
38033
|
-
*
|
|
38034
|
-
* );
|
|
38035
|
-
* console.log(res.data);
|
|
38036
|
-
*
|
|
38037
|
-
* // Example response
|
|
38038
|
-
* // {
|
|
38039
|
-
* // "done": false,
|
|
38040
|
-
* // "error": {},
|
|
38041
|
-
* // "metadata": {},
|
|
38042
|
-
* // "name": "my_name",
|
|
38043
|
-
* // "response": {}
|
|
38044
|
-
* // }
|
|
38045
|
-
* }
|
|
38046
|
-
*
|
|
38047
|
-
* main().catch(e => {
|
|
38048
|
-
* console.error(e);
|
|
38049
|
-
* throw e;
|
|
38050
|
-
* });
|
|
38051
|
-
*
|
|
38052
|
-
* ```
|
|
38053
|
-
*
|
|
38054
|
-
* @param params - Parameters for request
|
|
38055
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38056
|
-
* @param callback - Optional callback that handles the response.
|
|
38057
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38058
|
-
*/
|
|
38059
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38060
|
-
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
38061
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38062
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38063
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38064
|
-
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38065
|
-
}
|
|
38066
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get extends StandardParameters {
|
|
38067
|
-
/**
|
|
38068
|
-
* The name of the operation resource.
|
|
38069
|
-
*/
|
|
38070
|
-
name?: string;
|
|
38071
|
-
}
|
|
38072
|
-
export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers {
|
|
38073
|
-
context: APIRequestContext;
|
|
38074
|
-
constructor(context: APIRequestContext);
|
|
38075
|
-
/**
|
|
38076
|
-
* Gets a Answer.
|
|
38077
|
-
* @example
|
|
38078
|
-
* ```js
|
|
38079
|
-
* // Before running the sample:
|
|
38080
|
-
* // - Enable the API at:
|
|
38081
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38082
|
-
* // - Login into gcloud by running:
|
|
38083
|
-
* // ```sh
|
|
38084
|
-
* // $ gcloud auth application-default login
|
|
38085
|
-
* // ```
|
|
38086
|
-
* // - Install the npm module by running:
|
|
38087
|
-
* // ```sh
|
|
38088
|
-
* // $ npm install googleapis
|
|
38089
|
-
* // ```
|
|
38090
|
-
*
|
|
38091
|
-
* const {google} = require('googleapis');
|
|
38092
|
-
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
38093
|
-
*
|
|
38094
|
-
* async function main() {
|
|
38095
|
-
* const auth = new google.auth.GoogleAuth({
|
|
38096
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38097
|
-
* scopes: [
|
|
38098
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38099
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38100
|
-
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
38101
|
-
* ],
|
|
38102
|
-
* });
|
|
38103
|
-
*
|
|
38104
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
38105
|
-
* const authClient = await auth.getClient();
|
|
38106
|
-
* google.options({auth: authClient});
|
|
39500
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveExperiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39501
|
+
* parent:
|
|
39502
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
38107
39503
|
*
|
|
38108
|
-
*
|
|
38109
|
-
*
|
|
38110
|
-
*
|
|
38111
|
-
*
|
|
38112
|
-
*
|
|
38113
|
-
*
|
|
39504
|
+
* // Request body metadata
|
|
39505
|
+
* requestBody: {
|
|
39506
|
+
* // request body parameters
|
|
39507
|
+
* // {
|
|
39508
|
+
* // "desiredProgramsCount": 0
|
|
39509
|
+
* // }
|
|
39510
|
+
* },
|
|
38114
39511
|
* },
|
|
38115
39512
|
* );
|
|
38116
39513
|
* console.log(res.data);
|
|
38117
39514
|
*
|
|
38118
39515
|
* // Example response
|
|
38119
39516
|
* // {
|
|
38120
|
-
* // "
|
|
38121
|
-
* // "answerText": "my_answerText",
|
|
38122
|
-
* // "blobAttachments": [],
|
|
38123
|
-
* // "citations": [],
|
|
38124
|
-
* // "completeTime": "my_completeTime",
|
|
38125
|
-
* // "createTime": "my_createTime",
|
|
38126
|
-
* // "groundingScore": {},
|
|
38127
|
-
* // "groundingSupports": [],
|
|
38128
|
-
* // "name": "my_name",
|
|
38129
|
-
* // "queryUnderstandingInfo": {},
|
|
38130
|
-
* // "references": [],
|
|
38131
|
-
* // "relatedQuestions": [],
|
|
38132
|
-
* // "safetyRatings": [],
|
|
38133
|
-
* // "state": "my_state",
|
|
38134
|
-
* // "steps": []
|
|
39517
|
+
* // "programs": []
|
|
38135
39518
|
* // }
|
|
38136
39519
|
* }
|
|
38137
39520
|
*
|
|
@@ -38147,24 +39530,1072 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38147
39530
|
* @param callback - Optional callback that handles the response.
|
|
38148
39531
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38149
39532
|
*/
|
|
38150
|
-
|
|
38151
|
-
|
|
38152
|
-
|
|
38153
|
-
|
|
38154
|
-
|
|
38155
|
-
|
|
38156
|
-
}
|
|
38157
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
|
|
38158
|
-
/**
|
|
38159
|
-
* Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
38160
|
-
*/
|
|
38161
|
-
name?: string;
|
|
38162
|
-
}
|
|
38163
|
-
export class Resource$Projects$Locations$Collections$Engines$Sessions$Files {
|
|
38164
|
-
context: APIRequestContext;
|
|
38165
|
-
constructor(context: APIRequestContext);
|
|
39533
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39534
|
+
acquirePrograms(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>>;
|
|
39535
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39536
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>): void;
|
|
39537
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>): void;
|
|
39538
|
+
acquirePrograms(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>): void;
|
|
38166
39539
|
/**
|
|
38167
|
-
*
|
|
39540
|
+
* Creates a new AlphaEvolveExperiment.
|
|
39541
|
+
* @example
|
|
39542
|
+
* ```js
|
|
39543
|
+
* // Before running the sample:
|
|
39544
|
+
* // - Enable the API at:
|
|
39545
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39546
|
+
* // - Login into gcloud by running:
|
|
39547
|
+
* // ```sh
|
|
39548
|
+
* // $ gcloud auth application-default login
|
|
39549
|
+
* // ```
|
|
39550
|
+
* // - Install the npm module by running:
|
|
39551
|
+
* // ```sh
|
|
39552
|
+
* // $ npm install googleapis
|
|
39553
|
+
* // ```
|
|
39554
|
+
*
|
|
39555
|
+
* const {google} = require('googleapis');
|
|
39556
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39557
|
+
*
|
|
39558
|
+
* async function main() {
|
|
39559
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39560
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39561
|
+
* scopes: [
|
|
39562
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39563
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39564
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39565
|
+
* ],
|
|
39566
|
+
* });
|
|
39567
|
+
*
|
|
39568
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39569
|
+
* const authClient = await auth.getClient();
|
|
39570
|
+
* google.options({auth: authClient});
|
|
39571
|
+
*
|
|
39572
|
+
* // Do the magic
|
|
39573
|
+
* const res =
|
|
39574
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.create(
|
|
39575
|
+
* {
|
|
39576
|
+
* // Required. The parent resource name (Session) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
39577
|
+
* parent:
|
|
39578
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
39579
|
+
*
|
|
39580
|
+
* // Request body metadata
|
|
39581
|
+
* requestBody: {
|
|
39582
|
+
* // request body parameters
|
|
39583
|
+
* // {
|
|
39584
|
+
* // "config": {},
|
|
39585
|
+
* // "createTime": "my_createTime",
|
|
39586
|
+
* // "initialAlphaEvolveProgram": "my_initialAlphaEvolveProgram",
|
|
39587
|
+
* // "name": "my_name",
|
|
39588
|
+
* // "state": "my_state",
|
|
39589
|
+
* // "stats": {}
|
|
39590
|
+
* // }
|
|
39591
|
+
* },
|
|
39592
|
+
* },
|
|
39593
|
+
* );
|
|
39594
|
+
* console.log(res.data);
|
|
39595
|
+
*
|
|
39596
|
+
* // Example response
|
|
39597
|
+
* // {
|
|
39598
|
+
* // "config": {},
|
|
39599
|
+
* // "createTime": "my_createTime",
|
|
39600
|
+
* // "initialAlphaEvolveProgram": "my_initialAlphaEvolveProgram",
|
|
39601
|
+
* // "name": "my_name",
|
|
39602
|
+
* // "state": "my_state",
|
|
39603
|
+
* // "stats": {}
|
|
39604
|
+
* // }
|
|
39605
|
+
* }
|
|
39606
|
+
*
|
|
39607
|
+
* main().catch(e => {
|
|
39608
|
+
* console.error(e);
|
|
39609
|
+
* throw e;
|
|
39610
|
+
* });
|
|
39611
|
+
*
|
|
39612
|
+
* ```
|
|
39613
|
+
*
|
|
39614
|
+
* @param params - Parameters for request
|
|
39615
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39616
|
+
* @param callback - Optional callback that handles the response.
|
|
39617
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39618
|
+
*/
|
|
39619
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39620
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>>;
|
|
39621
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39622
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39623
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39624
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39625
|
+
/**
|
|
39626
|
+
* Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded).
|
|
39627
|
+
* @example
|
|
39628
|
+
* ```js
|
|
39629
|
+
* // Before running the sample:
|
|
39630
|
+
* // - Enable the API at:
|
|
39631
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39632
|
+
* // - Login into gcloud by running:
|
|
39633
|
+
* // ```sh
|
|
39634
|
+
* // $ gcloud auth application-default login
|
|
39635
|
+
* // ```
|
|
39636
|
+
* // - Install the npm module by running:
|
|
39637
|
+
* // ```sh
|
|
39638
|
+
* // $ npm install googleapis
|
|
39639
|
+
* // ```
|
|
39640
|
+
*
|
|
39641
|
+
* const {google} = require('googleapis');
|
|
39642
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39643
|
+
*
|
|
39644
|
+
* async function main() {
|
|
39645
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39646
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39647
|
+
* scopes: [
|
|
39648
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39649
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39650
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39651
|
+
* ],
|
|
39652
|
+
* });
|
|
39653
|
+
*
|
|
39654
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39655
|
+
* const authClient = await auth.getClient();
|
|
39656
|
+
* google.options({auth: authClient});
|
|
39657
|
+
*
|
|
39658
|
+
* // Do the magic
|
|
39659
|
+
* const res =
|
|
39660
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.delete(
|
|
39661
|
+
* {
|
|
39662
|
+
* // Required. The full resource name of the experiment to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39663
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39664
|
+
* },
|
|
39665
|
+
* );
|
|
39666
|
+
* console.log(res.data);
|
|
39667
|
+
*
|
|
39668
|
+
* // Example response
|
|
39669
|
+
* // {}
|
|
39670
|
+
* }
|
|
39671
|
+
*
|
|
39672
|
+
* main().catch(e => {
|
|
39673
|
+
* console.error(e);
|
|
39674
|
+
* throw e;
|
|
39675
|
+
* });
|
|
39676
|
+
*
|
|
39677
|
+
* ```
|
|
39678
|
+
*
|
|
39679
|
+
* @param params - Parameters for request
|
|
39680
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39681
|
+
* @param callback - Optional callback that handles the response.
|
|
39682
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39683
|
+
*/
|
|
39684
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39685
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
39686
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39687
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
39688
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
39689
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
39690
|
+
/**
|
|
39691
|
+
* Get an existing AlphaEvolveExperiment.
|
|
39692
|
+
* @example
|
|
39693
|
+
* ```js
|
|
39694
|
+
* // Before running the sample:
|
|
39695
|
+
* // - Enable the API at:
|
|
39696
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39697
|
+
* // - Login into gcloud by running:
|
|
39698
|
+
* // ```sh
|
|
39699
|
+
* // $ gcloud auth application-default login
|
|
39700
|
+
* // ```
|
|
39701
|
+
* // - Install the npm module by running:
|
|
39702
|
+
* // ```sh
|
|
39703
|
+
* // $ npm install googleapis
|
|
39704
|
+
* // ```
|
|
39705
|
+
*
|
|
39706
|
+
* const {google} = require('googleapis');
|
|
39707
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39708
|
+
*
|
|
39709
|
+
* async function main() {
|
|
39710
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39711
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39712
|
+
* scopes: [
|
|
39713
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39714
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39715
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39716
|
+
* ],
|
|
39717
|
+
* });
|
|
39718
|
+
*
|
|
39719
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39720
|
+
* const authClient = await auth.getClient();
|
|
39721
|
+
* google.options({auth: authClient});
|
|
39722
|
+
*
|
|
39723
|
+
* // Do the magic
|
|
39724
|
+
* const res =
|
|
39725
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.get(
|
|
39726
|
+
* {
|
|
39727
|
+
* // Required. The full resource name of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39728
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39729
|
+
* },
|
|
39730
|
+
* );
|
|
39731
|
+
* console.log(res.data);
|
|
39732
|
+
*
|
|
39733
|
+
* // Example response
|
|
39734
|
+
* // {
|
|
39735
|
+
* // "config": {},
|
|
39736
|
+
* // "createTime": "my_createTime",
|
|
39737
|
+
* // "initialAlphaEvolveProgram": "my_initialAlphaEvolveProgram",
|
|
39738
|
+
* // "name": "my_name",
|
|
39739
|
+
* // "state": "my_state",
|
|
39740
|
+
* // "stats": {}
|
|
39741
|
+
* // }
|
|
39742
|
+
* }
|
|
39743
|
+
*
|
|
39744
|
+
* main().catch(e => {
|
|
39745
|
+
* console.error(e);
|
|
39746
|
+
* throw e;
|
|
39747
|
+
* });
|
|
39748
|
+
*
|
|
39749
|
+
* ```
|
|
39750
|
+
*
|
|
39751
|
+
* @param params - Parameters for request
|
|
39752
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39753
|
+
* @param callback - Optional callback that handles the response.
|
|
39754
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39755
|
+
*/
|
|
39756
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39757
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>>;
|
|
39758
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39759
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39760
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39761
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39762
|
+
/**
|
|
39763
|
+
* List all AlphaEvolveExperiments in a given session.
|
|
39764
|
+
* @example
|
|
39765
|
+
* ```js
|
|
39766
|
+
* // Before running the sample:
|
|
39767
|
+
* // - Enable the API at:
|
|
39768
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39769
|
+
* // - Login into gcloud by running:
|
|
39770
|
+
* // ```sh
|
|
39771
|
+
* // $ gcloud auth application-default login
|
|
39772
|
+
* // ```
|
|
39773
|
+
* // - Install the npm module by running:
|
|
39774
|
+
* // ```sh
|
|
39775
|
+
* // $ npm install googleapis
|
|
39776
|
+
* // ```
|
|
39777
|
+
*
|
|
39778
|
+
* const {google} = require('googleapis');
|
|
39779
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39780
|
+
*
|
|
39781
|
+
* async function main() {
|
|
39782
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39783
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39784
|
+
* scopes: [
|
|
39785
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39786
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39787
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39788
|
+
* ],
|
|
39789
|
+
* });
|
|
39790
|
+
*
|
|
39791
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39792
|
+
* const authClient = await auth.getClient();
|
|
39793
|
+
* google.options({auth: authClient});
|
|
39794
|
+
*
|
|
39795
|
+
* // Do the magic
|
|
39796
|
+
* const res =
|
|
39797
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.list(
|
|
39798
|
+
* {
|
|
39799
|
+
* // Optional. The maximum number of experiments to return. The service may return fewer than this value.
|
|
39800
|
+
* pageSize: 'placeholder-value',
|
|
39801
|
+
* // Optional. A page token, received from a previous `ListAlphaEvolveExperiments` call. Provide this to retrieve the subsequent page.
|
|
39802
|
+
* pageToken: 'placeholder-value',
|
|
39803
|
+
* // Required. The parent resource name (Session) of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
39804
|
+
* parent:
|
|
39805
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
39806
|
+
* },
|
|
39807
|
+
* );
|
|
39808
|
+
* console.log(res.data);
|
|
39809
|
+
*
|
|
39810
|
+
* // Example response
|
|
39811
|
+
* // {
|
|
39812
|
+
* // "alphaEvolveExperiments": [],
|
|
39813
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
39814
|
+
* // }
|
|
39815
|
+
* }
|
|
39816
|
+
*
|
|
39817
|
+
* main().catch(e => {
|
|
39818
|
+
* console.error(e);
|
|
39819
|
+
* throw e;
|
|
39820
|
+
* });
|
|
39821
|
+
*
|
|
39822
|
+
* ```
|
|
39823
|
+
*
|
|
39824
|
+
* @param params - Parameters for request
|
|
39825
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39826
|
+
* @param callback - Optional callback that handles the response.
|
|
39827
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39828
|
+
*/
|
|
39829
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39830
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>>;
|
|
39831
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39832
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>): void;
|
|
39833
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>): void;
|
|
39834
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>): void;
|
|
39835
|
+
/**
|
|
39836
|
+
* Resumes a workflow to process the AlphaEvolveExperiment.
|
|
39837
|
+
* @example
|
|
39838
|
+
* ```js
|
|
39839
|
+
* // Before running the sample:
|
|
39840
|
+
* // - Enable the API at:
|
|
39841
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39842
|
+
* // - Login into gcloud by running:
|
|
39843
|
+
* // ```sh
|
|
39844
|
+
* // $ gcloud auth application-default login
|
|
39845
|
+
* // ```
|
|
39846
|
+
* // - Install the npm module by running:
|
|
39847
|
+
* // ```sh
|
|
39848
|
+
* // $ npm install googleapis
|
|
39849
|
+
* // ```
|
|
39850
|
+
*
|
|
39851
|
+
* const {google} = require('googleapis');
|
|
39852
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39853
|
+
*
|
|
39854
|
+
* async function main() {
|
|
39855
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39856
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39857
|
+
* scopes: [
|
|
39858
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39859
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39860
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39861
|
+
* ],
|
|
39862
|
+
* });
|
|
39863
|
+
*
|
|
39864
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39865
|
+
* const authClient = await auth.getClient();
|
|
39866
|
+
* google.options({auth: authClient});
|
|
39867
|
+
*
|
|
39868
|
+
* // Do the magic
|
|
39869
|
+
* const res =
|
|
39870
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.resume(
|
|
39871
|
+
* {
|
|
39872
|
+
* // Required. Experiment to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39873
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39874
|
+
*
|
|
39875
|
+
* // Request body metadata
|
|
39876
|
+
* requestBody: {
|
|
39877
|
+
* // request body parameters
|
|
39878
|
+
* // {}
|
|
39879
|
+
* },
|
|
39880
|
+
* },
|
|
39881
|
+
* );
|
|
39882
|
+
* console.log(res.data);
|
|
39883
|
+
*
|
|
39884
|
+
* // Example response
|
|
39885
|
+
* // {
|
|
39886
|
+
* // "done": false,
|
|
39887
|
+
* // "error": {},
|
|
39888
|
+
* // "metadata": {},
|
|
39889
|
+
* // "name": "my_name",
|
|
39890
|
+
* // "response": {}
|
|
39891
|
+
* // }
|
|
39892
|
+
* }
|
|
39893
|
+
*
|
|
39894
|
+
* main().catch(e => {
|
|
39895
|
+
* console.error(e);
|
|
39896
|
+
* throw e;
|
|
39897
|
+
* });
|
|
39898
|
+
*
|
|
39899
|
+
* ```
|
|
39900
|
+
*
|
|
39901
|
+
* @param params - Parameters for request
|
|
39902
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39903
|
+
* @param callback - Optional callback that handles the response.
|
|
39904
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39905
|
+
*/
|
|
39906
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39907
|
+
resume(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
39908
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39909
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39910
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39911
|
+
resume(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39912
|
+
/**
|
|
39913
|
+
* Starts a workflow to process the AlphaEvolveExperiment.
|
|
39914
|
+
* @example
|
|
39915
|
+
* ```js
|
|
39916
|
+
* // Before running the sample:
|
|
39917
|
+
* // - Enable the API at:
|
|
39918
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39919
|
+
* // - Login into gcloud by running:
|
|
39920
|
+
* // ```sh
|
|
39921
|
+
* // $ gcloud auth application-default login
|
|
39922
|
+
* // ```
|
|
39923
|
+
* // - Install the npm module by running:
|
|
39924
|
+
* // ```sh
|
|
39925
|
+
* // $ npm install googleapis
|
|
39926
|
+
* // ```
|
|
39927
|
+
*
|
|
39928
|
+
* const {google} = require('googleapis');
|
|
39929
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39930
|
+
*
|
|
39931
|
+
* async function main() {
|
|
39932
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39933
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39934
|
+
* scopes: [
|
|
39935
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39936
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39937
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39938
|
+
* ],
|
|
39939
|
+
* });
|
|
39940
|
+
*
|
|
39941
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39942
|
+
* const authClient = await auth.getClient();
|
|
39943
|
+
* google.options({auth: authClient});
|
|
39944
|
+
*
|
|
39945
|
+
* // Do the magic
|
|
39946
|
+
* const res =
|
|
39947
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.start(
|
|
39948
|
+
* {
|
|
39949
|
+
* // Required. Experiment to start. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39950
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39951
|
+
*
|
|
39952
|
+
* // Request body metadata
|
|
39953
|
+
* requestBody: {
|
|
39954
|
+
* // request body parameters
|
|
39955
|
+
* // {
|
|
39956
|
+
* // "name": "my_name"
|
|
39957
|
+
* // }
|
|
39958
|
+
* },
|
|
39959
|
+
* },
|
|
39960
|
+
* );
|
|
39961
|
+
* console.log(res.data);
|
|
39962
|
+
*
|
|
39963
|
+
* // Example response
|
|
39964
|
+
* // {
|
|
39965
|
+
* // "done": false,
|
|
39966
|
+
* // "error": {},
|
|
39967
|
+
* // "metadata": {},
|
|
39968
|
+
* // "name": "my_name",
|
|
39969
|
+
* // "response": {}
|
|
39970
|
+
* // }
|
|
39971
|
+
* }
|
|
39972
|
+
*
|
|
39973
|
+
* main().catch(e => {
|
|
39974
|
+
* console.error(e);
|
|
39975
|
+
* throw e;
|
|
39976
|
+
* });
|
|
39977
|
+
*
|
|
39978
|
+
* ```
|
|
39979
|
+
*
|
|
39980
|
+
* @param params - Parameters for request
|
|
39981
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39982
|
+
* @param callback - Optional callback that handles the response.
|
|
39983
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39984
|
+
*/
|
|
39985
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39986
|
+
start(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
39987
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39988
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39989
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39990
|
+
start(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39991
|
+
/**
|
|
39992
|
+
* Adds an AlphaEvolveProgramEvaluation to the experiment.
|
|
39993
|
+
* @example
|
|
39994
|
+
* ```js
|
|
39995
|
+
* // Before running the sample:
|
|
39996
|
+
* // - Enable the API at:
|
|
39997
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39998
|
+
* // - Login into gcloud by running:
|
|
39999
|
+
* // ```sh
|
|
40000
|
+
* // $ gcloud auth application-default login
|
|
40001
|
+
* // ```
|
|
40002
|
+
* // - Install the npm module by running:
|
|
40003
|
+
* // ```sh
|
|
40004
|
+
* // $ npm install googleapis
|
|
40005
|
+
* // ```
|
|
40006
|
+
*
|
|
40007
|
+
* const {google} = require('googleapis');
|
|
40008
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40009
|
+
*
|
|
40010
|
+
* async function main() {
|
|
40011
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40012
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40013
|
+
* scopes: [
|
|
40014
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40015
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40016
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40017
|
+
* ],
|
|
40018
|
+
* });
|
|
40019
|
+
*
|
|
40020
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40021
|
+
* const authClient = await auth.getClient();
|
|
40022
|
+
* google.options({auth: authClient});
|
|
40023
|
+
*
|
|
40024
|
+
* // Do the magic
|
|
40025
|
+
* const res =
|
|
40026
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.submitProgramsEvaluations(
|
|
40027
|
+
* {
|
|
40028
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40029
|
+
* parent:
|
|
40030
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
40031
|
+
*
|
|
40032
|
+
* // Request body metadata
|
|
40033
|
+
* requestBody: {
|
|
40034
|
+
* // request body parameters
|
|
40035
|
+
* // {
|
|
40036
|
+
* // "evaluationSubmissions": []
|
|
40037
|
+
* // }
|
|
40038
|
+
* },
|
|
40039
|
+
* },
|
|
40040
|
+
* );
|
|
40041
|
+
* console.log(res.data);
|
|
40042
|
+
*
|
|
40043
|
+
* // Example response
|
|
40044
|
+
* // {}
|
|
40045
|
+
* }
|
|
40046
|
+
*
|
|
40047
|
+
* main().catch(e => {
|
|
40048
|
+
* console.error(e);
|
|
40049
|
+
* throw e;
|
|
40050
|
+
* });
|
|
40051
|
+
*
|
|
40052
|
+
* ```
|
|
40053
|
+
*
|
|
40054
|
+
* @param params - Parameters for request
|
|
40055
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40056
|
+
* @param callback - Optional callback that handles the response.
|
|
40057
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40058
|
+
*/
|
|
40059
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40060
|
+
submitProgramsEvaluations(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>>;
|
|
40061
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40062
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>): void;
|
|
40063
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>): void;
|
|
40064
|
+
submitProgramsEvaluations(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>): void;
|
|
40065
|
+
}
|
|
40066
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms extends StandardParameters {
|
|
40067
|
+
/**
|
|
40068
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveExperiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40069
|
+
*/
|
|
40070
|
+
parent?: string;
|
|
40071
|
+
/**
|
|
40072
|
+
* Request body metadata
|
|
40073
|
+
*/
|
|
40074
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsRequest;
|
|
40075
|
+
}
|
|
40076
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create extends StandardParameters {
|
|
40077
|
+
/**
|
|
40078
|
+
* Required. The parent resource name (Session) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
40079
|
+
*/
|
|
40080
|
+
parent?: string;
|
|
40081
|
+
/**
|
|
40082
|
+
* Request body metadata
|
|
40083
|
+
*/
|
|
40084
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment;
|
|
40085
|
+
}
|
|
40086
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete extends StandardParameters {
|
|
40087
|
+
/**
|
|
40088
|
+
* Required. The full resource name of the experiment to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40089
|
+
*/
|
|
40090
|
+
name?: string;
|
|
40091
|
+
}
|
|
40092
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get extends StandardParameters {
|
|
40093
|
+
/**
|
|
40094
|
+
* Required. The full resource name of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40095
|
+
*/
|
|
40096
|
+
name?: string;
|
|
40097
|
+
}
|
|
40098
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List extends StandardParameters {
|
|
40099
|
+
/**
|
|
40100
|
+
* Optional. The maximum number of experiments to return. The service may return fewer than this value.
|
|
40101
|
+
*/
|
|
40102
|
+
pageSize?: number;
|
|
40103
|
+
/**
|
|
40104
|
+
* Optional. A page token, received from a previous `ListAlphaEvolveExperiments` call. Provide this to retrieve the subsequent page.
|
|
40105
|
+
*/
|
|
40106
|
+
pageToken?: string;
|
|
40107
|
+
/**
|
|
40108
|
+
* Required. The parent resource name (Session) of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
40109
|
+
*/
|
|
40110
|
+
parent?: string;
|
|
40111
|
+
}
|
|
40112
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume extends StandardParameters {
|
|
40113
|
+
/**
|
|
40114
|
+
* Required. Experiment to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40115
|
+
*/
|
|
40116
|
+
name?: string;
|
|
40117
|
+
/**
|
|
40118
|
+
* Request body metadata
|
|
40119
|
+
*/
|
|
40120
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest;
|
|
40121
|
+
}
|
|
40122
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start extends StandardParameters {
|
|
40123
|
+
/**
|
|
40124
|
+
* Required. Experiment to start. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40125
|
+
*/
|
|
40126
|
+
name?: string;
|
|
40127
|
+
/**
|
|
40128
|
+
* Request body metadata
|
|
40129
|
+
*/
|
|
40130
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentRequest;
|
|
40131
|
+
}
|
|
40132
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations extends StandardParameters {
|
|
40133
|
+
/**
|
|
40134
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40135
|
+
*/
|
|
40136
|
+
parent?: string;
|
|
40137
|
+
/**
|
|
40138
|
+
* Request body metadata
|
|
40139
|
+
*/
|
|
40140
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest;
|
|
40141
|
+
}
|
|
40142
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms {
|
|
40143
|
+
context: APIRequestContext;
|
|
40144
|
+
constructor(context: APIRequestContext);
|
|
40145
|
+
/**
|
|
40146
|
+
* Creates a new AlphaEvolveProgram.
|
|
40147
|
+
* @example
|
|
40148
|
+
* ```js
|
|
40149
|
+
* // Before running the sample:
|
|
40150
|
+
* // - Enable the API at:
|
|
40151
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40152
|
+
* // - Login into gcloud by running:
|
|
40153
|
+
* // ```sh
|
|
40154
|
+
* // $ gcloud auth application-default login
|
|
40155
|
+
* // ```
|
|
40156
|
+
* // - Install the npm module by running:
|
|
40157
|
+
* // ```sh
|
|
40158
|
+
* // $ npm install googleapis
|
|
40159
|
+
* // ```
|
|
40160
|
+
*
|
|
40161
|
+
* const {google} = require('googleapis');
|
|
40162
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40163
|
+
*
|
|
40164
|
+
* async function main() {
|
|
40165
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40166
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40167
|
+
* scopes: [
|
|
40168
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40169
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40170
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40171
|
+
* ],
|
|
40172
|
+
* });
|
|
40173
|
+
*
|
|
40174
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40175
|
+
* const authClient = await auth.getClient();
|
|
40176
|
+
* google.options({auth: authClient});
|
|
40177
|
+
*
|
|
40178
|
+
* // Do the magic
|
|
40179
|
+
* const res =
|
|
40180
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.create(
|
|
40181
|
+
* {
|
|
40182
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveProgram. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40183
|
+
* parent:
|
|
40184
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
40185
|
+
*
|
|
40186
|
+
* // Request body metadata
|
|
40187
|
+
* requestBody: {
|
|
40188
|
+
* // request body parameters
|
|
40189
|
+
* // {
|
|
40190
|
+
* // "content": {},
|
|
40191
|
+
* // "createTime": "my_createTime",
|
|
40192
|
+
* // "evaluation": {},
|
|
40193
|
+
* // "lockToken": "my_lockToken",
|
|
40194
|
+
* // "name": "my_name",
|
|
40195
|
+
* // "parentPrograms": [],
|
|
40196
|
+
* // "state": "my_state"
|
|
40197
|
+
* // }
|
|
40198
|
+
* },
|
|
40199
|
+
* },
|
|
40200
|
+
* );
|
|
40201
|
+
* console.log(res.data);
|
|
40202
|
+
*
|
|
40203
|
+
* // Example response
|
|
40204
|
+
* // {
|
|
40205
|
+
* // "content": {},
|
|
40206
|
+
* // "createTime": "my_createTime",
|
|
40207
|
+
* // "evaluation": {},
|
|
40208
|
+
* // "lockToken": "my_lockToken",
|
|
40209
|
+
* // "name": "my_name",
|
|
40210
|
+
* // "parentPrograms": [],
|
|
40211
|
+
* // "state": "my_state"
|
|
40212
|
+
* // }
|
|
40213
|
+
* }
|
|
40214
|
+
*
|
|
40215
|
+
* main().catch(e => {
|
|
40216
|
+
* console.error(e);
|
|
40217
|
+
* throw e;
|
|
40218
|
+
* });
|
|
40219
|
+
*
|
|
40220
|
+
* ```
|
|
40221
|
+
*
|
|
40222
|
+
* @param params - Parameters for request
|
|
40223
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40224
|
+
* @param callback - Optional callback that handles the response.
|
|
40225
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40226
|
+
*/
|
|
40227
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40228
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>>;
|
|
40229
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40230
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40231
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40232
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40233
|
+
/**
|
|
40234
|
+
* Gets an existing AlphaEvolveProgram.
|
|
40235
|
+
* @example
|
|
40236
|
+
* ```js
|
|
40237
|
+
* // Before running the sample:
|
|
40238
|
+
* // - Enable the API at:
|
|
40239
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40240
|
+
* // - Login into gcloud by running:
|
|
40241
|
+
* // ```sh
|
|
40242
|
+
* // $ gcloud auth application-default login
|
|
40243
|
+
* // ```
|
|
40244
|
+
* // - Install the npm module by running:
|
|
40245
|
+
* // ```sh
|
|
40246
|
+
* // $ npm install googleapis
|
|
40247
|
+
* // ```
|
|
40248
|
+
*
|
|
40249
|
+
* const {google} = require('googleapis');
|
|
40250
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40251
|
+
*
|
|
40252
|
+
* async function main() {
|
|
40253
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40254
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40255
|
+
* scopes: [
|
|
40256
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40257
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40258
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40259
|
+
* ],
|
|
40260
|
+
* });
|
|
40261
|
+
*
|
|
40262
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40263
|
+
* const authClient = await auth.getClient();
|
|
40264
|
+
* google.options({auth: authClient});
|
|
40265
|
+
*
|
|
40266
|
+
* // Do the magic
|
|
40267
|
+
* const res =
|
|
40268
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.get(
|
|
40269
|
+
* {
|
|
40270
|
+
* // Required. The full resource name of the program. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}/alphaEvolvePrograms/{alpha_evolve_program\}`
|
|
40271
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment/alphaEvolvePrograms/my-alphaEvolveProgram',
|
|
40272
|
+
* },
|
|
40273
|
+
* );
|
|
40274
|
+
* console.log(res.data);
|
|
40275
|
+
*
|
|
40276
|
+
* // Example response
|
|
40277
|
+
* // {
|
|
40278
|
+
* // "content": {},
|
|
40279
|
+
* // "createTime": "my_createTime",
|
|
40280
|
+
* // "evaluation": {},
|
|
40281
|
+
* // "lockToken": "my_lockToken",
|
|
40282
|
+
* // "name": "my_name",
|
|
40283
|
+
* // "parentPrograms": [],
|
|
40284
|
+
* // "state": "my_state"
|
|
40285
|
+
* // }
|
|
40286
|
+
* }
|
|
40287
|
+
*
|
|
40288
|
+
* main().catch(e => {
|
|
40289
|
+
* console.error(e);
|
|
40290
|
+
* throw e;
|
|
40291
|
+
* });
|
|
40292
|
+
*
|
|
40293
|
+
* ```
|
|
40294
|
+
*
|
|
40295
|
+
* @param params - Parameters for request
|
|
40296
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40297
|
+
* @param callback - Optional callback that handles the response.
|
|
40298
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40299
|
+
*/
|
|
40300
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40301
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>>;
|
|
40302
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40303
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40304
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40305
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40306
|
+
/**
|
|
40307
|
+
* List all AlphaEvolvePrograms in a given experiment that follow the criteria provided in the request.
|
|
40308
|
+
* @example
|
|
40309
|
+
* ```js
|
|
40310
|
+
* // Before running the sample:
|
|
40311
|
+
* // - Enable the API at:
|
|
40312
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40313
|
+
* // - Login into gcloud by running:
|
|
40314
|
+
* // ```sh
|
|
40315
|
+
* // $ gcloud auth application-default login
|
|
40316
|
+
* // ```
|
|
40317
|
+
* // - Install the npm module by running:
|
|
40318
|
+
* // ```sh
|
|
40319
|
+
* // $ npm install googleapis
|
|
40320
|
+
* // ```
|
|
40321
|
+
*
|
|
40322
|
+
* const {google} = require('googleapis');
|
|
40323
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40324
|
+
*
|
|
40325
|
+
* async function main() {
|
|
40326
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40327
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40328
|
+
* scopes: [
|
|
40329
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40330
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40331
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40332
|
+
* ],
|
|
40333
|
+
* });
|
|
40334
|
+
*
|
|
40335
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40336
|
+
* const authClient = await auth.getClient();
|
|
40337
|
+
* google.options({auth: authClient});
|
|
40338
|
+
*
|
|
40339
|
+
* // Do the magic
|
|
40340
|
+
* const res =
|
|
40341
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.list(
|
|
40342
|
+
* {
|
|
40343
|
+
* // Optional. Sorting criterion for the programs. Comma separated list of metrics to sort by and optionally sort order, e.g. "score1 desc, score2". The criteria are applied in the order listed in the field. An implicit criterion of sorting by create_time descending is always applied as the final tie-breaker after all other specified criteria.
|
|
40344
|
+
* orderBy: 'placeholder-value',
|
|
40345
|
+
* // Optional. The maximum number of programs to return. The service may return fewer than this value.
|
|
40346
|
+
* pageSize: 'placeholder-value',
|
|
40347
|
+
* // Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page.
|
|
40348
|
+
* pageToken: 'placeholder-value',
|
|
40349
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40350
|
+
* parent:
|
|
40351
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
40352
|
+
* // Optional. Filter to apply to the programs. Examples: "state_filter = \'COMPLETED\'" "state_filter = \'INITIALIZED\' OR "state_filter = \'EVALUATING\'" If empty, the behavior defaults to listing programs in REGISTRATION_COMPLETE state or processing state is NULL.
|
|
40353
|
+
* stateFilter: 'placeholder-value',
|
|
40354
|
+
* },
|
|
40355
|
+
* );
|
|
40356
|
+
* console.log(res.data);
|
|
40357
|
+
*
|
|
40358
|
+
* // Example response
|
|
40359
|
+
* // {
|
|
40360
|
+
* // "alphaEvolvePrograms": [],
|
|
40361
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
40362
|
+
* // }
|
|
40363
|
+
* }
|
|
40364
|
+
*
|
|
40365
|
+
* main().catch(e => {
|
|
40366
|
+
* console.error(e);
|
|
40367
|
+
* throw e;
|
|
40368
|
+
* });
|
|
40369
|
+
*
|
|
40370
|
+
* ```
|
|
40371
|
+
*
|
|
40372
|
+
* @param params - Parameters for request
|
|
40373
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40374
|
+
* @param callback - Optional callback that handles the response.
|
|
40375
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40376
|
+
*/
|
|
40377
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40378
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>>;
|
|
40379
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40380
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>): void;
|
|
40381
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>): void;
|
|
40382
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>): void;
|
|
40383
|
+
}
|
|
40384
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create extends StandardParameters {
|
|
40385
|
+
/**
|
|
40386
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveProgram. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40387
|
+
*/
|
|
40388
|
+
parent?: string;
|
|
40389
|
+
/**
|
|
40390
|
+
* Request body metadata
|
|
40391
|
+
*/
|
|
40392
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram;
|
|
40393
|
+
}
|
|
40394
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get extends StandardParameters {
|
|
40395
|
+
/**
|
|
40396
|
+
* Required. The full resource name of the program. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}/alphaEvolvePrograms/{alpha_evolve_program\}`
|
|
40397
|
+
*/
|
|
40398
|
+
name?: string;
|
|
40399
|
+
}
|
|
40400
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List extends StandardParameters {
|
|
40401
|
+
/**
|
|
40402
|
+
* Optional. Sorting criterion for the programs. Comma separated list of metrics to sort by and optionally sort order, e.g. "score1 desc, score2". The criteria are applied in the order listed in the field. An implicit criterion of sorting by create_time descending is always applied as the final tie-breaker after all other specified criteria.
|
|
40403
|
+
*/
|
|
40404
|
+
orderBy?: string;
|
|
40405
|
+
/**
|
|
40406
|
+
* Optional. The maximum number of programs to return. The service may return fewer than this value.
|
|
40407
|
+
*/
|
|
40408
|
+
pageSize?: number;
|
|
40409
|
+
/**
|
|
40410
|
+
* Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page.
|
|
40411
|
+
*/
|
|
40412
|
+
pageToken?: string;
|
|
40413
|
+
/**
|
|
40414
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40415
|
+
*/
|
|
40416
|
+
parent?: string;
|
|
40417
|
+
/**
|
|
40418
|
+
* Optional. Filter to apply to the programs. Examples: "state_filter = \'COMPLETED\'" "state_filter = \'INITIALIZED\' OR "state_filter = \'EVALUATING\'" If empty, the behavior defaults to listing programs in REGISTRATION_COMPLETE state or processing state is NULL.
|
|
40419
|
+
*/
|
|
40420
|
+
stateFilter?: string;
|
|
40421
|
+
}
|
|
40422
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations {
|
|
40423
|
+
context: APIRequestContext;
|
|
40424
|
+
constructor(context: APIRequestContext);
|
|
40425
|
+
/**
|
|
40426
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
40427
|
+
* @example
|
|
40428
|
+
* ```js
|
|
40429
|
+
* // Before running the sample:
|
|
40430
|
+
* // - Enable the API at:
|
|
40431
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40432
|
+
* // - Login into gcloud by running:
|
|
40433
|
+
* // ```sh
|
|
40434
|
+
* // $ gcloud auth application-default login
|
|
40435
|
+
* // ```
|
|
40436
|
+
* // - Install the npm module by running:
|
|
40437
|
+
* // ```sh
|
|
40438
|
+
* // $ npm install googleapis
|
|
40439
|
+
* // ```
|
|
40440
|
+
*
|
|
40441
|
+
* const {google} = require('googleapis');
|
|
40442
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40443
|
+
*
|
|
40444
|
+
* async function main() {
|
|
40445
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40446
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40447
|
+
* scopes: [
|
|
40448
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40449
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40450
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40451
|
+
* ],
|
|
40452
|
+
* });
|
|
40453
|
+
*
|
|
40454
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40455
|
+
* const authClient = await auth.getClient();
|
|
40456
|
+
* google.options({auth: authClient});
|
|
40457
|
+
*
|
|
40458
|
+
* // Do the magic
|
|
40459
|
+
* const res =
|
|
40460
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.operations.get(
|
|
40461
|
+
* {
|
|
40462
|
+
* // The name of the operation resource.
|
|
40463
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment/operations/my-operation',
|
|
40464
|
+
* },
|
|
40465
|
+
* );
|
|
40466
|
+
* console.log(res.data);
|
|
40467
|
+
*
|
|
40468
|
+
* // Example response
|
|
40469
|
+
* // {
|
|
40470
|
+
* // "done": false,
|
|
40471
|
+
* // "error": {},
|
|
40472
|
+
* // "metadata": {},
|
|
40473
|
+
* // "name": "my_name",
|
|
40474
|
+
* // "response": {}
|
|
40475
|
+
* // }
|
|
40476
|
+
* }
|
|
40477
|
+
*
|
|
40478
|
+
* main().catch(e => {
|
|
40479
|
+
* console.error(e);
|
|
40480
|
+
* throw e;
|
|
40481
|
+
* });
|
|
40482
|
+
*
|
|
40483
|
+
* ```
|
|
40484
|
+
*
|
|
40485
|
+
* @param params - Parameters for request
|
|
40486
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40487
|
+
* @param callback - Optional callback that handles the response.
|
|
40488
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40489
|
+
*/
|
|
40490
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40491
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
40492
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40493
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
40494
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
40495
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
40496
|
+
}
|
|
40497
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations$Get extends StandardParameters {
|
|
40498
|
+
/**
|
|
40499
|
+
* The name of the operation resource.
|
|
40500
|
+
*/
|
|
40501
|
+
name?: string;
|
|
40502
|
+
}
|
|
40503
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers {
|
|
40504
|
+
context: APIRequestContext;
|
|
40505
|
+
constructor(context: APIRequestContext);
|
|
40506
|
+
/**
|
|
40507
|
+
* Gets a Answer.
|
|
40508
|
+
* @example
|
|
40509
|
+
* ```js
|
|
40510
|
+
* // Before running the sample:
|
|
40511
|
+
* // - Enable the API at:
|
|
40512
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40513
|
+
* // - Login into gcloud by running:
|
|
40514
|
+
* // ```sh
|
|
40515
|
+
* // $ gcloud auth application-default login
|
|
40516
|
+
* // ```
|
|
40517
|
+
* // - Install the npm module by running:
|
|
40518
|
+
* // ```sh
|
|
40519
|
+
* // $ npm install googleapis
|
|
40520
|
+
* // ```
|
|
40521
|
+
*
|
|
40522
|
+
* const {google} = require('googleapis');
|
|
40523
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40524
|
+
*
|
|
40525
|
+
* async function main() {
|
|
40526
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40527
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40528
|
+
* scopes: [
|
|
40529
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40530
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40531
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40532
|
+
* ],
|
|
40533
|
+
* });
|
|
40534
|
+
*
|
|
40535
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40536
|
+
* const authClient = await auth.getClient();
|
|
40537
|
+
* google.options({auth: authClient});
|
|
40538
|
+
*
|
|
40539
|
+
* // Do the magic
|
|
40540
|
+
* const res =
|
|
40541
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.answers.get(
|
|
40542
|
+
* {
|
|
40543
|
+
* // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
40544
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/answers/my-answer',
|
|
40545
|
+
* },
|
|
40546
|
+
* );
|
|
40547
|
+
* console.log(res.data);
|
|
40548
|
+
*
|
|
40549
|
+
* // Example response
|
|
40550
|
+
* // {
|
|
40551
|
+
* // "answerSkippedReasons": [],
|
|
40552
|
+
* // "answerText": "my_answerText",
|
|
40553
|
+
* // "blobAttachments": [],
|
|
40554
|
+
* // "citations": [],
|
|
40555
|
+
* // "completeTime": "my_completeTime",
|
|
40556
|
+
* // "createTime": "my_createTime",
|
|
40557
|
+
* // "groundingScore": {},
|
|
40558
|
+
* // "groundingSupports": [],
|
|
40559
|
+
* // "name": "my_name",
|
|
40560
|
+
* // "queryUnderstandingInfo": {},
|
|
40561
|
+
* // "references": [],
|
|
40562
|
+
* // "relatedQuestions": [],
|
|
40563
|
+
* // "safetyRatings": [],
|
|
40564
|
+
* // "state": "my_state",
|
|
40565
|
+
* // "steps": []
|
|
40566
|
+
* // }
|
|
40567
|
+
* }
|
|
40568
|
+
*
|
|
40569
|
+
* main().catch(e => {
|
|
40570
|
+
* console.error(e);
|
|
40571
|
+
* throw e;
|
|
40572
|
+
* });
|
|
40573
|
+
*
|
|
40574
|
+
* ```
|
|
40575
|
+
*
|
|
40576
|
+
* @param params - Parameters for request
|
|
40577
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40578
|
+
* @param callback - Optional callback that handles the response.
|
|
40579
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
40580
|
+
*/
|
|
40581
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40582
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>>;
|
|
40583
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40584
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
40585
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
40586
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
40587
|
+
}
|
|
40588
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
|
|
40589
|
+
/**
|
|
40590
|
+
* Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
40591
|
+
*/
|
|
40592
|
+
name?: string;
|
|
40593
|
+
}
|
|
40594
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Files {
|
|
40595
|
+
context: APIRequestContext;
|
|
40596
|
+
constructor(context: APIRequestContext);
|
|
40597
|
+
/**
|
|
40598
|
+
* Lists metadata for all files in the current session.
|
|
38168
40599
|
* @example
|
|
38169
40600
|
* ```js
|
|
38170
40601
|
* // Before running the sample:
|
|
@@ -38391,6 +40822,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38391
40822
|
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
38392
40823
|
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
38393
40824
|
* 'placeholder-value',
|
|
40825
|
+
* // Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).
|
|
40826
|
+
* languageCode: 'placeholder-value',
|
|
40827
|
+
* // Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).
|
|
40828
|
+
* modelInfoView: 'placeholder-value',
|
|
38394
40829
|
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
38395
40830
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
38396
40831
|
* },
|
|
@@ -38403,6 +40838,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38403
40838
|
* // "allowPublicAccess": false,
|
|
38404
40839
|
* // "allowlistedDomains": [],
|
|
38405
40840
|
* // "assistantSettings": {},
|
|
40841
|
+
* // "batchAuthStatuses": [],
|
|
38406
40842
|
* // "collectionComponents": [],
|
|
38407
40843
|
* // "configId": "my_configId",
|
|
38408
40844
|
* // "contentSearchSpec": {},
|
|
@@ -38508,6 +40944,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38508
40944
|
* // "allowPublicAccess": false,
|
|
38509
40945
|
* // "allowlistedDomains": [],
|
|
38510
40946
|
* // "assistantSettings": {},
|
|
40947
|
+
* // "batchAuthStatuses": [],
|
|
38511
40948
|
* // "collectionComponents": [],
|
|
38512
40949
|
* // "configId": "my_configId",
|
|
38513
40950
|
* // "contentSearchSpec": {},
|
|
@@ -38553,6 +40990,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38553
40990
|
* // "allowPublicAccess": false,
|
|
38554
40991
|
* // "allowlistedDomains": [],
|
|
38555
40992
|
* // "assistantSettings": {},
|
|
40993
|
+
* // "batchAuthStatuses": [],
|
|
38556
40994
|
* // "collectionComponents": [],
|
|
38557
40995
|
* // "configId": "my_configId",
|
|
38558
40996
|
* // "contentSearchSpec": {},
|
|
@@ -38617,6 +41055,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38617
41055
|
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
38618
41056
|
*/
|
|
38619
41057
|
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
41058
|
+
/**
|
|
41059
|
+
* Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).
|
|
41060
|
+
*/
|
|
41061
|
+
languageCode?: string;
|
|
41062
|
+
/**
|
|
41063
|
+
* Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).
|
|
41064
|
+
*/
|
|
41065
|
+
modelInfoView?: string;
|
|
38620
41066
|
/**
|
|
38621
41067
|
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
38622
41068
|
*/
|
|
@@ -39052,6 +41498,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39052
41498
|
* // "documentProcessingConfig": {},
|
|
39053
41499
|
* // "federatedSearchConfig": {},
|
|
39054
41500
|
* // "healthcareFhirConfig": {},
|
|
41501
|
+
* // "iconUri": "my_iconUri",
|
|
39055
41502
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
39056
41503
|
* // "idpConfig": {},
|
|
39057
41504
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -39200,29 +41647,122 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39200
41647
|
* google.options({auth: authClient});
|
|
39201
41648
|
*
|
|
39202
41649
|
* // Do the magic
|
|
39203
|
-
* const res =
|
|
39204
|
-
* await discoveryengine.projects.locations.dataStores.deletePatientFilter({
|
|
39205
|
-
* // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
|
|
39206
|
-
* dataStore:
|
|
39207
|
-
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
39208
|
-
*
|
|
39209
|
-
* // Request body metadata
|
|
39210
|
-
* requestBody: {
|
|
39211
|
-
* // request body parameters
|
|
39212
|
-
* // {
|
|
39213
|
-
* // "dataStore": "my_dataStore"
|
|
39214
|
-
* // }
|
|
39215
|
-
* },
|
|
39216
|
-
* });
|
|
41650
|
+
* const res =
|
|
41651
|
+
* await discoveryengine.projects.locations.dataStores.deletePatientFilter({
|
|
41652
|
+
* // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
|
|
41653
|
+
* dataStore:
|
|
41654
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
41655
|
+
*
|
|
41656
|
+
* // Request body metadata
|
|
41657
|
+
* requestBody: {
|
|
41658
|
+
* // request body parameters
|
|
41659
|
+
* // {
|
|
41660
|
+
* // "dataStore": "my_dataStore"
|
|
41661
|
+
* // }
|
|
41662
|
+
* },
|
|
41663
|
+
* });
|
|
41664
|
+
* console.log(res.data);
|
|
41665
|
+
*
|
|
41666
|
+
* // Example response
|
|
41667
|
+
* // {
|
|
41668
|
+
* // "done": false,
|
|
41669
|
+
* // "error": {},
|
|
41670
|
+
* // "metadata": {},
|
|
41671
|
+
* // "name": "my_name",
|
|
41672
|
+
* // "response": {}
|
|
41673
|
+
* // }
|
|
41674
|
+
* }
|
|
41675
|
+
*
|
|
41676
|
+
* main().catch(e => {
|
|
41677
|
+
* console.error(e);
|
|
41678
|
+
* throw e;
|
|
41679
|
+
* });
|
|
41680
|
+
*
|
|
41681
|
+
* ```
|
|
41682
|
+
*
|
|
41683
|
+
* @param params - Parameters for request
|
|
41684
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
41685
|
+
* @param callback - Optional callback that handles the response.
|
|
41686
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
41687
|
+
*/
|
|
41688
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41689
|
+
deletePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
41690
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41691
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41692
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41693
|
+
deletePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41694
|
+
/**
|
|
41695
|
+
* Gets a DataStore.
|
|
41696
|
+
* @example
|
|
41697
|
+
* ```js
|
|
41698
|
+
* // Before running the sample:
|
|
41699
|
+
* // - Enable the API at:
|
|
41700
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
41701
|
+
* // - Login into gcloud by running:
|
|
41702
|
+
* // ```sh
|
|
41703
|
+
* // $ gcloud auth application-default login
|
|
41704
|
+
* // ```
|
|
41705
|
+
* // - Install the npm module by running:
|
|
41706
|
+
* // ```sh
|
|
41707
|
+
* // $ npm install googleapis
|
|
41708
|
+
* // ```
|
|
41709
|
+
*
|
|
41710
|
+
* const {google} = require('googleapis');
|
|
41711
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
41712
|
+
*
|
|
41713
|
+
* async function main() {
|
|
41714
|
+
* const auth = new google.auth.GoogleAuth({
|
|
41715
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
41716
|
+
* scopes: [
|
|
41717
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
41718
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
41719
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
41720
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
41721
|
+
* ],
|
|
41722
|
+
* });
|
|
41723
|
+
*
|
|
41724
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
41725
|
+
* const authClient = await auth.getClient();
|
|
41726
|
+
* google.options({auth: authClient});
|
|
41727
|
+
*
|
|
41728
|
+
* // Do the magic
|
|
41729
|
+
* const res = await discoveryengine.projects.locations.dataStores.get({
|
|
41730
|
+
* // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
41731
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
41732
|
+
* // Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.
|
|
41733
|
+
* view: 'placeholder-value',
|
|
41734
|
+
* });
|
|
39217
41735
|
* console.log(res.data);
|
|
39218
41736
|
*
|
|
39219
41737
|
* // Example response
|
|
39220
41738
|
* // {
|
|
39221
|
-
* // "
|
|
39222
|
-
* // "
|
|
39223
|
-
* // "
|
|
41739
|
+
* // "aclEnabled": false,
|
|
41740
|
+
* // "advancedSiteSearchConfig": {},
|
|
41741
|
+
* // "billingEstimation": {},
|
|
41742
|
+
* // "cmekConfig": {},
|
|
41743
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
41744
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
41745
|
+
* // "contentConfig": "my_contentConfig",
|
|
41746
|
+
* // "createTime": "my_createTime",
|
|
41747
|
+
* // "dataProtectionPolicy": {},
|
|
41748
|
+
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
41749
|
+
* // "displayName": "my_displayName",
|
|
41750
|
+
* // "documentProcessingConfig": {},
|
|
41751
|
+
* // "federatedSearchConfig": {},
|
|
41752
|
+
* // "healthcareFhirConfig": {},
|
|
41753
|
+
* // "iconUri": "my_iconUri",
|
|
41754
|
+
* // "identityMappingStore": "my_identityMappingStore",
|
|
41755
|
+
* // "idpConfig": {},
|
|
41756
|
+
* // "industryVertical": "my_industryVertical",
|
|
41757
|
+
* // "isInfobotFaqDataStore": false,
|
|
41758
|
+
* // "kmsKeyName": "my_kmsKeyName",
|
|
41759
|
+
* // "languageInfo": {},
|
|
39224
41760
|
* // "name": "my_name",
|
|
39225
|
-
* // "
|
|
41761
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
41762
|
+
* // "servingConfigDataStore": {},
|
|
41763
|
+
* // "solutionTypes": [],
|
|
41764
|
+
* // "startingSchema": {},
|
|
41765
|
+
* // "workspaceConfig": {}
|
|
39226
41766
|
* // }
|
|
39227
41767
|
* }
|
|
39228
41768
|
*
|
|
@@ -39238,14 +41778,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39238
41778
|
* @param callback - Optional callback that handles the response.
|
|
39239
41779
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39240
41780
|
*/
|
|
39241
|
-
|
|
39242
|
-
|
|
39243
|
-
|
|
39244
|
-
|
|
39245
|
-
|
|
39246
|
-
|
|
41781
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41782
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>>;
|
|
41783
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41784
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
41785
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
41786
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
39247
41787
|
/**
|
|
39248
|
-
* Gets a
|
|
41788
|
+
* Gets a CompletionConfig
|
|
39249
41789
|
* @example
|
|
39250
41790
|
* ```js
|
|
39251
41791
|
* // Before running the sample:
|
|
@@ -39268,7 +41808,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39268
41808
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39269
41809
|
* scopes: [
|
|
39270
41810
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39271
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
39272
41811
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39273
41812
|
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39274
41813
|
* ],
|
|
@@ -39279,40 +41818,25 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39279
41818
|
* google.options({auth: authClient});
|
|
39280
41819
|
*
|
|
39281
41820
|
* // Do the magic
|
|
39282
|
-
* const res =
|
|
39283
|
-
*
|
|
39284
|
-
*
|
|
39285
|
-
*
|
|
41821
|
+
* const res =
|
|
41822
|
+
* await discoveryengine.projects.locations.dataStores.getCompletionConfig({
|
|
41823
|
+
* // Required. Full CompletionConfig resource name. Format: `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
41824
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/completionConfig',
|
|
41825
|
+
* });
|
|
39286
41826
|
* console.log(res.data);
|
|
39287
41827
|
*
|
|
39288
41828
|
* // Example response
|
|
39289
41829
|
* // {
|
|
39290
|
-
* // "
|
|
39291
|
-
* // "
|
|
39292
|
-
* // "
|
|
39293
|
-
* // "
|
|
39294
|
-
* // "
|
|
39295
|
-
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
39296
|
-
* // "contentConfig": "my_contentConfig",
|
|
39297
|
-
* // "createTime": "my_createTime",
|
|
39298
|
-
* // "dataProtectionPolicy": {},
|
|
39299
|
-
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
39300
|
-
* // "displayName": "my_displayName",
|
|
39301
|
-
* // "documentProcessingConfig": {},
|
|
39302
|
-
* // "federatedSearchConfig": {},
|
|
39303
|
-
* // "healthcareFhirConfig": {},
|
|
39304
|
-
* // "identityMappingStore": "my_identityMappingStore",
|
|
39305
|
-
* // "idpConfig": {},
|
|
39306
|
-
* // "industryVertical": "my_industryVertical",
|
|
39307
|
-
* // "isInfobotFaqDataStore": false,
|
|
39308
|
-
* // "kmsKeyName": "my_kmsKeyName",
|
|
39309
|
-
* // "languageInfo": {},
|
|
41830
|
+
* // "enableMode": "my_enableMode",
|
|
41831
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
41832
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
41833
|
+
* // "maxSuggestions": 0,
|
|
41834
|
+
* // "minPrefixLength": 0,
|
|
39310
41835
|
* // "name": "my_name",
|
|
39311
|
-
* // "
|
|
39312
|
-
* // "
|
|
39313
|
-
* // "
|
|
39314
|
-
* // "
|
|
39315
|
-
* // "workspaceConfig": {}
|
|
41836
|
+
* // "numUniqueUsersThreshold": 0,
|
|
41837
|
+
* // "queryFrequencyThreshold": 0,
|
|
41838
|
+
* // "queryModel": "my_queryModel",
|
|
41839
|
+
* // "shouldServeContentSuggestions": false
|
|
39316
41840
|
* // }
|
|
39317
41841
|
* }
|
|
39318
41842
|
*
|
|
@@ -39328,12 +41852,12 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39328
41852
|
* @param callback - Optional callback that handles the response.
|
|
39329
41853
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39330
41854
|
*/
|
|
39331
|
-
|
|
39332
|
-
|
|
39333
|
-
|
|
39334
|
-
|
|
39335
|
-
|
|
39336
|
-
|
|
41855
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41856
|
+
getCompletionConfig(params?: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
41857
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41858
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
41859
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
41860
|
+
getCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
39337
41861
|
/**
|
|
39338
41862
|
* Gets a DocumentProcessingConfig.
|
|
39339
41863
|
* @example
|
|
@@ -39512,6 +42036,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39512
42036
|
* pageToken: 'placeholder-value',
|
|
39513
42037
|
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
39514
42038
|
* parent: 'projects/my-project/locations/my-location',
|
|
42039
|
+
* // Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons.
|
|
42040
|
+
* view: 'placeholder-value',
|
|
39515
42041
|
* });
|
|
39516
42042
|
* console.log(res.data);
|
|
39517
42043
|
*
|
|
@@ -39598,6 +42124,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39598
42124
|
* // "documentProcessingConfig": {},
|
|
39599
42125
|
* // "federatedSearchConfig": {},
|
|
39600
42126
|
* // "healthcareFhirConfig": {},
|
|
42127
|
+
* // "iconUri": "my_iconUri",
|
|
39601
42128
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
39602
42129
|
* // "idpConfig": {},
|
|
39603
42130
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -39631,6 +42158,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39631
42158
|
* // "documentProcessingConfig": {},
|
|
39632
42159
|
* // "federatedSearchConfig": {},
|
|
39633
42160
|
* // "healthcareFhirConfig": {},
|
|
42161
|
+
* // "iconUri": "my_iconUri",
|
|
39634
42162
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
39635
42163
|
* // "idpConfig": {},
|
|
39636
42164
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -39823,7 +42351,100 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39823
42351
|
replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39824
42352
|
replacePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39825
42353
|
/**
|
|
39826
|
-
* Updates the
|
|
42354
|
+
* Updates the CompletionConfigs.
|
|
42355
|
+
* @example
|
|
42356
|
+
* ```js
|
|
42357
|
+
* // Before running the sample:
|
|
42358
|
+
* // - Enable the API at:
|
|
42359
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
42360
|
+
* // - Login into gcloud by running:
|
|
42361
|
+
* // ```sh
|
|
42362
|
+
* // $ gcloud auth application-default login
|
|
42363
|
+
* // ```
|
|
42364
|
+
* // - Install the npm module by running:
|
|
42365
|
+
* // ```sh
|
|
42366
|
+
* // $ npm install googleapis
|
|
42367
|
+
* // ```
|
|
42368
|
+
*
|
|
42369
|
+
* const {google} = require('googleapis');
|
|
42370
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
42371
|
+
*
|
|
42372
|
+
* async function main() {
|
|
42373
|
+
* const auth = new google.auth.GoogleAuth({
|
|
42374
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
42375
|
+
* scopes: [
|
|
42376
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
42377
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
42378
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
42379
|
+
* ],
|
|
42380
|
+
* });
|
|
42381
|
+
*
|
|
42382
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
42383
|
+
* const authClient = await auth.getClient();
|
|
42384
|
+
* google.options({auth: authClient});
|
|
42385
|
+
*
|
|
42386
|
+
* // Do the magic
|
|
42387
|
+
* const res =
|
|
42388
|
+
* await discoveryengine.projects.locations.dataStores.updateCompletionConfig({
|
|
42389
|
+
* // Required. Immutable. Fully qualified name `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
42390
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/completionConfig',
|
|
42391
|
+
* // 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.
|
|
42392
|
+
* updateMask: 'placeholder-value',
|
|
42393
|
+
*
|
|
42394
|
+
* // Request body metadata
|
|
42395
|
+
* requestBody: {
|
|
42396
|
+
* // request body parameters
|
|
42397
|
+
* // {
|
|
42398
|
+
* // "enableMode": "my_enableMode",
|
|
42399
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
42400
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
42401
|
+
* // "maxSuggestions": 0,
|
|
42402
|
+
* // "minPrefixLength": 0,
|
|
42403
|
+
* // "name": "my_name",
|
|
42404
|
+
* // "numUniqueUsersThreshold": 0,
|
|
42405
|
+
* // "queryFrequencyThreshold": 0,
|
|
42406
|
+
* // "queryModel": "my_queryModel",
|
|
42407
|
+
* // "shouldServeContentSuggestions": false
|
|
42408
|
+
* // }
|
|
42409
|
+
* },
|
|
42410
|
+
* });
|
|
42411
|
+
* console.log(res.data);
|
|
42412
|
+
*
|
|
42413
|
+
* // Example response
|
|
42414
|
+
* // {
|
|
42415
|
+
* // "enableMode": "my_enableMode",
|
|
42416
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
42417
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
42418
|
+
* // "maxSuggestions": 0,
|
|
42419
|
+
* // "minPrefixLength": 0,
|
|
42420
|
+
* // "name": "my_name",
|
|
42421
|
+
* // "numUniqueUsersThreshold": 0,
|
|
42422
|
+
* // "queryFrequencyThreshold": 0,
|
|
42423
|
+
* // "queryModel": "my_queryModel",
|
|
42424
|
+
* // "shouldServeContentSuggestions": false
|
|
42425
|
+
* // }
|
|
42426
|
+
* }
|
|
42427
|
+
*
|
|
42428
|
+
* main().catch(e => {
|
|
42429
|
+
* console.error(e);
|
|
42430
|
+
* throw e;
|
|
42431
|
+
* });
|
|
42432
|
+
*
|
|
42433
|
+
* ```
|
|
42434
|
+
*
|
|
42435
|
+
* @param params - Parameters for request
|
|
42436
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
42437
|
+
* @param callback - Optional callback that handles the response.
|
|
42438
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
42439
|
+
*/
|
|
42440
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
42441
|
+
updateCompletionConfig(params?: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
42442
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
42443
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
42444
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
42445
|
+
updateCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
42446
|
+
/**
|
|
42447
|
+
* Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleton resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full DocumentProcessingConfig as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set DocumentProcessingConfig.default_parsing_config (or DocumentProcessingConfig.parsing_config_overrides) and omit `update_mask`. Some fields, such as DocumentProcessingConfig.chunking_config, are immutable and return an error if changed.
|
|
39827
42448
|
* @example
|
|
39828
42449
|
* ```js
|
|
39829
42450
|
* // Before running the sample:
|
|
@@ -39861,7 +42482,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39861
42482
|
* {
|
|
39862
42483
|
* // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
39863
42484
|
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/documentProcessingConfig',
|
|
39864
|
-
* //
|
|
42485
|
+
* // Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details.
|
|
39865
42486
|
* updateMask: 'placeholder-value',
|
|
39866
42487
|
*
|
|
39867
42488
|
* // Request body metadata
|
|
@@ -39989,6 +42610,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39989
42610
|
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
39990
42611
|
*/
|
|
39991
42612
|
name?: string;
|
|
42613
|
+
/**
|
|
42614
|
+
* Optional. The view to apply to the returned DataStore. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon.
|
|
42615
|
+
*/
|
|
42616
|
+
view?: string;
|
|
42617
|
+
}
|
|
42618
|
+
export interface Params$Resource$Projects$Locations$Datastores$Getcompletionconfig extends StandardParameters {
|
|
42619
|
+
/**
|
|
42620
|
+
* Required. Full CompletionConfig resource name. Format: `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
42621
|
+
*/
|
|
42622
|
+
name?: string;
|
|
39992
42623
|
}
|
|
39993
42624
|
export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig extends StandardParameters {
|
|
39994
42625
|
/**
|
|
@@ -40019,6 +42650,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40019
42650
|
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
40020
42651
|
*/
|
|
40021
42652
|
parent?: string;
|
|
42653
|
+
/**
|
|
42654
|
+
* Optional. The view to apply to the returned DataStores. Defaults to DataStoreView.DATA_STORE_VIEW_BASIC if unspecified. DataStoreView.DATA_STORE_VIEW_FULL additionally populates DataStore.icon_uri for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons.
|
|
42655
|
+
*/
|
|
42656
|
+
view?: string;
|
|
40022
42657
|
}
|
|
40023
42658
|
export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters {
|
|
40024
42659
|
/**
|
|
@@ -40054,13 +42689,27 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40054
42689
|
*/
|
|
40055
42690
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
|
|
40056
42691
|
}
|
|
42692
|
+
export interface Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig extends StandardParameters {
|
|
42693
|
+
/**
|
|
42694
|
+
* Required. Immutable. Fully qualified name `projects/x/locations/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/dataStores/x/completionConfig` `projects/x/locations/x/collections/x/engines/x/completionConfig`
|
|
42695
|
+
*/
|
|
42696
|
+
name?: string;
|
|
42697
|
+
/**
|
|
42698
|
+
* 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.
|
|
42699
|
+
*/
|
|
42700
|
+
updateMask?: string;
|
|
42701
|
+
/**
|
|
42702
|
+
* Request body metadata
|
|
42703
|
+
*/
|
|
42704
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
42705
|
+
}
|
|
40057
42706
|
export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
40058
42707
|
/**
|
|
40059
42708
|
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
40060
42709
|
*/
|
|
40061
42710
|
name?: string;
|
|
40062
42711
|
/**
|
|
40063
|
-
*
|
|
42712
|
+
* Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full DocumentProcessingConfig in the request body then overwrites the existing resource. See the method description for details.
|
|
40064
42713
|
*/
|
|
40065
42714
|
updateMask?: string;
|
|
40066
42715
|
/**
|
|
@@ -46809,6 +49458,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46809
49458
|
* // "entity": "my_entity",
|
|
46810
49459
|
* // "eventTime": "my_eventTime",
|
|
46811
49460
|
* // "eventType": "my_eventType",
|
|
49461
|
+
* // "feedback": {},
|
|
46812
49462
|
* // "filter": "my_filter",
|
|
46813
49463
|
* // "mediaInfo": {},
|
|
46814
49464
|
* // "pageInfo": {},
|
|
@@ -46839,6 +49489,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46839
49489
|
* // "entity": "my_entity",
|
|
46840
49490
|
* // "eventTime": "my_eventTime",
|
|
46841
49491
|
* // "eventType": "my_eventType",
|
|
49492
|
+
* // "feedback": {},
|
|
46842
49493
|
* // "filter": "my_filter",
|
|
46843
49494
|
* // "mediaInfo": {},
|
|
46844
49495
|
* // "pageInfo": {},
|
|
@@ -46970,6 +49621,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46970
49621
|
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
46971
49622
|
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
46972
49623
|
* 'placeholder-value',
|
|
49624
|
+
* // Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).
|
|
49625
|
+
* languageCode: 'placeholder-value',
|
|
49626
|
+
* // Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).
|
|
49627
|
+
* modelInfoView: 'placeholder-value',
|
|
46973
49628
|
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
46974
49629
|
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
46975
49630
|
* });
|
|
@@ -46981,6 +49636,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46981
49636
|
* // "allowPublicAccess": false,
|
|
46982
49637
|
* // "allowlistedDomains": [],
|
|
46983
49638
|
* // "assistantSettings": {},
|
|
49639
|
+
* // "batchAuthStatuses": [],
|
|
46984
49640
|
* // "collectionComponents": [],
|
|
46985
49641
|
* // "configId": "my_configId",
|
|
46986
49642
|
* // "contentSearchSpec": {},
|
|
@@ -47085,6 +49741,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
47085
49741
|
* // "allowPublicAccess": false,
|
|
47086
49742
|
* // "allowlistedDomains": [],
|
|
47087
49743
|
* // "assistantSettings": {},
|
|
49744
|
+
* // "batchAuthStatuses": [],
|
|
47088
49745
|
* // "collectionComponents": [],
|
|
47089
49746
|
* // "configId": "my_configId",
|
|
47090
49747
|
* // "contentSearchSpec": {},
|
|
@@ -47129,6 +49786,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
47129
49786
|
* // "allowPublicAccess": false,
|
|
47130
49787
|
* // "allowlistedDomains": [],
|
|
47131
49788
|
* // "assistantSettings": {},
|
|
49789
|
+
* // "batchAuthStatuses": [],
|
|
47132
49790
|
* // "collectionComponents": [],
|
|
47133
49791
|
* // "configId": "my_configId",
|
|
47134
49792
|
* // "contentSearchSpec": {},
|
|
@@ -47193,6 +49851,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
47193
49851
|
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
47194
49852
|
*/
|
|
47195
49853
|
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
49854
|
+
/**
|
|
49855
|
+
* Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).
|
|
49856
|
+
*/
|
|
49857
|
+
languageCode?: string;
|
|
49858
|
+
/**
|
|
49859
|
+
* Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `MODEL_INFO_VIEW_ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; unset / `MODEL_INFO_VIEW_WEB` returns the end-user selector. The mobile surface is detected from the `X-Goog-Gemini-Enterprise-Mobile` header instead (see `ModelInfoView`).
|
|
49860
|
+
*/
|
|
49861
|
+
modelInfoView?: string;
|
|
47196
49862
|
/**
|
|
47197
49863
|
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
47198
49864
|
*/
|
|
@@ -48575,6 +51241,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48575
51241
|
* // "endDate": {},
|
|
48576
51242
|
* // "freeTrial": false,
|
|
48577
51243
|
* // "geminiBundle": false,
|
|
51244
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48578
51245
|
* // "licenseCount": "my_licenseCount",
|
|
48579
51246
|
* // "name": "my_name",
|
|
48580
51247
|
* // "startDate": {},
|
|
@@ -48595,6 +51262,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48595
51262
|
* // "endDate": {},
|
|
48596
51263
|
* // "freeTrial": false,
|
|
48597
51264
|
* // "geminiBundle": false,
|
|
51265
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48598
51266
|
* // "licenseCount": "my_licenseCount",
|
|
48599
51267
|
* // "name": "my_name",
|
|
48600
51268
|
* // "startDate": {},
|
|
@@ -48671,6 +51339,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48671
51339
|
* // "endDate": {},
|
|
48672
51340
|
* // "freeTrial": false,
|
|
48673
51341
|
* // "geminiBundle": false,
|
|
51342
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48674
51343
|
* // "licenseCount": "my_licenseCount",
|
|
48675
51344
|
* // "name": "my_name",
|
|
48676
51345
|
* // "startDate": {},
|
|
@@ -48820,6 +51489,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48820
51489
|
* // "endDate": {},
|
|
48821
51490
|
* // "freeTrial": false,
|
|
48822
51491
|
* // "geminiBundle": false,
|
|
51492
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48823
51493
|
* // "licenseCount": "my_licenseCount",
|
|
48824
51494
|
* // "name": "my_name",
|
|
48825
51495
|
* // "startDate": {},
|
|
@@ -48840,6 +51510,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48840
51510
|
* // "endDate": {},
|
|
48841
51511
|
* // "freeTrial": false,
|
|
48842
51512
|
* // "geminiBundle": false,
|
|
51513
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48843
51514
|
* // "licenseCount": "my_licenseCount",
|
|
48844
51515
|
* // "name": "my_name",
|
|
48845
51516
|
* // "startDate": {},
|
|
@@ -51409,6 +54080,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
51409
54080
|
* // "entity": "my_entity",
|
|
51410
54081
|
* // "eventTime": "my_eventTime",
|
|
51411
54082
|
* // "eventType": "my_eventType",
|
|
54083
|
+
* // "feedback": {},
|
|
51412
54084
|
* // "filter": "my_filter",
|
|
51413
54085
|
* // "mediaInfo": {},
|
|
51414
54086
|
* // "pageInfo": {},
|
|
@@ -51439,6 +54111,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
51439
54111
|
* // "entity": "my_entity",
|
|
51440
54112
|
* // "eventTime": "my_eventTime",
|
|
51441
54113
|
* // "eventType": "my_eventType",
|
|
54114
|
+
* // "feedback": {},
|
|
51442
54115
|
* // "filter": "my_filter",
|
|
51443
54116
|
* // "mediaInfo": {},
|
|
51444
54117
|
* // "pageInfo": {},
|
|
@@ -52040,6 +54713,78 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52040
54713
|
export class Resource$Projects$Locations$Userstores$Userlicenses {
|
|
52041
54714
|
context: APIRequestContext;
|
|
52042
54715
|
constructor(context: APIRequestContext);
|
|
54716
|
+
/**
|
|
54717
|
+
* Exports all the UserLicenses under the parent UserStore as a single CSV document. This is the backend for the admin console "Download as CSV" action: it reuses the ListUserLicenses read path so admins can sort/filter offline in Excel or Sheets. The response carries the full CSV (header row followed by data rows) inline in ExportUserLicensesResponse.csv_data.
|
|
54718
|
+
* @example
|
|
54719
|
+
* ```js
|
|
54720
|
+
* // Before running the sample:
|
|
54721
|
+
* // - Enable the API at:
|
|
54722
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
54723
|
+
* // - Login into gcloud by running:
|
|
54724
|
+
* // ```sh
|
|
54725
|
+
* // $ gcloud auth application-default login
|
|
54726
|
+
* // ```
|
|
54727
|
+
* // - Install the npm module by running:
|
|
54728
|
+
* // ```sh
|
|
54729
|
+
* // $ npm install googleapis
|
|
54730
|
+
* // ```
|
|
54731
|
+
*
|
|
54732
|
+
* const {google} = require('googleapis');
|
|
54733
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
54734
|
+
*
|
|
54735
|
+
* async function main() {
|
|
54736
|
+
* const auth = new google.auth.GoogleAuth({
|
|
54737
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
54738
|
+
* scopes: [
|
|
54739
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
54740
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
54741
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
54742
|
+
* ],
|
|
54743
|
+
* });
|
|
54744
|
+
*
|
|
54745
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
54746
|
+
* const authClient = await auth.getClient();
|
|
54747
|
+
* google.options({auth: authClient});
|
|
54748
|
+
*
|
|
54749
|
+
* // Do the magic
|
|
54750
|
+
* const res =
|
|
54751
|
+
* await discoveryengine.projects.locations.userStores.userLicenses.export({
|
|
54752
|
+
* // Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. All UserLicenses under this UserStore are exported.
|
|
54753
|
+
* parent:
|
|
54754
|
+
* 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
54755
|
+
*
|
|
54756
|
+
* // Request body metadata
|
|
54757
|
+
* requestBody: {
|
|
54758
|
+
* // request body parameters
|
|
54759
|
+
* // {}
|
|
54760
|
+
* },
|
|
54761
|
+
* });
|
|
54762
|
+
* console.log(res.data);
|
|
54763
|
+
*
|
|
54764
|
+
* // Example response
|
|
54765
|
+
* // {
|
|
54766
|
+
* // "csvData": "my_csvData"
|
|
54767
|
+
* // }
|
|
54768
|
+
* }
|
|
54769
|
+
*
|
|
54770
|
+
* main().catch(e => {
|
|
54771
|
+
* console.error(e);
|
|
54772
|
+
* throw e;
|
|
54773
|
+
* });
|
|
54774
|
+
*
|
|
54775
|
+
* ```
|
|
54776
|
+
*
|
|
54777
|
+
* @param params - Parameters for request
|
|
54778
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
54779
|
+
* @param callback - Optional callback that handles the response.
|
|
54780
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
54781
|
+
*/
|
|
54782
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
54783
|
+
export(params?: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>>;
|
|
54784
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
54785
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>): void;
|
|
54786
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>): void;
|
|
54787
|
+
export(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>): void;
|
|
52043
54788
|
/**
|
|
52044
54789
|
* Lists the User Licenses.
|
|
52045
54790
|
* @example
|
|
@@ -52080,7 +54825,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52080
54825
|
* filter: 'placeholder-value',
|
|
52081
54826
|
* // 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.
|
|
52082
54827
|
* orderBy: 'placeholder-value',
|
|
52083
|
-
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
54828
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
52084
54829
|
* pageSize: 'placeholder-value',
|
|
52085
54830
|
* // 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.
|
|
52086
54831
|
* pageToken: 'placeholder-value',
|
|
@@ -52116,6 +54861,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52116
54861
|
list(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse>): void;
|
|
52117
54862
|
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse>): void;
|
|
52118
54863
|
}
|
|
54864
|
+
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$Export extends StandardParameters {
|
|
54865
|
+
/**
|
|
54866
|
+
* Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. All UserLicenses under this UserStore are exported.
|
|
54867
|
+
*/
|
|
54868
|
+
parent?: string;
|
|
54869
|
+
/**
|
|
54870
|
+
* Request body metadata
|
|
54871
|
+
*/
|
|
54872
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest;
|
|
54873
|
+
}
|
|
52119
54874
|
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
|
|
52120
54875
|
/**
|
|
52121
54876
|
* 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`.
|
|
@@ -52126,7 +54881,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52126
54881
|
*/
|
|
52127
54882
|
orderBy?: string;
|
|
52128
54883
|
/**
|
|
52129
|
-
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
54884
|
+
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
52130
54885
|
*/
|
|
52131
54886
|
pageSize?: number;
|
|
52132
54887
|
/**
|