@googleapis/discoveryengine 1.2.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +33 -0
- package/build/v1alpha.d.ts +625 -19
- package/build/v1alpha.js +275 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +175 -24
- package/build/v1beta.js +72 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +1441 -133
- package/v1beta.ts +356 -26
package/v1beta.ts
CHANGED
|
@@ -239,15 +239,6 @@ export namespace discoveryengine_v1beta {
|
|
|
239
239
|
*/
|
|
240
240
|
functionName?: string | null;
|
|
241
241
|
}
|
|
242
|
-
/**
|
|
243
|
-
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
244
|
-
*/
|
|
245
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
|
|
246
|
-
/**
|
|
247
|
-
* TargetSites created.
|
|
248
|
-
*/
|
|
249
|
-
targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
|
|
250
|
-
}
|
|
251
242
|
/**
|
|
252
243
|
* Metadata for Create Schema LRO.
|
|
253
244
|
*/
|
|
@@ -464,6 +455,78 @@ export namespace discoveryengine_v1beta {
|
|
|
464
455
|
*/
|
|
465
456
|
purgeCount?: string | null;
|
|
466
457
|
}
|
|
458
|
+
/**
|
|
459
|
+
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
460
|
+
*/
|
|
461
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
462
|
+
/**
|
|
463
|
+
* Operation create time.
|
|
464
|
+
*/
|
|
465
|
+
createTime?: string | null;
|
|
466
|
+
/**
|
|
467
|
+
* Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.
|
|
468
|
+
*/
|
|
469
|
+
invalidUris?: string[] | null;
|
|
470
|
+
/**
|
|
471
|
+
* Total number of URIs that have yet to be crawled.
|
|
472
|
+
*/
|
|
473
|
+
pendingCount?: number | null;
|
|
474
|
+
/**
|
|
475
|
+
* Total number of URIs that were rejected due to insufficient indexing resources.
|
|
476
|
+
*/
|
|
477
|
+
quotaExceededCount?: number | null;
|
|
478
|
+
/**
|
|
479
|
+
* Total number of URIs that have been crawled so far.
|
|
480
|
+
*/
|
|
481
|
+
successCount?: number | null;
|
|
482
|
+
/**
|
|
483
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
484
|
+
*/
|
|
485
|
+
updateTime?: string | null;
|
|
486
|
+
/**
|
|
487
|
+
* Total number of unique URIs in the request that are not in invalid_uris.
|
|
488
|
+
*/
|
|
489
|
+
validUrisCount?: number | null;
|
|
490
|
+
}
|
|
491
|
+
/**
|
|
492
|
+
* Response message for SiteSearchEngineService.RecrawlUris method.
|
|
493
|
+
*/
|
|
494
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
|
|
495
|
+
/**
|
|
496
|
+
* URIs that were not crawled before the LRO terminated.
|
|
497
|
+
*/
|
|
498
|
+
failedUris?: string[] | null;
|
|
499
|
+
/**
|
|
500
|
+
* Details for a sample of up to 10 `failed_uris`.
|
|
501
|
+
*/
|
|
502
|
+
failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
|
|
503
|
+
}
|
|
504
|
+
/**
|
|
505
|
+
* Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
|
|
506
|
+
*/
|
|
507
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
|
|
508
|
+
/**
|
|
509
|
+
* List of failure reasons by corpus type (e.g. desktop, mobile).
|
|
510
|
+
*/
|
|
511
|
+
failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
|
|
512
|
+
/**
|
|
513
|
+
* URI that failed to be crawled.
|
|
514
|
+
*/
|
|
515
|
+
uri?: string | null;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.
|
|
519
|
+
*/
|
|
520
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
521
|
+
/**
|
|
522
|
+
* DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
|
|
523
|
+
*/
|
|
524
|
+
corpusType?: string | null;
|
|
525
|
+
/**
|
|
526
|
+
* Reason why the URI was not crawled.
|
|
527
|
+
*/
|
|
528
|
+
errorMessage?: string | null;
|
|
529
|
+
}
|
|
467
530
|
/**
|
|
468
531
|
* Defines the structure and layout of a type of document data.
|
|
469
532
|
*/
|
|
@@ -548,12 +611,7 @@ export namespace discoveryengine_v1beta {
|
|
|
548
611
|
*/
|
|
549
612
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
550
613
|
}
|
|
551
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
552
|
-
/**
|
|
553
|
-
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
554
|
-
*/
|
|
555
|
-
totalRequiredQuota?: string | null;
|
|
556
|
-
}
|
|
614
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {}
|
|
557
615
|
/**
|
|
558
616
|
* Metadata for UpdateSchema LRO.
|
|
559
617
|
*/
|
|
@@ -616,7 +674,7 @@ export namespace discoveryengine_v1beta {
|
|
|
616
674
|
/**
|
|
617
675
|
* The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.
|
|
618
676
|
*/
|
|
619
|
-
|
|
677
|
+
completableFieldPaths?: string[] | null;
|
|
620
678
|
/**
|
|
621
679
|
* The suggestion for the query.
|
|
622
680
|
*/
|
|
@@ -714,6 +772,10 @@ export namespace discoveryengine_v1beta {
|
|
|
714
772
|
* The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used.
|
|
715
773
|
*/
|
|
716
774
|
servingConfig?: string | null;
|
|
775
|
+
/**
|
|
776
|
+
* A specification for configuring the summary returned in the response.
|
|
777
|
+
*/
|
|
778
|
+
summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec;
|
|
717
779
|
/**
|
|
718
780
|
* The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
|
|
719
781
|
*/
|
|
@@ -1204,7 +1266,7 @@ export namespace discoveryengine_v1beta {
|
|
|
1204
1266
|
*/
|
|
1205
1267
|
export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest {
|
|
1206
1268
|
/**
|
|
1207
|
-
* Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
|
1269
|
+
* Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
|
1208
1270
|
*/
|
|
1209
1271
|
filter?: string | null;
|
|
1210
1272
|
/**
|
|
@@ -1212,7 +1274,7 @@ export namespace discoveryengine_v1beta {
|
|
|
1212
1274
|
*/
|
|
1213
1275
|
pageSize?: number | null;
|
|
1214
1276
|
/**
|
|
1215
|
-
* Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.
|
|
1277
|
+
* Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
|
|
1216
1278
|
*/
|
|
1217
1279
|
params?: {[key: string]: any} | null;
|
|
1218
1280
|
/**
|
|
@@ -1343,7 +1405,7 @@ export namespace discoveryengine_v1beta {
|
|
|
1343
1405
|
*/
|
|
1344
1406
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest {
|
|
1345
1407
|
/**
|
|
1346
|
-
* Boost specification to boost certain documents.
|
|
1408
|
+
* Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
1347
1409
|
*/
|
|
1348
1410
|
boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
1349
1411
|
/**
|
|
@@ -1363,7 +1425,7 @@ export namespace discoveryengine_v1beta {
|
|
|
1363
1425
|
*/
|
|
1364
1426
|
facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
1365
1427
|
/**
|
|
1366
|
-
* 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. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1428
|
+
* 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. 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 customer 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)
|
|
1367
1429
|
*/
|
|
1368
1430
|
filter?: string | null;
|
|
1369
1431
|
/**
|
|
@@ -1375,7 +1437,7 @@ export namespace discoveryengine_v1beta {
|
|
|
1375
1437
|
*/
|
|
1376
1438
|
offset?: number | null;
|
|
1377
1439
|
/**
|
|
1378
|
-
* 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. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1440
|
+
* 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.
|
|
1379
1441
|
*/
|
|
1380
1442
|
orderBy?: string | null;
|
|
1381
1443
|
/**
|
|
@@ -1475,9 +1537,13 @@ export namespace discoveryengine_v1beta {
|
|
|
1475
1537
|
*/
|
|
1476
1538
|
maxExtractiveSegmentCount?: number | null;
|
|
1477
1539
|
/**
|
|
1478
|
-
*
|
|
1540
|
+
* Return at most `num_next_segments` segments after each selected segments.
|
|
1479
1541
|
*/
|
|
1480
|
-
|
|
1542
|
+
numNextSegments?: number | null;
|
|
1543
|
+
/**
|
|
1544
|
+
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
1545
|
+
*/
|
|
1546
|
+
numPreviousSegments?: number | null;
|
|
1481
1547
|
}
|
|
1482
1548
|
/**
|
|
1483
1549
|
* A specification for configuring snippets in a search response.
|
|
@@ -1513,7 +1579,7 @@ export namespace discoveryengine_v1beta {
|
|
|
1513
1579
|
*/
|
|
1514
1580
|
includeCitations?: boolean | null;
|
|
1515
1581
|
/**
|
|
1516
|
-
* Language code for Summary. Use language tags defined by BCP47.
|
|
1582
|
+
* Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
1517
1583
|
*/
|
|
1518
1584
|
languageCode?: string | null;
|
|
1519
1585
|
/**
|
|
@@ -1648,6 +1714,7 @@ export namespace discoveryengine_v1beta {
|
|
|
1648
1714
|
* Results of facets requested by user.
|
|
1649
1715
|
*/
|
|
1650
1716
|
facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[];
|
|
1717
|
+
geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[];
|
|
1651
1718
|
/**
|
|
1652
1719
|
* Guided search result.
|
|
1653
1720
|
*/
|
|
@@ -1711,6 +1778,19 @@ export namespace discoveryengine_v1beta {
|
|
|
1711
1778
|
*/
|
|
1712
1779
|
value?: string | null;
|
|
1713
1780
|
}
|
|
1781
|
+
/**
|
|
1782
|
+
* Debug information specifically related to forward geocoding issues arising from Geolocation Search.
|
|
1783
|
+
*/
|
|
1784
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo {
|
|
1785
|
+
/**
|
|
1786
|
+
* The error produced.
|
|
1787
|
+
*/
|
|
1788
|
+
errorMessage?: string | null;
|
|
1789
|
+
/**
|
|
1790
|
+
* The address from which forward geocoding ingestion produced issues.
|
|
1791
|
+
*/
|
|
1792
|
+
originalAddressQuery?: string | null;
|
|
1793
|
+
}
|
|
1714
1794
|
/**
|
|
1715
1795
|
* Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.
|
|
1716
1796
|
*/
|
|
@@ -1773,6 +1853,10 @@ export namespace discoveryengine_v1beta {
|
|
|
1773
1853
|
* Summary of the top N search result specified by the summary spec.
|
|
1774
1854
|
*/
|
|
1775
1855
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary {
|
|
1856
|
+
/**
|
|
1857
|
+
* A collection of Safety Attribute categories and their associated confidence scores.
|
|
1858
|
+
*/
|
|
1859
|
+
safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes;
|
|
1776
1860
|
/**
|
|
1777
1861
|
* Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1778
1862
|
*/
|
|
@@ -1782,6 +1866,19 @@ export namespace discoveryengine_v1beta {
|
|
|
1782
1866
|
*/
|
|
1783
1867
|
summaryText?: string | null;
|
|
1784
1868
|
}
|
|
1869
|
+
/**
|
|
1870
|
+
* Safety Attribute categories and their associated confidence scores.
|
|
1871
|
+
*/
|
|
1872
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes {
|
|
1873
|
+
/**
|
|
1874
|
+
* The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
|
|
1875
|
+
*/
|
|
1876
|
+
categories?: string[] | null;
|
|
1877
|
+
/**
|
|
1878
|
+
* The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
|
|
1879
|
+
*/
|
|
1880
|
+
scores?: number[] | null;
|
|
1881
|
+
}
|
|
1785
1882
|
/**
|
|
1786
1883
|
* Defines text input.
|
|
1787
1884
|
*/
|
|
@@ -2390,7 +2487,7 @@ export namespace discoveryengine_v1beta {
|
|
|
2390
2487
|
*/
|
|
2391
2488
|
query?: string;
|
|
2392
2489
|
/**
|
|
2393
|
-
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for
|
|
2490
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
2394
2491
|
*/
|
|
2395
2492
|
queryModel?: string;
|
|
2396
2493
|
/**
|
|
@@ -6342,12 +6439,17 @@ export namespace discoveryengine_v1beta {
|
|
|
6342
6439
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
6343
6440
|
context: APIRequestContext;
|
|
6344
6441
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
6442
|
+
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
6345
6443
|
constructor(context: APIRequestContext) {
|
|
6346
6444
|
this.context = context;
|
|
6347
6445
|
this.operations =
|
|
6348
6446
|
new Resource$Projects$Locations$Collections$Engines$Operations(
|
|
6349
6447
|
this.context
|
|
6350
6448
|
);
|
|
6449
|
+
this.servingConfigs =
|
|
6450
|
+
new Resource$Projects$Locations$Collections$Engines$Servingconfigs(
|
|
6451
|
+
this.context
|
|
6452
|
+
);
|
|
6351
6453
|
}
|
|
6352
6454
|
}
|
|
6353
6455
|
|
|
@@ -6576,6 +6678,234 @@ export namespace discoveryengine_v1beta {
|
|
|
6576
6678
|
pageToken?: string;
|
|
6577
6679
|
}
|
|
6578
6680
|
|
|
6681
|
+
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
6682
|
+
context: APIRequestContext;
|
|
6683
|
+
constructor(context: APIRequestContext) {
|
|
6684
|
+
this.context = context;
|
|
6685
|
+
}
|
|
6686
|
+
|
|
6687
|
+
/**
|
|
6688
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
6689
|
+
*
|
|
6690
|
+
* @param params - Parameters for request
|
|
6691
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6692
|
+
* @param callback - Optional callback that handles the response.
|
|
6693
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6694
|
+
*/
|
|
6695
|
+
recommend(
|
|
6696
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6697
|
+
options: StreamMethodOptions
|
|
6698
|
+
): GaxiosPromise<Readable>;
|
|
6699
|
+
recommend(
|
|
6700
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6701
|
+
options?: MethodOptions
|
|
6702
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
6703
|
+
recommend(
|
|
6704
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6705
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6706
|
+
callback: BodyResponseCallback<Readable>
|
|
6707
|
+
): void;
|
|
6708
|
+
recommend(
|
|
6709
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6710
|
+
options:
|
|
6711
|
+
| MethodOptions
|
|
6712
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>,
|
|
6713
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
|
|
6714
|
+
): void;
|
|
6715
|
+
recommend(
|
|
6716
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend,
|
|
6717
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
|
|
6718
|
+
): void;
|
|
6719
|
+
recommend(
|
|
6720
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
|
|
6721
|
+
): void;
|
|
6722
|
+
recommend(
|
|
6723
|
+
paramsOrCallback?:
|
|
6724
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
6725
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
|
|
6726
|
+
| BodyResponseCallback<Readable>,
|
|
6727
|
+
optionsOrCallback?:
|
|
6728
|
+
| MethodOptions
|
|
6729
|
+
| StreamMethodOptions
|
|
6730
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
|
|
6731
|
+
| BodyResponseCallback<Readable>,
|
|
6732
|
+
callback?:
|
|
6733
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
|
|
6734
|
+
| BodyResponseCallback<Readable>
|
|
6735
|
+
):
|
|
6736
|
+
| void
|
|
6737
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>
|
|
6738
|
+
| GaxiosPromise<Readable> {
|
|
6739
|
+
let params = (paramsOrCallback ||
|
|
6740
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend;
|
|
6741
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6742
|
+
|
|
6743
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6744
|
+
callback = paramsOrCallback;
|
|
6745
|
+
params =
|
|
6746
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend;
|
|
6747
|
+
options = {};
|
|
6748
|
+
}
|
|
6749
|
+
|
|
6750
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6751
|
+
callback = optionsOrCallback;
|
|
6752
|
+
options = {};
|
|
6753
|
+
}
|
|
6754
|
+
|
|
6755
|
+
const rootUrl =
|
|
6756
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6757
|
+
const parameters = {
|
|
6758
|
+
options: Object.assign(
|
|
6759
|
+
{
|
|
6760
|
+
url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace(
|
|
6761
|
+
/([^:]\/)\/+/g,
|
|
6762
|
+
'$1'
|
|
6763
|
+
),
|
|
6764
|
+
method: 'POST',
|
|
6765
|
+
},
|
|
6766
|
+
options
|
|
6767
|
+
),
|
|
6768
|
+
params,
|
|
6769
|
+
requiredParams: ['servingConfig'],
|
|
6770
|
+
pathParams: ['servingConfig'],
|
|
6771
|
+
context: this.context,
|
|
6772
|
+
};
|
|
6773
|
+
if (callback) {
|
|
6774
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>(
|
|
6775
|
+
parameters,
|
|
6776
|
+
callback as BodyResponseCallback<unknown>
|
|
6777
|
+
);
|
|
6778
|
+
} else {
|
|
6779
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>(
|
|
6780
|
+
parameters
|
|
6781
|
+
);
|
|
6782
|
+
}
|
|
6783
|
+
}
|
|
6784
|
+
|
|
6785
|
+
/**
|
|
6786
|
+
* Performs a search.
|
|
6787
|
+
*
|
|
6788
|
+
* @param params - Parameters for request
|
|
6789
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6790
|
+
* @param callback - Optional callback that handles the response.
|
|
6791
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6792
|
+
*/
|
|
6793
|
+
search(
|
|
6794
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6795
|
+
options: StreamMethodOptions
|
|
6796
|
+
): GaxiosPromise<Readable>;
|
|
6797
|
+
search(
|
|
6798
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6799
|
+
options?: MethodOptions
|
|
6800
|
+
): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
6801
|
+
search(
|
|
6802
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6803
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6804
|
+
callback: BodyResponseCallback<Readable>
|
|
6805
|
+
): void;
|
|
6806
|
+
search(
|
|
6807
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6808
|
+
options:
|
|
6809
|
+
| MethodOptions
|
|
6810
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>,
|
|
6811
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>
|
|
6812
|
+
): void;
|
|
6813
|
+
search(
|
|
6814
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search,
|
|
6815
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>
|
|
6816
|
+
): void;
|
|
6817
|
+
search(
|
|
6818
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>
|
|
6819
|
+
): void;
|
|
6820
|
+
search(
|
|
6821
|
+
paramsOrCallback?:
|
|
6822
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search
|
|
6823
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>
|
|
6824
|
+
| BodyResponseCallback<Readable>,
|
|
6825
|
+
optionsOrCallback?:
|
|
6826
|
+
| MethodOptions
|
|
6827
|
+
| StreamMethodOptions
|
|
6828
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>
|
|
6829
|
+
| BodyResponseCallback<Readable>,
|
|
6830
|
+
callback?:
|
|
6831
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>
|
|
6832
|
+
| BodyResponseCallback<Readable>
|
|
6833
|
+
):
|
|
6834
|
+
| void
|
|
6835
|
+
| GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>
|
|
6836
|
+
| GaxiosPromise<Readable> {
|
|
6837
|
+
let params = (paramsOrCallback ||
|
|
6838
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search;
|
|
6839
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6840
|
+
|
|
6841
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6842
|
+
callback = paramsOrCallback;
|
|
6843
|
+
params =
|
|
6844
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search;
|
|
6845
|
+
options = {};
|
|
6846
|
+
}
|
|
6847
|
+
|
|
6848
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6849
|
+
callback = optionsOrCallback;
|
|
6850
|
+
options = {};
|
|
6851
|
+
}
|
|
6852
|
+
|
|
6853
|
+
const rootUrl =
|
|
6854
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
6855
|
+
const parameters = {
|
|
6856
|
+
options: Object.assign(
|
|
6857
|
+
{
|
|
6858
|
+
url: (rootUrl + '/v1beta/{+servingConfig}:search').replace(
|
|
6859
|
+
/([^:]\/)\/+/g,
|
|
6860
|
+
'$1'
|
|
6861
|
+
),
|
|
6862
|
+
method: 'POST',
|
|
6863
|
+
},
|
|
6864
|
+
options
|
|
6865
|
+
),
|
|
6866
|
+
params,
|
|
6867
|
+
requiredParams: ['servingConfig'],
|
|
6868
|
+
pathParams: ['servingConfig'],
|
|
6869
|
+
context: this.context,
|
|
6870
|
+
};
|
|
6871
|
+
if (callback) {
|
|
6872
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>(
|
|
6873
|
+
parameters,
|
|
6874
|
+
callback as BodyResponseCallback<unknown>
|
|
6875
|
+
);
|
|
6876
|
+
} else {
|
|
6877
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>(
|
|
6878
|
+
parameters
|
|
6879
|
+
);
|
|
6880
|
+
}
|
|
6881
|
+
}
|
|
6882
|
+
}
|
|
6883
|
+
|
|
6884
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
|
|
6885
|
+
extends StandardParameters {
|
|
6886
|
+
/**
|
|
6887
|
+
* Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it.
|
|
6888
|
+
*/
|
|
6889
|
+
servingConfig?: string;
|
|
6890
|
+
|
|
6891
|
+
/**
|
|
6892
|
+
* Request body metadata
|
|
6893
|
+
*/
|
|
6894
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest;
|
|
6895
|
+
}
|
|
6896
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search
|
|
6897
|
+
extends StandardParameters {
|
|
6898
|
+
/**
|
|
6899
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
6900
|
+
*/
|
|
6901
|
+
servingConfig?: string;
|
|
6902
|
+
|
|
6903
|
+
/**
|
|
6904
|
+
* Request body metadata
|
|
6905
|
+
*/
|
|
6906
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
6907
|
+
}
|
|
6908
|
+
|
|
6579
6909
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
6580
6910
|
context: APIRequestContext;
|
|
6581
6911
|
constructor(context: APIRequestContext) {
|
|
@@ -6947,7 +7277,7 @@ export namespace discoveryengine_v1beta {
|
|
|
6947
7277
|
*/
|
|
6948
7278
|
query?: string;
|
|
6949
7279
|
/**
|
|
6950
|
-
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for
|
|
7280
|
+
* Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
6951
7281
|
*/
|
|
6952
7282
|
queryModel?: string;
|
|
6953
7283
|
/**
|