@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
@@ -154,6 +154,7 @@ class ControlServiceClient {
|
|
154
154
|
this.pathTemplates = {
|
155
155
|
aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
|
156
156
|
enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
|
157
|
+
evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
|
157
158
|
locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
|
158
159
|
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
|
159
160
|
projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
|
@@ -187,6 +188,8 @@ class ControlServiceClient {
|
|
187
188
|
projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
|
188
189
|
projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
|
189
190
|
projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
191
|
+
sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
|
192
|
+
sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
|
190
193
|
};
|
191
194
|
// Some of the methods on this service return "paged" results,
|
192
195
|
// (e.g. 50 results at a time, with tokens to get subsequent
|
@@ -663,6 +666,54 @@ class ControlServiceClient {
|
|
663
666
|
matchEngineFromEngineName(engineName) {
|
664
667
|
return this.pathTemplates.enginePathTemplate.match(engineName).engine;
|
665
668
|
}
|
669
|
+
/**
|
670
|
+
* Return a fully-qualified evaluation resource name string.
|
671
|
+
*
|
672
|
+
* @param {string} project
|
673
|
+
* @param {string} location
|
674
|
+
* @param {string} evaluation
|
675
|
+
* @returns {string} Resource name string.
|
676
|
+
*/
|
677
|
+
evaluationPath(project, location, evaluation) {
|
678
|
+
return this.pathTemplates.evaluationPathTemplate.render({
|
679
|
+
project: project,
|
680
|
+
location: location,
|
681
|
+
evaluation: evaluation,
|
682
|
+
});
|
683
|
+
}
|
684
|
+
/**
|
685
|
+
* Parse the project from Evaluation resource.
|
686
|
+
*
|
687
|
+
* @param {string} evaluationName
|
688
|
+
* A fully-qualified path representing Evaluation resource.
|
689
|
+
* @returns {string} A string representing the project.
|
690
|
+
*/
|
691
|
+
matchProjectFromEvaluationName(evaluationName) {
|
692
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
693
|
+
.project;
|
694
|
+
}
|
695
|
+
/**
|
696
|
+
* Parse the location from Evaluation resource.
|
697
|
+
*
|
698
|
+
* @param {string} evaluationName
|
699
|
+
* A fully-qualified path representing Evaluation resource.
|
700
|
+
* @returns {string} A string representing the location.
|
701
|
+
*/
|
702
|
+
matchLocationFromEvaluationName(evaluationName) {
|
703
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
704
|
+
.location;
|
705
|
+
}
|
706
|
+
/**
|
707
|
+
* Parse the evaluation from Evaluation resource.
|
708
|
+
*
|
709
|
+
* @param {string} evaluationName
|
710
|
+
* A fully-qualified path representing Evaluation resource.
|
711
|
+
* @returns {string} A string representing the evaluation.
|
712
|
+
*/
|
713
|
+
matchEvaluationFromEvaluationName(evaluationName) {
|
714
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
715
|
+
.evaluation;
|
716
|
+
}
|
666
717
|
/**
|
667
718
|
* Return a fully-qualified location resource name string.
|
668
719
|
*
|
@@ -2736,6 +2787,112 @@ class ControlServiceClient {
|
|
2736
2787
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
2737
2788
|
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
|
2738
2789
|
}
|
2790
|
+
/**
|
2791
|
+
* Return a fully-qualified sampleQuery resource name string.
|
2792
|
+
*
|
2793
|
+
* @param {string} project
|
2794
|
+
* @param {string} location
|
2795
|
+
* @param {string} sample_query_set
|
2796
|
+
* @param {string} sample_query
|
2797
|
+
* @returns {string} Resource name string.
|
2798
|
+
*/
|
2799
|
+
sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
|
2800
|
+
return this.pathTemplates.sampleQueryPathTemplate.render({
|
2801
|
+
project: project,
|
2802
|
+
location: location,
|
2803
|
+
sample_query_set: sampleQuerySet,
|
2804
|
+
sample_query: sampleQuery,
|
2805
|
+
});
|
2806
|
+
}
|
2807
|
+
/**
|
2808
|
+
* Parse the project from SampleQuery resource.
|
2809
|
+
*
|
2810
|
+
* @param {string} sampleQueryName
|
2811
|
+
* A fully-qualified path representing SampleQuery resource.
|
2812
|
+
* @returns {string} A string representing the project.
|
2813
|
+
*/
|
2814
|
+
matchProjectFromSampleQueryName(sampleQueryName) {
|
2815
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2816
|
+
.project;
|
2817
|
+
}
|
2818
|
+
/**
|
2819
|
+
* Parse the location from SampleQuery resource.
|
2820
|
+
*
|
2821
|
+
* @param {string} sampleQueryName
|
2822
|
+
* A fully-qualified path representing SampleQuery resource.
|
2823
|
+
* @returns {string} A string representing the location.
|
2824
|
+
*/
|
2825
|
+
matchLocationFromSampleQueryName(sampleQueryName) {
|
2826
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2827
|
+
.location;
|
2828
|
+
}
|
2829
|
+
/**
|
2830
|
+
* Parse the sample_query_set from SampleQuery resource.
|
2831
|
+
*
|
2832
|
+
* @param {string} sampleQueryName
|
2833
|
+
* A fully-qualified path representing SampleQuery resource.
|
2834
|
+
* @returns {string} A string representing the sample_query_set.
|
2835
|
+
*/
|
2836
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
|
2837
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2838
|
+
.sample_query_set;
|
2839
|
+
}
|
2840
|
+
/**
|
2841
|
+
* Parse the sample_query from SampleQuery resource.
|
2842
|
+
*
|
2843
|
+
* @param {string} sampleQueryName
|
2844
|
+
* A fully-qualified path representing SampleQuery resource.
|
2845
|
+
* @returns {string} A string representing the sample_query.
|
2846
|
+
*/
|
2847
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName) {
|
2848
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2849
|
+
.sample_query;
|
2850
|
+
}
|
2851
|
+
/**
|
2852
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2853
|
+
*
|
2854
|
+
* @param {string} project
|
2855
|
+
* @param {string} location
|
2856
|
+
* @param {string} sample_query_set
|
2857
|
+
* @returns {string} Resource name string.
|
2858
|
+
*/
|
2859
|
+
sampleQuerySetPath(project, location, sampleQuerySet) {
|
2860
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.render({
|
2861
|
+
project: project,
|
2862
|
+
location: location,
|
2863
|
+
sample_query_set: sampleQuerySet,
|
2864
|
+
});
|
2865
|
+
}
|
2866
|
+
/**
|
2867
|
+
* Parse the project from SampleQuerySet resource.
|
2868
|
+
*
|
2869
|
+
* @param {string} sampleQuerySetName
|
2870
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2871
|
+
* @returns {string} A string representing the project.
|
2872
|
+
*/
|
2873
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName) {
|
2874
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
|
2875
|
+
}
|
2876
|
+
/**
|
2877
|
+
* Parse the location from SampleQuerySet resource.
|
2878
|
+
*
|
2879
|
+
* @param {string} sampleQuerySetName
|
2880
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2881
|
+
* @returns {string} A string representing the location.
|
2882
|
+
*/
|
2883
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName) {
|
2884
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
|
2885
|
+
}
|
2886
|
+
/**
|
2887
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2888
|
+
*
|
2889
|
+
* @param {string} sampleQuerySetName
|
2890
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2891
|
+
* @returns {string} A string representing the sample_query_set.
|
2892
|
+
*/
|
2893
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
|
2894
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
|
2895
|
+
}
|
2739
2896
|
/**
|
2740
2897
|
* Terminate the gRPC channel and close the client.
|
2741
2898
|
*
|
@@ -1,4 +1,3 @@
|
|
1
|
-
/// <reference types="node" />
|
2
1
|
import type * as gax from 'google-gax';
|
3
2
|
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
|
4
3
|
import { Transform } from 'stream';
|
@@ -912,6 +911,39 @@ export declare class ConversationalSearchServiceClient {
|
|
912
911
|
* @returns {string} A string representing the engine.
|
913
912
|
*/
|
914
913
|
matchEngineFromEngineName(engineName: string): string | number;
|
914
|
+
/**
|
915
|
+
* Return a fully-qualified evaluation resource name string.
|
916
|
+
*
|
917
|
+
* @param {string} project
|
918
|
+
* @param {string} location
|
919
|
+
* @param {string} evaluation
|
920
|
+
* @returns {string} Resource name string.
|
921
|
+
*/
|
922
|
+
evaluationPath(project: string, location: string, evaluation: string): string;
|
923
|
+
/**
|
924
|
+
* Parse the project from Evaluation resource.
|
925
|
+
*
|
926
|
+
* @param {string} evaluationName
|
927
|
+
* A fully-qualified path representing Evaluation resource.
|
928
|
+
* @returns {string} A string representing the project.
|
929
|
+
*/
|
930
|
+
matchProjectFromEvaluationName(evaluationName: string): string | number;
|
931
|
+
/**
|
932
|
+
* Parse the location from Evaluation resource.
|
933
|
+
*
|
934
|
+
* @param {string} evaluationName
|
935
|
+
* A fully-qualified path representing Evaluation resource.
|
936
|
+
* @returns {string} A string representing the location.
|
937
|
+
*/
|
938
|
+
matchLocationFromEvaluationName(evaluationName: string): string | number;
|
939
|
+
/**
|
940
|
+
* Parse the evaluation from Evaluation resource.
|
941
|
+
*
|
942
|
+
* @param {string} evaluationName
|
943
|
+
* A fully-qualified path representing Evaluation resource.
|
944
|
+
* @returns {string} A string representing the evaluation.
|
945
|
+
*/
|
946
|
+
matchEvaluationFromEvaluationName(evaluationName: string): string | number;
|
915
947
|
/**
|
916
948
|
* Return a fully-qualified project resource name string.
|
917
949
|
*
|
@@ -2418,6 +2450,81 @@ export declare class ConversationalSearchServiceClient {
|
|
2418
2450
|
* @returns {string} A string representing the target_site.
|
2419
2451
|
*/
|
2420
2452
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
2453
|
+
/**
|
2454
|
+
* Return a fully-qualified sampleQuery resource name string.
|
2455
|
+
*
|
2456
|
+
* @param {string} project
|
2457
|
+
* @param {string} location
|
2458
|
+
* @param {string} sample_query_set
|
2459
|
+
* @param {string} sample_query
|
2460
|
+
* @returns {string} Resource name string.
|
2461
|
+
*/
|
2462
|
+
sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
|
2463
|
+
/**
|
2464
|
+
* Parse the project from SampleQuery resource.
|
2465
|
+
*
|
2466
|
+
* @param {string} sampleQueryName
|
2467
|
+
* A fully-qualified path representing SampleQuery resource.
|
2468
|
+
* @returns {string} A string representing the project.
|
2469
|
+
*/
|
2470
|
+
matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
|
2471
|
+
/**
|
2472
|
+
* Parse the location from SampleQuery resource.
|
2473
|
+
*
|
2474
|
+
* @param {string} sampleQueryName
|
2475
|
+
* A fully-qualified path representing SampleQuery resource.
|
2476
|
+
* @returns {string} A string representing the location.
|
2477
|
+
*/
|
2478
|
+
matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
|
2479
|
+
/**
|
2480
|
+
* Parse the sample_query_set from SampleQuery resource.
|
2481
|
+
*
|
2482
|
+
* @param {string} sampleQueryName
|
2483
|
+
* A fully-qualified path representing SampleQuery resource.
|
2484
|
+
* @returns {string} A string representing the sample_query_set.
|
2485
|
+
*/
|
2486
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
|
2487
|
+
/**
|
2488
|
+
* Parse the sample_query from SampleQuery resource.
|
2489
|
+
*
|
2490
|
+
* @param {string} sampleQueryName
|
2491
|
+
* A fully-qualified path representing SampleQuery resource.
|
2492
|
+
* @returns {string} A string representing the sample_query.
|
2493
|
+
*/
|
2494
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
|
2495
|
+
/**
|
2496
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2497
|
+
*
|
2498
|
+
* @param {string} project
|
2499
|
+
* @param {string} location
|
2500
|
+
* @param {string} sample_query_set
|
2501
|
+
* @returns {string} Resource name string.
|
2502
|
+
*/
|
2503
|
+
sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
|
2504
|
+
/**
|
2505
|
+
* Parse the project from SampleQuerySet resource.
|
2506
|
+
*
|
2507
|
+
* @param {string} sampleQuerySetName
|
2508
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2509
|
+
* @returns {string} A string representing the project.
|
2510
|
+
*/
|
2511
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2512
|
+
/**
|
2513
|
+
* Parse the location from SampleQuerySet resource.
|
2514
|
+
*
|
2515
|
+
* @param {string} sampleQuerySetName
|
2516
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2517
|
+
* @returns {string} A string representing the location.
|
2518
|
+
*/
|
2519
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2520
|
+
/**
|
2521
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2522
|
+
*
|
2523
|
+
* @param {string} sampleQuerySetName
|
2524
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2525
|
+
* @returns {string} A string representing the sample_query_set.
|
2526
|
+
*/
|
2527
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2421
2528
|
/**
|
2422
2529
|
* Terminate the gRPC channel and close the client.
|
2423
2530
|
*
|
@@ -152,6 +152,7 @@ class ConversationalSearchServiceClient {
|
|
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 ConversationalSearchServiceClient {
|
|
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
|
// Some of the methods on this service return "paged" results,
|
189
192
|
// (e.g. 50 results at a time, with tokens to get subsequent
|
@@ -970,6 +973,54 @@ class ConversationalSearchServiceClient {
|
|
970
973
|
matchEngineFromEngineName(engineName) {
|
971
974
|
return this.pathTemplates.enginePathTemplate.match(engineName).engine;
|
972
975
|
}
|
976
|
+
/**
|
977
|
+
* Return a fully-qualified evaluation resource name string.
|
978
|
+
*
|
979
|
+
* @param {string} project
|
980
|
+
* @param {string} location
|
981
|
+
* @param {string} evaluation
|
982
|
+
* @returns {string} Resource name string.
|
983
|
+
*/
|
984
|
+
evaluationPath(project, location, evaluation) {
|
985
|
+
return this.pathTemplates.evaluationPathTemplate.render({
|
986
|
+
project: project,
|
987
|
+
location: location,
|
988
|
+
evaluation: evaluation,
|
989
|
+
});
|
990
|
+
}
|
991
|
+
/**
|
992
|
+
* Parse the project from Evaluation resource.
|
993
|
+
*
|
994
|
+
* @param {string} evaluationName
|
995
|
+
* A fully-qualified path representing Evaluation resource.
|
996
|
+
* @returns {string} A string representing the project.
|
997
|
+
*/
|
998
|
+
matchProjectFromEvaluationName(evaluationName) {
|
999
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
1000
|
+
.project;
|
1001
|
+
}
|
1002
|
+
/**
|
1003
|
+
* Parse the location from Evaluation resource.
|
1004
|
+
*
|
1005
|
+
* @param {string} evaluationName
|
1006
|
+
* A fully-qualified path representing Evaluation resource.
|
1007
|
+
* @returns {string} A string representing the location.
|
1008
|
+
*/
|
1009
|
+
matchLocationFromEvaluationName(evaluationName) {
|
1010
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
1011
|
+
.location;
|
1012
|
+
}
|
1013
|
+
/**
|
1014
|
+
* Parse the evaluation from Evaluation resource.
|
1015
|
+
*
|
1016
|
+
* @param {string} evaluationName
|
1017
|
+
* A fully-qualified path representing Evaluation resource.
|
1018
|
+
* @returns {string} A string representing the evaluation.
|
1019
|
+
*/
|
1020
|
+
matchEvaluationFromEvaluationName(evaluationName) {
|
1021
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
1022
|
+
.evaluation;
|
1023
|
+
}
|
973
1024
|
/**
|
974
1025
|
* Return a fully-qualified project resource name string.
|
975
1026
|
*
|
@@ -3010,6 +3061,112 @@ class ConversationalSearchServiceClient {
|
|
3010
3061
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
3011
3062
|
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
|
3012
3063
|
}
|
3064
|
+
/**
|
3065
|
+
* Return a fully-qualified sampleQuery resource name string.
|
3066
|
+
*
|
3067
|
+
* @param {string} project
|
3068
|
+
* @param {string} location
|
3069
|
+
* @param {string} sample_query_set
|
3070
|
+
* @param {string} sample_query
|
3071
|
+
* @returns {string} Resource name string.
|
3072
|
+
*/
|
3073
|
+
sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
|
3074
|
+
return this.pathTemplates.sampleQueryPathTemplate.render({
|
3075
|
+
project: project,
|
3076
|
+
location: location,
|
3077
|
+
sample_query_set: sampleQuerySet,
|
3078
|
+
sample_query: sampleQuery,
|
3079
|
+
});
|
3080
|
+
}
|
3081
|
+
/**
|
3082
|
+
* Parse the project from SampleQuery resource.
|
3083
|
+
*
|
3084
|
+
* @param {string} sampleQueryName
|
3085
|
+
* A fully-qualified path representing SampleQuery resource.
|
3086
|
+
* @returns {string} A string representing the project.
|
3087
|
+
*/
|
3088
|
+
matchProjectFromSampleQueryName(sampleQueryName) {
|
3089
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
3090
|
+
.project;
|
3091
|
+
}
|
3092
|
+
/**
|
3093
|
+
* Parse the location from SampleQuery resource.
|
3094
|
+
*
|
3095
|
+
* @param {string} sampleQueryName
|
3096
|
+
* A fully-qualified path representing SampleQuery resource.
|
3097
|
+
* @returns {string} A string representing the location.
|
3098
|
+
*/
|
3099
|
+
matchLocationFromSampleQueryName(sampleQueryName) {
|
3100
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
3101
|
+
.location;
|
3102
|
+
}
|
3103
|
+
/**
|
3104
|
+
* Parse the sample_query_set from SampleQuery resource.
|
3105
|
+
*
|
3106
|
+
* @param {string} sampleQueryName
|
3107
|
+
* A fully-qualified path representing SampleQuery resource.
|
3108
|
+
* @returns {string} A string representing the sample_query_set.
|
3109
|
+
*/
|
3110
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
|
3111
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
3112
|
+
.sample_query_set;
|
3113
|
+
}
|
3114
|
+
/**
|
3115
|
+
* Parse the sample_query from SampleQuery resource.
|
3116
|
+
*
|
3117
|
+
* @param {string} sampleQueryName
|
3118
|
+
* A fully-qualified path representing SampleQuery resource.
|
3119
|
+
* @returns {string} A string representing the sample_query.
|
3120
|
+
*/
|
3121
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName) {
|
3122
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
3123
|
+
.sample_query;
|
3124
|
+
}
|
3125
|
+
/**
|
3126
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
3127
|
+
*
|
3128
|
+
* @param {string} project
|
3129
|
+
* @param {string} location
|
3130
|
+
* @param {string} sample_query_set
|
3131
|
+
* @returns {string} Resource name string.
|
3132
|
+
*/
|
3133
|
+
sampleQuerySetPath(project, location, sampleQuerySet) {
|
3134
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.render({
|
3135
|
+
project: project,
|
3136
|
+
location: location,
|
3137
|
+
sample_query_set: sampleQuerySet,
|
3138
|
+
});
|
3139
|
+
}
|
3140
|
+
/**
|
3141
|
+
* Parse the project from SampleQuerySet resource.
|
3142
|
+
*
|
3143
|
+
* @param {string} sampleQuerySetName
|
3144
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
3145
|
+
* @returns {string} A string representing the project.
|
3146
|
+
*/
|
3147
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName) {
|
3148
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
|
3149
|
+
}
|
3150
|
+
/**
|
3151
|
+
* Parse the location from SampleQuerySet resource.
|
3152
|
+
*
|
3153
|
+
* @param {string} sampleQuerySetName
|
3154
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
3155
|
+
* @returns {string} A string representing the location.
|
3156
|
+
*/
|
3157
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName) {
|
3158
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
|
3159
|
+
}
|
3160
|
+
/**
|
3161
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
3162
|
+
*
|
3163
|
+
* @param {string} sampleQuerySetName
|
3164
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
3165
|
+
* @returns {string} A string representing the sample_query_set.
|
3166
|
+
*/
|
3167
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
|
3168
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
|
3169
|
+
}
|
3013
3170
|
/**
|
3014
3171
|
* Terminate the gRPC channel and close the client.
|
3015
3172
|
*
|
@@ -1,4 +1,3 @@
|
|
1
|
-
/// <reference types="node" />
|
2
1
|
import type * as gax from 'google-gax';
|
3
2
|
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
|
4
3
|
import { Transform } from 'stream';
|
@@ -787,6 +786,39 @@ export declare class DataStoreServiceClient {
|
|
787
786
|
* @returns {string} A string representing the engine.
|
788
787
|
*/
|
789
788
|
matchEngineFromEngineName(engineName: string): string | number;
|
789
|
+
/**
|
790
|
+
* Return a fully-qualified evaluation resource name string.
|
791
|
+
*
|
792
|
+
* @param {string} project
|
793
|
+
* @param {string} location
|
794
|
+
* @param {string} evaluation
|
795
|
+
* @returns {string} Resource name string.
|
796
|
+
*/
|
797
|
+
evaluationPath(project: string, location: string, evaluation: string): string;
|
798
|
+
/**
|
799
|
+
* Parse the project from Evaluation resource.
|
800
|
+
*
|
801
|
+
* @param {string} evaluationName
|
802
|
+
* A fully-qualified path representing Evaluation resource.
|
803
|
+
* @returns {string} A string representing the project.
|
804
|
+
*/
|
805
|
+
matchProjectFromEvaluationName(evaluationName: string): string | number;
|
806
|
+
/**
|
807
|
+
* Parse the location from Evaluation resource.
|
808
|
+
*
|
809
|
+
* @param {string} evaluationName
|
810
|
+
* A fully-qualified path representing Evaluation resource.
|
811
|
+
* @returns {string} A string representing the location.
|
812
|
+
*/
|
813
|
+
matchLocationFromEvaluationName(evaluationName: string): string | number;
|
814
|
+
/**
|
815
|
+
* Parse the evaluation from Evaluation resource.
|
816
|
+
*
|
817
|
+
* @param {string} evaluationName
|
818
|
+
* A fully-qualified path representing Evaluation resource.
|
819
|
+
* @returns {string} A string representing the evaluation.
|
820
|
+
*/
|
821
|
+
matchEvaluationFromEvaluationName(evaluationName: string): string | number;
|
790
822
|
/**
|
791
823
|
* Return a fully-qualified project resource name string.
|
792
824
|
*
|
@@ -2293,6 +2325,81 @@ export declare class DataStoreServiceClient {
|
|
2293
2325
|
* @returns {string} A string representing the target_site.
|
2294
2326
|
*/
|
2295
2327
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
2328
|
+
/**
|
2329
|
+
* Return a fully-qualified sampleQuery resource name string.
|
2330
|
+
*
|
2331
|
+
* @param {string} project
|
2332
|
+
* @param {string} location
|
2333
|
+
* @param {string} sample_query_set
|
2334
|
+
* @param {string} sample_query
|
2335
|
+
* @returns {string} Resource name string.
|
2336
|
+
*/
|
2337
|
+
sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
|
2338
|
+
/**
|
2339
|
+
* Parse the project from SampleQuery resource.
|
2340
|
+
*
|
2341
|
+
* @param {string} sampleQueryName
|
2342
|
+
* A fully-qualified path representing SampleQuery resource.
|
2343
|
+
* @returns {string} A string representing the project.
|
2344
|
+
*/
|
2345
|
+
matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
|
2346
|
+
/**
|
2347
|
+
* Parse the location from SampleQuery resource.
|
2348
|
+
*
|
2349
|
+
* @param {string} sampleQueryName
|
2350
|
+
* A fully-qualified path representing SampleQuery resource.
|
2351
|
+
* @returns {string} A string representing the location.
|
2352
|
+
*/
|
2353
|
+
matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
|
2354
|
+
/**
|
2355
|
+
* Parse the sample_query_set from SampleQuery resource.
|
2356
|
+
*
|
2357
|
+
* @param {string} sampleQueryName
|
2358
|
+
* A fully-qualified path representing SampleQuery resource.
|
2359
|
+
* @returns {string} A string representing the sample_query_set.
|
2360
|
+
*/
|
2361
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
|
2362
|
+
/**
|
2363
|
+
* Parse the sample_query from SampleQuery resource.
|
2364
|
+
*
|
2365
|
+
* @param {string} sampleQueryName
|
2366
|
+
* A fully-qualified path representing SampleQuery resource.
|
2367
|
+
* @returns {string} A string representing the sample_query.
|
2368
|
+
*/
|
2369
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
|
2370
|
+
/**
|
2371
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2372
|
+
*
|
2373
|
+
* @param {string} project
|
2374
|
+
* @param {string} location
|
2375
|
+
* @param {string} sample_query_set
|
2376
|
+
* @returns {string} Resource name string.
|
2377
|
+
*/
|
2378
|
+
sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
|
2379
|
+
/**
|
2380
|
+
* Parse the project from SampleQuerySet resource.
|
2381
|
+
*
|
2382
|
+
* @param {string} sampleQuerySetName
|
2383
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2384
|
+
* @returns {string} A string representing the project.
|
2385
|
+
*/
|
2386
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2387
|
+
/**
|
2388
|
+
* Parse the location from SampleQuerySet resource.
|
2389
|
+
*
|
2390
|
+
* @param {string} sampleQuerySetName
|
2391
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2392
|
+
* @returns {string} A string representing the location.
|
2393
|
+
*/
|
2394
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2395
|
+
/**
|
2396
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2397
|
+
*
|
2398
|
+
* @param {string} sampleQuerySetName
|
2399
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2400
|
+
* @returns {string} A string representing the sample_query_set.
|
2401
|
+
*/
|
2402
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2296
2403
|
/**
|
2297
2404
|
* Terminate the gRPC channel and close the client.
|
2298
2405
|
*
|