@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/build/v1beta.d.ts
CHANGED
|
@@ -192,15 +192,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
192
192
|
*/
|
|
193
193
|
functionName?: string | null;
|
|
194
194
|
}
|
|
195
|
-
/**
|
|
196
|
-
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
197
|
-
*/
|
|
198
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
|
|
199
|
-
/**
|
|
200
|
-
* TargetSites created.
|
|
201
|
-
*/
|
|
202
|
-
targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
|
|
203
|
-
}
|
|
204
195
|
/**
|
|
205
196
|
* Metadata for Create Schema LRO.
|
|
206
197
|
*/
|
|
@@ -417,6 +408,78 @@ export declare namespace discoveryengine_v1beta {
|
|
|
417
408
|
*/
|
|
418
409
|
purgeCount?: string | null;
|
|
419
410
|
}
|
|
411
|
+
/**
|
|
412
|
+
* Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
413
|
+
*/
|
|
414
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
415
|
+
/**
|
|
416
|
+
* Operation create time.
|
|
417
|
+
*/
|
|
418
|
+
createTime?: string | null;
|
|
419
|
+
/**
|
|
420
|
+
* 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.
|
|
421
|
+
*/
|
|
422
|
+
invalidUris?: string[] | null;
|
|
423
|
+
/**
|
|
424
|
+
* Total number of URIs that have yet to be crawled.
|
|
425
|
+
*/
|
|
426
|
+
pendingCount?: number | null;
|
|
427
|
+
/**
|
|
428
|
+
* Total number of URIs that were rejected due to insufficient indexing resources.
|
|
429
|
+
*/
|
|
430
|
+
quotaExceededCount?: number | null;
|
|
431
|
+
/**
|
|
432
|
+
* Total number of URIs that have been crawled so far.
|
|
433
|
+
*/
|
|
434
|
+
successCount?: number | null;
|
|
435
|
+
/**
|
|
436
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
437
|
+
*/
|
|
438
|
+
updateTime?: string | null;
|
|
439
|
+
/**
|
|
440
|
+
* Total number of unique URIs in the request that are not in invalid_uris.
|
|
441
|
+
*/
|
|
442
|
+
validUrisCount?: number | null;
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* Response message for SiteSearchEngineService.RecrawlUris method.
|
|
446
|
+
*/
|
|
447
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse {
|
|
448
|
+
/**
|
|
449
|
+
* URIs that were not crawled before the LRO terminated.
|
|
450
|
+
*/
|
|
451
|
+
failedUris?: string[] | null;
|
|
452
|
+
/**
|
|
453
|
+
* Details for a sample of up to 10 `failed_uris`.
|
|
454
|
+
*/
|
|
455
|
+
failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[];
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
|
|
459
|
+
*/
|
|
460
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo {
|
|
461
|
+
/**
|
|
462
|
+
* List of failure reasons by corpus type (e.g. desktop, mobile).
|
|
463
|
+
*/
|
|
464
|
+
failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[];
|
|
465
|
+
/**
|
|
466
|
+
* URI that failed to be crawled.
|
|
467
|
+
*/
|
|
468
|
+
uri?: string | null;
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
* Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.
|
|
472
|
+
*/
|
|
473
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason {
|
|
474
|
+
/**
|
|
475
|
+
* DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
|
|
476
|
+
*/
|
|
477
|
+
corpusType?: string | null;
|
|
478
|
+
/**
|
|
479
|
+
* Reason why the URI was not crawled.
|
|
480
|
+
*/
|
|
481
|
+
errorMessage?: string | null;
|
|
482
|
+
}
|
|
420
483
|
/**
|
|
421
484
|
* Defines the structure and layout of a type of document data.
|
|
422
485
|
*/
|
|
@@ -504,10 +567,6 @@ export declare namespace discoveryengine_v1beta {
|
|
|
504
567
|
quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
|
|
505
568
|
}
|
|
506
569
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
|
|
507
|
-
/**
|
|
508
|
-
* This number is an estimation on how much total quota this project needs to successfully complete indexing.
|
|
509
|
-
*/
|
|
510
|
-
totalRequiredQuota?: string | null;
|
|
511
570
|
}
|
|
512
571
|
/**
|
|
513
572
|
* Metadata for UpdateSchema LRO.
|
|
@@ -571,7 +630,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
571
630
|
/**
|
|
572
631
|
* 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.
|
|
573
632
|
*/
|
|
574
|
-
|
|
633
|
+
completableFieldPaths?: string[] | null;
|
|
575
634
|
/**
|
|
576
635
|
* The suggestion for the query.
|
|
577
636
|
*/
|
|
@@ -669,6 +728,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
669
728
|
* 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.
|
|
670
729
|
*/
|
|
671
730
|
servingConfig?: string | null;
|
|
731
|
+
/**
|
|
732
|
+
* A specification for configuring the summary returned in the response.
|
|
733
|
+
*/
|
|
734
|
+
summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec;
|
|
672
735
|
/**
|
|
673
736
|
* 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.
|
|
674
737
|
*/
|
|
@@ -1165,7 +1228,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1165
1228
|
*/
|
|
1166
1229
|
export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest {
|
|
1167
1230
|
/**
|
|
1168
|
-
* 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.
|
|
1231
|
+
* 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.
|
|
1169
1232
|
*/
|
|
1170
1233
|
filter?: string | null;
|
|
1171
1234
|
/**
|
|
@@ -1173,7 +1236,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1173
1236
|
*/
|
|
1174
1237
|
pageSize?: number | null;
|
|
1175
1238
|
/**
|
|
1176
|
-
* 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.
|
|
1239
|
+
* 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.
|
|
1177
1240
|
*/
|
|
1178
1241
|
params?: {
|
|
1179
1242
|
[key: string]: any;
|
|
@@ -1312,7 +1375,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1312
1375
|
*/
|
|
1313
1376
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest {
|
|
1314
1377
|
/**
|
|
1315
|
-
* Boost specification to boost certain documents.
|
|
1378
|
+
* Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
1316
1379
|
*/
|
|
1317
1380
|
boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
1318
1381
|
/**
|
|
@@ -1332,7 +1395,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1332
1395
|
*/
|
|
1333
1396
|
facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
1334
1397
|
/**
|
|
1335
|
-
* 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.
|
|
1398
|
+
* 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)
|
|
1336
1399
|
*/
|
|
1337
1400
|
filter?: string | null;
|
|
1338
1401
|
/**
|
|
@@ -1344,7 +1407,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1344
1407
|
*/
|
|
1345
1408
|
offset?: number | null;
|
|
1346
1409
|
/**
|
|
1347
|
-
* 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.
|
|
1410
|
+
* 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.
|
|
1348
1411
|
*/
|
|
1349
1412
|
orderBy?: string | null;
|
|
1350
1413
|
/**
|
|
@@ -1448,9 +1511,13 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1448
1511
|
*/
|
|
1449
1512
|
maxExtractiveSegmentCount?: number | null;
|
|
1450
1513
|
/**
|
|
1451
|
-
*
|
|
1514
|
+
* Return at most `num_next_segments` segments after each selected segments.
|
|
1515
|
+
*/
|
|
1516
|
+
numNextSegments?: number | null;
|
|
1517
|
+
/**
|
|
1518
|
+
* Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
|
|
1452
1519
|
*/
|
|
1453
|
-
|
|
1520
|
+
numPreviousSegments?: number | null;
|
|
1454
1521
|
}
|
|
1455
1522
|
/**
|
|
1456
1523
|
* A specification for configuring snippets in a search response.
|
|
@@ -1486,7 +1553,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1486
1553
|
*/
|
|
1487
1554
|
includeCitations?: boolean | null;
|
|
1488
1555
|
/**
|
|
1489
|
-
* Language code for Summary. Use language tags defined by BCP47.
|
|
1556
|
+
* 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.
|
|
1490
1557
|
*/
|
|
1491
1558
|
languageCode?: string | null;
|
|
1492
1559
|
/**
|
|
@@ -1621,6 +1688,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1621
1688
|
* Results of facets requested by user.
|
|
1622
1689
|
*/
|
|
1623
1690
|
facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[];
|
|
1691
|
+
geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[];
|
|
1624
1692
|
/**
|
|
1625
1693
|
* Guided search result.
|
|
1626
1694
|
*/
|
|
@@ -1684,6 +1752,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1684
1752
|
*/
|
|
1685
1753
|
value?: string | null;
|
|
1686
1754
|
}
|
|
1755
|
+
/**
|
|
1756
|
+
* Debug information specifically related to forward geocoding issues arising from Geolocation Search.
|
|
1757
|
+
*/
|
|
1758
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo {
|
|
1759
|
+
/**
|
|
1760
|
+
* The error produced.
|
|
1761
|
+
*/
|
|
1762
|
+
errorMessage?: string | null;
|
|
1763
|
+
/**
|
|
1764
|
+
* The address from which forward geocoding ingestion produced issues.
|
|
1765
|
+
*/
|
|
1766
|
+
originalAddressQuery?: string | null;
|
|
1767
|
+
}
|
|
1687
1768
|
/**
|
|
1688
1769
|
* 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.
|
|
1689
1770
|
*/
|
|
@@ -1746,6 +1827,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1746
1827
|
* Summary of the top N search result specified by the summary spec.
|
|
1747
1828
|
*/
|
|
1748
1829
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary {
|
|
1830
|
+
/**
|
|
1831
|
+
* A collection of Safety Attribute categories and their associated confidence scores.
|
|
1832
|
+
*/
|
|
1833
|
+
safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes;
|
|
1749
1834
|
/**
|
|
1750
1835
|
* Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
|
|
1751
1836
|
*/
|
|
@@ -1755,6 +1840,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1755
1840
|
*/
|
|
1756
1841
|
summaryText?: string | null;
|
|
1757
1842
|
}
|
|
1843
|
+
/**
|
|
1844
|
+
* Safety Attribute categories and their associated confidence scores.
|
|
1845
|
+
*/
|
|
1846
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes {
|
|
1847
|
+
/**
|
|
1848
|
+
* The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
|
|
1849
|
+
*/
|
|
1850
|
+
categories?: string[] | null;
|
|
1851
|
+
/**
|
|
1852
|
+
* The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
|
|
1853
|
+
*/
|
|
1854
|
+
scores?: number[] | null;
|
|
1855
|
+
}
|
|
1758
1856
|
/**
|
|
1759
1857
|
* Defines text input.
|
|
1760
1858
|
*/
|
|
@@ -2222,7 +2320,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2222
2320
|
*/
|
|
2223
2321
|
query?: string;
|
|
2224
2322
|
/**
|
|
2225
|
-
* 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
|
|
2323
|
+
* 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.
|
|
2226
2324
|
*/
|
|
2227
2325
|
queryModel?: string;
|
|
2228
2326
|
/**
|
|
@@ -3188,6 +3286,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3188
3286
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
3189
3287
|
context: APIRequestContext;
|
|
3190
3288
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
3289
|
+
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
3191
3290
|
constructor(context: APIRequestContext);
|
|
3192
3291
|
}
|
|
3193
3292
|
export class Resource$Projects$Locations$Collections$Engines$Operations {
|
|
@@ -3246,6 +3345,58 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3246
3345
|
*/
|
|
3247
3346
|
pageToken?: string;
|
|
3248
3347
|
}
|
|
3348
|
+
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
3349
|
+
context: APIRequestContext;
|
|
3350
|
+
constructor(context: APIRequestContext);
|
|
3351
|
+
/**
|
|
3352
|
+
* Makes a recommendation, which requires a contextual user event.
|
|
3353
|
+
*
|
|
3354
|
+
* @param params - Parameters for request
|
|
3355
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3356
|
+
* @param callback - Optional callback that handles the response.
|
|
3357
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3358
|
+
*/
|
|
3359
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3360
|
+
recommend(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
3361
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3362
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
3363
|
+
recommend(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
3364
|
+
recommend(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse>): void;
|
|
3365
|
+
/**
|
|
3366
|
+
* Performs a search.
|
|
3367
|
+
*
|
|
3368
|
+
* @param params - Parameters for request
|
|
3369
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3370
|
+
* @param callback - Optional callback that handles the response.
|
|
3371
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3372
|
+
*/
|
|
3373
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3374
|
+
search(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
3375
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3376
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
3377
|
+
search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
3378
|
+
search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaSearchResponse>): void;
|
|
3379
|
+
}
|
|
3380
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
3381
|
+
/**
|
|
3382
|
+
* 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.
|
|
3383
|
+
*/
|
|
3384
|
+
servingConfig?: string;
|
|
3385
|
+
/**
|
|
3386
|
+
* Request body metadata
|
|
3387
|
+
*/
|
|
3388
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest;
|
|
3389
|
+
}
|
|
3390
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
|
|
3391
|
+
/**
|
|
3392
|
+
* 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.
|
|
3393
|
+
*/
|
|
3394
|
+
servingConfig?: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* Request body metadata
|
|
3397
|
+
*/
|
|
3398
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
3399
|
+
}
|
|
3249
3400
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
3250
3401
|
context: APIRequestContext;
|
|
3251
3402
|
constructor(context: APIRequestContext);
|
|
@@ -3341,7 +3492,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3341
3492
|
*/
|
|
3342
3493
|
query?: string;
|
|
3343
3494
|
/**
|
|
3344
|
-
* 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
|
|
3495
|
+
* 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.
|
|
3345
3496
|
*/
|
|
3346
3497
|
queryModel?: string;
|
|
3347
3498
|
/**
|
package/build/v1beta.js
CHANGED
|
@@ -1351,6 +1351,8 @@ var discoveryengine_v1beta;
|
|
|
1351
1351
|
this.context = context;
|
|
1352
1352
|
this.operations =
|
|
1353
1353
|
new Resource$Projects$Locations$Collections$Engines$Operations(this.context);
|
|
1354
|
+
this.servingConfigs =
|
|
1355
|
+
new Resource$Projects$Locations$Collections$Engines$Servingconfigs(this.context);
|
|
1354
1356
|
}
|
|
1355
1357
|
}
|
|
1356
1358
|
discoveryengine_v1beta.Resource$Projects$Locations$Collections$Engines = Resource$Projects$Locations$Collections$Engines;
|
|
@@ -1424,6 +1426,76 @@ var discoveryengine_v1beta;
|
|
|
1424
1426
|
}
|
|
1425
1427
|
}
|
|
1426
1428
|
discoveryengine_v1beta.Resource$Projects$Locations$Collections$Engines$Operations = Resource$Projects$Locations$Collections$Engines$Operations;
|
|
1429
|
+
class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
1430
|
+
constructor(context) {
|
|
1431
|
+
this.context = context;
|
|
1432
|
+
}
|
|
1433
|
+
recommend(paramsOrCallback, optionsOrCallback, callback) {
|
|
1434
|
+
let params = (paramsOrCallback ||
|
|
1435
|
+
{});
|
|
1436
|
+
let options = (optionsOrCallback || {});
|
|
1437
|
+
if (typeof paramsOrCallback === 'function') {
|
|
1438
|
+
callback = paramsOrCallback;
|
|
1439
|
+
params =
|
|
1440
|
+
{};
|
|
1441
|
+
options = {};
|
|
1442
|
+
}
|
|
1443
|
+
if (typeof optionsOrCallback === 'function') {
|
|
1444
|
+
callback = optionsOrCallback;
|
|
1445
|
+
options = {};
|
|
1446
|
+
}
|
|
1447
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
1448
|
+
const parameters = {
|
|
1449
|
+
options: Object.assign({
|
|
1450
|
+
url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace(/([^:]\/)\/+/g, '$1'),
|
|
1451
|
+
method: 'POST',
|
|
1452
|
+
}, options),
|
|
1453
|
+
params,
|
|
1454
|
+
requiredParams: ['servingConfig'],
|
|
1455
|
+
pathParams: ['servingConfig'],
|
|
1456
|
+
context: this.context,
|
|
1457
|
+
};
|
|
1458
|
+
if (callback) {
|
|
1459
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
1460
|
+
}
|
|
1461
|
+
else {
|
|
1462
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1463
|
+
}
|
|
1464
|
+
}
|
|
1465
|
+
search(paramsOrCallback, optionsOrCallback, callback) {
|
|
1466
|
+
let params = (paramsOrCallback ||
|
|
1467
|
+
{});
|
|
1468
|
+
let options = (optionsOrCallback || {});
|
|
1469
|
+
if (typeof paramsOrCallback === 'function') {
|
|
1470
|
+
callback = paramsOrCallback;
|
|
1471
|
+
params =
|
|
1472
|
+
{};
|
|
1473
|
+
options = {};
|
|
1474
|
+
}
|
|
1475
|
+
if (typeof optionsOrCallback === 'function') {
|
|
1476
|
+
callback = optionsOrCallback;
|
|
1477
|
+
options = {};
|
|
1478
|
+
}
|
|
1479
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
1480
|
+
const parameters = {
|
|
1481
|
+
options: Object.assign({
|
|
1482
|
+
url: (rootUrl + '/v1beta/{+servingConfig}:search').replace(/([^:]\/)\/+/g, '$1'),
|
|
1483
|
+
method: 'POST',
|
|
1484
|
+
}, options),
|
|
1485
|
+
params,
|
|
1486
|
+
requiredParams: ['servingConfig'],
|
|
1487
|
+
pathParams: ['servingConfig'],
|
|
1488
|
+
context: this.context,
|
|
1489
|
+
};
|
|
1490
|
+
if (callback) {
|
|
1491
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
1492
|
+
}
|
|
1493
|
+
else {
|
|
1494
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1495
|
+
}
|
|
1496
|
+
}
|
|
1497
|
+
}
|
|
1498
|
+
discoveryengine_v1beta.Resource$Projects$Locations$Collections$Engines$Servingconfigs = Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
1427
1499
|
class Resource$Projects$Locations$Collections$Operations {
|
|
1428
1500
|
constructor(context) {
|
|
1429
1501
|
this.context = context;
|