google-cloud-discovery_engine-v1beta 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +24 -1
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +30 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +45 -2
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +135 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +24 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +10 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +144 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +75 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -1
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +30 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +24 -1
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +10 -1
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +119 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +75 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +54 -2
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +64 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +24 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +10 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +69 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +75 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +2 -2
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +9 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +4 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +34 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +136 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +4 -0
- metadata +25 -5
|
@@ -14,7 +14,7 @@ require 'google/protobuf/empty_pb'
|
|
|
14
14
|
require 'google/protobuf/field_mask_pb'
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
descriptor_data = "\nGgoogle/cloud/discoveryengine/v1beta/conversational_search_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\x36google/cloud/discoveryengine/v1beta/conversation.proto\x1a\x38google/cloud/discoveryengine/v1beta/search_service.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"\
|
|
17
|
+
descriptor_data = "\nGgoogle/cloud/discoveryengine/v1beta/conversational_search_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\x36google/cloud/discoveryengine/v1beta/conversation.proto\x1a\x38google/cloud/discoveryengine/v1beta/search_service.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"\xcf\x04\n\x1b\x43onverseConversationRequest\x12\x41\n\x04name\x18\x01 \x01(\tB3\xe0\x41\x02\xfa\x41-\n+discoveryengine.googleapis.com/Conversation\x12\x42\n\x05query\x18\x02 \x01(\x0b\x32..google.cloud.discoveryengine.v1beta.TextInputB\x03\xe0\x41\x02\x12I\n\x0eserving_config\x18\x03 \x01(\tB1\xfa\x41.\n,discoveryengine.googleapis.com/ServingConfig\x12G\n\x0c\x63onversation\x18\x05 \x01(\x0b\x32\x31.google.cloud.discoveryengine.v1beta.Conversation\x12\x13\n\x0bsafe_search\x18\x06 \x01(\x08\x12\x65\n\x0buser_labels\x18\x07 \x03(\x0b\x32P.google.cloud.discoveryengine.v1beta.ConverseConversationRequest.UserLabelsEntry\x12\x66\n\x0csummary_spec\x18\x08 \x01(\x0b\x32P.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec\x1a\x31\n\x0fUserLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"\x97\x02\n\x1c\x43onverseConversationResponse\x12\x39\n\x05reply\x18\x01 \x01(\x0b\x32*.google.cloud.discoveryengine.v1beta.Reply\x12G\n\x0c\x63onversation\x18\x02 \x01(\x0b\x32\x31.google.cloud.discoveryengine.v1beta.Conversation\x12\x19\n\x11related_questions\x18\x06 \x03(\t\x12X\n\x0esearch_results\x18\x03 \x03(\x0b\x32@.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult\"\xab\x01\n\x19\x43reateConversationRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12L\n\x0c\x63onversation\x18\x02 \x01(\x0b\x32\x31.google.cloud.discoveryengine.v1beta.ConversationB\x03\xe0\x41\x02\"\x9a\x01\n\x19UpdateConversationRequest\x12L\n\x0c\x63onversation\x18\x01 \x01(\x0b\x32\x31.google.cloud.discoveryengine.v1beta.ConversationB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"^\n\x19\x44\x65leteConversationRequest\x12\x41\n\x04name\x18\x01 \x01(\tB3\xe0\x41\x02\xfa\x41-\n+discoveryengine.googleapis.com/Conversation\"[\n\x16GetConversationRequest\x12\x41\n\x04name\x18\x01 \x01(\tB3\xe0\x41\x02\xfa\x41-\n+discoveryengine.googleapis.com/Conversation\"\xa5\x01\n\x18ListConversationsRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x11\n\tpage_size\x18\x02 \x01(\x05\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x04 \x01(\t\x12\x10\n\x08order_by\x18\x05 \x01(\t\"~\n\x19ListConversationsResponse\x12H\n\rconversations\x18\x01 \x03(\x0b\x32\x31.google.cloud.discoveryengine.v1beta.Conversation\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t2\xb6\x10\n\x1b\x43onversationalSearchService\x12\xe2\x02\n\x14\x43onverseConversation\x12@.google.cloud.discoveryengine.v1beta.ConverseConversationRequest\x1a\x41.google.cloud.discoveryengine.v1beta.ConverseConversationResponse\"\xc4\x01\x82\xd3\xe4\x93\x02\xb0\x01\"K/v1beta/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse:\x01*Z^\"Y/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse:\x01*\xda\x41\nname,query\x12\xdb\x02\n\x12\x43reateConversation\x12>.google.cloud.discoveryengine.v1beta.CreateConversationRequest\x1a\x31.google.cloud.discoveryengine.v1beta.Conversation\"\xd1\x01\x82\xd3\xe4\x93\x02\xb4\x01\"B/v1beta/{parent=projects/*/locations/*/dataStores/*}/conversations:\x0c\x63onversationZ`\"P/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations:\x0c\x63onversation\xda\x41\x13parent,conversation\x12\x95\x02\n\x12\x44\x65leteConversation\x12>.google.cloud.discoveryengine.v1beta.DeleteConversationRequest\x1a\x16.google.protobuf.Empty\"\xa6\x01\x82\xd3\xe4\x93\x02\x98\x01*B/v1beta/{name=projects/*/locations/*/dataStores/*/conversations/*}ZR*P/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}\xda\x41\x04name\x12\xfa\x02\n\x12UpdateConversation\x12>.google.cloud.discoveryengine.v1beta.UpdateConversationRequest\x1a\x31.google.cloud.discoveryengine.v1beta.Conversation\"\xf0\x01\x82\xd3\xe4\x93\x02\xce\x01\x32O/v1beta/{conversation.name=projects/*/locations/*/dataStores/*/conversations/*}:\x0c\x63onversationZm2]/v1beta/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:\x0c\x63onversation\xda\x41\x18\x63onversation,update_mask\x12\xaa\x02\n\x0fGetConversation\x12;.google.cloud.discoveryengine.v1beta.GetConversationRequest\x1a\x31.google.cloud.discoveryengine.v1beta.Conversation\"\xa6\x01\x82\xd3\xe4\x93\x02\x98\x01\x12\x42/v1beta/{name=projects/*/locations/*/dataStores/*/conversations/*}ZR\x12P/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}\xda\x41\x04name\x12\xbd\x02\n\x11ListConversations\x12=.google.cloud.discoveryengine.v1beta.ListConversationsRequest\x1a>.google.cloud.discoveryengine.v1beta.ListConversationsResponse\"\xa8\x01\x82\xd3\xe4\x93\x02\x98\x01\x12\x42/v1beta/{parent=projects/*/locations/*/dataStores/*}/conversationsZR\x12P/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations\xda\x41\x06parent\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xa7\x02\n\'com.google.cloud.discoveryengine.v1betaB ConversationalSearchServiceProtoP\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
|
|
|
@@ -30,7 +30,7 @@ rescue TypeError => e
|
|
|
30
30
|
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
|
31
31
|
imports = [
|
|
32
32
|
["google.cloud.discoveryengine.v1beta.TextInput", "google/cloud/discoveryengine/v1beta/conversation.proto"],
|
|
33
|
-
["google.cloud.discoveryengine.v1beta.
|
|
33
|
+
["google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec", "google/cloud/discoveryengine/v1beta/search_service.proto"],
|
|
34
34
|
["google.protobuf.FieldMask", "google/protobuf/field_mask.proto"],
|
|
35
35
|
]
|
|
36
36
|
imports.each do |type_name, expected_filename|
|
|
@@ -13,7 +13,7 @@ require 'google/cloud/discoveryengine/v1beta/document_pb'
|
|
|
13
13
|
require 'google/protobuf/struct_pb'
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
descriptor_data = "\n8google/cloud/discoveryengine/v1beta/search_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\x30google/cloud/discoveryengine/v1beta/common.proto\x1a\x32google/cloud/discoveryengine/v1beta/document.proto\x1a\x1cgoogle/protobuf/struct.proto\"\
|
|
16
|
+
descriptor_data = "\n8google/cloud/discoveryengine/v1beta/search_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\x30google/cloud/discoveryengine/v1beta/common.proto\x1a\x32google/cloud/discoveryengine/v1beta/document.proto\x1a\x1cgoogle/protobuf/struct.proto\"\x96\x1a\n\rSearchRequest\x12L\n\x0eserving_config\x18\x01 \x01(\tB4\xe0\x41\x02\xfa\x41.\n,discoveryengine.googleapis.com/ServingConfig\x12:\n\x06\x62ranch\x18\x02 \x01(\tB*\xfa\x41\'\n%discoveryengine.googleapis.com/Branch\x12\r\n\x05query\x18\x03 \x01(\t\x12R\n\x0bimage_query\x18\x13 \x01(\x0b\x32=.google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12\x0e\n\x06\x66ilter\x18\x07 \x01(\t\x12\x10\n\x08order_by\x18\x08 \x01(\t\x12@\n\tuser_info\x18\x15 \x01(\x0b\x32-.google.cloud.discoveryengine.v1beta.UserInfo\x12Q\n\x0b\x66\x61\x63\x65t_specs\x18\t \x03(\x0b\x32<.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec\x12P\n\nboost_spec\x18\n \x01(\x0b\x32<.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec\x12N\n\x06params\x18\x0b \x03(\x0b\x32>.google.cloud.discoveryengine.v1beta.SearchRequest.ParamsEntry\x12\x63\n\x14query_expansion_spec\x18\r \x01(\x0b\x32\x45.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec\x12\x65\n\x15spell_correction_spec\x18\x0e \x01(\x0b\x32\x46.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec\x12\x16\n\x0euser_pseudo_id\x18\x0f \x01(\t\x12\x61\n\x13\x63ontent_search_spec\x18\x18 \x01(\x0b\x32\x44.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec\x12X\n\x0e\x65mbedding_spec\x18\x17 \x01(\x0b\x32@.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec\x12\x1a\n\x12ranking_expression\x18\x1a \x01(\t\x12\x13\n\x0bsafe_search\x18\x14 \x01(\x08\x12W\n\x0buser_labels\x18\x16 \x03(\x0b\x32\x42.google.cloud.discoveryengine.v1beta.SearchRequest.UserLabelsEntry\x1a,\n\nImageQuery\x12\x15\n\x0bimage_bytes\x18\x01 \x01(\tH\x00\x42\x07\n\x05image\x1a\x84\x03\n\tFacetSpec\x12]\n\tfacet_key\x18\x01 \x01(\x0b\x32\x45.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKeyB\x03\xe0\x41\x02\x12\r\n\x05limit\x18\x02 \x01(\x05\x12\x1c\n\x14\x65xcluded_filter_keys\x18\x03 \x03(\t\x12\x1f\n\x17\x65nable_dynamic_position\x18\x04 \x01(\x08\x1a\xc9\x01\n\x08\x46\x61\x63\x65tKey\x12\x10\n\x03key\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12@\n\tintervals\x18\x02 \x03(\x0b\x32-.google.cloud.discoveryengine.v1beta.Interval\x12\x19\n\x11restricted_values\x18\x03 \x03(\t\x12\x10\n\x08prefixes\x18\x04 \x03(\t\x12\x10\n\x08\x63ontains\x18\x05 \x03(\t\x12\x18\n\x10\x63\x61se_insensitive\x18\x06 \x01(\x08\x12\x10\n\x08order_by\x18\x07 \x01(\t\x1a\xb3\x01\n\tBoostSpec\x12n\n\x15\x63ondition_boost_specs\x18\x01 \x03(\x0b\x32O.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec.ConditionBoostSpec\x1a\x36\n\x12\x43onditionBoostSpec\x12\x11\n\tcondition\x18\x01 \x01(\t\x12\r\n\x05\x62oost\x18\x02 \x01(\x02\x1a\xd8\x01\n\x12QueryExpansionSpec\x12\x62\n\tcondition\x18\x01 \x01(\x0e\x32O.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.Condition\x12\x1e\n\x16pin_unexpanded_results\x18\x02 \x01(\x08\">\n\tCondition\x12\x19\n\x15\x43ONDITION_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x08\n\x04\x41UTO\x10\x02\x1a\xad\x01\n\x13SpellCorrectionSpec\x12Y\n\x04mode\x18\x01 \x01(\x0e\x32K.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode\";\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x13\n\x0fSUGGESTION_ONLY\x10\x01\x12\x08\n\x04\x41UTO\x10\x02\x1a\xb6\x06\n\x11\x43ontentSearchSpec\x12\x66\n\x0csnippet_spec\x18\x01 \x01(\x0b\x32P.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec\x12\x66\n\x0csummary_spec\x18\x02 \x01(\x0b\x32P.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec\x12{\n\x17\x65xtractive_content_spec\x18\x03 \x01(\x0b\x32Z.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec\x1a`\n\x0bSnippetSpec\x12\x1d\n\x11max_snippet_count\x18\x01 \x01(\x05\x42\x02\x18\x01\x12\x1a\n\x0ereference_only\x18\x02 \x01(\x08\x42\x02\x18\x01\x12\x16\n\x0ereturn_snippet\x18\x03 \x01(\x08\x1a\xa9\x01\n\x0bSummarySpec\x12\x1c\n\x14summary_result_count\x18\x01 \x01(\x05\x12\x19\n\x11include_citations\x18\x02 \x01(\x08\x12 \n\x18ignore_adversarial_query\x18\x03 \x01(\x08\x12(\n ignore_non_summary_seeking_query\x18\x04 \x01(\x08\x12\x15\n\rlanguage_code\x18\x06 \x01(\t\x1a\xc5\x01\n\x15\x45xtractiveContentSpec\x12#\n\x1bmax_extractive_answer_count\x18\x01 \x01(\x05\x12$\n\x1cmax_extractive_segment_count\x18\x02 \x01(\x05\x12\'\n\x1freturn_extractive_segment_score\x18\x03 \x01(\x08\x12\x1d\n\x15num_previous_segments\x18\x04 \x01(\x05\x12\x19\n\x11num_next_segments\x18\x05 \x01(\x05\x1a\xb3\x01\n\rEmbeddingSpec\x12k\n\x11\x65mbedding_vectors\x18\x01 \x03(\x0b\x32P.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector\x1a\x35\n\x0f\x45mbeddingVector\x12\x12\n\nfield_path\x18\x01 \x01(\t\x12\x0e\n\x06vector\x18\x02 \x03(\x02\x1a\x45\n\x0bParamsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12%\n\x05value\x18\x02 \x01(\x0b\x32\x16.google.protobuf.Value:\x02\x38\x01\x1a\x31\n\x0fUserLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"\xe3\x0f\n\x0eSearchResponse\x12Q\n\x07results\x18\x01 \x03(\x0b\x32@.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult\x12I\n\x06\x66\x61\x63\x65ts\x18\x02 \x03(\x0b\x32\x39.google.cloud.discoveryengine.v1beta.SearchResponse.Facet\x12\x64\n\x14guided_search_result\x18\x08 \x01(\x0b\x32\x46.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult\x12\x12\n\ntotal_size\x18\x03 \x01(\x05\x12\x19\n\x11\x61ttribution_token\x18\x04 \x01(\t\x12\x14\n\x0credirect_uri\x18\x0c \x01(\t\x12\x17\n\x0fnext_page_token\x18\x05 \x01(\t\x12\x17\n\x0f\x63orrected_query\x18\x07 \x01(\t\x12L\n\x07summary\x18\t \x01(\x0b\x32;.google.cloud.discoveryengine.v1beta.SearchResponse.Summary\x12\x18\n\x10\x61pplied_controls\x18\n \x03(\t\x12\x64\n\x14query_expansion_info\x18\x0e \x01(\x0b\x32\x46.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo\x1a\xa9\x02\n\x0cSearchResult\x12\n\n\x02id\x18\x01 \x01(\t\x12?\n\x08\x64ocument\x18\x02 \x01(\x0b\x32-.google.cloud.discoveryengine.v1beta.Document\x12g\n\x0cmodel_scores\x18\x04 \x03(\x0b\x32Q.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.ModelScoresEntry\x1a\x63\n\x10ModelScoresEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12>\n\x05value\x18\x02 \x01(\x0b\x32/.google.cloud.discoveryengine.v1beta.DoubleList:\x02\x38\x01\x1a\x81\x02\n\x05\x46\x61\x63\x65t\x12\x0b\n\x03key\x18\x01 \x01(\t\x12T\n\x06values\x18\x02 \x03(\x0b\x32\x44.google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue\x12\x15\n\rdynamic_facet\x18\x03 \x01(\x08\x1a~\n\nFacetValue\x12\x0f\n\x05value\x18\x01 \x01(\tH\x00\x12\x41\n\x08interval\x18\x02 \x01(\x0b\x32-.google.cloud.discoveryengine.v1beta.IntervalH\x00\x12\r\n\x05\x63ount\x18\x03 \x01(\x03\x42\r\n\x0b\x66\x61\x63\x65t_value\x1a\xf3\x01\n\x12GuidedSearchResult\x12y\n\x15refinement_attributes\x18\x01 \x03(\x0b\x32Z.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute\x12\x1b\n\x13\x66ollow_up_questions\x18\x02 \x03(\t\x1a\x45\n\x13RefinementAttribute\x12\x15\n\rattribute_key\x18\x01 \x01(\t\x12\x17\n\x0f\x61ttribute_value\x18\x02 \x01(\t\x1a\x96\x04\n\x07Summary\x12\x14\n\x0csummary_text\x18\x01 \x01(\t\x12q\n\x17summary_skipped_reasons\x18\x02 \x03(\x0e\x32P.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason\x12g\n\x11safety_attributes\x18\x03 \x01(\x0b\x32L.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes\x1a\x36\n\x10SafetyAttributes\x12\x12\n\ncategories\x18\x01 \x03(\t\x12\x0e\n\x06scores\x18\x02 \x03(\x02\"\xe0\x01\n\x14SummarySkippedReason\x12&\n\"SUMMARY_SKIPPED_REASON_UNSPECIFIED\x10\x00\x12\x1d\n\x19\x41\x44VERSARIAL_QUERY_IGNORED\x10\x01\x12%\n!NON_SUMMARY_SEEKING_QUERY_IGNORED\x10\x02\x12\x1f\n\x1bOUT_OF_DOMAIN_QUERY_IGNORED\x10\x03\x12\x1e\n\x1aPOTENTIAL_POLICY_VIOLATION\x10\x04\x12\x19\n\x15LLM_ADDON_NOT_ENABLED\x10\x05\x1aI\n\x12QueryExpansionInfo\x12\x16\n\x0e\x65xpanded_query\x18\x01 \x01(\x08\x12\x1b\n\x13pinned_result_count\x18\x02 \x01(\x03\x32\xa3\x03\n\rSearchService\x12\xbd\x02\n\x06Search\x12\x32.google.cloud.discoveryengine.v1beta.SearchRequest\x1a\x33.google.cloud.discoveryengine.v1beta.SearchResponse\"\xc9\x01\x82\xd3\xe4\x93\x02\xc2\x01\"T/v1beta/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:search:\x01*Zg\"b/v1beta/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search:\x01*\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x99\x02\n\'com.google.cloud.discoveryengine.v1betaB\x12SearchServiceProtoP\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"
|
|
17
17
|
|
|
18
18
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
19
19
|
|
|
@@ -60,6 +60,8 @@ module Google
|
|
|
60
60
|
SearchRequest::ContentSearchSpec::SnippetSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec").msgclass
|
|
61
61
|
SearchRequest::ContentSearchSpec::SummarySpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec").msgclass
|
|
62
62
|
SearchRequest::ContentSearchSpec::ExtractiveContentSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec").msgclass
|
|
63
|
+
SearchRequest::EmbeddingSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec").msgclass
|
|
64
|
+
SearchRequest::EmbeddingSpec::EmbeddingVector = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector").msgclass
|
|
63
65
|
SearchResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse").msgclass
|
|
64
66
|
SearchResponse::SearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult").msgclass
|
|
65
67
|
SearchResponse::Facet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.Facet").msgclass
|
|
@@ -67,7 +69,9 @@ module Google
|
|
|
67
69
|
SearchResponse::GuidedSearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult").msgclass
|
|
68
70
|
SearchResponse::GuidedSearchResult::RefinementAttribute = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult.RefinementAttribute").msgclass
|
|
69
71
|
SearchResponse::Summary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.Summary").msgclass
|
|
72
|
+
SearchResponse::Summary::SafetyAttributes = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes").msgclass
|
|
70
73
|
SearchResponse::Summary::SummarySkippedReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason").enummodule
|
|
74
|
+
SearchResponse::QueryExpansionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo").msgclass
|
|
71
75
|
end
|
|
72
76
|
end
|
|
73
77
|
end
|
|
@@ -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\"\xe3\x07\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\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\"\
|
|
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\"\xe3\x07\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\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
|
|
|
@@ -66,6 +66,20 @@ module Google
|
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
|
67
67
|
# non-empty value to expect.
|
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
|
69
|
+
|
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
|
73
|
+
# `name` field on the resource.
|
|
74
|
+
#
|
|
75
|
+
# This behavior should not be applied to references to other resources within
|
|
76
|
+
# the message.
|
|
77
|
+
#
|
|
78
|
+
# The identifier field of resources often have different field behavior
|
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
|
82
|
+
IDENTIFIER = 8
|
|
69
83
|
end
|
|
70
84
|
end
|
|
71
85
|
end
|
|
@@ -100,6 +100,15 @@ module Google
|
|
|
100
100
|
include ::Google::Protobuf::MessageExts
|
|
101
101
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
102
102
|
end
|
|
103
|
+
|
|
104
|
+
# Double list.
|
|
105
|
+
# @!attribute [rw] values
|
|
106
|
+
# @return [::Array<::Float>]
|
|
107
|
+
# Double values.
|
|
108
|
+
class DoubleList
|
|
109
|
+
include ::Google::Protobuf::MessageExts
|
|
110
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
111
|
+
end
|
|
103
112
|
end
|
|
104
113
|
end
|
|
105
114
|
end
|
|
@@ -61,10 +61,14 @@ module Google
|
|
|
61
61
|
# Defines a reply message to user.
|
|
62
62
|
# @!attribute [rw] reply
|
|
63
63
|
# @return [::String]
|
|
64
|
+
# DEPRECATED: use `summary` instead.
|
|
64
65
|
# Text reply.
|
|
65
66
|
# @!attribute [rw] references
|
|
66
67
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Reply::Reference>]
|
|
67
68
|
# References in the reply.
|
|
69
|
+
# @!attribute [rw] summary
|
|
70
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary]
|
|
71
|
+
# Summary based on search results.
|
|
68
72
|
class Reply
|
|
69
73
|
include ::Google::Protobuf::MessageExts
|
|
70
74
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -48,9 +48,40 @@ module Google
|
|
|
48
48
|
# @!attribute [rw] safe_search
|
|
49
49
|
# @return [::Boolean]
|
|
50
50
|
# Whether to turn on safe search.
|
|
51
|
+
# @!attribute [rw] user_labels
|
|
52
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
53
|
+
# The user labels applied to a resource must meet the following requirements:
|
|
54
|
+
#
|
|
55
|
+
# * Each resource can have multiple labels, up to a maximum of 64.
|
|
56
|
+
# * Each label must be a key-value pair.
|
|
57
|
+
# * Keys have a minimum length of 1 character and a maximum length of 63
|
|
58
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
|
59
|
+
# length of 63 characters.
|
|
60
|
+
# * Keys and values can contain only lowercase letters, numeric characters,
|
|
61
|
+
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
|
62
|
+
# international characters are allowed.
|
|
63
|
+
# * The key portion of a label must be unique. However, you can use the same
|
|
64
|
+
# key with multiple resources.
|
|
65
|
+
# * Keys must start with a lowercase letter or international character.
|
|
66
|
+
#
|
|
67
|
+
# See [Google Cloud
|
|
68
|
+
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
|
69
|
+
# for more details.
|
|
70
|
+
# @!attribute [rw] summary_spec
|
|
71
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
|
|
72
|
+
# A specification for configuring the summary returned in the response.
|
|
51
73
|
class ConverseConversationRequest
|
|
52
74
|
include ::Google::Protobuf::MessageExts
|
|
53
75
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
76
|
+
|
|
77
|
+
# @!attribute [rw] key
|
|
78
|
+
# @return [::String]
|
|
79
|
+
# @!attribute [rw] value
|
|
80
|
+
# @return [::String]
|
|
81
|
+
class UserLabelsEntry
|
|
82
|
+
include ::Google::Protobuf::MessageExts
|
|
83
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
84
|
+
end
|
|
54
85
|
end
|
|
55
86
|
|
|
56
87
|
# Response message for
|
|
@@ -62,6 +93,9 @@ module Google
|
|
|
62
93
|
# @!attribute [rw] conversation
|
|
63
94
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
|
|
64
95
|
# Updated conversation including the answer.
|
|
96
|
+
# @!attribute [rw] related_questions
|
|
97
|
+
# @return [::Array<::String>]
|
|
98
|
+
# Suggested related questions.
|
|
65
99
|
# @!attribute [rw] search_results
|
|
66
100
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
|
|
67
101
|
# Search Results.
|
|
@@ -138,6 +138,37 @@ module Google
|
|
|
138
138
|
# @!attribute [rw] content_search_spec
|
|
139
139
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec]
|
|
140
140
|
# A specification for configuring the behavior of content search.
|
|
141
|
+
# @!attribute [rw] embedding_spec
|
|
142
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec]
|
|
143
|
+
# Uses the provided embedding to do additional semantic document retrieval.
|
|
144
|
+
# The retrieval is based on the dot product of
|
|
145
|
+
# [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document
|
|
146
|
+
# embedding that is provided in
|
|
147
|
+
# [SearchRequest.embedding_spec.embedding_vectors.field_path][].
|
|
148
|
+
#
|
|
149
|
+
# If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not
|
|
150
|
+
# provided, it will use [ServingConfig.embedding_config.field_paths][].
|
|
151
|
+
# @!attribute [rw] ranking_expression
|
|
152
|
+
# @return [::String]
|
|
153
|
+
# The ranking expression controls the customized ranking on retrieval
|
|
154
|
+
# documents. This overrides [ServingConfig.ranking_expression][].
|
|
155
|
+
# The ranking expression is a single function or multiple functions that are
|
|
156
|
+
# joint by "+".
|
|
157
|
+
# * ranking_expression = function, { " + ", function };
|
|
158
|
+
# Supported functions:
|
|
159
|
+
# * double * relevance_score
|
|
160
|
+
# * double * dotProduct(embedding_field_path)
|
|
161
|
+
# Function variables:
|
|
162
|
+
# `relevance_score`: pre-defined keywords, used for measure relevance
|
|
163
|
+
# between query and document.
|
|
164
|
+
# `embedding_field_path`: the document embedding field
|
|
165
|
+
# used with query embedding vector.
|
|
166
|
+
# `dotProduct`: embedding function between embedding_field_path and query
|
|
167
|
+
# embedding vector.
|
|
168
|
+
#
|
|
169
|
+
# Example ranking expression:
|
|
170
|
+
# If document has an embedding field doc_embedding, the ranking expression
|
|
171
|
+
# could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
|
141
172
|
# @!attribute [rw] safe_search
|
|
142
173
|
# @return [::Boolean]
|
|
143
174
|
# Whether to turn on safe search. This is only supported for
|
|
@@ -368,6 +399,11 @@ module Google
|
|
|
368
399
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
|
|
369
400
|
# The condition under which query expansion should occur. Default to
|
|
370
401
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
|
|
402
|
+
# @!attribute [rw] pin_unexpanded_results
|
|
403
|
+
# @return [::Boolean]
|
|
404
|
+
# Whether to pin unexpanded results. If this field is set to true,
|
|
405
|
+
# unexpanded products are always at the top of the search results, followed
|
|
406
|
+
# by the expanded results.
|
|
371
407
|
class QueryExpansionSpec
|
|
372
408
|
include ::Google::Protobuf::MessageExts
|
|
373
409
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -508,6 +544,10 @@ module Google
|
|
|
508
544
|
# navigational queries. If this field is set to `true`, we skip
|
|
509
545
|
# generating summaries for non-summary seeking queries and return
|
|
510
546
|
# fallback messages instead.
|
|
547
|
+
# @!attribute [rw] language_code
|
|
548
|
+
# @return [::String]
|
|
549
|
+
# Language code for Summary. Use language tags defined by
|
|
550
|
+
# [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
|
|
511
551
|
class SummarySpec
|
|
512
552
|
include ::Google::Protobuf::MessageExts
|
|
513
553
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -549,15 +589,48 @@ module Google
|
|
|
549
589
|
# If the number of matching segments is less than
|
|
550
590
|
# `max_extractive_segment_count`, return all of the segments. Otherwise,
|
|
551
591
|
# return the `max_extractive_segment_count`.
|
|
552
|
-
#
|
|
553
|
-
#
|
|
554
|
-
#
|
|
592
|
+
# @!attribute [rw] return_extractive_segment_score
|
|
593
|
+
# @return [::Boolean]
|
|
594
|
+
# Specifies whether to return the confidence score from the extractive
|
|
595
|
+
# segments in each search result. The default value is `false`.
|
|
596
|
+
# @!attribute [rw] num_previous_segments
|
|
597
|
+
# @return [::Integer]
|
|
598
|
+
# Specifies whether to also include the adjacent from each selected
|
|
599
|
+
# segments.
|
|
600
|
+
# Return at most `num_previous_segments` segments before each selected
|
|
601
|
+
# segments.
|
|
602
|
+
# @!attribute [rw] num_next_segments
|
|
603
|
+
# @return [::Integer]
|
|
604
|
+
# Return at most `num_next_segments` segments after each selected
|
|
605
|
+
# segments.
|
|
555
606
|
class ExtractiveContentSpec
|
|
556
607
|
include ::Google::Protobuf::MessageExts
|
|
557
608
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
558
609
|
end
|
|
559
610
|
end
|
|
560
611
|
|
|
612
|
+
# The specification that uses customized query embedding vector to do
|
|
613
|
+
# semantic document retrieval.
|
|
614
|
+
# @!attribute [rw] embedding_vectors
|
|
615
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector>]
|
|
616
|
+
# The embedding vector used for retrieval. Limit to 1.
|
|
617
|
+
class EmbeddingSpec
|
|
618
|
+
include ::Google::Protobuf::MessageExts
|
|
619
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
620
|
+
|
|
621
|
+
# Embedding vector.
|
|
622
|
+
# @!attribute [rw] field_path
|
|
623
|
+
# @return [::String]
|
|
624
|
+
# Embedding field path in schema.
|
|
625
|
+
# @!attribute [rw] vector
|
|
626
|
+
# @return [::Array<::Float>]
|
|
627
|
+
# Query embedding vector.
|
|
628
|
+
class EmbeddingVector
|
|
629
|
+
include ::Google::Protobuf::MessageExts
|
|
630
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
631
|
+
end
|
|
632
|
+
end
|
|
633
|
+
|
|
561
634
|
# @!attribute [rw] key
|
|
562
635
|
# @return [::String]
|
|
563
636
|
# @!attribute [rw] value
|
|
@@ -631,6 +704,9 @@ module Google
|
|
|
631
704
|
# @!attribute [rw] applied_controls
|
|
632
705
|
# @return [::Array<::String>]
|
|
633
706
|
# Controls applied as part of the Control service.
|
|
707
|
+
# @!attribute [rw] query_expansion_info
|
|
708
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo]
|
|
709
|
+
# Query expansion information for the returned results.
|
|
634
710
|
class SearchResponse
|
|
635
711
|
include ::Google::Protobuf::MessageExts
|
|
636
712
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -644,9 +720,21 @@ module Google
|
|
|
644
720
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
|
|
645
721
|
# The document data snippet in the search response. Only fields that are
|
|
646
722
|
# marked as retrievable are populated.
|
|
723
|
+
# @!attribute [rw] model_scores
|
|
724
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
|
|
725
|
+
# Google provided available scores.
|
|
647
726
|
class SearchResult
|
|
648
727
|
include ::Google::Protobuf::MessageExts
|
|
649
728
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
729
|
+
|
|
730
|
+
# @!attribute [rw] key
|
|
731
|
+
# @return [::String]
|
|
732
|
+
# @!attribute [rw] value
|
|
733
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
|
|
734
|
+
class ModelScoresEntry
|
|
735
|
+
include ::Google::Protobuf::MessageExts
|
|
736
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
737
|
+
end
|
|
650
738
|
end
|
|
651
739
|
|
|
652
740
|
# A facet result.
|
|
@@ -715,10 +803,28 @@ module Google
|
|
|
715
803
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
|
|
716
804
|
# Additional summary-skipped reasons. This provides the reason for ignored
|
|
717
805
|
# cases. If nothing is skipped, this field is not set.
|
|
806
|
+
# @!attribute [rw] safety_attributes
|
|
807
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
|
|
808
|
+
# A collection of Safety Attribute categories and their associated
|
|
809
|
+
# confidence scores.
|
|
718
810
|
class Summary
|
|
719
811
|
include ::Google::Protobuf::MessageExts
|
|
720
812
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
721
813
|
|
|
814
|
+
# Safety Attribute categories and their associated confidence scores.
|
|
815
|
+
# @!attribute [rw] categories
|
|
816
|
+
# @return [::Array<::String>]
|
|
817
|
+
# The display names of Safety Attribute categories associated with the
|
|
818
|
+
# generated content. Order matches the Scores.
|
|
819
|
+
# @!attribute [rw] scores
|
|
820
|
+
# @return [::Array<::Float>]
|
|
821
|
+
# The confidence scores of the each category, higher
|
|
822
|
+
# value means higher confidence. Order matches the Categories.
|
|
823
|
+
class SafetyAttributes
|
|
824
|
+
include ::Google::Protobuf::MessageExts
|
|
825
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
826
|
+
end
|
|
827
|
+
|
|
722
828
|
# An Enum for summary-skipped reasons.
|
|
723
829
|
module SummarySkippedReason
|
|
724
830
|
# Default value. The summary skipped reason is not specified.
|
|
@@ -744,8 +850,35 @@ module Google
|
|
|
744
850
|
# For example, the data store contains facts about company A but the
|
|
745
851
|
# user query is asking questions about company B.
|
|
746
852
|
OUT_OF_DOMAIN_QUERY_IGNORED = 3
|
|
853
|
+
|
|
854
|
+
# The potential policy violation case.
|
|
855
|
+
#
|
|
856
|
+
# Google skips the summary if there is a potential policy violation
|
|
857
|
+
# detected. This includes content that may be violent or toxic.
|
|
858
|
+
POTENTIAL_POLICY_VIOLATION = 4
|
|
859
|
+
|
|
860
|
+
# The LLM addon not enabled case.
|
|
861
|
+
#
|
|
862
|
+
# Google skips the summary if the LLM addon is not enabled.
|
|
863
|
+
LLM_ADDON_NOT_ENABLED = 5
|
|
747
864
|
end
|
|
748
865
|
end
|
|
866
|
+
|
|
867
|
+
# Information describing query expansion including whether expansion has
|
|
868
|
+
# occurred.
|
|
869
|
+
# @!attribute [rw] expanded_query
|
|
870
|
+
# @return [::Boolean]
|
|
871
|
+
# Bool describing whether query expansion has occurred.
|
|
872
|
+
# @!attribute [rw] pinned_result_count
|
|
873
|
+
# @return [::Integer]
|
|
874
|
+
# Number of pinned results. This field will only be set when expansion
|
|
875
|
+
# happens and
|
|
876
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
|
|
877
|
+
# is set to true.
|
|
878
|
+
class QueryExpansionInfo
|
|
879
|
+
include ::Google::Protobuf::MessageExts
|
|
880
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
881
|
+
end
|
|
749
882
|
end
|
|
750
883
|
end
|
|
751
884
|
end
|
|
@@ -409,6 +409,10 @@ module Google
|
|
|
409
409
|
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} resource
|
|
410
410
|
# full name, of the form:
|
|
411
411
|
# `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
|
|
412
|
+
# @!attribute [rw] uri
|
|
413
|
+
# @return [::String]
|
|
414
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} URI - only
|
|
415
|
+
# allowed for website data stores.
|
|
412
416
|
# @!attribute [rw] quantity
|
|
413
417
|
# @return [::Integer]
|
|
414
418
|
# Quantity of the Document associated with the user event. Defaults to 1.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-discovery_engine-v1beta
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-
|
|
11
|
+
date: 2023-09-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.20.0
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.20.0
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -44,6 +44,26 @@ dependencies:
|
|
|
44
44
|
- - "~>"
|
|
45
45
|
- !ruby/object:Gem::Version
|
|
46
46
|
version: '1.0'
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
name: google-cloud-location
|
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - ">="
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '0.4'
|
|
54
|
+
- - "<"
|
|
55
|
+
- !ruby/object:Gem::Version
|
|
56
|
+
version: 2.a
|
|
57
|
+
type: :runtime
|
|
58
|
+
prerelease: false
|
|
59
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
60
|
+
requirements:
|
|
61
|
+
- - ">="
|
|
62
|
+
- !ruby/object:Gem::Version
|
|
63
|
+
version: '0.4'
|
|
64
|
+
- - "<"
|
|
65
|
+
- !ruby/object:Gem::Version
|
|
66
|
+
version: 2.a
|
|
47
67
|
- !ruby/object:Gem::Dependency
|
|
48
68
|
name: google-style
|
|
49
69
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -297,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
297
317
|
- !ruby/object:Gem::Version
|
|
298
318
|
version: '0'
|
|
299
319
|
requirements: []
|
|
300
|
-
rubygems_version: 3.4.
|
|
320
|
+
rubygems_version: 3.4.19
|
|
301
321
|
signing_key:
|
|
302
322
|
specification_version: 4
|
|
303
323
|
summary: Discovery Engine API.
|