@googleapis/discoveryengine 8.0.0 → 8.1.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 +7 -0
- package/build/index.d.ts +5 -0
- package/build/index.js +4 -1
- package/build/index.js.map +1 -1
- package/build/v1.d.ts +8122 -0
- package/build/v1.js +4530 -0
- package/build/v1.js.map +1 -0
- package/build/v1alpha.d.ts +2084 -78
- package/build/v1alpha.js +1307 -102
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2374 -155
- package/build/v1beta.js +1203 -111
- package/build/v1beta.js.map +1 -1
- package/index.ts +12 -0
- package/package.json +1 -1
- package/v1.ts +19015 -0
- package/v1alpha.ts +13702 -9019
- package/v1beta.ts +11566 -6874
package/build/v1beta.d.ts
CHANGED
|
@@ -205,6 +205,296 @@ export declare namespace discoveryengine_v1beta {
|
|
|
205
205
|
*/
|
|
206
206
|
name?: string | null;
|
|
207
207
|
}
|
|
208
|
+
/**
|
|
209
|
+
* Defines an answer.
|
|
210
|
+
*/
|
|
211
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswer {
|
|
212
|
+
/**
|
|
213
|
+
* Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
214
|
+
*/
|
|
215
|
+
answerSkippedReasons?: string[] | null;
|
|
216
|
+
/**
|
|
217
|
+
* The textual answer.
|
|
218
|
+
*/
|
|
219
|
+
answerText?: string | null;
|
|
220
|
+
/**
|
|
221
|
+
* Citations.
|
|
222
|
+
*/
|
|
223
|
+
citations?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
224
|
+
/**
|
|
225
|
+
* Output only. Answer completed timestamp.
|
|
226
|
+
*/
|
|
227
|
+
completeTime?: string | null;
|
|
228
|
+
/**
|
|
229
|
+
* Output only. Answer creation timestamp.
|
|
230
|
+
*/
|
|
231
|
+
createTime?: string | null;
|
|
232
|
+
/**
|
|
233
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x`
|
|
234
|
+
*/
|
|
235
|
+
name?: string | null;
|
|
236
|
+
/**
|
|
237
|
+
* Query understanding information.
|
|
238
|
+
*/
|
|
239
|
+
queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
|
|
240
|
+
/**
|
|
241
|
+
* References.
|
|
242
|
+
*/
|
|
243
|
+
references?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference[];
|
|
244
|
+
/**
|
|
245
|
+
* Suggested related questions.
|
|
246
|
+
*/
|
|
247
|
+
relatedQuestions?: string[] | null;
|
|
248
|
+
/**
|
|
249
|
+
* The state of the answer generation.
|
|
250
|
+
*/
|
|
251
|
+
state?: string | null;
|
|
252
|
+
/**
|
|
253
|
+
* Answer generation steps.
|
|
254
|
+
*/
|
|
255
|
+
steps?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep[];
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Citation info for a segment.
|
|
259
|
+
*/
|
|
260
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation {
|
|
261
|
+
/**
|
|
262
|
+
* End of the attributed segment, exclusive.
|
|
263
|
+
*/
|
|
264
|
+
endIndex?: string | null;
|
|
265
|
+
/**
|
|
266
|
+
* Citation sources for the attributed segment.
|
|
267
|
+
*/
|
|
268
|
+
sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
269
|
+
/**
|
|
270
|
+
* Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
|
|
271
|
+
*/
|
|
272
|
+
startIndex?: string | null;
|
|
273
|
+
}
|
|
274
|
+
/**
|
|
275
|
+
* Citation source.
|
|
276
|
+
*/
|
|
277
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource {
|
|
278
|
+
/**
|
|
279
|
+
* ID of the citation source.
|
|
280
|
+
*/
|
|
281
|
+
referenceId?: string | null;
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* Query understanding information.
|
|
285
|
+
*/
|
|
286
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
|
|
287
|
+
/**
|
|
288
|
+
* Query classification information.
|
|
289
|
+
*/
|
|
290
|
+
queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* Query classification information.
|
|
294
|
+
*/
|
|
295
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo {
|
|
296
|
+
/**
|
|
297
|
+
* Classification output.
|
|
298
|
+
*/
|
|
299
|
+
positive?: boolean | null;
|
|
300
|
+
/**
|
|
301
|
+
* Query classification type.
|
|
302
|
+
*/
|
|
303
|
+
type?: string | null;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* Reference.
|
|
307
|
+
*/
|
|
308
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference {
|
|
309
|
+
/**
|
|
310
|
+
* Chunk information.
|
|
311
|
+
*/
|
|
312
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
|
|
313
|
+
/**
|
|
314
|
+
* Unstructured document information.
|
|
315
|
+
*/
|
|
316
|
+
unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* Chunk information.
|
|
320
|
+
*/
|
|
321
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo {
|
|
322
|
+
/**
|
|
323
|
+
* Chunk resource name.
|
|
324
|
+
*/
|
|
325
|
+
chunk?: string | null;
|
|
326
|
+
/**
|
|
327
|
+
* Chunk textual content.
|
|
328
|
+
*/
|
|
329
|
+
content?: string | null;
|
|
330
|
+
/**
|
|
331
|
+
* Document metadata.
|
|
332
|
+
*/
|
|
333
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
|
|
334
|
+
/**
|
|
335
|
+
* Relevance score.
|
|
336
|
+
*/
|
|
337
|
+
relevanceScore?: number | null;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Document metadata.
|
|
341
|
+
*/
|
|
342
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
|
|
343
|
+
/**
|
|
344
|
+
* Document resource name.
|
|
345
|
+
*/
|
|
346
|
+
document?: string | null;
|
|
347
|
+
/**
|
|
348
|
+
* Page identifier.
|
|
349
|
+
*/
|
|
350
|
+
pageIdentifier?: string | null;
|
|
351
|
+
/**
|
|
352
|
+
* Title.
|
|
353
|
+
*/
|
|
354
|
+
title?: string | null;
|
|
355
|
+
/**
|
|
356
|
+
* URI for the document.
|
|
357
|
+
*/
|
|
358
|
+
uri?: string | null;
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* Unstructured document information.
|
|
362
|
+
*/
|
|
363
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
|
|
364
|
+
/**
|
|
365
|
+
* List of cited chunk contents derived from document content.
|
|
366
|
+
*/
|
|
367
|
+
chunkContents?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
368
|
+
/**
|
|
369
|
+
* Document resource name.
|
|
370
|
+
*/
|
|
371
|
+
document?: string | null;
|
|
372
|
+
/**
|
|
373
|
+
* Title.
|
|
374
|
+
*/
|
|
375
|
+
title?: string | null;
|
|
376
|
+
/**
|
|
377
|
+
* URI for the document.
|
|
378
|
+
*/
|
|
379
|
+
uri?: string | null;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* Chunk content.
|
|
383
|
+
*/
|
|
384
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent {
|
|
385
|
+
/**
|
|
386
|
+
* Chunk textual content.
|
|
387
|
+
*/
|
|
388
|
+
content?: string | null;
|
|
389
|
+
/**
|
|
390
|
+
* Page identifier.
|
|
391
|
+
*/
|
|
392
|
+
pageIdentifier?: string | null;
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* Step information.
|
|
396
|
+
*/
|
|
397
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep {
|
|
398
|
+
/**
|
|
399
|
+
* Actions.
|
|
400
|
+
*/
|
|
401
|
+
actions?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction[];
|
|
402
|
+
/**
|
|
403
|
+
* The description of the step.
|
|
404
|
+
*/
|
|
405
|
+
description?: string | null;
|
|
406
|
+
/**
|
|
407
|
+
* The state of the step.
|
|
408
|
+
*/
|
|
409
|
+
state?: string | null;
|
|
410
|
+
/**
|
|
411
|
+
* The thought of the step.
|
|
412
|
+
*/
|
|
413
|
+
thought?: string | null;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* Action.
|
|
417
|
+
*/
|
|
418
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction {
|
|
419
|
+
/**
|
|
420
|
+
* Observation.
|
|
421
|
+
*/
|
|
422
|
+
observation?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation;
|
|
423
|
+
/**
|
|
424
|
+
* Search action.
|
|
425
|
+
*/
|
|
426
|
+
searchAction?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction;
|
|
427
|
+
}
|
|
428
|
+
/**
|
|
429
|
+
* Observation.
|
|
430
|
+
*/
|
|
431
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation {
|
|
432
|
+
/**
|
|
433
|
+
* Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
|
|
434
|
+
*/
|
|
435
|
+
searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult[];
|
|
436
|
+
}
|
|
437
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult {
|
|
438
|
+
/**
|
|
439
|
+
* If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
|
|
440
|
+
*/
|
|
441
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo[];
|
|
442
|
+
/**
|
|
443
|
+
* Document resource name.
|
|
444
|
+
*/
|
|
445
|
+
document?: string | null;
|
|
446
|
+
/**
|
|
447
|
+
* If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
|
|
448
|
+
*/
|
|
449
|
+
snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
450
|
+
/**
|
|
451
|
+
* Title.
|
|
452
|
+
*/
|
|
453
|
+
title?: string | null;
|
|
454
|
+
/**
|
|
455
|
+
* URI for the document.
|
|
456
|
+
*/
|
|
457
|
+
uri?: string | null;
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* Chunk information.
|
|
461
|
+
*/
|
|
462
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo {
|
|
463
|
+
/**
|
|
464
|
+
* Chunk resource name.
|
|
465
|
+
*/
|
|
466
|
+
chunk?: string | null;
|
|
467
|
+
/**
|
|
468
|
+
* Chunk textual content.
|
|
469
|
+
*/
|
|
470
|
+
content?: string | null;
|
|
471
|
+
/**
|
|
472
|
+
* Relevance score.
|
|
473
|
+
*/
|
|
474
|
+
relevanceScore?: number | null;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* Snippet information.
|
|
478
|
+
*/
|
|
479
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
480
|
+
/**
|
|
481
|
+
* Snippet content.
|
|
482
|
+
*/
|
|
483
|
+
snippet?: string | null;
|
|
484
|
+
/**
|
|
485
|
+
* Status of the snippet defined by the search team.
|
|
486
|
+
*/
|
|
487
|
+
snippetStatus?: string | null;
|
|
488
|
+
}
|
|
489
|
+
/**
|
|
490
|
+
* Search action.
|
|
491
|
+
*/
|
|
492
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction {
|
|
493
|
+
/**
|
|
494
|
+
* The query to search.
|
|
495
|
+
*/
|
|
496
|
+
query?: string | null;
|
|
497
|
+
}
|
|
208
498
|
/**
|
|
209
499
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
210
500
|
*/
|
|
@@ -475,7 +765,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
475
765
|
*/
|
|
476
766
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
477
767
|
/**
|
|
478
|
-
*
|
|
768
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
479
769
|
*/
|
|
480
770
|
enhancedDocumentElements?: string[] | null;
|
|
481
771
|
/**
|
|
@@ -571,7 +861,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
571
861
|
*/
|
|
572
862
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
573
863
|
/**
|
|
574
|
-
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
864
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
575
865
|
*/
|
|
576
866
|
dialogflowAgentToLink?: string | null;
|
|
577
867
|
}
|
|
@@ -678,7 +968,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
678
968
|
*/
|
|
679
969
|
searchAddOns?: string[] | null;
|
|
680
970
|
/**
|
|
681
|
-
* The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
971
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
682
972
|
*/
|
|
683
973
|
searchTier?: string | null;
|
|
684
974
|
}
|
|
@@ -713,6 +1003,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
713
1003
|
* Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
|
|
714
1004
|
*/
|
|
715
1005
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
1006
|
+
/**
|
|
1007
|
+
* If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
|
|
1008
|
+
*/
|
|
1009
|
+
advancedSiteSearchDataSources?: string[] | null;
|
|
716
1010
|
/**
|
|
717
1011
|
* If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
|
|
718
1012
|
*/
|
|
@@ -788,6 +1082,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
788
1082
|
* Count of entries that were processed successfully.
|
|
789
1083
|
*/
|
|
790
1084
|
successCount?: string | null;
|
|
1085
|
+
/**
|
|
1086
|
+
* Total count of entries that were processed.
|
|
1087
|
+
*/
|
|
1088
|
+
totalCount?: string | null;
|
|
791
1089
|
/**
|
|
792
1090
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
793
1091
|
*/
|
|
@@ -887,6 +1185,59 @@ export declare namespace discoveryengine_v1beta {
|
|
|
887
1185
|
*/
|
|
888
1186
|
unjoinedEventsCount?: string | null;
|
|
889
1187
|
}
|
|
1188
|
+
/**
|
|
1189
|
+
* Metadata and configurations for a Google Cloud project in the service.
|
|
1190
|
+
*/
|
|
1191
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
|
|
1192
|
+
/**
|
|
1193
|
+
* Output only. The timestamp when this project is created.
|
|
1194
|
+
*/
|
|
1195
|
+
createTime?: string | null;
|
|
1196
|
+
/**
|
|
1197
|
+
* Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
|
|
1198
|
+
*/
|
|
1199
|
+
name?: string | null;
|
|
1200
|
+
/**
|
|
1201
|
+
* Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
|
|
1202
|
+
*/
|
|
1203
|
+
provisionCompletionTime?: string | null;
|
|
1204
|
+
/**
|
|
1205
|
+
* Output only. A map of terms of services. The key is the `id` of ServiceTerms.
|
|
1206
|
+
*/
|
|
1207
|
+
serviceTermsMap?: {
|
|
1208
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
1209
|
+
} | null;
|
|
1210
|
+
}
|
|
1211
|
+
/**
|
|
1212
|
+
* Metadata about the terms of service.
|
|
1213
|
+
*/
|
|
1214
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
|
|
1215
|
+
/**
|
|
1216
|
+
* The last time when the project agreed to the terms of service.
|
|
1217
|
+
*/
|
|
1218
|
+
acceptTime?: string | null;
|
|
1219
|
+
/**
|
|
1220
|
+
* The last time when the project declined or revoked the agreement to terms of service.
|
|
1221
|
+
*/
|
|
1222
|
+
declineTime?: string | null;
|
|
1223
|
+
/**
|
|
1224
|
+
* The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
|
|
1225
|
+
*/
|
|
1226
|
+
id?: string | null;
|
|
1227
|
+
/**
|
|
1228
|
+
* Whether the project has accepted/rejected the service terms or it is still pending.
|
|
1229
|
+
*/
|
|
1230
|
+
state?: string | null;
|
|
1231
|
+
/**
|
|
1232
|
+
* The version string of the terms of service. For acceptable values, see the comments for id above.
|
|
1233
|
+
*/
|
|
1234
|
+
version?: string | null;
|
|
1235
|
+
}
|
|
1236
|
+
/**
|
|
1237
|
+
* Metadata associated with a project provision operation.
|
|
1238
|
+
*/
|
|
1239
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {
|
|
1240
|
+
}
|
|
890
1241
|
/**
|
|
891
1242
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
892
1243
|
*/
|
|
@@ -981,6 +1332,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
981
1332
|
*/
|
|
982
1333
|
purgeCount?: string | null;
|
|
983
1334
|
}
|
|
1335
|
+
/**
|
|
1336
|
+
* Defines a user inputed query.
|
|
1337
|
+
*/
|
|
1338
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
|
|
1339
|
+
/**
|
|
1340
|
+
* Unique Id for the query.
|
|
1341
|
+
*/
|
|
1342
|
+
queryId?: string | null;
|
|
1343
|
+
/**
|
|
1344
|
+
* Plain text.
|
|
1345
|
+
*/
|
|
1346
|
+
text?: string | null;
|
|
1347
|
+
}
|
|
984
1348
|
/**
|
|
985
1349
|
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
986
1350
|
*/
|
|
@@ -1076,6 +1440,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1076
1440
|
[key: string]: any;
|
|
1077
1441
|
} | null;
|
|
1078
1442
|
}
|
|
1443
|
+
/**
|
|
1444
|
+
* External session proto definition.
|
|
1445
|
+
*/
|
|
1446
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSession {
|
|
1447
|
+
/**
|
|
1448
|
+
* Output only. The time the session finished.
|
|
1449
|
+
*/
|
|
1450
|
+
endTime?: string | null;
|
|
1451
|
+
/**
|
|
1452
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
1453
|
+
*/
|
|
1454
|
+
name?: string | null;
|
|
1455
|
+
/**
|
|
1456
|
+
* Output only. The time the session started.
|
|
1457
|
+
*/
|
|
1458
|
+
startTime?: string | null;
|
|
1459
|
+
/**
|
|
1460
|
+
* The state of the session.
|
|
1461
|
+
*/
|
|
1462
|
+
state?: string | null;
|
|
1463
|
+
/**
|
|
1464
|
+
* Turns.
|
|
1465
|
+
*/
|
|
1466
|
+
turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[];
|
|
1467
|
+
/**
|
|
1468
|
+
* A unique identifier for tracking users.
|
|
1469
|
+
*/
|
|
1470
|
+
userPseudoId?: string | null;
|
|
1471
|
+
}
|
|
1472
|
+
/**
|
|
1473
|
+
* Represents a turn, including a query from the user and a answer from service.
|
|
1474
|
+
*/
|
|
1475
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
1476
|
+
/**
|
|
1477
|
+
* The resource name of the answer to the user query.
|
|
1478
|
+
*/
|
|
1479
|
+
answer?: string | null;
|
|
1480
|
+
/**
|
|
1481
|
+
* The user query.
|
|
1482
|
+
*/
|
|
1483
|
+
query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery;
|
|
1484
|
+
}
|
|
1079
1485
|
/**
|
|
1080
1486
|
* Verification information for target sites in advanced site search.
|
|
1081
1487
|
*/
|
|
@@ -1174,7 +1580,13 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1174
1580
|
*/
|
|
1175
1581
|
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1176
1582
|
/**
|
|
1177
|
-
* The
|
|
1583
|
+
* The metrics of the trained model.
|
|
1584
|
+
*/
|
|
1585
|
+
metrics?: {
|
|
1586
|
+
[key: string]: number;
|
|
1587
|
+
} | null;
|
|
1588
|
+
/**
|
|
1589
|
+
* The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.
|
|
1178
1590
|
*/
|
|
1179
1591
|
modelStatus?: string | null;
|
|
1180
1592
|
}
|
|
@@ -1241,15 +1653,600 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1241
1653
|
targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[];
|
|
1242
1654
|
}
|
|
1243
1655
|
/**
|
|
1244
|
-
*
|
|
1656
|
+
* Defines an answer.
|
|
1245
1657
|
*/
|
|
1246
|
-
export interface Schema$
|
|
1658
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswer {
|
|
1247
1659
|
/**
|
|
1248
|
-
*
|
|
1660
|
+
* Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1249
1661
|
*/
|
|
1250
|
-
|
|
1662
|
+
answerSkippedReasons?: string[] | null;
|
|
1251
1663
|
/**
|
|
1252
|
-
*
|
|
1664
|
+
* The textual answer.
|
|
1665
|
+
*/
|
|
1666
|
+
answerText?: string | null;
|
|
1667
|
+
/**
|
|
1668
|
+
* Citations.
|
|
1669
|
+
*/
|
|
1670
|
+
citations?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation[];
|
|
1671
|
+
/**
|
|
1672
|
+
* Output only. Answer completed timestamp.
|
|
1673
|
+
*/
|
|
1674
|
+
completeTime?: string | null;
|
|
1675
|
+
/**
|
|
1676
|
+
* Output only. Answer creation timestamp.
|
|
1677
|
+
*/
|
|
1678
|
+
createTime?: string | null;
|
|
1679
|
+
/**
|
|
1680
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x`
|
|
1681
|
+
*/
|
|
1682
|
+
name?: string | null;
|
|
1683
|
+
/**
|
|
1684
|
+
* Query understanding information.
|
|
1685
|
+
*/
|
|
1686
|
+
queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo;
|
|
1687
|
+
/**
|
|
1688
|
+
* References.
|
|
1689
|
+
*/
|
|
1690
|
+
references?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReference[];
|
|
1691
|
+
/**
|
|
1692
|
+
* Suggested related questions.
|
|
1693
|
+
*/
|
|
1694
|
+
relatedQuestions?: string[] | null;
|
|
1695
|
+
/**
|
|
1696
|
+
* The state of the answer generation.
|
|
1697
|
+
*/
|
|
1698
|
+
state?: string | null;
|
|
1699
|
+
/**
|
|
1700
|
+
* Answer generation steps.
|
|
1701
|
+
*/
|
|
1702
|
+
steps?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStep[];
|
|
1703
|
+
}
|
|
1704
|
+
/**
|
|
1705
|
+
* Citation info for a segment.
|
|
1706
|
+
*/
|
|
1707
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation {
|
|
1708
|
+
/**
|
|
1709
|
+
* End of the attributed segment, exclusive.
|
|
1710
|
+
*/
|
|
1711
|
+
endIndex?: string | null;
|
|
1712
|
+
/**
|
|
1713
|
+
* Citation sources for the attributed segment.
|
|
1714
|
+
*/
|
|
1715
|
+
sources?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource[];
|
|
1716
|
+
/**
|
|
1717
|
+
* Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
|
|
1718
|
+
*/
|
|
1719
|
+
startIndex?: string | null;
|
|
1720
|
+
}
|
|
1721
|
+
/**
|
|
1722
|
+
* Citation source.
|
|
1723
|
+
*/
|
|
1724
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource {
|
|
1725
|
+
/**
|
|
1726
|
+
* ID of the citation source.
|
|
1727
|
+
*/
|
|
1728
|
+
referenceId?: string | null;
|
|
1729
|
+
}
|
|
1730
|
+
/**
|
|
1731
|
+
* Request message for ConversationalSearchService.AnswerQuery method.
|
|
1732
|
+
*/
|
|
1733
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest {
|
|
1734
|
+
/**
|
|
1735
|
+
* Answer generation specification.
|
|
1736
|
+
*/
|
|
1737
|
+
answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec;
|
|
1738
|
+
/**
|
|
1739
|
+
* Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.
|
|
1740
|
+
*/
|
|
1741
|
+
asynchronousMode?: boolean | null;
|
|
1742
|
+
/**
|
|
1743
|
+
* Required. Current user query.
|
|
1744
|
+
*/
|
|
1745
|
+
query?: Schema$GoogleCloudDiscoveryengineV1betaQuery;
|
|
1746
|
+
/**
|
|
1747
|
+
* Query understanding specification.
|
|
1748
|
+
*/
|
|
1749
|
+
queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec;
|
|
1750
|
+
/**
|
|
1751
|
+
* Related questions specification.
|
|
1752
|
+
*/
|
|
1753
|
+
relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec;
|
|
1754
|
+
/**
|
|
1755
|
+
* Model specification.
|
|
1756
|
+
*/
|
|
1757
|
+
safetySpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec;
|
|
1758
|
+
/**
|
|
1759
|
+
* Search specification.
|
|
1760
|
+
*/
|
|
1761
|
+
searchSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec;
|
|
1762
|
+
/**
|
|
1763
|
+
* The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol “-” as session id. A new id will be automatically generated and assigned.
|
|
1764
|
+
*/
|
|
1765
|
+
session?: string | null;
|
|
1766
|
+
/**
|
|
1767
|
+
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
1768
|
+
*/
|
|
1769
|
+
userPseudoId?: string | null;
|
|
1770
|
+
}
|
|
1771
|
+
/**
|
|
1772
|
+
* Answer generation specification.
|
|
1773
|
+
*/
|
|
1774
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec {
|
|
1775
|
+
/**
|
|
1776
|
+
* Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
1777
|
+
*/
|
|
1778
|
+
answerLanguageCode?: string | null;
|
|
1779
|
+
/**
|
|
1780
|
+
* Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.
|
|
1781
|
+
*/
|
|
1782
|
+
ignoreAdversarialQuery?: boolean | null;
|
|
1783
|
+
/**
|
|
1784
|
+
* Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
|
|
1785
|
+
*/
|
|
1786
|
+
ignoreNonAnswerSeekingQuery?: boolean | null;
|
|
1787
|
+
/**
|
|
1788
|
+
* Specifies whether to include citation metadata in the answer. The default value is `false`.
|
|
1789
|
+
*/
|
|
1790
|
+
includeCitations?: boolean | null;
|
|
1791
|
+
/**
|
|
1792
|
+
* Answer generation model specification.
|
|
1793
|
+
*/
|
|
1794
|
+
modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec;
|
|
1795
|
+
/**
|
|
1796
|
+
* Answer generation prompt specification.
|
|
1797
|
+
*/
|
|
1798
|
+
promptSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec;
|
|
1799
|
+
}
|
|
1800
|
+
/**
|
|
1801
|
+
* Answer Generation Model specification.
|
|
1802
|
+
*/
|
|
1803
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec {
|
|
1804
|
+
/**
|
|
1805
|
+
* Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
|
|
1806
|
+
*/
|
|
1807
|
+
modelVersion?: string | null;
|
|
1808
|
+
}
|
|
1809
|
+
/**
|
|
1810
|
+
* Answer generation prompt specification.
|
|
1811
|
+
*/
|
|
1812
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec {
|
|
1813
|
+
/**
|
|
1814
|
+
* Customized preamble.
|
|
1815
|
+
*/
|
|
1816
|
+
preamble?: string | null;
|
|
1817
|
+
}
|
|
1818
|
+
/**
|
|
1819
|
+
* Query understanding specification.
|
|
1820
|
+
*/
|
|
1821
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec {
|
|
1822
|
+
/**
|
|
1823
|
+
* Query classification specification.
|
|
1824
|
+
*/
|
|
1825
|
+
queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
|
|
1826
|
+
/**
|
|
1827
|
+
* Query rephraser specification.
|
|
1828
|
+
*/
|
|
1829
|
+
queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec;
|
|
1830
|
+
}
|
|
1831
|
+
/**
|
|
1832
|
+
* Query classification specification.
|
|
1833
|
+
*/
|
|
1834
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec {
|
|
1835
|
+
/**
|
|
1836
|
+
* Enabled query classification types.
|
|
1837
|
+
*/
|
|
1838
|
+
types?: string[] | null;
|
|
1839
|
+
}
|
|
1840
|
+
/**
|
|
1841
|
+
* Query rephraser specification.
|
|
1842
|
+
*/
|
|
1843
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
|
|
1844
|
+
/**
|
|
1845
|
+
* Disable query rephraser.
|
|
1846
|
+
*/
|
|
1847
|
+
disable?: boolean | null;
|
|
1848
|
+
/**
|
|
1849
|
+
* Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
|
|
1850
|
+
*/
|
|
1851
|
+
maxRephraseSteps?: number | null;
|
|
1852
|
+
}
|
|
1853
|
+
/**
|
|
1854
|
+
* Related questions specification.
|
|
1855
|
+
*/
|
|
1856
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec {
|
|
1857
|
+
/**
|
|
1858
|
+
* Enable related questions feature if true.
|
|
1859
|
+
*/
|
|
1860
|
+
enable?: boolean | null;
|
|
1861
|
+
}
|
|
1862
|
+
/**
|
|
1863
|
+
* Safety specification.
|
|
1864
|
+
*/
|
|
1865
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec {
|
|
1866
|
+
/**
|
|
1867
|
+
* Enable the safety filtering on the answer response. It is false by default.
|
|
1868
|
+
*/
|
|
1869
|
+
enable?: boolean | null;
|
|
1870
|
+
}
|
|
1871
|
+
/**
|
|
1872
|
+
* Search specification.
|
|
1873
|
+
*/
|
|
1874
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec {
|
|
1875
|
+
/**
|
|
1876
|
+
* Search parameters.
|
|
1877
|
+
*/
|
|
1878
|
+
searchParams?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams;
|
|
1879
|
+
/**
|
|
1880
|
+
* Search result list.
|
|
1881
|
+
*/
|
|
1882
|
+
searchResultList?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList;
|
|
1883
|
+
}
|
|
1884
|
+
/**
|
|
1885
|
+
* Search parameters.
|
|
1886
|
+
*/
|
|
1887
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams {
|
|
1888
|
+
/**
|
|
1889
|
+
* Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
1890
|
+
*/
|
|
1891
|
+
boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
1892
|
+
/**
|
|
1893
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
|
1894
|
+
*/
|
|
1895
|
+
filter?: string | null;
|
|
1896
|
+
/**
|
|
1897
|
+
* Number of search results to return. The default value is 10.
|
|
1898
|
+
*/
|
|
1899
|
+
maxReturnResults?: number | null;
|
|
1900
|
+
/**
|
|
1901
|
+
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1902
|
+
*/
|
|
1903
|
+
orderBy?: string | null;
|
|
1904
|
+
}
|
|
1905
|
+
/**
|
|
1906
|
+
* Search result list.
|
|
1907
|
+
*/
|
|
1908
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList {
|
|
1909
|
+
/**
|
|
1910
|
+
* Search results.
|
|
1911
|
+
*/
|
|
1912
|
+
searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult[];
|
|
1913
|
+
}
|
|
1914
|
+
/**
|
|
1915
|
+
* Search result.
|
|
1916
|
+
*/
|
|
1917
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult {
|
|
1918
|
+
/**
|
|
1919
|
+
* Chunk information.
|
|
1920
|
+
*/
|
|
1921
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo;
|
|
1922
|
+
/**
|
|
1923
|
+
* Unstructured document information.
|
|
1924
|
+
*/
|
|
1925
|
+
unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo;
|
|
1926
|
+
}
|
|
1927
|
+
/**
|
|
1928
|
+
* Chunk information.
|
|
1929
|
+
*/
|
|
1930
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo {
|
|
1931
|
+
/**
|
|
1932
|
+
* Chunk resource name.
|
|
1933
|
+
*/
|
|
1934
|
+
chunk?: string | null;
|
|
1935
|
+
/**
|
|
1936
|
+
* Chunk textual content.
|
|
1937
|
+
*/
|
|
1938
|
+
content?: string | null;
|
|
1939
|
+
}
|
|
1940
|
+
/**
|
|
1941
|
+
* Unstructured document information.
|
|
1942
|
+
*/
|
|
1943
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
|
|
1944
|
+
/**
|
|
1945
|
+
* Document resource name.
|
|
1946
|
+
*/
|
|
1947
|
+
document?: string | null;
|
|
1948
|
+
/**
|
|
1949
|
+
* List of document contexts.
|
|
1950
|
+
*/
|
|
1951
|
+
documentContexts?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[];
|
|
1952
|
+
/**
|
|
1953
|
+
* List of extractive answers.
|
|
1954
|
+
*/
|
|
1955
|
+
extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[];
|
|
1956
|
+
/**
|
|
1957
|
+
* List of extractive segments.
|
|
1958
|
+
*/
|
|
1959
|
+
extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[];
|
|
1960
|
+
/**
|
|
1961
|
+
* Title.
|
|
1962
|
+
*/
|
|
1963
|
+
title?: string | null;
|
|
1964
|
+
/**
|
|
1965
|
+
* URI for the document.
|
|
1966
|
+
*/
|
|
1967
|
+
uri?: string | null;
|
|
1968
|
+
}
|
|
1969
|
+
/**
|
|
1970
|
+
* Document context.
|
|
1971
|
+
*/
|
|
1972
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext {
|
|
1973
|
+
/**
|
|
1974
|
+
* Document content.
|
|
1975
|
+
*/
|
|
1976
|
+
content?: string | null;
|
|
1977
|
+
/**
|
|
1978
|
+
* Page identifier.
|
|
1979
|
+
*/
|
|
1980
|
+
pageIdentifier?: string | null;
|
|
1981
|
+
}
|
|
1982
|
+
/**
|
|
1983
|
+
* Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
|
|
1984
|
+
*/
|
|
1985
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer {
|
|
1986
|
+
/**
|
|
1987
|
+
* Extractive answer content.
|
|
1988
|
+
*/
|
|
1989
|
+
content?: string | null;
|
|
1990
|
+
/**
|
|
1991
|
+
* Page identifier.
|
|
1992
|
+
*/
|
|
1993
|
+
pageIdentifier?: string | null;
|
|
1994
|
+
}
|
|
1995
|
+
/**
|
|
1996
|
+
* Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
|
|
1997
|
+
*/
|
|
1998
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment {
|
|
1999
|
+
/**
|
|
2000
|
+
* Extractive segment content.
|
|
2001
|
+
*/
|
|
2002
|
+
content?: string | null;
|
|
2003
|
+
/**
|
|
2004
|
+
* Page identifier.
|
|
2005
|
+
*/
|
|
2006
|
+
pageIdentifier?: string | null;
|
|
2007
|
+
}
|
|
2008
|
+
/**
|
|
2009
|
+
* Response message for ConversationalSearchService.AnswerQuery method.
|
|
2010
|
+
*/
|
|
2011
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse {
|
|
2012
|
+
/**
|
|
2013
|
+
* Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
|
|
2014
|
+
*/
|
|
2015
|
+
answer?: Schema$GoogleCloudDiscoveryengineV1betaAnswer;
|
|
2016
|
+
/**
|
|
2017
|
+
* A global unique ID used for logging.
|
|
2018
|
+
*/
|
|
2019
|
+
answerQueryToken?: string | null;
|
|
2020
|
+
/**
|
|
2021
|
+
* Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
|
|
2022
|
+
*/
|
|
2023
|
+
session?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
2024
|
+
}
|
|
2025
|
+
/**
|
|
2026
|
+
* Query understanding information.
|
|
2027
|
+
*/
|
|
2028
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo {
|
|
2029
|
+
/**
|
|
2030
|
+
* Query classification information.
|
|
2031
|
+
*/
|
|
2032
|
+
queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
2033
|
+
}
|
|
2034
|
+
/**
|
|
2035
|
+
* Query classification information.
|
|
2036
|
+
*/
|
|
2037
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo {
|
|
2038
|
+
/**
|
|
2039
|
+
* Classification output.
|
|
2040
|
+
*/
|
|
2041
|
+
positive?: boolean | null;
|
|
2042
|
+
/**
|
|
2043
|
+
* Query classification type.
|
|
2044
|
+
*/
|
|
2045
|
+
type?: string | null;
|
|
2046
|
+
}
|
|
2047
|
+
/**
|
|
2048
|
+
* Reference.
|
|
2049
|
+
*/
|
|
2050
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReference {
|
|
2051
|
+
/**
|
|
2052
|
+
* Chunk information.
|
|
2053
|
+
*/
|
|
2054
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo;
|
|
2055
|
+
/**
|
|
2056
|
+
* Unstructured document information.
|
|
2057
|
+
*/
|
|
2058
|
+
unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo;
|
|
2059
|
+
}
|
|
2060
|
+
/**
|
|
2061
|
+
* Chunk information.
|
|
2062
|
+
*/
|
|
2063
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo {
|
|
2064
|
+
/**
|
|
2065
|
+
* Chunk resource name.
|
|
2066
|
+
*/
|
|
2067
|
+
chunk?: string | null;
|
|
2068
|
+
/**
|
|
2069
|
+
* Chunk textual content.
|
|
2070
|
+
*/
|
|
2071
|
+
content?: string | null;
|
|
2072
|
+
/**
|
|
2073
|
+
* Document metadata.
|
|
2074
|
+
*/
|
|
2075
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata;
|
|
2076
|
+
/**
|
|
2077
|
+
* Relevance score.
|
|
2078
|
+
*/
|
|
2079
|
+
relevanceScore?: number | null;
|
|
2080
|
+
}
|
|
2081
|
+
/**
|
|
2082
|
+
* Document metadata.
|
|
2083
|
+
*/
|
|
2084
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata {
|
|
2085
|
+
/**
|
|
2086
|
+
* Document resource name.
|
|
2087
|
+
*/
|
|
2088
|
+
document?: string | null;
|
|
2089
|
+
/**
|
|
2090
|
+
* Page identifier.
|
|
2091
|
+
*/
|
|
2092
|
+
pageIdentifier?: string | null;
|
|
2093
|
+
/**
|
|
2094
|
+
* Title.
|
|
2095
|
+
*/
|
|
2096
|
+
title?: string | null;
|
|
2097
|
+
/**
|
|
2098
|
+
* URI for the document.
|
|
2099
|
+
*/
|
|
2100
|
+
uri?: string | null;
|
|
2101
|
+
}
|
|
2102
|
+
/**
|
|
2103
|
+
* Unstructured document information.
|
|
2104
|
+
*/
|
|
2105
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo {
|
|
2106
|
+
/**
|
|
2107
|
+
* List of cited chunk contents derived from document content.
|
|
2108
|
+
*/
|
|
2109
|
+
chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
2110
|
+
/**
|
|
2111
|
+
* Document resource name.
|
|
2112
|
+
*/
|
|
2113
|
+
document?: string | null;
|
|
2114
|
+
/**
|
|
2115
|
+
* Title.
|
|
2116
|
+
*/
|
|
2117
|
+
title?: string | null;
|
|
2118
|
+
/**
|
|
2119
|
+
* URI for the document.
|
|
2120
|
+
*/
|
|
2121
|
+
uri?: string | null;
|
|
2122
|
+
}
|
|
2123
|
+
/**
|
|
2124
|
+
* Chunk content.
|
|
2125
|
+
*/
|
|
2126
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent {
|
|
2127
|
+
/**
|
|
2128
|
+
* Chunk textual content.
|
|
2129
|
+
*/
|
|
2130
|
+
content?: string | null;
|
|
2131
|
+
/**
|
|
2132
|
+
* Page identifier.
|
|
2133
|
+
*/
|
|
2134
|
+
pageIdentifier?: string | null;
|
|
2135
|
+
}
|
|
2136
|
+
/**
|
|
2137
|
+
* Step information.
|
|
2138
|
+
*/
|
|
2139
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStep {
|
|
2140
|
+
/**
|
|
2141
|
+
* Actions.
|
|
2142
|
+
*/
|
|
2143
|
+
actions?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction[];
|
|
2144
|
+
/**
|
|
2145
|
+
* The description of the step.
|
|
2146
|
+
*/
|
|
2147
|
+
description?: string | null;
|
|
2148
|
+
/**
|
|
2149
|
+
* The state of the step.
|
|
2150
|
+
*/
|
|
2151
|
+
state?: string | null;
|
|
2152
|
+
/**
|
|
2153
|
+
* The thought of the step.
|
|
2154
|
+
*/
|
|
2155
|
+
thought?: string | null;
|
|
2156
|
+
}
|
|
2157
|
+
/**
|
|
2158
|
+
* Action.
|
|
2159
|
+
*/
|
|
2160
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction {
|
|
2161
|
+
/**
|
|
2162
|
+
* Observation.
|
|
2163
|
+
*/
|
|
2164
|
+
observation?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation;
|
|
2165
|
+
/**
|
|
2166
|
+
* Search action.
|
|
2167
|
+
*/
|
|
2168
|
+
searchAction?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction;
|
|
2169
|
+
}
|
|
2170
|
+
/**
|
|
2171
|
+
* Observation.
|
|
2172
|
+
*/
|
|
2173
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation {
|
|
2174
|
+
/**
|
|
2175
|
+
* Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
|
|
2176
|
+
*/
|
|
2177
|
+
searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult[];
|
|
2178
|
+
}
|
|
2179
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult {
|
|
2180
|
+
/**
|
|
2181
|
+
* If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
|
|
2182
|
+
*/
|
|
2183
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo[];
|
|
2184
|
+
/**
|
|
2185
|
+
* Document resource name.
|
|
2186
|
+
*/
|
|
2187
|
+
document?: string | null;
|
|
2188
|
+
/**
|
|
2189
|
+
* If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
|
|
2190
|
+
*/
|
|
2191
|
+
snippetInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
2192
|
+
/**
|
|
2193
|
+
* Title.
|
|
2194
|
+
*/
|
|
2195
|
+
title?: string | null;
|
|
2196
|
+
/**
|
|
2197
|
+
* URI for the document.
|
|
2198
|
+
*/
|
|
2199
|
+
uri?: string | null;
|
|
2200
|
+
}
|
|
2201
|
+
/**
|
|
2202
|
+
* Chunk information.
|
|
2203
|
+
*/
|
|
2204
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo {
|
|
2205
|
+
/**
|
|
2206
|
+
* Chunk resource name.
|
|
2207
|
+
*/
|
|
2208
|
+
chunk?: string | null;
|
|
2209
|
+
/**
|
|
2210
|
+
* Chunk textual content.
|
|
2211
|
+
*/
|
|
2212
|
+
content?: string | null;
|
|
2213
|
+
/**
|
|
2214
|
+
* Relevance score.
|
|
2215
|
+
*/
|
|
2216
|
+
relevanceScore?: number | null;
|
|
2217
|
+
}
|
|
2218
|
+
/**
|
|
2219
|
+
* Snippet information.
|
|
2220
|
+
*/
|
|
2221
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
2222
|
+
/**
|
|
2223
|
+
* Snippet content.
|
|
2224
|
+
*/
|
|
2225
|
+
snippet?: string | null;
|
|
2226
|
+
/**
|
|
2227
|
+
* Status of the snippet defined by the search team.
|
|
2228
|
+
*/
|
|
2229
|
+
snippetStatus?: string | null;
|
|
2230
|
+
}
|
|
2231
|
+
/**
|
|
2232
|
+
* Search action.
|
|
2233
|
+
*/
|
|
2234
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction {
|
|
2235
|
+
/**
|
|
2236
|
+
* The query to search.
|
|
2237
|
+
*/
|
|
2238
|
+
query?: string | null;
|
|
2239
|
+
}
|
|
2240
|
+
/**
|
|
2241
|
+
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2242
|
+
*/
|
|
2243
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
2244
|
+
/**
|
|
2245
|
+
* Operation create time.
|
|
2246
|
+
*/
|
|
2247
|
+
createTime?: string | null;
|
|
2248
|
+
/**
|
|
2249
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1253
2250
|
*/
|
|
1254
2251
|
updateTime?: string | null;
|
|
1255
2252
|
}
|
|
@@ -1281,7 +2278,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1281
2278
|
*/
|
|
1282
2279
|
export interface Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource {
|
|
1283
2280
|
/**
|
|
1284
|
-
* The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by
|
|
2281
|
+
* The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
|
|
1285
2282
|
*/
|
|
1286
2283
|
dataSchema?: string | null;
|
|
1287
2284
|
/**
|
|
@@ -1305,6 +2302,177 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1305
2302
|
*/
|
|
1306
2303
|
tableId?: string | null;
|
|
1307
2304
|
}
|
|
2305
|
+
/**
|
|
2306
|
+
* The Bigtable Options object that contains information to support the import.
|
|
2307
|
+
*/
|
|
2308
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions {
|
|
2309
|
+
/**
|
|
2310
|
+
* The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.
|
|
2311
|
+
*/
|
|
2312
|
+
families?: {
|
|
2313
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily;
|
|
2314
|
+
} | null;
|
|
2315
|
+
/**
|
|
2316
|
+
* The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`.
|
|
2317
|
+
*/
|
|
2318
|
+
keyFieldName?: string | null;
|
|
2319
|
+
}
|
|
2320
|
+
/**
|
|
2321
|
+
* The column of the Bigtable.
|
|
2322
|
+
*/
|
|
2323
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn {
|
|
2324
|
+
/**
|
|
2325
|
+
* The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.
|
|
2326
|
+
*/
|
|
2327
|
+
encoding?: string | null;
|
|
2328
|
+
/**
|
|
2329
|
+
* The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.
|
|
2330
|
+
*/
|
|
2331
|
+
fieldName?: string | null;
|
|
2332
|
+
/**
|
|
2333
|
+
* Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.
|
|
2334
|
+
*/
|
|
2335
|
+
qualifier?: string | null;
|
|
2336
|
+
/**
|
|
2337
|
+
* The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.
|
|
2338
|
+
*/
|
|
2339
|
+
type?: string | null;
|
|
2340
|
+
}
|
|
2341
|
+
/**
|
|
2342
|
+
* The column family of the Bigtable.
|
|
2343
|
+
*/
|
|
2344
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily {
|
|
2345
|
+
/**
|
|
2346
|
+
* The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.
|
|
2347
|
+
*/
|
|
2348
|
+
columns?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn[];
|
|
2349
|
+
/**
|
|
2350
|
+
* The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.
|
|
2351
|
+
*/
|
|
2352
|
+
encoding?: string | null;
|
|
2353
|
+
/**
|
|
2354
|
+
* The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.
|
|
2355
|
+
*/
|
|
2356
|
+
fieldName?: string | null;
|
|
2357
|
+
/**
|
|
2358
|
+
* The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.
|
|
2359
|
+
*/
|
|
2360
|
+
type?: string | null;
|
|
2361
|
+
}
|
|
2362
|
+
/**
|
|
2363
|
+
* The Cloud Bigtable source for importing data.
|
|
2364
|
+
*/
|
|
2365
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableSource {
|
|
2366
|
+
/**
|
|
2367
|
+
* Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations.
|
|
2368
|
+
*/
|
|
2369
|
+
bigtableOptions?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions;
|
|
2370
|
+
/**
|
|
2371
|
+
* Required. The instance ID of the Cloud Bigtable that needs to be imported.
|
|
2372
|
+
*/
|
|
2373
|
+
instanceId?: string | null;
|
|
2374
|
+
/**
|
|
2375
|
+
* The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
|
|
2376
|
+
*/
|
|
2377
|
+
projectId?: string | null;
|
|
2378
|
+
/**
|
|
2379
|
+
* Required. The table ID of the Cloud Bigtable that needs to be imported.
|
|
2380
|
+
*/
|
|
2381
|
+
tableId?: string | null;
|
|
2382
|
+
}
|
|
2383
|
+
/**
|
|
2384
|
+
* Request message for GroundedGenerationService.CheckGrounding method.
|
|
2385
|
+
*/
|
|
2386
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest {
|
|
2387
|
+
/**
|
|
2388
|
+
* Answer candidate to check.
|
|
2389
|
+
*/
|
|
2390
|
+
answerCandidate?: string | null;
|
|
2391
|
+
/**
|
|
2392
|
+
* List of facts for the grounding check. We support up to 200 facts.
|
|
2393
|
+
*/
|
|
2394
|
+
facts?: Schema$GoogleCloudDiscoveryengineV1betaGroundingFact[];
|
|
2395
|
+
/**
|
|
2396
|
+
* Configuration of the grounding check.
|
|
2397
|
+
*/
|
|
2398
|
+
groundingSpec?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec;
|
|
2399
|
+
}
|
|
2400
|
+
/**
|
|
2401
|
+
* Response message for the GroundedGenerationService.CheckGrounding method.
|
|
2402
|
+
*/
|
|
2403
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse {
|
|
2404
|
+
/**
|
|
2405
|
+
* List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
|
|
2406
|
+
*/
|
|
2407
|
+
citedChunks?: Schema$GoogleCloudDiscoveryengineV1betaFactChunk[];
|
|
2408
|
+
/**
|
|
2409
|
+
* Claim texts and citation info across all claims in the answer candidate.
|
|
2410
|
+
*/
|
|
2411
|
+
claims?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[];
|
|
2412
|
+
/**
|
|
2413
|
+
* The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.
|
|
2414
|
+
*/
|
|
2415
|
+
supportScore?: number | null;
|
|
2416
|
+
}
|
|
2417
|
+
/**
|
|
2418
|
+
* Text and citation info for a claim in the answer candidate.
|
|
2419
|
+
*/
|
|
2420
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim {
|
|
2421
|
+
/**
|
|
2422
|
+
* A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.
|
|
2423
|
+
*/
|
|
2424
|
+
citationIndices?: number[] | null;
|
|
2425
|
+
/**
|
|
2426
|
+
* Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
|
|
2427
|
+
*/
|
|
2428
|
+
claimText?: string | null;
|
|
2429
|
+
/**
|
|
2430
|
+
* Position indicating the end of the claim in the answer candidate, exclusive.
|
|
2431
|
+
*/
|
|
2432
|
+
endPos?: number | null;
|
|
2433
|
+
/**
|
|
2434
|
+
* Position indicating the start of the claim in the answer candidate, measured in bytes.
|
|
2435
|
+
*/
|
|
2436
|
+
startPos?: number | null;
|
|
2437
|
+
}
|
|
2438
|
+
/**
|
|
2439
|
+
* Specification for the grounding check.
|
|
2440
|
+
*/
|
|
2441
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec {
|
|
2442
|
+
/**
|
|
2443
|
+
* The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.
|
|
2444
|
+
*/
|
|
2445
|
+
citationThreshold?: number | null;
|
|
2446
|
+
}
|
|
2447
|
+
/**
|
|
2448
|
+
* Cloud SQL source import data from.
|
|
2449
|
+
*/
|
|
2450
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource {
|
|
2451
|
+
/**
|
|
2452
|
+
* Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.
|
|
2453
|
+
*/
|
|
2454
|
+
databaseId?: string | null;
|
|
2455
|
+
/**
|
|
2456
|
+
* Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
|
|
2457
|
+
*/
|
|
2458
|
+
gcsStagingDir?: string | null;
|
|
2459
|
+
/**
|
|
2460
|
+
* Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.
|
|
2461
|
+
*/
|
|
2462
|
+
instanceId?: string | null;
|
|
2463
|
+
/**
|
|
2464
|
+
* Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).
|
|
2465
|
+
*/
|
|
2466
|
+
offload?: boolean | null;
|
|
2467
|
+
/**
|
|
2468
|
+
* The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
|
|
2469
|
+
*/
|
|
2470
|
+
projectId?: string | null;
|
|
2471
|
+
/**
|
|
2472
|
+
* Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.
|
|
2473
|
+
*/
|
|
2474
|
+
tableId?: string | null;
|
|
2475
|
+
}
|
|
1308
2476
|
/**
|
|
1309
2477
|
* Response message for CompletionService.CompleteQuery method.
|
|
1310
2478
|
*/
|
|
@@ -1357,7 +2525,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1357
2525
|
*/
|
|
1358
2526
|
messages?: Schema$GoogleCloudDiscoveryengineV1betaConversationMessage[];
|
|
1359
2527
|
/**
|
|
1360
|
-
* Immutable. Fully qualified name `project/
|
|
2528
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
1361
2529
|
*/
|
|
1362
2530
|
name?: string | null;
|
|
1363
2531
|
/**
|
|
@@ -1786,7 +2954,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1786
2954
|
*/
|
|
1787
2955
|
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1788
2956
|
/**
|
|
1789
|
-
*
|
|
2957
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
1790
2958
|
*/
|
|
1791
2959
|
enhancedDocumentElements?: string[] | null;
|
|
1792
2960
|
/**
|
|
@@ -1893,7 +3061,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1893
3061
|
*/
|
|
1894
3062
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
1895
3063
|
/**
|
|
1896
|
-
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
3064
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
1897
3065
|
*/
|
|
1898
3066
|
dialogflowAgentToLink?: string | null;
|
|
1899
3067
|
}
|
|
@@ -1945,10 +3113,29 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1945
3113
|
*/
|
|
1946
3114
|
searchAddOns?: string[] | null;
|
|
1947
3115
|
/**
|
|
1948
|
-
* The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
3116
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
1949
3117
|
*/
|
|
1950
3118
|
searchTier?: string | null;
|
|
1951
3119
|
}
|
|
3120
|
+
/**
|
|
3121
|
+
* Fact Chunk.
|
|
3122
|
+
*/
|
|
3123
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaFactChunk {
|
|
3124
|
+
/**
|
|
3125
|
+
* Text content of the fact chunk. Can be at most 10K characters long.
|
|
3126
|
+
*/
|
|
3127
|
+
chunkText?: string | null;
|
|
3128
|
+
/**
|
|
3129
|
+
* Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.
|
|
3130
|
+
*/
|
|
3131
|
+
source?: string | null;
|
|
3132
|
+
/**
|
|
3133
|
+
* More fine-grained information for the source reference.
|
|
3134
|
+
*/
|
|
3135
|
+
sourceMetadata?: {
|
|
3136
|
+
[key: string]: string;
|
|
3137
|
+
} | null;
|
|
3138
|
+
}
|
|
1952
3139
|
/**
|
|
1953
3140
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
1954
3141
|
*/
|
|
@@ -1966,12 +3153,46 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1966
3153
|
*/
|
|
1967
3154
|
totalSize?: number | null;
|
|
1968
3155
|
}
|
|
3156
|
+
/**
|
|
3157
|
+
* Cloud FhirStore source import data from.
|
|
3158
|
+
*/
|
|
3159
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource {
|
|
3160
|
+
/**
|
|
3161
|
+
* Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}`.
|
|
3162
|
+
*/
|
|
3163
|
+
fhirStore?: string | null;
|
|
3164
|
+
/**
|
|
3165
|
+
* Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.
|
|
3166
|
+
*/
|
|
3167
|
+
gcsStagingDir?: string | null;
|
|
3168
|
+
}
|
|
3169
|
+
/**
|
|
3170
|
+
* Firestore source import data from.
|
|
3171
|
+
*/
|
|
3172
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource {
|
|
3173
|
+
/**
|
|
3174
|
+
* Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.
|
|
3175
|
+
*/
|
|
3176
|
+
collectionId?: string | null;
|
|
3177
|
+
/**
|
|
3178
|
+
* Required. The Firestore database to copy the data from with a length limit of 256 characters.
|
|
3179
|
+
*/
|
|
3180
|
+
databaseId?: string | null;
|
|
3181
|
+
/**
|
|
3182
|
+
* Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
|
|
3183
|
+
*/
|
|
3184
|
+
gcsStagingDir?: string | null;
|
|
3185
|
+
/**
|
|
3186
|
+
* The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
|
|
3187
|
+
*/
|
|
3188
|
+
projectId?: string | null;
|
|
3189
|
+
}
|
|
1969
3190
|
/**
|
|
1970
3191
|
* Cloud Storage location for input content.
|
|
1971
3192
|
*/
|
|
1972
3193
|
export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource {
|
|
1973
3194
|
/**
|
|
1974
|
-
* The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by
|
|
3195
|
+
* The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
|
|
1975
3196
|
*/
|
|
1976
3197
|
dataSchema?: string | null;
|
|
1977
3198
|
/**
|
|
@@ -1979,6 +3200,21 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1979
3200
|
*/
|
|
1980
3201
|
inputUris?: string[] | null;
|
|
1981
3202
|
}
|
|
3203
|
+
/**
|
|
3204
|
+
* Grounding Fact.
|
|
3205
|
+
*/
|
|
3206
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaGroundingFact {
|
|
3207
|
+
/**
|
|
3208
|
+
* Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.
|
|
3209
|
+
*/
|
|
3210
|
+
attributes?: {
|
|
3211
|
+
[key: string]: string;
|
|
3212
|
+
} | null;
|
|
3213
|
+
/**
|
|
3214
|
+
* Text content of the fact. Can be at most 10K characters long.
|
|
3215
|
+
*/
|
|
3216
|
+
factText?: string | null;
|
|
3217
|
+
}
|
|
1982
3218
|
/**
|
|
1983
3219
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1984
3220
|
*/
|
|
@@ -1995,6 +3231,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1995
3231
|
* Count of entries that were processed successfully.
|
|
1996
3232
|
*/
|
|
1997
3233
|
successCount?: string | null;
|
|
3234
|
+
/**
|
|
3235
|
+
* Total count of entries that were processed.
|
|
3236
|
+
*/
|
|
3237
|
+
totalCount?: string | null;
|
|
1998
3238
|
/**
|
|
1999
3239
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2000
3240
|
*/
|
|
@@ -2005,23 +3245,39 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2005
3245
|
*/
|
|
2006
3246
|
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest {
|
|
2007
3247
|
/**
|
|
2008
|
-
* Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported.
|
|
3248
|
+
* Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
|
|
2009
3249
|
*/
|
|
2010
3250
|
autoGenerateIds?: boolean | null;
|
|
2011
3251
|
/**
|
|
2012
3252
|
* BigQuery input source.
|
|
2013
3253
|
*/
|
|
2014
3254
|
bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource;
|
|
3255
|
+
/**
|
|
3256
|
+
* Cloud Bigtable input source.
|
|
3257
|
+
*/
|
|
3258
|
+
bigtableSource?: Schema$GoogleCloudDiscoveryengineV1betaBigtableSource;
|
|
3259
|
+
/**
|
|
3260
|
+
* Cloud SQL input source.
|
|
3261
|
+
*/
|
|
3262
|
+
cloudSqlSource?: Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource;
|
|
2015
3263
|
/**
|
|
2016
3264
|
* The desired location of errors incurred during the Import.
|
|
2017
3265
|
*/
|
|
2018
3266
|
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3267
|
+
/**
|
|
3268
|
+
* FhirStore input source.
|
|
3269
|
+
*/
|
|
3270
|
+
fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource;
|
|
3271
|
+
/**
|
|
3272
|
+
* Firestore input source.
|
|
3273
|
+
*/
|
|
3274
|
+
firestoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource;
|
|
2019
3275
|
/**
|
|
2020
3276
|
* Cloud Storage location for the input content.
|
|
2021
3277
|
*/
|
|
2022
3278
|
gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
2023
3279
|
/**
|
|
2024
|
-
* The field
|
|
3280
|
+
* The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"\}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
|
|
2025
3281
|
*/
|
|
2026
3282
|
idField?: string | null;
|
|
2027
3283
|
/**
|
|
@@ -2032,6 +3288,14 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2032
3288
|
* The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
|
|
2033
3289
|
*/
|
|
2034
3290
|
reconciliationMode?: string | null;
|
|
3291
|
+
/**
|
|
3292
|
+
* Spanner input source.
|
|
3293
|
+
*/
|
|
3294
|
+
spannerSource?: Schema$GoogleCloudDiscoveryengineV1betaSpannerSource;
|
|
3295
|
+
/**
|
|
3296
|
+
* Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
|
|
3297
|
+
*/
|
|
3298
|
+
updateMask?: string | null;
|
|
2035
3299
|
}
|
|
2036
3300
|
/**
|
|
2037
3301
|
* The inline source for the input config for ImportDocuments method.
|
|
@@ -2287,6 +3551,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2287
3551
|
*/
|
|
2288
3552
|
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[];
|
|
2289
3553
|
}
|
|
3554
|
+
/**
|
|
3555
|
+
* Response for ListSessions method.
|
|
3556
|
+
*/
|
|
3557
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse {
|
|
3558
|
+
/**
|
|
3559
|
+
* Pagination token, if not returned indicates the last page.
|
|
3560
|
+
*/
|
|
3561
|
+
nextPageToken?: string | null;
|
|
3562
|
+
/**
|
|
3563
|
+
* All the Sessions for a given data store.
|
|
3564
|
+
*/
|
|
3565
|
+
sessions?: Schema$GoogleCloudDiscoveryengineV1betaSession[];
|
|
3566
|
+
}
|
|
2290
3567
|
/**
|
|
2291
3568
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
2292
3569
|
*/
|
|
@@ -2322,7 +3599,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2322
3599
|
*/
|
|
2323
3600
|
export interface Schema$GoogleCloudDiscoveryengineV1betaPageInfo {
|
|
2324
3601
|
/**
|
|
2325
|
-
* The most specific category associated with a category page. To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name,
|
|
3602
|
+
* The most specific category associated with a category page. To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales \> 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
2326
3603
|
*/
|
|
2327
3604
|
pageCategory?: string | null;
|
|
2328
3605
|
/**
|
|
@@ -2359,6 +3636,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2359
3636
|
*/
|
|
2360
3637
|
totalPanels?: number | null;
|
|
2361
3638
|
}
|
|
3639
|
+
/**
|
|
3640
|
+
* Request for pausing training of an engine.
|
|
3641
|
+
*/
|
|
3642
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest {
|
|
3643
|
+
}
|
|
2362
3644
|
/**
|
|
2363
3645
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2364
3646
|
*/
|
|
@@ -2404,42 +3686,110 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2404
3686
|
/**
|
|
2405
3687
|
* The total count of documents purged as a result of the operation.
|
|
2406
3688
|
*/
|
|
2407
|
-
purgeCount?: string | null;
|
|
3689
|
+
purgeCount?: string | null;
|
|
3690
|
+
/**
|
|
3691
|
+
* A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.
|
|
3692
|
+
*/
|
|
3693
|
+
purgeSample?: string[] | null;
|
|
3694
|
+
}
|
|
3695
|
+
/**
|
|
3696
|
+
* Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
3697
|
+
*/
|
|
3698
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
3699
|
+
/**
|
|
3700
|
+
* Operation create time.
|
|
3701
|
+
*/
|
|
3702
|
+
createTime?: string | null;
|
|
3703
|
+
/**
|
|
3704
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3705
|
+
*/
|
|
3706
|
+
updateTime?: string | null;
|
|
3707
|
+
}
|
|
3708
|
+
/**
|
|
3709
|
+
* Request message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3710
|
+
*/
|
|
3711
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest {
|
|
3712
|
+
}
|
|
3713
|
+
/**
|
|
3714
|
+
* Response message for CompletionService.PurgeSuggestionDenyListEntries method.
|
|
3715
|
+
*/
|
|
3716
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse {
|
|
3717
|
+
/**
|
|
3718
|
+
* A sample of errors encountered while processing the request.
|
|
3719
|
+
*/
|
|
3720
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3721
|
+
/**
|
|
3722
|
+
* Number of suggestion deny list entries purged.
|
|
3723
|
+
*/
|
|
3724
|
+
purgeCount?: string | null;
|
|
3725
|
+
}
|
|
3726
|
+
/**
|
|
3727
|
+
* Defines a user inputed query.
|
|
3728
|
+
*/
|
|
3729
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaQuery {
|
|
3730
|
+
/**
|
|
3731
|
+
* Unique Id for the query.
|
|
3732
|
+
*/
|
|
3733
|
+
queryId?: string | null;
|
|
3734
|
+
/**
|
|
3735
|
+
* Plain text.
|
|
3736
|
+
*/
|
|
3737
|
+
text?: string | null;
|
|
3738
|
+
}
|
|
3739
|
+
/**
|
|
3740
|
+
* Record message for RankService.Rank method.
|
|
3741
|
+
*/
|
|
3742
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaRankingRecord {
|
|
3743
|
+
/**
|
|
3744
|
+
* The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
|
|
3745
|
+
*/
|
|
3746
|
+
content?: string | null;
|
|
3747
|
+
/**
|
|
3748
|
+
* The unique ID to represent the record.
|
|
3749
|
+
*/
|
|
3750
|
+
id?: string | null;
|
|
3751
|
+
/**
|
|
3752
|
+
* The score of this record based on the given query and selected model.
|
|
3753
|
+
*/
|
|
3754
|
+
score?: number | null;
|
|
2408
3755
|
/**
|
|
2409
|
-
*
|
|
3756
|
+
* The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
|
|
2410
3757
|
*/
|
|
2411
|
-
|
|
3758
|
+
title?: string | null;
|
|
2412
3759
|
}
|
|
2413
3760
|
/**
|
|
2414
|
-
*
|
|
3761
|
+
* Request message for RankService.Rank method.
|
|
2415
3762
|
*/
|
|
2416
|
-
export interface Schema$
|
|
3763
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaRankRequest {
|
|
2417
3764
|
/**
|
|
2418
|
-
*
|
|
3765
|
+
* If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
|
|
2419
3766
|
*/
|
|
2420
|
-
|
|
3767
|
+
ignoreRecordDetailsInResponse?: boolean | null;
|
|
2421
3768
|
/**
|
|
2422
|
-
*
|
|
3769
|
+
* The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.
|
|
2423
3770
|
*/
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
|
-
|
|
3771
|
+
model?: string | null;
|
|
3772
|
+
/**
|
|
3773
|
+
* The query to use.
|
|
3774
|
+
*/
|
|
3775
|
+
query?: string | null;
|
|
3776
|
+
/**
|
|
3777
|
+
* Required. A list of records to rank. At most 200 records to rank.
|
|
3778
|
+
*/
|
|
3779
|
+
records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
3780
|
+
/**
|
|
3781
|
+
* The number of results to return. If this is unset or no bigger than zero, returns all results.
|
|
3782
|
+
*/
|
|
3783
|
+
topN?: number | null;
|
|
2430
3784
|
}
|
|
2431
3785
|
/**
|
|
2432
|
-
* Response message for
|
|
3786
|
+
* Response message for RankService.Rank method.
|
|
2433
3787
|
*/
|
|
2434
|
-
export interface Schema$
|
|
3788
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaRankResponse {
|
|
2435
3789
|
/**
|
|
2436
|
-
* A
|
|
2437
|
-
*/
|
|
2438
|
-
errorSamples?: Schema$GoogleRpcStatus[];
|
|
2439
|
-
/**
|
|
2440
|
-
* Number of suggestion deny list entries purged.
|
|
3790
|
+
* A list of records sorted by descending score.
|
|
2441
3791
|
*/
|
|
2442
|
-
|
|
3792
|
+
records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
2443
3793
|
}
|
|
2444
3794
|
/**
|
|
2445
3795
|
* Request message for Recommend method.
|
|
@@ -2561,6 +3911,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2561
3911
|
*/
|
|
2562
3912
|
uri?: string | null;
|
|
2563
3913
|
}
|
|
3914
|
+
/**
|
|
3915
|
+
* Request for resuming training of an engine.
|
|
3916
|
+
*/
|
|
3917
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest {
|
|
3918
|
+
}
|
|
2564
3919
|
/**
|
|
2565
3920
|
* Defines the structure and layout of a type of document data.
|
|
2566
3921
|
*/
|
|
@@ -2646,7 +4001,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2646
4001
|
*/
|
|
2647
4002
|
orderBy?: string | null;
|
|
2648
4003
|
/**
|
|
2649
|
-
* Maximum number of Documents to return.
|
|
4004
|
+
* Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
2650
4005
|
*/
|
|
2651
4006
|
pageSize?: number | null;
|
|
2652
4007
|
/**
|
|
@@ -2711,11 +4066,49 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2711
4066
|
* Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
|
|
2712
4067
|
*/
|
|
2713
4068
|
boost?: number | null;
|
|
4069
|
+
/**
|
|
4070
|
+
* Complex specification for custom ranking based on customer defined attribute value.
|
|
4071
|
+
*/
|
|
4072
|
+
boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
2714
4073
|
/**
|
|
2715
4074
|
* An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
|
|
2716
4075
|
*/
|
|
2717
4076
|
condition?: string | null;
|
|
2718
4077
|
}
|
|
4078
|
+
/**
|
|
4079
|
+
* Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
|
|
4080
|
+
*/
|
|
4081
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
|
|
4082
|
+
/**
|
|
4083
|
+
* The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
|
|
4084
|
+
*/
|
|
4085
|
+
attributeType?: string | null;
|
|
4086
|
+
/**
|
|
4087
|
+
* The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
|
|
4088
|
+
*/
|
|
4089
|
+
controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
4090
|
+
/**
|
|
4091
|
+
* The name of the field whose value will be used to determine the boost amount.
|
|
4092
|
+
*/
|
|
4093
|
+
fieldName?: string | null;
|
|
4094
|
+
/**
|
|
4095
|
+
* The interpolation type to be applied to connect the control points listed below.
|
|
4096
|
+
*/
|
|
4097
|
+
interpolationType?: string | null;
|
|
4098
|
+
}
|
|
4099
|
+
/**
|
|
4100
|
+
* The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
|
|
4101
|
+
*/
|
|
4102
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
4103
|
+
/**
|
|
4104
|
+
* Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
|
|
4105
|
+
*/
|
|
4106
|
+
attributeValue?: string | null;
|
|
4107
|
+
/**
|
|
4108
|
+
* The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
|
|
4109
|
+
*/
|
|
4110
|
+
boostAmount?: number | null;
|
|
4111
|
+
}
|
|
2719
4112
|
/**
|
|
2720
4113
|
* A specification for configuring the behavior of content search.
|
|
2721
4114
|
*/
|
|
@@ -2754,7 +4147,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2754
4147
|
*/
|
|
2755
4148
|
numPreviousSegments?: number | null;
|
|
2756
4149
|
/**
|
|
2757
|
-
* Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store,
|
|
4150
|
+
* Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
|
|
2758
4151
|
*/
|
|
2759
4152
|
returnExtractiveSegmentScore?: boolean | null;
|
|
2760
4153
|
}
|
|
@@ -2804,11 +4197,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2804
4197
|
*/
|
|
2805
4198
|
modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
2806
4199
|
/**
|
|
2807
|
-
* The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary.
|
|
4200
|
+
* The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
|
|
2808
4201
|
*/
|
|
2809
4202
|
summaryResultCount?: number | null;
|
|
2810
4203
|
/**
|
|
2811
|
-
* If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality.
|
|
4204
|
+
* If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
|
|
2812
4205
|
*/
|
|
2813
4206
|
useSemanticChunks?: boolean | null;
|
|
2814
4207
|
}
|
|
@@ -3161,6 +4554,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3161
4554
|
* Document reference.
|
|
3162
4555
|
*/
|
|
3163
4556
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference {
|
|
4557
|
+
/**
|
|
4558
|
+
* List of cited chunk contents derived from document content.
|
|
4559
|
+
*/
|
|
4560
|
+
chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[];
|
|
3164
4561
|
/**
|
|
3165
4562
|
* Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`.
|
|
3166
4563
|
*/
|
|
@@ -3174,6 +4571,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3174
4571
|
*/
|
|
3175
4572
|
uri?: string | null;
|
|
3176
4573
|
}
|
|
4574
|
+
/**
|
|
4575
|
+
* Chunk content.
|
|
4576
|
+
*/
|
|
4577
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent {
|
|
4578
|
+
/**
|
|
4579
|
+
* Chunk textual content.
|
|
4580
|
+
*/
|
|
4581
|
+
content?: string | null;
|
|
4582
|
+
/**
|
|
4583
|
+
* Page identifier.
|
|
4584
|
+
*/
|
|
4585
|
+
pageIdentifier?: string | null;
|
|
4586
|
+
}
|
|
3177
4587
|
/**
|
|
3178
4588
|
* Safety Attribute categories and their associated confidence scores.
|
|
3179
4589
|
*/
|
|
@@ -3315,6 +4725,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3315
4725
|
*/
|
|
3316
4726
|
demotionEventType?: string | null;
|
|
3317
4727
|
}
|
|
4728
|
+
/**
|
|
4729
|
+
* External session proto definition.
|
|
4730
|
+
*/
|
|
4731
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSession {
|
|
4732
|
+
/**
|
|
4733
|
+
* Output only. The time the session finished.
|
|
4734
|
+
*/
|
|
4735
|
+
endTime?: string | null;
|
|
4736
|
+
/**
|
|
4737
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
4738
|
+
*/
|
|
4739
|
+
name?: string | null;
|
|
4740
|
+
/**
|
|
4741
|
+
* Output only. The time the session started.
|
|
4742
|
+
*/
|
|
4743
|
+
startTime?: string | null;
|
|
4744
|
+
/**
|
|
4745
|
+
* The state of the session.
|
|
4746
|
+
*/
|
|
4747
|
+
state?: string | null;
|
|
4748
|
+
/**
|
|
4749
|
+
* Turns.
|
|
4750
|
+
*/
|
|
4751
|
+
turns?: Schema$GoogleCloudDiscoveryengineV1betaSessionTurn[];
|
|
4752
|
+
/**
|
|
4753
|
+
* A unique identifier for tracking users.
|
|
4754
|
+
*/
|
|
4755
|
+
userPseudoId?: string | null;
|
|
4756
|
+
}
|
|
4757
|
+
/**
|
|
4758
|
+
* Represents a turn, including a query from the user and a answer from service.
|
|
4759
|
+
*/
|
|
4760
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSessionTurn {
|
|
4761
|
+
/**
|
|
4762
|
+
* The resource name of the answer to the user query.
|
|
4763
|
+
*/
|
|
4764
|
+
answer?: string | null;
|
|
4765
|
+
/**
|
|
4766
|
+
* The user query.
|
|
4767
|
+
*/
|
|
4768
|
+
query?: Schema$GoogleCloudDiscoveryengineV1betaQuery;
|
|
4769
|
+
}
|
|
3318
4770
|
/**
|
|
3319
4771
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
3320
4772
|
*/
|
|
@@ -3337,6 +4789,31 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3337
4789
|
*/
|
|
3338
4790
|
verifyTime?: string | null;
|
|
3339
4791
|
}
|
|
4792
|
+
/**
|
|
4793
|
+
* The Spanner source for importing data
|
|
4794
|
+
*/
|
|
4795
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSpannerSource {
|
|
4796
|
+
/**
|
|
4797
|
+
* Required. The database ID of the source Spanner table.
|
|
4798
|
+
*/
|
|
4799
|
+
databaseId?: string | null;
|
|
4800
|
+
/**
|
|
4801
|
+
* Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
|
|
4802
|
+
*/
|
|
4803
|
+
enableDataBoost?: boolean | null;
|
|
4804
|
+
/**
|
|
4805
|
+
* Required. The instance ID of the source Spanner table.
|
|
4806
|
+
*/
|
|
4807
|
+
instanceId?: string | null;
|
|
4808
|
+
/**
|
|
4809
|
+
* The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
|
|
4810
|
+
*/
|
|
4811
|
+
projectId?: string | null;
|
|
4812
|
+
/**
|
|
4813
|
+
* Required. The table name of the Spanner database that needs to be imported.
|
|
4814
|
+
*/
|
|
4815
|
+
tableId?: string | null;
|
|
4816
|
+
}
|
|
3340
4817
|
/**
|
|
3341
4818
|
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
3342
4819
|
*/
|
|
@@ -3486,7 +4963,13 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3486
4963
|
*/
|
|
3487
4964
|
errorSamples?: Schema$GoogleRpcStatus[];
|
|
3488
4965
|
/**
|
|
3489
|
-
* The
|
|
4966
|
+
* The metrics of the trained model.
|
|
4967
|
+
*/
|
|
4968
|
+
metrics?: {
|
|
4969
|
+
[key: string]: number;
|
|
4970
|
+
} | null;
|
|
4971
|
+
/**
|
|
4972
|
+
* The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.
|
|
3490
4973
|
*/
|
|
3491
4974
|
modelStatus?: string | null;
|
|
3492
4975
|
}
|
|
@@ -3519,6 +5002,25 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3519
5002
|
*/
|
|
3520
5003
|
value?: number | null;
|
|
3521
5004
|
}
|
|
5005
|
+
/**
|
|
5006
|
+
* Metadata associated with a tune operation.
|
|
5007
|
+
*/
|
|
5008
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
5009
|
+
/**
|
|
5010
|
+
* Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
5011
|
+
*/
|
|
5012
|
+
engine?: string | null;
|
|
5013
|
+
}
|
|
5014
|
+
/**
|
|
5015
|
+
* Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
|
|
5016
|
+
*/
|
|
5017
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest {
|
|
5018
|
+
}
|
|
5019
|
+
/**
|
|
5020
|
+
* Response associated with a tune operation.
|
|
5021
|
+
*/
|
|
5022
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {
|
|
5023
|
+
}
|
|
3522
5024
|
/**
|
|
3523
5025
|
* Metadata for UpdateSchema LRO.
|
|
3524
5026
|
*/
|
|
@@ -3842,7 +5344,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3842
5344
|
*/
|
|
3843
5345
|
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
3844
5346
|
/**
|
|
3845
|
-
*
|
|
5347
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
3846
5348
|
*/
|
|
3847
5349
|
enhancedDocumentElements?: string[] | null;
|
|
3848
5350
|
/**
|
|
@@ -3926,7 +5428,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3926
5428
|
*/
|
|
3927
5429
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
3928
5430
|
/**
|
|
3929
|
-
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
5431
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.
|
|
3930
5432
|
*/
|
|
3931
5433
|
dialogflowAgentToLink?: string | null;
|
|
3932
5434
|
}
|
|
@@ -3978,7 +5480,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3978
5480
|
*/
|
|
3979
5481
|
searchAddOns?: string[] | null;
|
|
3980
5482
|
/**
|
|
3981
|
-
* The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
5483
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
3982
5484
|
*/
|
|
3983
5485
|
searchTier?: string | null;
|
|
3984
5486
|
}
|
|
@@ -3998,6 +5500,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3998
5500
|
* Count of entries that were processed successfully.
|
|
3999
5501
|
*/
|
|
4000
5502
|
successCount?: string | null;
|
|
5503
|
+
/**
|
|
5504
|
+
* Total count of entries that were processed.
|
|
5505
|
+
*/
|
|
5506
|
+
totalCount?: string | null;
|
|
4001
5507
|
/**
|
|
4002
5508
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4003
5509
|
*/
|
|
@@ -4371,7 +5877,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4371
5877
|
context: APIRequestContext;
|
|
4372
5878
|
collections: Resource$Projects$Locations$Collections;
|
|
4373
5879
|
dataStores: Resource$Projects$Locations$Datastores;
|
|
5880
|
+
groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
|
|
4374
5881
|
operations: Resource$Projects$Locations$Operations;
|
|
5882
|
+
rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
|
|
5883
|
+
userEvents: Resource$Projects$Locations$Userevents;
|
|
4375
5884
|
constructor(context: APIRequestContext);
|
|
4376
5885
|
}
|
|
4377
5886
|
export class Resource$Projects$Locations$Collections {
|
|
@@ -4451,6 +5960,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4451
5960
|
operations: Resource$Projects$Locations$Collections$Datastores$Operations;
|
|
4452
5961
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
4453
5962
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
5963
|
+
sessions: Resource$Projects$Locations$Collections$Datastores$Sessions;
|
|
4454
5964
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
4455
5965
|
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
4456
5966
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
@@ -4835,6 +6345,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4835
6345
|
* Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
4836
6346
|
*/
|
|
4837
6347
|
name?: string;
|
|
6348
|
+
/**
|
|
6349
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
6350
|
+
*/
|
|
6351
|
+
updateMask?: string;
|
|
4838
6352
|
/**
|
|
4839
6353
|
* Request body metadata
|
|
4840
6354
|
*/
|
|
@@ -5050,7 +6564,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5050
6564
|
}
|
|
5051
6565
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters {
|
|
5052
6566
|
/**
|
|
5053
|
-
* Immutable. Fully qualified name `project/
|
|
6567
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
5054
6568
|
*/
|
|
5055
6569
|
name?: string;
|
|
5056
6570
|
/**
|
|
@@ -5367,6 +6881,20 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5367
6881
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
5368
6882
|
context: APIRequestContext;
|
|
5369
6883
|
constructor(context: APIRequestContext);
|
|
6884
|
+
/**
|
|
6885
|
+
* Answer query method.
|
|
6886
|
+
*
|
|
6887
|
+
* @param params - Parameters for request
|
|
6888
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6889
|
+
* @param callback - Optional callback that handles the response.
|
|
6890
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6891
|
+
*/
|
|
6892
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6893
|
+
answer(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
6894
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6895
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
6896
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
6897
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
5370
6898
|
/**
|
|
5371
6899
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
5372
6900
|
*
|
|
@@ -5403,94 +6931,261 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5403
6931
|
* @param callback - Optional callback that handles the response.
|
|
5404
6932
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5405
6933
|
*/
|
|
5406
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
5407
|
-
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
5408
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5409
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5410
|
-
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
5411
|
-
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6934
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6935
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6936
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6937
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6938
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6939
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6940
|
+
/**
|
|
6941
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
6942
|
+
*
|
|
6943
|
+
* @param params - Parameters for request
|
|
6944
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6945
|
+
* @param callback - Optional callback that handles the response.
|
|
6946
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6947
|
+
*/
|
|
6948
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6949
|
+
recommend(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
6950
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6951
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
6952
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
6953
|
+
recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
6954
|
+
/**
|
|
6955
|
+
* Performs a search.
|
|
6956
|
+
*
|
|
6957
|
+
* @param params - Parameters for request
|
|
6958
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6959
|
+
* @param callback - Optional callback that handles the response.
|
|
6960
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6961
|
+
*/
|
|
6962
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6963
|
+
search(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
6964
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6965
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
6966
|
+
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
6967
|
+
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
6968
|
+
}
|
|
6969
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer extends StandardParameters {
|
|
6970
|
+
/**
|
|
6971
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
6972
|
+
*/
|
|
6973
|
+
servingConfig?: string;
|
|
6974
|
+
/**
|
|
6975
|
+
* Request body metadata
|
|
6976
|
+
*/
|
|
6977
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
6978
|
+
}
|
|
6979
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
6980
|
+
/**
|
|
6981
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
6982
|
+
*/
|
|
6983
|
+
name?: string;
|
|
6984
|
+
}
|
|
6985
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
|
|
6986
|
+
/**
|
|
6987
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
6988
|
+
*/
|
|
6989
|
+
pageSize?: number;
|
|
6990
|
+
/**
|
|
6991
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
6992
|
+
*/
|
|
6993
|
+
pageToken?: string;
|
|
6994
|
+
/**
|
|
6995
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
6996
|
+
*/
|
|
6997
|
+
parent?: string;
|
|
6998
|
+
}
|
|
6999
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
7000
|
+
/**
|
|
7001
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
7002
|
+
*/
|
|
7003
|
+
name?: string;
|
|
7004
|
+
/**
|
|
7005
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
7006
|
+
*/
|
|
7007
|
+
updateMask?: string;
|
|
7008
|
+
/**
|
|
7009
|
+
* Request body metadata
|
|
7010
|
+
*/
|
|
7011
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
7012
|
+
}
|
|
7013
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
7014
|
+
/**
|
|
7015
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
7016
|
+
*/
|
|
7017
|
+
servingConfig?: string;
|
|
7018
|
+
/**
|
|
7019
|
+
* Request body metadata
|
|
7020
|
+
*/
|
|
7021
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest;
|
|
7022
|
+
}
|
|
7023
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search extends StandardParameters {
|
|
7024
|
+
/**
|
|
7025
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
7026
|
+
*/
|
|
7027
|
+
servingConfig?: string;
|
|
7028
|
+
/**
|
|
7029
|
+
* Request body metadata
|
|
7030
|
+
*/
|
|
7031
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
7032
|
+
}
|
|
7033
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sessions {
|
|
7034
|
+
context: APIRequestContext;
|
|
7035
|
+
answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers;
|
|
7036
|
+
constructor(context: APIRequestContext);
|
|
7037
|
+
/**
|
|
7038
|
+
* Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
|
|
7039
|
+
*
|
|
7040
|
+
* @param params - Parameters for request
|
|
7041
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7042
|
+
* @param callback - Optional callback that handles the response.
|
|
7043
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7044
|
+
*/
|
|
7045
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7046
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
7047
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7048
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
7049
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
7050
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
7051
|
+
/**
|
|
7052
|
+
* Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
|
|
7053
|
+
*
|
|
7054
|
+
* @param params - Parameters for request
|
|
7055
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7056
|
+
* @param callback - Optional callback that handles the response.
|
|
7057
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7058
|
+
*/
|
|
7059
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7060
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
|
|
7061
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7062
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
7063
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
7064
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
7065
|
+
/**
|
|
7066
|
+
* Gets a Session.
|
|
7067
|
+
*
|
|
7068
|
+
* @param params - Parameters for request
|
|
7069
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7070
|
+
* @param callback - Optional callback that handles the response.
|
|
7071
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7072
|
+
*/
|
|
7073
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7074
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
7075
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7076
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
7077
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
7078
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
5412
7079
|
/**
|
|
5413
|
-
*
|
|
7080
|
+
* Lists all Sessions by their parent DataStore.
|
|
5414
7081
|
*
|
|
5415
7082
|
* @param params - Parameters for request
|
|
5416
7083
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5417
7084
|
* @param callback - Optional callback that handles the response.
|
|
5418
7085
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5419
7086
|
*/
|
|
5420
|
-
|
|
5421
|
-
|
|
5422
|
-
|
|
5423
|
-
|
|
5424
|
-
|
|
5425
|
-
|
|
7087
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7088
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>;
|
|
7089
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7090
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
7091
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
7092
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
5426
7093
|
/**
|
|
5427
|
-
*
|
|
7094
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
5428
7095
|
*
|
|
5429
7096
|
* @param params - Parameters for request
|
|
5430
7097
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5431
7098
|
* @param callback - Optional callback that handles the response.
|
|
5432
7099
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5433
7100
|
*/
|
|
5434
|
-
|
|
5435
|
-
|
|
5436
|
-
|
|
5437
|
-
|
|
5438
|
-
|
|
5439
|
-
|
|
7101
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7102
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
7103
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7104
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
7105
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
7106
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
5440
7107
|
}
|
|
5441
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
7108
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters {
|
|
5442
7109
|
/**
|
|
5443
|
-
* Required.
|
|
7110
|
+
* Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
7111
|
+
*/
|
|
7112
|
+
parent?: string;
|
|
7113
|
+
/**
|
|
7114
|
+
* Request body metadata
|
|
7115
|
+
*/
|
|
7116
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
7117
|
+
}
|
|
7118
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete extends StandardParameters {
|
|
7119
|
+
/**
|
|
7120
|
+
* Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
5444
7121
|
*/
|
|
5445
7122
|
name?: string;
|
|
5446
7123
|
}
|
|
5447
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
7124
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters {
|
|
5448
7125
|
/**
|
|
5449
|
-
*
|
|
7126
|
+
* Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
7127
|
+
*/
|
|
7128
|
+
name?: string;
|
|
7129
|
+
}
|
|
7130
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List extends StandardParameters {
|
|
7131
|
+
/**
|
|
7132
|
+
* A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
|
7133
|
+
*/
|
|
7134
|
+
filter?: string;
|
|
7135
|
+
/**
|
|
7136
|
+
* 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` Example: "update_time desc" "create_time"
|
|
7137
|
+
*/
|
|
7138
|
+
orderBy?: string;
|
|
7139
|
+
/**
|
|
7140
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
5450
7141
|
*/
|
|
5451
7142
|
pageSize?: number;
|
|
5452
7143
|
/**
|
|
5453
|
-
*
|
|
7144
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
5454
7145
|
*/
|
|
5455
7146
|
pageToken?: string;
|
|
5456
7147
|
/**
|
|
5457
|
-
* Required.
|
|
7148
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
5458
7149
|
*/
|
|
5459
7150
|
parent?: string;
|
|
5460
7151
|
}
|
|
5461
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
7152
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch extends StandardParameters {
|
|
5462
7153
|
/**
|
|
5463
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/
|
|
7154
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
5464
7155
|
*/
|
|
5465
7156
|
name?: string;
|
|
5466
7157
|
/**
|
|
5467
|
-
* Indicates which fields in the provided
|
|
7158
|
+
* 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.
|
|
5468
7159
|
*/
|
|
5469
7160
|
updateMask?: string;
|
|
5470
7161
|
/**
|
|
5471
7162
|
* Request body metadata
|
|
5472
7163
|
*/
|
|
5473
|
-
requestBody?: Schema$
|
|
7164
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
5474
7165
|
}
|
|
5475
|
-
export
|
|
5476
|
-
|
|
5477
|
-
|
|
5478
|
-
*/
|
|
5479
|
-
servingConfig?: string;
|
|
7166
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers {
|
|
7167
|
+
context: APIRequestContext;
|
|
7168
|
+
constructor(context: APIRequestContext);
|
|
5480
7169
|
/**
|
|
5481
|
-
*
|
|
7170
|
+
* Gets a Answer.
|
|
7171
|
+
*
|
|
7172
|
+
* @param params - Parameters for request
|
|
7173
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7174
|
+
* @param callback - Optional callback that handles the response.
|
|
7175
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5482
7176
|
*/
|
|
5483
|
-
|
|
7177
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7178
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaAnswer>;
|
|
7179
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7180
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
7181
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
7182
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
5484
7183
|
}
|
|
5485
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5486
|
-
/**
|
|
5487
|
-
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
5488
|
-
*/
|
|
5489
|
-
servingConfig?: string;
|
|
7184
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters {
|
|
5490
7185
|
/**
|
|
5491
|
-
*
|
|
7186
|
+
* Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
5492
7187
|
*/
|
|
5493
|
-
|
|
7188
|
+
name?: string;
|
|
5494
7189
|
}
|
|
5495
7190
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
|
|
5496
7191
|
context: APIRequestContext;
|
|
@@ -6007,7 +7702,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6007
7702
|
}
|
|
6008
7703
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters {
|
|
6009
7704
|
/**
|
|
6010
|
-
* Required. The parent
|
|
7705
|
+
* Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
6011
7706
|
*/
|
|
6012
7707
|
parent?: string;
|
|
6013
7708
|
/**
|
|
@@ -6020,6 +7715,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6020
7715
|
conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
|
|
6021
7716
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
6022
7717
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
7718
|
+
sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
|
|
6023
7719
|
constructor(context: APIRequestContext);
|
|
6024
7720
|
/**
|
|
6025
7721
|
* Creates a Engine.
|
|
@@ -6091,6 +7787,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6091
7787
|
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
6092
7788
|
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
6093
7789
|
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
7790
|
+
/**
|
|
7791
|
+
* Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
7792
|
+
*
|
|
7793
|
+
* @param params - Parameters for request
|
|
7794
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7795
|
+
* @param callback - Optional callback that handles the response.
|
|
7796
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7797
|
+
*/
|
|
7798
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7799
|
+
pause(params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaEngine>;
|
|
7800
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7801
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
7802
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
7803
|
+
pause(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
7804
|
+
/**
|
|
7805
|
+
* Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
7806
|
+
*
|
|
7807
|
+
* @param params - Parameters for request
|
|
7808
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7809
|
+
* @param callback - Optional callback that handles the response.
|
|
7810
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7811
|
+
*/
|
|
7812
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7813
|
+
resume(params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaEngine>;
|
|
7814
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7815
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
7816
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
7817
|
+
resume(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
7818
|
+
/**
|
|
7819
|
+
* Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
|
|
7820
|
+
*
|
|
7821
|
+
* @param params - Parameters for request
|
|
7822
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7823
|
+
* @param callback - Optional callback that handles the response.
|
|
7824
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7825
|
+
*/
|
|
7826
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7827
|
+
tune(params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
7828
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7829
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7830
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
7831
|
+
tune(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6094
7832
|
}
|
|
6095
7833
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
|
|
6096
7834
|
/**
|
|
@@ -6150,6 +7888,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6150
7888
|
*/
|
|
6151
7889
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine;
|
|
6152
7890
|
}
|
|
7891
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Pause extends StandardParameters {
|
|
7892
|
+
/**
|
|
7893
|
+
* Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
7894
|
+
*/
|
|
7895
|
+
name?: string;
|
|
7896
|
+
/**
|
|
7897
|
+
* Request body metadata
|
|
7898
|
+
*/
|
|
7899
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest;
|
|
7900
|
+
}
|
|
7901
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Resume extends StandardParameters {
|
|
7902
|
+
/**
|
|
7903
|
+
* Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
7904
|
+
*/
|
|
7905
|
+
name?: string;
|
|
7906
|
+
/**
|
|
7907
|
+
* Request body metadata
|
|
7908
|
+
*/
|
|
7909
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest;
|
|
7910
|
+
}
|
|
7911
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Tune extends StandardParameters {
|
|
7912
|
+
/**
|
|
7913
|
+
* Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
7914
|
+
*/
|
|
7915
|
+
name?: string;
|
|
7916
|
+
/**
|
|
7917
|
+
* Request body metadata
|
|
7918
|
+
*/
|
|
7919
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest;
|
|
7920
|
+
}
|
|
6153
7921
|
export class Resource$Projects$Locations$Collections$Engines$Conversations {
|
|
6154
7922
|
context: APIRequestContext;
|
|
6155
7923
|
constructor(context: APIRequestContext);
|
|
@@ -6294,7 +8062,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6294
8062
|
}
|
|
6295
8063
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch extends StandardParameters {
|
|
6296
8064
|
/**
|
|
6297
|
-
* Immutable. Fully qualified name `project/
|
|
8065
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
6298
8066
|
*/
|
|
6299
8067
|
name?: string;
|
|
6300
8068
|
/**
|
|
@@ -6365,6 +8133,20 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6365
8133
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
6366
8134
|
context: APIRequestContext;
|
|
6367
8135
|
constructor(context: APIRequestContext);
|
|
8136
|
+
/**
|
|
8137
|
+
* Answer query method.
|
|
8138
|
+
*
|
|
8139
|
+
* @param params - Parameters for request
|
|
8140
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8141
|
+
* @param callback - Optional callback that handles the response.
|
|
8142
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8143
|
+
*/
|
|
8144
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8145
|
+
answer(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
8146
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8147
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
8148
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
8149
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
6368
8150
|
/**
|
|
6369
8151
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
6370
8152
|
*
|
|
@@ -6373,122 +8155,289 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6373
8155
|
* @param callback - Optional callback that handles the response.
|
|
6374
8156
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6375
8157
|
*/
|
|
6376
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6377
|
-
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
6378
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6379
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6380
|
-
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
6381
|
-
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
8158
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8159
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
8160
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8161
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
8162
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
8163
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
8164
|
+
/**
|
|
8165
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
8166
|
+
*
|
|
8167
|
+
* @param params - Parameters for request
|
|
8168
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8169
|
+
* @param callback - Optional callback that handles the response.
|
|
8170
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8171
|
+
*/
|
|
8172
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8173
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
8174
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8175
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
8176
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
8177
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
8178
|
+
/**
|
|
8179
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
8180
|
+
*
|
|
8181
|
+
* @param params - Parameters for request
|
|
8182
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8183
|
+
* @param callback - Optional callback that handles the response.
|
|
8184
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8185
|
+
*/
|
|
8186
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8187
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
8188
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8189
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
8190
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
8191
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>): void;
|
|
8192
|
+
/**
|
|
8193
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
8194
|
+
*
|
|
8195
|
+
* @param params - Parameters for request
|
|
8196
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8197
|
+
* @param callback - Optional callback that handles the response.
|
|
8198
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8199
|
+
*/
|
|
8200
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8201
|
+
recommend(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
8202
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8203
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
8204
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
8205
|
+
recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
8206
|
+
/**
|
|
8207
|
+
* Performs a search.
|
|
8208
|
+
*
|
|
8209
|
+
* @param params - Parameters for request
|
|
8210
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8211
|
+
* @param callback - Optional callback that handles the response.
|
|
8212
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8213
|
+
*/
|
|
8214
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8215
|
+
search(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
8216
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8217
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
8218
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
8219
|
+
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
8220
|
+
}
|
|
8221
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer extends StandardParameters {
|
|
8222
|
+
/**
|
|
8223
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
8224
|
+
*/
|
|
8225
|
+
servingConfig?: string;
|
|
8226
|
+
/**
|
|
8227
|
+
* Request body metadata
|
|
8228
|
+
*/
|
|
8229
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
8230
|
+
}
|
|
8231
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
8232
|
+
/**
|
|
8233
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
8234
|
+
*/
|
|
8235
|
+
name?: string;
|
|
8236
|
+
}
|
|
8237
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
|
|
8238
|
+
/**
|
|
8239
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
8240
|
+
*/
|
|
8241
|
+
pageSize?: number;
|
|
8242
|
+
/**
|
|
8243
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
8244
|
+
*/
|
|
8245
|
+
pageToken?: string;
|
|
8246
|
+
/**
|
|
8247
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
8248
|
+
*/
|
|
8249
|
+
parent?: string;
|
|
8250
|
+
}
|
|
8251
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
8252
|
+
/**
|
|
8253
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
8254
|
+
*/
|
|
8255
|
+
name?: string;
|
|
8256
|
+
/**
|
|
8257
|
+
* Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
|
|
8258
|
+
*/
|
|
8259
|
+
updateMask?: string;
|
|
8260
|
+
/**
|
|
8261
|
+
* Request body metadata
|
|
8262
|
+
*/
|
|
8263
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
8264
|
+
}
|
|
8265
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
8266
|
+
/**
|
|
8267
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.
|
|
8268
|
+
*/
|
|
8269
|
+
servingConfig?: string;
|
|
8270
|
+
/**
|
|
8271
|
+
* Request body metadata
|
|
8272
|
+
*/
|
|
8273
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest;
|
|
8274
|
+
}
|
|
8275
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
|
|
8276
|
+
/**
|
|
8277
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
8278
|
+
*/
|
|
8279
|
+
servingConfig?: string;
|
|
8280
|
+
/**
|
|
8281
|
+
* Request body metadata
|
|
8282
|
+
*/
|
|
8283
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
8284
|
+
}
|
|
8285
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions {
|
|
8286
|
+
context: APIRequestContext;
|
|
8287
|
+
answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers;
|
|
8288
|
+
constructor(context: APIRequestContext);
|
|
8289
|
+
/**
|
|
8290
|
+
* Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
|
|
8291
|
+
*
|
|
8292
|
+
* @param params - Parameters for request
|
|
8293
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8294
|
+
* @param callback - Optional callback that handles the response.
|
|
8295
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8296
|
+
*/
|
|
8297
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8298
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
8299
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8300
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
8301
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
8302
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
6382
8303
|
/**
|
|
6383
|
-
*
|
|
8304
|
+
* Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
|
|
6384
8305
|
*
|
|
6385
8306
|
* @param params - Parameters for request
|
|
6386
8307
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6387
8308
|
* @param callback - Optional callback that handles the response.
|
|
6388
8309
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6389
8310
|
*/
|
|
6390
|
-
|
|
6391
|
-
|
|
6392
|
-
|
|
6393
|
-
|
|
6394
|
-
|
|
6395
|
-
|
|
8311
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8312
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
|
|
8313
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8314
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
8315
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
8316
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
6396
8317
|
/**
|
|
6397
|
-
*
|
|
8318
|
+
* Gets a Session.
|
|
6398
8319
|
*
|
|
6399
8320
|
* @param params - Parameters for request
|
|
6400
8321
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6401
8322
|
* @param callback - Optional callback that handles the response.
|
|
6402
8323
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6403
8324
|
*/
|
|
6404
|
-
|
|
6405
|
-
|
|
6406
|
-
|
|
6407
|
-
|
|
6408
|
-
|
|
6409
|
-
|
|
8325
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8326
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
8327
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8328
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
8329
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
8330
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
6410
8331
|
/**
|
|
6411
|
-
*
|
|
8332
|
+
* Lists all Sessions by their parent DataStore.
|
|
6412
8333
|
*
|
|
6413
8334
|
* @param params - Parameters for request
|
|
6414
8335
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6415
8336
|
* @param callback - Optional callback that handles the response.
|
|
6416
8337
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6417
8338
|
*/
|
|
6418
|
-
|
|
6419
|
-
|
|
6420
|
-
|
|
6421
|
-
|
|
6422
|
-
|
|
6423
|
-
|
|
8339
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8340
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>;
|
|
8341
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8342
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
8343
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
8344
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
6424
8345
|
/**
|
|
6425
|
-
*
|
|
8346
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
6426
8347
|
*
|
|
6427
8348
|
* @param params - Parameters for request
|
|
6428
8349
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6429
8350
|
* @param callback - Optional callback that handles the response.
|
|
6430
8351
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6431
8352
|
*/
|
|
6432
|
-
|
|
6433
|
-
|
|
6434
|
-
|
|
6435
|
-
|
|
6436
|
-
|
|
6437
|
-
|
|
8353
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8354
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
8355
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8356
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
8357
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
8358
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
6438
8359
|
}
|
|
6439
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
8360
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters {
|
|
6440
8361
|
/**
|
|
6441
|
-
* Required.
|
|
8362
|
+
* Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
8363
|
+
*/
|
|
8364
|
+
parent?: string;
|
|
8365
|
+
/**
|
|
8366
|
+
* Request body metadata
|
|
8367
|
+
*/
|
|
8368
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
8369
|
+
}
|
|
8370
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters {
|
|
8371
|
+
/**
|
|
8372
|
+
* Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
6442
8373
|
*/
|
|
6443
8374
|
name?: string;
|
|
6444
8375
|
}
|
|
6445
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
8376
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters {
|
|
6446
8377
|
/**
|
|
6447
|
-
*
|
|
8378
|
+
* Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
8379
|
+
*/
|
|
8380
|
+
name?: string;
|
|
8381
|
+
}
|
|
8382
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters {
|
|
8383
|
+
/**
|
|
8384
|
+
* A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
|
8385
|
+
*/
|
|
8386
|
+
filter?: string;
|
|
8387
|
+
/**
|
|
8388
|
+
* 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` Example: "update_time desc" "create_time"
|
|
8389
|
+
*/
|
|
8390
|
+
orderBy?: string;
|
|
8391
|
+
/**
|
|
8392
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
6448
8393
|
*/
|
|
6449
8394
|
pageSize?: number;
|
|
6450
8395
|
/**
|
|
6451
|
-
*
|
|
8396
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
6452
8397
|
*/
|
|
6453
8398
|
pageToken?: string;
|
|
6454
8399
|
/**
|
|
6455
|
-
* Required.
|
|
8400
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
6456
8401
|
*/
|
|
6457
8402
|
parent?: string;
|
|
6458
8403
|
}
|
|
6459
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
8404
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters {
|
|
6460
8405
|
/**
|
|
6461
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/
|
|
8406
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
6462
8407
|
*/
|
|
6463
8408
|
name?: string;
|
|
6464
8409
|
/**
|
|
6465
|
-
* Indicates which fields in the provided
|
|
8410
|
+
* 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.
|
|
6466
8411
|
*/
|
|
6467
8412
|
updateMask?: string;
|
|
6468
8413
|
/**
|
|
6469
8414
|
* Request body metadata
|
|
6470
8415
|
*/
|
|
6471
|
-
requestBody?: Schema$
|
|
8416
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
6472
8417
|
}
|
|
6473
|
-
export
|
|
6474
|
-
|
|
6475
|
-
|
|
6476
|
-
*/
|
|
6477
|
-
servingConfig?: string;
|
|
8418
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers {
|
|
8419
|
+
context: APIRequestContext;
|
|
8420
|
+
constructor(context: APIRequestContext);
|
|
6478
8421
|
/**
|
|
6479
|
-
*
|
|
8422
|
+
* Gets a Answer.
|
|
8423
|
+
*
|
|
8424
|
+
* @param params - Parameters for request
|
|
8425
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8426
|
+
* @param callback - Optional callback that handles the response.
|
|
8427
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6480
8428
|
*/
|
|
6481
|
-
|
|
8429
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8430
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaAnswer>;
|
|
8431
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8432
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
8433
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
8434
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
6482
8435
|
}
|
|
6483
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
6484
|
-
/**
|
|
6485
|
-
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
6486
|
-
*/
|
|
6487
|
-
servingConfig?: string;
|
|
8436
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
|
|
6488
8437
|
/**
|
|
6489
|
-
*
|
|
8438
|
+
* Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
6490
8439
|
*/
|
|
6491
|
-
|
|
8440
|
+
name?: string;
|
|
6492
8441
|
}
|
|
6493
8442
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
6494
8443
|
context: APIRequestContext;
|
|
@@ -6554,6 +8503,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6554
8503
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
6555
8504
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
6556
8505
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
8506
|
+
sessions: Resource$Projects$Locations$Datastores$Sessions;
|
|
6557
8507
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
6558
8508
|
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
6559
8509
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
@@ -6914,6 +8864,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6914
8864
|
* Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
6915
8865
|
*/
|
|
6916
8866
|
name?: string;
|
|
8867
|
+
/**
|
|
8868
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
8869
|
+
*/
|
|
8870
|
+
updateMask?: string;
|
|
6917
8871
|
/**
|
|
6918
8872
|
* Request body metadata
|
|
6919
8873
|
*/
|
|
@@ -7129,7 +9083,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7129
9083
|
}
|
|
7130
9084
|
export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters {
|
|
7131
9085
|
/**
|
|
7132
|
-
* Immutable. Fully qualified name `project/
|
|
9086
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`.
|
|
7133
9087
|
*/
|
|
7134
9088
|
name?: string;
|
|
7135
9089
|
/**
|
|
@@ -7389,6 +9343,20 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7389
9343
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
7390
9344
|
context: APIRequestContext;
|
|
7391
9345
|
constructor(context: APIRequestContext);
|
|
9346
|
+
/**
|
|
9347
|
+
* Answer query method.
|
|
9348
|
+
*
|
|
9349
|
+
* @param params - Parameters for request
|
|
9350
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9351
|
+
* @param callback - Optional callback that handles the response.
|
|
9352
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9353
|
+
*/
|
|
9354
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9355
|
+
answer(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
9356
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9357
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
9358
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
9359
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>): void;
|
|
7392
9360
|
/**
|
|
7393
9361
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7394
9362
|
*
|
|
@@ -7460,6 +9428,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7460
9428
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
7461
9429
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
7462
9430
|
}
|
|
9431
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer extends StandardParameters {
|
|
9432
|
+
/**
|
|
9433
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
9434
|
+
*/
|
|
9435
|
+
servingConfig?: string;
|
|
9436
|
+
/**
|
|
9437
|
+
* Request body metadata
|
|
9438
|
+
*/
|
|
9439
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
9440
|
+
}
|
|
7463
9441
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
7464
9442
|
/**
|
|
7465
9443
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -7514,6 +9492,163 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7514
9492
|
*/
|
|
7515
9493
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
7516
9494
|
}
|
|
9495
|
+
export class Resource$Projects$Locations$Datastores$Sessions {
|
|
9496
|
+
context: APIRequestContext;
|
|
9497
|
+
answers: Resource$Projects$Locations$Datastores$Sessions$Answers;
|
|
9498
|
+
constructor(context: APIRequestContext);
|
|
9499
|
+
/**
|
|
9500
|
+
* Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
|
|
9501
|
+
*
|
|
9502
|
+
* @param params - Parameters for request
|
|
9503
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9504
|
+
* @param callback - Optional callback that handles the response.
|
|
9505
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9506
|
+
*/
|
|
9507
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9508
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
9509
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9510
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9511
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9512
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9513
|
+
/**
|
|
9514
|
+
* Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
|
|
9515
|
+
*
|
|
9516
|
+
* @param params - Parameters for request
|
|
9517
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9518
|
+
* @param callback - Optional callback that handles the response.
|
|
9519
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9520
|
+
*/
|
|
9521
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9522
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
|
|
9523
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9524
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
9525
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
9526
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
9527
|
+
/**
|
|
9528
|
+
* Gets a Session.
|
|
9529
|
+
*
|
|
9530
|
+
* @param params - Parameters for request
|
|
9531
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9532
|
+
* @param callback - Optional callback that handles the response.
|
|
9533
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9534
|
+
*/
|
|
9535
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9536
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
9537
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9538
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9539
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9540
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9541
|
+
/**
|
|
9542
|
+
* Lists all Sessions by their parent DataStore.
|
|
9543
|
+
*
|
|
9544
|
+
* @param params - Parameters for request
|
|
9545
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9546
|
+
* @param callback - Optional callback that handles the response.
|
|
9547
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9548
|
+
*/
|
|
9549
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9550
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>;
|
|
9551
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9552
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
9553
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
9554
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse>): void;
|
|
9555
|
+
/**
|
|
9556
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
9557
|
+
*
|
|
9558
|
+
* @param params - Parameters for request
|
|
9559
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9560
|
+
* @param callback - Optional callback that handles the response.
|
|
9561
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9562
|
+
*/
|
|
9563
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9564
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSession>;
|
|
9565
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9566
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9567
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9568
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSession>): void;
|
|
9569
|
+
}
|
|
9570
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create extends StandardParameters {
|
|
9571
|
+
/**
|
|
9572
|
+
* Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
9573
|
+
*/
|
|
9574
|
+
parent?: string;
|
|
9575
|
+
/**
|
|
9576
|
+
* Request body metadata
|
|
9577
|
+
*/
|
|
9578
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
9579
|
+
}
|
|
9580
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete extends StandardParameters {
|
|
9581
|
+
/**
|
|
9582
|
+
* Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
9583
|
+
*/
|
|
9584
|
+
name?: string;
|
|
9585
|
+
}
|
|
9586
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get extends StandardParameters {
|
|
9587
|
+
/**
|
|
9588
|
+
* Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}`
|
|
9589
|
+
*/
|
|
9590
|
+
name?: string;
|
|
9591
|
+
}
|
|
9592
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$List extends StandardParameters {
|
|
9593
|
+
/**
|
|
9594
|
+
* A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
|
9595
|
+
*/
|
|
9596
|
+
filter?: string;
|
|
9597
|
+
/**
|
|
9598
|
+
* 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` Example: "update_time desc" "create_time"
|
|
9599
|
+
*/
|
|
9600
|
+
orderBy?: string;
|
|
9601
|
+
/**
|
|
9602
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
9603
|
+
*/
|
|
9604
|
+
pageSize?: number;
|
|
9605
|
+
/**
|
|
9606
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
9607
|
+
*/
|
|
9608
|
+
pageToken?: string;
|
|
9609
|
+
/**
|
|
9610
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
9611
|
+
*/
|
|
9612
|
+
parent?: string;
|
|
9613
|
+
}
|
|
9614
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch extends StandardParameters {
|
|
9615
|
+
/**
|
|
9616
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
9617
|
+
*/
|
|
9618
|
+
name?: string;
|
|
9619
|
+
/**
|
|
9620
|
+
* 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.
|
|
9621
|
+
*/
|
|
9622
|
+
updateMask?: string;
|
|
9623
|
+
/**
|
|
9624
|
+
* Request body metadata
|
|
9625
|
+
*/
|
|
9626
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
9627
|
+
}
|
|
9628
|
+
export class Resource$Projects$Locations$Datastores$Sessions$Answers {
|
|
9629
|
+
context: APIRequestContext;
|
|
9630
|
+
constructor(context: APIRequestContext);
|
|
9631
|
+
/**
|
|
9632
|
+
* Gets a Answer.
|
|
9633
|
+
*
|
|
9634
|
+
* @param params - Parameters for request
|
|
9635
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9636
|
+
* @param callback - Optional callback that handles the response.
|
|
9637
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9638
|
+
*/
|
|
9639
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9640
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaAnswer>;
|
|
9641
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9642
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
9643
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
9644
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswer>): void;
|
|
9645
|
+
}
|
|
9646
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters {
|
|
9647
|
+
/**
|
|
9648
|
+
* Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}`
|
|
9649
|
+
*/
|
|
9650
|
+
name?: string;
|
|
9651
|
+
}
|
|
7517
9652
|
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
7518
9653
|
context: APIRequestContext;
|
|
7519
9654
|
targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites;
|
|
@@ -7863,7 +9998,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7863
9998
|
}
|
|
7864
9999
|
export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write extends StandardParameters {
|
|
7865
10000
|
/**
|
|
7866
|
-
* Required. The parent
|
|
10001
|
+
* Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
7867
10002
|
*/
|
|
7868
10003
|
parent?: string;
|
|
7869
10004
|
/**
|
|
@@ -7871,6 +10006,34 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7871
10006
|
*/
|
|
7872
10007
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent;
|
|
7873
10008
|
}
|
|
10009
|
+
export class Resource$Projects$Locations$Groundingconfigs {
|
|
10010
|
+
context: APIRequestContext;
|
|
10011
|
+
constructor(context: APIRequestContext);
|
|
10012
|
+
/**
|
|
10013
|
+
* Performs a grounding check.
|
|
10014
|
+
*
|
|
10015
|
+
* @param params - Parameters for request
|
|
10016
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10017
|
+
* @param callback - Optional callback that handles the response.
|
|
10018
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10019
|
+
*/
|
|
10020
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10021
|
+
check(params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>;
|
|
10022
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10023
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>): void;
|
|
10024
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>): void;
|
|
10025
|
+
check(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>): void;
|
|
10026
|
+
}
|
|
10027
|
+
export interface Params$Resource$Projects$Locations$Groundingconfigs$Check extends StandardParameters {
|
|
10028
|
+
/**
|
|
10029
|
+
* Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`.
|
|
10030
|
+
*/
|
|
10031
|
+
groundingConfig?: string;
|
|
10032
|
+
/**
|
|
10033
|
+
* Request body metadata
|
|
10034
|
+
*/
|
|
10035
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest;
|
|
10036
|
+
}
|
|
7874
10037
|
export class Resource$Projects$Locations$Operations {
|
|
7875
10038
|
context: APIRequestContext;
|
|
7876
10039
|
constructor(context: APIRequestContext);
|
|
@@ -7927,6 +10090,62 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7927
10090
|
*/
|
|
7928
10091
|
pageToken?: string;
|
|
7929
10092
|
}
|
|
10093
|
+
export class Resource$Projects$Locations$Rankingconfigs {
|
|
10094
|
+
context: APIRequestContext;
|
|
10095
|
+
constructor(context: APIRequestContext);
|
|
10096
|
+
/**
|
|
10097
|
+
* Ranks a list of text records based on the given input query.
|
|
10098
|
+
*
|
|
10099
|
+
* @param params - Parameters for request
|
|
10100
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10101
|
+
* @param callback - Optional callback that handles the response.
|
|
10102
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10103
|
+
*/
|
|
10104
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10105
|
+
rank(params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRankResponse>;
|
|
10106
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10107
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRankResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRankResponse>): void;
|
|
10108
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRankResponse>): void;
|
|
10109
|
+
rank(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRankResponse>): void;
|
|
10110
|
+
}
|
|
10111
|
+
export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters {
|
|
10112
|
+
/**
|
|
10113
|
+
* Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`.
|
|
10114
|
+
*/
|
|
10115
|
+
rankingConfig?: string;
|
|
10116
|
+
/**
|
|
10117
|
+
* Request body metadata
|
|
10118
|
+
*/
|
|
10119
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRankRequest;
|
|
10120
|
+
}
|
|
10121
|
+
export class Resource$Projects$Locations$Userevents {
|
|
10122
|
+
context: APIRequestContext;
|
|
10123
|
+
constructor(context: APIRequestContext);
|
|
10124
|
+
/**
|
|
10125
|
+
* Writes a single user event.
|
|
10126
|
+
*
|
|
10127
|
+
* @param params - Parameters for request
|
|
10128
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10129
|
+
* @param callback - Optional callback that handles the response.
|
|
10130
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10131
|
+
*/
|
|
10132
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10133
|
+
write(params?: Params$Resource$Projects$Locations$Userevents$Write, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
10134
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10135
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserEvent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserEvent>): void;
|
|
10136
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserEvent>): void;
|
|
10137
|
+
write(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaUserEvent>): void;
|
|
10138
|
+
}
|
|
10139
|
+
export interface Params$Resource$Projects$Locations$Userevents$Write extends StandardParameters {
|
|
10140
|
+
/**
|
|
10141
|
+
* Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
10142
|
+
*/
|
|
10143
|
+
parent?: string;
|
|
10144
|
+
/**
|
|
10145
|
+
* Request body metadata
|
|
10146
|
+
*/
|
|
10147
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent;
|
|
10148
|
+
}
|
|
7930
10149
|
export class Resource$Projects$Operations {
|
|
7931
10150
|
context: APIRequestContext;
|
|
7932
10151
|
constructor(context: APIRequestContext);
|