@googleapis/discoveryengine 30.0.0 → 31.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 +11 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +859 -23
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +2935 -276
- package/build/v1alpha.js +713 -109
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +680 -16
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +935 -183
- package/v1alpha.ts +4789 -670
- package/v1beta.ts +757 -178
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.
|
|
@@ -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,35 @@ 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, authenticated_account, note).
|
|
4694
|
+
*/
|
|
4695
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
|
|
4696
|
+
/**
|
|
4697
|
+
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
4698
|
+
*/
|
|
4699
|
+
authenticatedAccount?: string | null;
|
|
4700
|
+
/**
|
|
4701
|
+
* 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).
|
|
4702
|
+
*/
|
|
4703
|
+
author?: string | null;
|
|
4704
|
+
/**
|
|
4705
|
+
* Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
|
|
4706
|
+
*/
|
|
4707
|
+
description?: string | null;
|
|
4708
|
+
/**
|
|
4709
|
+
* Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
|
|
4710
|
+
*/
|
|
4711
|
+
note?: string | null;
|
|
4712
|
+
/**
|
|
4713
|
+
* Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
|
|
4714
|
+
*/
|
|
4715
|
+
shortDescription?: string | null;
|
|
4716
|
+
/**
|
|
4717
|
+
* Optional. Display title of the connector.
|
|
4718
|
+
*/
|
|
4719
|
+
title?: string | null;
|
|
4720
|
+
}
|
|
4292
4721
|
/**
|
|
4293
4722
|
* Any params and credentials used specifically for EUA connectors.
|
|
4294
4723
|
*/
|
|
@@ -4480,6 +4909,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4480
4909
|
* Optional. Configuration for `HEALTHCARE_FHIR` vertical.
|
|
4481
4910
|
*/
|
|
4482
4911
|
healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
|
|
4912
|
+
/**
|
|
4913
|
+
* 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.
|
|
4914
|
+
*/
|
|
4915
|
+
iconUri?: string | null;
|
|
4483
4916
|
/**
|
|
4484
4917
|
* 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
4918
|
*/
|
|
@@ -4829,6 +5262,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4829
5262
|
* The number of end users under the user store that were successfully deleted.
|
|
4830
5263
|
*/
|
|
4831
5264
|
successCount?: string | null;
|
|
5265
|
+
/**
|
|
5266
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
5267
|
+
*/
|
|
5268
|
+
updateTime?: string | null;
|
|
4832
5269
|
}
|
|
4833
5270
|
/**
|
|
4834
5271
|
* Defines target endpoints used to connect to third-party sources.
|
|
@@ -5261,6 +5698,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5261
5698
|
* 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
5699
|
*/
|
|
5263
5700
|
appType?: string | null;
|
|
5701
|
+
/**
|
|
5702
|
+
* 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.
|
|
5703
|
+
*/
|
|
5704
|
+
associatedAgentRegistry?: string | null;
|
|
5264
5705
|
/**
|
|
5265
5706
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
5266
5707
|
*/
|
|
@@ -5304,7 +5745,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5304
5745
|
*/
|
|
5305
5746
|
displayName?: string | null;
|
|
5306
5747
|
/**
|
|
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` * `
|
|
5748
|
+
* 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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
|
|
5308
5749
|
*/
|
|
5309
5750
|
features?: {
|
|
5310
5751
|
[key: string]: string;
|
|
@@ -5565,7 +6006,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5565
6006
|
*/
|
|
5566
6007
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
5567
6008
|
/**
|
|
5568
|
-
* Optional. The required subscription tier of this engine.
|
|
6009
|
+
* 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
6010
|
*/
|
|
5570
6011
|
requiredSubscriptionTier?: string | null;
|
|
5571
6012
|
/**
|
|
@@ -5742,6 +6183,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5742
6183
|
*/
|
|
5743
6184
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsResponse {
|
|
5744
6185
|
}
|
|
6186
|
+
/**
|
|
6187
|
+
* Request message for UserLicenseService.ExportUserLicenses.
|
|
6188
|
+
*/
|
|
6189
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest {
|
|
6190
|
+
}
|
|
6191
|
+
/**
|
|
6192
|
+
* Response message for UserLicenseService.ExportUserLicenses.
|
|
6193
|
+
*/
|
|
6194
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse {
|
|
6195
|
+
/**
|
|
6196
|
+
* 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.
|
|
6197
|
+
*/
|
|
6198
|
+
csvData?: string | null;
|
|
6199
|
+
}
|
|
5745
6200
|
/**
|
|
5746
6201
|
* External identity representing either a user or group. This user or group is from an external identity provider (IdP).
|
|
5747
6202
|
*/
|
|
@@ -5824,6 +6279,68 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5824
6279
|
*/
|
|
5825
6280
|
uri?: string | null;
|
|
5826
6281
|
}
|
|
6282
|
+
/**
|
|
6283
|
+
* Information about the user feedback. This information will be used for logging and metrics purpose.
|
|
6284
|
+
*/
|
|
6285
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaFeedback {
|
|
6286
|
+
/**
|
|
6287
|
+
* Optional. The additional user comment of the feedback if user gives a thumb down.
|
|
6288
|
+
*/
|
|
6289
|
+
comment?: string | null;
|
|
6290
|
+
/**
|
|
6291
|
+
* Optional. The version of the component that this report is being sent from.
|
|
6292
|
+
*/
|
|
6293
|
+
componentVersion?: string | null;
|
|
6294
|
+
/**
|
|
6295
|
+
* The related conversation information when user gives feedback.
|
|
6296
|
+
*/
|
|
6297
|
+
conversationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo;
|
|
6298
|
+
/**
|
|
6299
|
+
* Optional. Whether the customer accepted data use terms.
|
|
6300
|
+
*/
|
|
6301
|
+
dataTermsAccepted?: boolean | null;
|
|
6302
|
+
/**
|
|
6303
|
+
* Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.
|
|
6304
|
+
*/
|
|
6305
|
+
feedbackSource?: string | null;
|
|
6306
|
+
/**
|
|
6307
|
+
* Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.
|
|
6308
|
+
*/
|
|
6309
|
+
feedbackType?: string | null;
|
|
6310
|
+
/**
|
|
6311
|
+
* The version of the LLM model that was used to generate the response.
|
|
6312
|
+
*/
|
|
6313
|
+
llmModelVersion?: string | null;
|
|
6314
|
+
/**
|
|
6315
|
+
* Optional. The reason if user gives a thumb down.
|
|
6316
|
+
*/
|
|
6317
|
+
reasons?: string[] | null;
|
|
6318
|
+
}
|
|
6319
|
+
/**
|
|
6320
|
+
* The conversation information such as the question index and session name.
|
|
6321
|
+
*/
|
|
6322
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo {
|
|
6323
|
+
/**
|
|
6324
|
+
* Optional. The token which could be used to fetch the answer log.
|
|
6325
|
+
*/
|
|
6326
|
+
answerQueryToken?: string | null;
|
|
6327
|
+
/**
|
|
6328
|
+
* Optional. The token which could be used to fetch the assistant log.
|
|
6329
|
+
*/
|
|
6330
|
+
assistToken?: string | null;
|
|
6331
|
+
/**
|
|
6332
|
+
* Required. The user's search query.
|
|
6333
|
+
*/
|
|
6334
|
+
query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery;
|
|
6335
|
+
/**
|
|
6336
|
+
* The index of the user input within the conversation messages.
|
|
6337
|
+
*/
|
|
6338
|
+
questionIndex?: number | null;
|
|
6339
|
+
/**
|
|
6340
|
+
* Name of the newly generated or continued session.
|
|
6341
|
+
*/
|
|
6342
|
+
session?: string | null;
|
|
6343
|
+
}
|
|
5827
6344
|
/**
|
|
5828
6345
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
5829
6346
|
*/
|
|
@@ -6795,6 +7312,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6795
7312
|
* Output only. Whether the license config is for Gemini bundle.
|
|
6796
7313
|
*/
|
|
6797
7314
|
geminiBundle?: boolean | null;
|
|
7315
|
+
/**
|
|
7316
|
+
* 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.).
|
|
7317
|
+
*/
|
|
7318
|
+
lastUserUpdateTime?: string | null;
|
|
6798
7319
|
/**
|
|
6799
7320
|
* Required. Number of licenses purchased.
|
|
6800
7321
|
*/
|
|
@@ -6846,6 +7367,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6846
7367
|
*/
|
|
6847
7368
|
nextPageToken?: string | null;
|
|
6848
7369
|
}
|
|
7370
|
+
/**
|
|
7371
|
+
* Response message for AlphaEvolveService.ListAlphaEvolveExperiments.
|
|
7372
|
+
*/
|
|
7373
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse {
|
|
7374
|
+
/**
|
|
7375
|
+
* Output only. List of experiments.
|
|
7376
|
+
*/
|
|
7377
|
+
alphaEvolveExperiments?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment[];
|
|
7378
|
+
/**
|
|
7379
|
+
* 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.
|
|
7380
|
+
*/
|
|
7381
|
+
nextPageToken?: string | null;
|
|
7382
|
+
}
|
|
7383
|
+
/**
|
|
7384
|
+
* Response message for AlphaEvolveService.ListAlphaEvolvePrograms.
|
|
7385
|
+
*/
|
|
7386
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse {
|
|
7387
|
+
/**
|
|
7388
|
+
* Output only. List of programs matching the criteria provided in the request.
|
|
7389
|
+
*/
|
|
7390
|
+
alphaEvolvePrograms?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram[];
|
|
7391
|
+
/**
|
|
7392
|
+
* 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.
|
|
7393
|
+
*/
|
|
7394
|
+
nextPageToken?: string | null;
|
|
7395
|
+
}
|
|
6849
7396
|
/**
|
|
6850
7397
|
* Response message for the AssistantService.ListAssistants method.
|
|
6851
7398
|
*/
|
|
@@ -7478,6 +8025,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7478
8025
|
* 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
8026
|
*/
|
|
7480
8027
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
|
|
8028
|
+
/**
|
|
8029
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
8030
|
+
*/
|
|
8031
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
7481
8032
|
/**
|
|
7482
8033
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
7483
8034
|
*/
|
|
@@ -7507,6 +8058,35 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7507
8058
|
*/
|
|
7508
8059
|
updateType?: string | null;
|
|
7509
8060
|
}
|
|
8061
|
+
/**
|
|
8062
|
+
* 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.
|
|
8063
|
+
*/
|
|
8064
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
8065
|
+
/**
|
|
8066
|
+
* 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.
|
|
8067
|
+
*/
|
|
8068
|
+
effectiveTpmThreshold?: string | null;
|
|
8069
|
+
/**
|
|
8070
|
+
* 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).
|
|
8071
|
+
*/
|
|
8072
|
+
modelVersion?: string | null;
|
|
8073
|
+
/**
|
|
8074
|
+
* 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.
|
|
8075
|
+
*/
|
|
8076
|
+
startTime?: string | null;
|
|
8077
|
+
/**
|
|
8078
|
+
* 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.
|
|
8079
|
+
*/
|
|
8080
|
+
terminateTime?: string | null;
|
|
8081
|
+
/**
|
|
8082
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
8083
|
+
*/
|
|
8084
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
8085
|
+
/**
|
|
8086
|
+
* 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).
|
|
8087
|
+
*/
|
|
8088
|
+
updateType?: string | null;
|
|
8089
|
+
}
|
|
7510
8090
|
/**
|
|
7511
8091
|
* Customer provided configurations.
|
|
7512
8092
|
*/
|
|
@@ -7647,7 +8227,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7647
8227
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest {
|
|
7648
8228
|
}
|
|
7649
8229
|
/**
|
|
7650
|
-
* Response message for CompletionService.PurgeCompletionSuggestions method.
|
|
8230
|
+
* 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
8231
|
*/
|
|
7652
8232
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse {
|
|
7653
8233
|
/**
|
|
@@ -8578,6 +9158,24 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8578
9158
|
*/
|
|
8579
9159
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {
|
|
8580
9160
|
}
|
|
9161
|
+
/**
|
|
9162
|
+
* Metadata for AlphaEvolveService.ResumeExperiment long running operation.
|
|
9163
|
+
*/
|
|
9164
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata {
|
|
9165
|
+
/**
|
|
9166
|
+
* Output only. The time the operation was created.
|
|
9167
|
+
*/
|
|
9168
|
+
createTime?: string | null;
|
|
9169
|
+
/**
|
|
9170
|
+
* Output only. The time the operation was last updated.
|
|
9171
|
+
*/
|
|
9172
|
+
updateTime?: string | null;
|
|
9173
|
+
}
|
|
9174
|
+
/**
|
|
9175
|
+
* Request message for AlphaEvolveService.ResumeExperiment.
|
|
9176
|
+
*/
|
|
9177
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest {
|
|
9178
|
+
}
|
|
8581
9179
|
/**
|
|
8582
9180
|
* Request message for LicenseConfigService.RetractLicenseConfig method.
|
|
8583
9181
|
*/
|
|
@@ -9777,6 +10375,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
9777
10375
|
* Optional. A set of ranking signals associated with the result.
|
|
9778
10376
|
*/
|
|
9779
10377
|
rankSignals?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignals;
|
|
10378
|
+
/**
|
|
10379
|
+
* Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds.
|
|
10380
|
+
*/
|
|
10381
|
+
retrievalSignals?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals;
|
|
9780
10382
|
}
|
|
9781
10383
|
/**
|
|
9782
10384
|
* A set of ranking signals.
|
|
@@ -9836,6 +10438,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
9836
10438
|
*/
|
|
9837
10439
|
value?: number | null;
|
|
9838
10440
|
}
|
|
10441
|
+
/**
|
|
10442
|
+
* Contains a set of signals used by the relevance filter.
|
|
10443
|
+
*/
|
|
10444
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRetrievalSignals {
|
|
10445
|
+
/**
|
|
10446
|
+
* Optional. Indicates how the result was retrieved.
|
|
10447
|
+
*/
|
|
10448
|
+
retrievalSources?: string[] | null;
|
|
10449
|
+
/**
|
|
10450
|
+
* Optional. Relevance score used by the filter when semantic_relevance_threshold is set.
|
|
10451
|
+
*/
|
|
10452
|
+
semanticRelevanceScore?: number | null;
|
|
10453
|
+
}
|
|
9839
10454
|
/**
|
|
9840
10455
|
* Information about the session.
|
|
9841
10456
|
*/
|
|
@@ -10422,6 +11037,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10422
11037
|
*/
|
|
10423
11038
|
syncSinceTimestamp?: string | null;
|
|
10424
11039
|
}
|
|
11040
|
+
/**
|
|
11041
|
+
* Metadata for AlphaEvolveService.StartExperiment long running operation.
|
|
11042
|
+
*/
|
|
11043
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata {
|
|
11044
|
+
/**
|
|
11045
|
+
* Output only. The time the operation was created.
|
|
11046
|
+
*/
|
|
11047
|
+
createTime?: string | null;
|
|
11048
|
+
/**
|
|
11049
|
+
* Output only. The time the operation was last updated.
|
|
11050
|
+
*/
|
|
11051
|
+
updateTime?: string | null;
|
|
11052
|
+
}
|
|
11053
|
+
/**
|
|
11054
|
+
* Request message for AlphaEvolveService.StartExperiment.
|
|
11055
|
+
*/
|
|
11056
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentRequest {
|
|
11057
|
+
/**
|
|
11058
|
+
* Required. Experiment to start. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
11059
|
+
*/
|
|
11060
|
+
name?: string | null;
|
|
11061
|
+
}
|
|
10425
11062
|
/**
|
|
10426
11063
|
* Request for the AssistantService.StreamAssist method.
|
|
10427
11064
|
*/
|
|
@@ -10530,6 +11167,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10530
11167
|
* A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
|
|
10531
11168
|
*/
|
|
10532
11169
|
assistToken?: string | null;
|
|
11170
|
+
/**
|
|
11171
|
+
* Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors.
|
|
11172
|
+
*/
|
|
11173
|
+
connectorAuthErrors?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseConnectorAuthError[];
|
|
10533
11174
|
/**
|
|
10534
11175
|
* The tool names of the tools that were invoked.
|
|
10535
11176
|
*/
|
|
@@ -10543,6 +11184,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10543
11184
|
*/
|
|
10544
11185
|
sessionInfo?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo;
|
|
10545
11186
|
}
|
|
11187
|
+
/**
|
|
11188
|
+
* Describes an authentication error for a specific data connector.
|
|
11189
|
+
*/
|
|
11190
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseConnectorAuthError {
|
|
11191
|
+
/**
|
|
11192
|
+
* Resource name of the data connector that failed authentication.
|
|
11193
|
+
*/
|
|
11194
|
+
dataConnector?: string | null;
|
|
11195
|
+
/**
|
|
11196
|
+
* Human-readable error message describing the auth failure.
|
|
11197
|
+
*/
|
|
11198
|
+
errorMessage?: string | null;
|
|
11199
|
+
}
|
|
10546
11200
|
/**
|
|
10547
11201
|
* Represents a skill used during the assist call.
|
|
10548
11202
|
*/
|
|
@@ -10565,6 +11219,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10565
11219
|
*/
|
|
10566
11220
|
session?: string | null;
|
|
10567
11221
|
}
|
|
11222
|
+
/**
|
|
11223
|
+
* Request message for AlphaEvolveService.SubmitProgramsEvaluations.
|
|
11224
|
+
*/
|
|
11225
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest {
|
|
11226
|
+
/**
|
|
11227
|
+
* Required. List of program evaluations to submit. At this time, only one evaluation submission is supported.
|
|
11228
|
+
*/
|
|
11229
|
+
evaluationSubmissions?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluationSubmission[];
|
|
11230
|
+
}
|
|
11231
|
+
/**
|
|
11232
|
+
* Response message for AlphaEvolveService.SubmitProgramsEvaluations.
|
|
11233
|
+
*/
|
|
11234
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse {
|
|
11235
|
+
}
|
|
10568
11236
|
/**
|
|
10569
11237
|
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
10570
11238
|
*/
|
|
@@ -10916,6 +11584,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10916
11584
|
* 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
11585
|
*/
|
|
10918
11586
|
eventType?: string | null;
|
|
11587
|
+
/**
|
|
11588
|
+
* Optional. This field is optional except for the `add-feedback` event types.
|
|
11589
|
+
*/
|
|
11590
|
+
feedback?: Schema$GoogleCloudDiscoveryengineV1alphaFeedback;
|
|
10919
11591
|
/**
|
|
10920
11592
|
* 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
11593
|
*/
|
|
@@ -10987,11 +11659,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10987
11659
|
userId?: string | null;
|
|
10988
11660
|
}
|
|
10989
11661
|
/**
|
|
10990
|
-
* Precise location info with multiple representation options.
|
|
11662
|
+
* Precise location info with multiple representation options.
|
|
10991
11663
|
*/
|
|
10992
11664
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation {
|
|
10993
11665
|
/**
|
|
10994
|
-
*
|
|
11666
|
+
* Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.
|
|
10995
11667
|
*/
|
|
10996
11668
|
address?: string | null;
|
|
10997
11669
|
/**
|
|
@@ -11115,7 +11787,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11115
11787
|
*/
|
|
11116
11788
|
assistantSettings?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigAssistantSettings;
|
|
11117
11789
|
/**
|
|
11118
|
-
* Output only.
|
|
11790
|
+
* Output only. The batch authorization statuses for the widget's connectors.
|
|
11791
|
+
*/
|
|
11792
|
+
batchAuthStatuses?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus[];
|
|
11793
|
+
/**
|
|
11794
|
+
* 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
11795
|
*/
|
|
11120
11796
|
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
|
|
11121
11797
|
/**
|
|
@@ -11296,9 +11972,30 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11296
11972
|
webGroundingType?: string | null;
|
|
11297
11973
|
}
|
|
11298
11974
|
/**
|
|
11299
|
-
*
|
|
11975
|
+
* Describes the batch authorization status for a batch_authorization_group.
|
|
11976
|
+
*/
|
|
11977
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigBatchAuthStatus {
|
|
11978
|
+
/**
|
|
11979
|
+
* Output only. The batch authorization group the placeholder belongs to.
|
|
11980
|
+
*/
|
|
11981
|
+
batchAuthorizationGroup?: string | null;
|
|
11982
|
+
/**
|
|
11983
|
+
* Output only. The current authorization state for this connector.
|
|
11984
|
+
*/
|
|
11985
|
+
connectorAuthState?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigConnectorAuthState;
|
|
11986
|
+
/**
|
|
11987
|
+
* 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.
|
|
11988
|
+
*/
|
|
11989
|
+
placeholder?: string | null;
|
|
11990
|
+
}
|
|
11991
|
+
/**
|
|
11992
|
+
* 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
11993
|
*/
|
|
11301
11994
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
|
|
11995
|
+
/**
|
|
11996
|
+
* Output only. The auth uri of the connector source.
|
|
11997
|
+
*/
|
|
11998
|
+
connectorAuthState?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigConnectorAuthState;
|
|
11302
11999
|
/**
|
|
11303
12000
|
* Output only. The icon link of the connector source.
|
|
11304
12001
|
*/
|
|
@@ -11320,14 +12017,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11320
12017
|
*/
|
|
11321
12018
|
displayName?: string | null;
|
|
11322
12019
|
/**
|
|
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.
|
|
12020
|
+
* 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
12021
|
*/
|
|
11325
12022
|
id?: string | null;
|
|
11326
12023
|
/**
|
|
11327
|
-
* 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.
|
|
12024
|
+
* 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
12025
|
*/
|
|
11329
12026
|
name?: string | null;
|
|
11330
12027
|
}
|
|
12028
|
+
/**
|
|
12029
|
+
* Read-only connector in CollectionComponent auth state.
|
|
12030
|
+
*/
|
|
12031
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigConnectorAuthState {
|
|
12032
|
+
/**
|
|
12033
|
+
* 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.
|
|
12034
|
+
*/
|
|
12035
|
+
authorizationUri?: string | null;
|
|
12036
|
+
/**
|
|
12037
|
+
* Output only. The authorization state of the data connector.
|
|
12038
|
+
*/
|
|
12039
|
+
authState?: string | null;
|
|
12040
|
+
/**
|
|
12041
|
+
* Output only. The authorization state update timestamp.
|
|
12042
|
+
*/
|
|
12043
|
+
updateTime?: string | null;
|
|
12044
|
+
}
|
|
11331
12045
|
/**
|
|
11332
12046
|
* Customer provided configurations.
|
|
11333
12047
|
*/
|
|
@@ -11545,7 +12259,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11545
12259
|
*/
|
|
11546
12260
|
enableVisualContentSummary?: boolean | null;
|
|
11547
12261
|
/**
|
|
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` * `
|
|
12262
|
+
* 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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
|
|
11549
12263
|
*/
|
|
11550
12264
|
features?: {
|
|
11551
12265
|
[key: string]: string;
|
|
@@ -11554,16 +12268,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11554
12268
|
* Describes generative answer configuration.
|
|
11555
12269
|
*/
|
|
11556
12270
|
generativeAnswerConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig;
|
|
12271
|
+
/**
|
|
12272
|
+
* 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.
|
|
12273
|
+
*/
|
|
12274
|
+
googleDrivePickerEnabled?: boolean | null;
|
|
11557
12275
|
/**
|
|
11558
12276
|
* Describes widget (or web app) interaction type
|
|
11559
12277
|
*/
|
|
11560
12278
|
interactionType?: string | null;
|
|
12279
|
+
/**
|
|
12280
|
+
* 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.
|
|
12281
|
+
*/
|
|
12282
|
+
modelConfigInfo?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo;
|
|
11561
12283
|
/**
|
|
11562
12284
|
* 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
12285
|
*/
|
|
11564
12286
|
modelConfigs?: {
|
|
11565
12287
|
[key: string]: string;
|
|
11566
12288
|
} | null;
|
|
12289
|
+
/**
|
|
12290
|
+
* 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).
|
|
12291
|
+
*/
|
|
12292
|
+
onedrivePickerEnabled?: boolean | null;
|
|
11567
12293
|
/**
|
|
11568
12294
|
* Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
|
|
11569
12295
|
*/
|
|
@@ -11572,6 +12298,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11572
12298
|
* Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
|
|
11573
12299
|
*/
|
|
11574
12300
|
searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec;
|
|
12301
|
+
/**
|
|
12302
|
+
* 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.
|
|
12303
|
+
*/
|
|
12304
|
+
sourceAdminDisplayNameEnabled?: boolean | null;
|
|
11575
12305
|
}
|
|
11576
12306
|
/**
|
|
11577
12307
|
* Describes configuration for generative answer.
|
|
@@ -11618,6 +12348,65 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11618
12348
|
*/
|
|
11619
12349
|
resultCount?: number | null;
|
|
11620
12350
|
}
|
|
12351
|
+
/**
|
|
12352
|
+
* 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.
|
|
12353
|
+
*/
|
|
12354
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfo {
|
|
12355
|
+
/**
|
|
12356
|
+
* 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`.
|
|
12357
|
+
*/
|
|
12358
|
+
defaultModelId?: string | null;
|
|
12359
|
+
/**
|
|
12360
|
+
* 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.
|
|
12361
|
+
*/
|
|
12362
|
+
resolvedModels?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel[];
|
|
12363
|
+
}
|
|
12364
|
+
/**
|
|
12365
|
+
* A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.
|
|
12366
|
+
*/
|
|
12367
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel {
|
|
12368
|
+
/**
|
|
12369
|
+
* Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces.
|
|
12370
|
+
*/
|
|
12371
|
+
adminView?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView;
|
|
12372
|
+
/**
|
|
12373
|
+
* Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`.
|
|
12374
|
+
*/
|
|
12375
|
+
description?: string | null;
|
|
12376
|
+
/**
|
|
12377
|
+
* 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.
|
|
12378
|
+
*/
|
|
12379
|
+
displayName?: string | null;
|
|
12380
|
+
/**
|
|
12381
|
+
* Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`).
|
|
12382
|
+
*/
|
|
12383
|
+
icon?: string | null;
|
|
12384
|
+
/**
|
|
12385
|
+
* Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI.
|
|
12386
|
+
*/
|
|
12387
|
+
isPreview?: boolean | null;
|
|
12388
|
+
/**
|
|
12389
|
+
* 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.
|
|
12390
|
+
*/
|
|
12391
|
+
modelId?: string | null;
|
|
12392
|
+
}
|
|
12393
|
+
/**
|
|
12394
|
+
* 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.
|
|
12395
|
+
*/
|
|
12396
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView {
|
|
12397
|
+
/**
|
|
12398
|
+
* 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`.
|
|
12399
|
+
*/
|
|
12400
|
+
adminOverridable?: boolean | null;
|
|
12401
|
+
/**
|
|
12402
|
+
* 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`.
|
|
12403
|
+
*/
|
|
12404
|
+
enabledByDefault?: boolean | null;
|
|
12405
|
+
/**
|
|
12406
|
+
* Output only. Regions where this model is launched.
|
|
12407
|
+
*/
|
|
12408
|
+
regions?: string[] | null;
|
|
12409
|
+
}
|
|
11621
12410
|
/**
|
|
11622
12411
|
* SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.
|
|
11623
12412
|
*/
|
|
@@ -11660,6 +12449,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11660
12449
|
* Workspace settings for the end user.
|
|
11661
12450
|
*/
|
|
11662
12451
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceSettings {
|
|
12452
|
+
/**
|
|
12453
|
+
* Whether the calling user's customer domain matches the workspace data stores under this engine.
|
|
12454
|
+
*/
|
|
12455
|
+
customerDomainValid?: boolean | null;
|
|
11663
12456
|
/**
|
|
11664
12457
|
* Whether an end user has workspace access enabled.
|
|
11665
12458
|
*/
|
|
@@ -11869,6 +12662,25 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11869
12662
|
* Required. The supported connector modes for the associated BAP connection.
|
|
11870
12663
|
*/
|
|
11871
12664
|
supportedConnectorModes?: string[] | null;
|
|
12665
|
+
/**
|
|
12666
|
+
* 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).
|
|
12667
|
+
*/
|
|
12668
|
+
toolspecOverride?: Schema$GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride;
|
|
12669
|
+
}
|
|
12670
|
+
/**
|
|
12671
|
+
* 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.
|
|
12672
|
+
*/
|
|
12673
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BAPConfigToolspecOverride {
|
|
12674
|
+
/**
|
|
12675
|
+
* 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.
|
|
12676
|
+
*/
|
|
12677
|
+
baseVersion?: string | null;
|
|
12678
|
+
/**
|
|
12679
|
+
* 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.
|
|
12680
|
+
*/
|
|
12681
|
+
tools?: Array<{
|
|
12682
|
+
[key: string]: any;
|
|
12683
|
+
}> | null;
|
|
11872
12684
|
}
|
|
11873
12685
|
/**
|
|
11874
12686
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -12834,6 +13646,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12834
13646
|
* 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
13647
|
*/
|
|
12836
13648
|
appType?: string | null;
|
|
13649
|
+
/**
|
|
13650
|
+
* 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.
|
|
13651
|
+
*/
|
|
13652
|
+
associatedAgentRegistry?: string | null;
|
|
12837
13653
|
/**
|
|
12838
13654
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
12839
13655
|
*/
|
|
@@ -12877,7 +13693,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12877
13693
|
*/
|
|
12878
13694
|
displayName?: string | null;
|
|
12879
13695
|
/**
|
|
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` * `
|
|
13696
|
+
* 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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
|
|
12881
13697
|
*/
|
|
12882
13698
|
features?: {
|
|
12883
13699
|
[key: string]: string;
|
|
@@ -13105,7 +13921,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13105
13921
|
*/
|
|
13106
13922
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
13107
13923
|
/**
|
|
13108
|
-
* Optional. The required subscription tier of this engine.
|
|
13924
|
+
* 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
13925
|
*/
|
|
13110
13926
|
requiredSubscriptionTier?: string | null;
|
|
13111
13927
|
/**
|
|
@@ -13502,6 +14318,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13502
14318
|
* Output only. Whether the license config is for Gemini bundle.
|
|
13503
14319
|
*/
|
|
13504
14320
|
geminiBundle?: boolean | null;
|
|
14321
|
+
/**
|
|
14322
|
+
* 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.).
|
|
14323
|
+
*/
|
|
14324
|
+
lastUserUpdateTime?: string | null;
|
|
13505
14325
|
/**
|
|
13506
14326
|
* Required. Number of licenses purchased.
|
|
13507
14327
|
*/
|
|
@@ -13618,6 +14438,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13618
14438
|
* 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
14439
|
*/
|
|
13620
14440
|
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
|
|
14441
|
+
/**
|
|
14442
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
14443
|
+
*/
|
|
14444
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
13621
14445
|
/**
|
|
13622
14446
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
13623
14447
|
*/
|
|
@@ -13647,6 +14471,35 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13647
14471
|
*/
|
|
13648
14472
|
updateType?: string | null;
|
|
13649
14473
|
}
|
|
14474
|
+
/**
|
|
14475
|
+
* 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.
|
|
14476
|
+
*/
|
|
14477
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
14478
|
+
/**
|
|
14479
|
+
* 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.
|
|
14480
|
+
*/
|
|
14481
|
+
effectiveTpmThreshold?: string | null;
|
|
14482
|
+
/**
|
|
14483
|
+
* 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).
|
|
14484
|
+
*/
|
|
14485
|
+
modelVersion?: string | null;
|
|
14486
|
+
/**
|
|
14487
|
+
* 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.
|
|
14488
|
+
*/
|
|
14489
|
+
startTime?: string | null;
|
|
14490
|
+
/**
|
|
14491
|
+
* 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.
|
|
14492
|
+
*/
|
|
14493
|
+
terminateTime?: string | null;
|
|
14494
|
+
/**
|
|
14495
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
14496
|
+
*/
|
|
14497
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
14498
|
+
/**
|
|
14499
|
+
* 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).
|
|
14500
|
+
*/
|
|
14501
|
+
updateType?: string | null;
|
|
14502
|
+
}
|
|
13650
14503
|
/**
|
|
13651
14504
|
* Customer provided configurations.
|
|
13652
14505
|
*/
|
|
@@ -14816,11 +15669,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14816
15669
|
userId?: string | null;
|
|
14817
15670
|
}
|
|
14818
15671
|
/**
|
|
14819
|
-
* Precise location info with multiple representation options.
|
|
15672
|
+
* Precise location info with multiple representation options.
|
|
14820
15673
|
*/
|
|
14821
15674
|
export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation {
|
|
14822
15675
|
/**
|
|
14823
|
-
*
|
|
15676
|
+
* Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.
|
|
14824
15677
|
*/
|
|
14825
15678
|
address?: string | null;
|
|
14826
15679
|
/**
|
|
@@ -15287,7 +16140,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15287
16140
|
*/
|
|
15288
16141
|
createTime?: string | null;
|
|
15289
16142
|
/**
|
|
15290
|
-
* Required. The identifier for the data source.
|
|
16143
|
+
* 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
16144
|
*/
|
|
15292
16145
|
dataSource?: string | null;
|
|
15293
16146
|
/**
|
|
@@ -15354,6 +16207,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15354
16207
|
* 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
16208
|
*/
|
|
15356
16209
|
latestPauseTime?: string | null;
|
|
16210
|
+
/**
|
|
16211
|
+
* Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`.
|
|
16212
|
+
*/
|
|
16213
|
+
metadata?: Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata;
|
|
15357
16214
|
/**
|
|
15358
16215
|
* Identifier. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
15359
16216
|
*/
|
|
@@ -15362,6 +16219,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15362
16219
|
* 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
16220
|
*/
|
|
15364
16221
|
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
16222
|
+
/**
|
|
16223
|
+
* 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.
|
|
16224
|
+
*/
|
|
16225
|
+
oauthStaticIpAddresses?: string[] | null;
|
|
15365
16226
|
/**
|
|
15366
16227
|
* Required data connector parameters in structured json format.
|
|
15367
16228
|
*/
|
|
@@ -15404,6 +16265,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15404
16265
|
* The data synchronization mode supported by the data connector.
|
|
15405
16266
|
*/
|
|
15406
16267
|
syncMode?: string | null;
|
|
16268
|
+
/**
|
|
16269
|
+
* 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.
|
|
16270
|
+
*/
|
|
16271
|
+
tag?: string | null;
|
|
15407
16272
|
/**
|
|
15408
16273
|
* Output only. Timestamp the DataConnector was last updated.
|
|
15409
16274
|
*/
|
|
@@ -15413,6 +16278,35 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15413
16278
|
*/
|
|
15414
16279
|
vpcscEnabled?: boolean | null;
|
|
15415
16280
|
}
|
|
16281
|
+
/**
|
|
16282
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
|
|
16283
|
+
*/
|
|
16284
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
|
|
16285
|
+
/**
|
|
16286
|
+
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
16287
|
+
*/
|
|
16288
|
+
authenticatedAccount?: string | null;
|
|
16289
|
+
/**
|
|
16290
|
+
* 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).
|
|
16291
|
+
*/
|
|
16292
|
+
author?: string | null;
|
|
16293
|
+
/**
|
|
16294
|
+
* Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
|
|
16295
|
+
*/
|
|
16296
|
+
description?: string | null;
|
|
16297
|
+
/**
|
|
16298
|
+
* Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
|
|
16299
|
+
*/
|
|
16300
|
+
note?: string | null;
|
|
16301
|
+
/**
|
|
16302
|
+
* Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
|
|
16303
|
+
*/
|
|
16304
|
+
shortDescription?: string | null;
|
|
16305
|
+
/**
|
|
16306
|
+
* Optional. Display title of the connector.
|
|
16307
|
+
*/
|
|
16308
|
+
title?: string | null;
|
|
16309
|
+
}
|
|
15416
16310
|
/**
|
|
15417
16311
|
* Any params and credentials used specifically for EUA connectors.
|
|
15418
16312
|
*/
|
|
@@ -16081,6 +16975,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16081
16975
|
* 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
16976
|
*/
|
|
16083
16977
|
appType?: string | null;
|
|
16978
|
+
/**
|
|
16979
|
+
* 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.
|
|
16980
|
+
*/
|
|
16981
|
+
associatedAgentRegistry?: string | null;
|
|
16084
16982
|
/**
|
|
16085
16983
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
16086
16984
|
*/
|
|
@@ -16124,7 +17022,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16124
17022
|
*/
|
|
16125
17023
|
displayName?: string | null;
|
|
16126
17024
|
/**
|
|
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` * `
|
|
17025
|
+
* 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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
|
|
16128
17026
|
*/
|
|
16129
17027
|
features?: {
|
|
16130
17028
|
[key: string]: string;
|
|
@@ -16352,7 +17250,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16352
17250
|
*/
|
|
16353
17251
|
export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
16354
17252
|
/**
|
|
16355
|
-
* Optional. The required subscription tier of this engine.
|
|
17253
|
+
* 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
17254
|
*/
|
|
16357
17255
|
requiredSubscriptionTier?: string | null;
|
|
16358
17256
|
/**
|
|
@@ -16623,6 +17521,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16623
17521
|
* Output only. Whether the license config is for Gemini bundle.
|
|
16624
17522
|
*/
|
|
16625
17523
|
geminiBundle?: boolean | null;
|
|
17524
|
+
/**
|
|
17525
|
+
* 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.).
|
|
17526
|
+
*/
|
|
17527
|
+
lastUserUpdateTime?: string | null;
|
|
16626
17528
|
/**
|
|
16627
17529
|
* Required. Number of licenses purchased.
|
|
16628
17530
|
*/
|
|
@@ -16705,6 +17607,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16705
17607
|
* 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
17608
|
*/
|
|
16707
17609
|
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
|
|
17610
|
+
/**
|
|
17611
|
+
* Output only. Per-model Agent Search TPM subscription status.
|
|
17612
|
+
*/
|
|
17613
|
+
agentSearchTokenSubscriptionStatuses?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus[];
|
|
16708
17614
|
/**
|
|
16709
17615
|
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
16710
17616
|
*/
|
|
@@ -16734,6 +17640,35 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16734
17640
|
*/
|
|
16735
17641
|
updateType?: string | null;
|
|
16736
17642
|
}
|
|
17643
|
+
/**
|
|
17644
|
+
* 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.
|
|
17645
|
+
*/
|
|
17646
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatusAgentSearchTokenSubscriptionStatus {
|
|
17647
|
+
/**
|
|
17648
|
+
* 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.
|
|
17649
|
+
*/
|
|
17650
|
+
effectiveTpmThreshold?: string | null;
|
|
17651
|
+
/**
|
|
17652
|
+
* 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).
|
|
17653
|
+
*/
|
|
17654
|
+
modelVersion?: string | null;
|
|
17655
|
+
/**
|
|
17656
|
+
* 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.
|
|
17657
|
+
*/
|
|
17658
|
+
startTime?: string | null;
|
|
17659
|
+
/**
|
|
17660
|
+
* 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.
|
|
17661
|
+
*/
|
|
17662
|
+
terminateTime?: string | null;
|
|
17663
|
+
/**
|
|
17664
|
+
* Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.
|
|
17665
|
+
*/
|
|
17666
|
+
tpmThresholdNextUpdateTime?: string | null;
|
|
17667
|
+
/**
|
|
17668
|
+
* 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).
|
|
17669
|
+
*/
|
|
17670
|
+
updateType?: string | null;
|
|
17671
|
+
}
|
|
16737
17672
|
/**
|
|
16738
17673
|
* Customer provided configurations.
|
|
16739
17674
|
*/
|
|
@@ -16839,7 +17774,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16839
17774
|
updateTime?: string | null;
|
|
16840
17775
|
}
|
|
16841
17776
|
/**
|
|
16842
|
-
* Response message for CompletionService.PurgeCompletionSuggestions method.
|
|
17777
|
+
* 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
17778
|
*/
|
|
16844
17779
|
export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse {
|
|
16845
17780
|
/**
|
|
@@ -19902,8 +20837,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19902
20837
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
19903
20838
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
19904
20839
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
20840
|
+
* // "metadata": {},
|
|
19905
20841
|
* // "name": "my_name",
|
|
19906
20842
|
* // "nextSyncTime": {},
|
|
20843
|
+
* // "oauthStaticIpAddresses": [],
|
|
19907
20844
|
* // "params": {},
|
|
19908
20845
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
19909
20846
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -19914,6 +20851,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
19914
20851
|
* // "staticIpAddresses": [],
|
|
19915
20852
|
* // "staticIpEnabled": false,
|
|
19916
20853
|
* // "syncMode": "my_syncMode",
|
|
20854
|
+
* // "tag": "my_tag",
|
|
19917
20855
|
* // "updateTime": "my_updateTime",
|
|
19918
20856
|
* // "vpcscEnabled": false
|
|
19919
20857
|
* // }
|
|
@@ -21225,8 +22163,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21225
22163
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
21226
22164
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
21227
22165
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
22166
|
+
* // "metadata": {},
|
|
21228
22167
|
* // "name": "my_name",
|
|
21229
22168
|
* // "nextSyncTime": {},
|
|
22169
|
+
* // "oauthStaticIpAddresses": [],
|
|
21230
22170
|
* // "params": {},
|
|
21231
22171
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
21232
22172
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -21237,6 +22177,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21237
22177
|
* // "staticIpAddresses": [],
|
|
21238
22178
|
* // "staticIpEnabled": false,
|
|
21239
22179
|
* // "syncMode": "my_syncMode",
|
|
22180
|
+
* // "tag": "my_tag",
|
|
21240
22181
|
* // "updateTime": "my_updateTime",
|
|
21241
22182
|
* // "vpcscEnabled": false
|
|
21242
22183
|
* // }
|
|
@@ -21489,8 +22430,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21489
22430
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
21490
22431
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
21491
22432
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
22433
|
+
* // "metadata": {},
|
|
21492
22434
|
* // "name": "my_name",
|
|
21493
22435
|
* // "nextSyncTime": {},
|
|
22436
|
+
* // "oauthStaticIpAddresses": [],
|
|
21494
22437
|
* // "params": {},
|
|
21495
22438
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
21496
22439
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -21501,6 +22444,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21501
22444
|
* // "staticIpAddresses": [],
|
|
21502
22445
|
* // "staticIpEnabled": false,
|
|
21503
22446
|
* // "syncMode": "my_syncMode",
|
|
22447
|
+
* // "tag": "my_tag",
|
|
21504
22448
|
* // "updateTime": "my_updateTime",
|
|
21505
22449
|
* // "vpcscEnabled": false
|
|
21506
22450
|
* // }
|
|
@@ -21541,8 +22485,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21541
22485
|
* // "kmsKeyName": "my_kmsKeyName",
|
|
21542
22486
|
* // "lastSyncTime": "my_lastSyncTime",
|
|
21543
22487
|
* // "latestPauseTime": "my_latestPauseTime",
|
|
22488
|
+
* // "metadata": {},
|
|
21544
22489
|
* // "name": "my_name",
|
|
21545
22490
|
* // "nextSyncTime": {},
|
|
22491
|
+
* // "oauthStaticIpAddresses": [],
|
|
21546
22492
|
* // "params": {},
|
|
21547
22493
|
* // "privateConnectivityProjectId": "my_privateConnectivityProjectId",
|
|
21548
22494
|
* // "realtimeState": "my_realtimeState",
|
|
@@ -21553,6 +22499,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21553
22499
|
* // "staticIpAddresses": [],
|
|
21554
22500
|
* // "staticIpEnabled": false,
|
|
21555
22501
|
* // "syncMode": "my_syncMode",
|
|
22502
|
+
* // "tag": "my_tag",
|
|
21556
22503
|
* // "updateTime": "my_updateTime",
|
|
21557
22504
|
* // "vpcscEnabled": false
|
|
21558
22505
|
* // }
|
|
@@ -21691,6 +22638,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21691
22638
|
* requestBody: {
|
|
21692
22639
|
* // request body parameters
|
|
21693
22640
|
* // {
|
|
22641
|
+
* // "action": "my_action",
|
|
21694
22642
|
* // "scope": "my_scope"
|
|
21695
22643
|
* // }
|
|
21696
22644
|
* },
|
|
@@ -22608,6 +23556,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22608
23556
|
* // "documentProcessingConfig": {},
|
|
22609
23557
|
* // "federatedSearchConfig": {},
|
|
22610
23558
|
* // "healthcareFhirConfig": {},
|
|
23559
|
+
* // "iconUri": "my_iconUri",
|
|
22611
23560
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
22612
23561
|
* // "idpConfig": {},
|
|
22613
23562
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -22842,6 +23791,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22842
23791
|
* await discoveryengine.projects.locations.collections.dataStores.get({
|
|
22843
23792
|
* // 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
23793
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
23794
|
+
* // 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.
|
|
23795
|
+
* view: 'placeholder-value',
|
|
22845
23796
|
* });
|
|
22846
23797
|
* console.log(res.data);
|
|
22847
23798
|
*
|
|
@@ -22861,6 +23812,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22861
23812
|
* // "documentProcessingConfig": {},
|
|
22862
23813
|
* // "federatedSearchConfig": {},
|
|
22863
23814
|
* // "healthcareFhirConfig": {},
|
|
23815
|
+
* // "iconUri": "my_iconUri",
|
|
22864
23816
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
22865
23817
|
* // "idpConfig": {},
|
|
22866
23818
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -22894,6 +23846,82 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
22894
23846
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
22895
23847
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
22896
23848
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
23849
|
+
/**
|
|
23850
|
+
* Gets a CompletionConfig
|
|
23851
|
+
* @example
|
|
23852
|
+
* ```js
|
|
23853
|
+
* // Before running the sample:
|
|
23854
|
+
* // - Enable the API at:
|
|
23855
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
23856
|
+
* // - Login into gcloud by running:
|
|
23857
|
+
* // ```sh
|
|
23858
|
+
* // $ gcloud auth application-default login
|
|
23859
|
+
* // ```
|
|
23860
|
+
* // - Install the npm module by running:
|
|
23861
|
+
* // ```sh
|
|
23862
|
+
* // $ npm install googleapis
|
|
23863
|
+
* // ```
|
|
23864
|
+
*
|
|
23865
|
+
* const {google} = require('googleapis');
|
|
23866
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
23867
|
+
*
|
|
23868
|
+
* async function main() {
|
|
23869
|
+
* const auth = new google.auth.GoogleAuth({
|
|
23870
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
23871
|
+
* scopes: [
|
|
23872
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
23873
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
23874
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
23875
|
+
* ],
|
|
23876
|
+
* });
|
|
23877
|
+
*
|
|
23878
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
23879
|
+
* const authClient = await auth.getClient();
|
|
23880
|
+
* google.options({auth: authClient});
|
|
23881
|
+
*
|
|
23882
|
+
* // Do the magic
|
|
23883
|
+
* const res =
|
|
23884
|
+
* await discoveryengine.projects.locations.collections.dataStores.getCompletionConfig(
|
|
23885
|
+
* {
|
|
23886
|
+
* // 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`
|
|
23887
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/completionConfig',
|
|
23888
|
+
* },
|
|
23889
|
+
* );
|
|
23890
|
+
* console.log(res.data);
|
|
23891
|
+
*
|
|
23892
|
+
* // Example response
|
|
23893
|
+
* // {
|
|
23894
|
+
* // "enableMode": "my_enableMode",
|
|
23895
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
23896
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
23897
|
+
* // "maxSuggestions": 0,
|
|
23898
|
+
* // "minPrefixLength": 0,
|
|
23899
|
+
* // "name": "my_name",
|
|
23900
|
+
* // "numUniqueUsersThreshold": 0,
|
|
23901
|
+
* // "queryFrequencyThreshold": 0,
|
|
23902
|
+
* // "queryModel": "my_queryModel",
|
|
23903
|
+
* // "shouldServeContentSuggestions": false
|
|
23904
|
+
* // }
|
|
23905
|
+
* }
|
|
23906
|
+
*
|
|
23907
|
+
* main().catch(e => {
|
|
23908
|
+
* console.error(e);
|
|
23909
|
+
* throw e;
|
|
23910
|
+
* });
|
|
23911
|
+
*
|
|
23912
|
+
* ```
|
|
23913
|
+
*
|
|
23914
|
+
* @param params - Parameters for request
|
|
23915
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
23916
|
+
* @param callback - Optional callback that handles the response.
|
|
23917
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
23918
|
+
*/
|
|
23919
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
23920
|
+
getCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
23921
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
23922
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
23923
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
23924
|
+
getCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
22897
23925
|
/**
|
|
22898
23926
|
* Gets a DocumentProcessingConfig.
|
|
22899
23927
|
* @example
|
|
@@ -23076,6 +24104,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23076
24104
|
* // 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
24105
|
* parent:
|
|
23078
24106
|
* 'projects/my-project/locations/my-location/collections/my-collection',
|
|
24107
|
+
* // 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.
|
|
24108
|
+
* view: 'placeholder-value',
|
|
23079
24109
|
* });
|
|
23080
24110
|
* console.log(res.data);
|
|
23081
24111
|
*
|
|
@@ -23163,6 +24193,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23163
24193
|
* // "documentProcessingConfig": {},
|
|
23164
24194
|
* // "federatedSearchConfig": {},
|
|
23165
24195
|
* // "healthcareFhirConfig": {},
|
|
24196
|
+
* // "iconUri": "my_iconUri",
|
|
23166
24197
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
23167
24198
|
* // "idpConfig": {},
|
|
23168
24199
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -23196,6 +24227,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23196
24227
|
* // "documentProcessingConfig": {},
|
|
23197
24228
|
* // "federatedSearchConfig": {},
|
|
23198
24229
|
* // "healthcareFhirConfig": {},
|
|
24230
|
+
* // "iconUri": "my_iconUri",
|
|
23199
24231
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
23200
24232
|
* // "idpConfig": {},
|
|
23201
24233
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -23475,7 +24507,102 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23475
24507
|
trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
23476
24508
|
trainCustomModel(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
23477
24509
|
/**
|
|
23478
|
-
* Updates the
|
|
24510
|
+
* Updates the CompletionConfigs.
|
|
24511
|
+
* @example
|
|
24512
|
+
* ```js
|
|
24513
|
+
* // Before running the sample:
|
|
24514
|
+
* // - Enable the API at:
|
|
24515
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24516
|
+
* // - Login into gcloud by running:
|
|
24517
|
+
* // ```sh
|
|
24518
|
+
* // $ gcloud auth application-default login
|
|
24519
|
+
* // ```
|
|
24520
|
+
* // - Install the npm module by running:
|
|
24521
|
+
* // ```sh
|
|
24522
|
+
* // $ npm install googleapis
|
|
24523
|
+
* // ```
|
|
24524
|
+
*
|
|
24525
|
+
* const {google} = require('googleapis');
|
|
24526
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
24527
|
+
*
|
|
24528
|
+
* async function main() {
|
|
24529
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24530
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24531
|
+
* scopes: [
|
|
24532
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
24533
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
24534
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
24535
|
+
* ],
|
|
24536
|
+
* });
|
|
24537
|
+
*
|
|
24538
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
24539
|
+
* const authClient = await auth.getClient();
|
|
24540
|
+
* google.options({auth: authClient});
|
|
24541
|
+
*
|
|
24542
|
+
* // Do the magic
|
|
24543
|
+
* const res =
|
|
24544
|
+
* await discoveryengine.projects.locations.collections.dataStores.updateCompletionConfig(
|
|
24545
|
+
* {
|
|
24546
|
+
* // 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`
|
|
24547
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/completionConfig',
|
|
24548
|
+
* // 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.
|
|
24549
|
+
* updateMask: 'placeholder-value',
|
|
24550
|
+
*
|
|
24551
|
+
* // Request body metadata
|
|
24552
|
+
* requestBody: {
|
|
24553
|
+
* // request body parameters
|
|
24554
|
+
* // {
|
|
24555
|
+
* // "enableMode": "my_enableMode",
|
|
24556
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
24557
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
24558
|
+
* // "maxSuggestions": 0,
|
|
24559
|
+
* // "minPrefixLength": 0,
|
|
24560
|
+
* // "name": "my_name",
|
|
24561
|
+
* // "numUniqueUsersThreshold": 0,
|
|
24562
|
+
* // "queryFrequencyThreshold": 0,
|
|
24563
|
+
* // "queryModel": "my_queryModel",
|
|
24564
|
+
* // "shouldServeContentSuggestions": false
|
|
24565
|
+
* // }
|
|
24566
|
+
* },
|
|
24567
|
+
* },
|
|
24568
|
+
* );
|
|
24569
|
+
* console.log(res.data);
|
|
24570
|
+
*
|
|
24571
|
+
* // Example response
|
|
24572
|
+
* // {
|
|
24573
|
+
* // "enableMode": "my_enableMode",
|
|
24574
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
24575
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
24576
|
+
* // "maxSuggestions": 0,
|
|
24577
|
+
* // "minPrefixLength": 0,
|
|
24578
|
+
* // "name": "my_name",
|
|
24579
|
+
* // "numUniqueUsersThreshold": 0,
|
|
24580
|
+
* // "queryFrequencyThreshold": 0,
|
|
24581
|
+
* // "queryModel": "my_queryModel",
|
|
24582
|
+
* // "shouldServeContentSuggestions": false
|
|
24583
|
+
* // }
|
|
24584
|
+
* }
|
|
24585
|
+
*
|
|
24586
|
+
* main().catch(e => {
|
|
24587
|
+
* console.error(e);
|
|
24588
|
+
* throw e;
|
|
24589
|
+
* });
|
|
24590
|
+
*
|
|
24591
|
+
* ```
|
|
24592
|
+
*
|
|
24593
|
+
* @param params - Parameters for request
|
|
24594
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24595
|
+
* @param callback - Optional callback that handles the response.
|
|
24596
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24597
|
+
*/
|
|
24598
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24599
|
+
updateCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
24600
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24601
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24602
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24603
|
+
updateCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
24604
|
+
/**
|
|
24605
|
+
* 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
24606
|
* @example
|
|
23480
24607
|
* ```js
|
|
23481
24608
|
* // Before running the sample:
|
|
@@ -23513,7 +24640,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23513
24640
|
* {
|
|
23514
24641
|
* // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
23515
24642
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/documentProcessingConfig',
|
|
23516
|
-
* //
|
|
24643
|
+
* // 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
24644
|
* updateMask: 'placeholder-value',
|
|
23518
24645
|
*
|
|
23519
24646
|
* // Request body metadata
|
|
@@ -23641,6 +24768,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23641
24768
|
* 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
24769
|
*/
|
|
23643
24770
|
name?: string;
|
|
24771
|
+
/**
|
|
24772
|
+
* 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.
|
|
24773
|
+
*/
|
|
24774
|
+
view?: string;
|
|
24775
|
+
}
|
|
24776
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Getcompletionconfig extends StandardParameters {
|
|
24777
|
+
/**
|
|
24778
|
+
* 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`
|
|
24779
|
+
*/
|
|
24780
|
+
name?: string;
|
|
23644
24781
|
}
|
|
23645
24782
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig extends StandardParameters {
|
|
23646
24783
|
/**
|
|
@@ -23671,6 +24808,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23671
24808
|
* 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
24809
|
*/
|
|
23673
24810
|
parent?: string;
|
|
24811
|
+
/**
|
|
24812
|
+
* 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.
|
|
24813
|
+
*/
|
|
24814
|
+
view?: string;
|
|
23674
24815
|
}
|
|
23675
24816
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters {
|
|
23676
24817
|
/**
|
|
@@ -23716,13 +24857,27 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
23716
24857
|
*/
|
|
23717
24858
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest;
|
|
23718
24859
|
}
|
|
24860
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatecompletionconfig extends StandardParameters {
|
|
24861
|
+
/**
|
|
24862
|
+
* 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`
|
|
24863
|
+
*/
|
|
24864
|
+
name?: string;
|
|
24865
|
+
/**
|
|
24866
|
+
* 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.
|
|
24867
|
+
*/
|
|
24868
|
+
updateMask?: string;
|
|
24869
|
+
/**
|
|
24870
|
+
* Request body metadata
|
|
24871
|
+
*/
|
|
24872
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
24873
|
+
}
|
|
23719
24874
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
23720
24875
|
/**
|
|
23721
24876
|
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
23722
24877
|
*/
|
|
23723
24878
|
name?: string;
|
|
23724
24879
|
/**
|
|
23725
|
-
*
|
|
24880
|
+
* 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
24881
|
*/
|
|
23727
24882
|
updateMask?: string;
|
|
23728
24883
|
/**
|
|
@@ -31516,6 +32671,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31516
32671
|
* // "entity": "my_entity",
|
|
31517
32672
|
* // "eventTime": "my_eventTime",
|
|
31518
32673
|
* // "eventType": "my_eventType",
|
|
32674
|
+
* // "feedback": {},
|
|
31519
32675
|
* // "filter": "my_filter",
|
|
31520
32676
|
* // "mediaInfo": {},
|
|
31521
32677
|
* // "pageInfo": {},
|
|
@@ -31547,6 +32703,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31547
32703
|
* // "entity": "my_entity",
|
|
31548
32704
|
* // "eventTime": "my_eventTime",
|
|
31549
32705
|
* // "eventType": "my_eventType",
|
|
32706
|
+
* // "feedback": {},
|
|
31550
32707
|
* // "filter": "my_filter",
|
|
31551
32708
|
* // "mediaInfo": {},
|
|
31552
32709
|
* // "pageInfo": {},
|
|
@@ -31679,6 +32836,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31679
32836
|
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
31680
32837
|
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
31681
32838
|
* 'placeholder-value',
|
|
32839
|
+
* // 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).
|
|
32840
|
+
* languageCode: 'placeholder-value',
|
|
32841
|
+
* // 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`).
|
|
32842
|
+
* modelInfoView: 'placeholder-value',
|
|
31682
32843
|
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
31683
32844
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
31684
32845
|
* },
|
|
@@ -31691,6 +32852,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31691
32852
|
* // "allowPublicAccess": false,
|
|
31692
32853
|
* // "allowlistedDomains": [],
|
|
31693
32854
|
* // "assistantSettings": {},
|
|
32855
|
+
* // "batchAuthStatuses": [],
|
|
31694
32856
|
* // "collectionComponents": [],
|
|
31695
32857
|
* // "configId": "my_configId",
|
|
31696
32858
|
* // "contentSearchSpec": {},
|
|
@@ -31796,6 +32958,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31796
32958
|
* // "allowPublicAccess": false,
|
|
31797
32959
|
* // "allowlistedDomains": [],
|
|
31798
32960
|
* // "assistantSettings": {},
|
|
32961
|
+
* // "batchAuthStatuses": [],
|
|
31799
32962
|
* // "collectionComponents": [],
|
|
31800
32963
|
* // "configId": "my_configId",
|
|
31801
32964
|
* // "contentSearchSpec": {},
|
|
@@ -31841,6 +33004,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31841
33004
|
* // "allowPublicAccess": false,
|
|
31842
33005
|
* // "allowlistedDomains": [],
|
|
31843
33006
|
* // "assistantSettings": {},
|
|
33007
|
+
* // "batchAuthStatuses": [],
|
|
31844
33008
|
* // "collectionComponents": [],
|
|
31845
33009
|
* // "configId": "my_configId",
|
|
31846
33010
|
* // "contentSearchSpec": {},
|
|
@@ -31905,6 +33069,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31905
33069
|
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
31906
33070
|
*/
|
|
31907
33071
|
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
33072
|
+
/**
|
|
33073
|
+
* 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).
|
|
33074
|
+
*/
|
|
33075
|
+
languageCode?: string;
|
|
33076
|
+
/**
|
|
33077
|
+
* 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`).
|
|
33078
|
+
*/
|
|
33079
|
+
modelInfoView?: string;
|
|
31908
33080
|
/**
|
|
31909
33081
|
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
31910
33082
|
*/
|
|
@@ -31984,6 +33156,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31984
33156
|
* // {
|
|
31985
33157
|
* // "agentGatewaySetting": {},
|
|
31986
33158
|
* // "appType": "my_appType",
|
|
33159
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
31987
33160
|
* // "chatEngineConfig": {},
|
|
31988
33161
|
* // "chatEngineMetadata": {},
|
|
31989
33162
|
* // "cmekConfig": {},
|
|
@@ -32154,6 +33327,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32154
33327
|
* // {
|
|
32155
33328
|
* // "agentGatewaySetting": {},
|
|
32156
33329
|
* // "appType": "my_appType",
|
|
33330
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32157
33331
|
* // "chatEngineConfig": {},
|
|
32158
33332
|
* // "chatEngineMetadata": {},
|
|
32159
33333
|
* // "cmekConfig": {},
|
|
@@ -32200,7 +33374,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32200
33374
|
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
32201
33375
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
32202
33376
|
/**
|
|
32203
|
-
* Gets
|
|
33377
|
+
* Gets a CompletionConfig
|
|
32204
33378
|
* @example
|
|
32205
33379
|
* ```js
|
|
32206
33380
|
* // Before running the sample:
|
|
@@ -32234,87 +33408,26 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32234
33408
|
*
|
|
32235
33409
|
* // Do the magic
|
|
32236
33410
|
* const res =
|
|
32237
|
-
* await discoveryengine.projects.locations.collections.engines.
|
|
32238
|
-
* // 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).
|
|
32239
|
-
* 'options.requestedPolicyVersion': 'placeholder-value',
|
|
32240
|
-
* // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
|
|
32241
|
-
* resource:
|
|
32242
|
-
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
32243
|
-
* });
|
|
32244
|
-
* console.log(res.data);
|
|
32245
|
-
*
|
|
32246
|
-
* // Example response
|
|
32247
|
-
* // {
|
|
32248
|
-
* // "bindings": [],
|
|
32249
|
-
* // "etag": "my_etag",
|
|
32250
|
-
* // "version": 0
|
|
32251
|
-
* // }
|
|
32252
|
-
* }
|
|
32253
|
-
*
|
|
32254
|
-
* main().catch(e => {
|
|
32255
|
-
* console.error(e);
|
|
32256
|
-
* throw e;
|
|
32257
|
-
* });
|
|
32258
|
-
*
|
|
32259
|
-
* ```
|
|
32260
|
-
*
|
|
32261
|
-
* @param params - Parameters for request
|
|
32262
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
32263
|
-
* @param callback - Optional callback that handles the response.
|
|
32264
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
32265
|
-
*/
|
|
32266
|
-
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
32267
|
-
getIamPolicy(params?: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIamV1Policy>>;
|
|
32268
|
-
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
32269
|
-
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$GoogleIamV1Policy>, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
|
|
32270
|
-
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
|
|
32271
|
-
getIamPolicy(callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
|
|
32272
|
-
/**
|
|
32273
|
-
* Get Workspace settings for the end user.
|
|
32274
|
-
* @example
|
|
32275
|
-
* ```js
|
|
32276
|
-
* // Before running the sample:
|
|
32277
|
-
* // - Enable the API at:
|
|
32278
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
32279
|
-
* // - Login into gcloud by running:
|
|
32280
|
-
* // ```sh
|
|
32281
|
-
* // $ gcloud auth application-default login
|
|
32282
|
-
* // ```
|
|
32283
|
-
* // - Install the npm module by running:
|
|
32284
|
-
* // ```sh
|
|
32285
|
-
* // $ npm install googleapis
|
|
32286
|
-
* // ```
|
|
32287
|
-
*
|
|
32288
|
-
* const {google} = require('googleapis');
|
|
32289
|
-
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
32290
|
-
*
|
|
32291
|
-
* async function main() {
|
|
32292
|
-
* const auth = new google.auth.GoogleAuth({
|
|
32293
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
32294
|
-
* scopes: [
|
|
32295
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
32296
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
32297
|
-
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
32298
|
-
* ],
|
|
32299
|
-
* });
|
|
32300
|
-
*
|
|
32301
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
32302
|
-
* const authClient = await auth.getClient();
|
|
32303
|
-
* google.options({auth: authClient});
|
|
32304
|
-
*
|
|
32305
|
-
* // Do the magic
|
|
32306
|
-
* const res =
|
|
32307
|
-
* await discoveryengine.projects.locations.collections.engines.getWorkspaceSettings(
|
|
33411
|
+
* await discoveryengine.projects.locations.collections.engines.getCompletionConfig(
|
|
32308
33412
|
* {
|
|
32309
|
-
* // Required. Full
|
|
32310
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
33413
|
+
* // 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`
|
|
33414
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig',
|
|
32311
33415
|
* },
|
|
32312
33416
|
* );
|
|
32313
33417
|
* console.log(res.data);
|
|
32314
33418
|
*
|
|
32315
33419
|
* // Example response
|
|
32316
33420
|
* // {
|
|
32317
|
-
* // "
|
|
33421
|
+
* // "enableMode": "my_enableMode",
|
|
33422
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
33423
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
33424
|
+
* // "maxSuggestions": 0,
|
|
33425
|
+
* // "minPrefixLength": 0,
|
|
33426
|
+
* // "name": "my_name",
|
|
33427
|
+
* // "numUniqueUsersThreshold": 0,
|
|
33428
|
+
* // "queryFrequencyThreshold": 0,
|
|
33429
|
+
* // "queryModel": "my_queryModel",
|
|
33430
|
+
* // "shouldServeContentSuggestions": false
|
|
32318
33431
|
* // }
|
|
32319
33432
|
* }
|
|
32320
33433
|
*
|
|
@@ -32330,14 +33443,152 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32330
33443
|
* @param callback - Optional callback that handles the response.
|
|
32331
33444
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
32332
33445
|
*/
|
|
32333
|
-
|
|
32334
|
-
|
|
32335
|
-
|
|
32336
|
-
|
|
32337
|
-
|
|
32338
|
-
|
|
33446
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33447
|
+
getCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
33448
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33449
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
33450
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
33451
|
+
getCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
32339
33452
|
/**
|
|
32340
|
-
*
|
|
33453
|
+
* 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.
|
|
33454
|
+
* @example
|
|
33455
|
+
* ```js
|
|
33456
|
+
* // Before running the sample:
|
|
33457
|
+
* // - Enable the API at:
|
|
33458
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33459
|
+
* // - Login into gcloud by running:
|
|
33460
|
+
* // ```sh
|
|
33461
|
+
* // $ gcloud auth application-default login
|
|
33462
|
+
* // ```
|
|
33463
|
+
* // - Install the npm module by running:
|
|
33464
|
+
* // ```sh
|
|
33465
|
+
* // $ npm install googleapis
|
|
33466
|
+
* // ```
|
|
33467
|
+
*
|
|
33468
|
+
* const {google} = require('googleapis');
|
|
33469
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
33470
|
+
*
|
|
33471
|
+
* async function main() {
|
|
33472
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33473
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33474
|
+
* scopes: [
|
|
33475
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33476
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33477
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
33478
|
+
* ],
|
|
33479
|
+
* });
|
|
33480
|
+
*
|
|
33481
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33482
|
+
* const authClient = await auth.getClient();
|
|
33483
|
+
* google.options({auth: authClient});
|
|
33484
|
+
*
|
|
33485
|
+
* // Do the magic
|
|
33486
|
+
* const res =
|
|
33487
|
+
* await discoveryengine.projects.locations.collections.engines.getIamPolicy({
|
|
33488
|
+
* // 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).
|
|
33489
|
+
* 'options.requestedPolicyVersion': 'placeholder-value',
|
|
33490
|
+
* // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
|
|
33491
|
+
* resource:
|
|
33492
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
33493
|
+
* });
|
|
33494
|
+
* console.log(res.data);
|
|
33495
|
+
*
|
|
33496
|
+
* // Example response
|
|
33497
|
+
* // {
|
|
33498
|
+
* // "bindings": [],
|
|
33499
|
+
* // "etag": "my_etag",
|
|
33500
|
+
* // "version": 0
|
|
33501
|
+
* // }
|
|
33502
|
+
* }
|
|
33503
|
+
*
|
|
33504
|
+
* main().catch(e => {
|
|
33505
|
+
* console.error(e);
|
|
33506
|
+
* throw e;
|
|
33507
|
+
* });
|
|
33508
|
+
*
|
|
33509
|
+
* ```
|
|
33510
|
+
*
|
|
33511
|
+
* @param params - Parameters for request
|
|
33512
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33513
|
+
* @param callback - Optional callback that handles the response.
|
|
33514
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33515
|
+
*/
|
|
33516
|
+
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33517
|
+
getIamPolicy(params?: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleIamV1Policy>>;
|
|
33518
|
+
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33519
|
+
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$GoogleIamV1Policy>, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
|
|
33520
|
+
getIamPolicy(params: Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy, callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
|
|
33521
|
+
getIamPolicy(callback: BodyResponseCallback<Schema$GoogleIamV1Policy>): void;
|
|
33522
|
+
/**
|
|
33523
|
+
* Get Workspace settings for the end user.
|
|
33524
|
+
* @example
|
|
33525
|
+
* ```js
|
|
33526
|
+
* // Before running the sample:
|
|
33527
|
+
* // - Enable the API at:
|
|
33528
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33529
|
+
* // - Login into gcloud by running:
|
|
33530
|
+
* // ```sh
|
|
33531
|
+
* // $ gcloud auth application-default login
|
|
33532
|
+
* // ```
|
|
33533
|
+
* // - Install the npm module by running:
|
|
33534
|
+
* // ```sh
|
|
33535
|
+
* // $ npm install googleapis
|
|
33536
|
+
* // ```
|
|
33537
|
+
*
|
|
33538
|
+
* const {google} = require('googleapis');
|
|
33539
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
33540
|
+
*
|
|
33541
|
+
* async function main() {
|
|
33542
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33543
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33544
|
+
* scopes: [
|
|
33545
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33546
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33547
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
33548
|
+
* ],
|
|
33549
|
+
* });
|
|
33550
|
+
*
|
|
33551
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33552
|
+
* const authClient = await auth.getClient();
|
|
33553
|
+
* google.options({auth: authClient});
|
|
33554
|
+
*
|
|
33555
|
+
* // Do the magic
|
|
33556
|
+
* const res =
|
|
33557
|
+
* await discoveryengine.projects.locations.collections.engines.getWorkspaceSettings(
|
|
33558
|
+
* {
|
|
33559
|
+
* // Required. Full Engine resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
33560
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
33561
|
+
* },
|
|
33562
|
+
* );
|
|
33563
|
+
* console.log(res.data);
|
|
33564
|
+
*
|
|
33565
|
+
* // Example response
|
|
33566
|
+
* // {
|
|
33567
|
+
* // "customerDomainValid": false,
|
|
33568
|
+
* // "workspaceAccessEnabled": false
|
|
33569
|
+
* // }
|
|
33570
|
+
* }
|
|
33571
|
+
*
|
|
33572
|
+
* main().catch(e => {
|
|
33573
|
+
* console.error(e);
|
|
33574
|
+
* throw e;
|
|
33575
|
+
* });
|
|
33576
|
+
*
|
|
33577
|
+
* ```
|
|
33578
|
+
*
|
|
33579
|
+
* @param params - Parameters for request
|
|
33580
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33581
|
+
* @param callback - Optional callback that handles the response.
|
|
33582
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33583
|
+
*/
|
|
33584
|
+
getWorkspaceSettings(params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33585
|
+
getWorkspaceSettings(params?: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceSettings>>;
|
|
33586
|
+
getWorkspaceSettings(params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33587
|
+
getWorkspaceSettings(params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceSettings>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceSettings>): void;
|
|
33588
|
+
getWorkspaceSettings(params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceSettings>): void;
|
|
33589
|
+
getWorkspaceSettings(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceSettings>): void;
|
|
33590
|
+
/**
|
|
33591
|
+
* Lists all the Engines associated with the project.
|
|
32341
33592
|
* @example
|
|
32342
33593
|
* ```js
|
|
32343
33594
|
* // Before running the sample:
|
|
@@ -32457,6 +33708,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32457
33708
|
* // {
|
|
32458
33709
|
* // "agentGatewaySetting": {},
|
|
32459
33710
|
* // "appType": "my_appType",
|
|
33711
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32460
33712
|
* // "chatEngineConfig": {},
|
|
32461
33713
|
* // "chatEngineMetadata": {},
|
|
32462
33714
|
* // "cmekConfig": {},
|
|
@@ -32490,6 +33742,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32490
33742
|
* // {
|
|
32491
33743
|
* // "agentGatewaySetting": {},
|
|
32492
33744
|
* // "appType": "my_appType",
|
|
33745
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32493
33746
|
* // "chatEngineConfig": {},
|
|
32494
33747
|
* // "chatEngineMetadata": {},
|
|
32495
33748
|
* // "cmekConfig": {},
|
|
@@ -32586,6 +33839,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32586
33839
|
* // {
|
|
32587
33840
|
* // "agentGatewaySetting": {},
|
|
32588
33841
|
* // "appType": "my_appType",
|
|
33842
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32589
33843
|
* // "chatEngineConfig": {},
|
|
32590
33844
|
* // "chatEngineMetadata": {},
|
|
32591
33845
|
* // "cmekConfig": {},
|
|
@@ -32682,6 +33936,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32682
33936
|
* // {
|
|
32683
33937
|
* // "agentGatewaySetting": {},
|
|
32684
33938
|
* // "appType": "my_appType",
|
|
33939
|
+
* // "associatedAgentRegistry": "my_associatedAgentRegistry",
|
|
32685
33940
|
* // "chatEngineConfig": {},
|
|
32686
33941
|
* // "chatEngineMetadata": {},
|
|
32687
33942
|
* // "cmekConfig": {},
|
|
@@ -32879,6 +34134,101 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32879
34134
|
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
32880
34135
|
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
32881
34136
|
tune(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
34137
|
+
/**
|
|
34138
|
+
* Updates the CompletionConfigs.
|
|
34139
|
+
* @example
|
|
34140
|
+
* ```js
|
|
34141
|
+
* // Before running the sample:
|
|
34142
|
+
* // - Enable the API at:
|
|
34143
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
34144
|
+
* // - Login into gcloud by running:
|
|
34145
|
+
* // ```sh
|
|
34146
|
+
* // $ gcloud auth application-default login
|
|
34147
|
+
* // ```
|
|
34148
|
+
* // - Install the npm module by running:
|
|
34149
|
+
* // ```sh
|
|
34150
|
+
* // $ npm install googleapis
|
|
34151
|
+
* // ```
|
|
34152
|
+
*
|
|
34153
|
+
* const {google} = require('googleapis');
|
|
34154
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
34155
|
+
*
|
|
34156
|
+
* async function main() {
|
|
34157
|
+
* const auth = new google.auth.GoogleAuth({
|
|
34158
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
34159
|
+
* scopes: [
|
|
34160
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
34161
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
34162
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
34163
|
+
* ],
|
|
34164
|
+
* });
|
|
34165
|
+
*
|
|
34166
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
34167
|
+
* const authClient = await auth.getClient();
|
|
34168
|
+
* google.options({auth: authClient});
|
|
34169
|
+
*
|
|
34170
|
+
* // Do the magic
|
|
34171
|
+
* const res =
|
|
34172
|
+
* await discoveryengine.projects.locations.collections.engines.updateCompletionConfig(
|
|
34173
|
+
* {
|
|
34174
|
+
* // 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`
|
|
34175
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig',
|
|
34176
|
+
* // 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.
|
|
34177
|
+
* updateMask: 'placeholder-value',
|
|
34178
|
+
*
|
|
34179
|
+
* // Request body metadata
|
|
34180
|
+
* requestBody: {
|
|
34181
|
+
* // request body parameters
|
|
34182
|
+
* // {
|
|
34183
|
+
* // "enableMode": "my_enableMode",
|
|
34184
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
34185
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
34186
|
+
* // "maxSuggestions": 0,
|
|
34187
|
+
* // "minPrefixLength": 0,
|
|
34188
|
+
* // "name": "my_name",
|
|
34189
|
+
* // "numUniqueUsersThreshold": 0,
|
|
34190
|
+
* // "queryFrequencyThreshold": 0,
|
|
34191
|
+
* // "queryModel": "my_queryModel",
|
|
34192
|
+
* // "shouldServeContentSuggestions": false
|
|
34193
|
+
* // }
|
|
34194
|
+
* },
|
|
34195
|
+
* },
|
|
34196
|
+
* );
|
|
34197
|
+
* console.log(res.data);
|
|
34198
|
+
*
|
|
34199
|
+
* // Example response
|
|
34200
|
+
* // {
|
|
34201
|
+
* // "enableMode": "my_enableMode",
|
|
34202
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
34203
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
34204
|
+
* // "maxSuggestions": 0,
|
|
34205
|
+
* // "minPrefixLength": 0,
|
|
34206
|
+
* // "name": "my_name",
|
|
34207
|
+
* // "numUniqueUsersThreshold": 0,
|
|
34208
|
+
* // "queryFrequencyThreshold": 0,
|
|
34209
|
+
* // "queryModel": "my_queryModel",
|
|
34210
|
+
* // "shouldServeContentSuggestions": false
|
|
34211
|
+
* // }
|
|
34212
|
+
* }
|
|
34213
|
+
*
|
|
34214
|
+
* main().catch(e => {
|
|
34215
|
+
* console.error(e);
|
|
34216
|
+
* throw e;
|
|
34217
|
+
* });
|
|
34218
|
+
*
|
|
34219
|
+
* ```
|
|
34220
|
+
*
|
|
34221
|
+
* @param params - Parameters for request
|
|
34222
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
34223
|
+
* @param callback - Optional callback that handles the response.
|
|
34224
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
34225
|
+
*/
|
|
34226
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
34227
|
+
updateCompletionConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
34228
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
34229
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
34230
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
34231
|
+
updateCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
32882
34232
|
}
|
|
32883
34233
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
|
|
32884
34234
|
/**
|
|
@@ -32906,6 +34256,12 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32906
34256
|
*/
|
|
32907
34257
|
name?: string;
|
|
32908
34258
|
}
|
|
34259
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Getcompletionconfig extends StandardParameters {
|
|
34260
|
+
/**
|
|
34261
|
+
* 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`
|
|
34262
|
+
*/
|
|
34263
|
+
name?: string;
|
|
34264
|
+
}
|
|
32909
34265
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Getiampolicy extends StandardParameters {
|
|
32910
34266
|
/**
|
|
32911
34267
|
* 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 +34350,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32994
34350
|
*/
|
|
32995
34351
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest;
|
|
32996
34352
|
}
|
|
34353
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Updatecompletionconfig extends StandardParameters {
|
|
34354
|
+
/**
|
|
34355
|
+
* 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`
|
|
34356
|
+
*/
|
|
34357
|
+
name?: string;
|
|
34358
|
+
/**
|
|
34359
|
+
* 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.
|
|
34360
|
+
*/
|
|
34361
|
+
updateMask?: string;
|
|
34362
|
+
/**
|
|
34363
|
+
* Request body metadata
|
|
34364
|
+
*/
|
|
34365
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
34366
|
+
}
|
|
32997
34367
|
export class Resource$Projects$Locations$Collections$Engines$Analytics {
|
|
32998
34368
|
context: APIRequestContext;
|
|
32999
34369
|
constructor(context: APIRequestContext);
|
|
@@ -33736,6 +35106,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33736
35106
|
* // {
|
|
33737
35107
|
* // "answer": {},
|
|
33738
35108
|
* // "assistToken": "my_assistToken",
|
|
35109
|
+
* // "connectorAuthErrors": [],
|
|
33739
35110
|
* // "invocationTools": [],
|
|
33740
35111
|
* // "invokedSkills": [],
|
|
33741
35112
|
* // "sessionInfo": {}
|
|
@@ -33880,6 +35251,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33880
35251
|
* // "adkAgentDefinition": {},
|
|
33881
35252
|
* // "authorizationConfig": {},
|
|
33882
35253
|
* // "createTime": "my_createTime",
|
|
35254
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
33883
35255
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
33884
35256
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
33885
35257
|
* // "description": "my_description",
|
|
@@ -33908,6 +35280,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
33908
35280
|
* // "adkAgentDefinition": {},
|
|
33909
35281
|
* // "authorizationConfig": {},
|
|
33910
35282
|
* // "createTime": "my_createTime",
|
|
35283
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
33911
35284
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
33912
35285
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
33913
35286
|
* // "description": "my_description",
|
|
@@ -34067,6 +35440,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34067
35440
|
* // "adkAgentDefinition": {},
|
|
34068
35441
|
* // "authorizationConfig": {},
|
|
34069
35442
|
* // "createTime": "my_createTime",
|
|
35443
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
34070
35444
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
34071
35445
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
34072
35446
|
* // "description": "my_description",
|
|
@@ -34233,6 +35607,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34233
35607
|
* // "adkAgentDefinition": {},
|
|
34234
35608
|
* // "authorizationConfig": {},
|
|
34235
35609
|
* // "createTime": "my_createTime",
|
|
35610
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
34236
35611
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
34237
35612
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
34238
35613
|
* // "description": "my_description",
|
|
@@ -34261,6 +35636,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
34261
35636
|
* // "adkAgentDefinition": {},
|
|
34262
35637
|
* // "authorizationConfig": {},
|
|
34263
35638
|
* // "createTime": "my_createTime",
|
|
35639
|
+
* // "creationFailureReason": "my_creationFailureReason",
|
|
34264
35640
|
* // "customPlaceholderText": "my_customPlaceholderText",
|
|
34265
35641
|
* // "deploymentFailureReason": "my_deploymentFailureReason",
|
|
34266
35642
|
* // "description": "my_description",
|
|
@@ -37768,7 +39144,932 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37768
39144
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
37769
39145
|
* scopes: [
|
|
37770
39146
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
37771
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
39147
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
39148
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39149
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39150
|
+
* ],
|
|
39151
|
+
* });
|
|
39152
|
+
*
|
|
39153
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39154
|
+
* const authClient = await auth.getClient();
|
|
39155
|
+
* google.options({auth: authClient});
|
|
39156
|
+
*
|
|
39157
|
+
* // Do the magic
|
|
39158
|
+
* const res =
|
|
39159
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.list({
|
|
39160
|
+
* // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
39161
|
+
* filter: 'placeholder-value',
|
|
39162
|
+
* // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
39163
|
+
* orderBy: 'placeholder-value',
|
|
39164
|
+
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
39165
|
+
* pageSize: 'placeholder-value',
|
|
39166
|
+
* // A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
39167
|
+
* pageToken: 'placeholder-value',
|
|
39168
|
+
* // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
39169
|
+
* parent:
|
|
39170
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
39171
|
+
* });
|
|
39172
|
+
* console.log(res.data);
|
|
39173
|
+
*
|
|
39174
|
+
* // Example response
|
|
39175
|
+
* // {
|
|
39176
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
39177
|
+
* // "sessions": []
|
|
39178
|
+
* // }
|
|
39179
|
+
* }
|
|
39180
|
+
*
|
|
39181
|
+
* main().catch(e => {
|
|
39182
|
+
* console.error(e);
|
|
39183
|
+
* throw e;
|
|
39184
|
+
* });
|
|
39185
|
+
*
|
|
39186
|
+
* ```
|
|
39187
|
+
*
|
|
39188
|
+
* @param params - Parameters for request
|
|
39189
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39190
|
+
* @param callback - Optional callback that handles the response.
|
|
39191
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39192
|
+
*/
|
|
39193
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39194
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>>;
|
|
39195
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39196
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
39197
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
39198
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
39199
|
+
/**
|
|
39200
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
39201
|
+
* @example
|
|
39202
|
+
* ```js
|
|
39203
|
+
* // Before running the sample:
|
|
39204
|
+
* // - Enable the API at:
|
|
39205
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39206
|
+
* // - Login into gcloud by running:
|
|
39207
|
+
* // ```sh
|
|
39208
|
+
* // $ gcloud auth application-default login
|
|
39209
|
+
* // ```
|
|
39210
|
+
* // - Install the npm module by running:
|
|
39211
|
+
* // ```sh
|
|
39212
|
+
* // $ npm install googleapis
|
|
39213
|
+
* // ```
|
|
39214
|
+
*
|
|
39215
|
+
* const {google} = require('googleapis');
|
|
39216
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39217
|
+
*
|
|
39218
|
+
* async function main() {
|
|
39219
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39220
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39221
|
+
* scopes: [
|
|
39222
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39223
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
39224
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39225
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39226
|
+
* ],
|
|
39227
|
+
* });
|
|
39228
|
+
*
|
|
39229
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39230
|
+
* const authClient = await auth.getClient();
|
|
39231
|
+
* google.options({auth: authClient});
|
|
39232
|
+
*
|
|
39233
|
+
* // Do the magic
|
|
39234
|
+
* const res =
|
|
39235
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.patch(
|
|
39236
|
+
* {
|
|
39237
|
+
* // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
39238
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
39239
|
+
* // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
|
|
39240
|
+
* updateMask: 'placeholder-value',
|
|
39241
|
+
*
|
|
39242
|
+
* // Request body metadata
|
|
39243
|
+
* requestBody: {
|
|
39244
|
+
* // request body parameters
|
|
39245
|
+
* // {
|
|
39246
|
+
* // "displayName": "my_displayName",
|
|
39247
|
+
* // "endTime": "my_endTime",
|
|
39248
|
+
* // "isPinned": false,
|
|
39249
|
+
* // "labels": [],
|
|
39250
|
+
* // "name": "my_name",
|
|
39251
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
39252
|
+
* // "startTime": "my_startTime",
|
|
39253
|
+
* // "state": "my_state",
|
|
39254
|
+
* // "turns": [],
|
|
39255
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
39256
|
+
* // }
|
|
39257
|
+
* },
|
|
39258
|
+
* },
|
|
39259
|
+
* );
|
|
39260
|
+
* console.log(res.data);
|
|
39261
|
+
*
|
|
39262
|
+
* // Example response
|
|
39263
|
+
* // {
|
|
39264
|
+
* // "displayName": "my_displayName",
|
|
39265
|
+
* // "endTime": "my_endTime",
|
|
39266
|
+
* // "isPinned": false,
|
|
39267
|
+
* // "labels": [],
|
|
39268
|
+
* // "name": "my_name",
|
|
39269
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
39270
|
+
* // "startTime": "my_startTime",
|
|
39271
|
+
* // "state": "my_state",
|
|
39272
|
+
* // "turns": [],
|
|
39273
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
39274
|
+
* // }
|
|
39275
|
+
* }
|
|
39276
|
+
*
|
|
39277
|
+
* main().catch(e => {
|
|
39278
|
+
* console.error(e);
|
|
39279
|
+
* throw e;
|
|
39280
|
+
* });
|
|
39281
|
+
*
|
|
39282
|
+
* ```
|
|
39283
|
+
*
|
|
39284
|
+
* @param params - Parameters for request
|
|
39285
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39286
|
+
* @param callback - Optional callback that handles the response.
|
|
39287
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39288
|
+
*/
|
|
39289
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39290
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaSession>>;
|
|
39291
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39292
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
39293
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
39294
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
39295
|
+
}
|
|
39296
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters {
|
|
39297
|
+
/**
|
|
39298
|
+
* Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
39299
|
+
*/
|
|
39300
|
+
parent?: string;
|
|
39301
|
+
/**
|
|
39302
|
+
* Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61\}[a-z0-9]/. If not specified, a unique ID will be generated.
|
|
39303
|
+
*/
|
|
39304
|
+
sessionId?: string;
|
|
39305
|
+
/**
|
|
39306
|
+
* Request body metadata
|
|
39307
|
+
*/
|
|
39308
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
39309
|
+
}
|
|
39310
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters {
|
|
39311
|
+
/**
|
|
39312
|
+
* Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
39313
|
+
*/
|
|
39314
|
+
name?: string;
|
|
39315
|
+
}
|
|
39316
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters {
|
|
39317
|
+
/**
|
|
39318
|
+
* Optional. If set to true, the full session including all answer details will be returned.
|
|
39319
|
+
*/
|
|
39320
|
+
includeAnswerDetails?: boolean;
|
|
39321
|
+
/**
|
|
39322
|
+
* Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
39323
|
+
*/
|
|
39324
|
+
name?: string;
|
|
39325
|
+
}
|
|
39326
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters {
|
|
39327
|
+
/**
|
|
39328
|
+
* A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
39329
|
+
*/
|
|
39330
|
+
filter?: string;
|
|
39331
|
+
/**
|
|
39332
|
+
* A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
39333
|
+
*/
|
|
39334
|
+
orderBy?: string;
|
|
39335
|
+
/**
|
|
39336
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
39337
|
+
*/
|
|
39338
|
+
pageSize?: number;
|
|
39339
|
+
/**
|
|
39340
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
39341
|
+
*/
|
|
39342
|
+
pageToken?: string;
|
|
39343
|
+
/**
|
|
39344
|
+
* Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
39345
|
+
*/
|
|
39346
|
+
parent?: string;
|
|
39347
|
+
}
|
|
39348
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters {
|
|
39349
|
+
/**
|
|
39350
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
39351
|
+
*/
|
|
39352
|
+
name?: string;
|
|
39353
|
+
/**
|
|
39354
|
+
* Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
|
|
39355
|
+
*/
|
|
39356
|
+
updateMask?: string;
|
|
39357
|
+
/**
|
|
39358
|
+
* Request body metadata
|
|
39359
|
+
*/
|
|
39360
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
39361
|
+
}
|
|
39362
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments {
|
|
39363
|
+
context: APIRequestContext;
|
|
39364
|
+
alphaEvolvePrograms: Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms;
|
|
39365
|
+
operations: Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations;
|
|
39366
|
+
constructor(context: APIRequestContext);
|
|
39367
|
+
/**
|
|
39368
|
+
* Acquires one or more AlphaEvolveProgram from the generated queue of programs for evaluation.
|
|
39369
|
+
* @example
|
|
39370
|
+
* ```js
|
|
39371
|
+
* // Before running the sample:
|
|
39372
|
+
* // - Enable the API at:
|
|
39373
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39374
|
+
* // - Login into gcloud by running:
|
|
39375
|
+
* // ```sh
|
|
39376
|
+
* // $ gcloud auth application-default login
|
|
39377
|
+
* // ```
|
|
39378
|
+
* // - Install the npm module by running:
|
|
39379
|
+
* // ```sh
|
|
39380
|
+
* // $ npm install googleapis
|
|
39381
|
+
* // ```
|
|
39382
|
+
*
|
|
39383
|
+
* const {google} = require('googleapis');
|
|
39384
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39385
|
+
*
|
|
39386
|
+
* async function main() {
|
|
39387
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39388
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39389
|
+
* scopes: [
|
|
39390
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39391
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39392
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39393
|
+
* ],
|
|
39394
|
+
* });
|
|
39395
|
+
*
|
|
39396
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39397
|
+
* const authClient = await auth.getClient();
|
|
39398
|
+
* google.options({auth: authClient});
|
|
39399
|
+
*
|
|
39400
|
+
* // Do the magic
|
|
39401
|
+
* const res =
|
|
39402
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.acquirePrograms(
|
|
39403
|
+
* {
|
|
39404
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveExperiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39405
|
+
* parent:
|
|
39406
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39407
|
+
*
|
|
39408
|
+
* // Request body metadata
|
|
39409
|
+
* requestBody: {
|
|
39410
|
+
* // request body parameters
|
|
39411
|
+
* // {
|
|
39412
|
+
* // "desiredProgramsCount": 0
|
|
39413
|
+
* // }
|
|
39414
|
+
* },
|
|
39415
|
+
* },
|
|
39416
|
+
* );
|
|
39417
|
+
* console.log(res.data);
|
|
39418
|
+
*
|
|
39419
|
+
* // Example response
|
|
39420
|
+
* // {
|
|
39421
|
+
* // "programs": []
|
|
39422
|
+
* // }
|
|
39423
|
+
* }
|
|
39424
|
+
*
|
|
39425
|
+
* main().catch(e => {
|
|
39426
|
+
* console.error(e);
|
|
39427
|
+
* throw e;
|
|
39428
|
+
* });
|
|
39429
|
+
*
|
|
39430
|
+
* ```
|
|
39431
|
+
*
|
|
39432
|
+
* @param params - Parameters for request
|
|
39433
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39434
|
+
* @param callback - Optional callback that handles the response.
|
|
39435
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39436
|
+
*/
|
|
39437
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39438
|
+
acquirePrograms(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>>;
|
|
39439
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39440
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>): void;
|
|
39441
|
+
acquirePrograms(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>): void;
|
|
39442
|
+
acquirePrograms(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse>): void;
|
|
39443
|
+
/**
|
|
39444
|
+
* Creates a new AlphaEvolveExperiment.
|
|
39445
|
+
* @example
|
|
39446
|
+
* ```js
|
|
39447
|
+
* // Before running the sample:
|
|
39448
|
+
* // - Enable the API at:
|
|
39449
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39450
|
+
* // - Login into gcloud by running:
|
|
39451
|
+
* // ```sh
|
|
39452
|
+
* // $ gcloud auth application-default login
|
|
39453
|
+
* // ```
|
|
39454
|
+
* // - Install the npm module by running:
|
|
39455
|
+
* // ```sh
|
|
39456
|
+
* // $ npm install googleapis
|
|
39457
|
+
* // ```
|
|
39458
|
+
*
|
|
39459
|
+
* const {google} = require('googleapis');
|
|
39460
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39461
|
+
*
|
|
39462
|
+
* async function main() {
|
|
39463
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39464
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39465
|
+
* scopes: [
|
|
39466
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39467
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39468
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39469
|
+
* ],
|
|
39470
|
+
* });
|
|
39471
|
+
*
|
|
39472
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39473
|
+
* const authClient = await auth.getClient();
|
|
39474
|
+
* google.options({auth: authClient});
|
|
39475
|
+
*
|
|
39476
|
+
* // Do the magic
|
|
39477
|
+
* const res =
|
|
39478
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.create(
|
|
39479
|
+
* {
|
|
39480
|
+
* // Required. The parent resource name (Session) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
39481
|
+
* parent:
|
|
39482
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
39483
|
+
*
|
|
39484
|
+
* // Request body metadata
|
|
39485
|
+
* requestBody: {
|
|
39486
|
+
* // request body parameters
|
|
39487
|
+
* // {
|
|
39488
|
+
* // "config": {},
|
|
39489
|
+
* // "createTime": "my_createTime",
|
|
39490
|
+
* // "initialAlphaEvolveProgram": "my_initialAlphaEvolveProgram",
|
|
39491
|
+
* // "name": "my_name",
|
|
39492
|
+
* // "state": "my_state",
|
|
39493
|
+
* // "stats": {}
|
|
39494
|
+
* // }
|
|
39495
|
+
* },
|
|
39496
|
+
* },
|
|
39497
|
+
* );
|
|
39498
|
+
* console.log(res.data);
|
|
39499
|
+
*
|
|
39500
|
+
* // Example response
|
|
39501
|
+
* // {
|
|
39502
|
+
* // "config": {},
|
|
39503
|
+
* // "createTime": "my_createTime",
|
|
39504
|
+
* // "initialAlphaEvolveProgram": "my_initialAlphaEvolveProgram",
|
|
39505
|
+
* // "name": "my_name",
|
|
39506
|
+
* // "state": "my_state",
|
|
39507
|
+
* // "stats": {}
|
|
39508
|
+
* // }
|
|
39509
|
+
* }
|
|
39510
|
+
*
|
|
39511
|
+
* main().catch(e => {
|
|
39512
|
+
* console.error(e);
|
|
39513
|
+
* throw e;
|
|
39514
|
+
* });
|
|
39515
|
+
*
|
|
39516
|
+
* ```
|
|
39517
|
+
*
|
|
39518
|
+
* @param params - Parameters for request
|
|
39519
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39520
|
+
* @param callback - Optional callback that handles the response.
|
|
39521
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39522
|
+
*/
|
|
39523
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39524
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>>;
|
|
39525
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39526
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39527
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39528
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39529
|
+
/**
|
|
39530
|
+
* Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded).
|
|
39531
|
+
* @example
|
|
39532
|
+
* ```js
|
|
39533
|
+
* // Before running the sample:
|
|
39534
|
+
* // - Enable the API at:
|
|
39535
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39536
|
+
* // - Login into gcloud by running:
|
|
39537
|
+
* // ```sh
|
|
39538
|
+
* // $ gcloud auth application-default login
|
|
39539
|
+
* // ```
|
|
39540
|
+
* // - Install the npm module by running:
|
|
39541
|
+
* // ```sh
|
|
39542
|
+
* // $ npm install googleapis
|
|
39543
|
+
* // ```
|
|
39544
|
+
*
|
|
39545
|
+
* const {google} = require('googleapis');
|
|
39546
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39547
|
+
*
|
|
39548
|
+
* async function main() {
|
|
39549
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39550
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39551
|
+
* scopes: [
|
|
39552
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39553
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39554
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39555
|
+
* ],
|
|
39556
|
+
* });
|
|
39557
|
+
*
|
|
39558
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39559
|
+
* const authClient = await auth.getClient();
|
|
39560
|
+
* google.options({auth: authClient});
|
|
39561
|
+
*
|
|
39562
|
+
* // Do the magic
|
|
39563
|
+
* const res =
|
|
39564
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.delete(
|
|
39565
|
+
* {
|
|
39566
|
+
* // 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\}`
|
|
39567
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39568
|
+
* },
|
|
39569
|
+
* );
|
|
39570
|
+
* console.log(res.data);
|
|
39571
|
+
*
|
|
39572
|
+
* // Example response
|
|
39573
|
+
* // {}
|
|
39574
|
+
* }
|
|
39575
|
+
*
|
|
39576
|
+
* main().catch(e => {
|
|
39577
|
+
* console.error(e);
|
|
39578
|
+
* throw e;
|
|
39579
|
+
* });
|
|
39580
|
+
*
|
|
39581
|
+
* ```
|
|
39582
|
+
*
|
|
39583
|
+
* @param params - Parameters for request
|
|
39584
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39585
|
+
* @param callback - Optional callback that handles the response.
|
|
39586
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39587
|
+
*/
|
|
39588
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39589
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
39590
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39591
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
39592
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
39593
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
39594
|
+
/**
|
|
39595
|
+
* Get an existing AlphaEvolveExperiment.
|
|
39596
|
+
* @example
|
|
39597
|
+
* ```js
|
|
39598
|
+
* // Before running the sample:
|
|
39599
|
+
* // - Enable the API at:
|
|
39600
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39601
|
+
* // - Login into gcloud by running:
|
|
39602
|
+
* // ```sh
|
|
39603
|
+
* // $ gcloud auth application-default login
|
|
39604
|
+
* // ```
|
|
39605
|
+
* // - Install the npm module by running:
|
|
39606
|
+
* // ```sh
|
|
39607
|
+
* // $ npm install googleapis
|
|
39608
|
+
* // ```
|
|
39609
|
+
*
|
|
39610
|
+
* const {google} = require('googleapis');
|
|
39611
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39612
|
+
*
|
|
39613
|
+
* async function main() {
|
|
39614
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39615
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39616
|
+
* scopes: [
|
|
39617
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39618
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39619
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39620
|
+
* ],
|
|
39621
|
+
* });
|
|
39622
|
+
*
|
|
39623
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39624
|
+
* const authClient = await auth.getClient();
|
|
39625
|
+
* google.options({auth: authClient});
|
|
39626
|
+
*
|
|
39627
|
+
* // Do the magic
|
|
39628
|
+
* const res =
|
|
39629
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.get(
|
|
39630
|
+
* {
|
|
39631
|
+
* // Required. The full resource name of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39632
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39633
|
+
* },
|
|
39634
|
+
* );
|
|
39635
|
+
* console.log(res.data);
|
|
39636
|
+
*
|
|
39637
|
+
* // Example response
|
|
39638
|
+
* // {
|
|
39639
|
+
* // "config": {},
|
|
39640
|
+
* // "createTime": "my_createTime",
|
|
39641
|
+
* // "initialAlphaEvolveProgram": "my_initialAlphaEvolveProgram",
|
|
39642
|
+
* // "name": "my_name",
|
|
39643
|
+
* // "state": "my_state",
|
|
39644
|
+
* // "stats": {}
|
|
39645
|
+
* // }
|
|
39646
|
+
* }
|
|
39647
|
+
*
|
|
39648
|
+
* main().catch(e => {
|
|
39649
|
+
* console.error(e);
|
|
39650
|
+
* throw e;
|
|
39651
|
+
* });
|
|
39652
|
+
*
|
|
39653
|
+
* ```
|
|
39654
|
+
*
|
|
39655
|
+
* @param params - Parameters for request
|
|
39656
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39657
|
+
* @param callback - Optional callback that handles the response.
|
|
39658
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39659
|
+
*/
|
|
39660
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39661
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>>;
|
|
39662
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39663
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39664
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39665
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment>): void;
|
|
39666
|
+
/**
|
|
39667
|
+
* List all AlphaEvolveExperiments in a given session.
|
|
39668
|
+
* @example
|
|
39669
|
+
* ```js
|
|
39670
|
+
* // Before running the sample:
|
|
39671
|
+
* // - Enable the API at:
|
|
39672
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39673
|
+
* // - Login into gcloud by running:
|
|
39674
|
+
* // ```sh
|
|
39675
|
+
* // $ gcloud auth application-default login
|
|
39676
|
+
* // ```
|
|
39677
|
+
* // - Install the npm module by running:
|
|
39678
|
+
* // ```sh
|
|
39679
|
+
* // $ npm install googleapis
|
|
39680
|
+
* // ```
|
|
39681
|
+
*
|
|
39682
|
+
* const {google} = require('googleapis');
|
|
39683
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39684
|
+
*
|
|
39685
|
+
* async function main() {
|
|
39686
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39687
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39688
|
+
* scopes: [
|
|
39689
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39690
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39691
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39692
|
+
* ],
|
|
39693
|
+
* });
|
|
39694
|
+
*
|
|
39695
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39696
|
+
* const authClient = await auth.getClient();
|
|
39697
|
+
* google.options({auth: authClient});
|
|
39698
|
+
*
|
|
39699
|
+
* // Do the magic
|
|
39700
|
+
* const res =
|
|
39701
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.list(
|
|
39702
|
+
* {
|
|
39703
|
+
* // Optional. The maximum number of experiments to return. The service may return fewer than this value.
|
|
39704
|
+
* pageSize: 'placeholder-value',
|
|
39705
|
+
* // Optional. A page token, received from a previous `ListAlphaEvolveExperiments` call. Provide this to retrieve the subsequent page.
|
|
39706
|
+
* pageToken: 'placeholder-value',
|
|
39707
|
+
* // Required. The parent resource name (Session) of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
39708
|
+
* parent:
|
|
39709
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
39710
|
+
* },
|
|
39711
|
+
* );
|
|
39712
|
+
* console.log(res.data);
|
|
39713
|
+
*
|
|
39714
|
+
* // Example response
|
|
39715
|
+
* // {
|
|
39716
|
+
* // "alphaEvolveExperiments": [],
|
|
39717
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
39718
|
+
* // }
|
|
39719
|
+
* }
|
|
39720
|
+
*
|
|
39721
|
+
* main().catch(e => {
|
|
39722
|
+
* console.error(e);
|
|
39723
|
+
* throw e;
|
|
39724
|
+
* });
|
|
39725
|
+
*
|
|
39726
|
+
* ```
|
|
39727
|
+
*
|
|
39728
|
+
* @param params - Parameters for request
|
|
39729
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39730
|
+
* @param callback - Optional callback that handles the response.
|
|
39731
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39732
|
+
*/
|
|
39733
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39734
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>>;
|
|
39735
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39736
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>): void;
|
|
39737
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>): void;
|
|
39738
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse>): void;
|
|
39739
|
+
/**
|
|
39740
|
+
* Resumes a workflow to process the AlphaEvolveExperiment.
|
|
39741
|
+
* @example
|
|
39742
|
+
* ```js
|
|
39743
|
+
* // Before running the sample:
|
|
39744
|
+
* // - Enable the API at:
|
|
39745
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39746
|
+
* // - Login into gcloud by running:
|
|
39747
|
+
* // ```sh
|
|
39748
|
+
* // $ gcloud auth application-default login
|
|
39749
|
+
* // ```
|
|
39750
|
+
* // - Install the npm module by running:
|
|
39751
|
+
* // ```sh
|
|
39752
|
+
* // $ npm install googleapis
|
|
39753
|
+
* // ```
|
|
39754
|
+
*
|
|
39755
|
+
* const {google} = require('googleapis');
|
|
39756
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39757
|
+
*
|
|
39758
|
+
* async function main() {
|
|
39759
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39760
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39761
|
+
* scopes: [
|
|
39762
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39763
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39764
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39765
|
+
* ],
|
|
39766
|
+
* });
|
|
39767
|
+
*
|
|
39768
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39769
|
+
* const authClient = await auth.getClient();
|
|
39770
|
+
* google.options({auth: authClient});
|
|
39771
|
+
*
|
|
39772
|
+
* // Do the magic
|
|
39773
|
+
* const res =
|
|
39774
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.resume(
|
|
39775
|
+
* {
|
|
39776
|
+
* // Required. Experiment to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39777
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39778
|
+
*
|
|
39779
|
+
* // Request body metadata
|
|
39780
|
+
* requestBody: {
|
|
39781
|
+
* // request body parameters
|
|
39782
|
+
* // {}
|
|
39783
|
+
* },
|
|
39784
|
+
* },
|
|
39785
|
+
* );
|
|
39786
|
+
* console.log(res.data);
|
|
39787
|
+
*
|
|
39788
|
+
* // Example response
|
|
39789
|
+
* // {
|
|
39790
|
+
* // "done": false,
|
|
39791
|
+
* // "error": {},
|
|
39792
|
+
* // "metadata": {},
|
|
39793
|
+
* // "name": "my_name",
|
|
39794
|
+
* // "response": {}
|
|
39795
|
+
* // }
|
|
39796
|
+
* }
|
|
39797
|
+
*
|
|
39798
|
+
* main().catch(e => {
|
|
39799
|
+
* console.error(e);
|
|
39800
|
+
* throw e;
|
|
39801
|
+
* });
|
|
39802
|
+
*
|
|
39803
|
+
* ```
|
|
39804
|
+
*
|
|
39805
|
+
* @param params - Parameters for request
|
|
39806
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39807
|
+
* @param callback - Optional callback that handles the response.
|
|
39808
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39809
|
+
*/
|
|
39810
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39811
|
+
resume(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
39812
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39813
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39814
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39815
|
+
resume(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39816
|
+
/**
|
|
39817
|
+
* Starts a workflow to process the AlphaEvolveExperiment.
|
|
39818
|
+
* @example
|
|
39819
|
+
* ```js
|
|
39820
|
+
* // Before running the sample:
|
|
39821
|
+
* // - Enable the API at:
|
|
39822
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39823
|
+
* // - Login into gcloud by running:
|
|
39824
|
+
* // ```sh
|
|
39825
|
+
* // $ gcloud auth application-default login
|
|
39826
|
+
* // ```
|
|
39827
|
+
* // - Install the npm module by running:
|
|
39828
|
+
* // ```sh
|
|
39829
|
+
* // $ npm install googleapis
|
|
39830
|
+
* // ```
|
|
39831
|
+
*
|
|
39832
|
+
* const {google} = require('googleapis');
|
|
39833
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39834
|
+
*
|
|
39835
|
+
* async function main() {
|
|
39836
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39837
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39838
|
+
* scopes: [
|
|
39839
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39840
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39841
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39842
|
+
* ],
|
|
39843
|
+
* });
|
|
39844
|
+
*
|
|
39845
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39846
|
+
* const authClient = await auth.getClient();
|
|
39847
|
+
* google.options({auth: authClient});
|
|
39848
|
+
*
|
|
39849
|
+
* // Do the magic
|
|
39850
|
+
* const res =
|
|
39851
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.start(
|
|
39852
|
+
* {
|
|
39853
|
+
* // Required. Experiment to start. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39854
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39855
|
+
*
|
|
39856
|
+
* // Request body metadata
|
|
39857
|
+
* requestBody: {
|
|
39858
|
+
* // request body parameters
|
|
39859
|
+
* // {
|
|
39860
|
+
* // "name": "my_name"
|
|
39861
|
+
* // }
|
|
39862
|
+
* },
|
|
39863
|
+
* },
|
|
39864
|
+
* );
|
|
39865
|
+
* console.log(res.data);
|
|
39866
|
+
*
|
|
39867
|
+
* // Example response
|
|
39868
|
+
* // {
|
|
39869
|
+
* // "done": false,
|
|
39870
|
+
* // "error": {},
|
|
39871
|
+
* // "metadata": {},
|
|
39872
|
+
* // "name": "my_name",
|
|
39873
|
+
* // "response": {}
|
|
39874
|
+
* // }
|
|
39875
|
+
* }
|
|
39876
|
+
*
|
|
39877
|
+
* main().catch(e => {
|
|
39878
|
+
* console.error(e);
|
|
39879
|
+
* throw e;
|
|
39880
|
+
* });
|
|
39881
|
+
*
|
|
39882
|
+
* ```
|
|
39883
|
+
*
|
|
39884
|
+
* @param params - Parameters for request
|
|
39885
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39886
|
+
* @param callback - Optional callback that handles the response.
|
|
39887
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39888
|
+
*/
|
|
39889
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39890
|
+
start(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
39891
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39892
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39893
|
+
start(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39894
|
+
start(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39895
|
+
/**
|
|
39896
|
+
* Adds an AlphaEvolveProgramEvaluation to the experiment.
|
|
39897
|
+
* @example
|
|
39898
|
+
* ```js
|
|
39899
|
+
* // Before running the sample:
|
|
39900
|
+
* // - Enable the API at:
|
|
39901
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39902
|
+
* // - Login into gcloud by running:
|
|
39903
|
+
* // ```sh
|
|
39904
|
+
* // $ gcloud auth application-default login
|
|
39905
|
+
* // ```
|
|
39906
|
+
* // - Install the npm module by running:
|
|
39907
|
+
* // ```sh
|
|
39908
|
+
* // $ npm install googleapis
|
|
39909
|
+
* // ```
|
|
39910
|
+
*
|
|
39911
|
+
* const {google} = require('googleapis');
|
|
39912
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
39913
|
+
*
|
|
39914
|
+
* async function main() {
|
|
39915
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39916
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39917
|
+
* scopes: [
|
|
39918
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39919
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39920
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39921
|
+
* ],
|
|
39922
|
+
* });
|
|
39923
|
+
*
|
|
39924
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39925
|
+
* const authClient = await auth.getClient();
|
|
39926
|
+
* google.options({auth: authClient});
|
|
39927
|
+
*
|
|
39928
|
+
* // Do the magic
|
|
39929
|
+
* const res =
|
|
39930
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.submitProgramsEvaluations(
|
|
39931
|
+
* {
|
|
39932
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39933
|
+
* parent:
|
|
39934
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
39935
|
+
*
|
|
39936
|
+
* // Request body metadata
|
|
39937
|
+
* requestBody: {
|
|
39938
|
+
* // request body parameters
|
|
39939
|
+
* // {
|
|
39940
|
+
* // "evaluationSubmissions": []
|
|
39941
|
+
* // }
|
|
39942
|
+
* },
|
|
39943
|
+
* },
|
|
39944
|
+
* );
|
|
39945
|
+
* console.log(res.data);
|
|
39946
|
+
*
|
|
39947
|
+
* // Example response
|
|
39948
|
+
* // {}
|
|
39949
|
+
* }
|
|
39950
|
+
*
|
|
39951
|
+
* main().catch(e => {
|
|
39952
|
+
* console.error(e);
|
|
39953
|
+
* throw e;
|
|
39954
|
+
* });
|
|
39955
|
+
*
|
|
39956
|
+
* ```
|
|
39957
|
+
*
|
|
39958
|
+
* @param params - Parameters for request
|
|
39959
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39960
|
+
* @param callback - Optional callback that handles the response.
|
|
39961
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39962
|
+
*/
|
|
39963
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39964
|
+
submitProgramsEvaluations(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>>;
|
|
39965
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39966
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>): void;
|
|
39967
|
+
submitProgramsEvaluations(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>): void;
|
|
39968
|
+
submitProgramsEvaluations(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse>): void;
|
|
39969
|
+
}
|
|
39970
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Acquireprograms extends StandardParameters {
|
|
39971
|
+
/**
|
|
39972
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveExperiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39973
|
+
*/
|
|
39974
|
+
parent?: string;
|
|
39975
|
+
/**
|
|
39976
|
+
* Request body metadata
|
|
39977
|
+
*/
|
|
39978
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAcquireProgramsRequest;
|
|
39979
|
+
}
|
|
39980
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Create extends StandardParameters {
|
|
39981
|
+
/**
|
|
39982
|
+
* Required. The parent resource name (Session) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
39983
|
+
*/
|
|
39984
|
+
parent?: string;
|
|
39985
|
+
/**
|
|
39986
|
+
* Request body metadata
|
|
39987
|
+
*/
|
|
39988
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment;
|
|
39989
|
+
}
|
|
39990
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Delete extends StandardParameters {
|
|
39991
|
+
/**
|
|
39992
|
+
* 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\}`
|
|
39993
|
+
*/
|
|
39994
|
+
name?: string;
|
|
39995
|
+
}
|
|
39996
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Get extends StandardParameters {
|
|
39997
|
+
/**
|
|
39998
|
+
* Required. The full resource name of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
39999
|
+
*/
|
|
40000
|
+
name?: string;
|
|
40001
|
+
}
|
|
40002
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$List extends StandardParameters {
|
|
40003
|
+
/**
|
|
40004
|
+
* Optional. The maximum number of experiments to return. The service may return fewer than this value.
|
|
40005
|
+
*/
|
|
40006
|
+
pageSize?: number;
|
|
40007
|
+
/**
|
|
40008
|
+
* Optional. A page token, received from a previous `ListAlphaEvolveExperiments` call. Provide this to retrieve the subsequent page.
|
|
40009
|
+
*/
|
|
40010
|
+
pageToken?: string;
|
|
40011
|
+
/**
|
|
40012
|
+
* Required. The parent resource name (Session) of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}`
|
|
40013
|
+
*/
|
|
40014
|
+
parent?: string;
|
|
40015
|
+
}
|
|
40016
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Resume extends StandardParameters {
|
|
40017
|
+
/**
|
|
40018
|
+
* Required. Experiment to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40019
|
+
*/
|
|
40020
|
+
name?: string;
|
|
40021
|
+
/**
|
|
40022
|
+
* Request body metadata
|
|
40023
|
+
*/
|
|
40024
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest;
|
|
40025
|
+
}
|
|
40026
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Start extends StandardParameters {
|
|
40027
|
+
/**
|
|
40028
|
+
* Required. Experiment to start. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40029
|
+
*/
|
|
40030
|
+
name?: string;
|
|
40031
|
+
/**
|
|
40032
|
+
* Request body metadata
|
|
40033
|
+
*/
|
|
40034
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStartExperimentRequest;
|
|
40035
|
+
}
|
|
40036
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Submitprogramsevaluations extends StandardParameters {
|
|
40037
|
+
/**
|
|
40038
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40039
|
+
*/
|
|
40040
|
+
parent?: string;
|
|
40041
|
+
/**
|
|
40042
|
+
* Request body metadata
|
|
40043
|
+
*/
|
|
40044
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest;
|
|
40045
|
+
}
|
|
40046
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms {
|
|
40047
|
+
context: APIRequestContext;
|
|
40048
|
+
constructor(context: APIRequestContext);
|
|
40049
|
+
/**
|
|
40050
|
+
* Creates a new AlphaEvolveProgram.
|
|
40051
|
+
* @example
|
|
40052
|
+
* ```js
|
|
40053
|
+
* // Before running the sample:
|
|
40054
|
+
* // - Enable the API at:
|
|
40055
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40056
|
+
* // - Login into gcloud by running:
|
|
40057
|
+
* // ```sh
|
|
40058
|
+
* // $ gcloud auth application-default login
|
|
40059
|
+
* // ```
|
|
40060
|
+
* // - Install the npm module by running:
|
|
40061
|
+
* // ```sh
|
|
40062
|
+
* // $ npm install googleapis
|
|
40063
|
+
* // ```
|
|
40064
|
+
*
|
|
40065
|
+
* const {google} = require('googleapis');
|
|
40066
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40067
|
+
*
|
|
40068
|
+
* async function main() {
|
|
40069
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40070
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40071
|
+
* scopes: [
|
|
40072
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
37772
40073
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
37773
40074
|
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
37774
40075
|
* ],
|
|
@@ -37780,25 +40081,38 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37780
40081
|
*
|
|
37781
40082
|
* // Do the magic
|
|
37782
40083
|
* const res =
|
|
37783
|
-
* await discoveryengine.projects.locations.collections.engines.sessions.
|
|
37784
|
-
*
|
|
37785
|
-
*
|
|
37786
|
-
*
|
|
37787
|
-
*
|
|
37788
|
-
*
|
|
37789
|
-
*
|
|
37790
|
-
*
|
|
37791
|
-
*
|
|
37792
|
-
*
|
|
37793
|
-
*
|
|
37794
|
-
*
|
|
37795
|
-
*
|
|
40084
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.create(
|
|
40085
|
+
* {
|
|
40086
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveProgram. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40087
|
+
* parent:
|
|
40088
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
40089
|
+
*
|
|
40090
|
+
* // Request body metadata
|
|
40091
|
+
* requestBody: {
|
|
40092
|
+
* // request body parameters
|
|
40093
|
+
* // {
|
|
40094
|
+
* // "content": {},
|
|
40095
|
+
* // "createTime": "my_createTime",
|
|
40096
|
+
* // "evaluation": {},
|
|
40097
|
+
* // "lockToken": "my_lockToken",
|
|
40098
|
+
* // "name": "my_name",
|
|
40099
|
+
* // "parentPrograms": [],
|
|
40100
|
+
* // "state": "my_state"
|
|
40101
|
+
* // }
|
|
40102
|
+
* },
|
|
40103
|
+
* },
|
|
40104
|
+
* );
|
|
37796
40105
|
* console.log(res.data);
|
|
37797
40106
|
*
|
|
37798
40107
|
* // Example response
|
|
37799
40108
|
* // {
|
|
37800
|
-
* // "
|
|
37801
|
-
* // "
|
|
40109
|
+
* // "content": {},
|
|
40110
|
+
* // "createTime": "my_createTime",
|
|
40111
|
+
* // "evaluation": {},
|
|
40112
|
+
* // "lockToken": "my_lockToken",
|
|
40113
|
+
* // "name": "my_name",
|
|
40114
|
+
* // "parentPrograms": [],
|
|
40115
|
+
* // "state": "my_state"
|
|
37802
40116
|
* // }
|
|
37803
40117
|
* }
|
|
37804
40118
|
*
|
|
@@ -37814,14 +40128,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37814
40128
|
* @param callback - Optional callback that handles the response.
|
|
37815
40129
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
37816
40130
|
*/
|
|
37817
|
-
|
|
37818
|
-
|
|
37819
|
-
|
|
37820
|
-
|
|
37821
|
-
|
|
37822
|
-
|
|
40131
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40132
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>>;
|
|
40133
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40134
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40135
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40136
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
37823
40137
|
/**
|
|
37824
|
-
*
|
|
40138
|
+
* Gets an existing AlphaEvolveProgram.
|
|
37825
40139
|
* @example
|
|
37826
40140
|
* ```js
|
|
37827
40141
|
* // Before running the sample:
|
|
@@ -37844,7 +40158,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37844
40158
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
37845
40159
|
* scopes: [
|
|
37846
40160
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
37847
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
37848
40161
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
37849
40162
|
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
37850
40163
|
* ],
|
|
@@ -37856,45 +40169,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37856
40169
|
*
|
|
37857
40170
|
* // Do the magic
|
|
37858
40171
|
* const res =
|
|
37859
|
-
* await discoveryengine.projects.locations.collections.engines.sessions.
|
|
40172
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.get(
|
|
37860
40173
|
* {
|
|
37861
|
-
* //
|
|
37862
|
-
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session',
|
|
37863
|
-
* // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
|
|
37864
|
-
* updateMask: 'placeholder-value',
|
|
37865
|
-
*
|
|
37866
|
-
* // Request body metadata
|
|
37867
|
-
* requestBody: {
|
|
37868
|
-
* // request body parameters
|
|
37869
|
-
* // {
|
|
37870
|
-
* // "displayName": "my_displayName",
|
|
37871
|
-
* // "endTime": "my_endTime",
|
|
37872
|
-
* // "isPinned": false,
|
|
37873
|
-
* // "labels": [],
|
|
37874
|
-
* // "name": "my_name",
|
|
37875
|
-
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
37876
|
-
* // "startTime": "my_startTime",
|
|
37877
|
-
* // "state": "my_state",
|
|
37878
|
-
* // "turns": [],
|
|
37879
|
-
* // "userPseudoId": "my_userPseudoId"
|
|
37880
|
-
* // }
|
|
37881
|
-
* },
|
|
40174
|
+
* // 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\}`
|
|
40175
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment/alphaEvolvePrograms/my-alphaEvolveProgram',
|
|
37882
40176
|
* },
|
|
37883
40177
|
* );
|
|
37884
40178
|
* console.log(res.data);
|
|
37885
40179
|
*
|
|
37886
40180
|
* // Example response
|
|
37887
40181
|
* // {
|
|
37888
|
-
* // "
|
|
37889
|
-
* // "
|
|
37890
|
-
* // "
|
|
37891
|
-
* // "
|
|
40182
|
+
* // "content": {},
|
|
40183
|
+
* // "createTime": "my_createTime",
|
|
40184
|
+
* // "evaluation": {},
|
|
40185
|
+
* // "lockToken": "my_lockToken",
|
|
37892
40186
|
* // "name": "my_name",
|
|
37893
|
-
* // "
|
|
37894
|
-
* // "
|
|
37895
|
-
* // "state": "my_state",
|
|
37896
|
-
* // "turns": [],
|
|
37897
|
-
* // "userPseudoId": "my_userPseudoId"
|
|
40187
|
+
* // "parentPrograms": [],
|
|
40188
|
+
* // "state": "my_state"
|
|
37898
40189
|
* // }
|
|
37899
40190
|
* }
|
|
37900
40191
|
*
|
|
@@ -37910,83 +40201,127 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37910
40201
|
* @param callback - Optional callback that handles the response.
|
|
37911
40202
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
37912
40203
|
*/
|
|
37913
|
-
|
|
37914
|
-
|
|
37915
|
-
|
|
37916
|
-
|
|
37917
|
-
|
|
37918
|
-
|
|
37919
|
-
}
|
|
37920
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters {
|
|
40204
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40205
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>>;
|
|
40206
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40207
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40208
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
40209
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram>): void;
|
|
37921
40210
|
/**
|
|
37922
|
-
*
|
|
40211
|
+
* List all AlphaEvolvePrograms in a given experiment that follow the criteria provided in the request.
|
|
40212
|
+
* @example
|
|
40213
|
+
* ```js
|
|
40214
|
+
* // Before running the sample:
|
|
40215
|
+
* // - Enable the API at:
|
|
40216
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
40217
|
+
* // - Login into gcloud by running:
|
|
40218
|
+
* // ```sh
|
|
40219
|
+
* // $ gcloud auth application-default login
|
|
40220
|
+
* // ```
|
|
40221
|
+
* // - Install the npm module by running:
|
|
40222
|
+
* // ```sh
|
|
40223
|
+
* // $ npm install googleapis
|
|
40224
|
+
* // ```
|
|
40225
|
+
*
|
|
40226
|
+
* const {google} = require('googleapis');
|
|
40227
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
40228
|
+
*
|
|
40229
|
+
* async function main() {
|
|
40230
|
+
* const auth = new google.auth.GoogleAuth({
|
|
40231
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
40232
|
+
* scopes: [
|
|
40233
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
40234
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
40235
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
40236
|
+
* ],
|
|
40237
|
+
* });
|
|
40238
|
+
*
|
|
40239
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
40240
|
+
* const authClient = await auth.getClient();
|
|
40241
|
+
* google.options({auth: authClient});
|
|
40242
|
+
*
|
|
40243
|
+
* // Do the magic
|
|
40244
|
+
* const res =
|
|
40245
|
+
* await discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.list(
|
|
40246
|
+
* {
|
|
40247
|
+
* // 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.
|
|
40248
|
+
* orderBy: 'placeholder-value',
|
|
40249
|
+
* // Optional. The maximum number of programs to return. The service may return fewer than this value.
|
|
40250
|
+
* pageSize: 'placeholder-value',
|
|
40251
|
+
* // Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page.
|
|
40252
|
+
* pageToken: 'placeholder-value',
|
|
40253
|
+
* // Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
40254
|
+
* parent:
|
|
40255
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/alphaEvolveExperiments/my-alphaEvolveExperiment',
|
|
40256
|
+
* // 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.
|
|
40257
|
+
* stateFilter: 'placeholder-value',
|
|
40258
|
+
* },
|
|
40259
|
+
* );
|
|
40260
|
+
* console.log(res.data);
|
|
40261
|
+
*
|
|
40262
|
+
* // Example response
|
|
40263
|
+
* // {
|
|
40264
|
+
* // "alphaEvolvePrograms": [],
|
|
40265
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
40266
|
+
* // }
|
|
40267
|
+
* }
|
|
40268
|
+
*
|
|
40269
|
+
* main().catch(e => {
|
|
40270
|
+
* console.error(e);
|
|
40271
|
+
* throw e;
|
|
40272
|
+
* });
|
|
40273
|
+
*
|
|
40274
|
+
* ```
|
|
40275
|
+
*
|
|
40276
|
+
* @param params - Parameters for request
|
|
40277
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
40278
|
+
* @param callback - Optional callback that handles the response.
|
|
40279
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
37923
40280
|
*/
|
|
37924
|
-
|
|
40281
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
40282
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>>;
|
|
40283
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
40284
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>): void;
|
|
40285
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>): void;
|
|
40286
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse>): void;
|
|
40287
|
+
}
|
|
40288
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Create extends StandardParameters {
|
|
37925
40289
|
/**
|
|
37926
|
-
*
|
|
40290
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveProgram. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
37927
40291
|
*/
|
|
37928
|
-
|
|
40292
|
+
parent?: string;
|
|
37929
40293
|
/**
|
|
37930
40294
|
* Request body metadata
|
|
37931
40295
|
*/
|
|
37932
|
-
requestBody?: Schema$
|
|
37933
|
-
}
|
|
37934
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters {
|
|
37935
|
-
/**
|
|
37936
|
-
* Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
37937
|
-
*/
|
|
37938
|
-
name?: string;
|
|
40296
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram;
|
|
37939
40297
|
}
|
|
37940
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters {
|
|
40298
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$Get extends StandardParameters {
|
|
37941
40299
|
/**
|
|
37942
|
-
*
|
|
37943
|
-
*/
|
|
37944
|
-
includeAnswerDetails?: boolean;
|
|
37945
|
-
/**
|
|
37946
|
-
* Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
40300
|
+
* 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\}`
|
|
37947
40301
|
*/
|
|
37948
40302
|
name?: string;
|
|
37949
40303
|
}
|
|
37950
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters {
|
|
37951
|
-
/**
|
|
37952
|
-
* A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
37953
|
-
*/
|
|
37954
|
-
filter?: string;
|
|
40304
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Alphaevolveprograms$List extends StandardParameters {
|
|
37955
40305
|
/**
|
|
37956
|
-
*
|
|
40306
|
+
* 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.
|
|
37957
40307
|
*/
|
|
37958
40308
|
orderBy?: string;
|
|
37959
40309
|
/**
|
|
37960
|
-
*
|
|
40310
|
+
* Optional. The maximum number of programs to return. The service may return fewer than this value.
|
|
37961
40311
|
*/
|
|
37962
40312
|
pageSize?: number;
|
|
37963
40313
|
/**
|
|
37964
|
-
* A page token, received from a previous `
|
|
40314
|
+
* Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page.
|
|
37965
40315
|
*/
|
|
37966
40316
|
pageToken?: string;
|
|
37967
40317
|
/**
|
|
37968
|
-
* Required. The
|
|
40318
|
+
* Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/alphaEvolveExperiments/{alpha_evolve_experiment\}`
|
|
37969
40319
|
*/
|
|
37970
40320
|
parent?: string;
|
|
37971
|
-
}
|
|
37972
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters {
|
|
37973
40321
|
/**
|
|
37974
|
-
*
|
|
37975
|
-
*/
|
|
37976
|
-
name?: string;
|
|
37977
|
-
/**
|
|
37978
|
-
* Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.
|
|
40322
|
+
* 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.
|
|
37979
40323
|
*/
|
|
37980
|
-
|
|
37981
|
-
/**
|
|
37982
|
-
* Request body metadata
|
|
37983
|
-
*/
|
|
37984
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
37985
|
-
}
|
|
37986
|
-
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments {
|
|
37987
|
-
context: APIRequestContext;
|
|
37988
|
-
operations: Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations;
|
|
37989
|
-
constructor(context: APIRequestContext);
|
|
40324
|
+
stateFilter?: string;
|
|
37990
40325
|
}
|
|
37991
40326
|
export class Resource$Projects$Locations$Collections$Engines$Sessions$Alphaevolveexperiments$Operations {
|
|
37992
40327
|
context: APIRequestContext;
|
|
@@ -38391,6 +40726,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38391
40726
|
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
38392
40727
|
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
38393
40728
|
* 'placeholder-value',
|
|
40729
|
+
* // 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).
|
|
40730
|
+
* languageCode: 'placeholder-value',
|
|
40731
|
+
* // 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`).
|
|
40732
|
+
* modelInfoView: 'placeholder-value',
|
|
38394
40733
|
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
38395
40734
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
38396
40735
|
* },
|
|
@@ -38403,6 +40742,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38403
40742
|
* // "allowPublicAccess": false,
|
|
38404
40743
|
* // "allowlistedDomains": [],
|
|
38405
40744
|
* // "assistantSettings": {},
|
|
40745
|
+
* // "batchAuthStatuses": [],
|
|
38406
40746
|
* // "collectionComponents": [],
|
|
38407
40747
|
* // "configId": "my_configId",
|
|
38408
40748
|
* // "contentSearchSpec": {},
|
|
@@ -38508,6 +40848,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38508
40848
|
* // "allowPublicAccess": false,
|
|
38509
40849
|
* // "allowlistedDomains": [],
|
|
38510
40850
|
* // "assistantSettings": {},
|
|
40851
|
+
* // "batchAuthStatuses": [],
|
|
38511
40852
|
* // "collectionComponents": [],
|
|
38512
40853
|
* // "configId": "my_configId",
|
|
38513
40854
|
* // "contentSearchSpec": {},
|
|
@@ -38553,6 +40894,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38553
40894
|
* // "allowPublicAccess": false,
|
|
38554
40895
|
* // "allowlistedDomains": [],
|
|
38555
40896
|
* // "assistantSettings": {},
|
|
40897
|
+
* // "batchAuthStatuses": [],
|
|
38556
40898
|
* // "collectionComponents": [],
|
|
38557
40899
|
* // "configId": "my_configId",
|
|
38558
40900
|
* // "contentSearchSpec": {},
|
|
@@ -38617,6 +40959,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38617
40959
|
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
38618
40960
|
*/
|
|
38619
40961
|
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
40962
|
+
/**
|
|
40963
|
+
* 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).
|
|
40964
|
+
*/
|
|
40965
|
+
languageCode?: string;
|
|
40966
|
+
/**
|
|
40967
|
+
* 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`).
|
|
40968
|
+
*/
|
|
40969
|
+
modelInfoView?: string;
|
|
38620
40970
|
/**
|
|
38621
40971
|
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
38622
40972
|
*/
|
|
@@ -39052,6 +41402,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39052
41402
|
* // "documentProcessingConfig": {},
|
|
39053
41403
|
* // "federatedSearchConfig": {},
|
|
39054
41404
|
* // "healthcareFhirConfig": {},
|
|
41405
|
+
* // "iconUri": "my_iconUri",
|
|
39055
41406
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
39056
41407
|
* // "idpConfig": {},
|
|
39057
41408
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -39200,29 +41551,122 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39200
41551
|
* google.options({auth: authClient});
|
|
39201
41552
|
*
|
|
39202
41553
|
* // 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
|
-
* });
|
|
41554
|
+
* const res =
|
|
41555
|
+
* await discoveryengine.projects.locations.dataStores.deletePatientFilter({
|
|
41556
|
+
* // 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.
|
|
41557
|
+
* dataStore:
|
|
41558
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
41559
|
+
*
|
|
41560
|
+
* // Request body metadata
|
|
41561
|
+
* requestBody: {
|
|
41562
|
+
* // request body parameters
|
|
41563
|
+
* // {
|
|
41564
|
+
* // "dataStore": "my_dataStore"
|
|
41565
|
+
* // }
|
|
41566
|
+
* },
|
|
41567
|
+
* });
|
|
41568
|
+
* console.log(res.data);
|
|
41569
|
+
*
|
|
41570
|
+
* // Example response
|
|
41571
|
+
* // {
|
|
41572
|
+
* // "done": false,
|
|
41573
|
+
* // "error": {},
|
|
41574
|
+
* // "metadata": {},
|
|
41575
|
+
* // "name": "my_name",
|
|
41576
|
+
* // "response": {}
|
|
41577
|
+
* // }
|
|
41578
|
+
* }
|
|
41579
|
+
*
|
|
41580
|
+
* main().catch(e => {
|
|
41581
|
+
* console.error(e);
|
|
41582
|
+
* throw e;
|
|
41583
|
+
* });
|
|
41584
|
+
*
|
|
41585
|
+
* ```
|
|
41586
|
+
*
|
|
41587
|
+
* @param params - Parameters for request
|
|
41588
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
41589
|
+
* @param callback - Optional callback that handles the response.
|
|
41590
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
41591
|
+
*/
|
|
41592
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41593
|
+
deletePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
41594
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41595
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41596
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41597
|
+
deletePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
41598
|
+
/**
|
|
41599
|
+
* Gets a DataStore.
|
|
41600
|
+
* @example
|
|
41601
|
+
* ```js
|
|
41602
|
+
* // Before running the sample:
|
|
41603
|
+
* // - Enable the API at:
|
|
41604
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
41605
|
+
* // - Login into gcloud by running:
|
|
41606
|
+
* // ```sh
|
|
41607
|
+
* // $ gcloud auth application-default login
|
|
41608
|
+
* // ```
|
|
41609
|
+
* // - Install the npm module by running:
|
|
41610
|
+
* // ```sh
|
|
41611
|
+
* // $ npm install googleapis
|
|
41612
|
+
* // ```
|
|
41613
|
+
*
|
|
41614
|
+
* const {google} = require('googleapis');
|
|
41615
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
41616
|
+
*
|
|
41617
|
+
* async function main() {
|
|
41618
|
+
* const auth = new google.auth.GoogleAuth({
|
|
41619
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
41620
|
+
* scopes: [
|
|
41621
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
41622
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
41623
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
41624
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
41625
|
+
* ],
|
|
41626
|
+
* });
|
|
41627
|
+
*
|
|
41628
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
41629
|
+
* const authClient = await auth.getClient();
|
|
41630
|
+
* google.options({auth: authClient});
|
|
41631
|
+
*
|
|
41632
|
+
* // Do the magic
|
|
41633
|
+
* const res = await discoveryengine.projects.locations.dataStores.get({
|
|
41634
|
+
* // 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.
|
|
41635
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
41636
|
+
* // 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.
|
|
41637
|
+
* view: 'placeholder-value',
|
|
41638
|
+
* });
|
|
39217
41639
|
* console.log(res.data);
|
|
39218
41640
|
*
|
|
39219
41641
|
* // Example response
|
|
39220
41642
|
* // {
|
|
39221
|
-
* // "
|
|
39222
|
-
* // "
|
|
39223
|
-
* // "
|
|
41643
|
+
* // "aclEnabled": false,
|
|
41644
|
+
* // "advancedSiteSearchConfig": {},
|
|
41645
|
+
* // "billingEstimation": {},
|
|
41646
|
+
* // "cmekConfig": {},
|
|
41647
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
41648
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
41649
|
+
* // "contentConfig": "my_contentConfig",
|
|
41650
|
+
* // "createTime": "my_createTime",
|
|
41651
|
+
* // "dataProtectionPolicy": {},
|
|
41652
|
+
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
41653
|
+
* // "displayName": "my_displayName",
|
|
41654
|
+
* // "documentProcessingConfig": {},
|
|
41655
|
+
* // "federatedSearchConfig": {},
|
|
41656
|
+
* // "healthcareFhirConfig": {},
|
|
41657
|
+
* // "iconUri": "my_iconUri",
|
|
41658
|
+
* // "identityMappingStore": "my_identityMappingStore",
|
|
41659
|
+
* // "idpConfig": {},
|
|
41660
|
+
* // "industryVertical": "my_industryVertical",
|
|
41661
|
+
* // "isInfobotFaqDataStore": false,
|
|
41662
|
+
* // "kmsKeyName": "my_kmsKeyName",
|
|
41663
|
+
* // "languageInfo": {},
|
|
39224
41664
|
* // "name": "my_name",
|
|
39225
|
-
* // "
|
|
41665
|
+
* // "naturalLanguageQueryUnderstandingConfig": {},
|
|
41666
|
+
* // "servingConfigDataStore": {},
|
|
41667
|
+
* // "solutionTypes": [],
|
|
41668
|
+
* // "startingSchema": {},
|
|
41669
|
+
* // "workspaceConfig": {}
|
|
39226
41670
|
* // }
|
|
39227
41671
|
* }
|
|
39228
41672
|
*
|
|
@@ -39238,14 +41682,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39238
41682
|
* @param callback - Optional callback that handles the response.
|
|
39239
41683
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39240
41684
|
*/
|
|
39241
|
-
|
|
39242
|
-
|
|
39243
|
-
|
|
39244
|
-
|
|
39245
|
-
|
|
39246
|
-
|
|
41685
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41686
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>>;
|
|
41687
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41688
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
41689
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
41690
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
39247
41691
|
/**
|
|
39248
|
-
* Gets a
|
|
41692
|
+
* Gets a CompletionConfig
|
|
39249
41693
|
* @example
|
|
39250
41694
|
* ```js
|
|
39251
41695
|
* // Before running the sample:
|
|
@@ -39268,7 +41712,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39268
41712
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39269
41713
|
* scopes: [
|
|
39270
41714
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39271
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
39272
41715
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39273
41716
|
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39274
41717
|
* ],
|
|
@@ -39279,40 +41722,25 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39279
41722
|
* google.options({auth: authClient});
|
|
39280
41723
|
*
|
|
39281
41724
|
* // Do the magic
|
|
39282
|
-
* const res =
|
|
39283
|
-
*
|
|
39284
|
-
*
|
|
39285
|
-
*
|
|
41725
|
+
* const res =
|
|
41726
|
+
* await discoveryengine.projects.locations.dataStores.getCompletionConfig({
|
|
41727
|
+
* // 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`
|
|
41728
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/completionConfig',
|
|
41729
|
+
* });
|
|
39286
41730
|
* console.log(res.data);
|
|
39287
41731
|
*
|
|
39288
41732
|
* // Example response
|
|
39289
41733
|
* // {
|
|
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": {},
|
|
41734
|
+
* // "enableMode": "my_enableMode",
|
|
41735
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
41736
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
41737
|
+
* // "maxSuggestions": 0,
|
|
41738
|
+
* // "minPrefixLength": 0,
|
|
39310
41739
|
* // "name": "my_name",
|
|
39311
|
-
* // "
|
|
39312
|
-
* // "
|
|
39313
|
-
* // "
|
|
39314
|
-
* // "
|
|
39315
|
-
* // "workspaceConfig": {}
|
|
41740
|
+
* // "numUniqueUsersThreshold": 0,
|
|
41741
|
+
* // "queryFrequencyThreshold": 0,
|
|
41742
|
+
* // "queryModel": "my_queryModel",
|
|
41743
|
+
* // "shouldServeContentSuggestions": false
|
|
39316
41744
|
* // }
|
|
39317
41745
|
* }
|
|
39318
41746
|
*
|
|
@@ -39328,12 +41756,12 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39328
41756
|
* @param callback - Optional callback that handles the response.
|
|
39329
41757
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39330
41758
|
*/
|
|
39331
|
-
|
|
39332
|
-
|
|
39333
|
-
|
|
39334
|
-
|
|
39335
|
-
|
|
39336
|
-
|
|
41759
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
41760
|
+
getCompletionConfig(params?: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
41761
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
41762
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
41763
|
+
getCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Getcompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
41764
|
+
getCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
39337
41765
|
/**
|
|
39338
41766
|
* Gets a DocumentProcessingConfig.
|
|
39339
41767
|
* @example
|
|
@@ -39512,6 +41940,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39512
41940
|
* pageToken: 'placeholder-value',
|
|
39513
41941
|
* // 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
41942
|
* parent: 'projects/my-project/locations/my-location',
|
|
41943
|
+
* // 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.
|
|
41944
|
+
* view: 'placeholder-value',
|
|
39515
41945
|
* });
|
|
39516
41946
|
* console.log(res.data);
|
|
39517
41947
|
*
|
|
@@ -39598,6 +42028,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39598
42028
|
* // "documentProcessingConfig": {},
|
|
39599
42029
|
* // "federatedSearchConfig": {},
|
|
39600
42030
|
* // "healthcareFhirConfig": {},
|
|
42031
|
+
* // "iconUri": "my_iconUri",
|
|
39601
42032
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
39602
42033
|
* // "idpConfig": {},
|
|
39603
42034
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -39631,6 +42062,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39631
42062
|
* // "documentProcessingConfig": {},
|
|
39632
42063
|
* // "federatedSearchConfig": {},
|
|
39633
42064
|
* // "healthcareFhirConfig": {},
|
|
42065
|
+
* // "iconUri": "my_iconUri",
|
|
39634
42066
|
* // "identityMappingStore": "my_identityMappingStore",
|
|
39635
42067
|
* // "idpConfig": {},
|
|
39636
42068
|
* // "industryVertical": "my_industryVertical",
|
|
@@ -39823,7 +42255,100 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39823
42255
|
replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39824
42256
|
replacePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
39825
42257
|
/**
|
|
39826
|
-
* Updates the
|
|
42258
|
+
* Updates the CompletionConfigs.
|
|
42259
|
+
* @example
|
|
42260
|
+
* ```js
|
|
42261
|
+
* // Before running the sample:
|
|
42262
|
+
* // - Enable the API at:
|
|
42263
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
42264
|
+
* // - Login into gcloud by running:
|
|
42265
|
+
* // ```sh
|
|
42266
|
+
* // $ gcloud auth application-default login
|
|
42267
|
+
* // ```
|
|
42268
|
+
* // - Install the npm module by running:
|
|
42269
|
+
* // ```sh
|
|
42270
|
+
* // $ npm install googleapis
|
|
42271
|
+
* // ```
|
|
42272
|
+
*
|
|
42273
|
+
* const {google} = require('googleapis');
|
|
42274
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
42275
|
+
*
|
|
42276
|
+
* async function main() {
|
|
42277
|
+
* const auth = new google.auth.GoogleAuth({
|
|
42278
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
42279
|
+
* scopes: [
|
|
42280
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
42281
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
42282
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
42283
|
+
* ],
|
|
42284
|
+
* });
|
|
42285
|
+
*
|
|
42286
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
42287
|
+
* const authClient = await auth.getClient();
|
|
42288
|
+
* google.options({auth: authClient});
|
|
42289
|
+
*
|
|
42290
|
+
* // Do the magic
|
|
42291
|
+
* const res =
|
|
42292
|
+
* await discoveryengine.projects.locations.dataStores.updateCompletionConfig({
|
|
42293
|
+
* // 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`
|
|
42294
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/completionConfig',
|
|
42295
|
+
* // 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.
|
|
42296
|
+
* updateMask: 'placeholder-value',
|
|
42297
|
+
*
|
|
42298
|
+
* // Request body metadata
|
|
42299
|
+
* requestBody: {
|
|
42300
|
+
* // request body parameters
|
|
42301
|
+
* // {
|
|
42302
|
+
* // "enableMode": "my_enableMode",
|
|
42303
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
42304
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
42305
|
+
* // "maxSuggestions": 0,
|
|
42306
|
+
* // "minPrefixLength": 0,
|
|
42307
|
+
* // "name": "my_name",
|
|
42308
|
+
* // "numUniqueUsersThreshold": 0,
|
|
42309
|
+
* // "queryFrequencyThreshold": 0,
|
|
42310
|
+
* // "queryModel": "my_queryModel",
|
|
42311
|
+
* // "shouldServeContentSuggestions": false
|
|
42312
|
+
* // }
|
|
42313
|
+
* },
|
|
42314
|
+
* });
|
|
42315
|
+
* console.log(res.data);
|
|
42316
|
+
*
|
|
42317
|
+
* // Example response
|
|
42318
|
+
* // {
|
|
42319
|
+
* // "enableMode": "my_enableMode",
|
|
42320
|
+
* // "filterPiiSuggestionsUsingDlp": false,
|
|
42321
|
+
* // "matchingOrder": "my_matchingOrder",
|
|
42322
|
+
* // "maxSuggestions": 0,
|
|
42323
|
+
* // "minPrefixLength": 0,
|
|
42324
|
+
* // "name": "my_name",
|
|
42325
|
+
* // "numUniqueUsersThreshold": 0,
|
|
42326
|
+
* // "queryFrequencyThreshold": 0,
|
|
42327
|
+
* // "queryModel": "my_queryModel",
|
|
42328
|
+
* // "shouldServeContentSuggestions": false
|
|
42329
|
+
* // }
|
|
42330
|
+
* }
|
|
42331
|
+
*
|
|
42332
|
+
* main().catch(e => {
|
|
42333
|
+
* console.error(e);
|
|
42334
|
+
* throw e;
|
|
42335
|
+
* });
|
|
42336
|
+
*
|
|
42337
|
+
* ```
|
|
42338
|
+
*
|
|
42339
|
+
* @param params - Parameters for request
|
|
42340
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
42341
|
+
* @param callback - Optional callback that handles the response.
|
|
42342
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
42343
|
+
*/
|
|
42344
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
42345
|
+
updateCompletionConfig(params?: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>>;
|
|
42346
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
42347
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
42348
|
+
updateCompletionConfig(params: Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
42349
|
+
updateCompletionConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig>): void;
|
|
42350
|
+
/**
|
|
42351
|
+
* 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
42352
|
* @example
|
|
39828
42353
|
* ```js
|
|
39829
42354
|
* // Before running the sample:
|
|
@@ -39861,7 +42386,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39861
42386
|
* {
|
|
39862
42387
|
* // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
39863
42388
|
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/documentProcessingConfig',
|
|
39864
|
-
* //
|
|
42389
|
+
* // 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
42390
|
* updateMask: 'placeholder-value',
|
|
39866
42391
|
*
|
|
39867
42392
|
* // Request body metadata
|
|
@@ -39989,6 +42514,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
39989
42514
|
* 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
42515
|
*/
|
|
39991
42516
|
name?: string;
|
|
42517
|
+
/**
|
|
42518
|
+
* 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.
|
|
42519
|
+
*/
|
|
42520
|
+
view?: string;
|
|
42521
|
+
}
|
|
42522
|
+
export interface Params$Resource$Projects$Locations$Datastores$Getcompletionconfig extends StandardParameters {
|
|
42523
|
+
/**
|
|
42524
|
+
* 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`
|
|
42525
|
+
*/
|
|
42526
|
+
name?: string;
|
|
39992
42527
|
}
|
|
39993
42528
|
export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig extends StandardParameters {
|
|
39994
42529
|
/**
|
|
@@ -40019,6 +42554,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40019
42554
|
* 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
42555
|
*/
|
|
40021
42556
|
parent?: string;
|
|
42557
|
+
/**
|
|
42558
|
+
* 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.
|
|
42559
|
+
*/
|
|
42560
|
+
view?: string;
|
|
40022
42561
|
}
|
|
40023
42562
|
export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters {
|
|
40024
42563
|
/**
|
|
@@ -40054,13 +42593,27 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
40054
42593
|
*/
|
|
40055
42594
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
|
|
40056
42595
|
}
|
|
42596
|
+
export interface Params$Resource$Projects$Locations$Datastores$Updatecompletionconfig extends StandardParameters {
|
|
42597
|
+
/**
|
|
42598
|
+
* 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`
|
|
42599
|
+
*/
|
|
42600
|
+
name?: string;
|
|
42601
|
+
/**
|
|
42602
|
+
* 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.
|
|
42603
|
+
*/
|
|
42604
|
+
updateMask?: string;
|
|
42605
|
+
/**
|
|
42606
|
+
* Request body metadata
|
|
42607
|
+
*/
|
|
42608
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCompletionConfig;
|
|
42609
|
+
}
|
|
40057
42610
|
export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
40058
42611
|
/**
|
|
40059
42612
|
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
40060
42613
|
*/
|
|
40061
42614
|
name?: string;
|
|
40062
42615
|
/**
|
|
40063
|
-
*
|
|
42616
|
+
* 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
42617
|
*/
|
|
40065
42618
|
updateMask?: string;
|
|
40066
42619
|
/**
|
|
@@ -46809,6 +49362,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46809
49362
|
* // "entity": "my_entity",
|
|
46810
49363
|
* // "eventTime": "my_eventTime",
|
|
46811
49364
|
* // "eventType": "my_eventType",
|
|
49365
|
+
* // "feedback": {},
|
|
46812
49366
|
* // "filter": "my_filter",
|
|
46813
49367
|
* // "mediaInfo": {},
|
|
46814
49368
|
* // "pageInfo": {},
|
|
@@ -46839,6 +49393,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46839
49393
|
* // "entity": "my_entity",
|
|
46840
49394
|
* // "eventTime": "my_eventTime",
|
|
46841
49395
|
* // "eventType": "my_eventType",
|
|
49396
|
+
* // "feedback": {},
|
|
46842
49397
|
* // "filter": "my_filter",
|
|
46843
49398
|
* // "mediaInfo": {},
|
|
46844
49399
|
* // "pageInfo": {},
|
|
@@ -46970,6 +49525,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46970
49525
|
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
46971
49526
|
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
46972
49527
|
* 'placeholder-value',
|
|
49528
|
+
* // 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).
|
|
49529
|
+
* languageCode: 'placeholder-value',
|
|
49530
|
+
* // 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`).
|
|
49531
|
+
* modelInfoView: 'placeholder-value',
|
|
46973
49532
|
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
46974
49533
|
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
46975
49534
|
* });
|
|
@@ -46981,6 +49540,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
46981
49540
|
* // "allowPublicAccess": false,
|
|
46982
49541
|
* // "allowlistedDomains": [],
|
|
46983
49542
|
* // "assistantSettings": {},
|
|
49543
|
+
* // "batchAuthStatuses": [],
|
|
46984
49544
|
* // "collectionComponents": [],
|
|
46985
49545
|
* // "configId": "my_configId",
|
|
46986
49546
|
* // "contentSearchSpec": {},
|
|
@@ -47085,6 +49645,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
47085
49645
|
* // "allowPublicAccess": false,
|
|
47086
49646
|
* // "allowlistedDomains": [],
|
|
47087
49647
|
* // "assistantSettings": {},
|
|
49648
|
+
* // "batchAuthStatuses": [],
|
|
47088
49649
|
* // "collectionComponents": [],
|
|
47089
49650
|
* // "configId": "my_configId",
|
|
47090
49651
|
* // "contentSearchSpec": {},
|
|
@@ -47129,6 +49690,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
47129
49690
|
* // "allowPublicAccess": false,
|
|
47130
49691
|
* // "allowlistedDomains": [],
|
|
47131
49692
|
* // "assistantSettings": {},
|
|
49693
|
+
* // "batchAuthStatuses": [],
|
|
47132
49694
|
* // "collectionComponents": [],
|
|
47133
49695
|
* // "configId": "my_configId",
|
|
47134
49696
|
* // "contentSearchSpec": {},
|
|
@@ -47193,6 +49755,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
47193
49755
|
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
47194
49756
|
*/
|
|
47195
49757
|
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
49758
|
+
/**
|
|
49759
|
+
* 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).
|
|
49760
|
+
*/
|
|
49761
|
+
languageCode?: string;
|
|
49762
|
+
/**
|
|
49763
|
+
* 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`).
|
|
49764
|
+
*/
|
|
49765
|
+
modelInfoView?: string;
|
|
47196
49766
|
/**
|
|
47197
49767
|
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
47198
49768
|
*/
|
|
@@ -48575,6 +51145,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48575
51145
|
* // "endDate": {},
|
|
48576
51146
|
* // "freeTrial": false,
|
|
48577
51147
|
* // "geminiBundle": false,
|
|
51148
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48578
51149
|
* // "licenseCount": "my_licenseCount",
|
|
48579
51150
|
* // "name": "my_name",
|
|
48580
51151
|
* // "startDate": {},
|
|
@@ -48595,6 +51166,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48595
51166
|
* // "endDate": {},
|
|
48596
51167
|
* // "freeTrial": false,
|
|
48597
51168
|
* // "geminiBundle": false,
|
|
51169
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48598
51170
|
* // "licenseCount": "my_licenseCount",
|
|
48599
51171
|
* // "name": "my_name",
|
|
48600
51172
|
* // "startDate": {},
|
|
@@ -48671,6 +51243,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48671
51243
|
* // "endDate": {},
|
|
48672
51244
|
* // "freeTrial": false,
|
|
48673
51245
|
* // "geminiBundle": false,
|
|
51246
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48674
51247
|
* // "licenseCount": "my_licenseCount",
|
|
48675
51248
|
* // "name": "my_name",
|
|
48676
51249
|
* // "startDate": {},
|
|
@@ -48820,6 +51393,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48820
51393
|
* // "endDate": {},
|
|
48821
51394
|
* // "freeTrial": false,
|
|
48822
51395
|
* // "geminiBundle": false,
|
|
51396
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48823
51397
|
* // "licenseCount": "my_licenseCount",
|
|
48824
51398
|
* // "name": "my_name",
|
|
48825
51399
|
* // "startDate": {},
|
|
@@ -48840,6 +51414,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
48840
51414
|
* // "endDate": {},
|
|
48841
51415
|
* // "freeTrial": false,
|
|
48842
51416
|
* // "geminiBundle": false,
|
|
51417
|
+
* // "lastUserUpdateTime": "my_lastUserUpdateTime",
|
|
48843
51418
|
* // "licenseCount": "my_licenseCount",
|
|
48844
51419
|
* // "name": "my_name",
|
|
48845
51420
|
* // "startDate": {},
|
|
@@ -51409,6 +53984,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
51409
53984
|
* // "entity": "my_entity",
|
|
51410
53985
|
* // "eventTime": "my_eventTime",
|
|
51411
53986
|
* // "eventType": "my_eventType",
|
|
53987
|
+
* // "feedback": {},
|
|
51412
53988
|
* // "filter": "my_filter",
|
|
51413
53989
|
* // "mediaInfo": {},
|
|
51414
53990
|
* // "pageInfo": {},
|
|
@@ -51439,6 +54015,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
51439
54015
|
* // "entity": "my_entity",
|
|
51440
54016
|
* // "eventTime": "my_eventTime",
|
|
51441
54017
|
* // "eventType": "my_eventType",
|
|
54018
|
+
* // "feedback": {},
|
|
51442
54019
|
* // "filter": "my_filter",
|
|
51443
54020
|
* // "mediaInfo": {},
|
|
51444
54021
|
* // "pageInfo": {},
|
|
@@ -52040,6 +54617,78 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52040
54617
|
export class Resource$Projects$Locations$Userstores$Userlicenses {
|
|
52041
54618
|
context: APIRequestContext;
|
|
52042
54619
|
constructor(context: APIRequestContext);
|
|
54620
|
+
/**
|
|
54621
|
+
* 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.
|
|
54622
|
+
* @example
|
|
54623
|
+
* ```js
|
|
54624
|
+
* // Before running the sample:
|
|
54625
|
+
* // - Enable the API at:
|
|
54626
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
54627
|
+
* // - Login into gcloud by running:
|
|
54628
|
+
* // ```sh
|
|
54629
|
+
* // $ gcloud auth application-default login
|
|
54630
|
+
* // ```
|
|
54631
|
+
* // - Install the npm module by running:
|
|
54632
|
+
* // ```sh
|
|
54633
|
+
* // $ npm install googleapis
|
|
54634
|
+
* // ```
|
|
54635
|
+
*
|
|
54636
|
+
* const {google} = require('googleapis');
|
|
54637
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
54638
|
+
*
|
|
54639
|
+
* async function main() {
|
|
54640
|
+
* const auth = new google.auth.GoogleAuth({
|
|
54641
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
54642
|
+
* scopes: [
|
|
54643
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
54644
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
54645
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
54646
|
+
* ],
|
|
54647
|
+
* });
|
|
54648
|
+
*
|
|
54649
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
54650
|
+
* const authClient = await auth.getClient();
|
|
54651
|
+
* google.options({auth: authClient});
|
|
54652
|
+
*
|
|
54653
|
+
* // Do the magic
|
|
54654
|
+
* const res =
|
|
54655
|
+
* await discoveryengine.projects.locations.userStores.userLicenses.export({
|
|
54656
|
+
* // Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. All UserLicenses under this UserStore are exported.
|
|
54657
|
+
* parent:
|
|
54658
|
+
* 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
54659
|
+
*
|
|
54660
|
+
* // Request body metadata
|
|
54661
|
+
* requestBody: {
|
|
54662
|
+
* // request body parameters
|
|
54663
|
+
* // {}
|
|
54664
|
+
* },
|
|
54665
|
+
* });
|
|
54666
|
+
* console.log(res.data);
|
|
54667
|
+
*
|
|
54668
|
+
* // Example response
|
|
54669
|
+
* // {
|
|
54670
|
+
* // "csvData": "my_csvData"
|
|
54671
|
+
* // }
|
|
54672
|
+
* }
|
|
54673
|
+
*
|
|
54674
|
+
* main().catch(e => {
|
|
54675
|
+
* console.error(e);
|
|
54676
|
+
* throw e;
|
|
54677
|
+
* });
|
|
54678
|
+
*
|
|
54679
|
+
* ```
|
|
54680
|
+
*
|
|
54681
|
+
* @param params - Parameters for request
|
|
54682
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
54683
|
+
* @param callback - Optional callback that handles the response.
|
|
54684
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
54685
|
+
*/
|
|
54686
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
54687
|
+
export(params?: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>>;
|
|
54688
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
54689
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>): void;
|
|
54690
|
+
export(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$Export, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>): void;
|
|
54691
|
+
export(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse>): void;
|
|
52043
54692
|
/**
|
|
52044
54693
|
* Lists the User Licenses.
|
|
52045
54694
|
* @example
|
|
@@ -52080,7 +54729,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52080
54729
|
* filter: 'placeholder-value',
|
|
52081
54730
|
* // 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
54731
|
* orderBy: 'placeholder-value',
|
|
52083
|
-
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
54732
|
+
* // 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
54733
|
* pageSize: 'placeholder-value',
|
|
52085
54734
|
* // 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
54735
|
* pageToken: 'placeholder-value',
|
|
@@ -52116,6 +54765,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52116
54765
|
list(params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse>): void;
|
|
52117
54766
|
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse>): void;
|
|
52118
54767
|
}
|
|
54768
|
+
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$Export extends StandardParameters {
|
|
54769
|
+
/**
|
|
54770
|
+
* Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. All UserLicenses under this UserStore are exported.
|
|
54771
|
+
*/
|
|
54772
|
+
parent?: string;
|
|
54773
|
+
/**
|
|
54774
|
+
* Request body metadata
|
|
54775
|
+
*/
|
|
54776
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest;
|
|
54777
|
+
}
|
|
52119
54778
|
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
|
|
52120
54779
|
/**
|
|
52121
54780
|
* 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 +54785,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
52126
54785
|
*/
|
|
52127
54786
|
orderBy?: string;
|
|
52128
54787
|
/**
|
|
52129
|
-
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to
|
|
54788
|
+
* 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
54789
|
*/
|
|
52131
54790
|
pageSize?: number;
|
|
52132
54791
|
/**
|