google-cloud-discovery_engine-v1 2.13.0 → 2.14.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.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +4 -4
- data/README.md +8 -10
- data/lib/google/cloud/discovery_engine/v1/acl_config_service/client.rb +591 -0
- data/lib/google/cloud/discovery_engine/v1/acl_config_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1/acl_config_service/paths.rb +50 -0
- data/lib/google/cloud/discovery_engine/v1/acl_config_service/rest/client.rb +534 -0
- data/lib/google/cloud/discovery_engine/v1/acl_config_service/rest/service_stub.rb +204 -0
- data/lib/google/cloud/discovery_engine/v1/acl_config_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/acl_config_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/client.rb +528 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1/assistant_service/paths.rb +104 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/rest/client.rb +493 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/rest/service_stub.rb +307 -0
- data/lib/google/cloud/discovery_engine/v1/cmek_config_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/client.rb +732 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/operations.rb +843 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/rest/client.rb +668 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/rest/operations.rb +1168 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/rest/service_stub.rb +265 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1/collection_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +162 -4
- data/lib/google/cloud/discovery_engine/v1/completion_service/credentials.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1/completion_service/paths.rb +62 -0
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +155 -4
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +78 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +37 -9
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +37 -9
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/client.rb +779 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/credentials.rb +50 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/operations.rb +843 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/paths.rb +227 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest/client.rb +715 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest/operations.rb +1168 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest/service_stub.rb +274 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1/data_connector_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +215 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +62 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +201 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb +138 -0
- data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +0 -1
- data/lib/google/cloud/discovery_engine/v1/document_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +0 -1
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +218 -3
- data/lib/google/cloud/discovery_engine/v1/engine_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/engine_service/paths.rb +104 -0
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +204 -3
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb +123 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/client.rb +1 -0
- data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/client.rb +1 -0
- data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/license_config_service/client.rb +1044 -0
- data/lib/google/cloud/discovery_engine/v1/license_config_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1/license_config_service/paths.rb +86 -0
- data/lib/google/cloud/discovery_engine/v1/license_config_service/rest/client.rb +959 -0
- data/lib/google/cloud/discovery_engine/v1/license_config_service/rest/service_stub.rb +451 -0
- data/lib/google/cloud/discovery_engine/v1/license_config_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/license_config_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/project_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/client.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1/rank_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/rest.rb +8 -2
- data/lib/google/cloud/discovery_engine/v1/schema_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +14 -2
- data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +14 -2
- data/lib/google/cloud/discovery_engine/v1/search_tuning_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/serving_config_service/client.rb +408 -3
- data/lib/google/cloud/discovery_engine/v1/serving_config_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/serving_config_service/paths.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1/serving_config_service/rest/client.rb +380 -3
- data/lib/google/cloud/discovery_engine/v1/serving_config_service/rest/service_stub.rb +303 -0
- data/lib/google/cloud/discovery_engine/v1/session_service/client.rb +25 -9
- data/lib/google/cloud/discovery_engine/v1/session_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1/session_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/session_service/rest/client.rb +25 -9
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/user_event_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/user_license_service/client.rb +124 -7
- data/lib/google/cloud/discovery_engine/v1/user_license_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/client.rb +117 -7
- data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/operations.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/service_stub.rb +61 -0
- data/lib/google/cloud/discovery_engine/v1/user_store_service/client.rb +590 -0
- data/lib/google/cloud/discovery_engine/v1/user_store_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1/user_store_service/paths.rb +71 -0
- data/lib/google/cloud/discovery_engine/v1/user_store_service/rest/client.rb +533 -0
- data/lib/google/cloud/discovery_engine/v1/user_store_service/rest/service_stub.rb +204 -0
- data/lib/google/cloud/discovery_engine/v1/user_store_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/user_store_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1/widget_config_service/client.rb +624 -0
- data/lib/google/cloud/discovery_engine/v1/widget_config_service/credentials.rb +50 -0
- data/lib/google/cloud/discovery_engine/v1/widget_config_service/paths.rb +101 -0
- data/lib/google/cloud/discovery_engine/v1/widget_config_service/rest/client.rb +567 -0
- data/lib/google/cloud/discovery_engine/v1/widget_config_service/rest/service_stub.rb +234 -0
- data/lib/google/cloud/discovery_engine/v1/widget_config_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1/widget_config_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1.rb +9 -3
- data/lib/google/cloud/discoveryengine/v1/acl_config_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1/acl_config_service_pb.rb +28 -0
- data/lib/google/cloud/discoveryengine/v1/acl_config_service_services_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/agent_gateway_setting_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1/assist_answer_pb.rb +13 -1
- data/lib/google/cloud/discoveryengine/v1/assistant_pb.rb +13 -1
- data/lib/google/cloud/discoveryengine/v1/assistant_service_pb.rb +12 -1
- data/lib/google/cloud/discoveryengine/v1/assistant_service_services_pb.rb +12 -1
- data/lib/google/cloud/discoveryengine/v1/chunk_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/cmek_config_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/cmek_config_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/collection_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1/collection_service_pb.rb +32 -0
- data/lib/google/cloud/discoveryengine/v1/collection_service_services_pb.rb +65 -0
- data/lib/google/cloud/discoveryengine/v1/common_pb.rb +13 -1
- data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +16 -1
- data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/control_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/control_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/data_connector_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1/data_connector_service_pb.rb +32 -0
- data/lib/google/cloud/discoveryengine/v1/data_connector_service_services_pb.rb +58 -0
- data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +10 -1
- data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/data_store_service_services_pb.rb +20 -1
- data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +11 -1
- data/lib/google/cloud/discoveryengine/v1/engine_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/engine_service_services_pb.rb +23 -4
- data/lib/google/cloud/discoveryengine/v1/feedback_pb.rb +28 -0
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/license_config_pb.rb +28 -0
- data/lib/google/cloud/discoveryengine/v1/license_config_service_pb.rb +36 -0
- data/lib/google/cloud/discoveryengine/v1/license_config_service_services_pb.rb +63 -0
- data/lib/google/cloud/discoveryengine/v1/logging_pb.rb +24 -0
- data/lib/google/cloud/discoveryengine/v1/project_pb.rb +11 -1
- data/lib/google/cloud/discoveryengine/v1/project_service_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1/project_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/rank_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/rank_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/recommendation_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/recommendation_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/schema_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/search_tuning_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/search_tuning_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/serving_config_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/serving_config_service_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1/serving_config_service_services_pb.rb +21 -1
- data/lib/google/cloud/discoveryengine/v1/session_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/session_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/session_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_license_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1/user_license_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/user_license_service_services_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1/user_store_pb.rb +24 -0
- data/lib/google/cloud/discoveryengine/v1/user_store_service_pb.rb +29 -0
- data/lib/google/cloud/discoveryengine/v1/user_store_service_services_pb.rb +47 -0
- data/lib/google/cloud/discoveryengine/v1/widget_config_pb.rb +63 -0
- data/lib/google/cloud/discoveryengine/v1/widget_config_service_pb.rb +30 -0
- data/lib/google/cloud/discoveryengine/v1/widget_config_service_services_pb.rb +48 -0
- data/proto_docs/google/cloud/discoveryengine/v1/acl_config.rb +43 -0
- data/proto_docs/google/cloud/discoveryengine/v1/acl_config_service.rb +49 -0
- data/proto_docs/google/cloud/discoveryengine/v1/agent_gateway_setting.rb +53 -0
- data/proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb +164 -1
- data/proto_docs/google/cloud/discoveryengine/v1/assistant.rb +217 -0
- data/proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb +179 -6
- data/proto_docs/google/cloud/discoveryengine/v1/chunk.rb +4 -0
- data/proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb +7 -2
- data/proto_docs/google/cloud/discoveryengine/v1/collection.rb +51 -0
- data/proto_docs/google/cloud/discoveryengine/v1/collection_service.rb +53 -0
- data/proto_docs/google/cloud/discoveryengine/v1/common.rb +201 -0
- data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +320 -4
- data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +31 -8
- data/proto_docs/google/cloud/discoveryengine/v1/data_connector.rb +875 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_connector_service.rb +142 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +179 -2
- data/proto_docs/google/cloud/discoveryengine/v1/document.rb +9 -4
- data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +7 -0
- data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +251 -1
- data/proto_docs/google/cloud/discoveryengine/v1/feedback.rb +165 -0
- data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +107 -0
- data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb +1 -0
- data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +6 -4
- data/proto_docs/google/cloud/discoveryengine/v1/license_config.rb +107 -0
- data/proto_docs/google/cloud/discoveryengine/v1/license_config_service.rb +220 -0
- data/proto_docs/google/cloud/discoveryengine/v1/logging.rb +40 -0
- data/proto_docs/google/cloud/discoveryengine/v1/project.rb +229 -0
- data/proto_docs/google/cloud/discoveryengine/v1/project_service.rb +18 -0
- data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +2 -1
- data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +3 -3
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +7 -1
- data/proto_docs/google/cloud/discoveryengine/v1/serving_config.rb +43 -0
- data/proto_docs/google/cloud/discoveryengine/v1/serving_config_service.rb +71 -0
- data/proto_docs/google/cloud/discoveryengine/v1/session.rb +9 -0
- data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +16 -6
- data/proto_docs/google/cloud/discoveryengine/v1/user_license.rb +16 -1
- data/proto_docs/google/cloud/discoveryengine/v1/user_license_service.rb +53 -6
- data/proto_docs/google/cloud/discoveryengine/v1/user_store.rb +66 -0
- data/proto_docs/google/cloud/discoveryengine/v1/user_store_service.rb +54 -0
- data/proto_docs/google/cloud/discoveryengine/v1/widget_config.rb +1082 -0
- data/proto_docs/google/cloud/discoveryengine/v1/widget_config_service.rb +102 -0
- data/proto_docs/google/iam/v1/iam_policy.rb +87 -0
- data/proto_docs/google/iam/v1/options.rb +50 -0
- data/proto_docs/google/iam/v1/policy.rb +426 -0
- data/proto_docs/google/type/date.rb +1 -1
- data/proto_docs/google/type/datetime.rb +104 -0
- data/proto_docs/google/type/expr.rb +75 -0
- data/proto_docs/google/type/latlng.rb +38 -0
- metadata +103 -1
|
@@ -255,10 +255,10 @@ module Google
|
|
|
255
255
|
# * `document` is the default model for regular dataStores.
|
|
256
256
|
# * `search-history` is the default model for site search dataStores.
|
|
257
257
|
# @param user_pseudo_id [::String]
|
|
258
|
-
# A unique identifier for tracking visitors. For example, this
|
|
259
|
-
# implemented with an HTTP cookie, which should be able to uniquely
|
|
260
|
-
# a visitor on a single device. This unique identifier should not
|
|
261
|
-
# the visitor logs in or out of the website.
|
|
258
|
+
# Optional. A unique identifier for tracking visitors. For example, this
|
|
259
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
|
260
|
+
# identify a visitor on a single device. This unique identifier should not
|
|
261
|
+
# change if the visitor logs in or out of the website.
|
|
262
262
|
#
|
|
263
263
|
# This field should NOT have a fixed value such as `unknown_visitor`.
|
|
264
264
|
#
|
|
@@ -332,6 +332,150 @@ module Google
|
|
|
332
332
|
raise ::Google::Cloud::Error.from_error(e)
|
|
333
333
|
end
|
|
334
334
|
|
|
335
|
+
##
|
|
336
|
+
# Completes the user input with advanced keyword suggestions.
|
|
337
|
+
#
|
|
338
|
+
# @overload advanced_complete_query(request, options = nil)
|
|
339
|
+
# Pass arguments to `advanced_complete_query` via a request object, either of type
|
|
340
|
+
# {::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest} or an equivalent Hash.
|
|
341
|
+
#
|
|
342
|
+
# @param request [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest, ::Hash]
|
|
343
|
+
# A request object representing the call parameters. Required. To specify no
|
|
344
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
345
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
346
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
347
|
+
#
|
|
348
|
+
# @overload advanced_complete_query(completion_config: nil, query: nil, query_model: nil, user_pseudo_id: nil, user_info: nil, include_tail_suggestions: nil, boost_spec: nil, suggestion_types: nil, suggestion_type_specs: nil, experiment_ids: nil)
|
|
349
|
+
# Pass arguments to `advanced_complete_query` via keyword arguments. Note that at
|
|
350
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
351
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
352
|
+
#
|
|
353
|
+
# @param completion_config [::String]
|
|
354
|
+
# Required. The completion_config of the parent dataStore or engine resource
|
|
355
|
+
# name for which the completion is performed, such as
|
|
356
|
+
# `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
|
|
357
|
+
# `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
|
|
358
|
+
# @param query [::String]
|
|
359
|
+
# Required. The typeahead input used to fetch suggestions. Maximum length is
|
|
360
|
+
# 128 characters.
|
|
361
|
+
#
|
|
362
|
+
# The query can not be empty for most of the suggestion types. If it is
|
|
363
|
+
# empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
|
|
364
|
+
# suggestion_types contains only the type `RECENT_SEARCH`, the query can
|
|
365
|
+
# be an empty string. The is called "zero prefix" feature, which returns
|
|
366
|
+
# user's recently searched queries given the empty query.
|
|
367
|
+
# @param query_model [::String]
|
|
368
|
+
# Specifies the autocomplete query model, which only applies to the QUERY
|
|
369
|
+
# SuggestionType. This overrides any model specified in the Configuration >
|
|
370
|
+
# Autocomplete section of the Cloud console. Currently supported values:
|
|
371
|
+
#
|
|
372
|
+
# * `document` - Using suggestions generated from user-imported documents.
|
|
373
|
+
# * `search-history` - Using suggestions generated from the past history of
|
|
374
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client#search SearchService.Search}
|
|
375
|
+
# API calls. Do not use it when there is no traffic for Search API.
|
|
376
|
+
# * `user-event` - Using suggestions generated from user-imported search
|
|
377
|
+
# events.
|
|
378
|
+
# * `document-completable` - Using suggestions taken directly from
|
|
379
|
+
# user-imported document fields marked as completable.
|
|
380
|
+
#
|
|
381
|
+
# Default values:
|
|
382
|
+
#
|
|
383
|
+
# * `document` is the default model for regular dataStores.
|
|
384
|
+
# * `search-history` is the default model for site search dataStores.
|
|
385
|
+
# @param user_pseudo_id [::String]
|
|
386
|
+
# Optional. A unique identifier for tracking visitors. For example, this
|
|
387
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
|
388
|
+
# identify a visitor on a single device. This unique identifier should not
|
|
389
|
+
# change if the visitor logs in or out of the website.
|
|
390
|
+
#
|
|
391
|
+
# This field should NOT have a fixed value such as `unknown_visitor`.
|
|
392
|
+
#
|
|
393
|
+
# This should be the same identifier as
|
|
394
|
+
# {::Google::Cloud::DiscoveryEngine::V1::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
|
|
395
|
+
# and
|
|
396
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
|
|
397
|
+
#
|
|
398
|
+
# The field must be a UTF-8 encoded string with a length limit of 128
|
|
399
|
+
# @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
|
|
400
|
+
# Optional. Information about the end user.
|
|
401
|
+
#
|
|
402
|
+
# This should be the same identifier information as
|
|
403
|
+
# {::Google::Cloud::DiscoveryEngine::V1::UserEvent#user_info UserEvent.user_info}
|
|
404
|
+
# and
|
|
405
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#user_info SearchRequest.user_info}.
|
|
406
|
+
# @param include_tail_suggestions [::Boolean]
|
|
407
|
+
# Indicates if tail suggestions should be returned if there are no
|
|
408
|
+
# suggestions that match the full query. Even if set to true, if there are
|
|
409
|
+
# suggestions that match the full query, those are returned and no
|
|
410
|
+
# tail suggestions are returned.
|
|
411
|
+
# @param boost_spec [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest::BoostSpec, ::Hash]
|
|
412
|
+
# Optional. Specification to boost suggestions matching the condition.
|
|
413
|
+
# @param suggestion_types [::Array<::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest::SuggestionType>]
|
|
414
|
+
# Optional. Suggestion types to return. If empty or unspecified, query
|
|
415
|
+
# suggestions are returned. Only one suggestion type is supported at the
|
|
416
|
+
# moment.
|
|
417
|
+
# @param suggestion_type_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest::SuggestionTypeSpec, ::Hash>]
|
|
418
|
+
# Optional. Specification of each suggestion type.
|
|
419
|
+
# @param experiment_ids [::Array<::String>]
|
|
420
|
+
# Optional. Experiment ids for this request.
|
|
421
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
422
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryResponse]
|
|
423
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
424
|
+
#
|
|
425
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryResponse]
|
|
426
|
+
#
|
|
427
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
428
|
+
#
|
|
429
|
+
# @example Basic example
|
|
430
|
+
# require "google/cloud/discovery_engine/v1"
|
|
431
|
+
#
|
|
432
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
433
|
+
# client = Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new
|
|
434
|
+
#
|
|
435
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
436
|
+
# request = Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest.new
|
|
437
|
+
#
|
|
438
|
+
# # Call the advanced_complete_query method.
|
|
439
|
+
# result = client.advanced_complete_query request
|
|
440
|
+
#
|
|
441
|
+
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryResponse.
|
|
442
|
+
# p result
|
|
443
|
+
#
|
|
444
|
+
def advanced_complete_query request, options = nil
|
|
445
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
446
|
+
|
|
447
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest
|
|
448
|
+
|
|
449
|
+
# Converts hash and nil to an options object
|
|
450
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
451
|
+
|
|
452
|
+
# Customize the options with defaults
|
|
453
|
+
call_metadata = @config.rpcs.advanced_complete_query.metadata.to_h
|
|
454
|
+
|
|
455
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
456
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
457
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
458
|
+
gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
|
|
459
|
+
transports_version_send: [:rest]
|
|
460
|
+
|
|
461
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
462
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
463
|
+
|
|
464
|
+
options.apply_defaults timeout: @config.rpcs.advanced_complete_query.timeout,
|
|
465
|
+
metadata: call_metadata,
|
|
466
|
+
retry_policy: @config.rpcs.advanced_complete_query.retry_policy
|
|
467
|
+
|
|
468
|
+
options.apply_defaults timeout: @config.timeout,
|
|
469
|
+
metadata: @config.metadata,
|
|
470
|
+
retry_policy: @config.retry_policy
|
|
471
|
+
|
|
472
|
+
@completion_service_stub.advanced_complete_query request, options do |result, operation|
|
|
473
|
+
yield result, operation if block_given?
|
|
474
|
+
end
|
|
475
|
+
rescue ::Gapic::Rest::Error => e
|
|
476
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
477
|
+
end
|
|
478
|
+
|
|
335
479
|
##
|
|
336
480
|
# Imports all
|
|
337
481
|
# {::Google::Cloud::DiscoveryEngine::V1::SuggestionDenyListEntry SuggestionDenyListEntry}
|
|
@@ -878,6 +1022,11 @@ module Google
|
|
|
878
1022
|
#
|
|
879
1023
|
attr_reader :complete_query
|
|
880
1024
|
##
|
|
1025
|
+
# RPC-specific configuration for `advanced_complete_query`
|
|
1026
|
+
# @return [::Gapic::Config::Method]
|
|
1027
|
+
#
|
|
1028
|
+
attr_reader :advanced_complete_query
|
|
1029
|
+
##
|
|
881
1030
|
# RPC-specific configuration for `import_suggestion_deny_list_entries`
|
|
882
1031
|
# @return [::Gapic::Config::Method]
|
|
883
1032
|
#
|
|
@@ -902,6 +1051,8 @@ module Google
|
|
|
902
1051
|
def initialize parent_rpcs = nil
|
|
903
1052
|
complete_query_config = parent_rpcs.complete_query if parent_rpcs.respond_to? :complete_query
|
|
904
1053
|
@complete_query = ::Gapic::Config::Method.new complete_query_config
|
|
1054
|
+
advanced_complete_query_config = parent_rpcs.advanced_complete_query if parent_rpcs.respond_to? :advanced_complete_query
|
|
1055
|
+
@advanced_complete_query = ::Gapic::Config::Method.new advanced_complete_query_config
|
|
905
1056
|
import_suggestion_deny_list_entries_config = parent_rpcs.import_suggestion_deny_list_entries if parent_rpcs.respond_to? :import_suggestion_deny_list_entries
|
|
906
1057
|
@import_suggestion_deny_list_entries = ::Gapic::Config::Method.new import_suggestion_deny_list_entries_config
|
|
907
1058
|
purge_suggestion_deny_list_entries_config = parent_rpcs.purge_suggestion_deny_list_entries if parent_rpcs.respond_to? :purge_suggestion_deny_list_entries
|
|
@@ -1027,6 +1027,13 @@ module Google
|
|
|
1027
1027
|
["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+/?$}, false]
|
|
1028
1028
|
]
|
|
1029
1029
|
)
|
|
1030
|
+
.with_bindings(
|
|
1031
|
+
uri_method: :get,
|
|
1032
|
+
uri_template: "/v1/{name}",
|
|
1033
|
+
matches: [
|
|
1034
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+/?$}, false]
|
|
1035
|
+
]
|
|
1036
|
+
)
|
|
1030
1037
|
.with_bindings(
|
|
1031
1038
|
uri_method: :get,
|
|
1032
1039
|
uri_template: "/v1/{name}",
|
|
@@ -113,6 +113,46 @@ module Google
|
|
|
113
113
|
end
|
|
114
114
|
end
|
|
115
115
|
|
|
116
|
+
##
|
|
117
|
+
# Baseline implementation for the advanced_complete_query REST call
|
|
118
|
+
#
|
|
119
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest]
|
|
120
|
+
# A request object representing the call parameters. Required.
|
|
121
|
+
# @param options [::Gapic::CallOptions]
|
|
122
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
123
|
+
#
|
|
124
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
125
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryResponse]
|
|
126
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
127
|
+
#
|
|
128
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryResponse]
|
|
129
|
+
# A result object deserialized from the server's reply
|
|
130
|
+
def advanced_complete_query request_pb, options = nil
|
|
131
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
|
132
|
+
|
|
133
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_advanced_complete_query_request request_pb
|
|
134
|
+
query_string_params = if query_string_params.any?
|
|
135
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
|
136
|
+
else
|
|
137
|
+
{}
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
response = @client_stub.make_http_request(
|
|
141
|
+
verb,
|
|
142
|
+
uri: uri,
|
|
143
|
+
body: body || "",
|
|
144
|
+
params: query_string_params,
|
|
145
|
+
method_name: "advanced_complete_query",
|
|
146
|
+
options: options
|
|
147
|
+
)
|
|
148
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
|
149
|
+
result = ::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryResponse.decode_json response.body, ignore_unknown_fields: true
|
|
150
|
+
catch :response do
|
|
151
|
+
yield result, operation if block_given?
|
|
152
|
+
result
|
|
153
|
+
end
|
|
154
|
+
end
|
|
155
|
+
|
|
116
156
|
##
|
|
117
157
|
# Baseline implementation for the import_suggestion_deny_list_entries REST call
|
|
118
158
|
#
|
|
@@ -301,6 +341,44 @@ module Google
|
|
|
301
341
|
transcoder.transcode request_pb
|
|
302
342
|
end
|
|
303
343
|
|
|
344
|
+
##
|
|
345
|
+
# @private
|
|
346
|
+
#
|
|
347
|
+
# GRPC transcoding helper method for the advanced_complete_query REST call
|
|
348
|
+
#
|
|
349
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1::AdvancedCompleteQueryRequest]
|
|
350
|
+
# A request object representing the call parameters. Required.
|
|
351
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
|
352
|
+
# Uri, Body, Query string parameters
|
|
353
|
+
def self.transcode_advanced_complete_query_request request_pb
|
|
354
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
|
355
|
+
.with_bindings(
|
|
356
|
+
uri_method: :post,
|
|
357
|
+
uri_template: "/v1/{completion_config}:completeQuery",
|
|
358
|
+
body: "*",
|
|
359
|
+
matches: [
|
|
360
|
+
["completion_config", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig/?$}, false]
|
|
361
|
+
]
|
|
362
|
+
)
|
|
363
|
+
.with_bindings(
|
|
364
|
+
uri_method: :post,
|
|
365
|
+
uri_template: "/v1/{completion_config}:completeQuery",
|
|
366
|
+
body: "*",
|
|
367
|
+
matches: [
|
|
368
|
+
["completion_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig/?$}, false]
|
|
369
|
+
]
|
|
370
|
+
)
|
|
371
|
+
.with_bindings(
|
|
372
|
+
uri_method: :post,
|
|
373
|
+
uri_template: "/v1/{completion_config}:completeQuery",
|
|
374
|
+
body: "*",
|
|
375
|
+
matches: [
|
|
376
|
+
["completion_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig/?$}, false]
|
|
377
|
+
]
|
|
378
|
+
)
|
|
379
|
+
transcoder.transcode request_pb
|
|
380
|
+
end
|
|
381
|
+
|
|
304
382
|
##
|
|
305
383
|
# @private
|
|
306
384
|
#
|
|
@@ -26,7 +26,9 @@ module Google
|
|
|
26
26
|
# Credentials for the ControlService API.
|
|
27
27
|
class Credentials < ::Google::Auth::Credentials
|
|
28
28
|
self.scope = [
|
|
29
|
-
"https://www.googleapis.com/auth/cloud-platform"
|
|
29
|
+
"https://www.googleapis.com/auth/cloud-platform",
|
|
30
|
+
"https://www.googleapis.com/auth/discoveryengine.readwrite",
|
|
31
|
+
"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
|
|
30
32
|
]
|
|
31
33
|
self.env_vars = [
|
|
32
34
|
"GOOGLE_CLOUD_CREDENTIALS",
|
|
@@ -850,6 +850,12 @@ module Google
|
|
|
850
850
|
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
|
|
851
851
|
# or
|
|
852
852
|
# `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
|
|
853
|
+
#
|
|
854
|
+
# Or the resource name of the agent engine serving config, such as:
|
|
855
|
+
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
|
|
856
|
+
# (use when `enable_agent_invocation` set to true, and you have custom
|
|
857
|
+
# `AI_MODE` agent engine configured)
|
|
858
|
+
#
|
|
853
859
|
# This field is used to identify the serving configuration name, set
|
|
854
860
|
# of models used to make the search.
|
|
855
861
|
# @param query [::Google::Cloud::DiscoveryEngine::V1::Query, ::Hash]
|
|
@@ -1010,6 +1016,12 @@ module Google
|
|
|
1010
1016
|
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
|
|
1011
1017
|
# or
|
|
1012
1018
|
# `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
|
|
1019
|
+
#
|
|
1020
|
+
# Or the resource name of the agent engine serving config, such as:
|
|
1021
|
+
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
|
|
1022
|
+
# (use when `enable_agent_invocation` set to true, and you have custom
|
|
1023
|
+
# `AI_MODE` agent engine configured)
|
|
1024
|
+
#
|
|
1013
1025
|
# This field is used to identify the serving configuration name, set
|
|
1014
1026
|
# of models used to make the search.
|
|
1015
1027
|
# @param query [::Google::Cloud::DiscoveryEngine::V1::Query, ::Hash]
|
|
@@ -1246,7 +1258,7 @@ module Google
|
|
|
1246
1258
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1247
1259
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1248
1260
|
#
|
|
1249
|
-
# @overload create_session(parent: nil, session: nil)
|
|
1261
|
+
# @overload create_session(parent: nil, session: nil, session_id: nil)
|
|
1250
1262
|
# Pass arguments to `create_session` via keyword arguments. Note that at
|
|
1251
1263
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1252
1264
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1256,6 +1268,13 @@ module Google
|
|
|
1256
1268
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
|
|
1257
1269
|
# @param session [::Google::Cloud::DiscoveryEngine::V1::Session, ::Hash]
|
|
1258
1270
|
# Required. The session to create.
|
|
1271
|
+
# @param session_id [::String]
|
|
1272
|
+
# Optional. The ID to use for the session, which will become the final
|
|
1273
|
+
# component of the session's resource name.
|
|
1274
|
+
#
|
|
1275
|
+
# This value should be 1-63 characters, and valid characters
|
|
1276
|
+
# are /[a-z0-9][a-z0-9-]\\{0,61}[a-z0-9]/. If not specified, a unique ID will
|
|
1277
|
+
# be generated.
|
|
1259
1278
|
#
|
|
1260
1279
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1261
1280
|
# @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::Session]
|
|
@@ -1626,7 +1645,9 @@ module Google
|
|
|
1626
1645
|
# Provide this to retrieve the subsequent page.
|
|
1627
1646
|
# @param filter [::String]
|
|
1628
1647
|
# A comma-separated list of fields to filter by, in EBNF grammar.
|
|
1648
|
+
#
|
|
1629
1649
|
# The supported fields are:
|
|
1650
|
+
#
|
|
1630
1651
|
# * `user_pseudo_id`
|
|
1631
1652
|
# * `state`
|
|
1632
1653
|
# * `display_name`
|
|
@@ -1635,28 +1656,35 @@ module Google
|
|
|
1635
1656
|
# * `labels`
|
|
1636
1657
|
# * `create_time`
|
|
1637
1658
|
# * `update_time`
|
|
1659
|
+
# * `collaborative_project`
|
|
1638
1660
|
#
|
|
1639
1661
|
# Examples:
|
|
1640
|
-
#
|
|
1641
|
-
#
|
|
1642
|
-
#
|
|
1643
|
-
#
|
|
1644
|
-
#
|
|
1662
|
+
#
|
|
1663
|
+
# * `user_pseudo_id = some_id`
|
|
1664
|
+
# * `display_name = "some_name"`
|
|
1665
|
+
# * `starred = true`
|
|
1666
|
+
# * `is_pinned=true AND (NOT labels:hidden)`
|
|
1667
|
+
# * `create_time > "1970-01-01T12:00:00Z"`
|
|
1668
|
+
# * `collaborative_project =
|
|
1669
|
+
# "projects/123/locations/global/collections/default_collection/engines/"
|
|
1670
|
+
# "default_engine/collaborative_projects/cp1"`
|
|
1645
1671
|
# @param order_by [::String]
|
|
1646
1672
|
# A comma-separated list of fields to order by, sorted in ascending order.
|
|
1647
1673
|
# Use "desc" after a field name for descending.
|
|
1674
|
+
#
|
|
1648
1675
|
# Supported fields:
|
|
1649
1676
|
#
|
|
1650
1677
|
# * `update_time`
|
|
1651
1678
|
# * `create_time`
|
|
1652
1679
|
# * `session_name`
|
|
1653
1680
|
# * `is_pinned`
|
|
1681
|
+
# * `display_name`
|
|
1654
1682
|
#
|
|
1655
1683
|
# Example:
|
|
1656
1684
|
#
|
|
1657
|
-
# *
|
|
1658
|
-
# *
|
|
1659
|
-
# *
|
|
1685
|
+
# * `update_time desc`
|
|
1686
|
+
# * `create_time`
|
|
1687
|
+
# * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then
|
|
1660
1688
|
# by update_time.
|
|
1661
1689
|
#
|
|
1662
1690
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
@@ -26,7 +26,9 @@ module Google
|
|
|
26
26
|
# Credentials for the ConversationalSearchService API.
|
|
27
27
|
class Credentials < ::Google::Auth::Credentials
|
|
28
28
|
self.scope = [
|
|
29
|
-
"https://www.googleapis.com/auth/cloud-platform"
|
|
29
|
+
"https://www.googleapis.com/auth/cloud-platform",
|
|
30
|
+
"https://www.googleapis.com/auth/discoveryengine.readwrite",
|
|
31
|
+
"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
|
|
30
32
|
]
|
|
31
33
|
self.env_vars = [
|
|
32
34
|
"GOOGLE_CLOUD_CREDENTIALS",
|
|
@@ -449,6 +449,18 @@ module Google
|
|
|
449
449
|
# @param engine [String]
|
|
450
450
|
# @param session [String]
|
|
451
451
|
#
|
|
452
|
+
# @overload session_path(project:, location:, collection:, engine:, collaborative_project:, session:)
|
|
453
|
+
# The resource will be in the following format:
|
|
454
|
+
#
|
|
455
|
+
# `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/collaborativeProjects/{collaborative_project}/sessions/{session}`
|
|
456
|
+
#
|
|
457
|
+
# @param project [String]
|
|
458
|
+
# @param location [String]
|
|
459
|
+
# @param collection [String]
|
|
460
|
+
# @param engine [String]
|
|
461
|
+
# @param collaborative_project [String]
|
|
462
|
+
# @param session [String]
|
|
463
|
+
#
|
|
452
464
|
# @return [::String]
|
|
453
465
|
def session_path **args
|
|
454
466
|
resources = {
|
|
@@ -474,6 +486,15 @@ module Google
|
|
|
474
486
|
raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
|
|
475
487
|
|
|
476
488
|
"projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/sessions/#{session}"
|
|
489
|
+
end),
|
|
490
|
+
"collaborative_project:collection:engine:location:project:session" => (proc do |project:, location:, collection:, engine:, collaborative_project:, session:|
|
|
491
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
|
492
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
493
|
+
raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
|
|
494
|
+
raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
|
|
495
|
+
raise ::ArgumentError, "collaborative_project cannot contain /" if collaborative_project.to_s.include? "/"
|
|
496
|
+
|
|
497
|
+
"projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/collaborativeProjects/#{collaborative_project}/sessions/#{session}"
|
|
477
498
|
end)
|
|
478
499
|
}
|
|
479
500
|
|
|
@@ -801,6 +801,12 @@ module Google
|
|
|
801
801
|
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
|
|
802
802
|
# or
|
|
803
803
|
# `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
|
|
804
|
+
#
|
|
805
|
+
# Or the resource name of the agent engine serving config, such as:
|
|
806
|
+
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
|
|
807
|
+
# (use when `enable_agent_invocation` set to true, and you have custom
|
|
808
|
+
# `AI_MODE` agent engine configured)
|
|
809
|
+
#
|
|
804
810
|
# This field is used to identify the serving configuration name, set
|
|
805
811
|
# of models used to make the search.
|
|
806
812
|
# @param query [::Google::Cloud::DiscoveryEngine::V1::Query, ::Hash]
|
|
@@ -954,6 +960,12 @@ module Google
|
|
|
954
960
|
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
|
|
955
961
|
# or
|
|
956
962
|
# `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
|
|
963
|
+
#
|
|
964
|
+
# Or the resource name of the agent engine serving config, such as:
|
|
965
|
+
# `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
|
|
966
|
+
# (use when `enable_agent_invocation` set to true, and you have custom
|
|
967
|
+
# `AI_MODE` agent engine configured)
|
|
968
|
+
#
|
|
957
969
|
# This field is used to identify the serving configuration name, set
|
|
958
970
|
# of models used to make the search.
|
|
959
971
|
# @param query [::Google::Cloud::DiscoveryEngine::V1::Query, ::Hash]
|
|
@@ -1178,7 +1190,7 @@ module Google
|
|
|
1178
1190
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1179
1191
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
1180
1192
|
#
|
|
1181
|
-
# @overload create_session(parent: nil, session: nil)
|
|
1193
|
+
# @overload create_session(parent: nil, session: nil, session_id: nil)
|
|
1182
1194
|
# Pass arguments to `create_session` via keyword arguments. Note that at
|
|
1183
1195
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1184
1196
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1188,6 +1200,13 @@ module Google
|
|
|
1188
1200
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
|
|
1189
1201
|
# @param session [::Google::Cloud::DiscoveryEngine::V1::Session, ::Hash]
|
|
1190
1202
|
# Required. The session to create.
|
|
1203
|
+
# @param session_id [::String]
|
|
1204
|
+
# Optional. The ID to use for the session, which will become the final
|
|
1205
|
+
# component of the session's resource name.
|
|
1206
|
+
#
|
|
1207
|
+
# This value should be 1-63 characters, and valid characters
|
|
1208
|
+
# are /[a-z0-9][a-z0-9-]\\{0,61}[a-z0-9]/. If not specified, a unique ID will
|
|
1209
|
+
# be generated.
|
|
1191
1210
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1192
1211
|
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Session]
|
|
1193
1212
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -1530,7 +1549,9 @@ module Google
|
|
|
1530
1549
|
# Provide this to retrieve the subsequent page.
|
|
1531
1550
|
# @param filter [::String]
|
|
1532
1551
|
# A comma-separated list of fields to filter by, in EBNF grammar.
|
|
1552
|
+
#
|
|
1533
1553
|
# The supported fields are:
|
|
1554
|
+
#
|
|
1534
1555
|
# * `user_pseudo_id`
|
|
1535
1556
|
# * `state`
|
|
1536
1557
|
# * `display_name`
|
|
@@ -1539,28 +1560,35 @@ module Google
|
|
|
1539
1560
|
# * `labels`
|
|
1540
1561
|
# * `create_time`
|
|
1541
1562
|
# * `update_time`
|
|
1563
|
+
# * `collaborative_project`
|
|
1542
1564
|
#
|
|
1543
1565
|
# Examples:
|
|
1544
|
-
#
|
|
1545
|
-
#
|
|
1546
|
-
#
|
|
1547
|
-
#
|
|
1548
|
-
#
|
|
1566
|
+
#
|
|
1567
|
+
# * `user_pseudo_id = some_id`
|
|
1568
|
+
# * `display_name = "some_name"`
|
|
1569
|
+
# * `starred = true`
|
|
1570
|
+
# * `is_pinned=true AND (NOT labels:hidden)`
|
|
1571
|
+
# * `create_time > "1970-01-01T12:00:00Z"`
|
|
1572
|
+
# * `collaborative_project =
|
|
1573
|
+
# "projects/123/locations/global/collections/default_collection/engines/"
|
|
1574
|
+
# "default_engine/collaborative_projects/cp1"`
|
|
1549
1575
|
# @param order_by [::String]
|
|
1550
1576
|
# A comma-separated list of fields to order by, sorted in ascending order.
|
|
1551
1577
|
# Use "desc" after a field name for descending.
|
|
1578
|
+
#
|
|
1552
1579
|
# Supported fields:
|
|
1553
1580
|
#
|
|
1554
1581
|
# * `update_time`
|
|
1555
1582
|
# * `create_time`
|
|
1556
1583
|
# * `session_name`
|
|
1557
1584
|
# * `is_pinned`
|
|
1585
|
+
# * `display_name`
|
|
1558
1586
|
#
|
|
1559
1587
|
# Example:
|
|
1560
1588
|
#
|
|
1561
|
-
# *
|
|
1562
|
-
# *
|
|
1563
|
-
# *
|
|
1589
|
+
# * `update_time desc`
|
|
1590
|
+
# * `create_time`
|
|
1591
|
+
# * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then
|
|
1564
1592
|
# by update_time.
|
|
1565
1593
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1566
1594
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::Session>]
|