google-cloud-discovery_engine-v1 0.6.0 → 0.8.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/v1/completion_service/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +875 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/paths.rb +167 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb +814 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest/service_stub.rb +440 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/control_service.rb +58 -0
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +769 -7
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +199 -0
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +720 -7
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +520 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +94 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +71 -33
- data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/document_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +71 -33
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +471 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +438 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +485 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/paths.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/client.rb +452 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +1114 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1/project_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +481 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +448 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +558 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/paths.rb +220 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +525 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/service_stub.rb +145 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/rest.rb +5 -0
- data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +26 -13
- data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +45 -0
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +26 -13
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1.rb +5 -0
- data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1/common_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1/control_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1/control_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1/control_service_services_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +32 -1
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1/document_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +48 -0
- data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +52 -0
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/grounding_pb.rb +46 -0
- data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +13 -1
- data/lib/google/cloud/discoveryengine/v1/project_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/project_service_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1/project_service_services_pb.rb +51 -0
- data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/rank_service_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/rank_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/recommendation_service_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1/recommendation_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1/session_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +4 -0
- data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +362 -0
- data/proto_docs/google/cloud/discoveryengine/v1/common.rb +25 -1
- data/proto_docs/google/cloud/discoveryengine/v1/control.rb +207 -0
- data/proto_docs/google/cloud/discoveryengine/v1/control_service.rb +126 -0
- data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +490 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +19 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1/document.rb +7 -0
- data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +102 -0
- data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +8 -4
- data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +144 -0
- data/proto_docs/google/cloud/discoveryengine/v1/grounding.rb +79 -0
- data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +313 -24
- data/proto_docs/google/cloud/discoveryengine/v1/project.rb +106 -0
- data/proto_docs/google/cloud/discoveryengine/v1/project_service.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +124 -0
- data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb +229 -0
- data/proto_docs/google/cloud/discoveryengine/v1/schema_service.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +150 -37
- data/proto_docs/google/cloud/discoveryengine/v1/session.rb +88 -0
- data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +40 -14
- data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +13 -1
- metadata +66 -2
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
3
|
+
# source: google/cloud/discoveryengine/v1/session.proto
|
4
|
+
|
5
|
+
require 'google/protobuf'
|
6
|
+
|
7
|
+
require 'google/api/field_behavior_pb'
|
8
|
+
require 'google/api/resource_pb'
|
9
|
+
require 'google/protobuf/timestamp_pb'
|
10
|
+
|
11
|
+
|
12
|
+
descriptor_data = "\n-google/cloud/discoveryengine/v1/session.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x9b\x06\n\x07Session\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x05\x12=\n\x05state\x18\x02 \x01(\x0e\x32..google.cloud.discoveryengine.v1.Session.State\x12\x16\n\x0euser_pseudo_id\x18\x03 \x01(\t\x12<\n\x05turns\x18\x04 \x03(\x0b\x32-.google.cloud.discoveryengine.v1.Session.Turn\x12\x33\n\nstart_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x1ay\n\x04Turn\x12\x35\n\x05query\x18\x01 \x01(\x0b\x32&.google.cloud.discoveryengine.v1.Query\x12:\n\x06\x61nswer\x18\x02 \x01(\tB*\xfa\x41\'\n%discoveryengine.googleapis.com/Answer\"/\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0f\n\x0bIN_PROGRESS\x10\x01:\xd3\x02\xea\x41\xcf\x02\n&discoveryengine.googleapis.com/Session\x12Rprojects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}\x12kprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}\x12\x64projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}\"4\n\x05Query\x12\x0e\n\x04text\x18\x02 \x01(\tH\x00\x12\x10\n\x08query_id\x18\x01 \x01(\tB\t\n\x07\x63ontentB\xff\x01\n#com.google.cloud.discoveryengine.v1B\x0cSessionProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
|
13
|
+
|
14
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
15
|
+
|
16
|
+
begin
|
17
|
+
pool.add_serialized_file(descriptor_data)
|
18
|
+
rescue TypeError
|
19
|
+
# Compatibility code: will be removed in the next major version.
|
20
|
+
require 'google/protobuf/descriptor_pb'
|
21
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
22
|
+
parsed.clear_dependency
|
23
|
+
serialized = parsed.class.encode(parsed)
|
24
|
+
file = pool.add_serialized_file(serialized)
|
25
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
26
|
+
imports = [
|
27
|
+
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
28
|
+
]
|
29
|
+
imports.each do |type_name, expected_filename|
|
30
|
+
import_file = pool.lookup(type_name).file_descriptor
|
31
|
+
if import_file.name != expected_filename
|
32
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
33
|
+
end
|
34
|
+
end
|
35
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
36
|
+
warn "This will become an error in the next major version."
|
37
|
+
end
|
38
|
+
|
39
|
+
module Google
|
40
|
+
module Cloud
|
41
|
+
module DiscoveryEngine
|
42
|
+
module V1
|
43
|
+
Session = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.Session").msgclass
|
44
|
+
Session::Turn = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.Session.Turn").msgclass
|
45
|
+
Session::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.Session.State").enummodule
|
46
|
+
Query = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.Query").msgclass
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -9,7 +9,7 @@ require 'google/api/resource_pb'
|
|
9
9
|
require 'google/protobuf/timestamp_pb'
|
10
10
|
|
11
11
|
|
12
|
-
descriptor_data = "\n8google/cloud/discoveryengine/v1/site_search_engine.proto\x12\x1fgoogle.cloud.discoveryengine.v1\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 = "\n8google/cloud/discoveryengine/v1/site_search_engine.proto\x12\x1fgoogle.cloud.discoveryengine.v1\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\"\x96\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>\n\x04type\x18\x03 \x01(\x0e\x32\x30.google.cloud.discoveryengine.v1.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\x12Z\n\x16site_verification_info\x18\x07 \x01(\x0b\x32\x35.google.cloud.discoveryengine.v1.SiteVerificationInfoB\x03\xe0\x41\x03\x12X\n\x0findexing_status\x18\x08 \x01(\x0e\x32:.google.cloud.discoveryengine.v1.TargetSite.IndexingStatusB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12V\n\x0e\x66\x61ilure_reason\x18\t \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1.TargetSite.FailureReasonB\x03\xe0\x41\x03\x1a\xa9\x01\n\rFailureReason\x12_\n\rquota_failure\x18\x01 \x01(\x0b\x32\x46.google.cloud.discoveryengine.v1.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}\"\xa3\x02\n\x14SiteVerificationInfo\x12l\n\x17site_verification_state\x18\x01 \x01(\x0e\x32K.google.cloud.discoveryengine.v1.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\x88\x02\n#com.google.cloud.discoveryengine.v1B\x15SiteSearchEngineProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\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 = "\n0google/cloud/discoveryengine/v1/user_event.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a,google/cloud/discoveryengine/v1/common.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\
|
14
|
+
descriptor_data = "\n0google/cloud/discoveryengine/v1/user_event.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a,google/cloud/discoveryengine/v1/common.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xba\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.v1.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.v1.PageInfo\x12\x19\n\x11\x61ttribution_token\x18\x08 \x01(\t\x12\x0e\n\x06\x66ilter\x18\t \x01(\t\x12@\n\tdocuments\x18\n \x03(\x0b\x32-.google.cloud.discoveryengine.v1.DocumentInfo\x12\x39\n\x05panel\x18\x0b \x01(\x0b\x32*.google.cloud.discoveryengine.v1.PanelInfo\x12@\n\x0bsearch_info\x18\x0c \x01(\x0b\x32+.google.cloud.discoveryengine.v1.SearchInfo\x12H\n\x0f\x63ompletion_info\x18\r \x01(\x0b\x32/.google.cloud.discoveryengine.v1.CompletionInfo\x12J\n\x10transaction_info\x18\x0e \x01(\x0b\x32\x30.google.cloud.discoveryengine.v1.TransactionInfo\x12\x0f\n\x07tag_ids\x18\x0f \x03(\t\x12\x15\n\rpromotion_ids\x18\x10 \x03(\t\x12N\n\nattributes\x18\x11 \x03(\x0b\x32:.google.cloud.discoveryengine.v1.UserEvent.AttributesEntry\x12>\n\nmedia_info\x18\x12 \x01(\x0b\x32*.google.cloud.discoveryengine.v1.MediaInfo\x1a\x63\n\x0f\x41ttributesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12?\n\x05value\x18\x02 \x01(\x0b\x32\x30.google.cloud.discoveryengine.v1.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\x81\x02\n#com.google.cloud.discoveryengine.v1B\x0eUserEventProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
|
15
15
|
|
16
16
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
17
17
|
|
@@ -14,7 +14,7 @@ require 'google/cloud/discoveryengine/v1/user_event_pb'
|
|
14
14
|
require 'google/longrunning/operations_pb'
|
15
15
|
|
16
16
|
|
17
|
-
descriptor_data = "\n8google/cloud/discoveryengine/v1/user_event_service.proto\x12\x1fgoogle.cloud.discoveryengine.v1\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\x33google/cloud/discoveryengine/v1/import_config.proto\x1a\x30google/cloud/discoveryengine/v1/user_event.proto\x1a#google/longrunning/operations.proto\"\
|
17
|
+
descriptor_data = "\n8google/cloud/discoveryengine/v1/user_event_service.proto\x12\x1fgoogle.cloud.discoveryengine.v1\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\x33google/cloud/discoveryengine/v1/import_config.proto\x1a\x30google/cloud/discoveryengine/v1/user_event.proto\x1a#google/longrunning/operations.proto\"\xc7\x01\n\x15WriteUserEventRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12H\n\nuser_event\x18\x02 \x01(\x0b\x32*.google.cloud.discoveryengine.v1.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\xef\x08\n\x10UserEventService\x12\xf0\x02\n\x0eWriteUserEvent\x12\x36.google.cloud.discoveryengine.v1.WriteUserEventRequest\x1a*.google.cloud.discoveryengine.v1.UserEvent\"\xf9\x01\x82\xd3\xe4\x93\x02\xf2\x01\"A/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:write:\nuser_eventZ]\"O/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write:\nuser_eventZB\"4/v1/{parent=projects/*/locations/*}/userEvents:write:\nuser_event\x12\x86\x02\n\x10\x43ollectUserEvent\x12\x38.google.cloud.discoveryengine.v1.CollectUserEventRequest\x1a\x14.google.api.HttpBody\"\xa1\x01\x82\xd3\xe4\x93\x02\x9a\x01\x12\x43/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:collectZS\x12Q/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect\x12\x8a\x03\n\x10ImportUserEvents\x12\x38.google.cloud.discoveryengine.v1.ImportUserEventsRequest\x1a\x1d.google.longrunning.Operation\"\x9c\x02\xca\x41t\n8google.cloud.discoveryengine.v1.ImportUserEventsResponse\x12\x38google.cloud.discoveryengine.v1.ImportUserEventsMetadata\x82\xd3\xe4\x93\x02\x9e\x01\"B/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:import:\x01*ZU\"P/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import:\x01*\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x88\x02\n#com.google.cloud.discoveryengine.v1B\x15UserEventServiceProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\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::V1::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
|
#
|
@@ -118,6 +118,10 @@ module Google
|
|
118
118
|
# @return [::String]
|
119
119
|
# Optional link to proto reference documentation. Example:
|
120
120
|
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
121
|
+
# @!attribute [rw] rest_reference_documentation_uri
|
122
|
+
# @return [::String]
|
123
|
+
# Optional link to REST reference documentation. Example:
|
124
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rest
|
121
125
|
class Publishing
|
122
126
|
include ::Google::Protobuf::MessageExts
|
123
127
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -0,0 +1,362 @@
|
|
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 V1
|
24
|
+
# Defines an answer.
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# @return [::String]
|
27
|
+
# Immutable. Fully qualified name
|
28
|
+
# `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
|
29
|
+
# @!attribute [rw] state
|
30
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::State]
|
31
|
+
# The state of the answer generation.
|
32
|
+
# @!attribute [rw] answer_text
|
33
|
+
# @return [::String]
|
34
|
+
# The textual answer.
|
35
|
+
# @!attribute [rw] citations
|
36
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Citation>]
|
37
|
+
# Citations.
|
38
|
+
# @!attribute [rw] references
|
39
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference>]
|
40
|
+
# References.
|
41
|
+
# @!attribute [rw] related_questions
|
42
|
+
# @return [::Array<::String>]
|
43
|
+
# Suggested related questions.
|
44
|
+
# @!attribute [rw] steps
|
45
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step>]
|
46
|
+
# Answer generation steps.
|
47
|
+
# @!attribute [rw] query_understanding_info
|
48
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo]
|
49
|
+
# Query understanding information.
|
50
|
+
# @!attribute [rw] answer_skipped_reasons
|
51
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::AnswerSkippedReason>]
|
52
|
+
# Additional answer-skipped reasons. This provides the reason for ignored
|
53
|
+
# cases. If nothing is skipped, this field is not set.
|
54
|
+
# @!attribute [r] create_time
|
55
|
+
# @return [::Google::Protobuf::Timestamp]
|
56
|
+
# Output only. Answer creation timestamp.
|
57
|
+
# @!attribute [r] complete_time
|
58
|
+
# @return [::Google::Protobuf::Timestamp]
|
59
|
+
# Output only. Answer completed timestamp.
|
60
|
+
class Answer
|
61
|
+
include ::Google::Protobuf::MessageExts
|
62
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
63
|
+
|
64
|
+
# Citation info for a segment.
|
65
|
+
# @!attribute [rw] start_index
|
66
|
+
# @return [::Integer]
|
67
|
+
# Index indicates the start of the segment, measured in bytes (UTF-8
|
68
|
+
# unicode).
|
69
|
+
# @!attribute [rw] end_index
|
70
|
+
# @return [::Integer]
|
71
|
+
# End of the attributed segment, exclusive.
|
72
|
+
# @!attribute [rw] sources
|
73
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::CitationSource>]
|
74
|
+
# Citation sources for the attributed segment.
|
75
|
+
class Citation
|
76
|
+
include ::Google::Protobuf::MessageExts
|
77
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
78
|
+
end
|
79
|
+
|
80
|
+
# Citation source.
|
81
|
+
# @!attribute [rw] reference_id
|
82
|
+
# @return [::String]
|
83
|
+
# ID of the citation source.
|
84
|
+
class CitationSource
|
85
|
+
include ::Google::Protobuf::MessageExts
|
86
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
87
|
+
end
|
88
|
+
|
89
|
+
# Reference.
|
90
|
+
# @!attribute [rw] unstructured_document_info
|
91
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::UnstructuredDocumentInfo]
|
92
|
+
# Unstructured document information.
|
93
|
+
# @!attribute [rw] chunk_info
|
94
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo]
|
95
|
+
# Chunk information.
|
96
|
+
class Reference
|
97
|
+
include ::Google::Protobuf::MessageExts
|
98
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
99
|
+
|
100
|
+
# Unstructured document information.
|
101
|
+
# @!attribute [rw] document
|
102
|
+
# @return [::String]
|
103
|
+
# Document resource name.
|
104
|
+
# @!attribute [rw] uri
|
105
|
+
# @return [::String]
|
106
|
+
# URI for the document.
|
107
|
+
# @!attribute [rw] title
|
108
|
+
# @return [::String]
|
109
|
+
# Title.
|
110
|
+
# @!attribute [rw] chunk_contents
|
111
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::UnstructuredDocumentInfo::ChunkContent>]
|
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.
|
117
|
+
class UnstructuredDocumentInfo
|
118
|
+
include ::Google::Protobuf::MessageExts
|
119
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
120
|
+
|
121
|
+
# Chunk content.
|
122
|
+
# @!attribute [rw] content
|
123
|
+
# @return [::String]
|
124
|
+
# Chunk textual content.
|
125
|
+
# @!attribute [rw] page_identifier
|
126
|
+
# @return [::String]
|
127
|
+
# Page identifier.
|
128
|
+
class ChunkContent
|
129
|
+
include ::Google::Protobuf::MessageExts
|
130
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
131
|
+
end
|
132
|
+
end
|
133
|
+
|
134
|
+
# Chunk information.
|
135
|
+
# @!attribute [rw] chunk
|
136
|
+
# @return [::String]
|
137
|
+
# Chunk resource name.
|
138
|
+
# @!attribute [rw] content
|
139
|
+
# @return [::String]
|
140
|
+
# Chunk textual content.
|
141
|
+
# @!attribute [rw] relevance_score
|
142
|
+
# @return [::Float]
|
143
|
+
# Relevance score.
|
144
|
+
# @!attribute [rw] document_metadata
|
145
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo::DocumentMetadata]
|
146
|
+
# Document metadata.
|
147
|
+
class ChunkInfo
|
148
|
+
include ::Google::Protobuf::MessageExts
|
149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
150
|
+
|
151
|
+
# Document metadata.
|
152
|
+
# @!attribute [rw] document
|
153
|
+
# @return [::String]
|
154
|
+
# Document resource name.
|
155
|
+
# @!attribute [rw] uri
|
156
|
+
# @return [::String]
|
157
|
+
# URI for the document.
|
158
|
+
# @!attribute [rw] title
|
159
|
+
# @return [::String]
|
160
|
+
# Title.
|
161
|
+
# @!attribute [rw] page_identifier
|
162
|
+
# @return [::String]
|
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.
|
168
|
+
class DocumentMetadata
|
169
|
+
include ::Google::Protobuf::MessageExts
|
170
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
171
|
+
end
|
172
|
+
end
|
173
|
+
end
|
174
|
+
|
175
|
+
# Step information.
|
176
|
+
# @!attribute [rw] state
|
177
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::State]
|
178
|
+
# The state of the step.
|
179
|
+
# @!attribute [rw] description
|
180
|
+
# @return [::String]
|
181
|
+
# The description of the step.
|
182
|
+
# @!attribute [rw] thought
|
183
|
+
# @return [::String]
|
184
|
+
# The thought of the step.
|
185
|
+
# @!attribute [rw] actions
|
186
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action>]
|
187
|
+
# Actions.
|
188
|
+
class Step
|
189
|
+
include ::Google::Protobuf::MessageExts
|
190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
191
|
+
|
192
|
+
# Action.
|
193
|
+
# @!attribute [rw] search_action
|
194
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::SearchAction]
|
195
|
+
# Search action.
|
196
|
+
# @!attribute [rw] observation
|
197
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation]
|
198
|
+
# Observation.
|
199
|
+
class Action
|
200
|
+
include ::Google::Protobuf::MessageExts
|
201
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
202
|
+
|
203
|
+
# Search action.
|
204
|
+
# @!attribute [rw] query
|
205
|
+
# @return [::String]
|
206
|
+
# The query to search.
|
207
|
+
class SearchAction
|
208
|
+
include ::Google::Protobuf::MessageExts
|
209
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
210
|
+
end
|
211
|
+
|
212
|
+
# Observation.
|
213
|
+
# @!attribute [rw] search_results
|
214
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult>]
|
215
|
+
# Search results observed by the search action, it can be snippets info
|
216
|
+
# or chunk info, depending on the citation type set by the user.
|
217
|
+
class Observation
|
218
|
+
include ::Google::Protobuf::MessageExts
|
219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
220
|
+
|
221
|
+
# @!attribute [rw] document
|
222
|
+
# @return [::String]
|
223
|
+
# Document resource name.
|
224
|
+
# @!attribute [rw] uri
|
225
|
+
# @return [::String]
|
226
|
+
# URI for the document.
|
227
|
+
# @!attribute [rw] title
|
228
|
+
# @return [::String]
|
229
|
+
# Title.
|
230
|
+
# @!attribute [rw] snippet_info
|
231
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult::SnippetInfo>]
|
232
|
+
# If citation_type is DOCUMENT_LEVEL_CITATION, populate document
|
233
|
+
# level snippets.
|
234
|
+
# @!attribute [rw] chunk_info
|
235
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult::ChunkInfo>]
|
236
|
+
# If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
|
237
|
+
# populate chunk info.
|
238
|
+
class SearchResult
|
239
|
+
include ::Google::Protobuf::MessageExts
|
240
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
241
|
+
|
242
|
+
# Snippet information.
|
243
|
+
# @!attribute [rw] snippet
|
244
|
+
# @return [::String]
|
245
|
+
# Snippet content.
|
246
|
+
# @!attribute [rw] snippet_status
|
247
|
+
# @return [::String]
|
248
|
+
# Status of the snippet defined by the search team.
|
249
|
+
class SnippetInfo
|
250
|
+
include ::Google::Protobuf::MessageExts
|
251
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
252
|
+
end
|
253
|
+
|
254
|
+
# Chunk information.
|
255
|
+
# @!attribute [rw] chunk
|
256
|
+
# @return [::String]
|
257
|
+
# Chunk resource name.
|
258
|
+
# @!attribute [rw] content
|
259
|
+
# @return [::String]
|
260
|
+
# Chunk textual content.
|
261
|
+
# @!attribute [rw] relevance_score
|
262
|
+
# @return [::Float]
|
263
|
+
# Relevance score.
|
264
|
+
class ChunkInfo
|
265
|
+
include ::Google::Protobuf::MessageExts
|
266
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
267
|
+
end
|
268
|
+
end
|
269
|
+
end
|
270
|
+
end
|
271
|
+
|
272
|
+
# Enumeration of the state of the step.
|
273
|
+
module State
|
274
|
+
# Unknown.
|
275
|
+
STATE_UNSPECIFIED = 0
|
276
|
+
|
277
|
+
# Step is currently in progress.
|
278
|
+
IN_PROGRESS = 1
|
279
|
+
|
280
|
+
# Step currently failed.
|
281
|
+
FAILED = 2
|
282
|
+
|
283
|
+
# Step has succeeded.
|
284
|
+
SUCCEEDED = 3
|
285
|
+
end
|
286
|
+
end
|
287
|
+
|
288
|
+
# Query understanding information.
|
289
|
+
# @!attribute [rw] query_classification_info
|
290
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo::QueryClassificationInfo>]
|
291
|
+
# Query classification information.
|
292
|
+
class QueryUnderstandingInfo
|
293
|
+
include ::Google::Protobuf::MessageExts
|
294
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
295
|
+
|
296
|
+
# Query classification information.
|
297
|
+
# @!attribute [rw] type
|
298
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::Answer::QueryUnderstandingInfo::QueryClassificationInfo::Type]
|
299
|
+
# Query classification type.
|
300
|
+
# @!attribute [rw] positive
|
301
|
+
# @return [::Boolean]
|
302
|
+
# Classification output.
|
303
|
+
class QueryClassificationInfo
|
304
|
+
include ::Google::Protobuf::MessageExts
|
305
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
306
|
+
|
307
|
+
# Query classification types.
|
308
|
+
module Type
|
309
|
+
# Unspecified query classification type.
|
310
|
+
TYPE_UNSPECIFIED = 0
|
311
|
+
|
312
|
+
# Adversarial query classification type.
|
313
|
+
ADVERSARIAL_QUERY = 1
|
314
|
+
|
315
|
+
# Non-answer-seeking query classification type.
|
316
|
+
NON_ANSWER_SEEKING_QUERY = 2
|
317
|
+
end
|
318
|
+
end
|
319
|
+
end
|
320
|
+
|
321
|
+
# Enumeration of the state of the answer generation.
|
322
|
+
module State
|
323
|
+
# Unknown.
|
324
|
+
STATE_UNSPECIFIED = 0
|
325
|
+
|
326
|
+
# Answer generation is currently in progress.
|
327
|
+
IN_PROGRESS = 1
|
328
|
+
|
329
|
+
# Answer generation currently failed.
|
330
|
+
FAILED = 2
|
331
|
+
|
332
|
+
# Answer generation has succeeded.
|
333
|
+
SUCCEEDED = 3
|
334
|
+
end
|
335
|
+
|
336
|
+
# An enum for answer skipped reasons.
|
337
|
+
module AnswerSkippedReason
|
338
|
+
# Default value. The answer skipped reason is not specified.
|
339
|
+
ANSWER_SKIPPED_REASON_UNSPECIFIED = 0
|
340
|
+
|
341
|
+
# The adversarial query ignored case.
|
342
|
+
ADVERSARIAL_QUERY_IGNORED = 1
|
343
|
+
|
344
|
+
# The non-answer seeking query ignored case.
|
345
|
+
NON_ANSWER_SEEKING_QUERY_IGNORED = 2
|
346
|
+
|
347
|
+
# The out-of-domain query ignored case.
|
348
|
+
#
|
349
|
+
# Google skips the answer if there are no high-relevance search results.
|
350
|
+
OUT_OF_DOMAIN_QUERY_IGNORED = 3
|
351
|
+
|
352
|
+
# The potential policy violation case.
|
353
|
+
#
|
354
|
+
# Google skips the answer if there is a potential policy violation
|
355
|
+
# detected. This includes content that may be violent or toxic.
|
356
|
+
POTENTIAL_POLICY_VIOLATION = 4
|
357
|
+
end
|
358
|
+
end
|
359
|
+
end
|
360
|
+
end
|
361
|
+
end
|
362
|
+
end
|
@@ -113,6 +113,9 @@ module Google
|
|
113
113
|
|
114
114
|
# The media industry vertical.
|
115
115
|
MEDIA = 2
|
116
|
+
|
117
|
+
# The healthcare FHIR vertical.
|
118
|
+
HEALTHCARE_FHIR = 7
|
116
119
|
end
|
117
120
|
|
118
121
|
# The type of solution.
|
@@ -128,10 +131,31 @@ module Google
|
|
128
131
|
|
129
132
|
# Used for use cases related to the Generative AI agent.
|
130
133
|
SOLUTION_TYPE_CHAT = 3
|
134
|
+
|
135
|
+
# Used for use cases related to the Generative Chat agent.
|
136
|
+
# It's used for Generative chat engine only, the associated data stores
|
137
|
+
# must enrolled with `SOLUTION_TYPE_CHAT` solution.
|
138
|
+
SOLUTION_TYPE_GENERATIVE_CHAT = 4
|
139
|
+
end
|
140
|
+
|
141
|
+
# Defines a further subdivision of `SolutionType`.
|
142
|
+
# Specifically applies to
|
143
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
|
144
|
+
module SearchUseCase
|
145
|
+
# Value used when unset. Will not occur in CSS.
|
146
|
+
SEARCH_USE_CASE_UNSPECIFIED = 0
|
147
|
+
|
148
|
+
# Search use case. Expects the traffic has a non-empty
|
149
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#query query}.
|
150
|
+
SEARCH_USE_CASE_SEARCH = 1
|
151
|
+
|
152
|
+
# Browse use case. Expects the traffic has an empty
|
153
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#query query}.
|
154
|
+
SEARCH_USE_CASE_BROWSE = 2
|
131
155
|
end
|
132
156
|
|
133
157
|
# Tiers of search features. Different tiers might have different
|
134
|
-
# pricing. To learn more,
|
158
|
+
# pricing. To learn more, check the pricing documentation.
|
135
159
|
module SearchTier
|
136
160
|
# Default value when the enum is unspecified. This is invalid to use.
|
137
161
|
SEARCH_TIER_UNSPECIFIED = 0
|