@google-cloud/discoveryengine 2.3.0 → 2.5.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/README.md +20 -0
- package/build/protos/google/cloud/discoveryengine/v1/assist_answer.proto +251 -0
- package/build/protos/google/cloud/discoveryengine/v1/assistant.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1/assistant_service.proto +217 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +15 -3
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +160 -14
- package/build/protos/google/cloud/discoveryengine/v1/session.proto +21 -8
- package/build/protos/google/cloud/discoveryengine/v1/session_service.proto +128 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +15 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +30 -9
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +136 -18
- package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +238 -8
- package/build/protos/google/cloud/discoveryengine/v1alpha/session_service.proto +201 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +26 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +136 -18
- package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +40 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/session_service.proto +128 -0
- package/build/protos/protos.d.ts +15854 -10608
- package/build/protos/protos.js +47009 -33222
- package/build/protos/protos.json +5357 -3208
- package/build/src/index.d.ts +7 -1
- package/build/src/index.js +6 -2
- package/build/src/v1/assistant_service_client.d.ts +2058 -0
- package/build/src/v1/assistant_service_client.js +2957 -0
- package/build/src/v1/assistant_service_client_config.json +43 -0
- package/build/src/v1/assistant_service_proto_list.json +48 -0
- package/build/src/v1/cmek_config_service_client.d.ts +255 -144
- package/build/src/v1/cmek_config_service_client.js +348 -196
- package/build/src/v1/cmek_config_service_proto_list.json +4 -0
- package/build/src/v1/completion_service_client.d.ts +255 -144
- package/build/src/v1/completion_service_client.js +348 -196
- package/build/src/v1/completion_service_proto_list.json +4 -0
- package/build/src/v1/control_service_client.d.ts +255 -144
- package/build/src/v1/control_service_client.js +348 -196
- package/build/src/v1/control_service_proto_list.json +4 -0
- package/build/src/v1/conversational_search_service_client.d.ts +302 -155
- package/build/src/v1/conversational_search_service_client.js +380 -204
- package/build/src/v1/conversational_search_service_proto_list.json +4 -0
- package/build/src/v1/data_store_service_client.d.ts +255 -144
- package/build/src/v1/data_store_service_client.js +348 -196
- package/build/src/v1/data_store_service_proto_list.json +4 -0
- package/build/src/v1/document_service_client.d.ts +255 -144
- package/build/src/v1/document_service_client.js +348 -196
- package/build/src/v1/document_service_proto_list.json +4 -0
- package/build/src/v1/engine_service_client.d.ts +255 -144
- package/build/src/v1/engine_service_client.js +348 -196
- package/build/src/v1/engine_service_proto_list.json +4 -0
- package/build/src/v1/gapic_metadata.json +86 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +255 -144
- package/build/src/v1/grounded_generation_service_client.js +348 -196
- package/build/src/v1/grounded_generation_service_proto_list.json +4 -0
- package/build/src/v1/identity_mapping_store_service_client.d.ts +255 -144
- package/build/src/v1/identity_mapping_store_service_client.js +353 -201
- package/build/src/v1/identity_mapping_store_service_proto_list.json +4 -0
- package/build/src/v1/index.d.ts +2 -0
- package/build/src/v1/index.js +5 -1
- package/build/src/v1/project_service_client.d.ts +255 -144
- package/build/src/v1/project_service_client.js +348 -196
- package/build/src/v1/project_service_proto_list.json +4 -0
- package/build/src/v1/rank_service_client.d.ts +255 -144
- package/build/src/v1/rank_service_client.js +348 -196
- package/build/src/v1/rank_service_proto_list.json +4 -0
- package/build/src/v1/recommendation_service_client.d.ts +255 -144
- package/build/src/v1/recommendation_service_client.js +348 -196
- package/build/src/v1/recommendation_service_proto_list.json +4 -0
- package/build/src/v1/schema_service_client.d.ts +255 -144
- package/build/src/v1/schema_service_client.js +348 -196
- package/build/src/v1/schema_service_proto_list.json +4 -0
- package/build/src/v1/search_service_client.d.ts +861 -228
- package/build/src/v1/search_service_client.js +752 -252
- package/build/src/v1/search_service_proto_list.json +4 -0
- package/build/src/v1/search_tuning_service_client.d.ts +255 -144
- package/build/src/v1/search_tuning_service_client.js +348 -196
- package/build/src/v1/search_tuning_service_proto_list.json +4 -0
- package/build/src/v1/serving_config_service_client.d.ts +255 -144
- package/build/src/v1/serving_config_service_client.js +348 -196
- package/build/src/v1/serving_config_service_proto_list.json +4 -0
- package/build/src/v1/session_service_client.d.ts +2326 -0
- package/build/src/v1/session_service_client.js +3218 -0
- package/build/src/v1/session_service_client_config.json +63 -0
- package/build/src/v1/session_service_proto_list.json +48 -0
- package/build/src/v1/site_search_engine_service_client.d.ts +255 -144
- package/build/src/v1/site_search_engine_service_client.js +348 -196
- package/build/src/v1/site_search_engine_service_proto_list.json +4 -0
- package/build/src/v1/user_event_service_client.d.ts +255 -144
- package/build/src/v1/user_event_service_client.js +348 -196
- package/build/src/v1/user_event_service_proto_list.json +4 -0
- package/build/src/v1/user_license_service_client.d.ts +255 -144
- package/build/src/v1/user_license_service_client.js +348 -196
- package/build/src/v1/user_license_service_proto_list.json +4 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +144 -144
- package/build/src/v1alpha/acl_config_service_client.js +196 -196
- package/build/src/v1alpha/acl_config_service_proto_list.json +1 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +144 -144
- package/build/src/v1alpha/chunk_service_client.js +196 -196
- package/build/src/v1alpha/chunk_service_proto_list.json +1 -0
- package/build/src/v1alpha/completion_service_client.d.ts +144 -144
- package/build/src/v1alpha/completion_service_client.js +196 -196
- package/build/src/v1alpha/completion_service_proto_list.json +1 -0
- package/build/src/v1alpha/control_service_client.d.ts +144 -144
- package/build/src/v1alpha/control_service_client.js +196 -196
- package/build/src/v1alpha/control_service_proto_list.json +1 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +221 -167
- package/build/src/v1alpha/conversational_search_service_client.js +244 -210
- package/build/src/v1alpha/conversational_search_service_proto_list.json +1 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +144 -144
- package/build/src/v1alpha/data_store_service_client.js +196 -196
- package/build/src/v1alpha/data_store_service_proto_list.json +1 -0
- package/build/src/v1alpha/document_service_client.d.ts +144 -144
- package/build/src/v1alpha/document_service_client.js +196 -196
- package/build/src/v1alpha/document_service_proto_list.json +1 -0
- package/build/src/v1alpha/engine_service_client.d.ts +144 -144
- package/build/src/v1alpha/engine_service_client.js +196 -196
- package/build/src/v1alpha/engine_service_proto_list.json +1 -0
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +144 -144
- package/build/src/v1alpha/estimate_billing_service_client.js +196 -196
- package/build/src/v1alpha/estimate_billing_service_proto_list.json +1 -0
- package/build/src/v1alpha/evaluation_service_client.d.ts +144 -144
- package/build/src/v1alpha/evaluation_service_client.js +196 -196
- package/build/src/v1alpha/evaluation_service_proto_list.json +1 -0
- package/build/src/v1alpha/gapic_metadata.json +82 -0
- package/build/src/v1alpha/grounded_generation_service_client.d.ts +144 -144
- package/build/src/v1alpha/grounded_generation_service_client.js +196 -196
- package/build/src/v1alpha/grounded_generation_service_proto_list.json +1 -0
- package/build/src/v1alpha/index.d.ts +1 -0
- package/build/src/v1alpha/index.js +3 -1
- package/build/src/v1alpha/project_service_client.d.ts +144 -144
- package/build/src/v1alpha/project_service_client.js +196 -196
- package/build/src/v1alpha/project_service_proto_list.json +1 -0
- package/build/src/v1alpha/rank_service_client.d.ts +144 -144
- package/build/src/v1alpha/rank_service_client.js +196 -196
- package/build/src/v1alpha/rank_service_proto_list.json +1 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +144 -144
- package/build/src/v1alpha/recommendation_service_client.js +196 -196
- package/build/src/v1alpha/recommendation_service_proto_list.json +1 -0
- package/build/src/v1alpha/sample_query_service_client.d.ts +144 -144
- package/build/src/v1alpha/sample_query_service_client.js +196 -196
- package/build/src/v1alpha/sample_query_service_proto_list.json +1 -0
- package/build/src/v1alpha/sample_query_set_service_client.d.ts +144 -144
- package/build/src/v1alpha/sample_query_set_service_client.js +196 -196
- package/build/src/v1alpha/sample_query_set_service_proto_list.json +1 -0
- package/build/src/v1alpha/schema_service_client.d.ts +144 -144
- package/build/src/v1alpha/schema_service_client.js +196 -196
- package/build/src/v1alpha/schema_service_proto_list.json +1 -0
- package/build/src/v1alpha/search_service_client.d.ts +378 -198
- package/build/src/v1alpha/search_service_client.js +352 -232
- package/build/src/v1alpha/search_service_proto_list.json +1 -0
- package/build/src/v1alpha/search_tuning_service_client.d.ts +144 -144
- package/build/src/v1alpha/search_tuning_service_client.js +196 -196
- package/build/src/v1alpha/search_tuning_service_proto_list.json +1 -0
- package/build/src/v1alpha/serving_config_service_client.d.ts +144 -144
- package/build/src/v1alpha/serving_config_service_client.js +196 -196
- package/build/src/v1alpha/serving_config_service_proto_list.json +1 -0
- package/build/src/v1alpha/session_service_client.d.ts +2331 -0
- package/build/src/v1alpha/session_service_client.js +3161 -0
- package/build/src/v1alpha/session_service_client_config.json +68 -0
- package/build/src/v1alpha/session_service_proto_list.json +49 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +144 -144
- package/build/src/v1alpha/site_search_engine_service_client.js +196 -196
- package/build/src/v1alpha/site_search_engine_service_proto_list.json +1 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +144 -144
- package/build/src/v1alpha/user_event_service_client.js +196 -196
- package/build/src/v1alpha/user_event_service_proto_list.json +1 -0
- package/build/src/v1beta/completion_service_client.d.ts +144 -144
- package/build/src/v1beta/completion_service_client.js +196 -196
- package/build/src/v1beta/completion_service_proto_list.json +1 -0
- package/build/src/v1beta/control_service_client.d.ts +144 -144
- package/build/src/v1beta/control_service_client.js +196 -196
- package/build/src/v1beta/control_service_proto_list.json +1 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +215 -161
- package/build/src/v1beta/conversational_search_service_client.js +242 -208
- package/build/src/v1beta/conversational_search_service_proto_list.json +1 -0
- package/build/src/v1beta/data_store_service_client.d.ts +144 -144
- package/build/src/v1beta/data_store_service_client.js +196 -196
- package/build/src/v1beta/data_store_service_proto_list.json +1 -0
- package/build/src/v1beta/document_service_client.d.ts +144 -144
- package/build/src/v1beta/document_service_client.js +196 -196
- package/build/src/v1beta/document_service_proto_list.json +1 -0
- package/build/src/v1beta/engine_service_client.d.ts +144 -144
- package/build/src/v1beta/engine_service_client.js +196 -196
- package/build/src/v1beta/engine_service_proto_list.json +1 -0
- package/build/src/v1beta/evaluation_service_client.d.ts +144 -144
- package/build/src/v1beta/evaluation_service_client.js +196 -196
- package/build/src/v1beta/evaluation_service_proto_list.json +1 -0
- package/build/src/v1beta/gapic_metadata.json +68 -0
- package/build/src/v1beta/grounded_generation_service_client.d.ts +144 -144
- package/build/src/v1beta/grounded_generation_service_client.js +196 -196
- package/build/src/v1beta/grounded_generation_service_proto_list.json +1 -0
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/project_service_client.d.ts +144 -144
- package/build/src/v1beta/project_service_client.js +196 -196
- package/build/src/v1beta/project_service_proto_list.json +1 -0
- package/build/src/v1beta/rank_service_client.d.ts +144 -144
- package/build/src/v1beta/rank_service_client.js +196 -196
- package/build/src/v1beta/rank_service_proto_list.json +1 -0
- package/build/src/v1beta/recommendation_service_client.d.ts +144 -144
- package/build/src/v1beta/recommendation_service_client.js +196 -196
- package/build/src/v1beta/recommendation_service_proto_list.json +1 -0
- package/build/src/v1beta/sample_query_service_client.d.ts +144 -144
- package/build/src/v1beta/sample_query_service_client.js +196 -196
- package/build/src/v1beta/sample_query_service_proto_list.json +1 -0
- package/build/src/v1beta/sample_query_set_service_client.d.ts +144 -144
- package/build/src/v1beta/sample_query_set_service_client.js +196 -196
- package/build/src/v1beta/sample_query_set_service_proto_list.json +1 -0
- package/build/src/v1beta/schema_service_client.d.ts +144 -144
- package/build/src/v1beta/schema_service_client.js +196 -196
- package/build/src/v1beta/schema_service_proto_list.json +1 -0
- package/build/src/v1beta/search_service_client.d.ts +612 -252
- package/build/src/v1beta/search_service_client.js +508 -268
- package/build/src/v1beta/search_service_proto_list.json +1 -0
- package/build/src/v1beta/search_tuning_service_client.d.ts +144 -144
- package/build/src/v1beta/search_tuning_service_client.js +196 -196
- package/build/src/v1beta/search_tuning_service_proto_list.json +1 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +144 -144
- package/build/src/v1beta/serving_config_service_client.js +196 -196
- package/build/src/v1beta/serving_config_service_proto_list.json +1 -0
- package/build/src/v1beta/session_service_client.d.ts +2266 -0
- package/build/src/v1beta/session_service_client.js +3136 -0
- package/build/src/v1beta/session_service_client_config.json +63 -0
- package/build/src/v1beta/session_service_proto_list.json +45 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +144 -144
- package/build/src/v1beta/site_search_engine_service_client.js +196 -196
- package/build/src/v1beta/site_search_engine_service_proto_list.json +1 -0
- package/build/src/v1beta/user_event_service_client.d.ts +144 -144
- package/build/src/v1beta/user_event_service_client.js +196 -196
- package/build/src/v1beta/user_event_service_proto_list.json +1 -0
- package/package.json +1 -1
@@ -176,15 +176,15 @@ class SearchServiceClient {
|
|
176
176
|
projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
|
177
177
|
projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
|
178
178
|
projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
|
179
|
-
projectLocationCollectionDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
|
180
179
|
projectLocationCollectionDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
|
180
|
+
projectLocationCollectionDataStoreSessionsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
|
181
181
|
projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
|
182
182
|
projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
183
183
|
projectLocationCollectionEngineControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/controls/{control}'),
|
184
184
|
projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
|
185
185
|
projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
|
186
|
-
projectLocationCollectionEngineSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}'),
|
187
186
|
projectLocationCollectionEngineSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}'),
|
187
|
+
projectLocationCollectionEngineSessionsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}'),
|
188
188
|
projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
|
189
189
|
projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
|
190
190
|
projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
@@ -195,8 +195,8 @@ class SearchServiceClient {
|
|
195
195
|
projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
|
196
196
|
projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
|
197
197
|
projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
|
198
|
-
projectLocationDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
|
199
198
|
projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
|
199
|
+
projectLocationDataStoreSessionsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
|
200
200
|
projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
|
201
201
|
projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
202
202
|
sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
|
@@ -526,8 +526,14 @@ class SearchServiceClient {
|
|
526
526
|
* The ranking expression controls the customized ranking on retrieval
|
527
527
|
* documents. This overrides
|
528
528
|
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
529
|
-
* The
|
530
|
-
*
|
529
|
+
* The syntax and supported features depend on the
|
530
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
531
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
532
|
+
*
|
533
|
+
* If
|
534
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
535
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
536
|
+
* function or multiple functions that are joined by "+".
|
531
537
|
*
|
532
538
|
* * ranking_expression = function, { " + ", function };
|
533
539
|
*
|
@@ -542,13 +548,73 @@ class SearchServiceClient {
|
|
542
548
|
* between query and document.
|
543
549
|
* * `embedding_field_path`: the document embedding field
|
544
550
|
* used with query embedding vector.
|
545
|
-
* * `dotProduct`: embedding function between embedding_field_path and
|
546
|
-
* embedding vector.
|
551
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
552
|
+
* query embedding vector.
|
547
553
|
*
|
548
554
|
* Example ranking expression:
|
549
555
|
*
|
550
556
|
* If document has an embedding field doc_embedding, the ranking expression
|
551
557
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
558
|
+
*
|
559
|
+
* If
|
560
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
561
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
562
|
+
* combinations of those chained using + or
|
563
|
+
* * operators) are supported:
|
564
|
+
*
|
565
|
+
* * `double`
|
566
|
+
* * `signal`
|
567
|
+
* * `log(signal)`
|
568
|
+
* * `exp(signal)`
|
569
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
570
|
+
* argument being a denominator constant.
|
571
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
572
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
573
|
+
* signal2 | double, else returns signal1.
|
574
|
+
*
|
575
|
+
* Here are a few examples of ranking formulas that use the supported
|
576
|
+
* ranking expression types:
|
577
|
+
*
|
578
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
579
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
580
|
+
* `semantic_smilarity_score` adjustment.
|
581
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
582
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
583
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
584
|
+
* add constant 0.3 adjustment to the final score if
|
585
|
+
* `semantic_similarity_score` is NaN.
|
586
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
587
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
588
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
589
|
+
* of `semantic_smilarity_score`.
|
590
|
+
*
|
591
|
+
* The following signals are supported:
|
592
|
+
*
|
593
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
594
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
595
|
+
* This score determines how semantically similar a search query is to a
|
596
|
+
* document.
|
597
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
598
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
599
|
+
* probabilistic model to estimate the probability that a document is
|
600
|
+
* relevant to a given query.
|
601
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
602
|
+
* proprietary Google model to determine the meaning and intent behind a
|
603
|
+
* user's query in context with the content in the documents.
|
604
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
605
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
606
|
+
* attractiveness of a search result from a user's perspective. A higher
|
607
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
608
|
+
* and intent, making it a valuable signal for ranking.
|
609
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
610
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
611
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
612
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
613
|
+
* Google model to determine the keyword-based overlap between the query and
|
614
|
+
* the document.
|
615
|
+
* * `base_rank`: the default rank of the result
|
616
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
617
|
+
* The backend to use for the ranking expression evaluation.
|
552
618
|
* @param {boolean} request.safeSearch
|
553
619
|
* Whether to turn on safe search. This is only supported for
|
554
620
|
* website search.
|
@@ -588,22 +654,16 @@ class SearchServiceClient {
|
|
588
654
|
* between /search API calls and /answer API calls.
|
589
655
|
*
|
590
656
|
* Example #1 (multi-turn /search API calls):
|
591
|
-
*
|
592
|
-
*
|
593
|
-
*
|
594
|
-
*
|
595
|
-
*
|
596
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
657
|
+
* Call /search API with the session ID generated in the first call.
|
658
|
+
* Here, the previous search query gets considered in query
|
659
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
660
|
+
* and the current query is "How about 2023?", the current query will
|
661
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
597
662
|
*
|
598
663
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
599
|
-
*
|
600
|
-
*
|
601
|
-
*
|
602
|
-
* results from the first search call.
|
603
|
-
*
|
604
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
605
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
606
|
-
* to create a session manually.
|
664
|
+
* Call /answer API with the session ID generated in the first call.
|
665
|
+
* Here, the answer generation happens in the context of the search
|
666
|
+
* results from the first search call.
|
607
667
|
*
|
608
668
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
609
669
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -821,8 +881,14 @@ class SearchServiceClient {
|
|
821
881
|
* The ranking expression controls the customized ranking on retrieval
|
822
882
|
* documents. This overrides
|
823
883
|
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
824
|
-
* The
|
825
|
-
*
|
884
|
+
* The syntax and supported features depend on the
|
885
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
886
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
887
|
+
*
|
888
|
+
* If
|
889
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
890
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
891
|
+
* function or multiple functions that are joined by "+".
|
826
892
|
*
|
827
893
|
* * ranking_expression = function, { " + ", function };
|
828
894
|
*
|
@@ -837,13 +903,73 @@ class SearchServiceClient {
|
|
837
903
|
* between query and document.
|
838
904
|
* * `embedding_field_path`: the document embedding field
|
839
905
|
* used with query embedding vector.
|
840
|
-
* * `dotProduct`: embedding function between embedding_field_path and
|
841
|
-
* embedding vector.
|
906
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
907
|
+
* query embedding vector.
|
842
908
|
*
|
843
909
|
* Example ranking expression:
|
844
910
|
*
|
845
911
|
* If document has an embedding field doc_embedding, the ranking expression
|
846
912
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
913
|
+
*
|
914
|
+
* If
|
915
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
916
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
917
|
+
* combinations of those chained using + or
|
918
|
+
* * operators) are supported:
|
919
|
+
*
|
920
|
+
* * `double`
|
921
|
+
* * `signal`
|
922
|
+
* * `log(signal)`
|
923
|
+
* * `exp(signal)`
|
924
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
925
|
+
* argument being a denominator constant.
|
926
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
927
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
928
|
+
* signal2 | double, else returns signal1.
|
929
|
+
*
|
930
|
+
* Here are a few examples of ranking formulas that use the supported
|
931
|
+
* ranking expression types:
|
932
|
+
*
|
933
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
934
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
935
|
+
* `semantic_smilarity_score` adjustment.
|
936
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
937
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
938
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
939
|
+
* add constant 0.3 adjustment to the final score if
|
940
|
+
* `semantic_similarity_score` is NaN.
|
941
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
942
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
943
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
944
|
+
* of `semantic_smilarity_score`.
|
945
|
+
*
|
946
|
+
* The following signals are supported:
|
947
|
+
*
|
948
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
949
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
950
|
+
* This score determines how semantically similar a search query is to a
|
951
|
+
* document.
|
952
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
953
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
954
|
+
* probabilistic model to estimate the probability that a document is
|
955
|
+
* relevant to a given query.
|
956
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
957
|
+
* proprietary Google model to determine the meaning and intent behind a
|
958
|
+
* user's query in context with the content in the documents.
|
959
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
960
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
961
|
+
* attractiveness of a search result from a user's perspective. A higher
|
962
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
963
|
+
* and intent, making it a valuable signal for ranking.
|
964
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
965
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
966
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
967
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
968
|
+
* Google model to determine the keyword-based overlap between the query and
|
969
|
+
* the document.
|
970
|
+
* * `base_rank`: the default rank of the result
|
971
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
972
|
+
* The backend to use for the ranking expression evaluation.
|
847
973
|
* @param {boolean} request.safeSearch
|
848
974
|
* Whether to turn on safe search. This is only supported for
|
849
975
|
* website search.
|
@@ -883,22 +1009,16 @@ class SearchServiceClient {
|
|
883
1009
|
* between /search API calls and /answer API calls.
|
884
1010
|
*
|
885
1011
|
* Example #1 (multi-turn /search API calls):
|
886
|
-
*
|
887
|
-
*
|
888
|
-
*
|
889
|
-
*
|
890
|
-
*
|
891
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
1012
|
+
* Call /search API with the session ID generated in the first call.
|
1013
|
+
* Here, the previous search query gets considered in query
|
1014
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
1015
|
+
* and the current query is "How about 2023?", the current query will
|
1016
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
892
1017
|
*
|
893
1018
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
894
|
-
*
|
895
|
-
*
|
896
|
-
*
|
897
|
-
* results from the first search call.
|
898
|
-
*
|
899
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
900
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
901
|
-
* to create a session manually.
|
1019
|
+
* Call /answer API with the session ID generated in the first call.
|
1020
|
+
* Here, the answer generation happens in the context of the search
|
1021
|
+
* results from the first search call.
|
902
1022
|
*
|
903
1023
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
904
1024
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -1856,154 +1976,154 @@ class SearchServiceClient {
|
|
1856
1976
|
return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
|
1857
1977
|
}
|
1858
1978
|
/**
|
1859
|
-
* Return a fully-qualified
|
1979
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
|
1860
1980
|
*
|
1861
1981
|
* @param {string} project
|
1862
1982
|
* @param {string} location
|
1863
1983
|
* @param {string} collection
|
1864
1984
|
* @param {string} data_store
|
1865
1985
|
* @param {string} session
|
1986
|
+
* @param {string} answer
|
1866
1987
|
* @returns {string} Resource name string.
|
1867
1988
|
*/
|
1868
|
-
|
1869
|
-
return this.pathTemplates.
|
1989
|
+
projectLocationCollectionDataStoreSessionAnswerPath(project, location, collection, dataStore, session, answer) {
|
1990
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.render({
|
1870
1991
|
project: project,
|
1871
1992
|
location: location,
|
1872
1993
|
collection: collection,
|
1873
1994
|
data_store: dataStore,
|
1874
1995
|
session: session,
|
1996
|
+
answer: answer,
|
1875
1997
|
});
|
1876
1998
|
}
|
1877
1999
|
/**
|
1878
|
-
* Parse the project from
|
2000
|
+
* Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.
|
1879
2001
|
*
|
1880
|
-
* @param {string}
|
1881
|
-
* A fully-qualified path representing
|
2002
|
+
* @param {string} projectLocationCollectionDataStoreSessionAnswerName
|
2003
|
+
* A fully-qualified path representing project_location_collection_data_store_session_answer resource.
|
1882
2004
|
* @returns {string} A string representing the project.
|
1883
2005
|
*/
|
1884
|
-
|
1885
|
-
return this.pathTemplates.
|
2006
|
+
matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
|
2007
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).project;
|
1886
2008
|
}
|
1887
2009
|
/**
|
1888
|
-
* Parse the location from
|
2010
|
+
* Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.
|
1889
2011
|
*
|
1890
|
-
* @param {string}
|
1891
|
-
* A fully-qualified path representing
|
2012
|
+
* @param {string} projectLocationCollectionDataStoreSessionAnswerName
|
2013
|
+
* A fully-qualified path representing project_location_collection_data_store_session_answer resource.
|
1892
2014
|
* @returns {string} A string representing the location.
|
1893
2015
|
*/
|
1894
|
-
|
1895
|
-
return this.pathTemplates.
|
2016
|
+
matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
|
2017
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).location;
|
1896
2018
|
}
|
1897
2019
|
/**
|
1898
|
-
* Parse the collection from
|
2020
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.
|
1899
2021
|
*
|
1900
|
-
* @param {string}
|
1901
|
-
* A fully-qualified path representing
|
2022
|
+
* @param {string} projectLocationCollectionDataStoreSessionAnswerName
|
2023
|
+
* A fully-qualified path representing project_location_collection_data_store_session_answer resource.
|
1902
2024
|
* @returns {string} A string representing the collection.
|
1903
2025
|
*/
|
1904
|
-
|
1905
|
-
return this.pathTemplates.
|
2026
|
+
matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
|
2027
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).collection;
|
1906
2028
|
}
|
1907
2029
|
/**
|
1908
|
-
* Parse the data_store from
|
2030
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.
|
1909
2031
|
*
|
1910
|
-
* @param {string}
|
1911
|
-
* A fully-qualified path representing
|
2032
|
+
* @param {string} projectLocationCollectionDataStoreSessionAnswerName
|
2033
|
+
* A fully-qualified path representing project_location_collection_data_store_session_answer resource.
|
1912
2034
|
* @returns {string} A string representing the data_store.
|
1913
2035
|
*/
|
1914
|
-
|
1915
|
-
return this.pathTemplates.
|
2036
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
|
2037
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).data_store;
|
1916
2038
|
}
|
1917
2039
|
/**
|
1918
|
-
* Parse the session from
|
2040
|
+
* Parse the session from ProjectLocationCollectionDataStoreSessionAnswer resource.
|
1919
2041
|
*
|
1920
|
-
* @param {string}
|
1921
|
-
* A fully-qualified path representing
|
2042
|
+
* @param {string} projectLocationCollectionDataStoreSessionAnswerName
|
2043
|
+
* A fully-qualified path representing project_location_collection_data_store_session_answer resource.
|
1922
2044
|
* @returns {string} A string representing the session.
|
1923
2045
|
*/
|
1924
|
-
|
1925
|
-
return this.pathTemplates.
|
2046
|
+
matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
|
2047
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).session;
|
1926
2048
|
}
|
1927
2049
|
/**
|
1928
|
-
*
|
2050
|
+
* Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.
|
2051
|
+
*
|
2052
|
+
* @param {string} projectLocationCollectionDataStoreSessionAnswerName
|
2053
|
+
* A fully-qualified path representing project_location_collection_data_store_session_answer resource.
|
2054
|
+
* @returns {string} A string representing the answer.
|
2055
|
+
*/
|
2056
|
+
matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
|
2057
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).answer;
|
2058
|
+
}
|
2059
|
+
/**
|
2060
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSessions resource name string.
|
1929
2061
|
*
|
1930
2062
|
* @param {string} project
|
1931
2063
|
* @param {string} location
|
1932
2064
|
* @param {string} collection
|
1933
2065
|
* @param {string} data_store
|
1934
2066
|
* @param {string} session
|
1935
|
-
* @param {string} answer
|
1936
2067
|
* @returns {string} Resource name string.
|
1937
2068
|
*/
|
1938
|
-
|
1939
|
-
return this.pathTemplates.
|
2069
|
+
projectLocationCollectionDataStoreSessionsPath(project, location, collection, dataStore, session) {
|
2070
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.render({
|
1940
2071
|
project: project,
|
1941
2072
|
location: location,
|
1942
2073
|
collection: collection,
|
1943
2074
|
data_store: dataStore,
|
1944
2075
|
session: session,
|
1945
|
-
answer: answer,
|
1946
2076
|
});
|
1947
2077
|
}
|
1948
2078
|
/**
|
1949
|
-
* Parse the project from
|
2079
|
+
* Parse the project from ProjectLocationCollectionDataStoreSessions resource.
|
1950
2080
|
*
|
1951
|
-
* @param {string}
|
1952
|
-
* A fully-qualified path representing
|
2081
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
2082
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
1953
2083
|
* @returns {string} A string representing the project.
|
1954
2084
|
*/
|
1955
|
-
|
1956
|
-
return this.pathTemplates.
|
2085
|
+
matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
|
2086
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).project;
|
1957
2087
|
}
|
1958
2088
|
/**
|
1959
|
-
* Parse the location from
|
2089
|
+
* Parse the location from ProjectLocationCollectionDataStoreSessions resource.
|
1960
2090
|
*
|
1961
|
-
* @param {string}
|
1962
|
-
* A fully-qualified path representing
|
2091
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
2092
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
1963
2093
|
* @returns {string} A string representing the location.
|
1964
2094
|
*/
|
1965
|
-
|
1966
|
-
return this.pathTemplates.
|
2095
|
+
matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
|
2096
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).location;
|
1967
2097
|
}
|
1968
2098
|
/**
|
1969
|
-
* Parse the collection from
|
2099
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSessions resource.
|
1970
2100
|
*
|
1971
|
-
* @param {string}
|
1972
|
-
* A fully-qualified path representing
|
2101
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
2102
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
1973
2103
|
* @returns {string} A string representing the collection.
|
1974
2104
|
*/
|
1975
|
-
|
1976
|
-
return this.pathTemplates.
|
2105
|
+
matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
|
2106
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).collection;
|
1977
2107
|
}
|
1978
2108
|
/**
|
1979
|
-
* Parse the data_store from
|
2109
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.
|
1980
2110
|
*
|
1981
|
-
* @param {string}
|
1982
|
-
* A fully-qualified path representing
|
2111
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
2112
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
1983
2113
|
* @returns {string} A string representing the data_store.
|
1984
2114
|
*/
|
1985
|
-
|
1986
|
-
return this.pathTemplates.
|
2115
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
|
2116
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).data_store;
|
1987
2117
|
}
|
1988
2118
|
/**
|
1989
|
-
* Parse the session from
|
2119
|
+
* Parse the session from ProjectLocationCollectionDataStoreSessions resource.
|
1990
2120
|
*
|
1991
|
-
* @param {string}
|
1992
|
-
* A fully-qualified path representing
|
2121
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
2122
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
1993
2123
|
* @returns {string} A string representing the session.
|
1994
2124
|
*/
|
1995
|
-
|
1996
|
-
return this.pathTemplates.
|
1997
|
-
}
|
1998
|
-
/**
|
1999
|
-
* Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.
|
2000
|
-
*
|
2001
|
-
* @param {string} projectLocationCollectionDataStoreSessionAnswerName
|
2002
|
-
* A fully-qualified path representing project_location_collection_data_store_session_answer resource.
|
2003
|
-
* @returns {string} A string representing the answer.
|
2004
|
-
*/
|
2005
|
-
matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
|
2006
|
-
return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).answer;
|
2125
|
+
matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
|
2126
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).session;
|
2007
2127
|
}
|
2008
2128
|
/**
|
2009
2129
|
* Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
|
@@ -2339,154 +2459,154 @@ class SearchServiceClient {
|
|
2339
2459
|
return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
|
2340
2460
|
}
|
2341
2461
|
/**
|
2342
|
-
* Return a fully-qualified
|
2462
|
+
* Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
|
2343
2463
|
*
|
2344
2464
|
* @param {string} project
|
2345
2465
|
* @param {string} location
|
2346
2466
|
* @param {string} collection
|
2347
2467
|
* @param {string} engine
|
2348
2468
|
* @param {string} session
|
2469
|
+
* @param {string} answer
|
2349
2470
|
* @returns {string} Resource name string.
|
2350
2471
|
*/
|
2351
|
-
|
2352
|
-
return this.pathTemplates.
|
2472
|
+
projectLocationCollectionEngineSessionAnswerPath(project, location, collection, engine, session, answer) {
|
2473
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.render({
|
2353
2474
|
project: project,
|
2354
2475
|
location: location,
|
2355
2476
|
collection: collection,
|
2356
2477
|
engine: engine,
|
2357
2478
|
session: session,
|
2479
|
+
answer: answer,
|
2358
2480
|
});
|
2359
2481
|
}
|
2360
2482
|
/**
|
2361
|
-
* Parse the project from
|
2483
|
+
* Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.
|
2362
2484
|
*
|
2363
|
-
* @param {string}
|
2364
|
-
* A fully-qualified path representing
|
2485
|
+
* @param {string} projectLocationCollectionEngineSessionAnswerName
|
2486
|
+
* A fully-qualified path representing project_location_collection_engine_session_answer resource.
|
2365
2487
|
* @returns {string} A string representing the project.
|
2366
2488
|
*/
|
2367
|
-
|
2368
|
-
return this.pathTemplates.
|
2489
|
+
matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
|
2490
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).project;
|
2369
2491
|
}
|
2370
2492
|
/**
|
2371
|
-
* Parse the location from
|
2493
|
+
* Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.
|
2372
2494
|
*
|
2373
|
-
* @param {string}
|
2374
|
-
* A fully-qualified path representing
|
2495
|
+
* @param {string} projectLocationCollectionEngineSessionAnswerName
|
2496
|
+
* A fully-qualified path representing project_location_collection_engine_session_answer resource.
|
2375
2497
|
* @returns {string} A string representing the location.
|
2376
2498
|
*/
|
2377
|
-
|
2378
|
-
return this.pathTemplates.
|
2499
|
+
matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
|
2500
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).location;
|
2379
2501
|
}
|
2380
2502
|
/**
|
2381
|
-
* Parse the collection from
|
2503
|
+
* Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.
|
2382
2504
|
*
|
2383
|
-
* @param {string}
|
2384
|
-
* A fully-qualified path representing
|
2505
|
+
* @param {string} projectLocationCollectionEngineSessionAnswerName
|
2506
|
+
* A fully-qualified path representing project_location_collection_engine_session_answer resource.
|
2385
2507
|
* @returns {string} A string representing the collection.
|
2386
2508
|
*/
|
2387
|
-
|
2388
|
-
return this.pathTemplates.
|
2509
|
+
matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
|
2510
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).collection;
|
2389
2511
|
}
|
2390
2512
|
/**
|
2391
|
-
* Parse the engine from
|
2513
|
+
* Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.
|
2392
2514
|
*
|
2393
|
-
* @param {string}
|
2394
|
-
* A fully-qualified path representing
|
2515
|
+
* @param {string} projectLocationCollectionEngineSessionAnswerName
|
2516
|
+
* A fully-qualified path representing project_location_collection_engine_session_answer resource.
|
2395
2517
|
* @returns {string} A string representing the engine.
|
2396
2518
|
*/
|
2397
|
-
|
2398
|
-
return this.pathTemplates.
|
2519
|
+
matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
|
2520
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).engine;
|
2399
2521
|
}
|
2400
2522
|
/**
|
2401
|
-
* Parse the session from
|
2523
|
+
* Parse the session from ProjectLocationCollectionEngineSessionAnswer resource.
|
2402
2524
|
*
|
2403
|
-
* @param {string}
|
2404
|
-
* A fully-qualified path representing
|
2525
|
+
* @param {string} projectLocationCollectionEngineSessionAnswerName
|
2526
|
+
* A fully-qualified path representing project_location_collection_engine_session_answer resource.
|
2405
2527
|
* @returns {string} A string representing the session.
|
2406
2528
|
*/
|
2407
|
-
|
2408
|
-
return this.pathTemplates.
|
2529
|
+
matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
|
2530
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).session;
|
2531
|
+
}
|
2532
|
+
/**
|
2533
|
+
* Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.
|
2534
|
+
*
|
2535
|
+
* @param {string} projectLocationCollectionEngineSessionAnswerName
|
2536
|
+
* A fully-qualified path representing project_location_collection_engine_session_answer resource.
|
2537
|
+
* @returns {string} A string representing the answer.
|
2538
|
+
*/
|
2539
|
+
matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
|
2540
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).answer;
|
2409
2541
|
}
|
2410
2542
|
/**
|
2411
|
-
* Return a fully-qualified
|
2543
|
+
* Return a fully-qualified projectLocationCollectionEngineSessions resource name string.
|
2412
2544
|
*
|
2413
2545
|
* @param {string} project
|
2414
2546
|
* @param {string} location
|
2415
2547
|
* @param {string} collection
|
2416
2548
|
* @param {string} engine
|
2417
2549
|
* @param {string} session
|
2418
|
-
* @param {string} answer
|
2419
2550
|
* @returns {string} Resource name string.
|
2420
2551
|
*/
|
2421
|
-
|
2422
|
-
return this.pathTemplates.
|
2552
|
+
projectLocationCollectionEngineSessionsPath(project, location, collection, engine, session) {
|
2553
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.render({
|
2423
2554
|
project: project,
|
2424
2555
|
location: location,
|
2425
2556
|
collection: collection,
|
2426
2557
|
engine: engine,
|
2427
2558
|
session: session,
|
2428
|
-
answer: answer,
|
2429
2559
|
});
|
2430
2560
|
}
|
2431
2561
|
/**
|
2432
|
-
* Parse the project from
|
2562
|
+
* Parse the project from ProjectLocationCollectionEngineSessions resource.
|
2433
2563
|
*
|
2434
|
-
* @param {string}
|
2435
|
-
* A fully-qualified path representing
|
2564
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
2565
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
2436
2566
|
* @returns {string} A string representing the project.
|
2437
2567
|
*/
|
2438
|
-
|
2439
|
-
return this.pathTemplates.
|
2568
|
+
matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
|
2569
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).project;
|
2440
2570
|
}
|
2441
2571
|
/**
|
2442
|
-
* Parse the location from
|
2572
|
+
* Parse the location from ProjectLocationCollectionEngineSessions resource.
|
2443
2573
|
*
|
2444
|
-
* @param {string}
|
2445
|
-
* A fully-qualified path representing
|
2574
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
2575
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
2446
2576
|
* @returns {string} A string representing the location.
|
2447
2577
|
*/
|
2448
|
-
|
2449
|
-
return this.pathTemplates.
|
2578
|
+
matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
|
2579
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).location;
|
2450
2580
|
}
|
2451
2581
|
/**
|
2452
|
-
* Parse the collection from
|
2582
|
+
* Parse the collection from ProjectLocationCollectionEngineSessions resource.
|
2453
2583
|
*
|
2454
|
-
* @param {string}
|
2455
|
-
* A fully-qualified path representing
|
2584
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
2585
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
2456
2586
|
* @returns {string} A string representing the collection.
|
2457
2587
|
*/
|
2458
|
-
|
2459
|
-
return this.pathTemplates.
|
2588
|
+
matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
|
2589
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).collection;
|
2460
2590
|
}
|
2461
2591
|
/**
|
2462
|
-
* Parse the engine from
|
2592
|
+
* Parse the engine from ProjectLocationCollectionEngineSessions resource.
|
2463
2593
|
*
|
2464
|
-
* @param {string}
|
2465
|
-
* A fully-qualified path representing
|
2594
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
2595
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
2466
2596
|
* @returns {string} A string representing the engine.
|
2467
2597
|
*/
|
2468
|
-
|
2469
|
-
return this.pathTemplates.
|
2598
|
+
matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
|
2599
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).engine;
|
2470
2600
|
}
|
2471
2601
|
/**
|
2472
|
-
* Parse the session from
|
2602
|
+
* Parse the session from ProjectLocationCollectionEngineSessions resource.
|
2473
2603
|
*
|
2474
|
-
* @param {string}
|
2475
|
-
* A fully-qualified path representing
|
2604
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
2605
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
2476
2606
|
* @returns {string} A string representing the session.
|
2477
2607
|
*/
|
2478
|
-
|
2479
|
-
return this.pathTemplates.
|
2480
|
-
}
|
2481
|
-
/**
|
2482
|
-
* Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.
|
2483
|
-
*
|
2484
|
-
* @param {string} projectLocationCollectionEngineSessionAnswerName
|
2485
|
-
* A fully-qualified path representing project_location_collection_engine_session_answer resource.
|
2486
|
-
* @returns {string} A string representing the answer.
|
2487
|
-
*/
|
2488
|
-
matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
|
2489
|
-
return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).answer;
|
2608
|
+
matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
|
2609
|
+
return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).session;
|
2490
2610
|
}
|
2491
2611
|
/**
|
2492
2612
|
* Return a fully-qualified projectLocationDataStore resource name string.
|
@@ -3070,63 +3190,6 @@ class SearchServiceClient {
|
|
3070
3190
|
matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
|
3071
3191
|
return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
|
3072
3192
|
}
|
3073
|
-
/**
|
3074
|
-
* Return a fully-qualified projectLocationDataStoreSession resource name string.
|
3075
|
-
*
|
3076
|
-
* @param {string} project
|
3077
|
-
* @param {string} location
|
3078
|
-
* @param {string} data_store
|
3079
|
-
* @param {string} session
|
3080
|
-
* @returns {string} Resource name string.
|
3081
|
-
*/
|
3082
|
-
projectLocationDataStoreSessionPath(project, location, dataStore, session) {
|
3083
|
-
return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.render({
|
3084
|
-
project: project,
|
3085
|
-
location: location,
|
3086
|
-
data_store: dataStore,
|
3087
|
-
session: session,
|
3088
|
-
});
|
3089
|
-
}
|
3090
|
-
/**
|
3091
|
-
* Parse the project from ProjectLocationDataStoreSession resource.
|
3092
|
-
*
|
3093
|
-
* @param {string} projectLocationDataStoreSessionName
|
3094
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3095
|
-
* @returns {string} A string representing the project.
|
3096
|
-
*/
|
3097
|
-
matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
|
3098
|
-
return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).project;
|
3099
|
-
}
|
3100
|
-
/**
|
3101
|
-
* Parse the location from ProjectLocationDataStoreSession resource.
|
3102
|
-
*
|
3103
|
-
* @param {string} projectLocationDataStoreSessionName
|
3104
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3105
|
-
* @returns {string} A string representing the location.
|
3106
|
-
*/
|
3107
|
-
matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
|
3108
|
-
return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).location;
|
3109
|
-
}
|
3110
|
-
/**
|
3111
|
-
* Parse the data_store from ProjectLocationDataStoreSession resource.
|
3112
|
-
*
|
3113
|
-
* @param {string} projectLocationDataStoreSessionName
|
3114
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3115
|
-
* @returns {string} A string representing the data_store.
|
3116
|
-
*/
|
3117
|
-
matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
|
3118
|
-
return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).data_store;
|
3119
|
-
}
|
3120
|
-
/**
|
3121
|
-
* Parse the session from ProjectLocationDataStoreSession resource.
|
3122
|
-
*
|
3123
|
-
* @param {string} projectLocationDataStoreSessionName
|
3124
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3125
|
-
* @returns {string} A string representing the session.
|
3126
|
-
*/
|
3127
|
-
matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
|
3128
|
-
return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).session;
|
3129
|
-
}
|
3130
3193
|
/**
|
3131
3194
|
* Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.
|
3132
3195
|
*
|
@@ -3196,6 +3259,63 @@ class SearchServiceClient {
|
|
3196
3259
|
matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName) {
|
3197
3260
|
return this.pathTemplates.projectLocationDataStoreSessionAnswerPathTemplate.match(projectLocationDataStoreSessionAnswerName).answer;
|
3198
3261
|
}
|
3262
|
+
/**
|
3263
|
+
* Return a fully-qualified projectLocationDataStoreSessions resource name string.
|
3264
|
+
*
|
3265
|
+
* @param {string} project
|
3266
|
+
* @param {string} location
|
3267
|
+
* @param {string} data_store
|
3268
|
+
* @param {string} session
|
3269
|
+
* @returns {string} Resource name string.
|
3270
|
+
*/
|
3271
|
+
projectLocationDataStoreSessionsPath(project, location, dataStore, session) {
|
3272
|
+
return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.render({
|
3273
|
+
project: project,
|
3274
|
+
location: location,
|
3275
|
+
data_store: dataStore,
|
3276
|
+
session: session,
|
3277
|
+
});
|
3278
|
+
}
|
3279
|
+
/**
|
3280
|
+
* Parse the project from ProjectLocationDataStoreSessions resource.
|
3281
|
+
*
|
3282
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3283
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3284
|
+
* @returns {string} A string representing the project.
|
3285
|
+
*/
|
3286
|
+
matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
|
3287
|
+
return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).project;
|
3288
|
+
}
|
3289
|
+
/**
|
3290
|
+
* Parse the location from ProjectLocationDataStoreSessions resource.
|
3291
|
+
*
|
3292
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3293
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3294
|
+
* @returns {string} A string representing the location.
|
3295
|
+
*/
|
3296
|
+
matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
|
3297
|
+
return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).location;
|
3298
|
+
}
|
3299
|
+
/**
|
3300
|
+
* Parse the data_store from ProjectLocationDataStoreSessions resource.
|
3301
|
+
*
|
3302
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3303
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3304
|
+
* @returns {string} A string representing the data_store.
|
3305
|
+
*/
|
3306
|
+
matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
|
3307
|
+
return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).data_store;
|
3308
|
+
}
|
3309
|
+
/**
|
3310
|
+
* Parse the session from ProjectLocationDataStoreSessions resource.
|
3311
|
+
*
|
3312
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3313
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3314
|
+
* @returns {string} A string representing the session.
|
3315
|
+
*/
|
3316
|
+
matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
|
3317
|
+
return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).session;
|
3318
|
+
}
|
3199
3319
|
/**
|
3200
3320
|
* Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
|
3201
3321
|
*
|