google-cloud-discovery_engine-v1beta 0.11.0 → 0.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +875 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +167 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +814 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +440 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service.rb +58 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +31 -15
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +31 -15
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +24 -15
- data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +24 -15
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +19 -8
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +19 -8
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +824 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +250 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +770 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +1106 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +306 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +25 -3
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +25 -3
- data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +485 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +452 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +1106 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +24 -2
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +24 -2
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +5 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +1035 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/paths.rb +73 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +967 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +1106 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +426 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +911 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/paths.rb +69 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +850 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +366 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +25 -12
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +25 -12
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +104 -2
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +97 -2
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +59 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +35 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +5 -0
- data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +48 -0
- data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +56 -0
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_services_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb +51 -0
- data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_services_pb.rb +63 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_pb.rb +47 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_services_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +2 -0
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -10
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +9 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +119 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +209 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +126 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +29 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +75 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +44 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +6 -7
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +3 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +223 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +194 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +39 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +89 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +106 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +28 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +20 -19
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb +82 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_service.rb +179 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set_service.rb +186 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +95 -28
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +31 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +11 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +4 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +24 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +13 -1
- metadata +72 -2
@@ -8,13 +8,14 @@ require 'google/api/annotations_pb'
|
|
8
8
|
require 'google/api/client_pb'
|
9
9
|
require 'google/api/field_behavior_pb'
|
10
10
|
require 'google/api/resource_pb'
|
11
|
+
require 'google/cloud/discoveryengine/v1beta/custom_tuning_model_pb'
|
11
12
|
require 'google/cloud/discoveryengine/v1beta/import_config_pb'
|
12
13
|
require 'google/longrunning/operations_pb'
|
13
14
|
require 'google/protobuf/timestamp_pb'
|
14
15
|
require 'google/rpc/status_pb'
|
15
16
|
|
16
17
|
|
17
|
-
descriptor_data = "\n?google/cloud/discoveryengine/v1beta/search_tuning_service.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x37google/cloud/discoveryengine/v1beta/import_config.proto\x1a#google/longrunning/operations.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x17google/rpc/status.proto\"\
|
18
|
+
descriptor_data = "\n?google/cloud/discoveryengine/v1beta/search_tuning_service.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a=google/cloud/discoveryengine/v1beta/custom_tuning_model.proto\x1a\x37google/cloud/discoveryengine/v1beta/import_config.proto\x1a#google/longrunning/operations.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x17google/rpc/status.proto\"_\n\x17ListCustomModelsRequest\x12\x44\n\ndata_store\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\"b\n\x18ListCustomModelsResponse\x12\x46\n\x06models\x18\x01 \x03(\x0b\x32\x36.google.cloud.discoveryengine.v1beta.CustomTuningModel\"\xca\x03\n\x17TrainCustomModelRequest\x12k\n\x12gcs_training_input\x18\x02 \x01(\x0b\x32M.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInputH\x00\x12\x44\n\ndata_store\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x12\n\nmodel_type\x18\x03 \x01(\t\x12L\n\x0c\x65rror_config\x18\x04 \x01(\x0b\x32\x36.google.cloud.discoveryengine.v1beta.ImportErrorConfig\x12\x10\n\x08model_id\x18\x05 \x01(\t\x1av\n\x10GcsTrainingInput\x12\x18\n\x10\x63orpus_data_path\x18\x01 \x01(\t\x12\x17\n\x0fquery_data_path\x18\x02 \x01(\t\x12\x17\n\x0ftrain_data_path\x18\x03 \x01(\t\x12\x16\n\x0etest_data_path\x18\x04 \x01(\tB\x10\n\x0etraining_input\"\xca\x02\n\x18TrainCustomModelResponse\x12)\n\rerror_samples\x18\x01 \x03(\x0b\x32\x12.google.rpc.Status\x12L\n\x0c\x65rror_config\x18\x02 \x01(\x0b\x32\x36.google.cloud.discoveryengine.v1beta.ImportErrorConfig\x12\x14\n\x0cmodel_status\x18\x03 \x01(\t\x12[\n\x07metrics\x18\x04 \x03(\x0b\x32J.google.cloud.discoveryengine.v1beta.TrainCustomModelResponse.MetricsEntry\x12\x12\n\nmodel_name\x18\x05 \x01(\t\x1a.\n\x0cMetricsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x01:\x02\x38\x01\"|\n\x18TrainCustomModelMetadata\x12/\n\x0b\x63reate_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp2\xae\x05\n\x13SearchTuningService\x12\xd3\x02\n\x10TrainCustomModel\x12<.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest\x1a\x1d.google.longrunning.Operation\"\xe1\x01\xca\x41|\n<google.cloud.discoveryengine.v1beta.TrainCustomModelResponse\x12<google.cloud.discoveryengine.v1beta.TrainCustomModelMetadata\x82\xd3\xe4\x93\x02\\\"W/v1beta/{data_store=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel:\x01*\x12\xec\x01\n\x10ListCustomModels\x12<.google.cloud.discoveryengine.v1beta.ListCustomModelsRequest\x1a=.google.cloud.discoveryengine.v1beta.ListCustomModelsResponse\"[\x82\xd3\xe4\x93\x02U\x12S/v1beta/{data_store=projects/*/locations/*/collections/*/dataStores/*}/customModels\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x9f\x02\n\'com.google.cloud.discoveryengine.v1betaB\x18SearchTuningServiceProtoP\x01ZQcloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02#Google.Cloud.DiscoveryEngine.V1Beta\xca\x02#Google\\Cloud\\DiscoveryEngine\\V1beta\xea\x02&Google::Cloud::DiscoveryEngine::V1betab\x06proto3"
|
18
19
|
|
19
20
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
20
21
|
|
@@ -29,6 +30,7 @@ rescue TypeError
|
|
29
30
|
file = pool.add_serialized_file(serialized)
|
30
31
|
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
31
32
|
imports = [
|
33
|
+
["google.cloud.discoveryengine.v1beta.CustomTuningModel", "google/cloud/discoveryengine/v1beta/custom_tuning_model.proto"],
|
32
34
|
["google.cloud.discoveryengine.v1beta.ImportErrorConfig", "google/cloud/discoveryengine/v1beta/import_config.proto"],
|
33
35
|
["google.rpc.Status", "google/rpc/status.proto"],
|
34
36
|
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
@@ -47,6 +49,8 @@ module Google
|
|
47
49
|
module Cloud
|
48
50
|
module DiscoveryEngine
|
49
51
|
module V1beta
|
52
|
+
ListCustomModelsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.ListCustomModelsRequest").msgclass
|
53
|
+
ListCustomModelsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.ListCustomModelsResponse").msgclass
|
50
54
|
TrainCustomModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.TrainCustomModelRequest").msgclass
|
51
55
|
TrainCustomModelRequest::GcsTrainingInput = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput").msgclass
|
52
56
|
TrainCustomModelResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.TrainCustomModelResponse").msgclass
|
@@ -35,6 +35,8 @@ module Google
|
|
35
35
|
|
36
36
|
# Trains a custom model.
|
37
37
|
rpc :TrainCustomModel, ::Google::Cloud::DiscoveryEngine::V1beta::TrainCustomModelRequest, ::Google::Longrunning::Operation
|
38
|
+
# Gets a list of all the custom models.
|
39
|
+
rpc :ListCustomModels, ::Google::Cloud::DiscoveryEngine::V1beta::ListCustomModelsRequest, ::Google::Cloud::DiscoveryEngine::V1beta::ListCustomModelsResponse
|
38
40
|
end
|
39
41
|
|
40
42
|
Stub = Service.rpc_stub_class
|
@@ -9,7 +9,7 @@ require 'google/api/resource_pb'
|
|
9
9
|
require 'google/protobuf/timestamp_pb'
|
10
10
|
|
11
11
|
|
12
|
-
descriptor_data = "\n<google/cloud/discoveryengine/v1beta/site_search_engine.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x95\x02\n\x10SiteSearchEngine\x12\x0c\n\x04name\x18\x01 \x01(\t:\xf2\x01\xea\x41\xee\x01\n/discoveryengine.googleapis.com/SiteSearchEngine\x12Pprojects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine\x12iprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine\"\
|
12
|
+
descriptor_data = "\n<google/cloud/discoveryengine/v1beta/site_search_engine.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x95\x02\n\x10SiteSearchEngine\x12\x0c\n\x04name\x18\x01 \x01(\t:\xf2\x01\xea\x41\xee\x01\n/discoveryengine.googleapis.com/SiteSearchEngine\x12Pprojects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine\x12iprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine\"\xaa\t\n\nTargetSite\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x03\x12$\n\x14provided_uri_pattern\x18\x02 \x01(\tB\x06\xe0\x41\x02\xe0\x41\x04\x12\x42\n\x04type\x18\x03 \x01(\x0e\x32\x34.google.cloud.discoveryengine.v1beta.TargetSite.Type\x12\x18\n\x0b\x65xact_match\x18\x06 \x01(\x08\x42\x03\xe0\x41\x04\x12\"\n\x15generated_uri_pattern\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x1c\n\x0froot_domain_uri\x18\n \x01(\tB\x03\xe0\x41\x03\x12^\n\x16site_verification_info\x18\x07 \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1beta.SiteVerificationInfoB\x03\xe0\x41\x03\x12\\\n\x0findexing_status\x18\x08 \x01(\x0e\x32>.google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatusB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12Z\n\x0e\x66\x61ilure_reason\x18\t \x01(\x0b\x32=.google.cloud.discoveryengine.v1beta.TargetSite.FailureReasonB\x03\xe0\x41\x03\x1a\xad\x01\n\rFailureReason\x12\x63\n\rquota_failure\x18\x01 \x01(\x0b\x32J.google.cloud.discoveryengine.v1beta.TargetSite.FailureReason.QuotaFailureH\x00\x1a,\n\x0cQuotaFailure\x12\x1c\n\x14total_required_quota\x18\x01 \x01(\x03\x42\t\n\x07\x66\x61ilure\"6\n\x04Type\x12\x14\n\x10TYPE_UNSPECIFIED\x10\x00\x12\x0b\n\x07INCLUDE\x10\x01\x12\x0b\n\x07\x45XCLUDE\x10\x02\"g\n\x0eIndexingStatus\x12\x1f\n\x1bINDEXING_STATUS_UNSPECIFIED\x10\x00\x12\x0b\n\x07PENDING\x10\x01\x12\n\n\x06\x46\x41ILED\x10\x02\x12\r\n\tSUCCEEDED\x10\x03\x12\x0c\n\x08\x44\x45LETING\x10\x04:\xa1\x02\xea\x41\x9d\x02\n)discoveryengine.googleapis.com/TargetSite\x12jprojects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}\x12\x83\x01projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}\"\xa7\x02\n\x14SiteVerificationInfo\x12p\n\x17site_verification_state\x18\x01 \x01(\x0e\x32O.google.cloud.discoveryengine.v1beta.SiteVerificationInfo.SiteVerificationState\x12/\n\x0bverify_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"l\n\x15SiteVerificationState\x12\'\n#SITE_VERIFICATION_STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08VERIFIED\x10\x01\x12\x0e\n\nUNVERIFIED\x10\x02\x12\x0c\n\x08\x45XEMPTED\x10\x03\x42\x9c\x02\n\'com.google.cloud.discoveryengine.v1betaB\x15SiteSearchEngineProtoP\x01ZQcloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02#Google.Cloud.DiscoveryEngine.V1Beta\xca\x02#Google\\Cloud\\DiscoveryEngine\\V1beta\xea\x02&Google::Cloud::DiscoveryEngine::V1betab\x06proto3"
|
13
13
|
|
14
14
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
15
15
|
|
@@ -11,7 +11,7 @@ require 'google/protobuf/duration_pb'
|
|
11
11
|
require 'google/protobuf/timestamp_pb'
|
12
12
|
|
13
13
|
|
14
|
-
descriptor_data = "\n4google/cloud/discoveryengine/v1beta/user_event.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x30google/cloud/discoveryengine/v1beta/common.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\
|
14
|
+
descriptor_data = "\n4google/cloud/discoveryengine/v1beta/user_event.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x30google/cloud/discoveryengine/v1beta/common.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xe2\x08\n\tUserEvent\x12\x17\n\nevent_type\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x1b\n\x0euser_pseudo_id\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12:\n\x06\x65ngine\x18\x13 \x01(\tB*\xfa\x41\'\n%discoveryengine.googleapis.com/Engine\x12\x41\n\ndata_store\x18\x14 \x01(\tB-\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12.\n\nevent_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12@\n\tuser_info\x18\x04 \x01(\x0b\x32-.google.cloud.discoveryengine.v1beta.UserInfo\x12\x1b\n\x13\x64irect_user_request\x18\x05 \x01(\x08\x12\x12\n\nsession_id\x18\x06 \x01(\t\x12@\n\tpage_info\x18\x07 \x01(\x0b\x32-.google.cloud.discoveryengine.v1beta.PageInfo\x12\x19\n\x11\x61ttribution_token\x18\x08 \x01(\t\x12\x0e\n\x06\x66ilter\x18\t \x01(\t\x12\x44\n\tdocuments\x18\n \x03(\x0b\x32\x31.google.cloud.discoveryengine.v1beta.DocumentInfo\x12=\n\x05panel\x18\x0b \x01(\x0b\x32..google.cloud.discoveryengine.v1beta.PanelInfo\x12\x44\n\x0bsearch_info\x18\x0c \x01(\x0b\x32/.google.cloud.discoveryengine.v1beta.SearchInfo\x12L\n\x0f\x63ompletion_info\x18\r \x01(\x0b\x32\x33.google.cloud.discoveryengine.v1beta.CompletionInfo\x12N\n\x10transaction_info\x18\x0e \x01(\x0b\x32\x34.google.cloud.discoveryengine.v1beta.TransactionInfo\x12\x0f\n\x07tag_ids\x18\x0f \x03(\t\x12\x15\n\rpromotion_ids\x18\x10 \x03(\t\x12R\n\nattributes\x18\x11 \x03(\x0b\x32>.google.cloud.discoveryengine.v1beta.UserEvent.AttributesEntry\x12\x42\n\nmedia_info\x18\x12 \x01(\x0b\x32..google.cloud.discoveryengine.v1beta.MediaInfo\x1ag\n\x0f\x41ttributesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x43\n\x05value\x18\x02 \x01(\x0b\x32\x34.google.cloud.discoveryengine.v1beta.CustomAttribute:\x02\x38\x01\"Y\n\x08PageInfo\x12\x13\n\x0bpageview_id\x18\x01 \x01(\t\x12\x15\n\rpage_category\x18\x02 \x01(\t\x12\x0b\n\x03uri\x18\x03 \x01(\t\x12\x14\n\x0creferrer_uri\x18\x04 \x01(\t\"T\n\nSearchInfo\x12\x14\n\x0csearch_query\x18\x01 \x01(\t\x12\x10\n\x08order_by\x18\x02 \x01(\t\x12\x13\n\x06offset\x18\x03 \x01(\x05H\x00\x88\x01\x01\x42\t\n\x07_offset\"H\n\x0e\x43ompletionInfo\x12\x1b\n\x13selected_suggestion\x18\x01 \x01(\t\x12\x19\n\x11selected_position\x18\x02 \x01(\x05\"\xc9\x01\n\x0fTransactionInfo\x12\x17\n\x05value\x18\x01 \x01(\x02\x42\x03\xe0\x41\x02H\x00\x88\x01\x01\x12\x15\n\x08\x63urrency\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12\x16\n\x0etransaction_id\x18\x03 \x01(\t\x12\x10\n\x03tax\x18\x04 \x01(\x02H\x01\x88\x01\x01\x12\x11\n\x04\x63ost\x18\x05 \x01(\x02H\x02\x88\x01\x01\x12\x1b\n\x0e\x64iscount_value\x18\x06 \x01(\x02H\x03\x88\x01\x01\x42\x08\n\x06_valueB\x06\n\x04_taxB\x07\n\x05_costB\x11\n\x0f_discount_value\"\xbb\x01\n\x0c\x44ocumentInfo\x12\x0c\n\x02id\x18\x01 \x01(\tH\x00\x12<\n\x04name\x18\x02 \x01(\tB,\xfa\x41)\n\'discoveryengine.googleapis.com/DocumentH\x00\x12\r\n\x03uri\x18\x06 \x01(\tH\x00\x12\x15\n\x08quantity\x18\x03 \x01(\x05H\x01\x88\x01\x01\x12\x15\n\rpromotion_ids\x18\x04 \x03(\tB\x15\n\x13\x64ocument_descriptorB\x0b\n\t_quantity\"\x94\x01\n\tPanelInfo\x12\x15\n\x08panel_id\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12\x14\n\x0c\x64isplay_name\x18\x03 \x01(\t\x12\x1b\n\x0epanel_position\x18\x04 \x01(\x05H\x00\x88\x01\x01\x12\x19\n\x0ctotal_panels\x18\x05 \x01(\x05H\x01\x88\x01\x01\x42\x11\n\x0f_panel_positionB\x0f\n\r_total_panels\"\x8d\x01\n\tMediaInfo\x12:\n\x17media_progress_duration\x18\x01 \x01(\x0b\x32\x19.google.protobuf.Duration\x12&\n\x19media_progress_percentage\x18\x02 \x01(\x02H\x00\x88\x01\x01\x42\x1c\n\x1a_media_progress_percentageB\x95\x02\n\'com.google.cloud.discoveryengine.v1betaB\x0eUserEventProtoP\x01ZQcloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02#Google.Cloud.DiscoveryEngine.V1Beta\xca\x02#Google\\Cloud\\DiscoveryEngine\\V1beta\xea\x02&Google::Cloud::DiscoveryEngine::V1betab\x06proto3"
|
15
15
|
|
16
16
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
17
17
|
|
@@ -14,7 +14,7 @@ require 'google/cloud/discoveryengine/v1beta/user_event_pb'
|
|
14
14
|
require 'google/longrunning/operations_pb'
|
15
15
|
|
16
16
|
|
17
|
-
descriptor_data = "\n<google/cloud/discoveryengine/v1beta/user_event_service.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/httpbody.proto\x1a\x19google/api/resource.proto\x1a\x37google/cloud/discoveryengine/v1beta/import_config.proto\x1a\x34google/cloud/discoveryengine/v1beta/user_event.proto\x1a#google/longrunning/operations.proto\"\
|
17
|
+
descriptor_data = "\n<google/cloud/discoveryengine/v1beta/user_event_service.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/httpbody.proto\x1a\x19google/api/resource.proto\x1a\x37google/cloud/discoveryengine/v1beta/import_config.proto\x1a\x34google/cloud/discoveryengine/v1beta/user_event.proto\x1a#google/longrunning/operations.proto\"\xcb\x01\n\x15WriteUserEventRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12L\n\nuser_event\x18\x02 \x01(\x0b\x32..google.cloud.discoveryengine.v1beta.UserEventB\x03\xe0\x41\x02H\x00\x88\x01\x01\x12\x13\n\x0bwrite_async\x18\x03 \x01(\x08\x42\r\n\x0b_user_event\"\xa8\x01\n\x17\x43ollectUserEventRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x17\n\nuser_event\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12\x10\n\x03uri\x18\x03 \x01(\tH\x00\x88\x01\x01\x12\x10\n\x03\x65ts\x18\x04 \x01(\x03H\x01\x88\x01\x01\x42\x06\n\x04_uriB\x06\n\x04_ets2\xa3\t\n\x10UserEventService\x12\x84\x03\n\x0eWriteUserEvent\x12:.google.cloud.discoveryengine.v1beta.WriteUserEventRequest\x1a..google.cloud.discoveryengine.v1beta.UserEvent\"\x85\x02\x82\xd3\xe4\x93\x02\xfe\x01\"E/v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:write:\nuser_eventZa\"S/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write:\nuser_eventZF\"8/v1beta/{parent=projects/*/locations/*}/userEvents:write:\nuser_event\x12\x92\x02\n\x10\x43ollectUserEvent\x12<.google.cloud.discoveryengine.v1beta.CollectUserEventRequest\x1a\x14.google.api.HttpBody\"\xa9\x01\x82\xd3\xe4\x93\x02\xa2\x01\x12G/v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:collectZW\x12U/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect\x12\x9e\x03\n\x10ImportUserEvents\x12<.google.cloud.discoveryengine.v1beta.ImportUserEventsRequest\x1a\x1d.google.longrunning.Operation\"\xac\x02\xca\x41|\n<google.cloud.discoveryengine.v1beta.ImportUserEventsResponse\x12<google.cloud.discoveryengine.v1beta.ImportUserEventsMetadata\x82\xd3\xe4\x93\x02\xa6\x01\"F/v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:import:\x01*ZY\"T/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import:\x01*\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x9c\x02\n\'com.google.cloud.discoveryengine.v1betaB\x15UserEventServiceProtoP\x01ZQcloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02#Google.Cloud.DiscoveryEngine.V1Beta\xca\x02#Google\\Cloud\\DiscoveryEngine\\V1beta\xea\x02&Google::Cloud::DiscoveryEngine::V1betab\x06proto3"
|
18
18
|
|
19
19
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
20
20
|
|
@@ -41,7 +41,7 @@ module Google
|
|
41
41
|
# This method is used only by the Discovery Engine API JavaScript pixel and
|
42
42
|
# Google Tag Manager. Users should not call this method directly.
|
43
43
|
rpc :CollectUserEvent, ::Google::Cloud::DiscoveryEngine::V1beta::CollectUserEventRequest, ::Google::Api::HttpBody
|
44
|
-
# Bulk import of
|
44
|
+
# Bulk import of user events. Request processing might be
|
45
45
|
# synchronous. Events that already exist are skipped.
|
46
46
|
# Use this method for backfilling historical user events.
|
47
47
|
#
|
@@ -290,6 +290,13 @@ module Google
|
|
290
290
|
# @return [::String]
|
291
291
|
# The fully qualified name of the method, for which the options below apply.
|
292
292
|
# This is used to find the method to apply the options.
|
293
|
+
#
|
294
|
+
# Example:
|
295
|
+
#
|
296
|
+
# publishing:
|
297
|
+
# method_settings:
|
298
|
+
# - selector: google.storage.control.v2.StorageControl.CreateFolder
|
299
|
+
# # method settings for CreateFolder...
|
293
300
|
# @!attribute [rw] long_running
|
294
301
|
# @return [::Google::Api::MethodSettings::LongRunning]
|
295
302
|
# Describes settings to use for long-running operations when generating
|
@@ -298,17 +305,14 @@ module Google
|
|
298
305
|
#
|
299
306
|
# Example of a YAML configuration::
|
300
307
|
#
|
301
|
-
#
|
302
|
-
#
|
308
|
+
# publishing:
|
309
|
+
# method_settings:
|
303
310
|
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
304
311
|
# long_running:
|
305
|
-
# initial_poll_delay:
|
306
|
-
# seconds: 60 # 1 minute
|
312
|
+
# initial_poll_delay: 60s # 1 minute
|
307
313
|
# poll_delay_multiplier: 1.5
|
308
|
-
# max_poll_delay:
|
309
|
-
#
|
310
|
-
# total_poll_timeout:
|
311
|
-
# seconds: 54000 # 90 minutes
|
314
|
+
# max_poll_delay: 360s # 6 minutes
|
315
|
+
# total_poll_timeout: 54000s # 90 minutes
|
312
316
|
# @!attribute [rw] auto_populated_fields
|
313
317
|
# @return [::Array<::String>]
|
314
318
|
# List of top-level fields of the request message, that should be
|
@@ -317,8 +321,8 @@ module Google
|
|
317
321
|
#
|
318
322
|
# Example of a YAML configuration:
|
319
323
|
#
|
320
|
-
#
|
321
|
-
#
|
324
|
+
# publishing:
|
325
|
+
# method_settings:
|
322
326
|
# - selector: google.example.v1.ExampleService.CreateExample
|
323
327
|
# auto_populated_fields:
|
324
328
|
# - request_id
|
@@ -124,8 +124,13 @@ module Google
|
|
124
124
|
# @return [::String]
|
125
125
|
# The plural name used in the resource name and permission names, such as
|
126
126
|
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
127
|
-
# name of 'cloudresourcemanager.googleapis.com/projects.get'.
|
128
|
-
#
|
127
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
|
128
|
+
# to this is for Nested Collections that have stuttering names, as defined
|
129
|
+
# in [AIP-122](https://google.aip.dev/122#nested-collections), where the
|
130
|
+
# collection ID in the resource name pattern does not necessarily directly
|
131
|
+
# match the `plural` value.
|
132
|
+
#
|
133
|
+
# It is the same concept of the `plural` field in k8s CRD spec
|
129
134
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
130
135
|
#
|
131
136
|
# Note: The plural form is required even for singleton resources. See
|
@@ -25,7 +25,7 @@ module Google
|
|
25
25
|
# @!attribute [rw] name
|
26
26
|
# @return [::String]
|
27
27
|
# Immutable. Fully qualified name
|
28
|
-
# `project
|
28
|
+
# `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
|
29
29
|
# @!attribute [rw] state
|
30
30
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::State]
|
31
31
|
# The state of the answer generation.
|
@@ -110,6 +110,10 @@ module Google
|
|
110
110
|
# @!attribute [rw] chunk_contents
|
111
111
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::UnstructuredDocumentInfo::ChunkContent>]
|
112
112
|
# List of cited chunk contents derived from document content.
|
113
|
+
# @!attribute [rw] struct_data
|
114
|
+
# @return [::Google::Protobuf::Struct]
|
115
|
+
# The structured JSON metadata for the document.
|
116
|
+
# It is populated from the struct data from the Chunk in search result.
|
113
117
|
class UnstructuredDocumentInfo
|
114
118
|
include ::Google::Protobuf::MessageExts
|
115
119
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -157,6 +161,10 @@ module Google
|
|
157
161
|
# @!attribute [rw] page_identifier
|
158
162
|
# @return [::String]
|
159
163
|
# Page identifier.
|
164
|
+
# @!attribute [rw] struct_data
|
165
|
+
# @return [::Google::Protobuf::Struct]
|
166
|
+
# The structured JSON metadata for the document.
|
167
|
+
# It is populated from the struct data from the Chunk in search result.
|
160
168
|
class DocumentMetadata
|
161
169
|
include ::Google::Protobuf::MessageExts
|
162
170
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -0,0 +1,119 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Chunk captures all raw metadata information of items to be recommended or
|
25
|
+
# searched in the chunk mode.
|
26
|
+
# @!attribute [rw] name
|
27
|
+
# @return [::String]
|
28
|
+
# The full resource name of the chunk.
|
29
|
+
# Format:
|
30
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
|
31
|
+
#
|
32
|
+
# This field must be a UTF-8 encoded string with a length limit of 1024
|
33
|
+
# characters.
|
34
|
+
# @!attribute [rw] id
|
35
|
+
# @return [::String]
|
36
|
+
# Unique chunk ID of the current chunk.
|
37
|
+
# @!attribute [rw] content
|
38
|
+
# @return [::String]
|
39
|
+
# Content is a string from a document (parsed content).
|
40
|
+
# @!attribute [r] relevance_score
|
41
|
+
# @return [::Float]
|
42
|
+
# Output only. Represents the relevance score based on similarity.
|
43
|
+
# Higher score indicates higher chunk relevance.
|
44
|
+
# The score is in range [-1.0, 1.0].
|
45
|
+
# Only populated on [SearchService.SearchResponse][].
|
46
|
+
# @!attribute [rw] document_metadata
|
47
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk::DocumentMetadata]
|
48
|
+
# Metadata of the document from the current chunk.
|
49
|
+
# @!attribute [r] derived_struct_data
|
50
|
+
# @return [::Google::Protobuf::Struct]
|
51
|
+
# Output only. This field is OUTPUT_ONLY.
|
52
|
+
# It contains derived data that are not in the original input document.
|
53
|
+
# @!attribute [rw] page_span
|
54
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk::PageSpan]
|
55
|
+
# Page span of the chunk.
|
56
|
+
# @!attribute [r] chunk_metadata
|
57
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk::ChunkMetadata]
|
58
|
+
# Output only. Metadata of the current chunk.
|
59
|
+
class Chunk
|
60
|
+
include ::Google::Protobuf::MessageExts
|
61
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
62
|
+
|
63
|
+
# Document metadata contains the information of the document of the current
|
64
|
+
# chunk.
|
65
|
+
# @!attribute [rw] uri
|
66
|
+
# @return [::String]
|
67
|
+
# Uri of the document.
|
68
|
+
# @!attribute [rw] title
|
69
|
+
# @return [::String]
|
70
|
+
# Title of the document.
|
71
|
+
# @!attribute [rw] struct_data
|
72
|
+
# @return [::Google::Protobuf::Struct]
|
73
|
+
# Data representation.
|
74
|
+
# The structured JSON data for the document. It should conform to the
|
75
|
+
# registered {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} or an
|
76
|
+
# `INVALID_ARGUMENT` error is thrown.
|
77
|
+
class DocumentMetadata
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
|
+
end
|
81
|
+
|
82
|
+
# Page span of the chunk.
|
83
|
+
# @!attribute [rw] page_start
|
84
|
+
# @return [::Integer]
|
85
|
+
# The start page of the chunk.
|
86
|
+
# @!attribute [rw] page_end
|
87
|
+
# @return [::Integer]
|
88
|
+
# The end page of the chunk.
|
89
|
+
class PageSpan
|
90
|
+
include ::Google::Protobuf::MessageExts
|
91
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
92
|
+
end
|
93
|
+
|
94
|
+
# Metadata of the current chunk. This field is only populated on
|
95
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
|
96
|
+
# API.
|
97
|
+
# @!attribute [rw] previous_chunks
|
98
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Chunk>]
|
99
|
+
# The previous chunks of the current chunk. The number is controlled by
|
100
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec#num_previous_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks}.
|
101
|
+
# This field is only populated on
|
102
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
|
103
|
+
# API.
|
104
|
+
# @!attribute [rw] next_chunks
|
105
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Chunk>]
|
106
|
+
# The next chunks of the current chunk. The number is controlled by
|
107
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec#num_next_chunks SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks}.
|
108
|
+
# This field is only populated on
|
109
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
|
110
|
+
# API.
|
111
|
+
class ChunkMetadata
|
112
|
+
include ::Google::Protobuf::MessageExts
|
113
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
@@ -156,6 +156,22 @@ module Google
|
|
156
156
|
SOLUTION_TYPE_GENERATIVE_CHAT = 4
|
157
157
|
end
|
158
158
|
|
159
|
+
# Defines a further subdivision of `SolutionType`.
|
160
|
+
# Specifically applies to
|
161
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
|
162
|
+
module SearchUseCase
|
163
|
+
# Value used when unset. Will not occur in CSS.
|
164
|
+
SEARCH_USE_CASE_UNSPECIFIED = 0
|
165
|
+
|
166
|
+
# Search use case. Expects the traffic has a non-empty
|
167
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query query}.
|
168
|
+
SEARCH_USE_CASE_SEARCH = 1
|
169
|
+
|
170
|
+
# Browse use case. Expects the traffic has an empty
|
171
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query query}.
|
172
|
+
SEARCH_USE_CASE_BROWSE = 2
|
173
|
+
end
|
174
|
+
|
159
175
|
# Tiers of search features. Different tiers might have different
|
160
176
|
# pricing. To learn more, check the pricing documentation.
|
161
177
|
module SearchTier
|
@@ -0,0 +1,209 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Defines circumstances to be checked before allowing a behavior
|
25
|
+
# @!attribute [rw] query_terms
|
26
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::QueryTerm>]
|
27
|
+
# Search only
|
28
|
+
# A list of terms to match the query on.
|
29
|
+
#
|
30
|
+
# Maximum of 10 query terms.
|
31
|
+
# @!attribute [rw] active_time_range
|
32
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::TimeRange>]
|
33
|
+
# Range of time(s) specifying when condition is active.
|
34
|
+
#
|
35
|
+
# Maximum of 10 time ranges.
|
36
|
+
class Condition
|
37
|
+
include ::Google::Protobuf::MessageExts
|
38
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
39
|
+
|
40
|
+
# Matcher for search request query
|
41
|
+
# @!attribute [rw] value
|
42
|
+
# @return [::String]
|
43
|
+
# The specific query value to match against
|
44
|
+
#
|
45
|
+
# Must be lowercase, must be UTF-8.
|
46
|
+
# Can have at most 3 space separated terms if full_match is true.
|
47
|
+
# Cannot be an empty string.
|
48
|
+
# Maximum length of 5000 characters.
|
49
|
+
# @!attribute [rw] full_match
|
50
|
+
# @return [::Boolean]
|
51
|
+
# Whether the search query needs to exactly match the query term.
|
52
|
+
class QueryTerm
|
53
|
+
include ::Google::Protobuf::MessageExts
|
54
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
55
|
+
end
|
56
|
+
|
57
|
+
# Used for time-dependent conditions.
|
58
|
+
# @!attribute [rw] start_time
|
59
|
+
# @return [::Google::Protobuf::Timestamp]
|
60
|
+
# Start of time range.
|
61
|
+
#
|
62
|
+
# Range is inclusive.
|
63
|
+
# @!attribute [rw] end_time
|
64
|
+
# @return [::Google::Protobuf::Timestamp]
|
65
|
+
# End of time range.
|
66
|
+
#
|
67
|
+
# Range is inclusive.
|
68
|
+
# Must be in the future.
|
69
|
+
class TimeRange
|
70
|
+
include ::Google::Protobuf::MessageExts
|
71
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
# Defines a conditioned behavior to employ during serving.
|
76
|
+
# Must be attached to a
|
77
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} to be
|
78
|
+
# considered at serving time. Permitted actions dependent on `SolutionType`.
|
79
|
+
# @!attribute [rw] boost_action
|
80
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction]
|
81
|
+
# Defines a boost-type control
|
82
|
+
# @!attribute [rw] filter_action
|
83
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction]
|
84
|
+
# Defines a filter-type control
|
85
|
+
# Currently not supported by Recommendation
|
86
|
+
# @!attribute [rw] redirect_action
|
87
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction]
|
88
|
+
# Defines a redirect-type control.
|
89
|
+
# @!attribute [rw] synonyms_action
|
90
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction]
|
91
|
+
# Treats a group of terms as synonyms of one another.
|
92
|
+
# @!attribute [rw] name
|
93
|
+
# @return [::String]
|
94
|
+
# Immutable. Fully qualified name
|
95
|
+
# `projects/*/locations/global/dataStore/*/controls/*`
|
96
|
+
# @!attribute [rw] display_name
|
97
|
+
# @return [::String]
|
98
|
+
# Required. Human readable name. The identifier used in UI views.
|
99
|
+
#
|
100
|
+
# Must be UTF-8 encoded string. Length limit is 128 characters.
|
101
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
102
|
+
# @!attribute [r] associated_serving_config_ids
|
103
|
+
# @return [::Array<::String>]
|
104
|
+
# Output only. List of all
|
105
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} ids this
|
106
|
+
# control is attached to. May take up to 10 minutes to update after changes.
|
107
|
+
# @!attribute [rw] solution_type
|
108
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SolutionType]
|
109
|
+
# Required. Immutable. What solution the control belongs to.
|
110
|
+
#
|
111
|
+
# Must be compatible with vertical of resource.
|
112
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
113
|
+
# @!attribute [rw] use_cases
|
114
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>]
|
115
|
+
# Specifies the use case for the control.
|
116
|
+
# Affects what condition fields can be set.
|
117
|
+
# Only applies to
|
118
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
|
119
|
+
# Currently only allow one use case per control.
|
120
|
+
# Must be set when solution_type is
|
121
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SolutionType.SOLUTION_TYPE_SEARCH}.
|
122
|
+
# @!attribute [rw] conditions
|
123
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>]
|
124
|
+
# Determines when the associated action will trigger.
|
125
|
+
#
|
126
|
+
# Omit to always apply the action.
|
127
|
+
# Currently only a single condition may be specified.
|
128
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
129
|
+
class Control
|
130
|
+
include ::Google::Protobuf::MessageExts
|
131
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
|
+
|
133
|
+
# Adjusts order of products in returned list.
|
134
|
+
# @!attribute [rw] boost
|
135
|
+
# @return [::Float]
|
136
|
+
# Required. Strength of the boost, which should be in [-1, 1]. Negative
|
137
|
+
# boost means demotion. Default is 0.0 (No-op).
|
138
|
+
# @!attribute [rw] filter
|
139
|
+
# @return [::String]
|
140
|
+
# Required. Specifies which products to apply the boost to.
|
141
|
+
#
|
142
|
+
# If no filter is provided all products will be boosted (No-op).
|
143
|
+
# Syntax documentation:
|
144
|
+
# https://cloud.google.com/retail/docs/filter-and-order
|
145
|
+
# Maximum length is 5000 characters.
|
146
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
147
|
+
# @!attribute [rw] data_store
|
148
|
+
# @return [::String]
|
149
|
+
# Required. Specifies which data store's documents can be boosted by this
|
150
|
+
# control. Full data store name e.g.
|
151
|
+
# projects/123/locations/global/collections/default_collection/dataStores/default_data_store
|
152
|
+
class BoostAction
|
153
|
+
include ::Google::Protobuf::MessageExts
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
end
|
156
|
+
|
157
|
+
# Specified which products may be included in results.
|
158
|
+
# Uses same filter as boost.
|
159
|
+
# @!attribute [rw] filter
|
160
|
+
# @return [::String]
|
161
|
+
# Required. A filter to apply on the matching condition results.
|
162
|
+
#
|
163
|
+
# Required
|
164
|
+
# Syntax documentation:
|
165
|
+
# https://cloud.google.com/retail/docs/filter-and-order
|
166
|
+
# Maximum length is 5000 characters. Otherwise an INVALID
|
167
|
+
# ARGUMENT error is thrown.
|
168
|
+
# @!attribute [rw] data_store
|
169
|
+
# @return [::String]
|
170
|
+
# Required. Specifies which data store's documents can be filtered by this
|
171
|
+
# control. Full data store name e.g.
|
172
|
+
# projects/123/locations/global/collections/default_collection/dataStores/default_data_store
|
173
|
+
class FilterAction
|
174
|
+
include ::Google::Protobuf::MessageExts
|
175
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
176
|
+
end
|
177
|
+
|
178
|
+
# Redirects a shopper to the provided URI.
|
179
|
+
# @!attribute [rw] redirect_uri
|
180
|
+
# @return [::String]
|
181
|
+
# Required. The URI to which the shopper will be redirected.
|
182
|
+
#
|
183
|
+
# Required.
|
184
|
+
# URI must have length equal or less than 2000 characters.
|
185
|
+
# Otherwise an INVALID ARGUMENT error is thrown.
|
186
|
+
class RedirectAction
|
187
|
+
include ::Google::Protobuf::MessageExts
|
188
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
189
|
+
end
|
190
|
+
|
191
|
+
# Creates a set of terms that will act as synonyms of one another.
|
192
|
+
#
|
193
|
+
# Example: "happy" will also be considered as "glad", "glad" will also be
|
194
|
+
# considered as "happy".
|
195
|
+
# @!attribute [rw] synonyms
|
196
|
+
# @return [::Array<::String>]
|
197
|
+
# Defines a set of synonyms.
|
198
|
+
# Can specify up to 100 synonyms.
|
199
|
+
# Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
|
200
|
+
# thrown.
|
201
|
+
class SynonymsAction
|
202
|
+
include ::Google::Protobuf::MessageExts
|
203
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
204
|
+
end
|
205
|
+
end
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|