@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
@@ -314,22 +314,16 @@ export declare class SearchServiceClient {
|
|
314
314
|
* between /search API calls and /answer API calls.
|
315
315
|
*
|
316
316
|
* Example #1 (multi-turn /search API calls):
|
317
|
-
*
|
318
|
-
*
|
319
|
-
*
|
320
|
-
*
|
321
|
-
*
|
322
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
317
|
+
* Call /search API with the session ID generated in the first call.
|
318
|
+
* Here, the previous search query gets considered in query
|
319
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
320
|
+
* and the current query is "How about 2023?", the current query will
|
321
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
323
322
|
*
|
324
323
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
325
|
-
*
|
326
|
-
*
|
327
|
-
*
|
328
|
-
* results from the first search call.
|
329
|
-
*
|
330
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
331
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
332
|
-
* to create a session manually.
|
324
|
+
* Call /answer API with the session ID generated in the first call.
|
325
|
+
* Here, the answer generation happens in the context of the search
|
326
|
+
* results from the first search call.
|
333
327
|
*
|
334
328
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
335
329
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -348,6 +342,99 @@ export declare class SearchServiceClient {
|
|
348
342
|
* This feature is not supported for healthcare search.
|
349
343
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
350
344
|
* Optional. The specification for returning the relevance score.
|
345
|
+
* @param {string} request.rankingExpression
|
346
|
+
* The ranking expression controls the customized ranking on retrieval
|
347
|
+
* documents. This overrides
|
348
|
+
* {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
349
|
+
* The syntax and supported features depend on the
|
350
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
351
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
352
|
+
*
|
353
|
+
* If
|
354
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
355
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
356
|
+
* function or multiple functions that are joined by "+".
|
357
|
+
*
|
358
|
+
* * ranking_expression = function, { " + ", function };
|
359
|
+
*
|
360
|
+
* Supported functions:
|
361
|
+
*
|
362
|
+
* * double * relevance_score
|
363
|
+
* * double * dotProduct(embedding_field_path)
|
364
|
+
*
|
365
|
+
* Function variables:
|
366
|
+
*
|
367
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
368
|
+
* between query and document.
|
369
|
+
* * `embedding_field_path`: the document embedding field
|
370
|
+
* used with query embedding vector.
|
371
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
372
|
+
* query embedding vector.
|
373
|
+
*
|
374
|
+
* Example ranking expression:
|
375
|
+
*
|
376
|
+
* If document has an embedding field doc_embedding, the ranking expression
|
377
|
+
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
378
|
+
*
|
379
|
+
* If
|
380
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
381
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
382
|
+
* combinations of those chained using + or
|
383
|
+
* * operators) are supported:
|
384
|
+
*
|
385
|
+
* * `double`
|
386
|
+
* * `signal`
|
387
|
+
* * `log(signal)`
|
388
|
+
* * `exp(signal)`
|
389
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
390
|
+
* argument being a denominator constant.
|
391
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
392
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
393
|
+
* signal2 | double, else returns signal1.
|
394
|
+
*
|
395
|
+
* Here are a few examples of ranking formulas that use the supported
|
396
|
+
* ranking expression types:
|
397
|
+
*
|
398
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
399
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
400
|
+
* `semantic_smilarity_score` adjustment.
|
401
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
402
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
403
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
404
|
+
* add constant 0.3 adjustment to the final score if
|
405
|
+
* `semantic_similarity_score` is NaN.
|
406
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
407
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
408
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
409
|
+
* of `semantic_smilarity_score`.
|
410
|
+
*
|
411
|
+
* The following signals are supported:
|
412
|
+
*
|
413
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
414
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
415
|
+
* This score determines how semantically similar a search query is to a
|
416
|
+
* document.
|
417
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
418
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
419
|
+
* probabilistic model to estimate the probability that a document is
|
420
|
+
* relevant to a given query.
|
421
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
422
|
+
* proprietary Google model to determine the meaning and intent behind a
|
423
|
+
* user's query in context with the content in the documents.
|
424
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
425
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
426
|
+
* attractiveness of a search result from a user's perspective. A higher
|
427
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
428
|
+
* and intent, making it a valuable signal for ranking.
|
429
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
430
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
431
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
432
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
433
|
+
* Google model to determine the keyword-based overlap between the query and
|
434
|
+
* the document.
|
435
|
+
* * `base_rank`: the default rank of the result
|
436
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
437
|
+
* The backend to use for the ranking expression evaluation.
|
351
438
|
* @param {object} [options]
|
352
439
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
353
440
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -564,22 +651,16 @@ export declare class SearchServiceClient {
|
|
564
651
|
* between /search API calls and /answer API calls.
|
565
652
|
*
|
566
653
|
* Example #1 (multi-turn /search API calls):
|
567
|
-
*
|
568
|
-
*
|
569
|
-
*
|
570
|
-
*
|
571
|
-
*
|
572
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
654
|
+
* Call /search API with the session ID generated in the first call.
|
655
|
+
* Here, the previous search query gets considered in query
|
656
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
657
|
+
* and the current query is "How about 2023?", the current query will
|
658
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
573
659
|
*
|
574
660
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
575
|
-
*
|
576
|
-
*
|
577
|
-
*
|
578
|
-
* results from the first search call.
|
579
|
-
*
|
580
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
581
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
582
|
-
* to create a session manually.
|
661
|
+
* Call /answer API with the session ID generated in the first call.
|
662
|
+
* Here, the answer generation happens in the context of the search
|
663
|
+
* results from the first search call.
|
583
664
|
*
|
584
665
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
585
666
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -598,6 +679,99 @@ export declare class SearchServiceClient {
|
|
598
679
|
* This feature is not supported for healthcare search.
|
599
680
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
600
681
|
* Optional. The specification for returning the relevance score.
|
682
|
+
* @param {string} request.rankingExpression
|
683
|
+
* The ranking expression controls the customized ranking on retrieval
|
684
|
+
* documents. This overrides
|
685
|
+
* {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
686
|
+
* The syntax and supported features depend on the
|
687
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
688
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
689
|
+
*
|
690
|
+
* If
|
691
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
692
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
693
|
+
* function or multiple functions that are joined by "+".
|
694
|
+
*
|
695
|
+
* * ranking_expression = function, { " + ", function };
|
696
|
+
*
|
697
|
+
* Supported functions:
|
698
|
+
*
|
699
|
+
* * double * relevance_score
|
700
|
+
* * double * dotProduct(embedding_field_path)
|
701
|
+
*
|
702
|
+
* Function variables:
|
703
|
+
*
|
704
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
705
|
+
* between query and document.
|
706
|
+
* * `embedding_field_path`: the document embedding field
|
707
|
+
* used with query embedding vector.
|
708
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
709
|
+
* query embedding vector.
|
710
|
+
*
|
711
|
+
* Example ranking expression:
|
712
|
+
*
|
713
|
+
* If document has an embedding field doc_embedding, the ranking expression
|
714
|
+
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
715
|
+
*
|
716
|
+
* If
|
717
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
718
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
719
|
+
* combinations of those chained using + or
|
720
|
+
* * operators) are supported:
|
721
|
+
*
|
722
|
+
* * `double`
|
723
|
+
* * `signal`
|
724
|
+
* * `log(signal)`
|
725
|
+
* * `exp(signal)`
|
726
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
727
|
+
* argument being a denominator constant.
|
728
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
729
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
730
|
+
* signal2 | double, else returns signal1.
|
731
|
+
*
|
732
|
+
* Here are a few examples of ranking formulas that use the supported
|
733
|
+
* ranking expression types:
|
734
|
+
*
|
735
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
736
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
737
|
+
* `semantic_smilarity_score` adjustment.
|
738
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
739
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
740
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
741
|
+
* add constant 0.3 adjustment to the final score if
|
742
|
+
* `semantic_similarity_score` is NaN.
|
743
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
744
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
745
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
746
|
+
* of `semantic_smilarity_score`.
|
747
|
+
*
|
748
|
+
* The following signals are supported:
|
749
|
+
*
|
750
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
751
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
752
|
+
* This score determines how semantically similar a search query is to a
|
753
|
+
* document.
|
754
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
755
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
756
|
+
* probabilistic model to estimate the probability that a document is
|
757
|
+
* relevant to a given query.
|
758
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
759
|
+
* proprietary Google model to determine the meaning and intent behind a
|
760
|
+
* user's query in context with the content in the documents.
|
761
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
762
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
763
|
+
* attractiveness of a search result from a user's perspective. A higher
|
764
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
765
|
+
* and intent, making it a valuable signal for ranking.
|
766
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
767
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
768
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
769
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
770
|
+
* Google model to determine the keyword-based overlap between the query and
|
771
|
+
* the document.
|
772
|
+
* * `base_rank`: the default rank of the result
|
773
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
774
|
+
* The backend to use for the ranking expression evaluation.
|
601
775
|
* @param {object} [options]
|
602
776
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
603
777
|
* @returns {Stream}
|
@@ -809,22 +983,16 @@ export declare class SearchServiceClient {
|
|
809
983
|
* between /search API calls and /answer API calls.
|
810
984
|
*
|
811
985
|
* Example #1 (multi-turn /search API calls):
|
812
|
-
*
|
813
|
-
*
|
814
|
-
*
|
815
|
-
*
|
816
|
-
*
|
817
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
986
|
+
* Call /search API with the session ID generated in the first call.
|
987
|
+
* Here, the previous search query gets considered in query
|
988
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
989
|
+
* and the current query is "How about 2023?", the current query will
|
990
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
818
991
|
*
|
819
992
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
820
|
-
*
|
821
|
-
*
|
822
|
-
*
|
823
|
-
* results from the first search call.
|
824
|
-
*
|
825
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
826
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
827
|
-
* to create a session manually.
|
993
|
+
* Call /answer API with the session ID generated in the first call.
|
994
|
+
* Here, the answer generation happens in the context of the search
|
995
|
+
* results from the first search call.
|
828
996
|
*
|
829
997
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
830
998
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -843,6 +1011,99 @@ export declare class SearchServiceClient {
|
|
843
1011
|
* This feature is not supported for healthcare search.
|
844
1012
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
845
1013
|
* Optional. The specification for returning the relevance score.
|
1014
|
+
* @param {string} request.rankingExpression
|
1015
|
+
* The ranking expression controls the customized ranking on retrieval
|
1016
|
+
* documents. This overrides
|
1017
|
+
* {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
1018
|
+
* The syntax and supported features depend on the
|
1019
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
1020
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
1021
|
+
*
|
1022
|
+
* If
|
1023
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
1024
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
1025
|
+
* function or multiple functions that are joined by "+".
|
1026
|
+
*
|
1027
|
+
* * ranking_expression = function, { " + ", function };
|
1028
|
+
*
|
1029
|
+
* Supported functions:
|
1030
|
+
*
|
1031
|
+
* * double * relevance_score
|
1032
|
+
* * double * dotProduct(embedding_field_path)
|
1033
|
+
*
|
1034
|
+
* Function variables:
|
1035
|
+
*
|
1036
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
1037
|
+
* between query and document.
|
1038
|
+
* * `embedding_field_path`: the document embedding field
|
1039
|
+
* used with query embedding vector.
|
1040
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
1041
|
+
* query embedding vector.
|
1042
|
+
*
|
1043
|
+
* Example ranking expression:
|
1044
|
+
*
|
1045
|
+
* If document has an embedding field doc_embedding, the ranking expression
|
1046
|
+
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
1047
|
+
*
|
1048
|
+
* If
|
1049
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
1050
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
1051
|
+
* combinations of those chained using + or
|
1052
|
+
* * operators) are supported:
|
1053
|
+
*
|
1054
|
+
* * `double`
|
1055
|
+
* * `signal`
|
1056
|
+
* * `log(signal)`
|
1057
|
+
* * `exp(signal)`
|
1058
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
1059
|
+
* argument being a denominator constant.
|
1060
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
1061
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
1062
|
+
* signal2 | double, else returns signal1.
|
1063
|
+
*
|
1064
|
+
* Here are a few examples of ranking formulas that use the supported
|
1065
|
+
* ranking expression types:
|
1066
|
+
*
|
1067
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
1068
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
1069
|
+
* `semantic_smilarity_score` adjustment.
|
1070
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
1071
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
1072
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
1073
|
+
* add constant 0.3 adjustment to the final score if
|
1074
|
+
* `semantic_similarity_score` is NaN.
|
1075
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
1076
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
1077
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
1078
|
+
* of `semantic_smilarity_score`.
|
1079
|
+
*
|
1080
|
+
* The following signals are supported:
|
1081
|
+
*
|
1082
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
1083
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
1084
|
+
* This score determines how semantically similar a search query is to a
|
1085
|
+
* document.
|
1086
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
1087
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
1088
|
+
* probabilistic model to estimate the probability that a document is
|
1089
|
+
* relevant to a given query.
|
1090
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
1091
|
+
* proprietary Google model to determine the meaning and intent behind a
|
1092
|
+
* user's query in context with the content in the documents.
|
1093
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
1094
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
1095
|
+
* attractiveness of a search result from a user's perspective. A higher
|
1096
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
1097
|
+
* and intent, making it a valuable signal for ranking.
|
1098
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
1099
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
1100
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
1101
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
1102
|
+
* Google model to determine the keyword-based overlap between the query and
|
1103
|
+
* the document.
|
1104
|
+
* * `base_rank`: the default rank of the result
|
1105
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
1106
|
+
* The backend to use for the ranking expression evaluation.
|
846
1107
|
* @param {object} [options]
|
847
1108
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
848
1109
|
* @returns {Object}
|
@@ -1066,22 +1327,16 @@ export declare class SearchServiceClient {
|
|
1066
1327
|
* between /search API calls and /answer API calls.
|
1067
1328
|
*
|
1068
1329
|
* Example #1 (multi-turn /search API calls):
|
1069
|
-
*
|
1070
|
-
*
|
1071
|
-
*
|
1072
|
-
*
|
1073
|
-
*
|
1074
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
1330
|
+
* Call /search API with the session ID generated in the first call.
|
1331
|
+
* Here, the previous search query gets considered in query
|
1332
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
1333
|
+
* and the current query is "How about 2023?", the current query will
|
1334
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
1075
1335
|
*
|
1076
1336
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
1077
|
-
*
|
1078
|
-
*
|
1079
|
-
*
|
1080
|
-
* results from the first search call.
|
1081
|
-
*
|
1082
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
1083
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
1084
|
-
* to create a session manually.
|
1337
|
+
* Call /answer API with the session ID generated in the first call.
|
1338
|
+
* Here, the answer generation happens in the context of the search
|
1339
|
+
* results from the first search call.
|
1085
1340
|
*
|
1086
1341
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
1087
1342
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -1100,6 +1355,99 @@ export declare class SearchServiceClient {
|
|
1100
1355
|
* This feature is not supported for healthcare search.
|
1101
1356
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
1102
1357
|
* Optional. The specification for returning the relevance score.
|
1358
|
+
* @param {string} request.rankingExpression
|
1359
|
+
* The ranking expression controls the customized ranking on retrieval
|
1360
|
+
* documents. This overrides
|
1361
|
+
* {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
1362
|
+
* The syntax and supported features depend on the
|
1363
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
1364
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
1365
|
+
*
|
1366
|
+
* If
|
1367
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
1368
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
1369
|
+
* function or multiple functions that are joined by "+".
|
1370
|
+
*
|
1371
|
+
* * ranking_expression = function, { " + ", function };
|
1372
|
+
*
|
1373
|
+
* Supported functions:
|
1374
|
+
*
|
1375
|
+
* * double * relevance_score
|
1376
|
+
* * double * dotProduct(embedding_field_path)
|
1377
|
+
*
|
1378
|
+
* Function variables:
|
1379
|
+
*
|
1380
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
1381
|
+
* between query and document.
|
1382
|
+
* * `embedding_field_path`: the document embedding field
|
1383
|
+
* used with query embedding vector.
|
1384
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
1385
|
+
* query embedding vector.
|
1386
|
+
*
|
1387
|
+
* Example ranking expression:
|
1388
|
+
*
|
1389
|
+
* If document has an embedding field doc_embedding, the ranking expression
|
1390
|
+
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
1391
|
+
*
|
1392
|
+
* If
|
1393
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
1394
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
1395
|
+
* combinations of those chained using + or
|
1396
|
+
* * operators) are supported:
|
1397
|
+
*
|
1398
|
+
* * `double`
|
1399
|
+
* * `signal`
|
1400
|
+
* * `log(signal)`
|
1401
|
+
* * `exp(signal)`
|
1402
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
1403
|
+
* argument being a denominator constant.
|
1404
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
1405
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
1406
|
+
* signal2 | double, else returns signal1.
|
1407
|
+
*
|
1408
|
+
* Here are a few examples of ranking formulas that use the supported
|
1409
|
+
* ranking expression types:
|
1410
|
+
*
|
1411
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
1412
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
1413
|
+
* `semantic_smilarity_score` adjustment.
|
1414
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
1415
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
1416
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
1417
|
+
* add constant 0.3 adjustment to the final score if
|
1418
|
+
* `semantic_similarity_score` is NaN.
|
1419
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
1420
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
1421
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
1422
|
+
* of `semantic_smilarity_score`.
|
1423
|
+
*
|
1424
|
+
* The following signals are supported:
|
1425
|
+
*
|
1426
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
1427
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
1428
|
+
* This score determines how semantically similar a search query is to a
|
1429
|
+
* document.
|
1430
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
1431
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
1432
|
+
* probabilistic model to estimate the probability that a document is
|
1433
|
+
* relevant to a given query.
|
1434
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
1435
|
+
* proprietary Google model to determine the meaning and intent behind a
|
1436
|
+
* user's query in context with the content in the documents.
|
1437
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
1438
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
1439
|
+
* attractiveness of a search result from a user's perspective. A higher
|
1440
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
1441
|
+
* and intent, making it a valuable signal for ranking.
|
1442
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
1443
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
1444
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
1445
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
1446
|
+
* Google model to determine the keyword-based overlap between the query and
|
1447
|
+
* the document.
|
1448
|
+
* * `base_rank`: the default rank of the result
|
1449
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
1450
|
+
* The backend to use for the ranking expression evaluation.
|
1103
1451
|
* @param {object} [options]
|
1104
1452
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
1105
1453
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -1316,22 +1664,16 @@ export declare class SearchServiceClient {
|
|
1316
1664
|
* between /search API calls and /answer API calls.
|
1317
1665
|
*
|
1318
1666
|
* Example #1 (multi-turn /search API calls):
|
1319
|
-
*
|
1320
|
-
*
|
1321
|
-
*
|
1322
|
-
*
|
1323
|
-
*
|
1324
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
1667
|
+
* Call /search API with the session ID generated in the first call.
|
1668
|
+
* Here, the previous search query gets considered in query
|
1669
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
1670
|
+
* and the current query is "How about 2023?", the current query will
|
1671
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
1325
1672
|
*
|
1326
1673
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
1327
|
-
*
|
1328
|
-
*
|
1329
|
-
*
|
1330
|
-
* results from the first search call.
|
1331
|
-
*
|
1332
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
1333
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
1334
|
-
* to create a session manually.
|
1674
|
+
* Call /answer API with the session ID generated in the first call.
|
1675
|
+
* Here, the answer generation happens in the context of the search
|
1676
|
+
* results from the first search call.
|
1335
1677
|
*
|
1336
1678
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
1337
1679
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -1350,6 +1692,99 @@ export declare class SearchServiceClient {
|
|
1350
1692
|
* This feature is not supported for healthcare search.
|
1351
1693
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
1352
1694
|
* Optional. The specification for returning the relevance score.
|
1695
|
+
* @param {string} request.rankingExpression
|
1696
|
+
* The ranking expression controls the customized ranking on retrieval
|
1697
|
+
* documents. This overrides
|
1698
|
+
* {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
1699
|
+
* The syntax and supported features depend on the
|
1700
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
1701
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
1702
|
+
*
|
1703
|
+
* If
|
1704
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
1705
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
1706
|
+
* function or multiple functions that are joined by "+".
|
1707
|
+
*
|
1708
|
+
* * ranking_expression = function, { " + ", function };
|
1709
|
+
*
|
1710
|
+
* Supported functions:
|
1711
|
+
*
|
1712
|
+
* * double * relevance_score
|
1713
|
+
* * double * dotProduct(embedding_field_path)
|
1714
|
+
*
|
1715
|
+
* Function variables:
|
1716
|
+
*
|
1717
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
1718
|
+
* between query and document.
|
1719
|
+
* * `embedding_field_path`: the document embedding field
|
1720
|
+
* used with query embedding vector.
|
1721
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
1722
|
+
* query embedding vector.
|
1723
|
+
*
|
1724
|
+
* Example ranking expression:
|
1725
|
+
*
|
1726
|
+
* If document has an embedding field doc_embedding, the ranking expression
|
1727
|
+
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
1728
|
+
*
|
1729
|
+
* If
|
1730
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
1731
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
1732
|
+
* combinations of those chained using + or
|
1733
|
+
* * operators) are supported:
|
1734
|
+
*
|
1735
|
+
* * `double`
|
1736
|
+
* * `signal`
|
1737
|
+
* * `log(signal)`
|
1738
|
+
* * `exp(signal)`
|
1739
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
1740
|
+
* argument being a denominator constant.
|
1741
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
1742
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
1743
|
+
* signal2 | double, else returns signal1.
|
1744
|
+
*
|
1745
|
+
* Here are a few examples of ranking formulas that use the supported
|
1746
|
+
* ranking expression types:
|
1747
|
+
*
|
1748
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
1749
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
1750
|
+
* `semantic_smilarity_score` adjustment.
|
1751
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
1752
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
1753
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
1754
|
+
* add constant 0.3 adjustment to the final score if
|
1755
|
+
* `semantic_similarity_score` is NaN.
|
1756
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
1757
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
1758
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
1759
|
+
* of `semantic_smilarity_score`.
|
1760
|
+
*
|
1761
|
+
* The following signals are supported:
|
1762
|
+
*
|
1763
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
1764
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
1765
|
+
* This score determines how semantically similar a search query is to a
|
1766
|
+
* document.
|
1767
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
1768
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
1769
|
+
* probabilistic model to estimate the probability that a document is
|
1770
|
+
* relevant to a given query.
|
1771
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
1772
|
+
* proprietary Google model to determine the meaning and intent behind a
|
1773
|
+
* user's query in context with the content in the documents.
|
1774
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
1775
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
1776
|
+
* attractiveness of a search result from a user's perspective. A higher
|
1777
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
1778
|
+
* and intent, making it a valuable signal for ranking.
|
1779
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
1780
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
1781
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
1782
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
1783
|
+
* Google model to determine the keyword-based overlap between the query and
|
1784
|
+
* the document.
|
1785
|
+
* * `base_rank`: the default rank of the result
|
1786
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
1787
|
+
* The backend to use for the ranking expression evaluation.
|
1353
1788
|
* @param {object} [options]
|
1354
1789
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
1355
1790
|
* @returns {Stream}
|
@@ -1561,22 +1996,16 @@ export declare class SearchServiceClient {
|
|
1561
1996
|
* between /search API calls and /answer API calls.
|
1562
1997
|
*
|
1563
1998
|
* Example #1 (multi-turn /search API calls):
|
1564
|
-
*
|
1565
|
-
*
|
1566
|
-
*
|
1567
|
-
*
|
1568
|
-
*
|
1569
|
-
* be interpreted as "How did Alphabet do in 2023?".
|
1999
|
+
* Call /search API with the session ID generated in the first call.
|
2000
|
+
* Here, the previous search query gets considered in query
|
2001
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
2002
|
+
* and the current query is "How about 2023?", the current query will
|
2003
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
1570
2004
|
*
|
1571
2005
|
* Example #2 (coordination between /search API calls and /answer API calls):
|
1572
|
-
*
|
1573
|
-
*
|
1574
|
-
*
|
1575
|
-
* results from the first search call.
|
1576
|
-
*
|
1577
|
-
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
1578
|
-
* gets automatically created. Otherwise, users can use the create-session API
|
1579
|
-
* to create a session manually.
|
2006
|
+
* Call /answer API with the session ID generated in the first call.
|
2007
|
+
* Here, the answer generation happens in the context of the search
|
2008
|
+
* results from the first search call.
|
1580
2009
|
*
|
1581
2010
|
* Multi-turn Search feature is currently at private GA stage. Please use
|
1582
2011
|
* v1alpha or v1beta version instead before we launch this feature to public
|
@@ -1595,6 +2024,99 @@ export declare class SearchServiceClient {
|
|
1595
2024
|
* This feature is not supported for healthcare search.
|
1596
2025
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
|
1597
2026
|
* Optional. The specification for returning the relevance score.
|
2027
|
+
* @param {string} request.rankingExpression
|
2028
|
+
* The ranking expression controls the customized ranking on retrieval
|
2029
|
+
* documents. This overrides
|
2030
|
+
* {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
2031
|
+
* The syntax and supported features depend on the
|
2032
|
+
* `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
2033
|
+
* provided, it defaults to `RANK_BY_EMBEDDING`.
|
2034
|
+
*
|
2035
|
+
* If
|
2036
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
2037
|
+
* is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
|
2038
|
+
* function or multiple functions that are joined by "+".
|
2039
|
+
*
|
2040
|
+
* * ranking_expression = function, { " + ", function };
|
2041
|
+
*
|
2042
|
+
* Supported functions:
|
2043
|
+
*
|
2044
|
+
* * double * relevance_score
|
2045
|
+
* * double * dotProduct(embedding_field_path)
|
2046
|
+
*
|
2047
|
+
* Function variables:
|
2048
|
+
*
|
2049
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
2050
|
+
* between query and document.
|
2051
|
+
* * `embedding_field_path`: the document embedding field
|
2052
|
+
* used with query embedding vector.
|
2053
|
+
* * `dotProduct`: embedding function between `embedding_field_path` and
|
2054
|
+
* query embedding vector.
|
2055
|
+
*
|
2056
|
+
* Example ranking expression:
|
2057
|
+
*
|
2058
|
+
* If document has an embedding field doc_embedding, the ranking expression
|
2059
|
+
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
2060
|
+
*
|
2061
|
+
* If
|
2062
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend|ranking_expression_backend}
|
2063
|
+
* is set to `RANK_BY_FORMULA`, the following expression types (and
|
2064
|
+
* combinations of those chained using + or
|
2065
|
+
* * operators) are supported:
|
2066
|
+
*
|
2067
|
+
* * `double`
|
2068
|
+
* * `signal`
|
2069
|
+
* * `log(signal)`
|
2070
|
+
* * `exp(signal)`
|
2071
|
+
* * `rr(signal, double > 0)` -- reciprocal rank transformation with second
|
2072
|
+
* argument being a denominator constant.
|
2073
|
+
* * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
|
2074
|
+
* * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
|
2075
|
+
* signal2 | double, else returns signal1.
|
2076
|
+
*
|
2077
|
+
* Here are a few examples of ranking formulas that use the supported
|
2078
|
+
* ranking expression types:
|
2079
|
+
*
|
2080
|
+
* - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
|
2081
|
+
* -- mostly rank by the logarithm of `keyword_similarity_score` with slight
|
2082
|
+
* `semantic_smilarity_score` adjustment.
|
2083
|
+
* - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
|
2084
|
+
* is_nan(keyword_similarity_score)` -- rank by the exponent of
|
2085
|
+
* `semantic_similarity_score` filling the value with 0 if it's NaN, also
|
2086
|
+
* add constant 0.3 adjustment to the final score if
|
2087
|
+
* `semantic_similarity_score` is NaN.
|
2088
|
+
* - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
|
2089
|
+
* rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
|
2090
|
+
* of `keyword_similarity_score` with slight adjustment of reciprocal rank
|
2091
|
+
* of `semantic_smilarity_score`.
|
2092
|
+
*
|
2093
|
+
* The following signals are supported:
|
2094
|
+
*
|
2095
|
+
* * `semantic_similarity_score`: semantic similarity adjustment that is
|
2096
|
+
* calculated using the embeddings generated by a proprietary Google model.
|
2097
|
+
* This score determines how semantically similar a search query is to a
|
2098
|
+
* document.
|
2099
|
+
* * `keyword_similarity_score`: keyword match adjustment uses the Best
|
2100
|
+
* Match 25 (BM25) ranking function. This score is calculated using a
|
2101
|
+
* probabilistic model to estimate the probability that a document is
|
2102
|
+
* relevant to a given query.
|
2103
|
+
* * `relevance_score`: semantic relevance adjustment that uses a
|
2104
|
+
* proprietary Google model to determine the meaning and intent behind a
|
2105
|
+
* user's query in context with the content in the documents.
|
2106
|
+
* * `pctr_rank`: predicted conversion rate adjustment as a rank use
|
2107
|
+
* predicted Click-through rate (pCTR) to gauge the relevance and
|
2108
|
+
* attractiveness of a search result from a user's perspective. A higher
|
2109
|
+
* pCTR suggests that the result is more likely to satisfy the user's query
|
2110
|
+
* and intent, making it a valuable signal for ranking.
|
2111
|
+
* * `freshness_rank`: freshness adjustment as a rank
|
2112
|
+
* * `document_age`: The time in hours elapsed since the document was last
|
2113
|
+
* updated, a floating-point number (e.g., 0.25 means 15 minutes).
|
2114
|
+
* * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
|
2115
|
+
* Google model to determine the keyword-based overlap between the query and
|
2116
|
+
* the document.
|
2117
|
+
* * `base_rank`: the default rank of the result
|
2118
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
|
2119
|
+
* The backend to use for the ranking expression evaluation.
|
1598
2120
|
* @param {object} [options]
|
1599
2121
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
1600
2122
|
* @returns {Object}
|
@@ -1659,6 +2181,117 @@ export declare class SearchServiceClient {
|
|
1659
2181
|
* ```
|
1660
2182
|
*/
|
1661
2183
|
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
2184
|
+
/**
|
2185
|
+
* Return a fully-qualified assistAnswer resource name string.
|
2186
|
+
*
|
2187
|
+
* @param {string} project
|
2188
|
+
* @param {string} location
|
2189
|
+
* @param {string} collection
|
2190
|
+
* @param {string} engine
|
2191
|
+
* @param {string} session
|
2192
|
+
* @param {string} assist_answer
|
2193
|
+
* @returns {string} Resource name string.
|
2194
|
+
*/
|
2195
|
+
assistAnswerPath(project: string, location: string, collection: string, engine: string, session: string, assistAnswer: string): string;
|
2196
|
+
/**
|
2197
|
+
* Parse the project from AssistAnswer resource.
|
2198
|
+
*
|
2199
|
+
* @param {string} assistAnswerName
|
2200
|
+
* A fully-qualified path representing AssistAnswer resource.
|
2201
|
+
* @returns {string} A string representing the project.
|
2202
|
+
*/
|
2203
|
+
matchProjectFromAssistAnswerName(assistAnswerName: string): string | number;
|
2204
|
+
/**
|
2205
|
+
* Parse the location from AssistAnswer resource.
|
2206
|
+
*
|
2207
|
+
* @param {string} assistAnswerName
|
2208
|
+
* A fully-qualified path representing AssistAnswer resource.
|
2209
|
+
* @returns {string} A string representing the location.
|
2210
|
+
*/
|
2211
|
+
matchLocationFromAssistAnswerName(assistAnswerName: string): string | number;
|
2212
|
+
/**
|
2213
|
+
* Parse the collection from AssistAnswer resource.
|
2214
|
+
*
|
2215
|
+
* @param {string} assistAnswerName
|
2216
|
+
* A fully-qualified path representing AssistAnswer resource.
|
2217
|
+
* @returns {string} A string representing the collection.
|
2218
|
+
*/
|
2219
|
+
matchCollectionFromAssistAnswerName(assistAnswerName: string): string | number;
|
2220
|
+
/**
|
2221
|
+
* Parse the engine from AssistAnswer resource.
|
2222
|
+
*
|
2223
|
+
* @param {string} assistAnswerName
|
2224
|
+
* A fully-qualified path representing AssistAnswer resource.
|
2225
|
+
* @returns {string} A string representing the engine.
|
2226
|
+
*/
|
2227
|
+
matchEngineFromAssistAnswerName(assistAnswerName: string): string | number;
|
2228
|
+
/**
|
2229
|
+
* Parse the session from AssistAnswer resource.
|
2230
|
+
*
|
2231
|
+
* @param {string} assistAnswerName
|
2232
|
+
* A fully-qualified path representing AssistAnswer resource.
|
2233
|
+
* @returns {string} A string representing the session.
|
2234
|
+
*/
|
2235
|
+
matchSessionFromAssistAnswerName(assistAnswerName: string): string | number;
|
2236
|
+
/**
|
2237
|
+
* Parse the assist_answer from AssistAnswer resource.
|
2238
|
+
*
|
2239
|
+
* @param {string} assistAnswerName
|
2240
|
+
* A fully-qualified path representing AssistAnswer resource.
|
2241
|
+
* @returns {string} A string representing the assist_answer.
|
2242
|
+
*/
|
2243
|
+
matchAssistAnswerFromAssistAnswerName(assistAnswerName: string): string | number;
|
2244
|
+
/**
|
2245
|
+
* Return a fully-qualified assistant resource name string.
|
2246
|
+
*
|
2247
|
+
* @param {string} project
|
2248
|
+
* @param {string} location
|
2249
|
+
* @param {string} collection
|
2250
|
+
* @param {string} engine
|
2251
|
+
* @param {string} assistant
|
2252
|
+
* @returns {string} Resource name string.
|
2253
|
+
*/
|
2254
|
+
assistantPath(project: string, location: string, collection: string, engine: string, assistant: string): string;
|
2255
|
+
/**
|
2256
|
+
* Parse the project from Assistant resource.
|
2257
|
+
*
|
2258
|
+
* @param {string} assistantName
|
2259
|
+
* A fully-qualified path representing Assistant resource.
|
2260
|
+
* @returns {string} A string representing the project.
|
2261
|
+
*/
|
2262
|
+
matchProjectFromAssistantName(assistantName: string): string | number;
|
2263
|
+
/**
|
2264
|
+
* Parse the location from Assistant resource.
|
2265
|
+
*
|
2266
|
+
* @param {string} assistantName
|
2267
|
+
* A fully-qualified path representing Assistant resource.
|
2268
|
+
* @returns {string} A string representing the location.
|
2269
|
+
*/
|
2270
|
+
matchLocationFromAssistantName(assistantName: string): string | number;
|
2271
|
+
/**
|
2272
|
+
* Parse the collection from Assistant resource.
|
2273
|
+
*
|
2274
|
+
* @param {string} assistantName
|
2275
|
+
* A fully-qualified path representing Assistant resource.
|
2276
|
+
* @returns {string} A string representing the collection.
|
2277
|
+
*/
|
2278
|
+
matchCollectionFromAssistantName(assistantName: string): string | number;
|
2279
|
+
/**
|
2280
|
+
* Parse the engine from Assistant resource.
|
2281
|
+
*
|
2282
|
+
* @param {string} assistantName
|
2283
|
+
* A fully-qualified path representing Assistant resource.
|
2284
|
+
* @returns {string} A string representing the engine.
|
2285
|
+
*/
|
2286
|
+
matchEngineFromAssistantName(assistantName: string): string | number;
|
2287
|
+
/**
|
2288
|
+
* Parse the assistant from Assistant resource.
|
2289
|
+
*
|
2290
|
+
* @param {string} assistantName
|
2291
|
+
* A fully-qualified path representing Assistant resource.
|
2292
|
+
* @returns {string} A string representing the assistant.
|
2293
|
+
*/
|
2294
|
+
matchAssistantFromAssistantName(assistantName: string): string | number;
|
1662
2295
|
/**
|
1663
2296
|
* Return a fully-qualified engine resource name string.
|
1664
2297
|
*
|
@@ -2325,57 +2958,6 @@ export declare class SearchServiceClient {
|
|
2325
2958
|
* @returns {string} A string representing the serving_config.
|
2326
2959
|
*/
|
2327
2960
|
matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
2328
|
-
/**
|
2329
|
-
* Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
|
2330
|
-
*
|
2331
|
-
* @param {string} project
|
2332
|
-
* @param {string} location
|
2333
|
-
* @param {string} collection
|
2334
|
-
* @param {string} data_store
|
2335
|
-
* @param {string} session
|
2336
|
-
* @returns {string} Resource name string.
|
2337
|
-
*/
|
2338
|
-
projectLocationCollectionDataStoreSessionPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
|
2339
|
-
/**
|
2340
|
-
* Parse the project from ProjectLocationCollectionDataStoreSession resource.
|
2341
|
-
*
|
2342
|
-
* @param {string} projectLocationCollectionDataStoreSessionName
|
2343
|
-
* A fully-qualified path representing project_location_collection_data_store_session resource.
|
2344
|
-
* @returns {string} A string representing the project.
|
2345
|
-
*/
|
2346
|
-
matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
|
2347
|
-
/**
|
2348
|
-
* Parse the location from ProjectLocationCollectionDataStoreSession resource.
|
2349
|
-
*
|
2350
|
-
* @param {string} projectLocationCollectionDataStoreSessionName
|
2351
|
-
* A fully-qualified path representing project_location_collection_data_store_session resource.
|
2352
|
-
* @returns {string} A string representing the location.
|
2353
|
-
*/
|
2354
|
-
matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
|
2355
|
-
/**
|
2356
|
-
* Parse the collection from ProjectLocationCollectionDataStoreSession resource.
|
2357
|
-
*
|
2358
|
-
* @param {string} projectLocationCollectionDataStoreSessionName
|
2359
|
-
* A fully-qualified path representing project_location_collection_data_store_session resource.
|
2360
|
-
* @returns {string} A string representing the collection.
|
2361
|
-
*/
|
2362
|
-
matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
|
2363
|
-
/**
|
2364
|
-
* Parse the data_store from ProjectLocationCollectionDataStoreSession resource.
|
2365
|
-
*
|
2366
|
-
* @param {string} projectLocationCollectionDataStoreSessionName
|
2367
|
-
* A fully-qualified path representing project_location_collection_data_store_session resource.
|
2368
|
-
* @returns {string} A string representing the data_store.
|
2369
|
-
*/
|
2370
|
-
matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
|
2371
|
-
/**
|
2372
|
-
* Parse the session from ProjectLocationCollectionDataStoreSession resource.
|
2373
|
-
*
|
2374
|
-
* @param {string} projectLocationCollectionDataStoreSessionName
|
2375
|
-
* A fully-qualified path representing project_location_collection_data_store_session resource.
|
2376
|
-
* @returns {string} A string representing the session.
|
2377
|
-
*/
|
2378
|
-
matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
|
2379
2961
|
/**
|
2380
2962
|
* Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
|
2381
2963
|
*
|
@@ -2436,6 +3018,57 @@ export declare class SearchServiceClient {
|
|
2436
3018
|
* @returns {string} A string representing the answer.
|
2437
3019
|
*/
|
2438
3020
|
matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
|
3021
|
+
/**
|
3022
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSessions resource name string.
|
3023
|
+
*
|
3024
|
+
* @param {string} project
|
3025
|
+
* @param {string} location
|
3026
|
+
* @param {string} collection
|
3027
|
+
* @param {string} data_store
|
3028
|
+
* @param {string} session
|
3029
|
+
* @returns {string} Resource name string.
|
3030
|
+
*/
|
3031
|
+
projectLocationCollectionDataStoreSessionsPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
|
3032
|
+
/**
|
3033
|
+
* Parse the project from ProjectLocationCollectionDataStoreSessions resource.
|
3034
|
+
*
|
3035
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
3036
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
3037
|
+
* @returns {string} A string representing the project.
|
3038
|
+
*/
|
3039
|
+
matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
|
3040
|
+
/**
|
3041
|
+
* Parse the location from ProjectLocationCollectionDataStoreSessions resource.
|
3042
|
+
*
|
3043
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
3044
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
3045
|
+
* @returns {string} A string representing the location.
|
3046
|
+
*/
|
3047
|
+
matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
|
3048
|
+
/**
|
3049
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSessions resource.
|
3050
|
+
*
|
3051
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
3052
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
3053
|
+
* @returns {string} A string representing the collection.
|
3054
|
+
*/
|
3055
|
+
matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
|
3056
|
+
/**
|
3057
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.
|
3058
|
+
*
|
3059
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
3060
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
3061
|
+
* @returns {string} A string representing the data_store.
|
3062
|
+
*/
|
3063
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
|
3064
|
+
/**
|
3065
|
+
* Parse the session from ProjectLocationCollectionDataStoreSessions resource.
|
3066
|
+
*
|
3067
|
+
* @param {string} projectLocationCollectionDataStoreSessionsName
|
3068
|
+
* A fully-qualified path representing project_location_collection_data_store_sessions resource.
|
3069
|
+
* @returns {string} A string representing the session.
|
3070
|
+
*/
|
3071
|
+
matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
|
2439
3072
|
/**
|
2440
3073
|
* Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
|
2441
3074
|
*
|
@@ -2733,57 +3366,6 @@ export declare class SearchServiceClient {
|
|
2733
3366
|
* @returns {string} A string representing the serving_config.
|
2734
3367
|
*/
|
2735
3368
|
matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
2736
|
-
/**
|
2737
|
-
* Return a fully-qualified projectLocationCollectionEngineSession resource name string.
|
2738
|
-
*
|
2739
|
-
* @param {string} project
|
2740
|
-
* @param {string} location
|
2741
|
-
* @param {string} collection
|
2742
|
-
* @param {string} engine
|
2743
|
-
* @param {string} session
|
2744
|
-
* @returns {string} Resource name string.
|
2745
|
-
*/
|
2746
|
-
projectLocationCollectionEngineSessionPath(project: string, location: string, collection: string, engine: string, session: string): string;
|
2747
|
-
/**
|
2748
|
-
* Parse the project from ProjectLocationCollectionEngineSession resource.
|
2749
|
-
*
|
2750
|
-
* @param {string} projectLocationCollectionEngineSessionName
|
2751
|
-
* A fully-qualified path representing project_location_collection_engine_session resource.
|
2752
|
-
* @returns {string} A string representing the project.
|
2753
|
-
*/
|
2754
|
-
matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
|
2755
|
-
/**
|
2756
|
-
* Parse the location from ProjectLocationCollectionEngineSession resource.
|
2757
|
-
*
|
2758
|
-
* @param {string} projectLocationCollectionEngineSessionName
|
2759
|
-
* A fully-qualified path representing project_location_collection_engine_session resource.
|
2760
|
-
* @returns {string} A string representing the location.
|
2761
|
-
*/
|
2762
|
-
matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
|
2763
|
-
/**
|
2764
|
-
* Parse the collection from ProjectLocationCollectionEngineSession resource.
|
2765
|
-
*
|
2766
|
-
* @param {string} projectLocationCollectionEngineSessionName
|
2767
|
-
* A fully-qualified path representing project_location_collection_engine_session resource.
|
2768
|
-
* @returns {string} A string representing the collection.
|
2769
|
-
*/
|
2770
|
-
matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
|
2771
|
-
/**
|
2772
|
-
* Parse the engine from ProjectLocationCollectionEngineSession resource.
|
2773
|
-
*
|
2774
|
-
* @param {string} projectLocationCollectionEngineSessionName
|
2775
|
-
* A fully-qualified path representing project_location_collection_engine_session resource.
|
2776
|
-
* @returns {string} A string representing the engine.
|
2777
|
-
*/
|
2778
|
-
matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
|
2779
|
-
/**
|
2780
|
-
* Parse the session from ProjectLocationCollectionEngineSession resource.
|
2781
|
-
*
|
2782
|
-
* @param {string} projectLocationCollectionEngineSessionName
|
2783
|
-
* A fully-qualified path representing project_location_collection_engine_session resource.
|
2784
|
-
* @returns {string} A string representing the session.
|
2785
|
-
*/
|
2786
|
-
matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
|
2787
3369
|
/**
|
2788
3370
|
* Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
|
2789
3371
|
*
|
@@ -2844,6 +3426,57 @@ export declare class SearchServiceClient {
|
|
2844
3426
|
* @returns {string} A string representing the answer.
|
2845
3427
|
*/
|
2846
3428
|
matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
|
3429
|
+
/**
|
3430
|
+
* Return a fully-qualified projectLocationCollectionEngineSessions resource name string.
|
3431
|
+
*
|
3432
|
+
* @param {string} project
|
3433
|
+
* @param {string} location
|
3434
|
+
* @param {string} collection
|
3435
|
+
* @param {string} engine
|
3436
|
+
* @param {string} session
|
3437
|
+
* @returns {string} Resource name string.
|
3438
|
+
*/
|
3439
|
+
projectLocationCollectionEngineSessionsPath(project: string, location: string, collection: string, engine: string, session: string): string;
|
3440
|
+
/**
|
3441
|
+
* Parse the project from ProjectLocationCollectionEngineSessions resource.
|
3442
|
+
*
|
3443
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
3444
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
3445
|
+
* @returns {string} A string representing the project.
|
3446
|
+
*/
|
3447
|
+
matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
|
3448
|
+
/**
|
3449
|
+
* Parse the location from ProjectLocationCollectionEngineSessions resource.
|
3450
|
+
*
|
3451
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
3452
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
3453
|
+
* @returns {string} A string representing the location.
|
3454
|
+
*/
|
3455
|
+
matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
|
3456
|
+
/**
|
3457
|
+
* Parse the collection from ProjectLocationCollectionEngineSessions resource.
|
3458
|
+
*
|
3459
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
3460
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
3461
|
+
* @returns {string} A string representing the collection.
|
3462
|
+
*/
|
3463
|
+
matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
|
3464
|
+
/**
|
3465
|
+
* Parse the engine from ProjectLocationCollectionEngineSessions resource.
|
3466
|
+
*
|
3467
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
3468
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
3469
|
+
* @returns {string} A string representing the engine.
|
3470
|
+
*/
|
3471
|
+
matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
|
3472
|
+
/**
|
3473
|
+
* Parse the session from ProjectLocationCollectionEngineSessions resource.
|
3474
|
+
*
|
3475
|
+
* @param {string} projectLocationCollectionEngineSessionsName
|
3476
|
+
* A fully-qualified path representing project_location_collection_engine_sessions resource.
|
3477
|
+
* @returns {string} A string representing the session.
|
3478
|
+
*/
|
3479
|
+
matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
|
2847
3480
|
/**
|
2848
3481
|
* Return a fully-qualified projectLocationDataStore resource name string.
|
2849
3482
|
*
|
@@ -3273,48 +3906,6 @@ export declare class SearchServiceClient {
|
|
3273
3906
|
* @returns {string} A string representing the serving_config.
|
3274
3907
|
*/
|
3275
3908
|
matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
3276
|
-
/**
|
3277
|
-
* Return a fully-qualified projectLocationDataStoreSession resource name string.
|
3278
|
-
*
|
3279
|
-
* @param {string} project
|
3280
|
-
* @param {string} location
|
3281
|
-
* @param {string} data_store
|
3282
|
-
* @param {string} session
|
3283
|
-
* @returns {string} Resource name string.
|
3284
|
-
*/
|
3285
|
-
projectLocationDataStoreSessionPath(project: string, location: string, dataStore: string, session: string): string;
|
3286
|
-
/**
|
3287
|
-
* Parse the project from ProjectLocationDataStoreSession resource.
|
3288
|
-
*
|
3289
|
-
* @param {string} projectLocationDataStoreSessionName
|
3290
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3291
|
-
* @returns {string} A string representing the project.
|
3292
|
-
*/
|
3293
|
-
matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
|
3294
|
-
/**
|
3295
|
-
* Parse the location from ProjectLocationDataStoreSession resource.
|
3296
|
-
*
|
3297
|
-
* @param {string} projectLocationDataStoreSessionName
|
3298
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3299
|
-
* @returns {string} A string representing the location.
|
3300
|
-
*/
|
3301
|
-
matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
|
3302
|
-
/**
|
3303
|
-
* Parse the data_store from ProjectLocationDataStoreSession resource.
|
3304
|
-
*
|
3305
|
-
* @param {string} projectLocationDataStoreSessionName
|
3306
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3307
|
-
* @returns {string} A string representing the data_store.
|
3308
|
-
*/
|
3309
|
-
matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
|
3310
|
-
/**
|
3311
|
-
* Parse the session from ProjectLocationDataStoreSession resource.
|
3312
|
-
*
|
3313
|
-
* @param {string} projectLocationDataStoreSessionName
|
3314
|
-
* A fully-qualified path representing project_location_data_store_session resource.
|
3315
|
-
* @returns {string} A string representing the session.
|
3316
|
-
*/
|
3317
|
-
matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
|
3318
3909
|
/**
|
3319
3910
|
* Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.
|
3320
3911
|
*
|
@@ -3366,6 +3957,48 @@ export declare class SearchServiceClient {
|
|
3366
3957
|
* @returns {string} A string representing the answer.
|
3367
3958
|
*/
|
3368
3959
|
matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
|
3960
|
+
/**
|
3961
|
+
* Return a fully-qualified projectLocationDataStoreSessions resource name string.
|
3962
|
+
*
|
3963
|
+
* @param {string} project
|
3964
|
+
* @param {string} location
|
3965
|
+
* @param {string} data_store
|
3966
|
+
* @param {string} session
|
3967
|
+
* @returns {string} Resource name string.
|
3968
|
+
*/
|
3969
|
+
projectLocationDataStoreSessionsPath(project: string, location: string, dataStore: string, session: string): string;
|
3970
|
+
/**
|
3971
|
+
* Parse the project from ProjectLocationDataStoreSessions resource.
|
3972
|
+
*
|
3973
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3974
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3975
|
+
* @returns {string} A string representing the project.
|
3976
|
+
*/
|
3977
|
+
matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
|
3978
|
+
/**
|
3979
|
+
* Parse the location from ProjectLocationDataStoreSessions resource.
|
3980
|
+
*
|
3981
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3982
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3983
|
+
* @returns {string} A string representing the location.
|
3984
|
+
*/
|
3985
|
+
matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
|
3986
|
+
/**
|
3987
|
+
* Parse the data_store from ProjectLocationDataStoreSessions resource.
|
3988
|
+
*
|
3989
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3990
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3991
|
+
* @returns {string} A string representing the data_store.
|
3992
|
+
*/
|
3993
|
+
matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
|
3994
|
+
/**
|
3995
|
+
* Parse the session from ProjectLocationDataStoreSessions resource.
|
3996
|
+
*
|
3997
|
+
* @param {string} projectLocationDataStoreSessionsName
|
3998
|
+
* A fully-qualified path representing project_location_data_store_sessions resource.
|
3999
|
+
* @returns {string} A string representing the session.
|
4000
|
+
*/
|
4001
|
+
matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
|
3369
4002
|
/**
|
3370
4003
|
* Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
|
3371
4004
|
*
|