google-cloud-discovery_engine-v1beta 0.9.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +5 -1
  3. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +5 -1
  4. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/paths.rb +94 -0
  5. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +1 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +3 -1
  7. data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +45 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +3 -1
  9. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +469 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/credentials.rb +47 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +801 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/paths.rb +78 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +436 -0
  14. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +1077 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +129 -0
  16. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest.rb +53 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service.rb +56 -0
  18. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +5 -4
  19. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/paths.rb +21 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +5 -4
  21. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest.rb +2 -1
  22. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service.rb +2 -1
  23. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  24. data/lib/google/cloud/discovery_engine/v1beta.rb +1 -0
  25. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
  26. data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +5 -1
  27. data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +3 -1
  28. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +48 -0
  29. data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +1 -1
  30. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +2 -1
  31. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +57 -0
  32. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +45 -0
  33. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb +1 -1
  34. data/lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb +2 -1
  35. data/proto_docs/google/api/client.rb +4 -0
  36. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +5 -0
  37. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +20 -0
  38. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +7 -0
  39. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +103 -0
  40. data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +3 -0
  41. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +17 -4
  42. data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +126 -0
  43. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +4 -3
  44. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +3 -3
  45. metadata +16 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 264b8e56236f1c7da3b853e7a5c7f5af6b3b285d323446e915c8e94a0cc91d59
4
- data.tar.gz: 8aa5f671c5b09fdaed8a509e2f4699d5e01e898f4756995bb78bbeb6e1bbac4d
3
+ metadata.gz: 0f55ebbe529eee9e08ffe2e4d8e7ecfe7b4c9d0cc7fff215ad6df07bed5383ff
4
+ data.tar.gz: 0d83bcea943f452d21b8dafca0c390610e4ca6ad80f6500bb320146b2b117ce2
5
5
  SHA512:
6
- metadata.gz: a518db72057ecea19b2acd7e02b9931a99c03491de4ab13e24f2599e31db71e1c1d88eced04a308fda4744736ca08dfb5cf6d9a326d4669660e00e77f6271f74
7
- data.tar.gz: 60ace3ba75cfff5eb3251f52baf38a201680c189f825765fc540ab9f778d42bf722c86e8c2c8faeac55110e6521c924ad43dbc4e2276535a8e51b9f3ae841397
6
+ metadata.gz: 03da950b2344815bbc7520c9ac3f24ba5a6db5fdbac8baf01f34a8846b3a3ddc24e83016751b1436c4e9b6fd24bf7a5539ca68783e8ebd04f952266304db2f10
7
+ data.tar.gz: 5fd480418e9e7ed49976c7424751fe0dbe88501c8f914c8817386f08658a1dd6df02dc463763468111170310abc6e6d68791c1bf86234e6b4ca4edbd203772a4
@@ -193,7 +193,7 @@ module Google
193
193
  # @param options [::Gapic::CallOptions, ::Hash]
194
194
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
195
195
  #
196
- # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil)
196
+ # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil, boost_spec: nil)
197
197
  # Pass arguments to `converse_conversation` via keyword arguments. Note that at
198
198
  # least one keyword argument is required. To specify no parameters, or to keep all
199
199
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -254,6 +254,10 @@ module Google
254
254
  # For more information about filtering including syntax and filter
255
255
  # operators, see
256
256
  # [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
257
+ # @param boost_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec, ::Hash]
258
+ # Boost specification to boost certain documents in search results which may
259
+ # affect the converse response. For more information on boosting, see
260
+ # [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
257
261
  #
258
262
  # @yield [response, operation] Access the result along with the RPC operation
259
263
  # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse]
@@ -186,7 +186,7 @@ module Google
186
186
  # @param options [::Gapic::CallOptions, ::Hash]
187
187
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
188
188
  #
189
- # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil)
189
+ # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil, boost_spec: nil)
190
190
  # Pass arguments to `converse_conversation` via keyword arguments. Note that at
191
191
  # least one keyword argument is required. To specify no parameters, or to keep all
192
192
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -247,6 +247,10 @@ module Google
247
247
  # For more information about filtering including syntax and filter
248
248
  # operators, see
249
249
  # [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
250
+ # @param boost_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec, ::Hash]
251
+ # Boost specification to boost certain documents in search results which may
252
+ # affect the converse response. For more information on boosting, see
253
+ # [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
250
254
  # @yield [result, operation] Access the result along with the TransportOperation object
251
255
  # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse]
252
256
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -88,6 +88,100 @@ module Google
88
88
  resource.call(**args)
89
89
  end
90
90
 
91
+ ##
92
+ # Create a fully-qualified DocumentProcessingConfig resource string.
93
+ #
94
+ # @overload document_processing_config_path(project:, location:, data_store:)
95
+ # The resource will be in the following format:
96
+ #
97
+ # `projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig`
98
+ #
99
+ # @param project [String]
100
+ # @param location [String]
101
+ # @param data_store [String]
102
+ #
103
+ # @overload document_processing_config_path(project:, location:, collection:, data_store:)
104
+ # The resource will be in the following format:
105
+ #
106
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig`
107
+ #
108
+ # @param project [String]
109
+ # @param location [String]
110
+ # @param collection [String]
111
+ # @param data_store [String]
112
+ #
113
+ # @return [::String]
114
+ def document_processing_config_path **args
115
+ resources = {
116
+ "data_store:location:project" => (proc do |project:, location:, data_store:|
117
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
118
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
119
+
120
+ "projects/#{project}/locations/#{location}/dataStores/#{data_store}/documentProcessingConfig"
121
+ end),
122
+ "collection:data_store:location:project" => (proc do |project:, location:, collection:, data_store:|
123
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
124
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
125
+ raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
126
+
127
+ "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/documentProcessingConfig"
128
+ end)
129
+ }
130
+
131
+ resource = resources[args.keys.sort.join(":")]
132
+ raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
133
+ resource.call(**args)
134
+ end
135
+
136
+ ##
137
+ # Create a fully-qualified Schema resource string.
138
+ #
139
+ # @overload schema_path(project:, location:, data_store:, schema:)
140
+ # The resource will be in the following format:
141
+ #
142
+ # `projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}`
143
+ #
144
+ # @param project [String]
145
+ # @param location [String]
146
+ # @param data_store [String]
147
+ # @param schema [String]
148
+ #
149
+ # @overload schema_path(project:, location:, collection:, data_store:, schema:)
150
+ # The resource will be in the following format:
151
+ #
152
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`
153
+ #
154
+ # @param project [String]
155
+ # @param location [String]
156
+ # @param collection [String]
157
+ # @param data_store [String]
158
+ # @param schema [String]
159
+ #
160
+ # @return [::String]
161
+ def schema_path **args
162
+ resources = {
163
+ "data_store:location:project:schema" => (proc do |project:, location:, data_store:, schema:|
164
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
165
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
166
+ raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
167
+
168
+ "projects/#{project}/locations/#{location}/dataStores/#{data_store}/schemas/#{schema}"
169
+ end),
170
+ "collection:data_store:location:project:schema" => (proc do |project:, location:, collection:, data_store:, schema:|
171
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
172
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
173
+ raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
174
+ raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
175
+
176
+ "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/schemas/#{schema}"
177
+ end)
178
+ }
179
+
180
+ resource = resources[args.keys.sort.join(":")]
181
+ raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
182
+ resource.call(**args)
183
+ end
184
+
91
185
  extend self
92
186
  end
93
187
  end
@@ -24,6 +24,7 @@ require "google/cloud/discovery_engine/v1beta/document_service/rest"
24
24
  require "google/cloud/discovery_engine/v1beta/engine_service/rest"
25
25
  require "google/cloud/discovery_engine/v1beta/recommendation_service/rest"
26
26
  require "google/cloud/discovery_engine/v1beta/schema_service/rest"
27
+ require "google/cloud/discovery_engine/v1beta/search_tuning_service/rest"
27
28
  require "google/cloud/discovery_engine/v1beta/serving_config_service/rest"
28
29
  require "google/cloud/discovery_engine/v1beta/site_search_engine_service/rest"
29
30
  require "google/cloud/discovery_engine/v1beta/user_event_service/rest"
@@ -193,7 +193,7 @@ module Google
193
193
  # @param options [::Gapic::CallOptions, ::Hash]
194
194
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
195
195
  #
196
- # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, safe_search: nil, user_labels: nil)
196
+ # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, safe_search: nil, user_labels: nil)
197
197
  # Pass arguments to `search` via keyword arguments. Note that at
198
198
  # least one keyword argument is required. To specify no parameters, or to keep all
199
199
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -239,6 +239,8 @@ module Google
239
239
  # is unset.
240
240
  #
241
241
  # If this field is negative, an `INVALID_ARGUMENT` is returned.
242
+ # @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec, ::Hash>]
243
+ # A list of data store specs to apply on a search call.
242
244
  # @param filter [::String]
243
245
  # The filter syntax consists of an expression language for constructing a
244
246
  # predicate from one or more fields of the documents being filtered. Filter
@@ -73,6 +73,51 @@ module Google
73
73
  resource.call(**args)
74
74
  end
75
75
 
76
+ ##
77
+ # Create a fully-qualified DataStore resource string.
78
+ #
79
+ # @overload data_store_path(project:, location:, data_store:)
80
+ # The resource will be in the following format:
81
+ #
82
+ # `projects/{project}/locations/{location}/dataStores/{data_store}`
83
+ #
84
+ # @param project [String]
85
+ # @param location [String]
86
+ # @param data_store [String]
87
+ #
88
+ # @overload data_store_path(project:, location:, collection:, data_store:)
89
+ # The resource will be in the following format:
90
+ #
91
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
92
+ #
93
+ # @param project [String]
94
+ # @param location [String]
95
+ # @param collection [String]
96
+ # @param data_store [String]
97
+ #
98
+ # @return [::String]
99
+ def data_store_path **args
100
+ resources = {
101
+ "data_store:location:project" => (proc do |project:, location:, data_store:|
102
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
103
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
104
+
105
+ "projects/#{project}/locations/#{location}/dataStores/#{data_store}"
106
+ end),
107
+ "collection:data_store:location:project" => (proc do |project:, location:, collection:, data_store:|
108
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
109
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
110
+ raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
111
+
112
+ "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}"
113
+ end)
114
+ }
115
+
116
+ resource = resources[args.keys.sort.join(":")]
117
+ raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
118
+ resource.call(**args)
119
+ end
120
+
76
121
  ##
77
122
  # Create a fully-qualified ServingConfig resource string.
78
123
  #
@@ -186,7 +186,7 @@ module Google
186
186
  # @param options [::Gapic::CallOptions, ::Hash]
187
187
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
188
188
  #
189
- # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, safe_search: nil, user_labels: nil)
189
+ # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, safe_search: nil, user_labels: nil)
190
190
  # Pass arguments to `search` via keyword arguments. Note that at
191
191
  # least one keyword argument is required. To specify no parameters, or to keep all
192
192
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -232,6 +232,8 @@ module Google
232
232
  # is unset.
233
233
  #
234
234
  # If this field is negative, an `INVALID_ARGUMENT` is returned.
235
+ # @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec, ::Hash>]
236
+ # A list of data store specs to apply on a search call.
235
237
  # @param filter [::String]
236
238
  # The filter syntax consists of an expression language for constructing a
237
239
  # predicate from one or more fields of the documents being filtered. Filter