@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/v1alpha.d.ts
CHANGED
|
@@ -215,6 +215,599 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
215
215
|
*/
|
|
216
216
|
token?: string | null;
|
|
217
217
|
}
|
|
218
|
+
/**
|
|
219
|
+
* Defines an answer.
|
|
220
|
+
*/
|
|
221
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswer {
|
|
222
|
+
/**
|
|
223
|
+
* Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
224
|
+
*/
|
|
225
|
+
answerSkippedReasons?: string[] | null;
|
|
226
|
+
/**
|
|
227
|
+
* The textual answer.
|
|
228
|
+
*/
|
|
229
|
+
answerText?: string | null;
|
|
230
|
+
/**
|
|
231
|
+
* Citations.
|
|
232
|
+
*/
|
|
233
|
+
citations?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
234
|
+
/**
|
|
235
|
+
* Output only. Answer completed timestamp.
|
|
236
|
+
*/
|
|
237
|
+
completeTime?: string | null;
|
|
238
|
+
/**
|
|
239
|
+
* Output only. Answer creation timestamp.
|
|
240
|
+
*/
|
|
241
|
+
createTime?: string | null;
|
|
242
|
+
/**
|
|
243
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x`
|
|
244
|
+
*/
|
|
245
|
+
name?: string | null;
|
|
246
|
+
/**
|
|
247
|
+
* Query understanding information.
|
|
248
|
+
*/
|
|
249
|
+
queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
|
|
250
|
+
/**
|
|
251
|
+
* References.
|
|
252
|
+
*/
|
|
253
|
+
references?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference[];
|
|
254
|
+
/**
|
|
255
|
+
* Suggested related questions.
|
|
256
|
+
*/
|
|
257
|
+
relatedQuestions?: string[] | null;
|
|
258
|
+
/**
|
|
259
|
+
* The state of the answer generation.
|
|
260
|
+
*/
|
|
261
|
+
state?: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* Answer generation steps.
|
|
264
|
+
*/
|
|
265
|
+
steps?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep[];
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Citation info for a segment.
|
|
269
|
+
*/
|
|
270
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitation {
|
|
271
|
+
/**
|
|
272
|
+
* End of the attributed segment, exclusive.
|
|
273
|
+
*/
|
|
274
|
+
endIndex?: string | null;
|
|
275
|
+
/**
|
|
276
|
+
* Citation sources for the attributed segment.
|
|
277
|
+
*/
|
|
278
|
+
sources?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
279
|
+
/**
|
|
280
|
+
* Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
|
|
281
|
+
*/
|
|
282
|
+
startIndex?: string | null;
|
|
283
|
+
}
|
|
284
|
+
/**
|
|
285
|
+
* Citation source.
|
|
286
|
+
*/
|
|
287
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerCitationSource {
|
|
288
|
+
/**
|
|
289
|
+
* ID of the citation source.
|
|
290
|
+
*/
|
|
291
|
+
referenceId?: string | null;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* Request message for ConversationalSearchService.AnswerQuery method.
|
|
295
|
+
*/
|
|
296
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest {
|
|
297
|
+
/**
|
|
298
|
+
* Answer generation specification.
|
|
299
|
+
*/
|
|
300
|
+
answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec;
|
|
301
|
+
/**
|
|
302
|
+
* 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.
|
|
303
|
+
*/
|
|
304
|
+
asynchronousMode?: boolean | null;
|
|
305
|
+
/**
|
|
306
|
+
* Required. Current user query.
|
|
307
|
+
*/
|
|
308
|
+
query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery;
|
|
309
|
+
/**
|
|
310
|
+
* Query understanding specification.
|
|
311
|
+
*/
|
|
312
|
+
queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec;
|
|
313
|
+
/**
|
|
314
|
+
* Related questions specification.
|
|
315
|
+
*/
|
|
316
|
+
relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec;
|
|
317
|
+
/**
|
|
318
|
+
* Model specification.
|
|
319
|
+
*/
|
|
320
|
+
safetySpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec;
|
|
321
|
+
/**
|
|
322
|
+
* Search specification.
|
|
323
|
+
*/
|
|
324
|
+
searchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec;
|
|
325
|
+
/**
|
|
326
|
+
* 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.
|
|
327
|
+
*/
|
|
328
|
+
session?: string | null;
|
|
329
|
+
/**
|
|
330
|
+
* 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.
|
|
331
|
+
*/
|
|
332
|
+
userPseudoId?: string | null;
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* Answer generation specification.
|
|
336
|
+
*/
|
|
337
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec {
|
|
338
|
+
/**
|
|
339
|
+
* 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.
|
|
340
|
+
*/
|
|
341
|
+
answerLanguageCode?: string | null;
|
|
342
|
+
/**
|
|
343
|
+
* 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.
|
|
344
|
+
*/
|
|
345
|
+
ignoreAdversarialQuery?: boolean | null;
|
|
346
|
+
/**
|
|
347
|
+
* 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.
|
|
348
|
+
*/
|
|
349
|
+
ignoreNonAnswerSeekingQuery?: boolean | null;
|
|
350
|
+
/**
|
|
351
|
+
* Specifies whether to include citation metadata in the answer. The default value is `false`.
|
|
352
|
+
*/
|
|
353
|
+
includeCitations?: boolean | null;
|
|
354
|
+
/**
|
|
355
|
+
* Answer generation model specification.
|
|
356
|
+
*/
|
|
357
|
+
modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec;
|
|
358
|
+
/**
|
|
359
|
+
* Answer generation prompt specification.
|
|
360
|
+
*/
|
|
361
|
+
promptSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* Answer Generation Model specification.
|
|
365
|
+
*/
|
|
366
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec {
|
|
367
|
+
/**
|
|
368
|
+
* Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
|
|
369
|
+
*/
|
|
370
|
+
modelVersion?: string | null;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* Answer generation prompt specification.
|
|
374
|
+
*/
|
|
375
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec {
|
|
376
|
+
/**
|
|
377
|
+
* Customized preamble.
|
|
378
|
+
*/
|
|
379
|
+
preamble?: string | null;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* Query understanding specification.
|
|
383
|
+
*/
|
|
384
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec {
|
|
385
|
+
/**
|
|
386
|
+
* Query classification specification.
|
|
387
|
+
*/
|
|
388
|
+
queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
|
|
389
|
+
/**
|
|
390
|
+
* Query rephraser specification.
|
|
391
|
+
*/
|
|
392
|
+
queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec;
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* Query classification specification.
|
|
396
|
+
*/
|
|
397
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec {
|
|
398
|
+
/**
|
|
399
|
+
* Enabled query classification types.
|
|
400
|
+
*/
|
|
401
|
+
types?: string[] | null;
|
|
402
|
+
}
|
|
403
|
+
/**
|
|
404
|
+
* Query rephraser specification.
|
|
405
|
+
*/
|
|
406
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
|
|
407
|
+
/**
|
|
408
|
+
* Disable query rephraser.
|
|
409
|
+
*/
|
|
410
|
+
disable?: boolean | null;
|
|
411
|
+
/**
|
|
412
|
+
* Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
|
|
413
|
+
*/
|
|
414
|
+
maxRephraseSteps?: number | null;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* Related questions specification.
|
|
418
|
+
*/
|
|
419
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec {
|
|
420
|
+
/**
|
|
421
|
+
* Enable related questions feature if true.
|
|
422
|
+
*/
|
|
423
|
+
enable?: boolean | null;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* Safety specification.
|
|
427
|
+
*/
|
|
428
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec {
|
|
429
|
+
/**
|
|
430
|
+
* Enable the safety filtering on the answer response. It is false by default.
|
|
431
|
+
*/
|
|
432
|
+
enable?: boolean | null;
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* Search specification.
|
|
436
|
+
*/
|
|
437
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec {
|
|
438
|
+
/**
|
|
439
|
+
* Search parameters.
|
|
440
|
+
*/
|
|
441
|
+
searchParams?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams;
|
|
442
|
+
/**
|
|
443
|
+
* Search result list.
|
|
444
|
+
*/
|
|
445
|
+
searchResultList?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList;
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
* Search parameters.
|
|
449
|
+
*/
|
|
450
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams {
|
|
451
|
+
/**
|
|
452
|
+
* 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)
|
|
453
|
+
*/
|
|
454
|
+
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
455
|
+
/**
|
|
456
|
+
* Custom fine tuning configs.
|
|
457
|
+
*/
|
|
458
|
+
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
459
|
+
/**
|
|
460
|
+
* 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)
|
|
461
|
+
*/
|
|
462
|
+
filter?: string | null;
|
|
463
|
+
/**
|
|
464
|
+
* Number of search results to return. The default value is 10.
|
|
465
|
+
*/
|
|
466
|
+
maxReturnResults?: number | null;
|
|
467
|
+
/**
|
|
468
|
+
* 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.
|
|
469
|
+
*/
|
|
470
|
+
orderBy?: string | null;
|
|
471
|
+
/**
|
|
472
|
+
* Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
|
|
473
|
+
*/
|
|
474
|
+
searchResultMode?: string | null;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* Search result list.
|
|
478
|
+
*/
|
|
479
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList {
|
|
480
|
+
/**
|
|
481
|
+
* Search results.
|
|
482
|
+
*/
|
|
483
|
+
searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult[];
|
|
484
|
+
}
|
|
485
|
+
/**
|
|
486
|
+
* Search result.
|
|
487
|
+
*/
|
|
488
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult {
|
|
489
|
+
/**
|
|
490
|
+
* Chunk information.
|
|
491
|
+
*/
|
|
492
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo;
|
|
493
|
+
/**
|
|
494
|
+
* Unstructured document information.
|
|
495
|
+
*/
|
|
496
|
+
unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* Chunk information.
|
|
500
|
+
*/
|
|
501
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo {
|
|
502
|
+
/**
|
|
503
|
+
* Chunk resource name.
|
|
504
|
+
*/
|
|
505
|
+
chunk?: string | null;
|
|
506
|
+
/**
|
|
507
|
+
* Chunk textual content.
|
|
508
|
+
*/
|
|
509
|
+
content?: string | null;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* Unstructured document information.
|
|
513
|
+
*/
|
|
514
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
|
|
515
|
+
/**
|
|
516
|
+
* Document resource name.
|
|
517
|
+
*/
|
|
518
|
+
document?: string | null;
|
|
519
|
+
/**
|
|
520
|
+
* List of document contexts.
|
|
521
|
+
*/
|
|
522
|
+
documentContexts?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[];
|
|
523
|
+
/**
|
|
524
|
+
* List of extractive answers.
|
|
525
|
+
*/
|
|
526
|
+
extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[];
|
|
527
|
+
/**
|
|
528
|
+
* List of extractive segments.
|
|
529
|
+
*/
|
|
530
|
+
extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[];
|
|
531
|
+
/**
|
|
532
|
+
* Title.
|
|
533
|
+
*/
|
|
534
|
+
title?: string | null;
|
|
535
|
+
/**
|
|
536
|
+
* URI for the document.
|
|
537
|
+
*/
|
|
538
|
+
uri?: string | null;
|
|
539
|
+
}
|
|
540
|
+
/**
|
|
541
|
+
* Document context.
|
|
542
|
+
*/
|
|
543
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext {
|
|
544
|
+
/**
|
|
545
|
+
* Document content.
|
|
546
|
+
*/
|
|
547
|
+
content?: string | null;
|
|
548
|
+
/**
|
|
549
|
+
* Page identifier.
|
|
550
|
+
*/
|
|
551
|
+
pageIdentifier?: string | null;
|
|
552
|
+
}
|
|
553
|
+
/**
|
|
554
|
+
* Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
|
|
555
|
+
*/
|
|
556
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer {
|
|
557
|
+
/**
|
|
558
|
+
* Extractive answer content.
|
|
559
|
+
*/
|
|
560
|
+
content?: string | null;
|
|
561
|
+
/**
|
|
562
|
+
* Page identifier.
|
|
563
|
+
*/
|
|
564
|
+
pageIdentifier?: string | null;
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
|
|
568
|
+
*/
|
|
569
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment {
|
|
570
|
+
/**
|
|
571
|
+
* Extractive segment content.
|
|
572
|
+
*/
|
|
573
|
+
content?: string | null;
|
|
574
|
+
/**
|
|
575
|
+
* Page identifier.
|
|
576
|
+
*/
|
|
577
|
+
pageIdentifier?: string | null;
|
|
578
|
+
}
|
|
579
|
+
/**
|
|
580
|
+
* Response message for ConversationalSearchService.AnswerQuery method.
|
|
581
|
+
*/
|
|
582
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse {
|
|
583
|
+
/**
|
|
584
|
+
* Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
|
|
585
|
+
*/
|
|
586
|
+
answer?: Schema$GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
587
|
+
/**
|
|
588
|
+
* A global unique ID used for logging.
|
|
589
|
+
*/
|
|
590
|
+
answerQueryToken?: string | null;
|
|
591
|
+
/**
|
|
592
|
+
* Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
|
|
593
|
+
*/
|
|
594
|
+
session?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
595
|
+
}
|
|
596
|
+
/**
|
|
597
|
+
* Query understanding information.
|
|
598
|
+
*/
|
|
599
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
|
|
600
|
+
/**
|
|
601
|
+
* Query classification information.
|
|
602
|
+
*/
|
|
603
|
+
queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
604
|
+
}
|
|
605
|
+
/**
|
|
606
|
+
* Query classification information.
|
|
607
|
+
*/
|
|
608
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo {
|
|
609
|
+
/**
|
|
610
|
+
* Classification output.
|
|
611
|
+
*/
|
|
612
|
+
positive?: boolean | null;
|
|
613
|
+
/**
|
|
614
|
+
* Query classification type.
|
|
615
|
+
*/
|
|
616
|
+
type?: string | null;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* Reference.
|
|
620
|
+
*/
|
|
621
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReference {
|
|
622
|
+
/**
|
|
623
|
+
* Chunk information.
|
|
624
|
+
*/
|
|
625
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
|
|
626
|
+
/**
|
|
627
|
+
* Unstructured document information.
|
|
628
|
+
*/
|
|
629
|
+
unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
|
|
630
|
+
}
|
|
631
|
+
/**
|
|
632
|
+
* Chunk information.
|
|
633
|
+
*/
|
|
634
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo {
|
|
635
|
+
/**
|
|
636
|
+
* Chunk resource name.
|
|
637
|
+
*/
|
|
638
|
+
chunk?: string | null;
|
|
639
|
+
/**
|
|
640
|
+
* Chunk textual content.
|
|
641
|
+
*/
|
|
642
|
+
content?: string | null;
|
|
643
|
+
/**
|
|
644
|
+
* Document metadata.
|
|
645
|
+
*/
|
|
646
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
|
|
647
|
+
/**
|
|
648
|
+
* Relevance score.
|
|
649
|
+
*/
|
|
650
|
+
relevanceScore?: number | null;
|
|
651
|
+
}
|
|
652
|
+
/**
|
|
653
|
+
* Document metadata.
|
|
654
|
+
*/
|
|
655
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
|
|
656
|
+
/**
|
|
657
|
+
* Document resource name.
|
|
658
|
+
*/
|
|
659
|
+
document?: string | null;
|
|
660
|
+
/**
|
|
661
|
+
* Page identifier.
|
|
662
|
+
*/
|
|
663
|
+
pageIdentifier?: string | null;
|
|
664
|
+
/**
|
|
665
|
+
* Title.
|
|
666
|
+
*/
|
|
667
|
+
title?: string | null;
|
|
668
|
+
/**
|
|
669
|
+
* URI for the document.
|
|
670
|
+
*/
|
|
671
|
+
uri?: string | null;
|
|
672
|
+
}
|
|
673
|
+
/**
|
|
674
|
+
* Unstructured document information.
|
|
675
|
+
*/
|
|
676
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
|
|
677
|
+
/**
|
|
678
|
+
* List of cited chunk contents derived from document content.
|
|
679
|
+
*/
|
|
680
|
+
chunkContents?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
681
|
+
/**
|
|
682
|
+
* Document resource name.
|
|
683
|
+
*/
|
|
684
|
+
document?: string | null;
|
|
685
|
+
/**
|
|
686
|
+
* Title.
|
|
687
|
+
*/
|
|
688
|
+
title?: string | null;
|
|
689
|
+
/**
|
|
690
|
+
* URI for the document.
|
|
691
|
+
*/
|
|
692
|
+
uri?: string | null;
|
|
693
|
+
}
|
|
694
|
+
/**
|
|
695
|
+
* Chunk content.
|
|
696
|
+
*/
|
|
697
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent {
|
|
698
|
+
/**
|
|
699
|
+
* Chunk textual content.
|
|
700
|
+
*/
|
|
701
|
+
content?: string | null;
|
|
702
|
+
/**
|
|
703
|
+
* Page identifier.
|
|
704
|
+
*/
|
|
705
|
+
pageIdentifier?: string | null;
|
|
706
|
+
}
|
|
707
|
+
/**
|
|
708
|
+
* Step information.
|
|
709
|
+
*/
|
|
710
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStep {
|
|
711
|
+
/**
|
|
712
|
+
* Actions.
|
|
713
|
+
*/
|
|
714
|
+
actions?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction[];
|
|
715
|
+
/**
|
|
716
|
+
* The description of the step.
|
|
717
|
+
*/
|
|
718
|
+
description?: string | null;
|
|
719
|
+
/**
|
|
720
|
+
* The state of the step.
|
|
721
|
+
*/
|
|
722
|
+
state?: string | null;
|
|
723
|
+
/**
|
|
724
|
+
* The thought of the step.
|
|
725
|
+
*/
|
|
726
|
+
thought?: string | null;
|
|
727
|
+
}
|
|
728
|
+
/**
|
|
729
|
+
* Action.
|
|
730
|
+
*/
|
|
731
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepAction {
|
|
732
|
+
/**
|
|
733
|
+
* Observation.
|
|
734
|
+
*/
|
|
735
|
+
observation?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation;
|
|
736
|
+
/**
|
|
737
|
+
* Search action.
|
|
738
|
+
*/
|
|
739
|
+
searchAction?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction;
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* Observation.
|
|
743
|
+
*/
|
|
744
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation {
|
|
745
|
+
/**
|
|
746
|
+
* Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
|
|
747
|
+
*/
|
|
748
|
+
searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult[];
|
|
749
|
+
}
|
|
750
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult {
|
|
751
|
+
/**
|
|
752
|
+
* If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
|
|
753
|
+
*/
|
|
754
|
+
chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo[];
|
|
755
|
+
/**
|
|
756
|
+
* Document resource name.
|
|
757
|
+
*/
|
|
758
|
+
document?: string | null;
|
|
759
|
+
/**
|
|
760
|
+
* If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
|
|
761
|
+
*/
|
|
762
|
+
snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
763
|
+
/**
|
|
764
|
+
* Title.
|
|
765
|
+
*/
|
|
766
|
+
title?: string | null;
|
|
767
|
+
/**
|
|
768
|
+
* URI for the document.
|
|
769
|
+
*/
|
|
770
|
+
uri?: string | null;
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* Chunk information.
|
|
774
|
+
*/
|
|
775
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo {
|
|
776
|
+
/**
|
|
777
|
+
* Chunk resource name.
|
|
778
|
+
*/
|
|
779
|
+
chunk?: string | null;
|
|
780
|
+
/**
|
|
781
|
+
* Chunk textual content.
|
|
782
|
+
*/
|
|
783
|
+
content?: string | null;
|
|
784
|
+
/**
|
|
785
|
+
* Relevance score.
|
|
786
|
+
*/
|
|
787
|
+
relevanceScore?: number | null;
|
|
788
|
+
}
|
|
789
|
+
/**
|
|
790
|
+
* Snippet information.
|
|
791
|
+
*/
|
|
792
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
793
|
+
/**
|
|
794
|
+
* Snippet content.
|
|
795
|
+
*/
|
|
796
|
+
snippet?: string | null;
|
|
797
|
+
/**
|
|
798
|
+
* Status of the snippet defined by the search team.
|
|
799
|
+
*/
|
|
800
|
+
snippetStatus?: string | null;
|
|
801
|
+
}
|
|
802
|
+
/**
|
|
803
|
+
* Search action.
|
|
804
|
+
*/
|
|
805
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction {
|
|
806
|
+
/**
|
|
807
|
+
* The query to search.
|
|
808
|
+
*/
|
|
809
|
+
query?: string | null;
|
|
810
|
+
}
|
|
218
811
|
/**
|
|
219
812
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
220
813
|
*/
|
|
@@ -256,7 +849,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
256
849
|
*/
|
|
257
850
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBigQuerySource {
|
|
258
851
|
/**
|
|
259
|
-
* 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
|
|
852
|
+
* 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.
|
|
260
853
|
*/
|
|
261
854
|
dataSchema?: string | null;
|
|
262
855
|
/**
|
|
@@ -280,6 +873,257 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
280
873
|
*/
|
|
281
874
|
tableId?: string | null;
|
|
282
875
|
}
|
|
876
|
+
/**
|
|
877
|
+
* The Bigtable Options object that contains information to support the import.
|
|
878
|
+
*/
|
|
879
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptions {
|
|
880
|
+
/**
|
|
881
|
+
* 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.
|
|
882
|
+
*/
|
|
883
|
+
families?: {
|
|
884
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily;
|
|
885
|
+
} | null;
|
|
886
|
+
/**
|
|
887
|
+
* The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`.
|
|
888
|
+
*/
|
|
889
|
+
keyFieldName?: string | null;
|
|
890
|
+
}
|
|
891
|
+
/**
|
|
892
|
+
* The column of the Bigtable.
|
|
893
|
+
*/
|
|
894
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn {
|
|
895
|
+
/**
|
|
896
|
+
* 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.
|
|
897
|
+
*/
|
|
898
|
+
encoding?: string | null;
|
|
899
|
+
/**
|
|
900
|
+
* 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.
|
|
901
|
+
*/
|
|
902
|
+
fieldName?: string | null;
|
|
903
|
+
/**
|
|
904
|
+
* Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.
|
|
905
|
+
*/
|
|
906
|
+
qualifier?: string | null;
|
|
907
|
+
/**
|
|
908
|
+
* 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`.
|
|
909
|
+
*/
|
|
910
|
+
type?: string | null;
|
|
911
|
+
}
|
|
912
|
+
/**
|
|
913
|
+
* The column family of the Bigtable.
|
|
914
|
+
*/
|
|
915
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily {
|
|
916
|
+
/**
|
|
917
|
+
* 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.
|
|
918
|
+
*/
|
|
919
|
+
columns?: Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn[];
|
|
920
|
+
/**
|
|
921
|
+
* 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.
|
|
922
|
+
*/
|
|
923
|
+
encoding?: string | null;
|
|
924
|
+
/**
|
|
925
|
+
* 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.
|
|
926
|
+
*/
|
|
927
|
+
fieldName?: string | null;
|
|
928
|
+
/**
|
|
929
|
+
* 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`.
|
|
930
|
+
*/
|
|
931
|
+
type?: string | null;
|
|
932
|
+
}
|
|
933
|
+
/**
|
|
934
|
+
* The Cloud Bigtable source for importing data.
|
|
935
|
+
*/
|
|
936
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaBigtableSource {
|
|
937
|
+
/**
|
|
938
|
+
* Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations.
|
|
939
|
+
*/
|
|
940
|
+
bigtableOptions?: Schema$GoogleCloudDiscoveryengineV1alphaBigtableOptions;
|
|
941
|
+
/**
|
|
942
|
+
* Required. The instance ID of the Cloud Bigtable that needs to be imported.
|
|
943
|
+
*/
|
|
944
|
+
instanceId?: string | null;
|
|
945
|
+
/**
|
|
946
|
+
* 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.
|
|
947
|
+
*/
|
|
948
|
+
projectId?: string | null;
|
|
949
|
+
/**
|
|
950
|
+
* Required. The table ID of the Cloud Bigtable that needs to be imported.
|
|
951
|
+
*/
|
|
952
|
+
tableId?: string | null;
|
|
953
|
+
}
|
|
954
|
+
/**
|
|
955
|
+
* Request message for GroundedGenerationService.CheckGrounding method.
|
|
956
|
+
*/
|
|
957
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest {
|
|
958
|
+
/**
|
|
959
|
+
* Answer candidate to check.
|
|
960
|
+
*/
|
|
961
|
+
answerCandidate?: string | null;
|
|
962
|
+
/**
|
|
963
|
+
* List of facts for the grounding check. We support up to 200 facts.
|
|
964
|
+
*/
|
|
965
|
+
facts?: Schema$GoogleCloudDiscoveryengineV1alphaGroundingFact[];
|
|
966
|
+
/**
|
|
967
|
+
* Configuration of the grounding check.
|
|
968
|
+
*/
|
|
969
|
+
groundingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec;
|
|
970
|
+
}
|
|
971
|
+
/**
|
|
972
|
+
* Response message for the GroundedGenerationService.CheckGrounding method.
|
|
973
|
+
*/
|
|
974
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse {
|
|
975
|
+
/**
|
|
976
|
+
* List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
|
|
977
|
+
*/
|
|
978
|
+
citedChunks?: Schema$GoogleCloudDiscoveryengineV1alphaFactChunk[];
|
|
979
|
+
/**
|
|
980
|
+
* Claim texts and citation info across all claims in the answer candidate.
|
|
981
|
+
*/
|
|
982
|
+
claims?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim[];
|
|
983
|
+
/**
|
|
984
|
+
* 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.
|
|
985
|
+
*/
|
|
986
|
+
supportScore?: number | null;
|
|
987
|
+
}
|
|
988
|
+
/**
|
|
989
|
+
* Text and citation info for a claim in the answer candidate.
|
|
990
|
+
*/
|
|
991
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim {
|
|
992
|
+
/**
|
|
993
|
+
* 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.
|
|
994
|
+
*/
|
|
995
|
+
citationIndices?: number[] | null;
|
|
996
|
+
/**
|
|
997
|
+
* Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
|
|
998
|
+
*/
|
|
999
|
+
claimText?: string | null;
|
|
1000
|
+
/**
|
|
1001
|
+
* Position indicating the end of the claim in the answer candidate, exclusive.
|
|
1002
|
+
*/
|
|
1003
|
+
endPos?: number | null;
|
|
1004
|
+
/**
|
|
1005
|
+
* Position indicating the start of the claim in the answer candidate, measured in bytes.
|
|
1006
|
+
*/
|
|
1007
|
+
startPos?: number | null;
|
|
1008
|
+
}
|
|
1009
|
+
/**
|
|
1010
|
+
* Specification for the grounding check.
|
|
1011
|
+
*/
|
|
1012
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec {
|
|
1013
|
+
/**
|
|
1014
|
+
* 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.
|
|
1015
|
+
*/
|
|
1016
|
+
citationThreshold?: number | null;
|
|
1017
|
+
}
|
|
1018
|
+
/**
|
|
1019
|
+
* Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
|
|
1020
|
+
*/
|
|
1021
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunk {
|
|
1022
|
+
/**
|
|
1023
|
+
* Output only. Metadata of the current chunk.
|
|
1024
|
+
*/
|
|
1025
|
+
chunkMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
|
|
1026
|
+
/**
|
|
1027
|
+
* Content is a string from a document (parsed content).
|
|
1028
|
+
*/
|
|
1029
|
+
content?: string | null;
|
|
1030
|
+
/**
|
|
1031
|
+
* Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
|
|
1032
|
+
*/
|
|
1033
|
+
derivedStructData?: {
|
|
1034
|
+
[key: string]: any;
|
|
1035
|
+
} | null;
|
|
1036
|
+
/**
|
|
1037
|
+
* Metadata of the document from the current chunk.
|
|
1038
|
+
*/
|
|
1039
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata;
|
|
1040
|
+
/**
|
|
1041
|
+
* Unique chunk ID of the current chunk.
|
|
1042
|
+
*/
|
|
1043
|
+
id?: string | null;
|
|
1044
|
+
/**
|
|
1045
|
+
* The full resource name of the chunk. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}/chunks/{chunk_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
1046
|
+
*/
|
|
1047
|
+
name?: string | null;
|
|
1048
|
+
/**
|
|
1049
|
+
* Page span of the chunk.
|
|
1050
|
+
*/
|
|
1051
|
+
pageSpan?: Schema$GoogleCloudDiscoveryengineV1alphaChunkPageSpan;
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* Metadata of the current chunk. This field is only populated on SearchService.Search API.
|
|
1055
|
+
*/
|
|
1056
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
|
|
1057
|
+
/**
|
|
1058
|
+
* The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.
|
|
1059
|
+
*/
|
|
1060
|
+
nextChunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
1061
|
+
/**
|
|
1062
|
+
* The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.
|
|
1063
|
+
*/
|
|
1064
|
+
previousChunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* Document metadata contains the information of the document of the current chunk.
|
|
1068
|
+
*/
|
|
1069
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
|
|
1070
|
+
/**
|
|
1071
|
+
* Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
|
|
1072
|
+
*/
|
|
1073
|
+
structData?: {
|
|
1074
|
+
[key: string]: any;
|
|
1075
|
+
} | null;
|
|
1076
|
+
/**
|
|
1077
|
+
* Title of the document.
|
|
1078
|
+
*/
|
|
1079
|
+
title?: string | null;
|
|
1080
|
+
/**
|
|
1081
|
+
* Uri of the document.
|
|
1082
|
+
*/
|
|
1083
|
+
uri?: string | null;
|
|
1084
|
+
}
|
|
1085
|
+
/**
|
|
1086
|
+
* Page span of the chunk.
|
|
1087
|
+
*/
|
|
1088
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkPageSpan {
|
|
1089
|
+
/**
|
|
1090
|
+
* The end page of the chunk.
|
|
1091
|
+
*/
|
|
1092
|
+
pageEnd?: number | null;
|
|
1093
|
+
/**
|
|
1094
|
+
* The start page of the chunk.
|
|
1095
|
+
*/
|
|
1096
|
+
pageStart?: number | null;
|
|
1097
|
+
}
|
|
1098
|
+
/**
|
|
1099
|
+
* Cloud SQL source import data from.
|
|
1100
|
+
*/
|
|
1101
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
|
|
1102
|
+
/**
|
|
1103
|
+
* Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.
|
|
1104
|
+
*/
|
|
1105
|
+
databaseId?: string | null;
|
|
1106
|
+
/**
|
|
1107
|
+
* 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.
|
|
1108
|
+
*/
|
|
1109
|
+
gcsStagingDir?: string | null;
|
|
1110
|
+
/**
|
|
1111
|
+
* Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.
|
|
1112
|
+
*/
|
|
1113
|
+
instanceId?: string | null;
|
|
1114
|
+
/**
|
|
1115
|
+
* Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).
|
|
1116
|
+
*/
|
|
1117
|
+
offload?: boolean | null;
|
|
1118
|
+
/**
|
|
1119
|
+
* 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.
|
|
1120
|
+
*/
|
|
1121
|
+
projectId?: string | null;
|
|
1122
|
+
/**
|
|
1123
|
+
* Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.
|
|
1124
|
+
*/
|
|
1125
|
+
tableId?: string | null;
|
|
1126
|
+
}
|
|
283
1127
|
/**
|
|
284
1128
|
* Request message for CompletionService.CompleteQuery method.
|
|
285
1129
|
*/
|
|
@@ -357,7 +1201,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
357
1201
|
*/
|
|
358
1202
|
messages?: Schema$GoogleCloudDiscoveryengineV1alphaConversationMessage[];
|
|
359
1203
|
/**
|
|
360
|
-
* Immutable. Fully qualified name `project/
|
|
1204
|
+
* 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`.
|
|
361
1205
|
*/
|
|
362
1206
|
name?: string | null;
|
|
363
1207
|
/**
|
|
@@ -655,11 +1499,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
655
1499
|
*/
|
|
656
1500
|
updateTime?: string | null;
|
|
657
1501
|
}
|
|
658
|
-
/**
|
|
659
|
-
* The digital parsing configurations for documents.
|
|
660
|
-
*/
|
|
661
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {
|
|
662
|
-
}
|
|
663
1502
|
/**
|
|
664
1503
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
665
1504
|
*/
|
|
@@ -736,6 +1575,9 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
736
1575
|
* ACL Information of the Document.
|
|
737
1576
|
*/
|
|
738
1577
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
1578
|
+
/**
|
|
1579
|
+
* Readers of the document.
|
|
1580
|
+
*/
|
|
739
1581
|
readers?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
|
|
740
1582
|
}
|
|
741
1583
|
/**
|
|
@@ -793,6 +1635,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
793
1635
|
* 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.
|
|
794
1636
|
*/
|
|
795
1637
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig {
|
|
1638
|
+
/**
|
|
1639
|
+
* Whether chunking mode is enabled.
|
|
1640
|
+
*/
|
|
1641
|
+
chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig;
|
|
796
1642
|
/**
|
|
797
1643
|
* 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.
|
|
798
1644
|
*/
|
|
@@ -801,10 +1647,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
801
1647
|
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
802
1648
|
*/
|
|
803
1649
|
name?: string | null;
|
|
804
|
-
/**
|
|
805
|
-
* [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.
|
|
806
|
-
*/
|
|
807
|
-
ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
808
1650
|
/**
|
|
809
1651
|
* 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.
|
|
810
1652
|
*/
|
|
@@ -812,6 +1654,28 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
812
1654
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
813
1655
|
} | null;
|
|
814
1656
|
}
|
|
1657
|
+
/**
|
|
1658
|
+
* Configuration for chunking config.
|
|
1659
|
+
*/
|
|
1660
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig {
|
|
1661
|
+
/**
|
|
1662
|
+
* Configuration for the layout based chunking.
|
|
1663
|
+
*/
|
|
1664
|
+
layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig;
|
|
1665
|
+
}
|
|
1666
|
+
/**
|
|
1667
|
+
* Configuration for the layout based chunking.
|
|
1668
|
+
*/
|
|
1669
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig {
|
|
1670
|
+
/**
|
|
1671
|
+
* The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
|
|
1672
|
+
*/
|
|
1673
|
+
chunkSize?: number | null;
|
|
1674
|
+
/**
|
|
1675
|
+
* Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
|
|
1676
|
+
*/
|
|
1677
|
+
includeAncestorHeadings?: boolean | null;
|
|
1678
|
+
}
|
|
815
1679
|
/**
|
|
816
1680
|
* Related configurations applied to a specific type of document parser.
|
|
817
1681
|
*/
|
|
@@ -819,15 +1683,38 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
819
1683
|
/**
|
|
820
1684
|
* Configurations applied to digital parser.
|
|
821
1685
|
*/
|
|
822
|
-
digitalParsingConfig?: Schema$
|
|
1686
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
823
1687
|
/**
|
|
824
1688
|
* Configurations applied to layout parser.
|
|
825
1689
|
*/
|
|
826
|
-
layoutParsingConfig?: Schema$
|
|
1690
|
+
layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig;
|
|
827
1691
|
/**
|
|
828
1692
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
829
1693
|
*/
|
|
830
|
-
ocrParsingConfig?: Schema$
|
|
1694
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1695
|
+
}
|
|
1696
|
+
/**
|
|
1697
|
+
* The digital parsing configurations for documents.
|
|
1698
|
+
*/
|
|
1699
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
1700
|
+
}
|
|
1701
|
+
/**
|
|
1702
|
+
* The layout parsing configurations for documents.
|
|
1703
|
+
*/
|
|
1704
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
|
|
1705
|
+
}
|
|
1706
|
+
/**
|
|
1707
|
+
* The OCR parsing configurations for documents.
|
|
1708
|
+
*/
|
|
1709
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1710
|
+
/**
|
|
1711
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
1712
|
+
*/
|
|
1713
|
+
enhancedDocumentElements?: string[] | null;
|
|
1714
|
+
/**
|
|
1715
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1716
|
+
*/
|
|
1717
|
+
useNativeText?: boolean | null;
|
|
831
1718
|
}
|
|
832
1719
|
/**
|
|
833
1720
|
* Double list.
|
|
@@ -874,10 +1761,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
874
1761
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
875
1762
|
*/
|
|
876
1763
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
877
|
-
/**
|
|
878
|
-
* 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.
|
|
879
|
-
*/
|
|
880
|
-
allowMultipleDataStoresSearchEngine?: boolean | null;
|
|
881
1764
|
/**
|
|
882
1765
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
883
1766
|
*/
|
|
@@ -944,7 +1827,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
944
1827
|
*/
|
|
945
1828
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
946
1829
|
/**
|
|
947
|
-
* 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.
|
|
1830
|
+
* 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.
|
|
948
1831
|
*/
|
|
949
1832
|
dialogflowAgentToLink?: string | null;
|
|
950
1833
|
}
|
|
@@ -1051,7 +1934,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1051
1934
|
*/
|
|
1052
1935
|
searchAddOns?: string[] | null;
|
|
1053
1936
|
/**
|
|
1054
|
-
* The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
1937
|
+
* 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.
|
|
1055
1938
|
*/
|
|
1056
1939
|
searchTier?: string | null;
|
|
1057
1940
|
}
|
|
@@ -1134,6 +2017,25 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1134
2017
|
*/
|
|
1135
2018
|
documentCount?: string | null;
|
|
1136
2019
|
}
|
|
2020
|
+
/**
|
|
2021
|
+
* Fact Chunk.
|
|
2022
|
+
*/
|
|
2023
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaFactChunk {
|
|
2024
|
+
/**
|
|
2025
|
+
* Text content of the fact chunk. Can be at most 10K characters long.
|
|
2026
|
+
*/
|
|
2027
|
+
chunkText?: string | null;
|
|
2028
|
+
/**
|
|
2029
|
+
* 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.
|
|
2030
|
+
*/
|
|
2031
|
+
source?: string | null;
|
|
2032
|
+
/**
|
|
2033
|
+
* More fine-grained information for the source reference.
|
|
2034
|
+
*/
|
|
2035
|
+
sourceMetadata?: {
|
|
2036
|
+
[key: string]: string;
|
|
2037
|
+
} | null;
|
|
2038
|
+
}
|
|
1137
2039
|
/**
|
|
1138
2040
|
* Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.
|
|
1139
2041
|
*/
|
|
@@ -1151,10 +2053,27 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1151
2053
|
*/
|
|
1152
2054
|
totalSize?: number | null;
|
|
1153
2055
|
}
|
|
2056
|
+
/**
|
|
2057
|
+
* Cloud FhirStore source import data from.
|
|
2058
|
+
*/
|
|
2059
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaFhirStoreSource {
|
|
2060
|
+
/**
|
|
2061
|
+
* 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\}`.
|
|
2062
|
+
*/
|
|
2063
|
+
fhirStore?: string | null;
|
|
2064
|
+
/**
|
|
2065
|
+
* 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.
|
|
2066
|
+
*/
|
|
2067
|
+
gcsStagingDir?: string | null;
|
|
2068
|
+
}
|
|
1154
2069
|
/**
|
|
1155
2070
|
* Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
|
|
1156
2071
|
*/
|
|
1157
2072
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
2073
|
+
/**
|
|
2074
|
+
* 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 ``.
|
|
2075
|
+
*/
|
|
2076
|
+
advancedSiteSearchDataSources?: string[] | null;
|
|
1158
2077
|
/**
|
|
1159
2078
|
* 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.
|
|
1160
2079
|
*/
|
|
@@ -1192,18 +2111,54 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1192
2111
|
*/
|
|
1193
2112
|
searchableOption?: string | null;
|
|
1194
2113
|
}
|
|
2114
|
+
/**
|
|
2115
|
+
* Firestore source import data from.
|
|
2116
|
+
*/
|
|
2117
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaFirestoreSource {
|
|
2118
|
+
/**
|
|
2119
|
+
* Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.
|
|
2120
|
+
*/
|
|
2121
|
+
collectionId?: string | null;
|
|
2122
|
+
/**
|
|
2123
|
+
* Required. The Firestore database to copy the data from with a length limit of 256 characters.
|
|
2124
|
+
*/
|
|
2125
|
+
databaseId?: string | null;
|
|
2126
|
+
/**
|
|
2127
|
+
* 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.
|
|
2128
|
+
*/
|
|
2129
|
+
gcsStagingDir?: string | null;
|
|
2130
|
+
/**
|
|
2131
|
+
* 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.
|
|
2132
|
+
*/
|
|
2133
|
+
projectId?: string | null;
|
|
2134
|
+
}
|
|
1195
2135
|
/**
|
|
1196
2136
|
* Cloud Storage location for input content.
|
|
1197
2137
|
*/
|
|
1198
2138
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaGcsSource {
|
|
1199
2139
|
/**
|
|
1200
|
-
* 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
|
|
2140
|
+
* 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.
|
|
2141
|
+
*/
|
|
2142
|
+
dataSchema?: string | null;
|
|
2143
|
+
/**
|
|
2144
|
+
* Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/x.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
|
|
2145
|
+
*/
|
|
2146
|
+
inputUris?: string[] | null;
|
|
2147
|
+
}
|
|
2148
|
+
/**
|
|
2149
|
+
* Grounding Fact.
|
|
2150
|
+
*/
|
|
2151
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaGroundingFact {
|
|
2152
|
+
/**
|
|
2153
|
+
* 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.
|
|
1201
2154
|
*/
|
|
1202
|
-
|
|
2155
|
+
attributes?: {
|
|
2156
|
+
[key: string]: string;
|
|
2157
|
+
} | null;
|
|
1203
2158
|
/**
|
|
1204
|
-
*
|
|
2159
|
+
* Text content of the fact. Can be at most 10K characters long.
|
|
1205
2160
|
*/
|
|
1206
|
-
|
|
2161
|
+
factText?: string | null;
|
|
1207
2162
|
}
|
|
1208
2163
|
/**
|
|
1209
2164
|
* Defines guided search spec.
|
|
@@ -1260,6 +2215,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1260
2215
|
* Count of entries that were processed successfully.
|
|
1261
2216
|
*/
|
|
1262
2217
|
successCount?: string | null;
|
|
2218
|
+
/**
|
|
2219
|
+
* Total count of entries that were processed.
|
|
2220
|
+
*/
|
|
2221
|
+
totalCount?: string | null;
|
|
1263
2222
|
/**
|
|
1264
2223
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
1265
2224
|
*/
|
|
@@ -1270,23 +2229,39 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1270
2229
|
*/
|
|
1271
2230
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
|
|
1272
2231
|
/**
|
|
1273
|
-
* 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.
|
|
2232
|
+
* 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.
|
|
1274
2233
|
*/
|
|
1275
2234
|
autoGenerateIds?: boolean | null;
|
|
1276
2235
|
/**
|
|
1277
2236
|
* BigQuery input source.
|
|
1278
2237
|
*/
|
|
1279
2238
|
bigquerySource?: Schema$GoogleCloudDiscoveryengineV1alphaBigQuerySource;
|
|
2239
|
+
/**
|
|
2240
|
+
* Cloud Bigtable input source.
|
|
2241
|
+
*/
|
|
2242
|
+
bigtableSource?: Schema$GoogleCloudDiscoveryengineV1alphaBigtableSource;
|
|
2243
|
+
/**
|
|
2244
|
+
* Cloud SQL input source.
|
|
2245
|
+
*/
|
|
2246
|
+
cloudSqlSource?: Schema$GoogleCloudDiscoveryengineV1alphaCloudSqlSource;
|
|
1280
2247
|
/**
|
|
1281
2248
|
* The desired location of errors incurred during the Import.
|
|
1282
2249
|
*/
|
|
1283
2250
|
errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
2251
|
+
/**
|
|
2252
|
+
* FhirStore input source.
|
|
2253
|
+
*/
|
|
2254
|
+
fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1alphaFhirStoreSource;
|
|
2255
|
+
/**
|
|
2256
|
+
* Firestore input source.
|
|
2257
|
+
*/
|
|
2258
|
+
firestoreSource?: Schema$GoogleCloudDiscoveryengineV1alphaFirestoreSource;
|
|
1284
2259
|
/**
|
|
1285
2260
|
* Cloud Storage location for the input content.
|
|
1286
2261
|
*/
|
|
1287
2262
|
gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1288
2263
|
/**
|
|
1289
|
-
* The field
|
|
2264
|
+
* 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.
|
|
1290
2265
|
*/
|
|
1291
2266
|
idField?: string | null;
|
|
1292
2267
|
/**
|
|
@@ -1297,6 +2272,14 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1297
2272
|
* The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
|
|
1298
2273
|
*/
|
|
1299
2274
|
reconciliationMode?: string | null;
|
|
2275
|
+
/**
|
|
2276
|
+
* Spanner input source.
|
|
2277
|
+
*/
|
|
2278
|
+
spannerSource?: Schema$GoogleCloudDiscoveryengineV1alphaSpannerSource;
|
|
2279
|
+
/**
|
|
2280
|
+
* Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
|
|
2281
|
+
*/
|
|
2282
|
+
updateMask?: string | null;
|
|
1300
2283
|
}
|
|
1301
2284
|
/**
|
|
1302
2285
|
* The inline source for the input config for ImportDocuments method.
|
|
@@ -1475,9 +2458,17 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1475
2458
|
minimum?: number | null;
|
|
1476
2459
|
}
|
|
1477
2460
|
/**
|
|
1478
|
-
*
|
|
2461
|
+
* Response message for ChunkService.ListChunks method.
|
|
1479
2462
|
*/
|
|
1480
|
-
export interface Schema$
|
|
2463
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse {
|
|
2464
|
+
/**
|
|
2465
|
+
* The Chunks.
|
|
2466
|
+
*/
|
|
2467
|
+
chunks?: Schema$GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
2468
|
+
/**
|
|
2469
|
+
* A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
2470
|
+
*/
|
|
2471
|
+
nextPageToken?: string | null;
|
|
1481
2472
|
}
|
|
1482
2473
|
/**
|
|
1483
2474
|
* Response for ListConversations method.
|
|
@@ -1557,6 +2548,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1557
2548
|
*/
|
|
1558
2549
|
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
|
|
1559
2550
|
}
|
|
2551
|
+
/**
|
|
2552
|
+
* Response for ListSessions method.
|
|
2553
|
+
*/
|
|
2554
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse {
|
|
2555
|
+
/**
|
|
2556
|
+
* Pagination token, if not returned indicates the last page.
|
|
2557
|
+
*/
|
|
2558
|
+
nextPageToken?: string | null;
|
|
2559
|
+
/**
|
|
2560
|
+
* All the Sessions for a given data store.
|
|
2561
|
+
*/
|
|
2562
|
+
sessions?: Schema$GoogleCloudDiscoveryengineV1alphaSession[];
|
|
2563
|
+
}
|
|
1560
2564
|
/**
|
|
1561
2565
|
* Response message for SiteSearchEngineService.ListTargetSites method.
|
|
1562
2566
|
*/
|
|
@@ -1605,42 +2609,12 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1605
2609
|
*/
|
|
1606
2610
|
mediaProgressPercentage?: number | null;
|
|
1607
2611
|
}
|
|
1608
|
-
/**
|
|
1609
|
-
* The OCR options for parsing documents.
|
|
1610
|
-
*/
|
|
1611
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
1612
|
-
/**
|
|
1613
|
-
* Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.
|
|
1614
|
-
*/
|
|
1615
|
-
enabled?: boolean | null;
|
|
1616
|
-
/**
|
|
1617
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1618
|
-
*/
|
|
1619
|
-
enhancedDocumentElements?: string[] | null;
|
|
1620
|
-
/**
|
|
1621
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1622
|
-
*/
|
|
1623
|
-
useNativeText?: boolean | null;
|
|
1624
|
-
}
|
|
1625
|
-
/**
|
|
1626
|
-
* The OCR parsing configurations for documents.
|
|
1627
|
-
*/
|
|
1628
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
1629
|
-
/**
|
|
1630
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
1631
|
-
*/
|
|
1632
|
-
enhancedDocumentElements?: string[] | null;
|
|
1633
|
-
/**
|
|
1634
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
1635
|
-
*/
|
|
1636
|
-
useNativeText?: boolean | null;
|
|
1637
|
-
}
|
|
1638
2612
|
/**
|
|
1639
2613
|
* Detailed page information.
|
|
1640
2614
|
*/
|
|
1641
2615
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaPageInfo {
|
|
1642
2616
|
/**
|
|
1643
|
-
* 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,
|
|
2617
|
+
* 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.
|
|
1644
2618
|
*/
|
|
1645
2619
|
pageCategory?: string | null;
|
|
1646
2620
|
/**
|
|
@@ -1695,6 +2669,85 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1695
2669
|
*/
|
|
1696
2670
|
userId?: string | null;
|
|
1697
2671
|
}
|
|
2672
|
+
/**
|
|
2673
|
+
* Document captures all raw metadata information of items to be recommended or searched.
|
|
2674
|
+
*/
|
|
2675
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument {
|
|
2676
|
+
/**
|
|
2677
|
+
* Required. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`.
|
|
2678
|
+
*/
|
|
2679
|
+
document?: string | null;
|
|
2680
|
+
/**
|
|
2681
|
+
* The JSON string representation of the processed document.
|
|
2682
|
+
*/
|
|
2683
|
+
jsonData?: string | null;
|
|
2684
|
+
}
|
|
2685
|
+
/**
|
|
2686
|
+
* Metadata and configurations for a Google Cloud project in the service.
|
|
2687
|
+
*/
|
|
2688
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
|
|
2689
|
+
/**
|
|
2690
|
+
* Output only. The timestamp when this project is created.
|
|
2691
|
+
*/
|
|
2692
|
+
createTime?: string | null;
|
|
2693
|
+
/**
|
|
2694
|
+
* 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.
|
|
2695
|
+
*/
|
|
2696
|
+
name?: string | null;
|
|
2697
|
+
/**
|
|
2698
|
+
* Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
|
|
2699
|
+
*/
|
|
2700
|
+
provisionCompletionTime?: string | null;
|
|
2701
|
+
/**
|
|
2702
|
+
* Output only. A map of terms of services. The key is the `id` of ServiceTerms.
|
|
2703
|
+
*/
|
|
2704
|
+
serviceTermsMap?: {
|
|
2705
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
2706
|
+
} | null;
|
|
2707
|
+
}
|
|
2708
|
+
/**
|
|
2709
|
+
* Metadata about the terms of service.
|
|
2710
|
+
*/
|
|
2711
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
|
|
2712
|
+
/**
|
|
2713
|
+
* The last time when the project agreed to the terms of service.
|
|
2714
|
+
*/
|
|
2715
|
+
acceptTime?: string | null;
|
|
2716
|
+
/**
|
|
2717
|
+
* The last time when the project declined or revoked the agreement to terms of service.
|
|
2718
|
+
*/
|
|
2719
|
+
declineTime?: string | null;
|
|
2720
|
+
/**
|
|
2721
|
+
* 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`.
|
|
2722
|
+
*/
|
|
2723
|
+
id?: string | null;
|
|
2724
|
+
/**
|
|
2725
|
+
* Whether the project has accepted/rejected the service terms or it is still pending.
|
|
2726
|
+
*/
|
|
2727
|
+
state?: string | null;
|
|
2728
|
+
/**
|
|
2729
|
+
* The version string of the terms of service. For acceptable values, see the comments for id above.
|
|
2730
|
+
*/
|
|
2731
|
+
version?: string | null;
|
|
2732
|
+
}
|
|
2733
|
+
/**
|
|
2734
|
+
* Metadata associated with a project provision operation.
|
|
2735
|
+
*/
|
|
2736
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {
|
|
2737
|
+
}
|
|
2738
|
+
/**
|
|
2739
|
+
* Request for ProjectService.ProvisionProject method.
|
|
2740
|
+
*/
|
|
2741
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest {
|
|
2742
|
+
/**
|
|
2743
|
+
* Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).
|
|
2744
|
+
*/
|
|
2745
|
+
acceptDataUseTerms?: boolean | null;
|
|
2746
|
+
/**
|
|
2747
|
+
* Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
|
|
2748
|
+
*/
|
|
2749
|
+
dataUseTermsVersion?: string | null;
|
|
2750
|
+
}
|
|
1698
2751
|
/**
|
|
1699
2752
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
1700
2753
|
*/
|
|
@@ -1837,6 +2890,74 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1837
2890
|
*/
|
|
1838
2891
|
purgeCount?: string | null;
|
|
1839
2892
|
}
|
|
2893
|
+
/**
|
|
2894
|
+
* Defines a user inputed query.
|
|
2895
|
+
*/
|
|
2896
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
|
|
2897
|
+
/**
|
|
2898
|
+
* Unique Id for the query.
|
|
2899
|
+
*/
|
|
2900
|
+
queryId?: string | null;
|
|
2901
|
+
/**
|
|
2902
|
+
* Plain text.
|
|
2903
|
+
*/
|
|
2904
|
+
text?: string | null;
|
|
2905
|
+
}
|
|
2906
|
+
/**
|
|
2907
|
+
* Record message for RankService.Rank method.
|
|
2908
|
+
*/
|
|
2909
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRankingRecord {
|
|
2910
|
+
/**
|
|
2911
|
+
* 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.
|
|
2912
|
+
*/
|
|
2913
|
+
content?: string | null;
|
|
2914
|
+
/**
|
|
2915
|
+
* The unique ID to represent the record.
|
|
2916
|
+
*/
|
|
2917
|
+
id?: string | null;
|
|
2918
|
+
/**
|
|
2919
|
+
* The score of this record based on the given query and selected model.
|
|
2920
|
+
*/
|
|
2921
|
+
score?: number | null;
|
|
2922
|
+
/**
|
|
2923
|
+
* 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.
|
|
2924
|
+
*/
|
|
2925
|
+
title?: string | null;
|
|
2926
|
+
}
|
|
2927
|
+
/**
|
|
2928
|
+
* Request message for RankService.Rank method.
|
|
2929
|
+
*/
|
|
2930
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRankRequest {
|
|
2931
|
+
/**
|
|
2932
|
+
* If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
|
|
2933
|
+
*/
|
|
2934
|
+
ignoreRecordDetailsInResponse?: boolean | null;
|
|
2935
|
+
/**
|
|
2936
|
+
* 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.
|
|
2937
|
+
*/
|
|
2938
|
+
model?: string | null;
|
|
2939
|
+
/**
|
|
2940
|
+
* The query to use.
|
|
2941
|
+
*/
|
|
2942
|
+
query?: string | null;
|
|
2943
|
+
/**
|
|
2944
|
+
* Required. A list of records to rank. At most 200 records to rank.
|
|
2945
|
+
*/
|
|
2946
|
+
records?: Schema$GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
2947
|
+
/**
|
|
2948
|
+
* The number of results to return. If this is unset or no bigger than zero, returns all results.
|
|
2949
|
+
*/
|
|
2950
|
+
topN?: number | null;
|
|
2951
|
+
}
|
|
2952
|
+
/**
|
|
2953
|
+
* Response message for RankService.Rank method.
|
|
2954
|
+
*/
|
|
2955
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRankResponse {
|
|
2956
|
+
/**
|
|
2957
|
+
* A list of records sorted by descending score.
|
|
2958
|
+
*/
|
|
2959
|
+
records?: Schema$GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
2960
|
+
}
|
|
1840
2961
|
/**
|
|
1841
2962
|
* Request message for Recommend method.
|
|
1842
2963
|
*/
|
|
@@ -2029,6 +3150,23 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2029
3150
|
*/
|
|
2030
3151
|
uri?: string | null;
|
|
2031
3152
|
}
|
|
3153
|
+
/**
|
|
3154
|
+
* Request for ReportConsentChange method.
|
|
3155
|
+
*/
|
|
3156
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest {
|
|
3157
|
+
/**
|
|
3158
|
+
* Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.
|
|
3159
|
+
*/
|
|
3160
|
+
consentChangeAction?: string | null;
|
|
3161
|
+
/**
|
|
3162
|
+
* Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.
|
|
3163
|
+
*/
|
|
3164
|
+
serviceTermId?: string | null;
|
|
3165
|
+
/**
|
|
3166
|
+
* Required. The version string of the terms of service to update.
|
|
3167
|
+
*/
|
|
3168
|
+
serviceTermVersion?: string | null;
|
|
3169
|
+
}
|
|
2032
3170
|
/**
|
|
2033
3171
|
* Request for resuming training of an engine.
|
|
2034
3172
|
*/
|
|
@@ -2098,6 +3236,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2098
3236
|
* Custom fine tuning configs.
|
|
2099
3237
|
*/
|
|
2100
3238
|
customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
3239
|
+
/**
|
|
3240
|
+
* A list of data store specs to apply on a search call.
|
|
3241
|
+
*/
|
|
3242
|
+
dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
2101
3243
|
/**
|
|
2102
3244
|
* 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.
|
|
2103
3245
|
*/
|
|
@@ -2123,7 +3265,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2123
3265
|
*/
|
|
2124
3266
|
orderBy?: string | null;
|
|
2125
3267
|
/**
|
|
2126
|
-
* Maximum number of Documents to return.
|
|
3268
|
+
* 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.
|
|
2127
3269
|
*/
|
|
2128
3270
|
pageSize?: number | null;
|
|
2129
3271
|
/**
|
|
@@ -2189,22 +3331,68 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2189
3331
|
*/
|
|
2190
3332
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
2191
3333
|
/**
|
|
2192
|
-
* 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.
|
|
3334
|
+
* 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.
|
|
2193
3335
|
*/
|
|
2194
3336
|
boost?: number | null;
|
|
2195
3337
|
/**
|
|
2196
|
-
*
|
|
3338
|
+
* Complex specification for custom ranking based on customer defined attribute value.
|
|
3339
|
+
*/
|
|
3340
|
+
boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
3341
|
+
/**
|
|
3342
|
+
* 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"))`
|
|
2197
3343
|
*/
|
|
2198
3344
|
condition?: string | null;
|
|
2199
3345
|
}
|
|
3346
|
+
/**
|
|
3347
|
+
* Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
|
|
3348
|
+
*/
|
|
3349
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
|
|
3350
|
+
/**
|
|
3351
|
+
* 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).
|
|
3352
|
+
*/
|
|
3353
|
+
attributeType?: string | null;
|
|
3354
|
+
/**
|
|
3355
|
+
* The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
|
|
3356
|
+
*/
|
|
3357
|
+
controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
3358
|
+
/**
|
|
3359
|
+
* The name of the field whose value will be used to determine the boost amount.
|
|
3360
|
+
*/
|
|
3361
|
+
fieldName?: string | null;
|
|
3362
|
+
/**
|
|
3363
|
+
* The interpolation type to be applied to connect the control points listed below.
|
|
3364
|
+
*/
|
|
3365
|
+
interpolationType?: string | null;
|
|
3366
|
+
}
|
|
3367
|
+
/**
|
|
3368
|
+
* 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).
|
|
3369
|
+
*/
|
|
3370
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
3371
|
+
/**
|
|
3372
|
+
* 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]`.
|
|
3373
|
+
*/
|
|
3374
|
+
attributeValue?: string | null;
|
|
3375
|
+
/**
|
|
3376
|
+
* The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
|
|
3377
|
+
*/
|
|
3378
|
+
boostAmount?: number | null;
|
|
3379
|
+
}
|
|
2200
3380
|
/**
|
|
2201
3381
|
* A specification for configuring the behavior of content search.
|
|
2202
3382
|
*/
|
|
2203
3383
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
3384
|
+
/**
|
|
3385
|
+
* Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
|
|
3386
|
+
*/
|
|
3387
|
+
chunkSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
|
|
2204
3388
|
/**
|
|
2205
3389
|
* If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
|
|
2206
3390
|
*/
|
|
2207
3391
|
extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
3392
|
+
/**
|
|
3393
|
+
* Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.
|
|
3394
|
+
*/
|
|
3395
|
+
searchResultMode?: string | null;
|
|
2208
3396
|
/**
|
|
2209
3397
|
* If `snippetSpec` is not specified, snippets are not included in the search response.
|
|
2210
3398
|
*/
|
|
@@ -2214,6 +3402,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2214
3402
|
*/
|
|
2215
3403
|
summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
2216
3404
|
}
|
|
3405
|
+
/**
|
|
3406
|
+
* Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
|
|
3407
|
+
*/
|
|
3408
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec {
|
|
3409
|
+
/**
|
|
3410
|
+
* The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
|
|
3411
|
+
*/
|
|
3412
|
+
numNextChunks?: number | null;
|
|
3413
|
+
/**
|
|
3414
|
+
* The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
|
|
3415
|
+
*/
|
|
3416
|
+
numPreviousChunks?: number | null;
|
|
3417
|
+
}
|
|
2217
3418
|
/**
|
|
2218
3419
|
* A specification for configuring the extractive content in a search response.
|
|
2219
3420
|
*/
|
|
@@ -2234,6 +3435,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2234
3435
|
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
2235
3436
|
*/
|
|
2236
3437
|
numPreviousSegments?: number | null;
|
|
3438
|
+
/**
|
|
3439
|
+
* 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`.
|
|
3440
|
+
*/
|
|
3441
|
+
returnExtractiveSegmentScore?: boolean | null;
|
|
2237
3442
|
}
|
|
2238
3443
|
/**
|
|
2239
3444
|
* A specification for configuring snippets in a search response.
|
|
@@ -2281,9 +3486,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2281
3486
|
*/
|
|
2282
3487
|
modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
2283
3488
|
/**
|
|
2284
|
-
* 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
|
|
3489
|
+
* 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.
|
|
2285
3490
|
*/
|
|
2286
3491
|
summaryResultCount?: number | null;
|
|
3492
|
+
/**
|
|
3493
|
+
* 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.
|
|
3494
|
+
*/
|
|
3495
|
+
useSemanticChunks?: boolean | null;
|
|
2287
3496
|
}
|
|
2288
3497
|
/**
|
|
2289
3498
|
* Specification of the prompt to use with the model.
|
|
@@ -2299,10 +3508,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2299
3508
|
*/
|
|
2300
3509
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
2301
3510
|
/**
|
|
2302
|
-
* 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
|
|
3511
|
+
* 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).
|
|
2303
3512
|
*/
|
|
2304
3513
|
version?: string | null;
|
|
2305
3514
|
}
|
|
3515
|
+
/**
|
|
3516
|
+
* A struct to define data stores to filter on in a search call.
|
|
3517
|
+
*/
|
|
3518
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
3519
|
+
/**
|
|
3520
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`.
|
|
3521
|
+
*/
|
|
3522
|
+
dataStore?: string | null;
|
|
3523
|
+
}
|
|
2306
3524
|
/**
|
|
2307
3525
|
* The specification that uses customized query embedding vector to do semantic document retrieval.
|
|
2308
3526
|
*/
|
|
@@ -2550,6 +3768,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2550
3768
|
* Represents the search results.
|
|
2551
3769
|
*/
|
|
2552
3770
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult {
|
|
3771
|
+
/**
|
|
3772
|
+
* The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
|
|
3773
|
+
*/
|
|
3774
|
+
chunk?: Schema$GoogleCloudDiscoveryengineV1alphaChunk;
|
|
2553
3775
|
/**
|
|
2554
3776
|
* The document data snippet in the search response. Only fields that are marked as retrievable are populated.
|
|
2555
3777
|
*/
|
|
@@ -2625,6 +3847,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2625
3847
|
* Document reference.
|
|
2626
3848
|
*/
|
|
2627
3849
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference {
|
|
3850
|
+
/**
|
|
3851
|
+
* List of cited chunk contents derived from document content.
|
|
3852
|
+
*/
|
|
3853
|
+
chunkContents?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent[];
|
|
2628
3854
|
/**
|
|
2629
3855
|
* 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`.
|
|
2630
3856
|
*/
|
|
@@ -2638,6 +3864,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2638
3864
|
*/
|
|
2639
3865
|
uri?: string | null;
|
|
2640
3866
|
}
|
|
3867
|
+
/**
|
|
3868
|
+
* Chunk content.
|
|
3869
|
+
*/
|
|
3870
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent {
|
|
3871
|
+
/**
|
|
3872
|
+
* Chunk textual content.
|
|
3873
|
+
*/
|
|
3874
|
+
content?: string | null;
|
|
3875
|
+
/**
|
|
3876
|
+
* Page identifier.
|
|
3877
|
+
*/
|
|
3878
|
+
pageIdentifier?: string | null;
|
|
3879
|
+
}
|
|
2641
3880
|
/**
|
|
2642
3881
|
* Safety Attribute categories and their associated confidence scores.
|
|
2643
3882
|
*/
|
|
@@ -2725,7 +3964,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2725
3964
|
*/
|
|
2726
3965
|
modelId?: string | null;
|
|
2727
3966
|
/**
|
|
2728
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
3967
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
2729
3968
|
*/
|
|
2730
3969
|
name?: string | null;
|
|
2731
3970
|
/**
|
|
@@ -2774,10 +4013,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2774
4013
|
* Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
|
|
2775
4014
|
*/
|
|
2776
4015
|
contentFreshnessCutoffDays?: number | null;
|
|
2777
|
-
/**
|
|
2778
|
-
* Specifies the content watched minutes threshold for demotion.
|
|
2779
|
-
*/
|
|
2780
|
-
contentWatchedMinutesThreshold?: number | null;
|
|
2781
4016
|
/**
|
|
2782
4017
|
* Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
|
|
2783
4018
|
*/
|
|
@@ -2791,6 +4026,48 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2791
4026
|
*/
|
|
2792
4027
|
demotionEventType?: string | null;
|
|
2793
4028
|
}
|
|
4029
|
+
/**
|
|
4030
|
+
* External session proto definition.
|
|
4031
|
+
*/
|
|
4032
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSession {
|
|
4033
|
+
/**
|
|
4034
|
+
* Output only. The time the session finished.
|
|
4035
|
+
*/
|
|
4036
|
+
endTime?: string | null;
|
|
4037
|
+
/**
|
|
4038
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
4039
|
+
*/
|
|
4040
|
+
name?: string | null;
|
|
4041
|
+
/**
|
|
4042
|
+
* Output only. The time the session started.
|
|
4043
|
+
*/
|
|
4044
|
+
startTime?: string | null;
|
|
4045
|
+
/**
|
|
4046
|
+
* The state of the session.
|
|
4047
|
+
*/
|
|
4048
|
+
state?: string | null;
|
|
4049
|
+
/**
|
|
4050
|
+
* Turns.
|
|
4051
|
+
*/
|
|
4052
|
+
turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[];
|
|
4053
|
+
/**
|
|
4054
|
+
* A unique identifier for tracking users.
|
|
4055
|
+
*/
|
|
4056
|
+
userPseudoId?: string | null;
|
|
4057
|
+
}
|
|
4058
|
+
/**
|
|
4059
|
+
* Represents a turn, including a query from the user and a answer from service.
|
|
4060
|
+
*/
|
|
4061
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
4062
|
+
/**
|
|
4063
|
+
* The resource name of the answer to the user query.
|
|
4064
|
+
*/
|
|
4065
|
+
answer?: string | null;
|
|
4066
|
+
/**
|
|
4067
|
+
* The user query.
|
|
4068
|
+
*/
|
|
4069
|
+
query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery;
|
|
4070
|
+
}
|
|
2794
4071
|
/**
|
|
2795
4072
|
* SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
|
|
2796
4073
|
*/
|
|
@@ -2813,6 +4090,31 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2813
4090
|
*/
|
|
2814
4091
|
verifyTime?: string | null;
|
|
2815
4092
|
}
|
|
4093
|
+
/**
|
|
4094
|
+
* The Spanner source for importing data
|
|
4095
|
+
*/
|
|
4096
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSpannerSource {
|
|
4097
|
+
/**
|
|
4098
|
+
* Required. The database ID of the source Spanner table.
|
|
4099
|
+
*/
|
|
4100
|
+
databaseId?: string | null;
|
|
4101
|
+
/**
|
|
4102
|
+
* 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).
|
|
4103
|
+
*/
|
|
4104
|
+
enableDataBoost?: boolean | null;
|
|
4105
|
+
/**
|
|
4106
|
+
* Required. The instance ID of the source Spanner table.
|
|
4107
|
+
*/
|
|
4108
|
+
instanceId?: string | null;
|
|
4109
|
+
/**
|
|
4110
|
+
* 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.
|
|
4111
|
+
*/
|
|
4112
|
+
projectId?: string | null;
|
|
4113
|
+
/**
|
|
4114
|
+
* Required. The table name of the Spanner database that needs to be imported.
|
|
4115
|
+
*/
|
|
4116
|
+
tableId?: string | null;
|
|
4117
|
+
}
|
|
2816
4118
|
/**
|
|
2817
4119
|
* Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
|
|
2818
4120
|
*/
|
|
@@ -2933,11 +4235,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2933
4235
|
*/
|
|
2934
4236
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
2935
4237
|
/**
|
|
2936
|
-
* The Cloud Storage corpus data which could be associated in train data. The data path format is gs
|
|
4238
|
+
* 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"\}`
|
|
2937
4239
|
*/
|
|
2938
4240
|
corpusDataPath?: string | null;
|
|
2939
4241
|
/**
|
|
2940
|
-
* The gcs query data which could be associated in train data. The data path format is gs
|
|
4242
|
+
* 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"\}
|
|
2941
4243
|
*/
|
|
2942
4244
|
queryDataPath?: string | null;
|
|
2943
4245
|
/**
|
|
@@ -2945,7 +4247,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2945
4247
|
*/
|
|
2946
4248
|
testDataPath?: string | null;
|
|
2947
4249
|
/**
|
|
2948
|
-
* Cloud Storage training data path whose format should be gs
|
|
4250
|
+
* 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`
|
|
2949
4251
|
*/
|
|
2950
4252
|
trainDataPath?: string | null;
|
|
2951
4253
|
}
|
|
@@ -2962,7 +4264,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2962
4264
|
*/
|
|
2963
4265
|
errorSamples?: Schema$GoogleRpcStatus[];
|
|
2964
4266
|
/**
|
|
2965
|
-
* The
|
|
4267
|
+
* The metrics of the trained model.
|
|
4268
|
+
*/
|
|
4269
|
+
metrics?: {
|
|
4270
|
+
[key: string]: number;
|
|
4271
|
+
} | null;
|
|
4272
|
+
/**
|
|
4273
|
+
* 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.
|
|
2966
4274
|
*/
|
|
2967
4275
|
modelStatus?: string | null;
|
|
2968
4276
|
}
|
|
@@ -3183,6 +4491,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3183
4491
|
* Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
|
|
3184
4492
|
*/
|
|
3185
4493
|
allowPublicAccess?: boolean | null;
|
|
4494
|
+
/**
|
|
4495
|
+
* Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
|
|
4496
|
+
*/
|
|
4497
|
+
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
|
|
3186
4498
|
/**
|
|
3187
4499
|
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
3188
4500
|
*/
|
|
@@ -3199,6 +4511,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3199
4511
|
* Output only. The type of the parent data store.
|
|
3200
4512
|
*/
|
|
3201
4513
|
dataStoreType?: string | null;
|
|
4514
|
+
/**
|
|
4515
|
+
* Configurable UI configurations per data store.
|
|
4516
|
+
*/
|
|
4517
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[];
|
|
3202
4518
|
/**
|
|
3203
4519
|
* Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3204
4520
|
*/
|
|
@@ -3223,6 +4539,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3223
4539
|
* Whether to enable safe search.
|
|
3224
4540
|
*/
|
|
3225
4541
|
enableSafeSearch?: boolean | null;
|
|
4542
|
+
/**
|
|
4543
|
+
* Whether to enable search-as-you-type behavior for the search widget
|
|
4544
|
+
*/
|
|
4545
|
+
enableSearchAsYouType?: boolean | null;
|
|
3226
4546
|
/**
|
|
3227
4547
|
* Turn on or off summary for each snippets result.
|
|
3228
4548
|
*/
|
|
@@ -3274,6 +4594,67 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3274
4594
|
*/
|
|
3275
4595
|
updateTime?: string | null;
|
|
3276
4596
|
}
|
|
4597
|
+
/**
|
|
4598
|
+
* Read-only collection component that contains data store collections fields that may be used for filtering
|
|
4599
|
+
*/
|
|
4600
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
|
|
4601
|
+
/**
|
|
4602
|
+
* For the data store collection, list of the children data stores.
|
|
4603
|
+
*/
|
|
4604
|
+
dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
|
|
4605
|
+
/**
|
|
4606
|
+
* The display name of the collection.
|
|
4607
|
+
*/
|
|
4608
|
+
displayName?: string | null;
|
|
4609
|
+
/**
|
|
4610
|
+
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
|
|
4611
|
+
*/
|
|
4612
|
+
id?: string | null;
|
|
4613
|
+
/**
|
|
4614
|
+
* The name of the collection. It should be collection resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
4615
|
+
*/
|
|
4616
|
+
name?: string | null;
|
|
4617
|
+
}
|
|
4618
|
+
/**
|
|
4619
|
+
* Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
|
|
4620
|
+
*/
|
|
4621
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
|
|
4622
|
+
/**
|
|
4623
|
+
* The display name of the data store.
|
|
4624
|
+
*/
|
|
4625
|
+
displayName?: string | null;
|
|
4626
|
+
/**
|
|
4627
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
4628
|
+
*/
|
|
4629
|
+
id?: string | null;
|
|
4630
|
+
/**
|
|
4631
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
4632
|
+
*/
|
|
4633
|
+
name?: string | null;
|
|
4634
|
+
}
|
|
4635
|
+
/**
|
|
4636
|
+
* UI component configuration for data store.
|
|
4637
|
+
*/
|
|
4638
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
|
|
4639
|
+
/**
|
|
4640
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
4641
|
+
*/
|
|
4642
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
4643
|
+
/**
|
|
4644
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
4645
|
+
*/
|
|
4646
|
+
fieldsUiComponentsMap?: {
|
|
4647
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
4648
|
+
} | null;
|
|
4649
|
+
/**
|
|
4650
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
4651
|
+
*/
|
|
4652
|
+
id?: string | null;
|
|
4653
|
+
/**
|
|
4654
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project_number\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
4655
|
+
*/
|
|
4656
|
+
name?: string | null;
|
|
4657
|
+
}
|
|
3277
4658
|
/**
|
|
3278
4659
|
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
3279
4660
|
*/
|
|
@@ -3561,11 +4942,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3561
4942
|
*/
|
|
3562
4943
|
updateTime?: string | null;
|
|
3563
4944
|
}
|
|
3564
|
-
/**
|
|
3565
|
-
* The digital parsing configurations for documents.
|
|
3566
|
-
*/
|
|
3567
|
-
export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {
|
|
3568
|
-
}
|
|
3569
4945
|
/**
|
|
3570
4946
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3571
4947
|
*/
|
|
@@ -3610,11 +4986,29 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3610
4986
|
/**
|
|
3611
4987
|
* Configurations applied to digital parser.
|
|
3612
4988
|
*/
|
|
3613
|
-
digitalParsingConfig?: Schema$
|
|
4989
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
3614
4990
|
/**
|
|
3615
4991
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
3616
4992
|
*/
|
|
3617
|
-
ocrParsingConfig?: Schema$
|
|
4993
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
4994
|
+
}
|
|
4995
|
+
/**
|
|
4996
|
+
* The digital parsing configurations for documents.
|
|
4997
|
+
*/
|
|
4998
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
4999
|
+
}
|
|
5000
|
+
/**
|
|
5001
|
+
* The OCR parsing configurations for documents.
|
|
5002
|
+
*/
|
|
5003
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
5004
|
+
/**
|
|
5005
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
5006
|
+
*/
|
|
5007
|
+
enhancedDocumentElements?: string[] | null;
|
|
5008
|
+
/**
|
|
5009
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
5010
|
+
*/
|
|
5011
|
+
useNativeText?: boolean | null;
|
|
3618
5012
|
}
|
|
3619
5013
|
/**
|
|
3620
5014
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -3692,7 +5086,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3692
5086
|
*/
|
|
3693
5087
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
3694
5088
|
/**
|
|
3695
|
-
* 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.
|
|
5089
|
+
* 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.
|
|
3696
5090
|
*/
|
|
3697
5091
|
dialogflowAgentToLink?: string | null;
|
|
3698
5092
|
}
|
|
@@ -3744,7 +5138,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3744
5138
|
*/
|
|
3745
5139
|
searchAddOns?: string[] | null;
|
|
3746
5140
|
/**
|
|
3747
|
-
* The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
5141
|
+
* 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.
|
|
3748
5142
|
*/
|
|
3749
5143
|
searchTier?: string | null;
|
|
3750
5144
|
}
|
|
@@ -3764,6 +5158,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3764
5158
|
* Count of entries that were processed successfully.
|
|
3765
5159
|
*/
|
|
3766
5160
|
successCount?: string | null;
|
|
5161
|
+
/**
|
|
5162
|
+
* Total count of entries that were processed.
|
|
5163
|
+
*/
|
|
5164
|
+
totalCount?: string | null;
|
|
3767
5165
|
/**
|
|
3768
5166
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
3769
5167
|
*/
|
|
@@ -3863,19 +5261,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3863
5261
|
*/
|
|
3864
5262
|
unjoinedEventsCount?: string | null;
|
|
3865
5263
|
}
|
|
3866
|
-
/**
|
|
3867
|
-
* The OCR parsing configurations for documents.
|
|
3868
|
-
*/
|
|
3869
|
-
export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
3870
|
-
/**
|
|
3871
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
3872
|
-
*/
|
|
3873
|
-
enhancedDocumentElements?: string[] | null;
|
|
3874
|
-
/**
|
|
3875
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
3876
|
-
*/
|
|
3877
|
-
useNativeText?: boolean | null;
|
|
3878
|
-
}
|
|
3879
5264
|
/**
|
|
3880
5265
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
3881
5266
|
*/
|
|
@@ -4031,6 +5416,56 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4031
5416
|
*/
|
|
4032
5417
|
totalRequiredQuota?: string | null;
|
|
4033
5418
|
}
|
|
5419
|
+
/**
|
|
5420
|
+
* Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
5421
|
+
*/
|
|
5422
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
5423
|
+
/**
|
|
5424
|
+
* Operation create time.
|
|
5425
|
+
*/
|
|
5426
|
+
createTime?: string | null;
|
|
5427
|
+
/**
|
|
5428
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
5429
|
+
*/
|
|
5430
|
+
updateTime?: string | null;
|
|
5431
|
+
}
|
|
5432
|
+
/**
|
|
5433
|
+
* Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.
|
|
5434
|
+
*/
|
|
5435
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
5436
|
+
/**
|
|
5437
|
+
* Echoes the destination for the complete errors in the request if set.
|
|
5438
|
+
*/
|
|
5439
|
+
errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
5440
|
+
/**
|
|
5441
|
+
* A sample of errors encountered while processing the data.
|
|
5442
|
+
*/
|
|
5443
|
+
errorSamples?: Schema$GoogleRpcStatus[];
|
|
5444
|
+
/**
|
|
5445
|
+
* The metrics of the trained model.
|
|
5446
|
+
*/
|
|
5447
|
+
metrics?: {
|
|
5448
|
+
[key: string]: number;
|
|
5449
|
+
} | null;
|
|
5450
|
+
/**
|
|
5451
|
+
* 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.
|
|
5452
|
+
*/
|
|
5453
|
+
modelStatus?: string | null;
|
|
5454
|
+
}
|
|
5455
|
+
/**
|
|
5456
|
+
* Metadata associated with a tune operation.
|
|
5457
|
+
*/
|
|
5458
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
5459
|
+
/**
|
|
5460
|
+
* 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\}`
|
|
5461
|
+
*/
|
|
5462
|
+
engine?: string | null;
|
|
5463
|
+
}
|
|
5464
|
+
/**
|
|
5465
|
+
* Response associated with a tune operation.
|
|
5466
|
+
*/
|
|
5467
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {
|
|
5468
|
+
}
|
|
4034
5469
|
/**
|
|
4035
5470
|
* Metadata for UpdateSchema LRO.
|
|
4036
5471
|
*/
|
|
@@ -4202,11 +5637,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4202
5637
|
*/
|
|
4203
5638
|
updateTime?: string | null;
|
|
4204
5639
|
}
|
|
4205
|
-
/**
|
|
4206
|
-
* The digital parsing configurations for documents.
|
|
4207
|
-
*/
|
|
4208
|
-
export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {
|
|
4209
|
-
}
|
|
4210
5640
|
/**
|
|
4211
5641
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4212
5642
|
*/
|
|
@@ -4251,11 +5681,29 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4251
5681
|
/**
|
|
4252
5682
|
* Configurations applied to digital parser.
|
|
4253
5683
|
*/
|
|
4254
|
-
digitalParsingConfig?: Schema$
|
|
5684
|
+
digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig;
|
|
4255
5685
|
/**
|
|
4256
5686
|
* Configurations applied to OCR parser. Currently it only applies to PDFs.
|
|
4257
5687
|
*/
|
|
4258
|
-
ocrParsingConfig?: Schema$
|
|
5688
|
+
ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
5689
|
+
}
|
|
5690
|
+
/**
|
|
5691
|
+
* The digital parsing configurations for documents.
|
|
5692
|
+
*/
|
|
5693
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {
|
|
5694
|
+
}
|
|
5695
|
+
/**
|
|
5696
|
+
* The OCR parsing configurations for documents.
|
|
5697
|
+
*/
|
|
5698
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
5699
|
+
/**
|
|
5700
|
+
* [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
|
|
5701
|
+
*/
|
|
5702
|
+
enhancedDocumentElements?: string[] | null;
|
|
5703
|
+
/**
|
|
5704
|
+
* If true, will use native text instead of OCR text on pages containing native text.
|
|
5705
|
+
*/
|
|
5706
|
+
useNativeText?: boolean | null;
|
|
4259
5707
|
}
|
|
4260
5708
|
/**
|
|
4261
5709
|
* Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
@@ -4333,7 +5781,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4333
5781
|
*/
|
|
4334
5782
|
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
4335
5783
|
/**
|
|
4336
|
-
* 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.
|
|
5784
|
+
* 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.
|
|
4337
5785
|
*/
|
|
4338
5786
|
dialogflowAgentToLink?: string | null;
|
|
4339
5787
|
}
|
|
@@ -4385,7 +5833,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4385
5833
|
*/
|
|
4386
5834
|
searchAddOns?: string[] | null;
|
|
4387
5835
|
/**
|
|
4388
|
-
* The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
5836
|
+
* 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.
|
|
4389
5837
|
*/
|
|
4390
5838
|
searchTier?: string | null;
|
|
4391
5839
|
}
|
|
@@ -4405,6 +5853,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4405
5853
|
* Count of entries that were processed successfully.
|
|
4406
5854
|
*/
|
|
4407
5855
|
successCount?: string | null;
|
|
5856
|
+
/**
|
|
5857
|
+
* Total count of entries that were processed.
|
|
5858
|
+
*/
|
|
5859
|
+
totalCount?: string | null;
|
|
4408
5860
|
/**
|
|
4409
5861
|
* Operation last update time. If the operation is done, this is also the finish time.
|
|
4410
5862
|
*/
|
|
@@ -4504,19 +5956,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4504
5956
|
*/
|
|
4505
5957
|
unjoinedEventsCount?: string | null;
|
|
4506
5958
|
}
|
|
4507
|
-
/**
|
|
4508
|
-
* The OCR parsing configurations for documents.
|
|
4509
|
-
*/
|
|
4510
|
-
export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
4511
|
-
/**
|
|
4512
|
-
* Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
|
|
4513
|
-
*/
|
|
4514
|
-
enhancedDocumentElements?: string[] | null;
|
|
4515
|
-
/**
|
|
4516
|
-
* If true, will use native text instead of OCR text on pages containing native text.
|
|
4517
|
-
*/
|
|
4518
|
-
useNativeText?: boolean | null;
|
|
4519
|
-
}
|
|
4520
5959
|
/**
|
|
4521
5960
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4522
5961
|
*/
|
|
@@ -4886,12 +6325,85 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4886
6325
|
locations: Resource$Projects$Locations;
|
|
4887
6326
|
operations: Resource$Projects$Operations;
|
|
4888
6327
|
constructor(context: APIRequestContext);
|
|
6328
|
+
/**
|
|
6329
|
+
* Gets a Project. Returns NOT_FOUND when the project is not yet created.
|
|
6330
|
+
*
|
|
6331
|
+
* @param params - Parameters for request
|
|
6332
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6333
|
+
* @param callback - Optional callback that handles the response.
|
|
6334
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6335
|
+
*/
|
|
6336
|
+
get(params: Params$Resource$Projects$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6337
|
+
get(params?: Params$Resource$Projects$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProject>;
|
|
6338
|
+
get(params: Params$Resource$Projects$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6339
|
+
get(params: Params$Resource$Projects$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
|
|
6340
|
+
get(params: Params$Resource$Projects$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
|
|
6341
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
|
|
6342
|
+
/**
|
|
6343
|
+
* Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
|
|
6344
|
+
*
|
|
6345
|
+
* @param params - Parameters for request
|
|
6346
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6347
|
+
* @param callback - Optional callback that handles the response.
|
|
6348
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6349
|
+
*/
|
|
6350
|
+
provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6351
|
+
provision(params?: Params$Resource$Projects$Provision, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
6352
|
+
provision(params: Params$Resource$Projects$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6353
|
+
provision(params: Params$Resource$Projects$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6354
|
+
provision(params: Params$Resource$Projects$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6355
|
+
provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
6356
|
+
/**
|
|
6357
|
+
* Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
|
|
6358
|
+
*
|
|
6359
|
+
* @param params - Parameters for request
|
|
6360
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6361
|
+
* @param callback - Optional callback that handles the response.
|
|
6362
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6363
|
+
*/
|
|
6364
|
+
reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6365
|
+
reportConsentChange(params?: Params$Resource$Projects$Reportconsentchange, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProject>;
|
|
6366
|
+
reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6367
|
+
reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
|
|
6368
|
+
reportConsentChange(params: Params$Resource$Projects$Reportconsentchange, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
|
|
6369
|
+
reportConsentChange(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProject>): void;
|
|
6370
|
+
}
|
|
6371
|
+
export interface Params$Resource$Projects$Get extends StandardParameters {
|
|
6372
|
+
/**
|
|
6373
|
+
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
6374
|
+
*/
|
|
6375
|
+
name?: string;
|
|
6376
|
+
}
|
|
6377
|
+
export interface Params$Resource$Projects$Provision extends StandardParameters {
|
|
6378
|
+
/**
|
|
6379
|
+
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
6380
|
+
*/
|
|
6381
|
+
name?: string;
|
|
6382
|
+
/**
|
|
6383
|
+
* Request body metadata
|
|
6384
|
+
*/
|
|
6385
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
|
|
6386
|
+
}
|
|
6387
|
+
export interface Params$Resource$Projects$Reportconsentchange extends StandardParameters {
|
|
6388
|
+
/**
|
|
6389
|
+
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
6390
|
+
*/
|
|
6391
|
+
project?: string;
|
|
6392
|
+
/**
|
|
6393
|
+
* Request body metadata
|
|
6394
|
+
*/
|
|
6395
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest;
|
|
4889
6396
|
}
|
|
4890
6397
|
export class Resource$Projects$Locations {
|
|
4891
6398
|
context: APIRequestContext;
|
|
4892
6399
|
collections: Resource$Projects$Locations$Collections;
|
|
4893
6400
|
dataStores: Resource$Projects$Locations$Datastores;
|
|
6401
|
+
evaluations: Resource$Projects$Locations$Evaluations;
|
|
6402
|
+
groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
|
|
4894
6403
|
operations: Resource$Projects$Locations$Operations;
|
|
6404
|
+
rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
|
|
6405
|
+
sampleQuerySets: Resource$Projects$Locations$Samplequerysets;
|
|
6406
|
+
userEvents: Resource$Projects$Locations$Userevents;
|
|
4895
6407
|
constructor(context: APIRequestContext);
|
|
4896
6408
|
/**
|
|
4897
6409
|
* Estimates the data size to be used by a customer.
|
|
@@ -5039,6 +6551,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5039
6551
|
operations: Resource$Projects$Locations$Collections$Datastores$Operations;
|
|
5040
6552
|
schemas: Resource$Projects$Locations$Collections$Datastores$Schemas;
|
|
5041
6553
|
servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs;
|
|
6554
|
+
sessions: Resource$Projects$Locations$Collections$Datastores$Sessions;
|
|
5042
6555
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
5043
6556
|
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
5044
6557
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
@@ -5312,6 +6825,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5312
6825
|
}
|
|
5313
6826
|
export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents {
|
|
5314
6827
|
context: APIRequestContext;
|
|
6828
|
+
chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks;
|
|
5315
6829
|
constructor(context: APIRequestContext);
|
|
5316
6830
|
/**
|
|
5317
6831
|
* Creates a Document.
|
|
@@ -5355,6 +6869,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5355
6869
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
5356
6870
|
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
5357
6871
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
6872
|
+
/**
|
|
6873
|
+
* Gets the parsed layout information for a Document.
|
|
6874
|
+
*
|
|
6875
|
+
* @param params - Parameters for request
|
|
6876
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6877
|
+
* @param callback - Optional callback that handles the response.
|
|
6878
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6879
|
+
*/
|
|
6880
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
6881
|
+
getProcessedDocument(params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
6882
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6883
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
6884
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
6885
|
+
getProcessedDocument(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
5358
6886
|
/**
|
|
5359
6887
|
* Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
|
|
5360
6888
|
*
|
|
@@ -5438,6 +6966,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5438
6966
|
*/
|
|
5439
6967
|
name?: string;
|
|
5440
6968
|
}
|
|
6969
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument extends StandardParameters {
|
|
6970
|
+
/**
|
|
6971
|
+
* Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
|
|
6972
|
+
*/
|
|
6973
|
+
name?: string;
|
|
6974
|
+
/**
|
|
6975
|
+
* What format output should be. If unspecified, defaults to JSON.
|
|
6976
|
+
*/
|
|
6977
|
+
processedDocumentFormat?: string;
|
|
6978
|
+
/**
|
|
6979
|
+
* Required. What type of processing to return.
|
|
6980
|
+
*/
|
|
6981
|
+
processedDocumentType?: string;
|
|
6982
|
+
}
|
|
5441
6983
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import extends StandardParameters {
|
|
5442
6984
|
/**
|
|
5443
6985
|
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission.
|
|
@@ -5456,39 +6998,91 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5456
6998
|
/**
|
|
5457
6999
|
* A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
5458
7000
|
*/
|
|
5459
|
-
pageToken?: string;
|
|
7001
|
+
pageToken?: string;
|
|
7002
|
+
/**
|
|
7003
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.
|
|
7004
|
+
*/
|
|
7005
|
+
parent?: string;
|
|
7006
|
+
}
|
|
7007
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch extends StandardParameters {
|
|
7008
|
+
/**
|
|
7009
|
+
* If set to true, and the Document is not found, a new Document will be created.
|
|
7010
|
+
*/
|
|
7011
|
+
allowMissing?: boolean;
|
|
7012
|
+
/**
|
|
7013
|
+
* 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.
|
|
7014
|
+
*/
|
|
7015
|
+
name?: string;
|
|
7016
|
+
/**
|
|
7017
|
+
* Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
|
|
7018
|
+
*/
|
|
7019
|
+
updateMask?: string;
|
|
7020
|
+
/**
|
|
7021
|
+
* Request body metadata
|
|
7022
|
+
*/
|
|
7023
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument;
|
|
7024
|
+
}
|
|
7025
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge extends StandardParameters {
|
|
7026
|
+
/**
|
|
7027
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`.
|
|
7028
|
+
*/
|
|
7029
|
+
parent?: string;
|
|
7030
|
+
/**
|
|
7031
|
+
* Request body metadata
|
|
7032
|
+
*/
|
|
7033
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
7034
|
+
}
|
|
7035
|
+
export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks {
|
|
7036
|
+
context: APIRequestContext;
|
|
7037
|
+
constructor(context: APIRequestContext);
|
|
7038
|
+
/**
|
|
7039
|
+
* Gets a Document.
|
|
7040
|
+
*
|
|
7041
|
+
* @param params - Parameters for request
|
|
7042
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7043
|
+
* @param callback - Optional callback that handles the response.
|
|
7044
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7045
|
+
*/
|
|
7046
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7047
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
7048
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7049
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
7050
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
7051
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
5460
7052
|
/**
|
|
5461
|
-
*
|
|
7053
|
+
* Gets a list of Chunks.
|
|
7054
|
+
*
|
|
7055
|
+
* @param params - Parameters for request
|
|
7056
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7057
|
+
* @param callback - Optional callback that handles the response.
|
|
7058
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5462
7059
|
*/
|
|
5463
|
-
|
|
7060
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7061
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
7062
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7063
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
7064
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
7065
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
5464
7066
|
}
|
|
5465
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$
|
|
5466
|
-
/**
|
|
5467
|
-
* If set to true, and the Document is not found, a new Document will be created.
|
|
5468
|
-
*/
|
|
5469
|
-
allowMissing?: boolean;
|
|
7067
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get extends StandardParameters {
|
|
5470
7068
|
/**
|
|
5471
|
-
*
|
|
7069
|
+
* Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.
|
|
5472
7070
|
*/
|
|
5473
7071
|
name?: string;
|
|
7072
|
+
}
|
|
7073
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List extends StandardParameters {
|
|
5474
7074
|
/**
|
|
5475
|
-
*
|
|
7075
|
+
* Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
5476
7076
|
*/
|
|
5477
|
-
|
|
7077
|
+
pageSize?: number;
|
|
5478
7078
|
/**
|
|
5479
|
-
*
|
|
7079
|
+
* A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
5480
7080
|
*/
|
|
5481
|
-
|
|
5482
|
-
}
|
|
5483
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge extends StandardParameters {
|
|
7081
|
+
pageToken?: string;
|
|
5484
7082
|
/**
|
|
5485
|
-
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`.
|
|
7083
|
+
* Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.
|
|
5486
7084
|
*/
|
|
5487
7085
|
parent?: string;
|
|
5488
|
-
/**
|
|
5489
|
-
* Request body metadata
|
|
5490
|
-
*/
|
|
5491
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
5492
7086
|
}
|
|
5493
7087
|
export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations {
|
|
5494
7088
|
context: APIRequestContext;
|
|
@@ -5690,7 +7284,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5690
7284
|
}
|
|
5691
7285
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters {
|
|
5692
7286
|
/**
|
|
5693
|
-
* Immutable. Fully qualified name `project/
|
|
7287
|
+
* 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`.
|
|
5694
7288
|
*/
|
|
5695
7289
|
name?: string;
|
|
5696
7290
|
/**
|
|
@@ -6007,6 +7601,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6007
7601
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
6008
7602
|
context: APIRequestContext;
|
|
6009
7603
|
constructor(context: APIRequestContext);
|
|
7604
|
+
/**
|
|
7605
|
+
* Answer query method.
|
|
7606
|
+
*
|
|
7607
|
+
* @param params - Parameters for request
|
|
7608
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7609
|
+
* @param callback - Optional callback that handles the response.
|
|
7610
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7611
|
+
*/
|
|
7612
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7613
|
+
answer(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
7614
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7615
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
7616
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
7617
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
6010
7618
|
/**
|
|
6011
7619
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
6012
7620
|
*
|
|
@@ -6078,9 +7686,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6078
7686
|
search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
6079
7687
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
6080
7688
|
}
|
|
7689
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer extends StandardParameters {
|
|
7690
|
+
/**
|
|
7691
|
+
* 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.
|
|
7692
|
+
*/
|
|
7693
|
+
servingConfig?: string;
|
|
7694
|
+
/**
|
|
7695
|
+
* Request body metadata
|
|
7696
|
+
*/
|
|
7697
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
7698
|
+
}
|
|
6081
7699
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
6082
7700
|
/**
|
|
6083
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
7701
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
6084
7702
|
*/
|
|
6085
7703
|
name?: string;
|
|
6086
7704
|
}
|
|
@@ -6094,13 +7712,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6094
7712
|
*/
|
|
6095
7713
|
pageToken?: string;
|
|
6096
7714
|
/**
|
|
6097
|
-
* Required.
|
|
7715
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
6098
7716
|
*/
|
|
6099
7717
|
parent?: string;
|
|
6100
7718
|
}
|
|
6101
7719
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
6102
7720
|
/**
|
|
6103
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
7721
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
6104
7722
|
*/
|
|
6105
7723
|
name?: string;
|
|
6106
7724
|
/**
|
|
@@ -6132,6 +7750,163 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6132
7750
|
*/
|
|
6133
7751
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
6134
7752
|
}
|
|
7753
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sessions {
|
|
7754
|
+
context: APIRequestContext;
|
|
7755
|
+
answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers;
|
|
7756
|
+
constructor(context: APIRequestContext);
|
|
7757
|
+
/**
|
|
7758
|
+
* Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
|
|
7759
|
+
*
|
|
7760
|
+
* @param params - Parameters for request
|
|
7761
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7762
|
+
* @param callback - Optional callback that handles the response.
|
|
7763
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7764
|
+
*/
|
|
7765
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7766
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
7767
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7768
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7769
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7770
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7771
|
+
/**
|
|
7772
|
+
* Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
|
|
7773
|
+
*
|
|
7774
|
+
* @param params - Parameters for request
|
|
7775
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7776
|
+
* @param callback - Optional callback that handles the response.
|
|
7777
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7778
|
+
*/
|
|
7779
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7780
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
|
|
7781
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7782
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
7783
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
7784
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
7785
|
+
/**
|
|
7786
|
+
* Gets a Session.
|
|
7787
|
+
*
|
|
7788
|
+
* @param params - Parameters for request
|
|
7789
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7790
|
+
* @param callback - Optional callback that handles the response.
|
|
7791
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7792
|
+
*/
|
|
7793
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7794
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
7795
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7796
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7797
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7798
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7799
|
+
/**
|
|
7800
|
+
* Lists all Sessions by their parent DataStore.
|
|
7801
|
+
*
|
|
7802
|
+
* @param params - Parameters for request
|
|
7803
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7804
|
+
* @param callback - Optional callback that handles the response.
|
|
7805
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7806
|
+
*/
|
|
7807
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7808
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
|
|
7809
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7810
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
7811
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
7812
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
7813
|
+
/**
|
|
7814
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
7815
|
+
*
|
|
7816
|
+
* @param params - Parameters for request
|
|
7817
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7818
|
+
* @param callback - Optional callback that handles the response.
|
|
7819
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7820
|
+
*/
|
|
7821
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7822
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
7823
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7824
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7825
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7826
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
7827
|
+
}
|
|
7828
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters {
|
|
7829
|
+
/**
|
|
7830
|
+
* Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
7831
|
+
*/
|
|
7832
|
+
parent?: string;
|
|
7833
|
+
/**
|
|
7834
|
+
* Request body metadata
|
|
7835
|
+
*/
|
|
7836
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
7837
|
+
}
|
|
7838
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete extends StandardParameters {
|
|
7839
|
+
/**
|
|
7840
|
+
* 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\}`
|
|
7841
|
+
*/
|
|
7842
|
+
name?: string;
|
|
7843
|
+
}
|
|
7844
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters {
|
|
7845
|
+
/**
|
|
7846
|
+
* 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\}`
|
|
7847
|
+
*/
|
|
7848
|
+
name?: string;
|
|
7849
|
+
}
|
|
7850
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List extends StandardParameters {
|
|
7851
|
+
/**
|
|
7852
|
+
* A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
|
7853
|
+
*/
|
|
7854
|
+
filter?: string;
|
|
7855
|
+
/**
|
|
7856
|
+
* 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"
|
|
7857
|
+
*/
|
|
7858
|
+
orderBy?: string;
|
|
7859
|
+
/**
|
|
7860
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
7861
|
+
*/
|
|
7862
|
+
pageSize?: number;
|
|
7863
|
+
/**
|
|
7864
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
7865
|
+
*/
|
|
7866
|
+
pageToken?: string;
|
|
7867
|
+
/**
|
|
7868
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
7869
|
+
*/
|
|
7870
|
+
parent?: string;
|
|
7871
|
+
}
|
|
7872
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch extends StandardParameters {
|
|
7873
|
+
/**
|
|
7874
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
7875
|
+
*/
|
|
7876
|
+
name?: string;
|
|
7877
|
+
/**
|
|
7878
|
+
* 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.
|
|
7879
|
+
*/
|
|
7880
|
+
updateMask?: string;
|
|
7881
|
+
/**
|
|
7882
|
+
* Request body metadata
|
|
7883
|
+
*/
|
|
7884
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
7885
|
+
}
|
|
7886
|
+
export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers {
|
|
7887
|
+
context: APIRequestContext;
|
|
7888
|
+
constructor(context: APIRequestContext);
|
|
7889
|
+
/**
|
|
7890
|
+
* Gets a Answer.
|
|
7891
|
+
*
|
|
7892
|
+
* @param params - Parameters for request
|
|
7893
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7894
|
+
* @param callback - Optional callback that handles the response.
|
|
7895
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7896
|
+
*/
|
|
7897
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
7898
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>;
|
|
7899
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7900
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
7901
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
7902
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
7903
|
+
}
|
|
7904
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters {
|
|
7905
|
+
/**
|
|
7906
|
+
* 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\}`
|
|
7907
|
+
*/
|
|
7908
|
+
name?: string;
|
|
7909
|
+
}
|
|
6135
7910
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
|
|
6136
7911
|
context: APIRequestContext;
|
|
6137
7912
|
operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
|
|
@@ -6671,7 +8446,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6671
8446
|
}
|
|
6672
8447
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters {
|
|
6673
8448
|
/**
|
|
6674
|
-
* Required. The parent
|
|
8449
|
+
* 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\}`.
|
|
6675
8450
|
*/
|
|
6676
8451
|
parent?: string;
|
|
6677
8452
|
/**
|
|
@@ -6684,6 +8459,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6684
8459
|
conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
|
|
6685
8460
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
6686
8461
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
8462
|
+
sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
|
|
6687
8463
|
constructor(context: APIRequestContext);
|
|
6688
8464
|
/**
|
|
6689
8465
|
* Creates a Engine.
|
|
@@ -7030,7 +8806,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7030
8806
|
}
|
|
7031
8807
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch extends StandardParameters {
|
|
7032
8808
|
/**
|
|
7033
|
-
* Immutable. Fully qualified name `project/
|
|
8809
|
+
* 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`.
|
|
7034
8810
|
*/
|
|
7035
8811
|
name?: string;
|
|
7036
8812
|
/**
|
|
@@ -7101,6 +8877,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7101
8877
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
7102
8878
|
context: APIRequestContext;
|
|
7103
8879
|
constructor(context: APIRequestContext);
|
|
8880
|
+
/**
|
|
8881
|
+
* Answer query method.
|
|
8882
|
+
*
|
|
8883
|
+
* @param params - Parameters for request
|
|
8884
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
8885
|
+
* @param callback - Optional callback that handles the response.
|
|
8886
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
8887
|
+
*/
|
|
8888
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
8889
|
+
answer(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
8890
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
8891
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
8892
|
+
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
8893
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
7104
8894
|
/**
|
|
7105
8895
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
7106
8896
|
*
|
|
@@ -7172,9 +8962,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7172
8962
|
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
7173
8963
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
7174
8964
|
}
|
|
8965
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer extends StandardParameters {
|
|
8966
|
+
/**
|
|
8967
|
+
* 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.
|
|
8968
|
+
*/
|
|
8969
|
+
servingConfig?: string;
|
|
8970
|
+
/**
|
|
8971
|
+
* Request body metadata
|
|
8972
|
+
*/
|
|
8973
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
8974
|
+
}
|
|
7175
8975
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
7176
8976
|
/**
|
|
7177
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
8977
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
7178
8978
|
*/
|
|
7179
8979
|
name?: string;
|
|
7180
8980
|
}
|
|
@@ -7188,13 +8988,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7188
8988
|
*/
|
|
7189
8989
|
pageToken?: string;
|
|
7190
8990
|
/**
|
|
7191
|
-
* Required.
|
|
8991
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
7192
8992
|
*/
|
|
7193
8993
|
parent?: string;
|
|
7194
8994
|
}
|
|
7195
8995
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
7196
8996
|
/**
|
|
7197
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
8997
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
7198
8998
|
*/
|
|
7199
8999
|
name?: string;
|
|
7200
9000
|
/**
|
|
@@ -7222,9 +9022,166 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7222
9022
|
*/
|
|
7223
9023
|
servingConfig?: string;
|
|
7224
9024
|
/**
|
|
7225
|
-
* Request body metadata
|
|
9025
|
+
* Request body metadata
|
|
9026
|
+
*/
|
|
9027
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
9028
|
+
}
|
|
9029
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions {
|
|
9030
|
+
context: APIRequestContext;
|
|
9031
|
+
answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers;
|
|
9032
|
+
constructor(context: APIRequestContext);
|
|
9033
|
+
/**
|
|
9034
|
+
* Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
|
|
9035
|
+
*
|
|
9036
|
+
* @param params - Parameters for request
|
|
9037
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9038
|
+
* @param callback - Optional callback that handles the response.
|
|
9039
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9040
|
+
*/
|
|
9041
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9042
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9043
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9044
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9045
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9046
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9047
|
+
/**
|
|
9048
|
+
* Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
|
|
9049
|
+
*
|
|
9050
|
+
* @param params - Parameters for request
|
|
9051
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9052
|
+
* @param callback - Optional callback that handles the response.
|
|
9053
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9054
|
+
*/
|
|
9055
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9056
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
|
|
9057
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9058
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
9059
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
9060
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
9061
|
+
/**
|
|
9062
|
+
* Gets a Session.
|
|
9063
|
+
*
|
|
9064
|
+
* @param params - Parameters for request
|
|
9065
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9066
|
+
* @param callback - Optional callback that handles the response.
|
|
9067
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9068
|
+
*/
|
|
9069
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9070
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9071
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9072
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9073
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9074
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9075
|
+
/**
|
|
9076
|
+
* Lists all Sessions by their parent DataStore.
|
|
9077
|
+
*
|
|
9078
|
+
* @param params - Parameters for request
|
|
9079
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9080
|
+
* @param callback - Optional callback that handles the response.
|
|
9081
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9082
|
+
*/
|
|
9083
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9084
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
|
|
9085
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9086
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
9087
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
9088
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
9089
|
+
/**
|
|
9090
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
9091
|
+
*
|
|
9092
|
+
* @param params - Parameters for request
|
|
9093
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9094
|
+
* @param callback - Optional callback that handles the response.
|
|
9095
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9096
|
+
*/
|
|
9097
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9098
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9099
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9100
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9101
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9102
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
9103
|
+
}
|
|
9104
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters {
|
|
9105
|
+
/**
|
|
9106
|
+
* Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
9107
|
+
*/
|
|
9108
|
+
parent?: string;
|
|
9109
|
+
/**
|
|
9110
|
+
* Request body metadata
|
|
9111
|
+
*/
|
|
9112
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
9113
|
+
}
|
|
9114
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters {
|
|
9115
|
+
/**
|
|
9116
|
+
* 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\}`
|
|
9117
|
+
*/
|
|
9118
|
+
name?: string;
|
|
9119
|
+
}
|
|
9120
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters {
|
|
9121
|
+
/**
|
|
9122
|
+
* 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\}`
|
|
9123
|
+
*/
|
|
9124
|
+
name?: string;
|
|
9125
|
+
}
|
|
9126
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters {
|
|
9127
|
+
/**
|
|
9128
|
+
* A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
|
9129
|
+
*/
|
|
9130
|
+
filter?: string;
|
|
9131
|
+
/**
|
|
9132
|
+
* 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"
|
|
9133
|
+
*/
|
|
9134
|
+
orderBy?: string;
|
|
9135
|
+
/**
|
|
9136
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
9137
|
+
*/
|
|
9138
|
+
pageSize?: number;
|
|
9139
|
+
/**
|
|
9140
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
9141
|
+
*/
|
|
9142
|
+
pageToken?: string;
|
|
9143
|
+
/**
|
|
9144
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
9145
|
+
*/
|
|
9146
|
+
parent?: string;
|
|
9147
|
+
}
|
|
9148
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters {
|
|
9149
|
+
/**
|
|
9150
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
9151
|
+
*/
|
|
9152
|
+
name?: string;
|
|
9153
|
+
/**
|
|
9154
|
+
* 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.
|
|
9155
|
+
*/
|
|
9156
|
+
updateMask?: string;
|
|
9157
|
+
/**
|
|
9158
|
+
* Request body metadata
|
|
9159
|
+
*/
|
|
9160
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
9161
|
+
}
|
|
9162
|
+
export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers {
|
|
9163
|
+
context: APIRequestContext;
|
|
9164
|
+
constructor(context: APIRequestContext);
|
|
9165
|
+
/**
|
|
9166
|
+
* Gets a Answer.
|
|
9167
|
+
*
|
|
9168
|
+
* @param params - Parameters for request
|
|
9169
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9170
|
+
* @param callback - Optional callback that handles the response.
|
|
9171
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9172
|
+
*/
|
|
9173
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9174
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>;
|
|
9175
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9176
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
9177
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
9178
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
9179
|
+
}
|
|
9180
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters {
|
|
9181
|
+
/**
|
|
9182
|
+
* 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\}`
|
|
7226
9183
|
*/
|
|
7227
|
-
|
|
9184
|
+
name?: string;
|
|
7228
9185
|
}
|
|
7229
9186
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
7230
9187
|
context: APIRequestContext;
|
|
@@ -7290,6 +9247,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7290
9247
|
operations: Resource$Projects$Locations$Datastores$Operations;
|
|
7291
9248
|
schemas: Resource$Projects$Locations$Datastores$Schemas;
|
|
7292
9249
|
servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs;
|
|
9250
|
+
sessions: Resource$Projects$Locations$Datastores$Sessions;
|
|
7293
9251
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
7294
9252
|
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
7295
9253
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
@@ -7539,6 +9497,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7539
9497
|
}
|
|
7540
9498
|
export class Resource$Projects$Locations$Datastores$Branches$Documents {
|
|
7541
9499
|
context: APIRequestContext;
|
|
9500
|
+
chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks;
|
|
7542
9501
|
constructor(context: APIRequestContext);
|
|
7543
9502
|
/**
|
|
7544
9503
|
* Creates a Document.
|
|
@@ -7582,6 +9541,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7582
9541
|
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
7583
9542
|
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
7584
9543
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocument>): void;
|
|
9544
|
+
/**
|
|
9545
|
+
* Gets the parsed layout information for a Document.
|
|
9546
|
+
*
|
|
9547
|
+
* @param params - Parameters for request
|
|
9548
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9549
|
+
* @param callback - Optional callback that handles the response.
|
|
9550
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9551
|
+
*/
|
|
9552
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9553
|
+
getProcessedDocument(params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>;
|
|
9554
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9555
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
9556
|
+
getProcessedDocument(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
9557
|
+
getProcessedDocument(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument>): void;
|
|
7585
9558
|
/**
|
|
7586
9559
|
* Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
|
|
7587
9560
|
*
|
|
@@ -7665,6 +9638,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7665
9638
|
*/
|
|
7666
9639
|
name?: string;
|
|
7667
9640
|
}
|
|
9641
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument extends StandardParameters {
|
|
9642
|
+
/**
|
|
9643
|
+
* Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.
|
|
9644
|
+
*/
|
|
9645
|
+
name?: string;
|
|
9646
|
+
/**
|
|
9647
|
+
* What format output should be. If unspecified, defaults to JSON.
|
|
9648
|
+
*/
|
|
9649
|
+
processedDocumentFormat?: string;
|
|
9650
|
+
/**
|
|
9651
|
+
* Required. What type of processing to return.
|
|
9652
|
+
*/
|
|
9653
|
+
processedDocumentType?: string;
|
|
9654
|
+
}
|
|
7668
9655
|
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import extends StandardParameters {
|
|
7669
9656
|
/**
|
|
7670
9657
|
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission.
|
|
@@ -7717,6 +9704,58 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7717
9704
|
*/
|
|
7718
9705
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest;
|
|
7719
9706
|
}
|
|
9707
|
+
export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks {
|
|
9708
|
+
context: APIRequestContext;
|
|
9709
|
+
constructor(context: APIRequestContext);
|
|
9710
|
+
/**
|
|
9711
|
+
* Gets a Document.
|
|
9712
|
+
*
|
|
9713
|
+
* @param params - Parameters for request
|
|
9714
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9715
|
+
* @param callback - Optional callback that handles the response.
|
|
9716
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9717
|
+
*/
|
|
9718
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9719
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
9720
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9721
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
9722
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
9723
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaChunk>): void;
|
|
9724
|
+
/**
|
|
9725
|
+
* Gets a list of Chunks.
|
|
9726
|
+
*
|
|
9727
|
+
* @param params - Parameters for request
|
|
9728
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9729
|
+
* @param callback - Optional callback that handles the response.
|
|
9730
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9731
|
+
*/
|
|
9732
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
9733
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
9734
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
9735
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
9736
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
9737
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListChunksResponse>): void;
|
|
9738
|
+
}
|
|
9739
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get extends StandardParameters {
|
|
9740
|
+
/**
|
|
9741
|
+
* Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.
|
|
9742
|
+
*/
|
|
9743
|
+
name?: string;
|
|
9744
|
+
}
|
|
9745
|
+
export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List extends StandardParameters {
|
|
9746
|
+
/**
|
|
9747
|
+
* Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
9748
|
+
*/
|
|
9749
|
+
pageSize?: number;
|
|
9750
|
+
/**
|
|
9751
|
+
* A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
9752
|
+
*/
|
|
9753
|
+
pageToken?: string;
|
|
9754
|
+
/**
|
|
9755
|
+
* Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.
|
|
9756
|
+
*/
|
|
9757
|
+
parent?: string;
|
|
9758
|
+
}
|
|
7720
9759
|
export class Resource$Projects$Locations$Datastores$Branches$Operations {
|
|
7721
9760
|
context: APIRequestContext;
|
|
7722
9761
|
constructor(context: APIRequestContext);
|
|
@@ -7917,7 +9956,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7917
9956
|
}
|
|
7918
9957
|
export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters {
|
|
7919
9958
|
/**
|
|
7920
|
-
* Immutable. Fully qualified name `project/
|
|
9959
|
+
* 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`.
|
|
7921
9960
|
*/
|
|
7922
9961
|
name?: string;
|
|
7923
9962
|
/**
|
|
@@ -8177,6 +10216,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8177
10216
|
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
8178
10217
|
context: APIRequestContext;
|
|
8179
10218
|
constructor(context: APIRequestContext);
|
|
10219
|
+
/**
|
|
10220
|
+
* Answer query method.
|
|
10221
|
+
*
|
|
10222
|
+
* @param params - Parameters for request
|
|
10223
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10224
|
+
* @param callback - Optional callback that handles the response.
|
|
10225
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10226
|
+
*/
|
|
10227
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10228
|
+
answer(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
10229
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10230
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
10231
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
10232
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
|
|
8180
10233
|
/**
|
|
8181
10234
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
8182
10235
|
*
|
|
@@ -8248,9 +10301,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8248
10301
|
search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
8249
10302
|
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
|
|
8250
10303
|
}
|
|
10304
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer extends StandardParameters {
|
|
10305
|
+
/**
|
|
10306
|
+
* 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.
|
|
10307
|
+
*/
|
|
10308
|
+
servingConfig?: string;
|
|
10309
|
+
/**
|
|
10310
|
+
* Request body metadata
|
|
10311
|
+
*/
|
|
10312
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
10313
|
+
}
|
|
8251
10314
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
8252
10315
|
/**
|
|
8253
|
-
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/
|
|
10316
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
8254
10317
|
*/
|
|
8255
10318
|
name?: string;
|
|
8256
10319
|
}
|
|
@@ -8264,13 +10327,13 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8264
10327
|
*/
|
|
8265
10328
|
pageToken?: string;
|
|
8266
10329
|
/**
|
|
8267
|
-
* Required.
|
|
10330
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
8268
10331
|
*/
|
|
8269
10332
|
parent?: string;
|
|
8270
10333
|
}
|
|
8271
10334
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
8272
10335
|
/**
|
|
8273
|
-
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/
|
|
10336
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
8274
10337
|
*/
|
|
8275
10338
|
name?: string;
|
|
8276
10339
|
/**
|
|
@@ -8302,6 +10365,163 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8302
10365
|
*/
|
|
8303
10366
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
8304
10367
|
}
|
|
10368
|
+
export class Resource$Projects$Locations$Datastores$Sessions {
|
|
10369
|
+
context: APIRequestContext;
|
|
10370
|
+
answers: Resource$Projects$Locations$Datastores$Sessions$Answers;
|
|
10371
|
+
constructor(context: APIRequestContext);
|
|
10372
|
+
/**
|
|
10373
|
+
* Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
|
|
10374
|
+
*
|
|
10375
|
+
* @param params - Parameters for request
|
|
10376
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10377
|
+
* @param callback - Optional callback that handles the response.
|
|
10378
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10379
|
+
*/
|
|
10380
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10381
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
10382
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10383
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10384
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10385
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10386
|
+
/**
|
|
10387
|
+
* Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
|
|
10388
|
+
*
|
|
10389
|
+
* @param params - Parameters for request
|
|
10390
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10391
|
+
* @param callback - Optional callback that handles the response.
|
|
10392
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10393
|
+
*/
|
|
10394
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10395
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
|
|
10396
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10397
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
10398
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
10399
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
10400
|
+
/**
|
|
10401
|
+
* Gets a Session.
|
|
10402
|
+
*
|
|
10403
|
+
* @param params - Parameters for request
|
|
10404
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10405
|
+
* @param callback - Optional callback that handles the response.
|
|
10406
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10407
|
+
*/
|
|
10408
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10409
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
10410
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10411
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10412
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10413
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10414
|
+
/**
|
|
10415
|
+
* Lists all Sessions by their parent DataStore.
|
|
10416
|
+
*
|
|
10417
|
+
* @param params - Parameters for request
|
|
10418
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10419
|
+
* @param callback - Optional callback that handles the response.
|
|
10420
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10421
|
+
*/
|
|
10422
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10423
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
|
|
10424
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10425
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
10426
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Sessions$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
10427
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListSessionsResponse>): void;
|
|
10428
|
+
/**
|
|
10429
|
+
* Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
|
|
10430
|
+
*
|
|
10431
|
+
* @param params - Parameters for request
|
|
10432
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10433
|
+
* @param callback - Optional callback that handles the response.
|
|
10434
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10435
|
+
*/
|
|
10436
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10437
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSession>;
|
|
10438
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10439
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10440
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10441
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSession>): void;
|
|
10442
|
+
}
|
|
10443
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create extends StandardParameters {
|
|
10444
|
+
/**
|
|
10445
|
+
* Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
10446
|
+
*/
|
|
10447
|
+
parent?: string;
|
|
10448
|
+
/**
|
|
10449
|
+
* Request body metadata
|
|
10450
|
+
*/
|
|
10451
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
10452
|
+
}
|
|
10453
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete extends StandardParameters {
|
|
10454
|
+
/**
|
|
10455
|
+
* 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\}`
|
|
10456
|
+
*/
|
|
10457
|
+
name?: string;
|
|
10458
|
+
}
|
|
10459
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get extends StandardParameters {
|
|
10460
|
+
/**
|
|
10461
|
+
* 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\}`
|
|
10462
|
+
*/
|
|
10463
|
+
name?: string;
|
|
10464
|
+
}
|
|
10465
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$List extends StandardParameters {
|
|
10466
|
+
/**
|
|
10467
|
+
* A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
|
10468
|
+
*/
|
|
10469
|
+
filter?: string;
|
|
10470
|
+
/**
|
|
10471
|
+
* 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"
|
|
10472
|
+
*/
|
|
10473
|
+
orderBy?: string;
|
|
10474
|
+
/**
|
|
10475
|
+
* Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
10476
|
+
*/
|
|
10477
|
+
pageSize?: number;
|
|
10478
|
+
/**
|
|
10479
|
+
* A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
|
|
10480
|
+
*/
|
|
10481
|
+
pageToken?: string;
|
|
10482
|
+
/**
|
|
10483
|
+
* Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
|
|
10484
|
+
*/
|
|
10485
|
+
parent?: string;
|
|
10486
|
+
}
|
|
10487
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch extends StandardParameters {
|
|
10488
|
+
/**
|
|
10489
|
+
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
10490
|
+
*/
|
|
10491
|
+
name?: string;
|
|
10492
|
+
/**
|
|
10493
|
+
* 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.
|
|
10494
|
+
*/
|
|
10495
|
+
updateMask?: string;
|
|
10496
|
+
/**
|
|
10497
|
+
* Request body metadata
|
|
10498
|
+
*/
|
|
10499
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession;
|
|
10500
|
+
}
|
|
10501
|
+
export class Resource$Projects$Locations$Datastores$Sessions$Answers {
|
|
10502
|
+
context: APIRequestContext;
|
|
10503
|
+
constructor(context: APIRequestContext);
|
|
10504
|
+
/**
|
|
10505
|
+
* Gets a Answer.
|
|
10506
|
+
*
|
|
10507
|
+
* @param params - Parameters for request
|
|
10508
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10509
|
+
* @param callback - Optional callback that handles the response.
|
|
10510
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10511
|
+
*/
|
|
10512
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10513
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>;
|
|
10514
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10515
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
10516
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
10517
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswer>): void;
|
|
10518
|
+
}
|
|
10519
|
+
export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters {
|
|
10520
|
+
/**
|
|
10521
|
+
* 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\}`
|
|
10522
|
+
*/
|
|
10523
|
+
name?: string;
|
|
10524
|
+
}
|
|
8305
10525
|
export class Resource$Projects$Locations$Datastores$Sitesearchengine {
|
|
8306
10526
|
context: APIRequestContext;
|
|
8307
10527
|
targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites;
|
|
@@ -8675,7 +10895,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8675
10895
|
}
|
|
8676
10896
|
export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write extends StandardParameters {
|
|
8677
10897
|
/**
|
|
8678
|
-
* Required. The parent
|
|
10898
|
+
* 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\}`.
|
|
8679
10899
|
*/
|
|
8680
10900
|
parent?: string;
|
|
8681
10901
|
/**
|
|
@@ -8683,6 +10903,63 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8683
10903
|
*/
|
|
8684
10904
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
8685
10905
|
}
|
|
10906
|
+
export class Resource$Projects$Locations$Evaluations {
|
|
10907
|
+
context: APIRequestContext;
|
|
10908
|
+
operations: Resource$Projects$Locations$Evaluations$Operations;
|
|
10909
|
+
constructor(context: APIRequestContext);
|
|
10910
|
+
}
|
|
10911
|
+
export class Resource$Projects$Locations$Evaluations$Operations {
|
|
10912
|
+
context: APIRequestContext;
|
|
10913
|
+
constructor(context: APIRequestContext);
|
|
10914
|
+
/**
|
|
10915
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
10916
|
+
*
|
|
10917
|
+
* @param params - Parameters for request
|
|
10918
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10919
|
+
* @param callback - Optional callback that handles the response.
|
|
10920
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10921
|
+
*/
|
|
10922
|
+
get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10923
|
+
get(params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
10924
|
+
get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10925
|
+
get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
10926
|
+
get(params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
10927
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
10928
|
+
}
|
|
10929
|
+
export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get extends StandardParameters {
|
|
10930
|
+
/**
|
|
10931
|
+
* The name of the operation resource.
|
|
10932
|
+
*/
|
|
10933
|
+
name?: string;
|
|
10934
|
+
}
|
|
10935
|
+
export class Resource$Projects$Locations$Groundingconfigs {
|
|
10936
|
+
context: APIRequestContext;
|
|
10937
|
+
constructor(context: APIRequestContext);
|
|
10938
|
+
/**
|
|
10939
|
+
* Performs a grounding check.
|
|
10940
|
+
*
|
|
10941
|
+
* @param params - Parameters for request
|
|
10942
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
10943
|
+
* @param callback - Optional callback that handles the response.
|
|
10944
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
10945
|
+
*/
|
|
10946
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
10947
|
+
check(params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>;
|
|
10948
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
10949
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>): void;
|
|
10950
|
+
check(params: Params$Resource$Projects$Locations$Groundingconfigs$Check, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>): void;
|
|
10951
|
+
check(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>): void;
|
|
10952
|
+
}
|
|
10953
|
+
export interface Params$Resource$Projects$Locations$Groundingconfigs$Check extends StandardParameters {
|
|
10954
|
+
/**
|
|
10955
|
+
* Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`.
|
|
10956
|
+
*/
|
|
10957
|
+
groundingConfig?: string;
|
|
10958
|
+
/**
|
|
10959
|
+
* Request body metadata
|
|
10960
|
+
*/
|
|
10961
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest;
|
|
10962
|
+
}
|
|
8686
10963
|
export class Resource$Projects$Locations$Operations {
|
|
8687
10964
|
context: APIRequestContext;
|
|
8688
10965
|
constructor(context: APIRequestContext);
|
|
@@ -8739,6 +11016,91 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8739
11016
|
*/
|
|
8740
11017
|
pageToken?: string;
|
|
8741
11018
|
}
|
|
11019
|
+
export class Resource$Projects$Locations$Rankingconfigs {
|
|
11020
|
+
context: APIRequestContext;
|
|
11021
|
+
constructor(context: APIRequestContext);
|
|
11022
|
+
/**
|
|
11023
|
+
* Ranks a list of text records based on the given input query.
|
|
11024
|
+
*
|
|
11025
|
+
* @param params - Parameters for request
|
|
11026
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11027
|
+
* @param callback - Optional callback that handles the response.
|
|
11028
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11029
|
+
*/
|
|
11030
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
11031
|
+
rank(params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>;
|
|
11032
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
11033
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>): void;
|
|
11034
|
+
rank(params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>): void;
|
|
11035
|
+
rank(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRankResponse>): void;
|
|
11036
|
+
}
|
|
11037
|
+
export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters {
|
|
11038
|
+
/**
|
|
11039
|
+
* Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`.
|
|
11040
|
+
*/
|
|
11041
|
+
rankingConfig?: string;
|
|
11042
|
+
/**
|
|
11043
|
+
* Request body metadata
|
|
11044
|
+
*/
|
|
11045
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest;
|
|
11046
|
+
}
|
|
11047
|
+
export class Resource$Projects$Locations$Samplequerysets {
|
|
11048
|
+
context: APIRequestContext;
|
|
11049
|
+
operations: Resource$Projects$Locations$Samplequerysets$Operations;
|
|
11050
|
+
constructor(context: APIRequestContext);
|
|
11051
|
+
}
|
|
11052
|
+
export class Resource$Projects$Locations$Samplequerysets$Operations {
|
|
11053
|
+
context: APIRequestContext;
|
|
11054
|
+
constructor(context: APIRequestContext);
|
|
11055
|
+
/**
|
|
11056
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
11057
|
+
*
|
|
11058
|
+
* @param params - Parameters for request
|
|
11059
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11060
|
+
* @param callback - Optional callback that handles the response.
|
|
11061
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11062
|
+
*/
|
|
11063
|
+
get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
11064
|
+
get(params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
11065
|
+
get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
11066
|
+
get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
11067
|
+
get(params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
11068
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
11069
|
+
}
|
|
11070
|
+
export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get extends StandardParameters {
|
|
11071
|
+
/**
|
|
11072
|
+
* The name of the operation resource.
|
|
11073
|
+
*/
|
|
11074
|
+
name?: string;
|
|
11075
|
+
}
|
|
11076
|
+
export class Resource$Projects$Locations$Userevents {
|
|
11077
|
+
context: APIRequestContext;
|
|
11078
|
+
constructor(context: APIRequestContext);
|
|
11079
|
+
/**
|
|
11080
|
+
* Writes a single user event.
|
|
11081
|
+
*
|
|
11082
|
+
* @param params - Parameters for request
|
|
11083
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
11084
|
+
* @param callback - Optional callback that handles the response.
|
|
11085
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
11086
|
+
*/
|
|
11087
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
11088
|
+
write(params?: Params$Resource$Projects$Locations$Userevents$Write, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
11089
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
11090
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>): void;
|
|
11091
|
+
write(params: Params$Resource$Projects$Locations$Userevents$Write, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>): void;
|
|
11092
|
+
write(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaUserEvent>): void;
|
|
11093
|
+
}
|
|
11094
|
+
export interface Params$Resource$Projects$Locations$Userevents$Write extends StandardParameters {
|
|
11095
|
+
/**
|
|
11096
|
+
* 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\}`.
|
|
11097
|
+
*/
|
|
11098
|
+
parent?: string;
|
|
11099
|
+
/**
|
|
11100
|
+
* Request body metadata
|
|
11101
|
+
*/
|
|
11102
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
11103
|
+
}
|
|
8742
11104
|
export class Resource$Projects$Operations {
|
|
8743
11105
|
context: APIRequestContext;
|
|
8744
11106
|
constructor(context: APIRequestContext);
|