@google-cloud/discoveryengine 1.9.0 → 1.11.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 +19 -0
- package/README.md +32 -0
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +13 -0
- package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +119 -0
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +0 -5
- package/build/protos/google/cloud/discoveryengine/v1/completion.proto +31 -0
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +35 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +37 -2
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +108 -0
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +200 -4
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto +232 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation_service.proto +252 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +83 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto +86 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto +264 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto +258 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +10 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +83 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +67 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
- package/build/protos/protos.d.ts +31310 -20211
- package/build/protos/protos.js +86710 -60571
- package/build/protos/protos.json +7720 -5011
- package/build/src/v1/completion_service_client.d.ts +220 -0
- package/build/src/v1/completion_service_client.js +260 -0
- package/build/src/v1/completion_service_client_config.json +10 -0
- package/build/src/v1/control_service_client.d.ts +129 -1
- package/build/src/v1/control_service_client.js +176 -0
- package/build/src/v1/conversational_search_service_client.d.ts +147 -1
- package/build/src/v1/conversational_search_service_client.js +176 -0
- package/build/src/v1/data_store_service_client.d.ts +129 -1
- package/build/src/v1/data_store_service_client.js +176 -0
- package/build/src/v1/document_service_client.d.ts +131 -1
- package/build/src/v1/document_service_client.js +176 -0
- package/build/src/v1/engine_service_client.d.ts +129 -1
- package/build/src/v1/engine_service_client.js +176 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +129 -0
- package/build/src/v1/grounded_generation_service_client.js +176 -0
- package/build/src/v1/project_service_client.d.ts +129 -0
- package/build/src/v1/project_service_client.js +176 -0
- package/build/src/v1/rank_service_client.d.ts +129 -0
- package/build/src/v1/rank_service_client.js +176 -0
- package/build/src/v1/recommendation_service_client.d.ts +129 -0
- package/build/src/v1/recommendation_service_client.js +176 -0
- package/build/src/v1/schema_service_client.d.ts +129 -1
- package/build/src/v1/schema_service_client.js +176 -0
- package/build/src/v1/search_service_client.d.ts +252 -1
- package/build/src/v1/search_service_client.js +258 -0
- package/build/src/v1/site_search_engine_service_client.d.ts +129 -1
- package/build/src/v1/site_search_engine_service_client.js +176 -0
- package/build/src/v1/user_event_service_client.d.ts +129 -0
- package/build/src/v1/user_event_service_client.js +176 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
- package/build/src/v1alpha/acl_config_service_client.js +157 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +108 -1
- package/build/src/v1alpha/chunk_service_client.js +157 -0
- package/build/src/v1alpha/completion_service_client.d.ts +108 -0
- package/build/src/v1alpha/completion_service_client.js +157 -0
- package/build/src/v1alpha/control_service_client.d.ts +108 -1
- package/build/src/v1alpha/control_service_client.js +157 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -1
- package/build/src/v1alpha/conversational_search_service_client.js +157 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +108 -1
- package/build/src/v1alpha/data_store_service_client.js +157 -0
- package/build/src/v1alpha/document_service_client.d.ts +108 -1
- package/build/src/v1alpha/document_service_client.js +157 -0
- package/build/src/v1alpha/engine_service_client.d.ts +108 -1
- package/build/src/v1alpha/engine_service_client.js +157 -0
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
- package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
- package/build/src/v1alpha/evaluation_service_client.js +3288 -0
- package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
- package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
- package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
- package/build/src/v1alpha/index.d.ts +3 -0
- package/build/src/v1alpha/index.js +7 -1
- package/build/src/v1alpha/project_service_client.d.ts +108 -0
- package/build/src/v1alpha/project_service_client.js +157 -0
- package/build/src/v1alpha/rank_service_client.d.ts +108 -0
- package/build/src/v1alpha/rank_service_client.js +157 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
- package/build/src/v1alpha/recommendation_service_client.js +157 -0
- package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
- package/build/src/v1alpha/sample_query_service_client.js +3186 -0
- package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
- package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
- package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
- package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
- package/build/src/v1alpha/schema_service_client.d.ts +108 -1
- package/build/src/v1alpha/schema_service_client.js +157 -0
- package/build/src/v1alpha/search_service_client.d.ts +108 -1
- package/build/src/v1alpha/search_service_client.js +157 -0
- package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
- package/build/src/v1alpha/search_tuning_service_client.js +157 -0
- package/build/src/v1alpha/serving_config_service_client.d.ts +108 -1
- package/build/src/v1alpha/serving_config_service_client.js +157 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -1
- package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
- package/build/src/v1alpha/user_event_service_client.js +157 -0
- package/build/src/v1beta/completion_service_client.d.ts +237 -0
- package/build/src/v1beta/completion_service_client.js +339 -0
- package/build/src/v1beta/control_service_client.d.ts +237 -1
- package/build/src/v1beta/control_service_client.js +333 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +237 -1
- package/build/src/v1beta/conversational_search_service_client.js +333 -0
- package/build/src/v1beta/data_store_service_client.d.ts +237 -1
- package/build/src/v1beta/data_store_service_client.js +339 -0
- package/build/src/v1beta/document_service_client.d.ts +237 -1
- package/build/src/v1beta/document_service_client.js +339 -0
- package/build/src/v1beta/engine_service_client.d.ts +237 -1
- package/build/src/v1beta/engine_service_client.js +339 -0
- package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
- package/build/src/v1beta/evaluation_service_client.js +3252 -0
- package/build/src/v1beta/evaluation_service_client_config.json +58 -0
- package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
- package/build/src/v1beta/grounded_generation_service_client.js +333 -0
- package/build/src/v1beta/index.d.ts +3 -0
- package/build/src/v1beta/index.js +7 -1
- package/build/src/v1beta/project_service_client.d.ts +237 -0
- package/build/src/v1beta/project_service_client.js +339 -0
- package/build/src/v1beta/rank_service_client.d.ts +237 -0
- package/build/src/v1beta/rank_service_client.js +333 -0
- package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
- package/build/src/v1beta/recommendation_service_client.js +333 -0
- package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
- package/build/src/v1beta/sample_query_service_client.js +3150 -0
- package/build/src/v1beta/sample_query_service_client_config.json +68 -0
- package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
- package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
- package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
- package/build/src/v1beta/schema_service_client.d.ts +237 -1
- package/build/src/v1beta/schema_service_client.js +339 -0
- package/build/src/v1beta/search_service_client.d.ts +267 -13
- package/build/src/v1beta/search_service_client.js +353 -8
- package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
- package/build/src/v1beta/search_tuning_service_client.js +339 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +237 -1
- package/build/src/v1beta/serving_config_service_client.js +333 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -1
- package/build/src/v1beta/site_search_engine_service_client.js +339 -0
- package/build/src/v1beta/user_event_service_client.d.ts +237 -0
- package/build/src/v1beta/user_event_service_client.js +339 -0
- package/package.json +1 -1
@@ -152,6 +152,7 @@ class RecommendationServiceClient {
|
|
152
152
|
this.pathTemplates = {
|
153
153
|
aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
|
154
154
|
enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
|
155
|
+
evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
|
155
156
|
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
|
156
157
|
projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
|
157
158
|
projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
@@ -184,6 +185,8 @@ class RecommendationServiceClient {
|
|
184
185
|
projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
|
185
186
|
projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
|
186
187
|
projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
188
|
+
sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
|
189
|
+
sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
|
187
190
|
};
|
188
191
|
// Put together the default options sent with requests.
|
189
192
|
this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.RecommendationService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
|
@@ -467,6 +470,54 @@ class RecommendationServiceClient {
|
|
467
470
|
matchEngineFromEngineName(engineName) {
|
468
471
|
return this.pathTemplates.enginePathTemplate.match(engineName).engine;
|
469
472
|
}
|
473
|
+
/**
|
474
|
+
* Return a fully-qualified evaluation resource name string.
|
475
|
+
*
|
476
|
+
* @param {string} project
|
477
|
+
* @param {string} location
|
478
|
+
* @param {string} evaluation
|
479
|
+
* @returns {string} Resource name string.
|
480
|
+
*/
|
481
|
+
evaluationPath(project, location, evaluation) {
|
482
|
+
return this.pathTemplates.evaluationPathTemplate.render({
|
483
|
+
project: project,
|
484
|
+
location: location,
|
485
|
+
evaluation: evaluation,
|
486
|
+
});
|
487
|
+
}
|
488
|
+
/**
|
489
|
+
* Parse the project from Evaluation resource.
|
490
|
+
*
|
491
|
+
* @param {string} evaluationName
|
492
|
+
* A fully-qualified path representing Evaluation resource.
|
493
|
+
* @returns {string} A string representing the project.
|
494
|
+
*/
|
495
|
+
matchProjectFromEvaluationName(evaluationName) {
|
496
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
497
|
+
.project;
|
498
|
+
}
|
499
|
+
/**
|
500
|
+
* Parse the location from Evaluation resource.
|
501
|
+
*
|
502
|
+
* @param {string} evaluationName
|
503
|
+
* A fully-qualified path representing Evaluation resource.
|
504
|
+
* @returns {string} A string representing the location.
|
505
|
+
*/
|
506
|
+
matchLocationFromEvaluationName(evaluationName) {
|
507
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
508
|
+
.location;
|
509
|
+
}
|
510
|
+
/**
|
511
|
+
* Parse the evaluation from Evaluation resource.
|
512
|
+
*
|
513
|
+
* @param {string} evaluationName
|
514
|
+
* A fully-qualified path representing Evaluation resource.
|
515
|
+
* @returns {string} A string representing the evaluation.
|
516
|
+
*/
|
517
|
+
matchEvaluationFromEvaluationName(evaluationName) {
|
518
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
519
|
+
.evaluation;
|
520
|
+
}
|
470
521
|
/**
|
471
522
|
* Return a fully-qualified project resource name string.
|
472
523
|
*
|
@@ -2507,6 +2558,112 @@ class RecommendationServiceClient {
|
|
2507
2558
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
2508
2559
|
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
|
2509
2560
|
}
|
2561
|
+
/**
|
2562
|
+
* Return a fully-qualified sampleQuery resource name string.
|
2563
|
+
*
|
2564
|
+
* @param {string} project
|
2565
|
+
* @param {string} location
|
2566
|
+
* @param {string} sample_query_set
|
2567
|
+
* @param {string} sample_query
|
2568
|
+
* @returns {string} Resource name string.
|
2569
|
+
*/
|
2570
|
+
sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
|
2571
|
+
return this.pathTemplates.sampleQueryPathTemplate.render({
|
2572
|
+
project: project,
|
2573
|
+
location: location,
|
2574
|
+
sample_query_set: sampleQuerySet,
|
2575
|
+
sample_query: sampleQuery,
|
2576
|
+
});
|
2577
|
+
}
|
2578
|
+
/**
|
2579
|
+
* Parse the project from SampleQuery resource.
|
2580
|
+
*
|
2581
|
+
* @param {string} sampleQueryName
|
2582
|
+
* A fully-qualified path representing SampleQuery resource.
|
2583
|
+
* @returns {string} A string representing the project.
|
2584
|
+
*/
|
2585
|
+
matchProjectFromSampleQueryName(sampleQueryName) {
|
2586
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2587
|
+
.project;
|
2588
|
+
}
|
2589
|
+
/**
|
2590
|
+
* Parse the location from SampleQuery resource.
|
2591
|
+
*
|
2592
|
+
* @param {string} sampleQueryName
|
2593
|
+
* A fully-qualified path representing SampleQuery resource.
|
2594
|
+
* @returns {string} A string representing the location.
|
2595
|
+
*/
|
2596
|
+
matchLocationFromSampleQueryName(sampleQueryName) {
|
2597
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2598
|
+
.location;
|
2599
|
+
}
|
2600
|
+
/**
|
2601
|
+
* Parse the sample_query_set from SampleQuery resource.
|
2602
|
+
*
|
2603
|
+
* @param {string} sampleQueryName
|
2604
|
+
* A fully-qualified path representing SampleQuery resource.
|
2605
|
+
* @returns {string} A string representing the sample_query_set.
|
2606
|
+
*/
|
2607
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
|
2608
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2609
|
+
.sample_query_set;
|
2610
|
+
}
|
2611
|
+
/**
|
2612
|
+
* Parse the sample_query from SampleQuery resource.
|
2613
|
+
*
|
2614
|
+
* @param {string} sampleQueryName
|
2615
|
+
* A fully-qualified path representing SampleQuery resource.
|
2616
|
+
* @returns {string} A string representing the sample_query.
|
2617
|
+
*/
|
2618
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName) {
|
2619
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2620
|
+
.sample_query;
|
2621
|
+
}
|
2622
|
+
/**
|
2623
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2624
|
+
*
|
2625
|
+
* @param {string} project
|
2626
|
+
* @param {string} location
|
2627
|
+
* @param {string} sample_query_set
|
2628
|
+
* @returns {string} Resource name string.
|
2629
|
+
*/
|
2630
|
+
sampleQuerySetPath(project, location, sampleQuerySet) {
|
2631
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.render({
|
2632
|
+
project: project,
|
2633
|
+
location: location,
|
2634
|
+
sample_query_set: sampleQuerySet,
|
2635
|
+
});
|
2636
|
+
}
|
2637
|
+
/**
|
2638
|
+
* Parse the project from SampleQuerySet resource.
|
2639
|
+
*
|
2640
|
+
* @param {string} sampleQuerySetName
|
2641
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2642
|
+
* @returns {string} A string representing the project.
|
2643
|
+
*/
|
2644
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName) {
|
2645
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
|
2646
|
+
}
|
2647
|
+
/**
|
2648
|
+
* Parse the location from SampleQuerySet resource.
|
2649
|
+
*
|
2650
|
+
* @param {string} sampleQuerySetName
|
2651
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2652
|
+
* @returns {string} A string representing the location.
|
2653
|
+
*/
|
2654
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName) {
|
2655
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
|
2656
|
+
}
|
2657
|
+
/**
|
2658
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2659
|
+
*
|
2660
|
+
* @param {string} sampleQuerySetName
|
2661
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2662
|
+
* @returns {string} A string representing the sample_query_set.
|
2663
|
+
*/
|
2664
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
|
2665
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
|
2666
|
+
}
|
2510
2667
|
/**
|
2511
2668
|
* Terminate the gRPC channel and close the client.
|
2512
2669
|
*
|