@googleapis/discoveryengine 7.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 +29 -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 +2515 -153
- package/build/v1alpha.js +1651 -238
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2570 -241
- package/build/v1beta.js +1390 -266
- 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 +14526 -8967
- package/v1beta.ts +11630 -6744
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
|
*/
|
|
@@ -380,11 +670,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
380
670
|
*/
|
|
381
671
|
updateTime?: string | null;
|
|
382
672
|
}
|
|
383
|
-
/**
|
|
384
|
-
* The digital parsing configurations for documents.
|
|
385
|
-
*/
|
|
386
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {
|
|
387
|
-
}
|
|
388
673
|
/**
|
|
389
674
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
390
675
|
*/
|
|
@@ -407,6 +692,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
407
692
|
* A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
|
|
408
693
|
*/
|
|
409
694
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
695
|
+
/**
|
|
696
|
+
* Whether chunking mode is enabled.
|
|
697
|
+
*/
|
|
698
|
+
chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig;
|
|
410
699
|
/**
|
|
411
700
|
* Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
|
|
412
701
|
*/
|
|
@@ -415,10 +704,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
415
704
|
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
416
705
|
*/
|
|
417
706
|
name?: string | null;
|
|
418
|
-
/**
|
|
419
|
-
* [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs.
|
|
420
|
-
*/
|
|
421
|
-
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
422
707
|
/**
|
|
423
708
|
* Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
|
|
424
709
|
*/
|
|
@@ -426,6 +711,28 @@ export declare namespace discoveryengine_v1beta {
|
|
|
426
711
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
427
712
|
} | null;
|
|
428
713
|
}
|
|
714
|
+
/**
|
|
715
|
+
* Configuration for chunking config.
|
|
716
|
+
*/
|
|
717
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
|
|
718
|
+
/**
|
|
719
|
+
* Configuration for the layout based chunking.
|
|
720
|
+
*/
|
|
721
|
+
layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* Configuration for the layout based chunking.
|
|
725
|
+
*/
|
|
726
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
727
|
+
/**
|
|
728
|
+
* The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
|
|
729
|
+
*/
|
|
730
|
+
chunkSize?: number | null;
|
|
731
|
+
/**
|
|
732
|
+
* Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
|
|
733
|
+
*/
|
|
734
|
+
includeAncestorHeadings?: boolean | null;
|
|
735
|
+
}
|
|
429
736
|
/**
|
|
430
737
|
* Related configurations applied to a specific type of document parser.
|
|
431
738
|
*/
|
|
@@ -433,15 +740,38 @@ export declare namespace discoveryengine_v1beta {
|
|
|
433
740
|
/**
|
|
434
741
|
* Configurations applied to digital parser.
|
|
435
742
|
*/
|
|
436
|
-
digitalParsingConfig?: Schema$
|
|
743
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
437
744
|
/**
|
|
438
745
|
* Configurations applied to layout parser.
|
|
439
746
|
*/
|
|
440
|
-
layoutParsingConfig?: Schema$
|
|
747
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig;
|
|
441
748
|
/**
|
|
442
749
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
443
750
|
*/
|
|
444
|
-
ocrParsingConfig?: Schema$
|
|
751
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
752
|
+
}
|
|
753
|
+
/**
|
|
754
|
+
* The digital parsing configurations for documents.
|
|
755
|
+
*/
|
|
756
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
757
|
+
}
|
|
758
|
+
/**
|
|
759
|
+
* The layout parsing configurations for documents.
|
|
760
|
+
*/
|
|
761
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* The OCR parsing configurations for documents.
|
|
765
|
+
*/
|
|
766
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
767
|
+
/**
|
|
768
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
769
|
+
*/
|
|
770
|
+
enhancedDocumentElements?: string[] | null;
|
|
771
|
+
/**
|
|
772
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
773
|
+
*/
|
|
774
|
+
useNativeText?: boolean | null;
|
|
445
775
|
}
|
|
446
776
|
/**
|
|
447
777
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -465,10 +795,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
465
795
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
466
796
|
*/
|
|
467
797
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
468
|
-
/**
|
|
469
|
-
* Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.
|
|
470
|
-
*/
|
|
471
|
-
allowMultipleDataStoresSearchEngine?: boolean | null;
|
|
472
798
|
/**
|
|
473
799
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
474
800
|
*/
|
|
@@ -535,7 +861,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
535
861
|
*/
|
|
536
862
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
537
863
|
/**
|
|
538
|
-
* 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.
|
|
539
865
|
*/
|
|
540
866
|
dialogflowAgentToLink?: string | null;
|
|
541
867
|
}
|
|
@@ -642,7 +968,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
642
968
|
*/
|
|
643
969
|
searchAddOns?: string[] | null;
|
|
644
970
|
/**
|
|
645
|
-
* 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.
|
|
646
972
|
*/
|
|
647
973
|
searchTier?: string | null;
|
|
648
974
|
}
|
|
@@ -677,6 +1003,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
677
1003
|
* Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
|
|
678
1004
|
*/
|
|
679
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;
|
|
680
1010
|
/**
|
|
681
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.
|
|
682
1012
|
*/
|
|
@@ -752,6 +1082,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
752
1082
|
* Count of entries that were processed successfully.
|
|
753
1083
|
*/
|
|
754
1084
|
successCount?: string | null;
|
|
1085
|
+
/**
|
|
1086
|
+
* Total count of entries that were processed.
|
|
1087
|
+
*/
|
|
1088
|
+
totalCount?: string | null;
|
|
755
1089
|
/**
|
|
756
1090
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
757
1091
|
*/
|
|
@@ -852,39 +1186,57 @@ export declare namespace discoveryengine_v1beta {
|
|
|
852
1186
|
unjoinedEventsCount?: string | null;
|
|
853
1187
|
}
|
|
854
1188
|
/**
|
|
855
|
-
*
|
|
856
|
-
*/
|
|
857
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {
|
|
858
|
-
}
|
|
859
|
-
/**
|
|
860
|
-
* The OCR options for parsing documents.
|
|
1189
|
+
* Metadata and configurations for a Google Cloud project in the service.
|
|
861
1190
|
*/
|
|
862
|
-
export interface Schema$
|
|
1191
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
|
|
863
1192
|
/**
|
|
864
|
-
*
|
|
1193
|
+
* Output only. The timestamp when this project is created.
|
|
865
1194
|
*/
|
|
866
|
-
|
|
1195
|
+
createTime?: string | null;
|
|
867
1196
|
/**
|
|
868
|
-
*
|
|
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.
|
|
869
1198
|
*/
|
|
870
|
-
|
|
1199
|
+
name?: string | null;
|
|
871
1200
|
/**
|
|
872
|
-
*
|
|
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.
|
|
873
1202
|
*/
|
|
874
|
-
|
|
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;
|
|
875
1210
|
}
|
|
876
1211
|
/**
|
|
877
|
-
*
|
|
1212
|
+
* Metadata about the terms of service.
|
|
878
1213
|
*/
|
|
879
|
-
export interface Schema$
|
|
1214
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
|
|
880
1215
|
/**
|
|
881
|
-
*
|
|
1216
|
+
* The last time when the project agreed to the terms of service.
|
|
882
1217
|
*/
|
|
883
|
-
|
|
1218
|
+
acceptTime?: string | null;
|
|
884
1219
|
/**
|
|
885
|
-
*
|
|
1220
|
+
* The last time when the project declined or revoked the agreement to terms of service.
|
|
886
1221
|
*/
|
|
887
|
-
|
|
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 {
|
|
888
1240
|
}
|
|
889
1241
|
/**
|
|
890
1242
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -980,6 +1332,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
980
1332
|
*/
|
|
981
1333
|
purgeCount?: string | null;
|
|
982
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
|
+
}
|
|
983
1348
|
/**
|
|
984
1349
|
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
985
1350
|
*/
|
|
@@ -1075,6 +1440,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1075
1440
|
[key: string]: any;
|
|
1076
1441
|
} | null;
|
|
1077
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
|
+
}
|
|
1078
1485
|
/**
|
|
1079
1486
|
* Verification information for target sites in advanced site search.
|
|
1080
1487
|
*/
|
|
@@ -1173,7 +1580,13 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1173
1580
|
*/
|
|
1174
1581
|
errorSamples?: Schema$GoogleRpcStatus[];
|
|
1175
1582
|
/**
|
|
1176
|
-
* 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.
|
|
1177
1590
|
*/
|
|
1178
1591
|
modelStatus?: string | null;
|
|
1179
1592
|
}
|
|
@@ -1240,67 +1653,823 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1240
1653
|
targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[];
|
|
1241
1654
|
}
|
|
1242
1655
|
/**
|
|
1243
|
-
*
|
|
1656
|
+
* Defines an answer.
|
|
1657
|
+
*/
|
|
1658
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAnswer {
|
|
1659
|
+
/**
|
|
1660
|
+
* Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1661
|
+
*/
|
|
1662
|
+
answerSkippedReasons?: string[] | null;
|
|
1663
|
+
/**
|
|
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.
|
|
2250
|
+
*/
|
|
2251
|
+
updateTime?: string | null;
|
|
2252
|
+
}
|
|
2253
|
+
/**
|
|
2254
|
+
* Request message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2255
|
+
*/
|
|
2256
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest {
|
|
2257
|
+
/**
|
|
2258
|
+
* Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.
|
|
2259
|
+
*/
|
|
2260
|
+
requests?: Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest[];
|
|
2261
|
+
}
|
|
2262
|
+
/**
|
|
2263
|
+
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
2264
|
+
*/
|
|
2265
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse {
|
|
2266
|
+
/**
|
|
2267
|
+
* TargetSites created.
|
|
2268
|
+
*/
|
|
2269
|
+
targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[];
|
|
2270
|
+
}
|
|
2271
|
+
/**
|
|
2272
|
+
* Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
|
|
2273
|
+
*/
|
|
2274
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {
|
|
2275
|
+
}
|
|
2276
|
+
/**
|
|
2277
|
+
* BigQuery source import data from.
|
|
2278
|
+
*/
|
|
2279
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource {
|
|
2280
|
+
/**
|
|
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.
|
|
2282
|
+
*/
|
|
2283
|
+
dataSchema?: string | null;
|
|
2284
|
+
/**
|
|
2285
|
+
* Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
|
|
2286
|
+
*/
|
|
2287
|
+
datasetId?: string | null;
|
|
2288
|
+
/**
|
|
2289
|
+
* 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 BigQuery export to a specific Cloud Storage directory.
|
|
2290
|
+
*/
|
|
2291
|
+
gcsStagingDir?: string | null;
|
|
2292
|
+
/**
|
|
2293
|
+
* BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
|
|
2294
|
+
*/
|
|
2295
|
+
partitionDate?: Schema$GoogleTypeDate;
|
|
2296
|
+
/**
|
|
2297
|
+
* The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
|
|
2298
|
+
*/
|
|
2299
|
+
projectId?: string | null;
|
|
2300
|
+
/**
|
|
2301
|
+
* Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
|
|
2302
|
+
*/
|
|
2303
|
+
tableId?: string | null;
|
|
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.
|
|
1244
2385
|
*/
|
|
1245
|
-
export interface Schema$
|
|
2386
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest {
|
|
1246
2387
|
/**
|
|
1247
|
-
*
|
|
2388
|
+
* Answer candidate to check.
|
|
1248
2389
|
*/
|
|
1249
|
-
|
|
2390
|
+
answerCandidate?: string | null;
|
|
1250
2391
|
/**
|
|
1251
|
-
*
|
|
2392
|
+
* List of facts for the grounding check. We support up to 200 facts.
|
|
1252
2393
|
*/
|
|
1253
|
-
|
|
2394
|
+
facts?: Schema$GoogleCloudDiscoveryengineV1betaGroundingFact[];
|
|
2395
|
+
/**
|
|
2396
|
+
* Configuration of the grounding check.
|
|
2397
|
+
*/
|
|
2398
|
+
groundingSpec?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec;
|
|
1254
2399
|
}
|
|
1255
2400
|
/**
|
|
1256
|
-
*
|
|
2401
|
+
* Response message for the GroundedGenerationService.CheckGrounding method.
|
|
1257
2402
|
*/
|
|
1258
|
-
export interface Schema$
|
|
2403
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse {
|
|
1259
2404
|
/**
|
|
1260
|
-
*
|
|
2405
|
+
* List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
|
|
1261
2406
|
*/
|
|
1262
|
-
|
|
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;
|
|
1263
2416
|
}
|
|
1264
2417
|
/**
|
|
1265
|
-
*
|
|
2418
|
+
* Text and citation info for a claim in the answer candidate.
|
|
1266
2419
|
*/
|
|
1267
|
-
export interface Schema$
|
|
2420
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim {
|
|
1268
2421
|
/**
|
|
1269
|
-
*
|
|
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.
|
|
1270
2423
|
*/
|
|
1271
|
-
|
|
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;
|
|
1272
2437
|
}
|
|
1273
2438
|
/**
|
|
1274
|
-
*
|
|
2439
|
+
* Specification for the grounding check.
|
|
1275
2440
|
*/
|
|
1276
|
-
export interface Schema$
|
|
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;
|
|
1277
2446
|
}
|
|
1278
2447
|
/**
|
|
1279
|
-
*
|
|
2448
|
+
* Cloud SQL source import data from.
|
|
1280
2449
|
*/
|
|
1281
|
-
export interface Schema$
|
|
2450
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource {
|
|
1282
2451
|
/**
|
|
1283
|
-
* The
|
|
2452
|
+
* Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.
|
|
1284
2453
|
*/
|
|
1285
|
-
|
|
2454
|
+
databaseId?: string | null;
|
|
1286
2455
|
/**
|
|
1287
|
-
*
|
|
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.
|
|
1288
2457
|
*/
|
|
1289
|
-
|
|
2458
|
+
gcsStagingDir?: string | null;
|
|
1290
2459
|
/**
|
|
1291
|
-
*
|
|
2460
|
+
* Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.
|
|
1292
2461
|
*/
|
|
1293
|
-
|
|
2462
|
+
instanceId?: string | null;
|
|
1294
2463
|
/**
|
|
1295
|
-
*
|
|
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).
|
|
1296
2465
|
*/
|
|
1297
|
-
|
|
2466
|
+
offload?: boolean | null;
|
|
1298
2467
|
/**
|
|
1299
|
-
* The project ID
|
|
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.
|
|
1300
2469
|
*/
|
|
1301
2470
|
projectId?: string | null;
|
|
1302
2471
|
/**
|
|
1303
|
-
* Required. The
|
|
2472
|
+
* Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.
|
|
1304
2473
|
*/
|
|
1305
2474
|
tableId?: string | null;
|
|
1306
2475
|
}
|
|
@@ -1356,7 +2525,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1356
2525
|
*/
|
|
1357
2526
|
messages?: Schema$GoogleCloudDiscoveryengineV1betaConversationMessage[];
|
|
1358
2527
|
/**
|
|
1359
|
-
* 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`.
|
|
1360
2529
|
*/
|
|
1361
2530
|
name?: string | null;
|
|
1362
2531
|
/**
|
|
@@ -1633,11 +2802,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1633
2802
|
*/
|
|
1634
2803
|
updateTime?: string | null;
|
|
1635
2804
|
}
|
|
1636
|
-
/**
|
|
1637
|
-
* The digital parsing configurations for documents.
|
|
1638
|
-
*/
|
|
1639
|
-
export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {
|
|
1640
|
-
}
|
|
1641
2805
|
/**
|
|
1642
2806
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1643
2807
|
*/
|
|
@@ -1774,11 +2938,29 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1774
2938
|
/**
|
|
1775
2939
|
* Configurations applied to digital parser.
|
|
1776
2940
|
*/
|
|
1777
|
-
digitalParsingConfig?: Schema$
|
|
2941
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
1778
2942
|
/**
|
|
1779
2943
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
1780
2944
|
*/
|
|
1781
|
-
ocrParsingConfig?: Schema$
|
|
2945
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
2946
|
+
}
|
|
2947
|
+
/**
|
|
2948
|
+
* The digital parsing configurations for documents.
|
|
2949
|
+
*/
|
|
2950
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
2951
|
+
}
|
|
2952
|
+
/**
|
|
2953
|
+
* The OCR parsing configurations for documents.
|
|
2954
|
+
*/
|
|
2955
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2956
|
+
/**
|
|
2957
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
2958
|
+
*/
|
|
2959
|
+
enhancedDocumentElements?: string[] | null;
|
|
2960
|
+
/**
|
|
2961
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
2962
|
+
*/
|
|
2963
|
+
useNativeText?: boolean | null;
|
|
1782
2964
|
}
|
|
1783
2965
|
/**
|
|
1784
2966
|
* Double list.
|
|
@@ -1879,7 +3061,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1879
3061
|
*/
|
|
1880
3062
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
1881
3063
|
/**
|
|
1882
|
-
* 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.
|
|
1883
3065
|
*/
|
|
1884
3066
|
dialogflowAgentToLink?: string | null;
|
|
1885
3067
|
}
|
|
@@ -1931,10 +3113,29 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1931
3113
|
*/
|
|
1932
3114
|
searchAddOns?: string[] | null;
|
|
1933
3115
|
/**
|
|
1934
|
-
* 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.
|
|
1935
3117
|
*/
|
|
1936
3118
|
searchTier?: string | null;
|
|
1937
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
|
+
}
|
|
1938
3139
|
/**
|
|
1939
3140
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
1940
3141
|
*/
|
|
@@ -1952,12 +3153,46 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1952
3153
|
*/
|
|
1953
3154
|
totalSize?: number | null;
|
|
1954
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
|
+
}
|
|
1955
3190
|
/**
|
|
1956
3191
|
* Cloud Storage location for input content.
|
|
1957
3192
|
*/
|
|
1958
3193
|
export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource {
|
|
1959
3194
|
/**
|
|
1960
|
-
* 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.
|
|
1961
3196
|
*/
|
|
1962
3197
|
dataSchema?: string | null;
|
|
1963
3198
|
/**
|
|
@@ -1965,6 +3200,21 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1965
3200
|
*/
|
|
1966
3201
|
inputUris?: string[] | null;
|
|
1967
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
|
+
}
|
|
1968
3218
|
/**
|
|
1969
3219
|
* Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
1970
3220
|
*/
|
|
@@ -1981,6 +3231,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1981
3231
|
* Count of entries that were processed successfully.
|
|
1982
3232
|
*/
|
|
1983
3233
|
successCount?: string | null;
|
|
3234
|
+
/**
|
|
3235
|
+
* Total count of entries that were processed.
|
|
3236
|
+
*/
|
|
3237
|
+
totalCount?: string | null;
|
|
1984
3238
|
/**
|
|
1985
3239
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1986
3240
|
*/
|
|
@@ -1991,23 +3245,39 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1991
3245
|
*/
|
|
1992
3246
|
export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest {
|
|
1993
3247
|
/**
|
|
1994
|
-
* 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.
|
|
1995
3249
|
*/
|
|
1996
3250
|
autoGenerateIds?: boolean | null;
|
|
1997
3251
|
/**
|
|
1998
3252
|
* BigQuery input source.
|
|
1999
3253
|
*/
|
|
2000
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;
|
|
2001
3263
|
/**
|
|
2002
3264
|
* The desired location of errors incurred during the Import.
|
|
2003
3265
|
*/
|
|
2004
3266
|
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3267
|
+
/**
|
|
3268
|
+
* FhirStore input source.
|
|
3269
|
+
*/
|
|
3270
|
+
fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource;
|
|
3271
|
+
/**
|
|
3272
|
+
* Firestore input source.
|
|
3273
|
+
*/
|
|
3274
|
+
firestoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource;
|
|
2005
3275
|
/**
|
|
2006
3276
|
* Cloud Storage location for the input content.
|
|
2007
3277
|
*/
|
|
2008
3278
|
gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
2009
3279
|
/**
|
|
2010
|
-
* 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.
|
|
2011
3281
|
*/
|
|
2012
3282
|
idField?: string | null;
|
|
2013
3283
|
/**
|
|
@@ -2018,6 +3288,14 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2018
3288
|
* The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
|
|
2019
3289
|
*/
|
|
2020
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;
|
|
2021
3299
|
}
|
|
2022
3300
|
/**
|
|
2023
3301
|
* The inline source for the input config for ImportDocuments method.
|
|
@@ -2273,6 +3551,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2273
3551
|
*/
|
|
2274
3552
|
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[];
|
|
2275
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
|
+
}
|
|
2276
3567
|
/**
|
|
2277
3568
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
2278
3569
|
*/
|
|
@@ -2303,25 +3594,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2303
3594
|
*/
|
|
2304
3595
|
mediaProgressPercentage?: number | null;
|
|
2305
3596
|
}
|
|
2306
|
-
/**
|
|
2307
|
-
* The OCR parsing configurations for documents.
|
|
2308
|
-
*/
|
|
2309
|
-
export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
2310
|
-
/**
|
|
2311
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
2312
|
-
*/
|
|
2313
|
-
enhancedDocumentElements?: string[] | null;
|
|
2314
|
-
/**
|
|
2315
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
2316
|
-
*/
|
|
2317
|
-
useNativeText?: boolean | null;
|
|
2318
|
-
}
|
|
2319
3597
|
/**
|
|
2320
3598
|
* Detailed page information.
|
|
2321
3599
|
*/
|
|
2322
3600
|
export interface Schema$GoogleCloudDiscoveryengineV1betaPageInfo {
|
|
2323
3601
|
/**
|
|
2324
|
-
* 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.
|
|
2325
3603
|
*/
|
|
2326
3604
|
pageCategory?: string | null;
|
|
2327
3605
|
/**
|
|
@@ -2358,6 +3636,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2358
3636
|
*/
|
|
2359
3637
|
totalPanels?: number | null;
|
|
2360
3638
|
}
|
|
3639
|
+
/**
|
|
3640
|
+
* Request for pausing training of an engine.
|
|
3641
|
+
*/
|
|
3642
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest {
|
|
3643
|
+
}
|
|
2361
3644
|
/**
|
|
2362
3645
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2363
3646
|
*/
|
|
@@ -2440,6 +3723,74 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2440
3723
|
*/
|
|
2441
3724
|
purgeCount?: string | null;
|
|
2442
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;
|
|
3755
|
+
/**
|
|
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.
|
|
3757
|
+
*/
|
|
3758
|
+
title?: string | null;
|
|
3759
|
+
}
|
|
3760
|
+
/**
|
|
3761
|
+
* Request message for RankService.Rank method.
|
|
3762
|
+
*/
|
|
3763
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaRankRequest {
|
|
3764
|
+
/**
|
|
3765
|
+
* If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
|
|
3766
|
+
*/
|
|
3767
|
+
ignoreRecordDetailsInResponse?: boolean | null;
|
|
3768
|
+
/**
|
|
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.
|
|
3770
|
+
*/
|
|
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;
|
|
3784
|
+
}
|
|
3785
|
+
/**
|
|
3786
|
+
* Response message for RankService.Rank method.
|
|
3787
|
+
*/
|
|
3788
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaRankResponse {
|
|
3789
|
+
/**
|
|
3790
|
+
* A list of records sorted by descending score.
|
|
3791
|
+
*/
|
|
3792
|
+
records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
3793
|
+
}
|
|
2443
3794
|
/**
|
|
2444
3795
|
* Request message for Recommend method.
|
|
2445
3796
|
*/
|
|
@@ -2560,6 +3911,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2560
3911
|
*/
|
|
2561
3912
|
uri?: string | null;
|
|
2562
3913
|
}
|
|
3914
|
+
/**
|
|
3915
|
+
* Request for resuming training of an engine.
|
|
3916
|
+
*/
|
|
3917
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest {
|
|
3918
|
+
}
|
|
2563
3919
|
/**
|
|
2564
3920
|
* Defines the structure and layout of a type of document data.
|
|
2565
3921
|
*/
|
|
@@ -2616,6 +3972,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2616
3972
|
* A specification for configuring the behavior of content search.
|
|
2617
3973
|
*/
|
|
2618
3974
|
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
3975
|
+
/**
|
|
3976
|
+
* A list of data store specs to apply on a search call.
|
|
3977
|
+
*/
|
|
3978
|
+
dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
2619
3979
|
/**
|
|
2620
3980
|
* Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
|
|
2621
3981
|
*/
|
|
@@ -2641,7 +4001,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2641
4001
|
*/
|
|
2642
4002
|
orderBy?: string | null;
|
|
2643
4003
|
/**
|
|
2644
|
-
* 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.
|
|
2645
4005
|
*/
|
|
2646
4006
|
pageSize?: number | null;
|
|
2647
4007
|
/**
|
|
@@ -2703,14 +4063,52 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2703
4063
|
*/
|
|
2704
4064
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
|
|
2705
4065
|
/**
|
|
2706
|
-
* 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.
|
|
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.
|
|
2707
4067
|
*/
|
|
2708
4068
|
boost?: number | null;
|
|
2709
4069
|
/**
|
|
2710
|
-
*
|
|
4070
|
+
* Complex specification for custom ranking based on customer defined attribute value.
|
|
4071
|
+
*/
|
|
4072
|
+
boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
4073
|
+
/**
|
|
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"))`
|
|
2711
4075
|
*/
|
|
2712
4076
|
condition?: string | null;
|
|
2713
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
|
+
}
|
|
2714
4112
|
/**
|
|
2715
4113
|
* A specification for configuring the behavior of content search.
|
|
2716
4114
|
*/
|
|
@@ -2748,6 +4146,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2748
4146
|
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
2749
4147
|
*/
|
|
2750
4148
|
numPreviousSegments?: number | null;
|
|
4149
|
+
/**
|
|
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`.
|
|
4151
|
+
*/
|
|
4152
|
+
returnExtractiveSegmentScore?: boolean | null;
|
|
2751
4153
|
}
|
|
2752
4154
|
/**
|
|
2753
4155
|
* A specification for configuring snippets in a search response.
|
|
@@ -2795,9 +4197,13 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2795
4197
|
*/
|
|
2796
4198
|
modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
2797
4199
|
/**
|
|
2798
|
-
* 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
|
|
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.
|
|
2799
4201
|
*/
|
|
2800
4202
|
summaryResultCount?: number | null;
|
|
4203
|
+
/**
|
|
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.
|
|
4205
|
+
*/
|
|
4206
|
+
useSemanticChunks?: boolean | null;
|
|
2801
4207
|
}
|
|
2802
4208
|
/**
|
|
2803
4209
|
* Specification of the prompt to use with the model.
|
|
@@ -2813,10 +4219,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2813
4219
|
*/
|
|
2814
4220
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2815
4221
|
/**
|
|
2816
|
-
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned
|
|
4222
|
+
* The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
|
|
2817
4223
|
*/
|
|
2818
4224
|
version?: string | null;
|
|
2819
4225
|
}
|
|
4226
|
+
/**
|
|
4227
|
+
* A struct to define data stores to filter on in a search call.
|
|
4228
|
+
*/
|
|
4229
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
4230
|
+
/**
|
|
4231
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`.
|
|
4232
|
+
*/
|
|
4233
|
+
dataStore?: string | null;
|
|
4234
|
+
}
|
|
2820
4235
|
/**
|
|
2821
4236
|
* The specification that uses customized query embedding vector to do semantic document retrieval.
|
|
2822
4237
|
*/
|
|
@@ -3139,6 +4554,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3139
4554
|
* Document reference.
|
|
3140
4555
|
*/
|
|
3141
4556
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference {
|
|
4557
|
+
/**
|
|
4558
|
+
* List of cited chunk contents derived from document content.
|
|
4559
|
+
*/
|
|
4560
|
+
chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[];
|
|
3142
4561
|
/**
|
|
3143
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`.
|
|
3144
4563
|
*/
|
|
@@ -3152,6 +4571,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3152
4571
|
*/
|
|
3153
4572
|
uri?: string | null;
|
|
3154
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
|
+
}
|
|
3155
4587
|
/**
|
|
3156
4588
|
* Safety Attribute categories and their associated confidence scores.
|
|
3157
4589
|
*/
|
|
@@ -3231,7 +4663,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3231
4663
|
*/
|
|
3232
4664
|
modelId?: string | null;
|
|
3233
4665
|
/**
|
|
3234
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
4666
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
3235
4667
|
*/
|
|
3236
4668
|
name?: string | null;
|
|
3237
4669
|
/**
|
|
@@ -3280,22 +4712,60 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3280
4712
|
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
3281
4713
|
*/
|
|
3282
4714
|
contentFreshnessCutoffDays?: number | null;
|
|
4715
|
+
/**
|
|
4716
|
+
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
4717
|
+
*/
|
|
4718
|
+
contentWatchedPercentageThreshold?: number | null;
|
|
3283
4719
|
/**
|
|
3284
4720
|
* Specifies the content watched minutes threshold for demotion.
|
|
3285
4721
|
*/
|
|
3286
|
-
|
|
4722
|
+
contentWatchedSecondsThreshold?: number | null;
|
|
3287
4723
|
/**
|
|
3288
|
-
* Specifies the
|
|
4724
|
+
* Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
|
|
3289
4725
|
*/
|
|
3290
|
-
|
|
4726
|
+
demotionEventType?: string | null;
|
|
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 {
|
|
3291
4761
|
/**
|
|
3292
|
-
*
|
|
4762
|
+
* The resource name of the answer to the user query.
|
|
3293
4763
|
*/
|
|
3294
|
-
|
|
4764
|
+
answer?: string | null;
|
|
3295
4765
|
/**
|
|
3296
|
-
*
|
|
4766
|
+
* The user query.
|
|
3297
4767
|
*/
|
|
3298
|
-
|
|
4768
|
+
query?: Schema$GoogleCloudDiscoveryengineV1betaQuery;
|
|
3299
4769
|
}
|
|
3300
4770
|
/**
|
|
3301
4771
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
@@ -3319,6 +4789,31 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3319
4789
|
*/
|
|
3320
4790
|
verifyTime?: string | null;
|
|
3321
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
|
+
}
|
|
3322
4817
|
/**
|
|
3323
4818
|
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
3324
4819
|
*/
|
|
@@ -3404,6 +4899,80 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3404
4899
|
*/
|
|
3405
4900
|
input?: string | null;
|
|
3406
4901
|
}
|
|
4902
|
+
/**
|
|
4903
|
+
* Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
4904
|
+
*/
|
|
4905
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
4906
|
+
/**
|
|
4907
|
+
* Operation create time.
|
|
4908
|
+
*/
|
|
4909
|
+
createTime?: string | null;
|
|
4910
|
+
/**
|
|
4911
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4912
|
+
*/
|
|
4913
|
+
updateTime?: string | null;
|
|
4914
|
+
}
|
|
4915
|
+
/**
|
|
4916
|
+
* Request message for SearchTuningService.TrainCustomModel method.
|
|
4917
|
+
*/
|
|
4918
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest {
|
|
4919
|
+
/**
|
|
4920
|
+
* The desired location of errors incurred during the data ingestion and training.
|
|
4921
|
+
*/
|
|
4922
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
4923
|
+
/**
|
|
4924
|
+
* Cloud Storage training input.
|
|
4925
|
+
*/
|
|
4926
|
+
gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput;
|
|
4927
|
+
/**
|
|
4928
|
+
* Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.
|
|
4929
|
+
*/
|
|
4930
|
+
modelType?: string | null;
|
|
4931
|
+
}
|
|
4932
|
+
/**
|
|
4933
|
+
* Cloud Storage training data input.
|
|
4934
|
+
*/
|
|
4935
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput {
|
|
4936
|
+
/**
|
|
4937
|
+
* The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"\}`
|
|
4938
|
+
*/
|
|
4939
|
+
corpusDataPath?: string | null;
|
|
4940
|
+
/**
|
|
4941
|
+
* The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\}
|
|
4942
|
+
*/
|
|
4943
|
+
queryDataPath?: string | null;
|
|
4944
|
+
/**
|
|
4945
|
+
* Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.
|
|
4946
|
+
*/
|
|
4947
|
+
testDataPath?: string | null;
|
|
4948
|
+
/**
|
|
4949
|
+
* Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1`
|
|
4950
|
+
*/
|
|
4951
|
+
trainDataPath?: string | null;
|
|
4952
|
+
}
|
|
4953
|
+
/**
|
|
4954
|
+
* Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
|
|
4955
|
+
*/
|
|
4956
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
4957
|
+
/**
|
|
4958
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
4959
|
+
*/
|
|
4960
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
4961
|
+
/**
|
|
4962
|
+
* A sample of errors encountered while processing the data.
|
|
4963
|
+
*/
|
|
4964
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
4965
|
+
/**
|
|
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.
|
|
4973
|
+
*/
|
|
4974
|
+
modelStatus?: string | null;
|
|
4975
|
+
}
|
|
3407
4976
|
/**
|
|
3408
4977
|
* A transaction represents the entire purchase transaction.
|
|
3409
4978
|
*/
|
|
@@ -3433,6 +5002,25 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3433
5002
|
*/
|
|
3434
5003
|
value?: number | null;
|
|
3435
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
|
+
}
|
|
3436
5024
|
/**
|
|
3437
5025
|
* Metadata for UpdateSchema LRO.
|
|
3438
5026
|
*/
|
|
@@ -3696,11 +5284,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3696
5284
|
*/
|
|
3697
5285
|
updateTime?: string | null;
|
|
3698
5286
|
}
|
|
3699
|
-
/**
|
|
3700
|
-
* The digital parsing configurations for documents.
|
|
3701
|
-
*/
|
|
3702
|
-
export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {
|
|
3703
|
-
}
|
|
3704
5287
|
/**
|
|
3705
5288
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3706
5289
|
*/
|
|
@@ -3745,11 +5328,29 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3745
5328
|
/**
|
|
3746
5329
|
* Configurations applied to digital parser.
|
|
3747
5330
|
*/
|
|
3748
|
-
digitalParsingConfig?: Schema$
|
|
5331
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
3749
5332
|
/**
|
|
3750
5333
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
3751
5334
|
*/
|
|
3752
|
-
ocrParsingConfig?: Schema$
|
|
5335
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
5336
|
+
}
|
|
5337
|
+
/**
|
|
5338
|
+
* The digital parsing configurations for documents.
|
|
5339
|
+
*/
|
|
5340
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
5341
|
+
}
|
|
5342
|
+
/**
|
|
5343
|
+
* The OCR parsing configurations for documents.
|
|
5344
|
+
*/
|
|
5345
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
5346
|
+
/**
|
|
5347
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
5348
|
+
*/
|
|
5349
|
+
enhancedDocumentElements?: string[] | null;
|
|
5350
|
+
/**
|
|
5351
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
5352
|
+
*/
|
|
5353
|
+
useNativeText?: boolean | null;
|
|
3753
5354
|
}
|
|
3754
5355
|
/**
|
|
3755
5356
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3827,7 +5428,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3827
5428
|
*/
|
|
3828
5429
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
3829
5430
|
/**
|
|
3830
|
-
* 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.
|
|
3831
5432
|
*/
|
|
3832
5433
|
dialogflowAgentToLink?: string | null;
|
|
3833
5434
|
}
|
|
@@ -3879,7 +5480,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3879
5480
|
*/
|
|
3880
5481
|
searchAddOns?: string[] | null;
|
|
3881
5482
|
/**
|
|
3882
|
-
* 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.
|
|
3883
5484
|
*/
|
|
3884
5485
|
searchTier?: string | null;
|
|
3885
5486
|
}
|
|
@@ -3899,6 +5500,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3899
5500
|
* Count of entries that were processed successfully.
|
|
3900
5501
|
*/
|
|
3901
5502
|
successCount?: string | null;
|
|
5503
|
+
/**
|
|
5504
|
+
* Total count of entries that were processed.
|
|
5505
|
+
*/
|
|
5506
|
+
totalCount?: string | null;
|
|
3902
5507
|
/**
|
|
3903
5508
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3904
5509
|
*/
|
|
@@ -3998,19 +5603,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3998
5603
|
*/
|
|
3999
5604
|
unjoinedEventsCount?: string | null;
|
|
4000
5605
|
}
|
|
4001
|
-
/**
|
|
4002
|
-
* The OCR parsing configurations for documents.
|
|
4003
|
-
*/
|
|
4004
|
-
export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
4005
|
-
/**
|
|
4006
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
4007
|
-
*/
|
|
4008
|
-
enhancedDocumentElements?: string[] | null;
|
|
4009
|
-
/**
|
|
4010
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
4011
|
-
*/
|
|
4012
|
-
useNativeText?: boolean | null;
|
|
4013
|
-
}
|
|
4014
5606
|
/**
|
|
4015
5607
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4016
5608
|
*/
|
|
@@ -4285,7 +5877,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4285
5877
|
context: APIRequestContext;
|
|
4286
5878
|
collections: Resource$Projects$Locations$Collections;
|
|
4287
5879
|
dataStores: Resource$Projects$Locations$Datastores;
|
|
5880
|
+
groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
|
|
4288
5881
|
operations: Resource$Projects$Locations$Operations;
|
|
5882
|
+
rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
|
|
5883
|
+
userEvents: Resource$Projects$Locations$Userevents;
|
|
4289
5884
|
constructor(context: APIRequestContext);
|
|
4290
5885
|
}
|
|
4291
5886
|
export class Resource$Projects$Locations$Collections {
|
|
@@ -4365,6 +5960,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4365
5960
|
operations: Resource$Projects$Locations$Collections$Datastores$Operations;
|
|
4366
5961
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
4367
5962
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
5963
|
+
sessions: Resource$Projects$Locations$Collections$Datastores$Sessions;
|
|
4368
5964
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
4369
5965
|
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
4370
5966
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
@@ -4467,6 +6063,20 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4467
6063
|
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4468
6064
|
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
4469
6065
|
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaDataStore>): void;
|
|
6066
|
+
/**
|
|
6067
|
+
* Trains a custom model.
|
|
6068
|
+
*
|
|
6069
|
+
* @param params - Parameters for request
|
|
6070
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6071
|
+
* @param callback - Optional callback that handles the response.
|
|
6072
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6073
|
+
*/
|
|
6074
|
+
trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6075
|
+
trainCustomModel(params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6076
|
+
trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6077
|
+
trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6078
|
+
trainCustomModel(params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6079
|
+
trainCustomModel(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4470
6080
|
}
|
|
4471
6081
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
|
|
4472
6082
|
/**
|
|
@@ -4558,6 +6168,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4558
6168
|
*/
|
|
4559
6169
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore;
|
|
4560
6170
|
}
|
|
6171
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel extends StandardParameters {
|
|
6172
|
+
/**
|
|
6173
|
+
* Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.
|
|
6174
|
+
*/
|
|
6175
|
+
dataStore?: string;
|
|
6176
|
+
/**
|
|
6177
|
+
* Request body metadata
|
|
6178
|
+
*/
|
|
6179
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest;
|
|
6180
|
+
}
|
|
4561
6181
|
export class Resource$Projects$Locations$Collections$Datastores$Branches {
|
|
4562
6182
|
context: APIRequestContext;
|
|
4563
6183
|
documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents;
|
|
@@ -4725,6 +6345,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4725
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.
|
|
4726
6346
|
*/
|
|
4727
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;
|
|
4728
6352
|
/**
|
|
4729
6353
|
* Request body metadata
|
|
4730
6354
|
*/
|
|
@@ -4940,7 +6564,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4940
6564
|
}
|
|
4941
6565
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters {
|
|
4942
6566
|
/**
|
|
4943
|
-
* 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`.
|
|
4944
6568
|
*/
|
|
4945
6569
|
name?: string;
|
|
4946
6570
|
/**
|
|
@@ -5257,6 +6881,20 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5257
6881
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
5258
6882
|
context: APIRequestContext;
|
|
5259
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;
|
|
5260
6898
|
/**
|
|
5261
6899
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
5262
6900
|
*
|
|
@@ -5286,101 +6924,268 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5286
6924
|
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5287
6925
|
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>): void;
|
|
5288
6926
|
/**
|
|
5289
|
-
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
6927
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
6928
|
+
*
|
|
6929
|
+
* @param params - Parameters for request
|
|
6930
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6931
|
+
* @param callback - Optional callback that handles the response.
|
|
6932
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6933
|
+
*/
|
|
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.
|
|
5290
7067
|
*
|
|
5291
7068
|
* @param params - Parameters for request
|
|
5292
7069
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5293
7070
|
* @param callback - Optional callback that handles the response.
|
|
5294
7071
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5295
7072
|
*/
|
|
5296
|
-
|
|
5297
|
-
|
|
5298
|
-
|
|
5299
|
-
|
|
5300
|
-
|
|
5301
|
-
|
|
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;
|
|
5302
7079
|
/**
|
|
5303
|
-
*
|
|
7080
|
+
* Lists all Sessions by their parent DataStore.
|
|
5304
7081
|
*
|
|
5305
7082
|
* @param params - Parameters for request
|
|
5306
7083
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5307
7084
|
* @param callback - Optional callback that handles the response.
|
|
5308
7085
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5309
7086
|
*/
|
|
5310
|
-
|
|
5311
|
-
|
|
5312
|
-
|
|
5313
|
-
|
|
5314
|
-
|
|
5315
|
-
|
|
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;
|
|
5316
7093
|
/**
|
|
5317
|
-
*
|
|
7094
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
5318
7095
|
*
|
|
5319
7096
|
* @param params - Parameters for request
|
|
5320
7097
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5321
7098
|
* @param callback - Optional callback that handles the response.
|
|
5322
7099
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5323
7100
|
*/
|
|
5324
|
-
|
|
5325
|
-
|
|
5326
|
-
|
|
5327
|
-
|
|
5328
|
-
|
|
5329
|
-
|
|
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;
|
|
5330
7107
|
}
|
|
5331
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
7108
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters {
|
|
7109
|
+
/**
|
|
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 {
|
|
5332
7119
|
/**
|
|
5333
|
-
* Required. The resource name of the
|
|
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\}`
|
|
5334
7121
|
*/
|
|
5335
7122
|
name?: string;
|
|
5336
7123
|
}
|
|
5337
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
7124
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters {
|
|
5338
7125
|
/**
|
|
5339
|
-
*
|
|
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.
|
|
5340
7141
|
*/
|
|
5341
7142
|
pageSize?: number;
|
|
5342
7143
|
/**
|
|
5343
|
-
*
|
|
7144
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
5344
7145
|
*/
|
|
5345
7146
|
pageToken?: string;
|
|
5346
7147
|
/**
|
|
5347
|
-
* Required. The
|
|
7148
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
5348
7149
|
*/
|
|
5349
7150
|
parent?: string;
|
|
5350
7151
|
}
|
|
5351
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
7152
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch extends StandardParameters {
|
|
5352
7153
|
/**
|
|
5353
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/
|
|
7154
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
5354
7155
|
*/
|
|
5355
7156
|
name?: string;
|
|
5356
7157
|
/**
|
|
5357
|
-
* 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.
|
|
5358
7159
|
*/
|
|
5359
7160
|
updateMask?: string;
|
|
5360
7161
|
/**
|
|
5361
7162
|
* Request body metadata
|
|
5362
7163
|
*/
|
|
5363
|
-
requestBody?: Schema$
|
|
7164
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
5364
7165
|
}
|
|
5365
|
-
export
|
|
5366
|
-
|
|
5367
|
-
|
|
5368
|
-
*/
|
|
5369
|
-
servingConfig?: string;
|
|
7166
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers {
|
|
7167
|
+
context: APIRequestContext;
|
|
7168
|
+
constructor(context: APIRequestContext);
|
|
5370
7169
|
/**
|
|
5371
|
-
*
|
|
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.
|
|
5372
7176
|
*/
|
|
5373
|
-
|
|
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;
|
|
5374
7183
|
}
|
|
5375
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
5376
|
-
/**
|
|
5377
|
-
* 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.
|
|
5378
|
-
*/
|
|
5379
|
-
servingConfig?: string;
|
|
7184
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters {
|
|
5380
7185
|
/**
|
|
5381
|
-
*
|
|
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\}`
|
|
5382
7187
|
*/
|
|
5383
|
-
|
|
7188
|
+
name?: string;
|
|
5384
7189
|
}
|
|
5385
7190
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
|
|
5386
7191
|
context: APIRequestContext;
|
|
@@ -5897,7 +7702,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5897
7702
|
}
|
|
5898
7703
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters {
|
|
5899
7704
|
/**
|
|
5900
|
-
* 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\}`.
|
|
5901
7706
|
*/
|
|
5902
7707
|
parent?: string;
|
|
5903
7708
|
/**
|
|
@@ -5910,6 +7715,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5910
7715
|
conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
|
|
5911
7716
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
5912
7717
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
7718
|
+
sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
|
|
5913
7719
|
constructor(context: APIRequestContext);
|
|
5914
7720
|
/**
|
|
5915
7721
|
* Creates a Engine.
|
|
@@ -5981,6 +7787,48 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5981
7787
|
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5982
7788
|
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
5983
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;
|
|
5984
7832
|
}
|
|
5985
7833
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
|
|
5986
7834
|
/**
|
|
@@ -6040,6 +7888,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6040
7888
|
*/
|
|
6041
7889
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine;
|
|
6042
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
|
+
}
|
|
6043
7921
|
export class Resource$Projects$Locations$Collections$Engines$Conversations {
|
|
6044
7922
|
context: APIRequestContext;
|
|
6045
7923
|
constructor(context: APIRequestContext);
|
|
@@ -6184,7 +8062,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6184
8062
|
}
|
|
6185
8063
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch extends StandardParameters {
|
|
6186
8064
|
/**
|
|
6187
|
-
* 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`.
|
|
6188
8066
|
*/
|
|
6189
8067
|
name?: string;
|
|
6190
8068
|
/**
|
|
@@ -6252,133 +8130,314 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6252
8130
|
*/
|
|
6253
8131
|
pageToken?: string;
|
|
6254
8132
|
}
|
|
6255
|
-
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
8133
|
+
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
8134
|
+
context: APIRequestContext;
|
|
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;
|
|
8150
|
+
/**
|
|
8151
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
8152
|
+
*
|
|
8153
|
+
* @param params - Parameters for request
|
|
8154
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8155
|
+
* @param callback - Optional callback that handles the response.
|
|
8156
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8157
|
+
*/
|
|
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 {
|
|
6256
8286
|
context: APIRequestContext;
|
|
8287
|
+
answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers;
|
|
6257
8288
|
constructor(context: APIRequestContext);
|
|
6258
8289
|
/**
|
|
6259
|
-
*
|
|
8290
|
+
* Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
|
|
6260
8291
|
*
|
|
6261
8292
|
* @param params - Parameters for request
|
|
6262
8293
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6263
8294
|
* @param callback - Optional callback that handles the response.
|
|
6264
8295
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6265
8296
|
*/
|
|
6266
|
-
|
|
6267
|
-
|
|
6268
|
-
|
|
6269
|
-
|
|
6270
|
-
|
|
6271
|
-
|
|
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;
|
|
6272
8303
|
/**
|
|
6273
|
-
*
|
|
8304
|
+
* Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
|
|
6274
8305
|
*
|
|
6275
8306
|
* @param params - Parameters for request
|
|
6276
8307
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6277
8308
|
* @param callback - Optional callback that handles the response.
|
|
6278
8309
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6279
8310
|
*/
|
|
6280
|
-
|
|
6281
|
-
|
|
6282
|
-
|
|
6283
|
-
|
|
6284
|
-
|
|
6285
|
-
|
|
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;
|
|
6286
8317
|
/**
|
|
6287
|
-
*
|
|
8318
|
+
* Gets a Session.
|
|
6288
8319
|
*
|
|
6289
8320
|
* @param params - Parameters for request
|
|
6290
8321
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6291
8322
|
* @param callback - Optional callback that handles the response.
|
|
6292
8323
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6293
8324
|
*/
|
|
6294
|
-
|
|
6295
|
-
|
|
6296
|
-
|
|
6297
|
-
|
|
6298
|
-
|
|
6299
|
-
|
|
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;
|
|
6300
8331
|
/**
|
|
6301
|
-
*
|
|
8332
|
+
* Lists all Sessions by their parent DataStore.
|
|
6302
8333
|
*
|
|
6303
8334
|
* @param params - Parameters for request
|
|
6304
8335
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6305
8336
|
* @param callback - Optional callback that handles the response.
|
|
6306
8337
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6307
8338
|
*/
|
|
6308
|
-
|
|
6309
|
-
|
|
6310
|
-
|
|
6311
|
-
|
|
6312
|
-
|
|
6313
|
-
|
|
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;
|
|
6314
8345
|
/**
|
|
6315
|
-
*
|
|
8346
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
6316
8347
|
*
|
|
6317
8348
|
* @param params - Parameters for request
|
|
6318
8349
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6319
8350
|
* @param callback - Optional callback that handles the response.
|
|
6320
8351
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6321
8352
|
*/
|
|
6322
|
-
|
|
6323
|
-
|
|
6324
|
-
|
|
6325
|
-
|
|
6326
|
-
|
|
6327
|
-
|
|
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;
|
|
6328
8359
|
}
|
|
6329
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
8360
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters {
|
|
8361
|
+
/**
|
|
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 {
|
|
6330
8371
|
/**
|
|
6331
|
-
* Required. The resource name of the
|
|
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\}`
|
|
6332
8373
|
*/
|
|
6333
8374
|
name?: string;
|
|
6334
8375
|
}
|
|
6335
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
8376
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters {
|
|
6336
8377
|
/**
|
|
6337
|
-
*
|
|
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.
|
|
6338
8393
|
*/
|
|
6339
8394
|
pageSize?: number;
|
|
6340
8395
|
/**
|
|
6341
|
-
*
|
|
8396
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
6342
8397
|
*/
|
|
6343
8398
|
pageToken?: string;
|
|
6344
8399
|
/**
|
|
6345
|
-
* Required. The
|
|
8400
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
6346
8401
|
*/
|
|
6347
8402
|
parent?: string;
|
|
6348
8403
|
}
|
|
6349
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
8404
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters {
|
|
6350
8405
|
/**
|
|
6351
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/
|
|
8406
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
6352
8407
|
*/
|
|
6353
8408
|
name?: string;
|
|
6354
8409
|
/**
|
|
6355
|
-
* 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.
|
|
6356
8411
|
*/
|
|
6357
8412
|
updateMask?: string;
|
|
6358
8413
|
/**
|
|
6359
8414
|
* Request body metadata
|
|
6360
8415
|
*/
|
|
6361
|
-
requestBody?: Schema$
|
|
8416
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession;
|
|
6362
8417
|
}
|
|
6363
|
-
export
|
|
6364
|
-
|
|
6365
|
-
|
|
6366
|
-
*/
|
|
6367
|
-
servingConfig?: string;
|
|
8418
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers {
|
|
8419
|
+
context: APIRequestContext;
|
|
8420
|
+
constructor(context: APIRequestContext);
|
|
6368
8421
|
/**
|
|
6369
|
-
*
|
|
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.
|
|
6370
8428
|
*/
|
|
6371
|
-
|
|
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;
|
|
6372
8435
|
}
|
|
6373
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$
|
|
6374
|
-
/**
|
|
6375
|
-
* 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.
|
|
6376
|
-
*/
|
|
6377
|
-
servingConfig?: string;
|
|
8436
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
|
|
6378
8437
|
/**
|
|
6379
|
-
*
|
|
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\}`
|
|
6380
8439
|
*/
|
|
6381
|
-
|
|
8440
|
+
name?: string;
|
|
6382
8441
|
}
|
|
6383
8442
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
6384
8443
|
context: APIRequestContext;
|
|
@@ -6444,6 +8503,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6444
8503
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
6445
8504
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
6446
8505
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
8506
|
+
sessions: Resource$Projects$Locations$Datastores$Sessions;
|
|
6447
8507
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
6448
8508
|
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
6449
8509
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
@@ -6804,6 +8864,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6804
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.
|
|
6805
8865
|
*/
|
|
6806
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;
|
|
6807
8871
|
/**
|
|
6808
8872
|
* Request body metadata
|
|
6809
8873
|
*/
|
|
@@ -7019,7 +9083,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7019
9083
|
}
|
|
7020
9084
|
export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters {
|
|
7021
9085
|
/**
|
|
7022
|
-
* 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`.
|
|
7023
9087
|
*/
|
|
7024
9088
|
name?: string;
|
|
7025
9089
|
/**
|
|
@@ -7279,6 +9343,20 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7279
9343
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
7280
9344
|
context: APIRequestContext;
|
|
7281
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;
|
|
7282
9360
|
/**
|
|
7283
9361
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7284
9362
|
*
|
|
@@ -7350,9 +9428,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7350
9428
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
7351
9429
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
7352
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
|
+
}
|
|
7353
9441
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
7354
9442
|
/**
|
|
7355
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
9443
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
7356
9444
|
*/
|
|
7357
9445
|
name?: string;
|
|
7358
9446
|
}
|
|
@@ -7366,13 +9454,13 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7366
9454
|
*/
|
|
7367
9455
|
pageToken?: string;
|
|
7368
9456
|
/**
|
|
7369
|
-
* Required.
|
|
9457
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
7370
9458
|
*/
|
|
7371
9459
|
parent?: string;
|
|
7372
9460
|
}
|
|
7373
9461
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
7374
9462
|
/**
|
|
7375
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
9463
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
7376
9464
|
*/
|
|
7377
9465
|
name?: string;
|
|
7378
9466
|
/**
|
|
@@ -7404,6 +9492,163 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7404
9492
|
*/
|
|
7405
9493
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
7406
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
|
+
}
|
|
7407
9652
|
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
7408
9653
|
context: APIRequestContext;
|
|
7409
9654
|
targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites;
|
|
@@ -7753,7 +9998,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7753
9998
|
}
|
|
7754
9999
|
export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write extends StandardParameters {
|
|
7755
10000
|
/**
|
|
7756
|
-
* 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\}`.
|
|
7757
10002
|
*/
|
|
7758
10003
|
parent?: string;
|
|
7759
10004
|
/**
|
|
@@ -7761,6 +10006,34 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7761
10006
|
*/
|
|
7762
10007
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent;
|
|
7763
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
|
+
}
|
|
7764
10037
|
export class Resource$Projects$Locations$Operations {
|
|
7765
10038
|
context: APIRequestContext;
|
|
7766
10039
|
constructor(context: APIRequestContext);
|
|
@@ -7817,6 +10090,62 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7817
10090
|
*/
|
|
7818
10091
|
pageToken?: string;
|
|
7819
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
|
+
}
|
|
7820
10149
|
export class Resource$Projects$Operations {
|
|
7821
10150
|
context: APIRequestContext;
|
|
7822
10151
|
constructor(context: APIRequestContext);
|