@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
@@ -428,6 +428,39 @@ export declare class SearchTuningServiceClient {
|
|
428
428
|
* @returns {string} A string representing the engine.
|
429
429
|
*/
|
430
430
|
matchEngineFromEngineName(engineName: string): string | number;
|
431
|
+
/**
|
432
|
+
* Return a fully-qualified evaluation resource name string.
|
433
|
+
*
|
434
|
+
* @param {string} project
|
435
|
+
* @param {string} location
|
436
|
+
* @param {string} evaluation
|
437
|
+
* @returns {string} Resource name string.
|
438
|
+
*/
|
439
|
+
evaluationPath(project: string, location: string, evaluation: string): string;
|
440
|
+
/**
|
441
|
+
* Parse the project from Evaluation resource.
|
442
|
+
*
|
443
|
+
* @param {string} evaluationName
|
444
|
+
* A fully-qualified path representing Evaluation resource.
|
445
|
+
* @returns {string} A string representing the project.
|
446
|
+
*/
|
447
|
+
matchProjectFromEvaluationName(evaluationName: string): string | number;
|
448
|
+
/**
|
449
|
+
* Parse the location from Evaluation resource.
|
450
|
+
*
|
451
|
+
* @param {string} evaluationName
|
452
|
+
* A fully-qualified path representing Evaluation resource.
|
453
|
+
* @returns {string} A string representing the location.
|
454
|
+
*/
|
455
|
+
matchLocationFromEvaluationName(evaluationName: string): string | number;
|
456
|
+
/**
|
457
|
+
* Parse the evaluation from Evaluation resource.
|
458
|
+
*
|
459
|
+
* @param {string} evaluationName
|
460
|
+
* A fully-qualified path representing Evaluation resource.
|
461
|
+
* @returns {string} A string representing the evaluation.
|
462
|
+
*/
|
463
|
+
matchEvaluationFromEvaluationName(evaluationName: string): string | number;
|
431
464
|
/**
|
432
465
|
* Return a fully-qualified project resource name string.
|
433
466
|
*
|
@@ -1934,6 +1967,81 @@ export declare class SearchTuningServiceClient {
|
|
1934
1967
|
* @returns {string} A string representing the target_site.
|
1935
1968
|
*/
|
1936
1969
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1970
|
+
/**
|
1971
|
+
* Return a fully-qualified sampleQuery resource name string.
|
1972
|
+
*
|
1973
|
+
* @param {string} project
|
1974
|
+
* @param {string} location
|
1975
|
+
* @param {string} sample_query_set
|
1976
|
+
* @param {string} sample_query
|
1977
|
+
* @returns {string} Resource name string.
|
1978
|
+
*/
|
1979
|
+
sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
|
1980
|
+
/**
|
1981
|
+
* Parse the project from SampleQuery resource.
|
1982
|
+
*
|
1983
|
+
* @param {string} sampleQueryName
|
1984
|
+
* A fully-qualified path representing SampleQuery resource.
|
1985
|
+
* @returns {string} A string representing the project.
|
1986
|
+
*/
|
1987
|
+
matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
|
1988
|
+
/**
|
1989
|
+
* Parse the location from SampleQuery resource.
|
1990
|
+
*
|
1991
|
+
* @param {string} sampleQueryName
|
1992
|
+
* A fully-qualified path representing SampleQuery resource.
|
1993
|
+
* @returns {string} A string representing the location.
|
1994
|
+
*/
|
1995
|
+
matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
|
1996
|
+
/**
|
1997
|
+
* Parse the sample_query_set from SampleQuery resource.
|
1998
|
+
*
|
1999
|
+
* @param {string} sampleQueryName
|
2000
|
+
* A fully-qualified path representing SampleQuery resource.
|
2001
|
+
* @returns {string} A string representing the sample_query_set.
|
2002
|
+
*/
|
2003
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
|
2004
|
+
/**
|
2005
|
+
* Parse the sample_query from SampleQuery resource.
|
2006
|
+
*
|
2007
|
+
* @param {string} sampleQueryName
|
2008
|
+
* A fully-qualified path representing SampleQuery resource.
|
2009
|
+
* @returns {string} A string representing the sample_query.
|
2010
|
+
*/
|
2011
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
|
2012
|
+
/**
|
2013
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2014
|
+
*
|
2015
|
+
* @param {string} project
|
2016
|
+
* @param {string} location
|
2017
|
+
* @param {string} sample_query_set
|
2018
|
+
* @returns {string} Resource name string.
|
2019
|
+
*/
|
2020
|
+
sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
|
2021
|
+
/**
|
2022
|
+
* Parse the project from SampleQuerySet resource.
|
2023
|
+
*
|
2024
|
+
* @param {string} sampleQuerySetName
|
2025
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2026
|
+
* @returns {string} A string representing the project.
|
2027
|
+
*/
|
2028
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2029
|
+
/**
|
2030
|
+
* Parse the location from SampleQuerySet resource.
|
2031
|
+
*
|
2032
|
+
* @param {string} sampleQuerySetName
|
2033
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2034
|
+
* @returns {string} A string representing the location.
|
2035
|
+
*/
|
2036
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2037
|
+
/**
|
2038
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2039
|
+
*
|
2040
|
+
* @param {string} sampleQuerySetName
|
2041
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2042
|
+
* @returns {string} A string representing the sample_query_set.
|
2043
|
+
*/
|
2044
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
1937
2045
|
/**
|
1938
2046
|
* Terminate the gRPC channel and close the client.
|
1939
2047
|
*
|
@@ -151,6 +151,7 @@ class SearchTuningServiceClient {
|
|
151
151
|
this.pathTemplates = {
|
152
152
|
aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
|
153
153
|
enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
|
154
|
+
evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
|
154
155
|
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
|
155
156
|
projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
|
156
157
|
projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
@@ -183,6 +184,8 @@ class SearchTuningServiceClient {
|
|
183
184
|
projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
|
184
185
|
projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
|
185
186
|
projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
187
|
+
sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
|
188
|
+
sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
|
186
189
|
};
|
187
190
|
const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
|
188
191
|
// This API contains "long-running operations", which return a
|
@@ -755,6 +758,54 @@ class SearchTuningServiceClient {
|
|
755
758
|
matchEngineFromEngineName(engineName) {
|
756
759
|
return this.pathTemplates.enginePathTemplate.match(engineName).engine;
|
757
760
|
}
|
761
|
+
/**
|
762
|
+
* Return a fully-qualified evaluation resource name string.
|
763
|
+
*
|
764
|
+
* @param {string} project
|
765
|
+
* @param {string} location
|
766
|
+
* @param {string} evaluation
|
767
|
+
* @returns {string} Resource name string.
|
768
|
+
*/
|
769
|
+
evaluationPath(project, location, evaluation) {
|
770
|
+
return this.pathTemplates.evaluationPathTemplate.render({
|
771
|
+
project: project,
|
772
|
+
location: location,
|
773
|
+
evaluation: evaluation,
|
774
|
+
});
|
775
|
+
}
|
776
|
+
/**
|
777
|
+
* Parse the project from Evaluation resource.
|
778
|
+
*
|
779
|
+
* @param {string} evaluationName
|
780
|
+
* A fully-qualified path representing Evaluation resource.
|
781
|
+
* @returns {string} A string representing the project.
|
782
|
+
*/
|
783
|
+
matchProjectFromEvaluationName(evaluationName) {
|
784
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
785
|
+
.project;
|
786
|
+
}
|
787
|
+
/**
|
788
|
+
* Parse the location from Evaluation resource.
|
789
|
+
*
|
790
|
+
* @param {string} evaluationName
|
791
|
+
* A fully-qualified path representing Evaluation resource.
|
792
|
+
* @returns {string} A string representing the location.
|
793
|
+
*/
|
794
|
+
matchLocationFromEvaluationName(evaluationName) {
|
795
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
796
|
+
.location;
|
797
|
+
}
|
798
|
+
/**
|
799
|
+
* Parse the evaluation from Evaluation resource.
|
800
|
+
*
|
801
|
+
* @param {string} evaluationName
|
802
|
+
* A fully-qualified path representing Evaluation resource.
|
803
|
+
* @returns {string} A string representing the evaluation.
|
804
|
+
*/
|
805
|
+
matchEvaluationFromEvaluationName(evaluationName) {
|
806
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
807
|
+
.evaluation;
|
808
|
+
}
|
758
809
|
/**
|
759
810
|
* Return a fully-qualified project resource name string.
|
760
811
|
*
|
@@ -2795,6 +2846,112 @@ class SearchTuningServiceClient {
|
|
2795
2846
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
2796
2847
|
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
|
2797
2848
|
}
|
2849
|
+
/**
|
2850
|
+
* Return a fully-qualified sampleQuery resource name string.
|
2851
|
+
*
|
2852
|
+
* @param {string} project
|
2853
|
+
* @param {string} location
|
2854
|
+
* @param {string} sample_query_set
|
2855
|
+
* @param {string} sample_query
|
2856
|
+
* @returns {string} Resource name string.
|
2857
|
+
*/
|
2858
|
+
sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
|
2859
|
+
return this.pathTemplates.sampleQueryPathTemplate.render({
|
2860
|
+
project: project,
|
2861
|
+
location: location,
|
2862
|
+
sample_query_set: sampleQuerySet,
|
2863
|
+
sample_query: sampleQuery,
|
2864
|
+
});
|
2865
|
+
}
|
2866
|
+
/**
|
2867
|
+
* Parse the project from SampleQuery resource.
|
2868
|
+
*
|
2869
|
+
* @param {string} sampleQueryName
|
2870
|
+
* A fully-qualified path representing SampleQuery resource.
|
2871
|
+
* @returns {string} A string representing the project.
|
2872
|
+
*/
|
2873
|
+
matchProjectFromSampleQueryName(sampleQueryName) {
|
2874
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2875
|
+
.project;
|
2876
|
+
}
|
2877
|
+
/**
|
2878
|
+
* Parse the location from SampleQuery resource.
|
2879
|
+
*
|
2880
|
+
* @param {string} sampleQueryName
|
2881
|
+
* A fully-qualified path representing SampleQuery resource.
|
2882
|
+
* @returns {string} A string representing the location.
|
2883
|
+
*/
|
2884
|
+
matchLocationFromSampleQueryName(sampleQueryName) {
|
2885
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2886
|
+
.location;
|
2887
|
+
}
|
2888
|
+
/**
|
2889
|
+
* Parse the sample_query_set from SampleQuery resource.
|
2890
|
+
*
|
2891
|
+
* @param {string} sampleQueryName
|
2892
|
+
* A fully-qualified path representing SampleQuery resource.
|
2893
|
+
* @returns {string} A string representing the sample_query_set.
|
2894
|
+
*/
|
2895
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
|
2896
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2897
|
+
.sample_query_set;
|
2898
|
+
}
|
2899
|
+
/**
|
2900
|
+
* Parse the sample_query from SampleQuery resource.
|
2901
|
+
*
|
2902
|
+
* @param {string} sampleQueryName
|
2903
|
+
* A fully-qualified path representing SampleQuery resource.
|
2904
|
+
* @returns {string} A string representing the sample_query.
|
2905
|
+
*/
|
2906
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName) {
|
2907
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2908
|
+
.sample_query;
|
2909
|
+
}
|
2910
|
+
/**
|
2911
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2912
|
+
*
|
2913
|
+
* @param {string} project
|
2914
|
+
* @param {string} location
|
2915
|
+
* @param {string} sample_query_set
|
2916
|
+
* @returns {string} Resource name string.
|
2917
|
+
*/
|
2918
|
+
sampleQuerySetPath(project, location, sampleQuerySet) {
|
2919
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.render({
|
2920
|
+
project: project,
|
2921
|
+
location: location,
|
2922
|
+
sample_query_set: sampleQuerySet,
|
2923
|
+
});
|
2924
|
+
}
|
2925
|
+
/**
|
2926
|
+
* Parse the project from SampleQuerySet resource.
|
2927
|
+
*
|
2928
|
+
* @param {string} sampleQuerySetName
|
2929
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2930
|
+
* @returns {string} A string representing the project.
|
2931
|
+
*/
|
2932
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName) {
|
2933
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
|
2934
|
+
}
|
2935
|
+
/**
|
2936
|
+
* Parse the location from SampleQuerySet resource.
|
2937
|
+
*
|
2938
|
+
* @param {string} sampleQuerySetName
|
2939
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2940
|
+
* @returns {string} A string representing the location.
|
2941
|
+
*/
|
2942
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName) {
|
2943
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
|
2944
|
+
}
|
2945
|
+
/**
|
2946
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2947
|
+
*
|
2948
|
+
* @param {string} sampleQuerySetName
|
2949
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2950
|
+
* @returns {string} A string representing the sample_query_set.
|
2951
|
+
*/
|
2952
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
|
2953
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
|
2954
|
+
}
|
2798
2955
|
/**
|
2799
2956
|
* Terminate the gRPC channel and close the client.
|
2800
2957
|
*
|
@@ -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';
|
@@ -382,6 +381,39 @@ export declare class ServingConfigServiceClient {
|
|
382
381
|
* @returns {string} A string representing the engine.
|
383
382
|
*/
|
384
383
|
matchEngineFromEngineName(engineName: string): string | number;
|
384
|
+
/**
|
385
|
+
* Return a fully-qualified evaluation resource name string.
|
386
|
+
*
|
387
|
+
* @param {string} project
|
388
|
+
* @param {string} location
|
389
|
+
* @param {string} evaluation
|
390
|
+
* @returns {string} Resource name string.
|
391
|
+
*/
|
392
|
+
evaluationPath(project: string, location: string, evaluation: string): string;
|
393
|
+
/**
|
394
|
+
* Parse the project from Evaluation resource.
|
395
|
+
*
|
396
|
+
* @param {string} evaluationName
|
397
|
+
* A fully-qualified path representing Evaluation resource.
|
398
|
+
* @returns {string} A string representing the project.
|
399
|
+
*/
|
400
|
+
matchProjectFromEvaluationName(evaluationName: string): string | number;
|
401
|
+
/**
|
402
|
+
* Parse the location from Evaluation resource.
|
403
|
+
*
|
404
|
+
* @param {string} evaluationName
|
405
|
+
* A fully-qualified path representing Evaluation resource.
|
406
|
+
* @returns {string} A string representing the location.
|
407
|
+
*/
|
408
|
+
matchLocationFromEvaluationName(evaluationName: string): string | number;
|
409
|
+
/**
|
410
|
+
* Parse the evaluation from Evaluation resource.
|
411
|
+
*
|
412
|
+
* @param {string} evaluationName
|
413
|
+
* A fully-qualified path representing Evaluation resource.
|
414
|
+
* @returns {string} A string representing the evaluation.
|
415
|
+
*/
|
416
|
+
matchEvaluationFromEvaluationName(evaluationName: string): string | number;
|
385
417
|
/**
|
386
418
|
* Return a fully-qualified location resource name string.
|
387
419
|
*
|
@@ -1912,6 +1944,81 @@ export declare class ServingConfigServiceClient {
|
|
1912
1944
|
* @returns {string} A string representing the target_site.
|
1913
1945
|
*/
|
1914
1946
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1947
|
+
/**
|
1948
|
+
* Return a fully-qualified sampleQuery resource name string.
|
1949
|
+
*
|
1950
|
+
* @param {string} project
|
1951
|
+
* @param {string} location
|
1952
|
+
* @param {string} sample_query_set
|
1953
|
+
* @param {string} sample_query
|
1954
|
+
* @returns {string} Resource name string.
|
1955
|
+
*/
|
1956
|
+
sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
|
1957
|
+
/**
|
1958
|
+
* Parse the project from SampleQuery resource.
|
1959
|
+
*
|
1960
|
+
* @param {string} sampleQueryName
|
1961
|
+
* A fully-qualified path representing SampleQuery resource.
|
1962
|
+
* @returns {string} A string representing the project.
|
1963
|
+
*/
|
1964
|
+
matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
|
1965
|
+
/**
|
1966
|
+
* Parse the location from SampleQuery resource.
|
1967
|
+
*
|
1968
|
+
* @param {string} sampleQueryName
|
1969
|
+
* A fully-qualified path representing SampleQuery resource.
|
1970
|
+
* @returns {string} A string representing the location.
|
1971
|
+
*/
|
1972
|
+
matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
|
1973
|
+
/**
|
1974
|
+
* Parse the sample_query_set from SampleQuery resource.
|
1975
|
+
*
|
1976
|
+
* @param {string} sampleQueryName
|
1977
|
+
* A fully-qualified path representing SampleQuery resource.
|
1978
|
+
* @returns {string} A string representing the sample_query_set.
|
1979
|
+
*/
|
1980
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
|
1981
|
+
/**
|
1982
|
+
* Parse the sample_query from SampleQuery resource.
|
1983
|
+
*
|
1984
|
+
* @param {string} sampleQueryName
|
1985
|
+
* A fully-qualified path representing SampleQuery resource.
|
1986
|
+
* @returns {string} A string representing the sample_query.
|
1987
|
+
*/
|
1988
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
|
1989
|
+
/**
|
1990
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
1991
|
+
*
|
1992
|
+
* @param {string} project
|
1993
|
+
* @param {string} location
|
1994
|
+
* @param {string} sample_query_set
|
1995
|
+
* @returns {string} Resource name string.
|
1996
|
+
*/
|
1997
|
+
sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
|
1998
|
+
/**
|
1999
|
+
* Parse the project from SampleQuerySet resource.
|
2000
|
+
*
|
2001
|
+
* @param {string} sampleQuerySetName
|
2002
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2003
|
+
* @returns {string} A string representing the project.
|
2004
|
+
*/
|
2005
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2006
|
+
/**
|
2007
|
+
* Parse the location from SampleQuerySet resource.
|
2008
|
+
*
|
2009
|
+
* @param {string} sampleQuerySetName
|
2010
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2011
|
+
* @returns {string} A string representing the location.
|
2012
|
+
*/
|
2013
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
2014
|
+
/**
|
2015
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2016
|
+
*
|
2017
|
+
* @param {string} sampleQuerySetName
|
2018
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2019
|
+
* @returns {string} A string representing the sample_query_set.
|
2020
|
+
*/
|
2021
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
|
1915
2022
|
/**
|
1916
2023
|
* Terminate the gRPC channel and close the client.
|
1917
2024
|
*
|
@@ -152,6 +152,7 @@ class ServingConfigServiceClient {
|
|
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
|
locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
|
156
157
|
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
|
157
158
|
projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
|
@@ -185,6 +186,8 @@ class ServingConfigServiceClient {
|
|
185
186
|
projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
|
186
187
|
projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
|
187
188
|
projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
189
|
+
sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
|
190
|
+
sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
|
188
191
|
};
|
189
192
|
// Some of the methods on this service return "paged" results,
|
190
193
|
// (e.g. 50 results at a time, with tokens to get subsequent
|
@@ -603,6 +606,54 @@ class ServingConfigServiceClient {
|
|
603
606
|
matchEngineFromEngineName(engineName) {
|
604
607
|
return this.pathTemplates.enginePathTemplate.match(engineName).engine;
|
605
608
|
}
|
609
|
+
/**
|
610
|
+
* Return a fully-qualified evaluation resource name string.
|
611
|
+
*
|
612
|
+
* @param {string} project
|
613
|
+
* @param {string} location
|
614
|
+
* @param {string} evaluation
|
615
|
+
* @returns {string} Resource name string.
|
616
|
+
*/
|
617
|
+
evaluationPath(project, location, evaluation) {
|
618
|
+
return this.pathTemplates.evaluationPathTemplate.render({
|
619
|
+
project: project,
|
620
|
+
location: location,
|
621
|
+
evaluation: evaluation,
|
622
|
+
});
|
623
|
+
}
|
624
|
+
/**
|
625
|
+
* Parse the project from Evaluation resource.
|
626
|
+
*
|
627
|
+
* @param {string} evaluationName
|
628
|
+
* A fully-qualified path representing Evaluation resource.
|
629
|
+
* @returns {string} A string representing the project.
|
630
|
+
*/
|
631
|
+
matchProjectFromEvaluationName(evaluationName) {
|
632
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
633
|
+
.project;
|
634
|
+
}
|
635
|
+
/**
|
636
|
+
* Parse the location from Evaluation resource.
|
637
|
+
*
|
638
|
+
* @param {string} evaluationName
|
639
|
+
* A fully-qualified path representing Evaluation resource.
|
640
|
+
* @returns {string} A string representing the location.
|
641
|
+
*/
|
642
|
+
matchLocationFromEvaluationName(evaluationName) {
|
643
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
644
|
+
.location;
|
645
|
+
}
|
646
|
+
/**
|
647
|
+
* Parse the evaluation from Evaluation resource.
|
648
|
+
*
|
649
|
+
* @param {string} evaluationName
|
650
|
+
* A fully-qualified path representing Evaluation resource.
|
651
|
+
* @returns {string} A string representing the evaluation.
|
652
|
+
*/
|
653
|
+
matchEvaluationFromEvaluationName(evaluationName) {
|
654
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
655
|
+
.evaluation;
|
656
|
+
}
|
606
657
|
/**
|
607
658
|
* Return a fully-qualified location resource name string.
|
608
659
|
*
|
@@ -2676,6 +2727,112 @@ class ServingConfigServiceClient {
|
|
2676
2727
|
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
2677
2728
|
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
|
2678
2729
|
}
|
2730
|
+
/**
|
2731
|
+
* Return a fully-qualified sampleQuery resource name string.
|
2732
|
+
*
|
2733
|
+
* @param {string} project
|
2734
|
+
* @param {string} location
|
2735
|
+
* @param {string} sample_query_set
|
2736
|
+
* @param {string} sample_query
|
2737
|
+
* @returns {string} Resource name string.
|
2738
|
+
*/
|
2739
|
+
sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
|
2740
|
+
return this.pathTemplates.sampleQueryPathTemplate.render({
|
2741
|
+
project: project,
|
2742
|
+
location: location,
|
2743
|
+
sample_query_set: sampleQuerySet,
|
2744
|
+
sample_query: sampleQuery,
|
2745
|
+
});
|
2746
|
+
}
|
2747
|
+
/**
|
2748
|
+
* Parse the project from SampleQuery resource.
|
2749
|
+
*
|
2750
|
+
* @param {string} sampleQueryName
|
2751
|
+
* A fully-qualified path representing SampleQuery resource.
|
2752
|
+
* @returns {string} A string representing the project.
|
2753
|
+
*/
|
2754
|
+
matchProjectFromSampleQueryName(sampleQueryName) {
|
2755
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2756
|
+
.project;
|
2757
|
+
}
|
2758
|
+
/**
|
2759
|
+
* Parse the location from SampleQuery resource.
|
2760
|
+
*
|
2761
|
+
* @param {string} sampleQueryName
|
2762
|
+
* A fully-qualified path representing SampleQuery resource.
|
2763
|
+
* @returns {string} A string representing the location.
|
2764
|
+
*/
|
2765
|
+
matchLocationFromSampleQueryName(sampleQueryName) {
|
2766
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2767
|
+
.location;
|
2768
|
+
}
|
2769
|
+
/**
|
2770
|
+
* Parse the sample_query_set from SampleQuery resource.
|
2771
|
+
*
|
2772
|
+
* @param {string} sampleQueryName
|
2773
|
+
* A fully-qualified path representing SampleQuery resource.
|
2774
|
+
* @returns {string} A string representing the sample_query_set.
|
2775
|
+
*/
|
2776
|
+
matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
|
2777
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2778
|
+
.sample_query_set;
|
2779
|
+
}
|
2780
|
+
/**
|
2781
|
+
* Parse the sample_query from SampleQuery resource.
|
2782
|
+
*
|
2783
|
+
* @param {string} sampleQueryName
|
2784
|
+
* A fully-qualified path representing SampleQuery resource.
|
2785
|
+
* @returns {string} A string representing the sample_query.
|
2786
|
+
*/
|
2787
|
+
matchSampleQueryFromSampleQueryName(sampleQueryName) {
|
2788
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2789
|
+
.sample_query;
|
2790
|
+
}
|
2791
|
+
/**
|
2792
|
+
* Return a fully-qualified sampleQuerySet resource name string.
|
2793
|
+
*
|
2794
|
+
* @param {string} project
|
2795
|
+
* @param {string} location
|
2796
|
+
* @param {string} sample_query_set
|
2797
|
+
* @returns {string} Resource name string.
|
2798
|
+
*/
|
2799
|
+
sampleQuerySetPath(project, location, sampleQuerySet) {
|
2800
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.render({
|
2801
|
+
project: project,
|
2802
|
+
location: location,
|
2803
|
+
sample_query_set: sampleQuerySet,
|
2804
|
+
});
|
2805
|
+
}
|
2806
|
+
/**
|
2807
|
+
* Parse the project from SampleQuerySet resource.
|
2808
|
+
*
|
2809
|
+
* @param {string} sampleQuerySetName
|
2810
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2811
|
+
* @returns {string} A string representing the project.
|
2812
|
+
*/
|
2813
|
+
matchProjectFromSampleQuerySetName(sampleQuerySetName) {
|
2814
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
|
2815
|
+
}
|
2816
|
+
/**
|
2817
|
+
* Parse the location from SampleQuerySet resource.
|
2818
|
+
*
|
2819
|
+
* @param {string} sampleQuerySetName
|
2820
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2821
|
+
* @returns {string} A string representing the location.
|
2822
|
+
*/
|
2823
|
+
matchLocationFromSampleQuerySetName(sampleQuerySetName) {
|
2824
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
|
2825
|
+
}
|
2826
|
+
/**
|
2827
|
+
* Parse the sample_query_set from SampleQuerySet resource.
|
2828
|
+
*
|
2829
|
+
* @param {string} sampleQuerySetName
|
2830
|
+
* A fully-qualified path representing SampleQuerySet resource.
|
2831
|
+
* @returns {string} A string representing the sample_query_set.
|
2832
|
+
*/
|
2833
|
+
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
|
2834
|
+
return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
|
2835
|
+
}
|
2679
2836
|
/**
|
2680
2837
|
* Terminate the gRPC channel and close the client.
|
2681
2838
|
*
|