google-cloud-discovery_engine-v1beta 0.26.0 → 0.28.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 +5 -5
- data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/client.rb +591 -0
- data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/paths.rb +50 -0
- data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest/client.rb +534 -0
- data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest/service_stub.rb +204 -0
- data/lib/google/cloud/discovery_engine/v1beta/acl_config_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/acl_config_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/assistant_service/client.rb +1058 -0
- data/lib/google/cloud/discovery_engine/v1beta/assistant_service/credentials.rb +50 -0
- data/lib/google/cloud/discovery_engine/v1beta/assistant_service/paths.rb +230 -0
- data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest/client.rb +975 -0
- data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest/service_stub.rb +444 -0
- data/lib/google/cloud/discovery_engine/v1beta/assistant_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/assistant_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/client.rb +823 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/operations.rb +843 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/paths.rb +135 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/client.rb +752 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/operations.rb +1152 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest/service_stub.rb +341 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/cmek_config_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +148 -12
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/credentials.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +141 -12
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +62 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +212 -10
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +46 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +207 -10
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +72 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +13 -1
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/paths.rb +104 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +13 -1
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +10 -3
- data/lib/google/cloud/discovery_engine/v1beta/document_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +10 -3
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +226 -6
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/paths.rb +104 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +212 -6
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +123 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +13 -9
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +13 -9
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/client.rb +1180 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/operations.rb +843 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/paths.rb +154 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/client.rb +1088 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/operations.rb +1152 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest/service_stub.rb +511 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/identity_mapping_store_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/license_config_service/client.rb +1050 -0
- data/lib/google/cloud/discovery_engine/v1beta/license_config_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/license_config_service/paths.rb +86 -0
- data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest/client.rb +965 -0
- data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest/service_stub.rb +451 -0
- data/lib/google/cloud/discovery_engine/v1beta/license_config_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/license_config_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +4 -2
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +4 -2
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +4 -2
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +4 -2
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +10 -3
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +196 -38
- data/lib/google/cloud/discovery_engine/v1beta/search_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +196 -38
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +209 -3
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +195 -3
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/service_stub.rb +153 -0
- data/lib/google/cloud/discovery_engine/v1beta/session_service/client.rb +27 -9
- data/lib/google/cloud/discovery_engine/v1beta/session_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1beta/session_service/paths.rb +46 -0
- data/lib/google/cloud/discovery_engine/v1beta/session_service/rest/client.rb +27 -9
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/credentials.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +7 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +25 -11
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +2 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +25 -11
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +23 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/client.rb +768 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/operations.rb +843 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/paths.rb +71 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/client.rb +704 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/operations.rb +1152 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest/service_stub.rb +265 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_license_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_store_service/client.rb +590 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_store_service/credentials.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_store_service/paths.rb +71 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest/client.rb +533 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest/service_stub.rb +204 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_store_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_store_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +11 -4
- data/lib/google/cloud/discoveryengine/v1beta/acl_config_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1beta/acl_config_service_pb.rb +28 -0
- data/lib/google/cloud/discoveryengine/v1beta/acl_config_service_services_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/agent_gateway_setting_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/assist_answer_pb.rb +48 -0
- data/lib/google/cloud/discoveryengine/v1beta/assistant_pb.rb +35 -0
- data/lib/google/cloud/discoveryengine/v1beta/assistant_service_pb.rb +48 -0
- data/lib/google/cloud/discoveryengine/v1beta/assistant_service_services_pb.rb +56 -0
- data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/cmek_config_service_pb.rb +39 -0
- data/lib/google/cloud/discoveryengine/v1beta/cmek_config_service_services_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +12 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +6 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +12 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +8 -0
- data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +11 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +17 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +28 -6
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/feedback_pb.rb +28 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +11 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_pb.rb +26 -0
- data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_service_pb.rb +44 -0
- data/lib/google/cloud/discoveryengine/v1beta/identity_mapping_store_service_services_pb.rb +58 -0
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/license_config_pb.rb +27 -0
- data/lib/google/cloud/discoveryengine/v1beta/license_config_service_pb.rb +36 -0
- data/lib/google/cloud/discoveryengine/v1beta/license_config_service_services_pb.rb +65 -0
- data/lib/google/cloud/discoveryengine/v1beta/logging_pb.rb +24 -0
- data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +10 -1
- data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/safety_pb.rb +26 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/schema_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +18 -2
- data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb +14 -0
- data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/session_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_license_pb.rb +27 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_license_service_pb.rb +38 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_license_service_services_pb.rb +52 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_store_pb.rb +24 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_store_service_pb.rb +29 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_store_service_services_pb.rb +47 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/acl_config.rb +43 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/acl_config_service.rb +49 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/agent_gateway_setting.rb +53 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +117 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/assist_answer.rb +401 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/assistant.rb +253 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/assistant_service.rb +368 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +60 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/cmek_config_service.rb +228 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +223 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +115 -13
- data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +119 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +178 -8
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +218 -9
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +12 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +115 -10
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +30 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +388 -8
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +13 -11
- data/proto_docs/google/cloud/discoveryengine/v1beta/feedback.rb +147 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +190 -9
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +9 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/identity_mapping_store.rb +84 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/identity_mapping_store_service.rb +280 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +25 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/license_config.rb +101 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/license_config_service.rb +224 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/logging.rb +40 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +214 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +18 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +9 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +4 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/safety.rb +108 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +461 -69
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +50 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +30 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +21 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +8 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +7 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +39 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +14 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_license.rb +100 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_license_service.rb +202 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_store.rb +67 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_store_service.rb +54 -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/expr.rb +75 -0
- data/proto_docs/google/type/latlng.rb +38 -0
- metadata +120 -3
|
@@ -210,7 +210,7 @@ module Google
|
|
|
210
210
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
211
211
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
212
212
|
#
|
|
213
|
-
# @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, region_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, personalization_spec: nil)
|
|
213
|
+
# @overload search(serving_config: nil, branch: nil, query: nil, page_categories: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, num_results_per_data_store: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, region_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, display_spec: nil, crowding_specs: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_filter_spec: nil, personalization_spec: nil, relevance_score_spec: nil, search_addon_spec: nil, custom_ranking_params: nil, entity: nil)
|
|
214
214
|
# Pass arguments to `search` via keyword arguments. Note that at
|
|
215
215
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
216
216
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -230,6 +230,24 @@ module Google
|
|
|
230
230
|
# documents under the default branch.
|
|
231
231
|
# @param query [::String]
|
|
232
232
|
# Raw search query.
|
|
233
|
+
# @param page_categories [::Array<::String>]
|
|
234
|
+
# Optional. The categories associated with a category page. Must be set for
|
|
235
|
+
# category navigation queries to achieve good search quality. The format
|
|
236
|
+
# should be the same as
|
|
237
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::PageInfo#page_category PageInfo.page_category}.
|
|
238
|
+
# This field is the equivalent of the query for browse (navigation) queries.
|
|
239
|
+
# It's used by the browse model when the query is empty.
|
|
240
|
+
#
|
|
241
|
+
# If the field is empty, it will not be used by the browse model.
|
|
242
|
+
# If the field contains more than one element, only the first element will
|
|
243
|
+
# be used.
|
|
244
|
+
#
|
|
245
|
+
# To represent full path of a category, use '>' character to separate
|
|
246
|
+
# different hierarchies. If '>' is part of the category name, replace it with
|
|
247
|
+
# other character(s).
|
|
248
|
+
# For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
|
|
249
|
+
# 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
|
|
250
|
+
# > Founders Edition`
|
|
233
251
|
# @param image_query [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery, ::Hash]
|
|
234
252
|
# Raw image query.
|
|
235
253
|
# @param page_size [::Integer]
|
|
@@ -260,15 +278,25 @@ module Google
|
|
|
260
278
|
# is unset.
|
|
261
279
|
#
|
|
262
280
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
281
|
+
#
|
|
282
|
+
# A large offset may be capped to a reasonable threshold.
|
|
263
283
|
# @param one_box_page_size [::Integer]
|
|
264
284
|
# The maximum number of results to return for OneBox.
|
|
265
285
|
# This applies to each OneBox type individually.
|
|
266
286
|
# Default number is 10.
|
|
267
287
|
# @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec, ::Hash>]
|
|
268
|
-
#
|
|
269
|
-
#
|
|
270
|
-
#
|
|
271
|
-
#
|
|
288
|
+
# Specifications that define the specific
|
|
289
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s to be searched,
|
|
290
|
+
# along with configurations for those data stores. This is only considered
|
|
291
|
+
# for {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}s with multiple
|
|
292
|
+
# data stores. For engines with a single data store, the specs directly under
|
|
293
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest SearchRequest} should
|
|
294
|
+
# be used.
|
|
295
|
+
# @param num_results_per_data_store [::Integer]
|
|
296
|
+
# Optional. The maximum number of results to retrieve from each data store.
|
|
297
|
+
# If not specified, it will use the
|
|
298
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec#num_results SearchRequest.DataStoreSpec.num_results}
|
|
299
|
+
# if provided, otherwise there is no limit.
|
|
272
300
|
# @param filter [::String]
|
|
273
301
|
# The filter syntax consists of an expression language for constructing a
|
|
274
302
|
# predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -313,7 +341,7 @@ module Google
|
|
|
313
341
|
# If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
314
342
|
# @param user_info [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo, ::Hash]
|
|
315
343
|
# Information about the end user.
|
|
316
|
-
# Highly recommended for analytics.
|
|
344
|
+
# Highly recommended for analytics and personalization.
|
|
317
345
|
# {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_agent UserInfo.user_agent}
|
|
318
346
|
# is used to deduce `device_type` for analytics.
|
|
319
347
|
# @param language_code [::String]
|
|
@@ -359,10 +387,10 @@ module Google
|
|
|
359
387
|
# The spell correction specification that specifies the mode under
|
|
360
388
|
# which spell correction takes effect.
|
|
361
389
|
# @param user_pseudo_id [::String]
|
|
362
|
-
# A unique identifier for tracking visitors. For example, this
|
|
363
|
-
# implemented with an HTTP cookie, which should be able to uniquely
|
|
364
|
-
# a visitor on a single device. This unique identifier should not
|
|
365
|
-
# the visitor logs in or out of the website.
|
|
390
|
+
# Optional. A unique identifier for tracking visitors. For example, this
|
|
391
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
|
392
|
+
# identify a visitor on a single device. This unique identifier should not
|
|
393
|
+
# change if the visitor logs in or out of the website.
|
|
366
394
|
#
|
|
367
395
|
# This field should NOT have a fixed value such as `unknown_visitor`.
|
|
368
396
|
#
|
|
@@ -387,8 +415,8 @@ module Google
|
|
|
387
415
|
# is not provided, it will use
|
|
388
416
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#embedding_config ServingConfig.EmbeddingConfig.field_path}.
|
|
389
417
|
# @param ranking_expression [::String]
|
|
390
|
-
# The ranking expression controls the customized ranking on
|
|
391
|
-
# documents. This overrides
|
|
418
|
+
# Optional. The ranking expression controls the customized ranking on
|
|
419
|
+
# retrieval documents. This overrides
|
|
392
420
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
|
|
393
421
|
# The syntax and supported features depend on the
|
|
394
422
|
# `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
|
@@ -477,8 +505,17 @@ module Google
|
|
|
477
505
|
# Google model to determine the keyword-based overlap between the query and
|
|
478
506
|
# the document.
|
|
479
507
|
# * `base_rank`: the default rank of the result
|
|
508
|
+
# * `media_actor_match`: whether the media actor matches the query
|
|
509
|
+
# * `media_director_match`: whether the media director matches the query
|
|
510
|
+
# * `media_genre_match`: whether the media genre matches the query
|
|
511
|
+
# * `media_language_match`: whether the media language matches the query
|
|
512
|
+
# * `media_title_match`: whether the media title matches the query
|
|
513
|
+
# * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
514
|
+
# results
|
|
515
|
+
# * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
516
|
+
# results
|
|
480
517
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RankingExpressionBackend]
|
|
481
|
-
# The backend to use for the ranking expression evaluation.
|
|
518
|
+
# Optional. The backend to use for the ranking expression evaluation.
|
|
482
519
|
# @param safe_search [::Boolean]
|
|
483
520
|
# Whether to turn on safe search. This is only supported for
|
|
484
521
|
# website search.
|
|
@@ -501,12 +538,29 @@ module Google
|
|
|
501
538
|
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
|
502
539
|
# for more details.
|
|
503
540
|
# @param natural_language_query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash]
|
|
541
|
+
# Optional. Config for natural language query understanding capabilities,
|
|
542
|
+
# such as extracting structured field filters from the query. Refer to [this
|
|
543
|
+
# documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
|
|
544
|
+
# for more information.
|
|
504
545
|
# If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
|
505
546
|
# natural language query understanding will be done.
|
|
506
547
|
# @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SearchAsYouTypeSpec, ::Hash]
|
|
507
548
|
# Search as you type configuration. Only supported for the
|
|
508
549
|
# {::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical::MEDIA IndustryVertical.MEDIA}
|
|
509
550
|
# vertical.
|
|
551
|
+
# @param display_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DisplaySpec, ::Hash]
|
|
552
|
+
# Optional. Config for display feature, like match highlighting on search
|
|
553
|
+
# results.
|
|
554
|
+
# @param crowding_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec, ::Hash>]
|
|
555
|
+
# Optional. Crowding specifications for improving result diversity.
|
|
556
|
+
# If multiple CrowdingSpecs are specified, crowding will be evaluated on
|
|
557
|
+
# each unique combination of the `field` values, and max_count will be the
|
|
558
|
+
# maximum value of `max_count` across all CrowdingSpecs.
|
|
559
|
+
# For example, if the first CrowdingSpec has `field` = "color" and
|
|
560
|
+
# `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
|
|
561
|
+
# `max_count` = 2, then after 3 documents that share the same color AND size
|
|
562
|
+
# have been returned, subsequent ones should be
|
|
563
|
+
# removed or demoted.
|
|
510
564
|
# @param session [::String]
|
|
511
565
|
# The session resource name. Optional.
|
|
512
566
|
#
|
|
@@ -524,20 +578,29 @@ module Google
|
|
|
524
578
|
# Call /answer API with the session ID generated in the first call.
|
|
525
579
|
# Here, the answer generation happens in the context of the search
|
|
526
580
|
# results from the first search call.
|
|
527
|
-
#
|
|
528
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
529
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
530
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
531
581
|
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SessionSpec, ::Hash]
|
|
532
582
|
# Session specification.
|
|
533
583
|
#
|
|
534
584
|
# Can be used only when `session` is set.
|
|
535
585
|
# @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceThreshold]
|
|
536
|
-
# The relevance threshold of the search results.
|
|
586
|
+
# The global relevance threshold of the search results.
|
|
537
587
|
#
|
|
538
|
-
#
|
|
588
|
+
# Defaults to Google defined threshold, leveraging a balance of
|
|
539
589
|
# precision and recall to deliver both highly accurate results and
|
|
540
590
|
# comprehensive coverage of relevant information.
|
|
591
|
+
#
|
|
592
|
+
# If more granular relevance filtering is required, use the
|
|
593
|
+
# `relevance_filter_spec` instead.
|
|
594
|
+
#
|
|
595
|
+
# This feature is not supported for healthcare search.
|
|
596
|
+
# @param relevance_filter_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceFilterSpec, ::Hash]
|
|
597
|
+
# Optional. The granular relevance filtering specification.
|
|
598
|
+
#
|
|
599
|
+
# If not specified, the global `relevance_threshold` will be used for all
|
|
600
|
+
# sub-searches. If specified, this overrides the global
|
|
601
|
+
# `relevance_threshold` to use thresholds on a per sub-search basis.
|
|
602
|
+
#
|
|
603
|
+
# This feature is currently supported only for custom and site search.
|
|
541
604
|
# @param personalization_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec, ::Hash]
|
|
542
605
|
# The specification for personalization.
|
|
543
606
|
#
|
|
@@ -549,6 +612,21 @@ module Google
|
|
|
549
612
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#personalization_spec SearchRequest.personalization_spec}
|
|
550
613
|
# overrides
|
|
551
614
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
|
|
615
|
+
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
616
|
+
# Optional. The specification for returning the relevance score.
|
|
617
|
+
# @param search_addon_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SearchAddonSpec, ::Hash]
|
|
618
|
+
# Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
619
|
+
# repricing model.
|
|
620
|
+
# This field is only supported for search requests.
|
|
621
|
+
# @param custom_ranking_params [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CustomRankingParams, ::Hash]
|
|
622
|
+
# Optional. Optional configuration for the Custom Ranking feature.
|
|
623
|
+
# @param entity [::String]
|
|
624
|
+
# Optional. The entity for customers that may run multiple different
|
|
625
|
+
# entities, domains, sites or regions, for example, "Google US", "Google
|
|
626
|
+
# Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
627
|
+
# be exactly matched with
|
|
628
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#entity UserEvent.entity} to
|
|
629
|
+
# get search results boosted by entity.
|
|
552
630
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
553
631
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
|
|
554
632
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -638,7 +716,7 @@ module Google
|
|
|
638
716
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
639
717
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
640
718
|
#
|
|
641
|
-
# @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, region_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, personalization_spec: nil)
|
|
719
|
+
# @overload search_lite(serving_config: nil, branch: nil, query: nil, page_categories: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, num_results_per_data_store: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, region_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, display_spec: nil, crowding_specs: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_filter_spec: nil, personalization_spec: nil, relevance_score_spec: nil, search_addon_spec: nil, custom_ranking_params: nil, entity: nil)
|
|
642
720
|
# Pass arguments to `search_lite` via keyword arguments. Note that at
|
|
643
721
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
644
722
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -658,6 +736,24 @@ module Google
|
|
|
658
736
|
# documents under the default branch.
|
|
659
737
|
# @param query [::String]
|
|
660
738
|
# Raw search query.
|
|
739
|
+
# @param page_categories [::Array<::String>]
|
|
740
|
+
# Optional. The categories associated with a category page. Must be set for
|
|
741
|
+
# category navigation queries to achieve good search quality. The format
|
|
742
|
+
# should be the same as
|
|
743
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::PageInfo#page_category PageInfo.page_category}.
|
|
744
|
+
# This field is the equivalent of the query for browse (navigation) queries.
|
|
745
|
+
# It's used by the browse model when the query is empty.
|
|
746
|
+
#
|
|
747
|
+
# If the field is empty, it will not be used by the browse model.
|
|
748
|
+
# If the field contains more than one element, only the first element will
|
|
749
|
+
# be used.
|
|
750
|
+
#
|
|
751
|
+
# To represent full path of a category, use '>' character to separate
|
|
752
|
+
# different hierarchies. If '>' is part of the category name, replace it with
|
|
753
|
+
# other character(s).
|
|
754
|
+
# For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
|
|
755
|
+
# 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
|
|
756
|
+
# > Founders Edition`
|
|
661
757
|
# @param image_query [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery, ::Hash]
|
|
662
758
|
# Raw image query.
|
|
663
759
|
# @param page_size [::Integer]
|
|
@@ -688,15 +784,25 @@ module Google
|
|
|
688
784
|
# is unset.
|
|
689
785
|
#
|
|
690
786
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
787
|
+
#
|
|
788
|
+
# A large offset may be capped to a reasonable threshold.
|
|
691
789
|
# @param one_box_page_size [::Integer]
|
|
692
790
|
# The maximum number of results to return for OneBox.
|
|
693
791
|
# This applies to each OneBox type individually.
|
|
694
792
|
# Default number is 10.
|
|
695
793
|
# @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec, ::Hash>]
|
|
696
|
-
#
|
|
697
|
-
#
|
|
698
|
-
#
|
|
699
|
-
#
|
|
794
|
+
# Specifications that define the specific
|
|
795
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}s to be searched,
|
|
796
|
+
# along with configurations for those data stores. This is only considered
|
|
797
|
+
# for {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}s with multiple
|
|
798
|
+
# data stores. For engines with a single data store, the specs directly under
|
|
799
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest SearchRequest} should
|
|
800
|
+
# be used.
|
|
801
|
+
# @param num_results_per_data_store [::Integer]
|
|
802
|
+
# Optional. The maximum number of results to retrieve from each data store.
|
|
803
|
+
# If not specified, it will use the
|
|
804
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec#num_results SearchRequest.DataStoreSpec.num_results}
|
|
805
|
+
# if provided, otherwise there is no limit.
|
|
700
806
|
# @param filter [::String]
|
|
701
807
|
# The filter syntax consists of an expression language for constructing a
|
|
702
808
|
# predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -741,7 +847,7 @@ module Google
|
|
|
741
847
|
# If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
742
848
|
# @param user_info [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo, ::Hash]
|
|
743
849
|
# Information about the end user.
|
|
744
|
-
# Highly recommended for analytics.
|
|
850
|
+
# Highly recommended for analytics and personalization.
|
|
745
851
|
# {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_agent UserInfo.user_agent}
|
|
746
852
|
# is used to deduce `device_type` for analytics.
|
|
747
853
|
# @param language_code [::String]
|
|
@@ -787,10 +893,10 @@ module Google
|
|
|
787
893
|
# The spell correction specification that specifies the mode under
|
|
788
894
|
# which spell correction takes effect.
|
|
789
895
|
# @param user_pseudo_id [::String]
|
|
790
|
-
# A unique identifier for tracking visitors. For example, this
|
|
791
|
-
# implemented with an HTTP cookie, which should be able to uniquely
|
|
792
|
-
# a visitor on a single device. This unique identifier should not
|
|
793
|
-
# the visitor logs in or out of the website.
|
|
896
|
+
# Optional. A unique identifier for tracking visitors. For example, this
|
|
897
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
|
898
|
+
# identify a visitor on a single device. This unique identifier should not
|
|
899
|
+
# change if the visitor logs in or out of the website.
|
|
794
900
|
#
|
|
795
901
|
# This field should NOT have a fixed value such as `unknown_visitor`.
|
|
796
902
|
#
|
|
@@ -815,8 +921,8 @@ module Google
|
|
|
815
921
|
# is not provided, it will use
|
|
816
922
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#embedding_config ServingConfig.EmbeddingConfig.field_path}.
|
|
817
923
|
# @param ranking_expression [::String]
|
|
818
|
-
# The ranking expression controls the customized ranking on
|
|
819
|
-
# documents. This overrides
|
|
924
|
+
# Optional. The ranking expression controls the customized ranking on
|
|
925
|
+
# retrieval documents. This overrides
|
|
820
926
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
|
|
821
927
|
# The syntax and supported features depend on the
|
|
822
928
|
# `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
|
@@ -905,8 +1011,17 @@ module Google
|
|
|
905
1011
|
# Google model to determine the keyword-based overlap between the query and
|
|
906
1012
|
# the document.
|
|
907
1013
|
# * `base_rank`: the default rank of the result
|
|
1014
|
+
# * `media_actor_match`: whether the media actor matches the query
|
|
1015
|
+
# * `media_director_match`: whether the media director matches the query
|
|
1016
|
+
# * `media_genre_match`: whether the media genre matches the query
|
|
1017
|
+
# * `media_language_match`: whether the media language matches the query
|
|
1018
|
+
# * `media_title_match`: whether the media title matches the query
|
|
1019
|
+
# * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
1020
|
+
# results
|
|
1021
|
+
# * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
1022
|
+
# results
|
|
908
1023
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RankingExpressionBackend]
|
|
909
|
-
# The backend to use for the ranking expression evaluation.
|
|
1024
|
+
# Optional. The backend to use for the ranking expression evaluation.
|
|
910
1025
|
# @param safe_search [::Boolean]
|
|
911
1026
|
# Whether to turn on safe search. This is only supported for
|
|
912
1027
|
# website search.
|
|
@@ -929,12 +1044,29 @@ module Google
|
|
|
929
1044
|
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
|
930
1045
|
# for more details.
|
|
931
1046
|
# @param natural_language_query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash]
|
|
1047
|
+
# Optional. Config for natural language query understanding capabilities,
|
|
1048
|
+
# such as extracting structured field filters from the query. Refer to [this
|
|
1049
|
+
# documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
|
|
1050
|
+
# for more information.
|
|
932
1051
|
# If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
|
933
1052
|
# natural language query understanding will be done.
|
|
934
1053
|
# @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SearchAsYouTypeSpec, ::Hash]
|
|
935
1054
|
# Search as you type configuration. Only supported for the
|
|
936
1055
|
# {::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical::MEDIA IndustryVertical.MEDIA}
|
|
937
1056
|
# vertical.
|
|
1057
|
+
# @param display_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DisplaySpec, ::Hash]
|
|
1058
|
+
# Optional. Config for display feature, like match highlighting on search
|
|
1059
|
+
# results.
|
|
1060
|
+
# @param crowding_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec, ::Hash>]
|
|
1061
|
+
# Optional. Crowding specifications for improving result diversity.
|
|
1062
|
+
# If multiple CrowdingSpecs are specified, crowding will be evaluated on
|
|
1063
|
+
# each unique combination of the `field` values, and max_count will be the
|
|
1064
|
+
# maximum value of `max_count` across all CrowdingSpecs.
|
|
1065
|
+
# For example, if the first CrowdingSpec has `field` = "color" and
|
|
1066
|
+
# `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
|
|
1067
|
+
# `max_count` = 2, then after 3 documents that share the same color AND size
|
|
1068
|
+
# have been returned, subsequent ones should be
|
|
1069
|
+
# removed or demoted.
|
|
938
1070
|
# @param session [::String]
|
|
939
1071
|
# The session resource name. Optional.
|
|
940
1072
|
#
|
|
@@ -952,20 +1084,29 @@ module Google
|
|
|
952
1084
|
# Call /answer API with the session ID generated in the first call.
|
|
953
1085
|
# Here, the answer generation happens in the context of the search
|
|
954
1086
|
# results from the first search call.
|
|
955
|
-
#
|
|
956
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
957
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
958
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
959
1087
|
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SessionSpec, ::Hash]
|
|
960
1088
|
# Session specification.
|
|
961
1089
|
#
|
|
962
1090
|
# Can be used only when `session` is set.
|
|
963
1091
|
# @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceThreshold]
|
|
964
|
-
# The relevance threshold of the search results.
|
|
1092
|
+
# The global relevance threshold of the search results.
|
|
965
1093
|
#
|
|
966
|
-
#
|
|
1094
|
+
# Defaults to Google defined threshold, leveraging a balance of
|
|
967
1095
|
# precision and recall to deliver both highly accurate results and
|
|
968
1096
|
# comprehensive coverage of relevant information.
|
|
1097
|
+
#
|
|
1098
|
+
# If more granular relevance filtering is required, use the
|
|
1099
|
+
# `relevance_filter_spec` instead.
|
|
1100
|
+
#
|
|
1101
|
+
# This feature is not supported for healthcare search.
|
|
1102
|
+
# @param relevance_filter_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceFilterSpec, ::Hash]
|
|
1103
|
+
# Optional. The granular relevance filtering specification.
|
|
1104
|
+
#
|
|
1105
|
+
# If not specified, the global `relevance_threshold` will be used for all
|
|
1106
|
+
# sub-searches. If specified, this overrides the global
|
|
1107
|
+
# `relevance_threshold` to use thresholds on a per sub-search basis.
|
|
1108
|
+
#
|
|
1109
|
+
# This feature is currently supported only for custom and site search.
|
|
969
1110
|
# @param personalization_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec, ::Hash]
|
|
970
1111
|
# The specification for personalization.
|
|
971
1112
|
#
|
|
@@ -977,6 +1118,21 @@ module Google
|
|
|
977
1118
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#personalization_spec SearchRequest.personalization_spec}
|
|
978
1119
|
# overrides
|
|
979
1120
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
|
|
1121
|
+
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
1122
|
+
# Optional. The specification for returning the relevance score.
|
|
1123
|
+
# @param search_addon_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SearchAddonSpec, ::Hash]
|
|
1124
|
+
# Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
1125
|
+
# repricing model.
|
|
1126
|
+
# This field is only supported for search requests.
|
|
1127
|
+
# @param custom_ranking_params [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CustomRankingParams, ::Hash]
|
|
1128
|
+
# Optional. Optional configuration for the Custom Ranking feature.
|
|
1129
|
+
# @param entity [::String]
|
|
1130
|
+
# Optional. The entity for customers that may run multiple different
|
|
1131
|
+
# entities, domains, sites or regions, for example, "Google US", "Google
|
|
1132
|
+
# Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
1133
|
+
# be exactly matched with
|
|
1134
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#entity UserEvent.entity} to
|
|
1135
|
+
# get search results boosted by entity.
|
|
980
1136
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
981
1137
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
|
|
982
1138
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -1111,6 +1267,7 @@ module Google
|
|
|
1111
1267
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
1112
1268
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
1113
1269
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
1270
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
1114
1271
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
1115
1272
|
# trigger a retry.
|
|
1116
1273
|
# @return [::Hash]
|
|
@@ -1183,6 +1340,7 @@ module Google
|
|
|
1183
1340
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
1184
1341
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
1185
1342
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
1343
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
1186
1344
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
1187
1345
|
# trigger a retry.
|
|
1188
1346
|
#
|
|
@@ -504,6 +504,7 @@ module Google
|
|
|
504
504
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
505
505
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
506
506
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
507
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
507
508
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
508
509
|
# trigger a retry.
|
|
509
510
|
# @return [::Hash]
|
|
@@ -587,6 +588,7 @@ module Google
|
|
|
587
588
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
588
589
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
589
590
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
591
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
590
592
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
591
593
|
# trigger a retry.
|
|
592
594
|
#
|
|
@@ -26,7 +26,9 @@ module Google
|
|
|
26
26
|
# Credentials for the SearchTuningService 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",
|
|
@@ -703,6 +703,7 @@ module Google
|
|
|
703
703
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
704
704
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
705
705
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
706
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
706
707
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
707
708
|
# trigger a retry.
|
|
708
709
|
# @return [::Hash]
|
|
@@ -786,6 +787,7 @@ module Google
|
|
|
786
787
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
787
788
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
788
789
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
790
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
789
791
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
790
792
|
# trigger a retry.
|
|
791
793
|
#
|
|
@@ -457,6 +457,7 @@ module Google
|
|
|
457
457
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
458
458
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
459
459
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
460
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
460
461
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
461
462
|
# trigger a retry.
|
|
462
463
|
# @return [::Hash]
|
|
@@ -529,6 +530,7 @@ module Google
|
|
|
529
530
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
530
531
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
531
532
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
533
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
532
534
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
533
535
|
# trigger a retry.
|
|
534
536
|
#
|
|
@@ -541,6 +541,7 @@ module Google
|
|
|
541
541
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
542
542
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
543
543
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
544
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
544
545
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
545
546
|
# trigger a retry.
|
|
546
547
|
# @return [::Hash]
|
|
@@ -613,6 +614,7 @@ module Google
|
|
|
613
614
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
614
615
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
615
616
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
617
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
616
618
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
617
619
|
# trigger a retry.
|
|
618
620
|
#
|
|
@@ -927,6 +929,13 @@ module Google
|
|
|
927
929
|
["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
|
|
928
930
|
]
|
|
929
931
|
)
|
|
932
|
+
.with_bindings(
|
|
933
|
+
uri_method: :get,
|
|
934
|
+
uri_template: "/v1beta/{name}/operations",
|
|
935
|
+
matches: [
|
|
936
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/?$}, false]
|
|
937
|
+
]
|
|
938
|
+
)
|
|
930
939
|
.with_bindings(
|
|
931
940
|
uri_method: :get,
|
|
932
941
|
uri_template: "/v1beta/{name}/operations",
|
|
@@ -1004,6 +1013,13 @@ module Google
|
|
|
1004
1013
|
["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+/?$}, false]
|
|
1005
1014
|
]
|
|
1006
1015
|
)
|
|
1016
|
+
.with_bindings(
|
|
1017
|
+
uri_method: :get,
|
|
1018
|
+
uri_template: "/v1beta/{name}",
|
|
1019
|
+
matches: [
|
|
1020
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+/?$}, false]
|
|
1021
|
+
]
|
|
1022
|
+
)
|
|
1007
1023
|
.with_bindings(
|
|
1008
1024
|
uri_method: :get,
|
|
1009
1025
|
uri_template: "/v1beta/{name}",
|
|
@@ -1046,6 +1062,13 @@ module Google
|
|
|
1046
1062
|
["name", %r{^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+/?$}, false]
|
|
1047
1063
|
]
|
|
1048
1064
|
)
|
|
1065
|
+
.with_bindings(
|
|
1066
|
+
uri_method: :get,
|
|
1067
|
+
uri_template: "/v1beta/{name}",
|
|
1068
|
+
matches: [
|
|
1069
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+/?$}, false]
|
|
1070
|
+
]
|
|
1071
|
+
)
|
|
1049
1072
|
.with_bindings(
|
|
1050
1073
|
uri_method: :get,
|
|
1051
1074
|
uri_template: "/v1beta/{name}",
|