google-cloud-discovery_engine-v1beta 0.8.0 → 0.10.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/conversational_search_service/client.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/paths.rb +94 -0
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +1 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +45 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +469 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +801 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/paths.rb +78 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +436 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +1077 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +5 -4
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +5 -4
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest.rb +2 -1
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service.rb +2 -1
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +1 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +48 -0
- data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb +2 -1
- data/proto_docs/google/api/client.rb +4 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +5 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +20 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +7 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +103 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +17 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +126 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +4 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +3 -3
- metadata +18 -116
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
3
|
+
# source: google/cloud/discoveryengine/v1beta/search_tuning_service.proto
|
|
4
|
+
|
|
5
|
+
require 'google/protobuf'
|
|
6
|
+
|
|
7
|
+
require 'google/api/annotations_pb'
|
|
8
|
+
require 'google/api/client_pb'
|
|
9
|
+
require 'google/api/field_behavior_pb'
|
|
10
|
+
require 'google/api/resource_pb'
|
|
11
|
+
require 'google/cloud/discoveryengine/v1beta/import_config_pb'
|
|
12
|
+
require 'google/longrunning/operations_pb'
|
|
13
|
+
require 'google/protobuf/timestamp_pb'
|
|
14
|
+
require 'google/rpc/status_pb'
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
descriptor_data = "\n?google/cloud/discoveryengine/v1beta/search_tuning_service.proto\x12#google.cloud.discoveryengine.v1beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x37google/cloud/discoveryengine/v1beta/import_config.proto\x1a#google/longrunning/operations.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x17google/rpc/status.proto\"\xb8\x03\n\x17TrainCustomModelRequest\x12k\n\x12gcs_training_input\x18\x02 \x01(\x0b\x32M.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInputH\x00\x12\x44\n\ndata_store\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x12\n\nmodel_type\x18\x03 \x01(\t\x12L\n\x0c\x65rror_config\x18\x04 \x01(\x0b\x32\x36.google.cloud.discoveryengine.v1beta.ImportErrorConfig\x1av\n\x10GcsTrainingInput\x12\x18\n\x10\x63orpus_data_path\x18\x01 \x01(\t\x12\x17\n\x0fquery_data_path\x18\x02 \x01(\t\x12\x17\n\x0ftrain_data_path\x18\x03 \x01(\t\x12\x16\n\x0etest_data_path\x18\x04 \x01(\tB\x10\n\x0etraining_input\"\xa9\x01\n\x18TrainCustomModelResponse\x12)\n\rerror_samples\x18\x01 \x03(\x0b\x32\x12.google.rpc.Status\x12L\n\x0c\x65rror_config\x18\x02 \x01(\x0b\x32\x36.google.cloud.discoveryengine.v1beta.ImportErrorConfig\x12\x14\n\x0cmodel_status\x18\x03 \x01(\t\"|\n\x18TrainCustomModelMetadata\x12/\n\x0b\x63reate_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp2\xbf\x03\n\x13SearchTuningService\x12\xd3\x02\n\x10TrainCustomModel\x12<.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest\x1a\x1d.google.longrunning.Operation\"\xe1\x01\xca\x41|\n<google.cloud.discoveryengine.v1beta.TrainCustomModelResponse\x12<google.cloud.discoveryengine.v1beta.TrainCustomModelMetadata\x82\xd3\xe4\x93\x02\\\"W/v1beta/{data_store=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel:\x01*\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x9f\x02\n\'com.google.cloud.discoveryengine.v1betaB\x18SearchTuningServiceProtoP\x01ZQcloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02#Google.Cloud.DiscoveryEngine.V1Beta\xca\x02#Google\\Cloud\\DiscoveryEngine\\V1beta\xea\x02&Google::Cloud::DiscoveryEngine::V1betab\x06proto3"
|
|
18
|
+
|
|
19
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
20
|
+
|
|
21
|
+
begin
|
|
22
|
+
pool.add_serialized_file(descriptor_data)
|
|
23
|
+
rescue TypeError
|
|
24
|
+
# Compatibility code: will be removed in the next major version.
|
|
25
|
+
require 'google/protobuf/descriptor_pb'
|
|
26
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
|
27
|
+
parsed.clear_dependency
|
|
28
|
+
serialized = parsed.class.encode(parsed)
|
|
29
|
+
file = pool.add_serialized_file(serialized)
|
|
30
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
|
31
|
+
imports = [
|
|
32
|
+
["google.cloud.discoveryengine.v1beta.ImportErrorConfig", "google/cloud/discoveryengine/v1beta/import_config.proto"],
|
|
33
|
+
["google.rpc.Status", "google/rpc/status.proto"],
|
|
34
|
+
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
|
35
|
+
]
|
|
36
|
+
imports.each do |type_name, expected_filename|
|
|
37
|
+
import_file = pool.lookup(type_name).file_descriptor
|
|
38
|
+
if import_file.name != expected_filename
|
|
39
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
|
43
|
+
warn "This will become an error in the next major version."
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
module Google
|
|
47
|
+
module Cloud
|
|
48
|
+
module DiscoveryEngine
|
|
49
|
+
module V1beta
|
|
50
|
+
TrainCustomModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.TrainCustomModelRequest").msgclass
|
|
51
|
+
TrainCustomModelRequest::GcsTrainingInput = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput").msgclass
|
|
52
|
+
TrainCustomModelResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.TrainCustomModelResponse").msgclass
|
|
53
|
+
TrainCustomModelMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1beta.TrainCustomModelMetadata").msgclass
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
2
|
+
# Source: google/cloud/discoveryengine/v1beta/search_tuning_service.proto for package 'Google.Cloud.DiscoveryEngine.V1beta'
|
|
3
|
+
# Original file comments:
|
|
4
|
+
# Copyright 2022 Google LLC
|
|
5
|
+
#
|
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
# you may not use this file except in compliance with the License.
|
|
8
|
+
# You may obtain a copy of the License at
|
|
9
|
+
#
|
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
#
|
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
# See the License for the specific language governing permissions and
|
|
16
|
+
# limitations under the License.
|
|
17
|
+
#
|
|
18
|
+
|
|
19
|
+
require 'grpc'
|
|
20
|
+
require 'google/cloud/discoveryengine/v1beta/search_tuning_service_pb'
|
|
21
|
+
|
|
22
|
+
module Google
|
|
23
|
+
module Cloud
|
|
24
|
+
module DiscoveryEngine
|
|
25
|
+
module V1beta
|
|
26
|
+
module SearchTuningService
|
|
27
|
+
# Service for search tuning.
|
|
28
|
+
class Service
|
|
29
|
+
|
|
30
|
+
include ::GRPC::GenericService
|
|
31
|
+
|
|
32
|
+
self.marshal_class_method = :encode
|
|
33
|
+
self.unmarshal_class_method = :decode
|
|
34
|
+
self.service_name = 'google.cloud.discoveryengine.v1beta.SearchTuningService'
|
|
35
|
+
|
|
36
|
+
# Trains a custom model.
|
|
37
|
+
rpc :TrainCustomModel, ::Google::Cloud::DiscoveryEngine::V1beta::TrainCustomModelRequest, ::Google::Longrunning::Operation
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
Stub = Service.rpc_stub_class
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -12,7 +12,7 @@ require 'google/cloud/discoveryengine/v1beta/serving_config_pb'
|
|
|
12
12
|
require 'google/protobuf/field_mask_pb'
|
|
13
13
|
|
|
14
14
|
|
|
15
|
-
descriptor_data = "\n@google/cloud/discoveryengine/v1beta/serving_config_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\x38google/cloud/discoveryengine/v1beta/serving_config.proto\x1a google/protobuf/field_mask.proto\"\x9e\x01\n\x1aUpdateServingConfigRequest\x12O\n\x0eserving_config\x18\x01 \x01(\x0b\x32\x32.google.cloud.discoveryengine.v1beta.ServingConfigB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"]\n\x17GetServingConfigRequest\x12\x42\n\x04name\x18\x01 \x01(\tB4\xe0\x41\x02\xfa\x41.\n,discoveryengine.googleapis.com/ServingConfig\"\
|
|
15
|
+
descriptor_data = "\n@google/cloud/discoveryengine/v1beta/serving_config_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\x38google/cloud/discoveryengine/v1beta/serving_config.proto\x1a google/protobuf/field_mask.proto\"\x9e\x01\n\x1aUpdateServingConfigRequest\x12O\n\x0eserving_config\x18\x01 \x01(\x0b\x32\x32.google.cloud.discoveryengine.v1beta.ServingConfigB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"]\n\x17GetServingConfigRequest\x12\x42\n\x04name\x18\x01 \x01(\tB4\xe0\x41\x02\xfa\x41.\n,discoveryengine.googleapis.com/ServingConfig\"\x92\x01\n\x19ListServingConfigsRequest\x12\x44\n\x06parent\x18\x01 \x01(\tB4\xe0\x41\x02\xfa\x41.\x12,discoveryengine.googleapis.com/ServingConfig\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\"\x82\x01\n\x1aListServingConfigsResponse\x12K\n\x0fserving_configs\x18\x01 \x03(\x0b\x32\x32.google.cloud.discoveryengine.v1beta.ServingConfig\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t2\x82\x0b\n\x14ServingConfigService\x12\xfa\x03\n\x13UpdateServingConfig\x12?.google.cloud.discoveryengine.v1beta.UpdateServingConfigRequest\x1a\x32.google.cloud.discoveryengine.v1beta.ServingConfig\"\xed\x02\xda\x41\x1aserving_config,update_mask\x82\xd3\xe4\x93\x02\xc9\x02\x32R/v1beta/{serving_config.name=projects/*/locations/*/dataStores/*/servingConfigs/*}:\x0eserving_configZr2`/v1beta/{serving_config.name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:\x0eserving_configZo2]/v1beta/{serving_config.name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:\x0eserving_config\x12\x81\x03\n\x10GetServingConfig\x12<.google.cloud.discoveryengine.v1beta.GetServingConfigRequest\x1a\x32.google.cloud.discoveryengine.v1beta.ServingConfig\"\xfa\x01\xda\x41\x04name\x82\xd3\xe4\x93\x02\xec\x01\x12\x43/v1beta/{name=projects/*/locations/*/dataStores/*/servingConfigs/*}ZS\x12Q/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}ZP\x12N/v1beta/{name=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}\x12\x94\x03\n\x12ListServingConfigs\x12>.google.cloud.discoveryengine.v1beta.ListServingConfigsRequest\x1a?.google.cloud.discoveryengine.v1beta.ListServingConfigsResponse\"\xfc\x01\xda\x41\x06parent\x82\xd3\xe4\x93\x02\xec\x01\x12\x43/v1beta/{parent=projects/*/locations/*/dataStores/*}/servingConfigsZS\x12Q/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/servingConfigsZP\x12N/v1beta/{parent=projects/*/locations/*/collections/*/engines/*}/servingConfigs\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xa0\x02\n\'com.google.cloud.discoveryengine.v1betaB\x19ServingConfigServiceProtoP\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"
|
|
16
16
|
|
|
17
17
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
18
18
|
|
|
@@ -24,7 +24,8 @@ module Google
|
|
|
24
24
|
module DiscoveryEngine
|
|
25
25
|
module V1beta
|
|
26
26
|
module ServingConfigService
|
|
27
|
-
# Service for
|
|
27
|
+
# Service for operations related to
|
|
28
|
+
# [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig].
|
|
28
29
|
class Service
|
|
29
30
|
|
|
30
31
|
include ::GRPC::GenericService
|
|
@@ -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
|
|
@@ -88,6 +88,11 @@ module Google
|
|
|
88
88
|
# For more information about filtering including syntax and filter
|
|
89
89
|
# operators, see
|
|
90
90
|
# [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
|
91
|
+
# @!attribute [rw] boost_spec
|
|
92
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec]
|
|
93
|
+
# Boost specification to boost certain documents in search results which may
|
|
94
|
+
# affect the converse response. For more information on boosting, see
|
|
95
|
+
# [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
91
96
|
class ConverseConversationRequest
|
|
92
97
|
include ::Google::Protobuf::MessageExts
|
|
93
98
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -61,6 +61,26 @@ module Google
|
|
|
61
61
|
# @return [::Google::Protobuf::Timestamp]
|
|
62
62
|
# Output only. Timestamp the
|
|
63
63
|
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} was created at.
|
|
64
|
+
# @!attribute [rw] document_processing_config
|
|
65
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig]
|
|
66
|
+
# Configuration for Document understanding and enrichment.
|
|
67
|
+
# @!attribute [rw] starting_schema
|
|
68
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Schema]
|
|
69
|
+
# The start schema to use for this
|
|
70
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} when
|
|
71
|
+
# provisioning it. If unset, a default vertical specialized schema will be
|
|
72
|
+
# used.
|
|
73
|
+
#
|
|
74
|
+
# This field is only used by [CreateDataStore][] API, and will be ignored if
|
|
75
|
+
# used in other APIs. This field will be omitted from all API responses
|
|
76
|
+
# including [CreateDataStore][] API. To retrieve a schema of a
|
|
77
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, use
|
|
78
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client#get_schema SchemaService.GetSchema}
|
|
79
|
+
# API instead.
|
|
80
|
+
#
|
|
81
|
+
# The provided schema will be validated against certain rules on schema.
|
|
82
|
+
# Learn more from [this
|
|
83
|
+
# doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
|
64
84
|
class DataStore
|
|
65
85
|
include ::Google::Protobuf::MessageExts
|
|
66
86
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -66,6 +66,13 @@ module Google
|
|
|
66
66
|
# @return [::Google::Protobuf::Struct]
|
|
67
67
|
# Output only. This field is OUTPUT_ONLY.
|
|
68
68
|
# It contains derived data that are not in the original input document.
|
|
69
|
+
# @!attribute [r] index_time
|
|
70
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
71
|
+
# Output only. The last time the document was indexed. If this field is set,
|
|
72
|
+
# the document could be returned in search results.
|
|
73
|
+
#
|
|
74
|
+
# This field is OUTPUT_ONLY. If this field is not populated, it means the
|
|
75
|
+
# document has never been indexed.
|
|
69
76
|
class Document
|
|
70
77
|
include ::Google::Protobuf::MessageExts
|
|
71
78
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2024 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
module DiscoveryEngine
|
|
23
|
+
module V1beta
|
|
24
|
+
# A singleton resource of
|
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}. It's empty when
|
|
26
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is created, which
|
|
27
|
+
# defaults to digital parser. The first call to
|
|
28
|
+
# [DataStoreService.UpdateDocumentProcessingConfig][] method will initialize
|
|
29
|
+
# the config.
|
|
30
|
+
# @!attribute [rw] name
|
|
31
|
+
# @return [::String]
|
|
32
|
+
# The full resource name of the Document Processing Config.
|
|
33
|
+
# Format:
|
|
34
|
+
# `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
|
|
35
|
+
# @!attribute [rw] default_parsing_config
|
|
36
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig]
|
|
37
|
+
# Configurations for default Document parser.
|
|
38
|
+
# If not specified, we will configure it as default DigitalParsingConfig, and
|
|
39
|
+
# the default parsing config will be applied to all file types for Document
|
|
40
|
+
# parsing.
|
|
41
|
+
# @!attribute [rw] parsing_config_overrides
|
|
42
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig}]
|
|
43
|
+
# Map from file type to override the default parsing configuration based on
|
|
44
|
+
# the file type. Supported keys:
|
|
45
|
+
# * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
|
|
46
|
+
# parsing or layout parsing is supported.
|
|
47
|
+
# * `html`: Override parsing config for HTML files, only digital parsing and
|
|
48
|
+
# or layout parsing are supported.
|
|
49
|
+
# * `docx`: Override parsing config for DOCX files, only digital parsing and
|
|
50
|
+
# or layout parsing are supported.
|
|
51
|
+
class DocumentProcessingConfig
|
|
52
|
+
include ::Google::Protobuf::MessageExts
|
|
53
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
54
|
+
|
|
55
|
+
# Related configurations applied to a specific type of document parser.
|
|
56
|
+
# @!attribute [rw] digital_parsing_config
|
|
57
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig::DigitalParsingConfig]
|
|
58
|
+
# Configurations applied to digital parser.
|
|
59
|
+
# @!attribute [rw] ocr_parsing_config
|
|
60
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig::OcrParsingConfig]
|
|
61
|
+
# Configurations applied to OCR parser. Currently it only applies to
|
|
62
|
+
# PDFs.
|
|
63
|
+
class ParsingConfig
|
|
64
|
+
include ::Google::Protobuf::MessageExts
|
|
65
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
66
|
+
|
|
67
|
+
# The digital parsing configurations for documents.
|
|
68
|
+
class DigitalParsingConfig
|
|
69
|
+
include ::Google::Protobuf::MessageExts
|
|
70
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# The OCR parsing configurations for documents.
|
|
74
|
+
# @!attribute [rw] enhanced_document_elements
|
|
75
|
+
# @return [::Array<::String>]
|
|
76
|
+
# Apply additional enhanced OCR processing to a list of document
|
|
77
|
+
# elements.
|
|
78
|
+
#
|
|
79
|
+
# Supported values:
|
|
80
|
+
# * `table`: advanced table parsing model.
|
|
81
|
+
# @!attribute [rw] use_native_text
|
|
82
|
+
# @return [::Boolean]
|
|
83
|
+
# If true, will use native text instead of OCR text on pages containing
|
|
84
|
+
# native text.
|
|
85
|
+
class OcrParsingConfig
|
|
86
|
+
include ::Google::Protobuf::MessageExts
|
|
87
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# @!attribute [rw] key
|
|
92
|
+
# @return [::String]
|
|
93
|
+
# @!attribute [rw] value
|
|
94
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig]
|
|
95
|
+
class ParsingConfigOverridesEntry
|
|
96
|
+
include ::Google::Protobuf::MessageExts
|
|
97
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
@@ -74,6 +74,9 @@ module Google
|
|
|
74
74
|
# @!attribute [rw] failure_count
|
|
75
75
|
# @return [::Integer]
|
|
76
76
|
# Count of entries that encountered errors while processing.
|
|
77
|
+
# @!attribute [rw] ignored_count
|
|
78
|
+
# @return [::Integer]
|
|
79
|
+
# Count of entries that were ignored as entries were not found.
|
|
77
80
|
class PurgeDocumentsMetadata
|
|
78
81
|
include ::Google::Protobuf::MessageExts
|
|
79
82
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -72,6 +72,9 @@ module Google
|
|
|
72
72
|
# is unset.
|
|
73
73
|
#
|
|
74
74
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
75
|
+
# @!attribute [rw] data_store_specs
|
|
76
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
|
|
77
|
+
# A list of data store specs to apply on a search call.
|
|
75
78
|
# @!attribute [rw] filter
|
|
76
79
|
# @return [::String]
|
|
77
80
|
# The filter syntax consists of an expression language for constructing a
|
|
@@ -245,6 +248,17 @@ module Google
|
|
|
245
248
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
246
249
|
end
|
|
247
250
|
|
|
251
|
+
# A struct to define data stores to filter on in a search call.
|
|
252
|
+
# @!attribute [rw] data_store
|
|
253
|
+
# @return [::String]
|
|
254
|
+
# Required. Full resource name of
|
|
255
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, such as
|
|
256
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
|
|
257
|
+
class DataStoreSpec
|
|
258
|
+
include ::Google::Protobuf::MessageExts
|
|
259
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
260
|
+
end
|
|
261
|
+
|
|
248
262
|
# A facet specification to perform faceted search.
|
|
249
263
|
# @!attribute [rw] facet_key
|
|
250
264
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
|
|
@@ -404,9 +418,8 @@ module Google
|
|
|
404
418
|
# Examples:
|
|
405
419
|
#
|
|
406
420
|
# * To boost documents with document ID "doc_1" or "doc_2", and
|
|
407
|
-
# color
|
|
408
|
-
#
|
|
409
|
-
# * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
|
|
421
|
+
# color "Red" or "Blue":
|
|
422
|
+
# `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
|
|
410
423
|
# @!attribute [rw] boost
|
|
411
424
|
# @return [::Float]
|
|
412
425
|
# Strength of the condition boost, which should be in [-1, 1]. Negative
|
|
@@ -540,7 +553,7 @@ module Google
|
|
|
540
553
|
# of results returned is less than `summaryResultCount`, the summary is
|
|
541
554
|
# generated from all of the results.
|
|
542
555
|
#
|
|
543
|
-
# At most
|
|
556
|
+
# At most 10 results can be used to generate a summary.
|
|
544
557
|
# @!attribute [rw] include_citations
|
|
545
558
|
# @return [::Boolean]
|
|
546
559
|
# Specifies whether to include citations in the summary. The default
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2024 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
module DiscoveryEngine
|
|
23
|
+
module V1beta
|
|
24
|
+
# Request message for
|
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#train_custom_model SearchTuningService.TrainCustomModel}
|
|
26
|
+
# method.
|
|
27
|
+
# @!attribute [rw] gcs_training_input
|
|
28
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::TrainCustomModelRequest::GcsTrainingInput]
|
|
29
|
+
# Cloud Storage training input.
|
|
30
|
+
# @!attribute [rw] data_store
|
|
31
|
+
# @return [::String]
|
|
32
|
+
# Required. The resource name of the Data Store, such as
|
|
33
|
+
# `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
|
|
34
|
+
# This field is used to identify the data store where to train the models.
|
|
35
|
+
# @!attribute [rw] model_type
|
|
36
|
+
# @return [::String]
|
|
37
|
+
# Model to be trained. Supported values are:
|
|
38
|
+
#
|
|
39
|
+
# * **search-tuning**: Fine tuning the search system based on data provided.
|
|
40
|
+
# @!attribute [rw] error_config
|
|
41
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
|
|
42
|
+
# The desired location of errors incurred during the data ingestion and
|
|
43
|
+
# training.
|
|
44
|
+
class TrainCustomModelRequest
|
|
45
|
+
include ::Google::Protobuf::MessageExts
|
|
46
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
47
|
+
|
|
48
|
+
# Cloud Storage training data input.
|
|
49
|
+
# @!attribute [rw] corpus_data_path
|
|
50
|
+
# @return [::String]
|
|
51
|
+
# The Cloud Storage corpus data which could be associated in train data.
|
|
52
|
+
# The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
|
|
53
|
+
# A newline delimited jsonl/ndjson file.
|
|
54
|
+
#
|
|
55
|
+
# For search-tuning model, each line should have the _id, title
|
|
56
|
+
# and text. Example:
|
|
57
|
+
# `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
|
|
58
|
+
# @!attribute [rw] query_data_path
|
|
59
|
+
# @return [::String]
|
|
60
|
+
# The gcs query data which could be associated in train data.
|
|
61
|
+
# The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
|
|
62
|
+
# A newline delimited jsonl/ndjson file.
|
|
63
|
+
#
|
|
64
|
+
# For search-tuning model, each line should have the _id
|
|
65
|
+
# and text. Example: \\{"_id": "query1", "text": "example query"}
|
|
66
|
+
# @!attribute [rw] train_data_path
|
|
67
|
+
# @return [::String]
|
|
68
|
+
# Cloud Storage training data path whose format should be
|
|
69
|
+
# `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
|
|
70
|
+
# format. Each line should have the doc_id and query_id and score (number).
|
|
71
|
+
#
|
|
72
|
+
# For search-tuning model, it should have the query-id corpus-id
|
|
73
|
+
# score as tsv file header. The score should be a number in `[0, inf+)`.
|
|
74
|
+
# The larger the number is, the more relevant the pair is. Example:
|
|
75
|
+
#
|
|
76
|
+
# * `query-id\tcorpus-id\tscore`
|
|
77
|
+
# * `query1\tdoc1\t1`
|
|
78
|
+
# @!attribute [rw] test_data_path
|
|
79
|
+
# @return [::String]
|
|
80
|
+
# Cloud Storage test data. Same format as train_data_path. If not provided,
|
|
81
|
+
# a random 80/20 train/test split will be performed on train_data_path.
|
|
82
|
+
class GcsTrainingInput
|
|
83
|
+
include ::Google::Protobuf::MessageExts
|
|
84
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Response of the
|
|
89
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::TrainCustomModelRequest TrainCustomModelRequest}.
|
|
90
|
+
# This message is returned by the google.longrunning.Operations.response field.
|
|
91
|
+
# @!attribute [rw] error_samples
|
|
92
|
+
# @return [::Array<::Google::Rpc::Status>]
|
|
93
|
+
# A sample of errors encountered while processing the data.
|
|
94
|
+
# @!attribute [rw] error_config
|
|
95
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
|
|
96
|
+
# Echoes the destination for the complete errors in the request if set.
|
|
97
|
+
# @!attribute [rw] model_status
|
|
98
|
+
# @return [::String]
|
|
99
|
+
# The trained model status. Possible values are:
|
|
100
|
+
#
|
|
101
|
+
# * **bad-data**: The training data quality is bad.
|
|
102
|
+
# * **no-improvement**: Tuning didn't improve performance. Won't deploy.
|
|
103
|
+
# * **in-progress**: Model training is in progress.
|
|
104
|
+
# * **ready**: The model is ready for serving.
|
|
105
|
+
class TrainCustomModelResponse
|
|
106
|
+
include ::Google::Protobuf::MessageExts
|
|
107
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Metadata related to the progress of the TrainCustomModel operation. This is
|
|
111
|
+
# returned by the google.longrunning.Operation.metadata field.
|
|
112
|
+
# @!attribute [rw] create_time
|
|
113
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
114
|
+
# Operation create time.
|
|
115
|
+
# @!attribute [rw] update_time
|
|
116
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
117
|
+
# Operation last update time. If the operation is done, this is also the
|
|
118
|
+
# finish time.
|
|
119
|
+
class TrainCustomModelMetadata
|
|
120
|
+
include ::Google::Protobuf::MessageExts
|
|
121
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
122
|
+
end
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
@@ -34,7 +34,7 @@ module Google
|
|
|
34
34
|
# @!attribute [rw] name
|
|
35
35
|
# @return [::String]
|
|
36
36
|
# Immutable. Fully qualified name
|
|
37
|
-
# `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
37
|
+
# `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
|
|
38
38
|
# @!attribute [rw] display_name
|
|
39
39
|
# @return [::String]
|
|
40
40
|
# Required. The human readable serving config display name. Used in Discovery
|
|
@@ -87,8 +87,9 @@ module Google
|
|
|
87
87
|
# The ranking expression controls the customized ranking on retrieval
|
|
88
88
|
# documents. To leverage this, document embedding is required. The ranking
|
|
89
89
|
# expression setting in ServingConfig applies to all search requests served
|
|
90
|
-
# by the serving config. However, if
|
|
91
|
-
#
|
|
90
|
+
# by the serving config. However, if
|
|
91
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#ranking_expression SearchRequest.ranking_expression}
|
|
92
|
+
# is specified, it overrides the ServingConfig ranking expression.
|
|
92
93
|
#
|
|
93
94
|
# The ranking expression is a single function or multiple functions that are
|
|
94
95
|
# joined by "+".
|
|
@@ -43,7 +43,7 @@ module Google
|
|
|
43
43
|
# @!attribute [rw] name
|
|
44
44
|
# @return [::String]
|
|
45
45
|
# Required. The resource name of the ServingConfig to get. Format:
|
|
46
|
-
# `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
46
|
+
# `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
|
|
47
47
|
class GetServingConfigRequest
|
|
48
48
|
include ::Google::Protobuf::MessageExts
|
|
49
49
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -52,8 +52,8 @@ module Google
|
|
|
52
52
|
# Request for ListServingConfigs method.
|
|
53
53
|
# @!attribute [rw] parent
|
|
54
54
|
# @return [::String]
|
|
55
|
-
# Required.
|
|
56
|
-
# `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
55
|
+
# Required. Full resource name of the parent resource. Format:
|
|
56
|
+
# `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
|
|
57
57
|
# @!attribute [rw] page_size
|
|
58
58
|
# @return [::Integer]
|
|
59
59
|
# Optional. Maximum number of results to return. If unspecified, defaults
|