algolia 3.0.0.beta.11 → 3.0.0.beta.13
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/Gemfile.lock +2 -2
- data/lib/algolia/api/ingestion_client.rb +127 -3
- data/lib/algolia/api/query_suggestions_client.rb +4 -10
- data/lib/algolia/api/search_client.rb +2 -2
- data/lib/algolia/api/usage_client.rb +4 -4
- data/lib/algolia/models/abtesting/{filter_effects_empty_search.rb → empty_search_filter.rb} +3 -3
- data/lib/algolia/models/abtesting/filter_effects.rb +2 -2
- data/lib/algolia/models/abtesting/{filter_effects_outliers.rb → outliers_filter.rb} +3 -3
- data/lib/algolia/models/analytics/{click_positions_inner.rb → click_position.rb} +3 -3
- data/lib/algolia/models/analytics/get_click_positions_response.rb +1 -1
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +1 -1
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +1 -1
- data/lib/algolia/models/ingestion/destination.rb +15 -4
- data/lib/algolia/models/ingestion/destination_create.rb +15 -4
- data/lib/algolia/models/ingestion/destination_input.rb +1 -2
- data/lib/algolia/models/ingestion/destination_update.rb +15 -4
- data/lib/algolia/models/ingestion/docker_streams_input.rb +1 -0
- data/lib/algolia/models/ingestion/entity_type.rb +32 -0
- data/lib/algolia/models/ingestion/{destination_index_prefix.rb → model.rb} +55 -15
- data/lib/algolia/models/{recommend/trending_items.rb → ingestion/run_source_payload.rb} +39 -34
- data/lib/algolia/models/{search/base_get_api_key_response.rb → ingestion/run_source_response.rb} +19 -15
- data/lib/algolia/models/ingestion/{transformation_try_response_error.rb → transformation_error.rb} +3 -3
- data/lib/algolia/models/ingestion/{source_shopify_base.rb → transformation_models.rb} +14 -12
- data/lib/algolia/models/ingestion/transformation_try_response.rb +1 -1
- data/lib/algolia/models/monitoring/{incidents_inner.rb → incident_entry.rb} +3 -3
- data/lib/algolia/models/monitoring/{indexing_time_response_metrics.rb → indexing_metric.rb} +3 -3
- data/lib/algolia/models/monitoring/indexing_time_response.rb +1 -1
- data/lib/algolia/models/monitoring/infrastructure_response.rb +1 -1
- data/lib/algolia/models/monitoring/{latency_response_metrics.rb → latency_metric.rb} +3 -3
- data/lib/algolia/models/monitoring/latency_response.rb +1 -1
- data/lib/algolia/models/monitoring/{infrastructure_response_metrics.rb → metrics.rb} +3 -6
- data/lib/algolia/models/monitoring/{time_inner.rb → time_entry.rb} +3 -3
- data/lib/algolia/models/{search/search_for_hits_options.rb → query-suggestions/config_status.rb} +43 -36
- data/lib/algolia/models/{recommend/related_products.rb → query-suggestions/log_file.rb} +36 -32
- data/lib/algolia/models/recommend/around_precision.rb +1 -1
- data/lib/algolia/models/recommend/fallback_params.rb +1 -1
- data/lib/algolia/models/recommend/{around_precision_from_value_inner.rb → range.rb} +3 -6
- data/lib/algolia/models/recommend/recommend_rule.rb +1 -1
- data/lib/algolia/models/recommend/{redirect_rule_index_metadata_data.rb → redirect_rule_index_data.rb} +3 -3
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +1 -1
- data/lib/algolia/models/recommend/{recommend_rule_metadata.rb → rule_metadata.rb} +3 -3
- data/lib/algolia/models/recommend/search_params.rb +1 -1
- data/lib/algolia/models/recommend/search_params_object.rb +1 -1
- data/lib/algolia/models/search/around_precision.rb +1 -1
- data/lib/algolia/models/search/browse_params_object.rb +1 -1
- data/lib/algolia/models/search/built_in_operation.rb +1 -2
- data/lib/algolia/models/search/built_in_operation_value.rb +105 -0
- data/lib/algolia/models/search/consequence_params.rb +1 -1
- data/lib/algolia/models/search/dictionary_entry.rb +13 -6
- data/lib/algolia/models/search/dictionary_entry_type.rb +32 -0
- data/lib/algolia/models/search/index_settings.rb +2 -2
- data/lib/algolia/models/search/multiple_batch_request.rb +0 -2
- data/lib/algolia/models/search/{around_precision_from_value_inner.rb → range.rb} +3 -6
- data/lib/algolia/models/search/{redirect_rule_index_metadata_data.rb → redirect_rule_index_data.rb} +3 -3
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +1 -1
- data/lib/algolia/models/search/search_for_facets.rb +1 -1
- data/lib/algolia/models/search/search_for_hits.rb +1 -1
- data/lib/algolia/models/search/search_params_object.rb +1 -1
- data/lib/algolia/models/search/search_params_string.rb +1 -0
- data/lib/algolia/models/search/settings_response.rb +2 -2
- data/lib/algolia/models/usage/{get_usage400_response_error_errors_inner.rb → error_item.rb} +3 -3
- data/lib/algolia/models/usage/{get_usage400_response_error.rb → forbidden_error.rb} +4 -4
- data/lib/algolia/models/usage/{get_usage200_response.rb → index_usage.rb} +4 -4
- data/lib/algolia/models/usage/invalid_request_error.rb +231 -0
- data/lib/algolia/models/usage/{get_usage200_response_statistics_inner.rb → statistic_entry.rb} +3 -3
- data/lib/algolia/version.rb +1 -1
- metadata +30 -65
- data/lib/algolia/models/abtesting/custom_search_params.rb +0 -214
- data/lib/algolia/models/abtesting/error_base.rb +0 -212
- data/lib/algolia/models/analytics/error_base.rb +0 -212
- data/lib/algolia/models/ingestion/error_base.rb +0 -212
- data/lib/algolia/models/insights/error_base.rb +0 -212
- data/lib/algolia/models/monitoring/error_base.rb +0 -212
- data/lib/algolia/models/monitoring/get_servers403_response.rb +0 -211
- data/lib/algolia/models/personalization/error_base.rb +0 -212
- data/lib/algolia/models/query-suggestions/app_id.rb +0 -209
- data/lib/algolia/models/query-suggestions/error_base.rb +0 -212
- data/lib/algolia/models/recommend/base_recommend_request.rb +0 -281
- data/lib/algolia/models/recommend/base_search_params.rb +0 -635
- data/lib/algolia/models/recommend/base_search_params_without_query.rb +0 -616
- data/lib/algolia/models/recommend/base_search_response.rb +0 -499
- data/lib/algolia/models/recommend/error_base.rb +0 -212
- data/lib/algolia/models/recommend/frequently_bought_together.rb +0 -247
- data/lib/algolia/models/recommend/index_settings_as_search_params.rb +0 -788
- data/lib/algolia/models/recommend/looking_similar.rb +0 -256
- data/lib/algolia/models/recommend/recommendations_hits.rb +0 -215
- data/lib/algolia/models/recommend/recommended_for_you.rb +0 -244
- data/lib/algolia/models/recommend/search_pagination.rb +0 -282
- data/lib/algolia/models/recommend/search_params_query.rb +0 -212
- data/lib/algolia/models/recommend/trending_facets.rb +0 -258
- data/lib/algolia/models/search/base_index_settings.rb +0 -426
- data/lib/algolia/models/search/base_search_params.rb +0 -635
- data/lib/algolia/models/search/base_search_params_without_query.rb +0 -616
- data/lib/algolia/models/search/base_search_response.rb +0 -499
- data/lib/algolia/models/search/browse_pagination.rb +0 -274
- data/lib/algolia/models/search/cursor.rb +0 -209
- data/lib/algolia/models/search/error_base.rb +0 -212
- data/lib/algolia/models/search/index_settings_as_search_params.rb +0 -788
- data/lib/algolia/models/search/params.rb +0 -236
- data/lib/algolia/models/search/search_for_facets_options.rb +0 -293
- data/lib/algolia/models/search/search_hits.rb +0 -240
- data/lib/algolia/models/search/search_pagination.rb +0 -282
- data/lib/algolia/models/search/search_params_query.rb +0 -212
- data/lib/algolia/models/search/with_primary.rb +0 -212
- data/lib/algolia/models/usage/error_base.rb +0 -212
- data/lib/algolia/models/usage/get_usage400_response.rb +0 -213
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f77bf84313db0abf2e0ab5356eb7e4e467847a95b6fccd7525af505c9a36a03b
|
4
|
+
data.tar.gz: 21160bde664c846a9ea521cc0958a26e712c9b6a073c1fa2d387240cb5f61da7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 507469790e2f77f9e7815ba593a272af8ef9ba7aef78f0d1c8629516fe5637af8d632e009ebadc86e58e1d14420db1f4939905ef7517d9918c9675f3655443e1
|
7
|
+
data.tar.gz: 916f2b0afcf839b4ab383ab208328e2ff526ff8202424bcd4958a81f627ff0060b9f4dfa0e17c357d52e706e97b08c844682e09cc6c995892a9974837fb0e8b1
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,23 @@
|
|
1
|
+
## [3.0.0.beta.13](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.12...3.0.0.beta.13)
|
2
|
+
|
3
|
+
- [ac0cadb8a](https://github.com/algolia/api-clients-automation/commit/ac0cadb8a) feat(specs): add transformation copilot to ingestion ([#3479](https://github.com/algolia/api-clients-automation/pull/3479)) by [@Fluf22](https://github.com/Fluf22/)
|
4
|
+
- [08a04dec8](https://github.com/algolia/api-clients-automation/commit/08a04dec8) fix(specs): ingestion destination reject indexPrefix ([#3478](https://github.com/algolia/api-clients-automation/pull/3478)) by [@shortcuts](https://github.com/shortcuts/)
|
5
|
+
- [cdd673d33](https://github.com/algolia/api-clients-automation/commit/cdd673d33) fix(specs): ingestion destinations and transformations ([#3477](https://github.com/algolia/api-clients-automation/pull/3477)) by [@shortcuts](https://github.com/shortcuts/)
|
6
|
+
- [b4742be76](https://github.com/algolia/api-clients-automation/commit/b4742be76) fix(clients): move the license to the root ([#3457](https://github.com/algolia/api-clients-automation/pull/3457)) by [@millotp](https://github.com/millotp/)
|
7
|
+
- [e5d14171c](https://github.com/algolia/api-clients-automation/commit/e5d14171c) fix(specs): dictionary entry for stopwords has type property ([#3456](https://github.com/algolia/api-clients-automation/pull/3456)) by [@kai687](https://github.com/kai687/)
|
8
|
+
- [7af1e75e9](https://github.com/algolia/api-clients-automation/commit/7af1e75e9) fix(specs): body is not required in multiple batch request ([#3454](https://github.com/algolia/api-clients-automation/pull/3454)) by [@kai687](https://github.com/kai687/)
|
9
|
+
- [b90bef261](https://github.com/algolia/api-clients-automation/commit/b90bef261) feat(specs): add runSource endpoint ([#3453](https://github.com/algolia/api-clients-automation/pull/3453)) by [@millotp](https://github.com/millotp/)
|
10
|
+
- [27679b7fd](https://github.com/algolia/api-clients-automation/commit/27679b7fd) chore(clients): remove mention of GA ([#3452](https://github.com/algolia/api-clients-automation/pull/3452)) by [@millotp](https://github.com/millotp/)
|
11
|
+
|
12
|
+
## [3.0.0.beta.12](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.11...3.0.0.beta.12)
|
13
|
+
|
14
|
+
- [e982ddf0a](https://github.com/algolia/api-clients-automation/commit/e982ddf0a) fix(specs): built-in ops accept also int ([#3450](https://github.com/algolia/api-clients-automation/pull/3450)) by [@kai687](https://github.com/kai687/)
|
15
|
+
- [9a2e7a837](https://github.com/algolia/api-clients-automation/commit/9a2e7a837) fix(specs): required prop for dictionaryEntry ([#3449](https://github.com/algolia/api-clients-automation/pull/3449)) by [@kai687](https://github.com/kai687/)
|
16
|
+
- [41d86ce68](https://github.com/algolia/api-clients-automation/commit/41d86ce68) feat(clients): delete unused models ([#3445](https://github.com/algolia/api-clients-automation/pull/3445)) by [@millotp](https://github.com/millotp/)
|
17
|
+
- [e17970142](https://github.com/algolia/api-clients-automation/commit/e17970142) fix(specs): proper title with linter ([#3444](https://github.com/algolia/api-clients-automation/pull/3444)) by [@millotp](https://github.com/millotp/)
|
18
|
+
- [8fbbd5ebd](https://github.com/algolia/api-clients-automation/commit/8fbbd5ebd) fix(specs): getObject return object ([#3446](https://github.com/algolia/api-clients-automation/pull/3446)) by [@millotp](https://github.com/millotp/)
|
19
|
+
- [a35e814ab](https://github.com/algolia/api-clients-automation/commit/a35e814ab) fix(specs): clarify decompounding limitations ([#3227](https://github.com/algolia/api-clients-automation/pull/3227)) by [@kai687](https://github.com/kai687/)
|
20
|
+
|
1
21
|
## [3.0.0.beta.11](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.10...3.0.0.beta.11)
|
2
22
|
|
3
23
|
- [3ec5f5f7e](https://github.com/algolia/api-clients-automation/commit/3ec5f5f7e) feat(specs): add v2 endpoints for ingestion ([#3416](https://github.com/algolia/api-clients-automation/pull/3416)) by [@shortcuts](https://github.com/shortcuts/)
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
algolia (3.0.0.beta.
|
4
|
+
algolia (3.0.0.beta.13)
|
5
5
|
base64 (>= 0.2.0, < 1)
|
6
6
|
faraday (>= 1.0.1, < 3.0)
|
7
7
|
faraday-net_http_persistent (>= 0.15, < 3)
|
@@ -15,7 +15,7 @@ GEM
|
|
15
15
|
faraday (2.10.0)
|
16
16
|
faraday-net_http (>= 2.0, < 3.2)
|
17
17
|
logger
|
18
|
-
faraday-net_http (3.1.
|
18
|
+
faraday-net_http (3.1.1)
|
19
19
|
net-http
|
20
20
|
faraday-net_http_persistent (2.1.0)
|
21
21
|
faraday (~> 2.5)
|
@@ -2163,19 +2163,91 @@ module Algolia
|
|
2163
2163
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::ListTasksResponseV1")
|
2164
2164
|
end
|
2165
2165
|
|
2166
|
+
# Retrieves a list of existing LLM transformation helpers.
|
2167
|
+
#
|
2168
|
+
# Required API Key ACLs:
|
2169
|
+
# - addObject
|
2170
|
+
# - deleteIndex
|
2171
|
+
# - editSettings
|
2172
|
+
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2173
|
+
# @return [Http::Response] the response
|
2174
|
+
def list_transformation_models_with_http_info(request_options = {})
|
2175
|
+
path = "/1/transformations/copilot"
|
2176
|
+
query_params = {}
|
2177
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
2178
|
+
header_params = {}
|
2179
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
2180
|
+
|
2181
|
+
post_body = request_options[:debug_body]
|
2182
|
+
|
2183
|
+
new_options = request_options.merge(
|
2184
|
+
:operation => :"IngestionClient.list_transformation_models",
|
2185
|
+
:header_params => header_params,
|
2186
|
+
:query_params => query_params,
|
2187
|
+
:body => post_body,
|
2188
|
+
:use_read_transporter => false
|
2189
|
+
)
|
2190
|
+
|
2191
|
+
@api_client.call_api(:GET, path, new_options)
|
2192
|
+
end
|
2193
|
+
|
2194
|
+
# Retrieves a list of existing LLM transformation helpers.
|
2195
|
+
#
|
2196
|
+
# Required API Key ACLs:
|
2197
|
+
# - addObject
|
2198
|
+
# - deleteIndex
|
2199
|
+
# - editSettings
|
2200
|
+
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2201
|
+
# @return [TransformationModels]
|
2202
|
+
def list_transformation_models(request_options = {})
|
2203
|
+
response = list_transformation_models_with_http_info(request_options)
|
2204
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TransformationModels")
|
2205
|
+
end
|
2206
|
+
|
2166
2207
|
# Retrieves a list of transformations.
|
2167
2208
|
#
|
2168
2209
|
# Required API Key ACLs:
|
2169
2210
|
# - addObject
|
2170
2211
|
# - deleteIndex
|
2171
2212
|
# - editSettings
|
2213
|
+
# @param items_per_page [Integer] Number of items per page. (default to 10)
|
2214
|
+
# @param page [Integer] Page number of the paginated API response.
|
2172
2215
|
# @param sort [SortKeys] Property by which to sort the list. (default to 'desc')
|
2173
2216
|
# @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
|
2174
2217
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2175
2218
|
# @return [Http::Response] the response
|
2176
|
-
def list_transformations_with_http_info(
|
2219
|
+
def list_transformations_with_http_info(
|
2220
|
+
items_per_page = nil,
|
2221
|
+
page = nil,
|
2222
|
+
sort = nil,
|
2223
|
+
order = nil,
|
2224
|
+
request_options = {}
|
2225
|
+
)
|
2226
|
+
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
|
2227
|
+
raise(
|
2228
|
+
ArgumentError,
|
2229
|
+
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_transformations, must be smaller than or equal to 100."
|
2230
|
+
)
|
2231
|
+
end
|
2232
|
+
|
2233
|
+
if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
|
2234
|
+
raise(
|
2235
|
+
ArgumentError,
|
2236
|
+
"invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_transformations, must be greater than or equal to 1."
|
2237
|
+
)
|
2238
|
+
end
|
2239
|
+
|
2240
|
+
if @api_client.config.client_side_validation && !page.nil? && page < 1
|
2241
|
+
raise(
|
2242
|
+
ArgumentError,
|
2243
|
+
"invalid value for \"\"page\"\" when calling IngestionClient.list_transformations, must be greater than or equal to 1."
|
2244
|
+
)
|
2245
|
+
end
|
2246
|
+
|
2177
2247
|
path = "/1/transformations"
|
2178
2248
|
query_params = {}
|
2249
|
+
query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
|
2250
|
+
query_params[:page] = page unless page.nil?
|
2179
2251
|
query_params[:sort] = sort unless sort.nil?
|
2180
2252
|
query_params[:order] = order unless order.nil?
|
2181
2253
|
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
@@ -2201,12 +2273,14 @@ module Algolia
|
|
2201
2273
|
# - addObject
|
2202
2274
|
# - deleteIndex
|
2203
2275
|
# - editSettings
|
2276
|
+
# @param items_per_page [Integer] Number of items per page. (default to 10)
|
2277
|
+
# @param page [Integer] Page number of the paginated API response.
|
2204
2278
|
# @param sort [SortKeys] Property by which to sort the list. (default to 'desc')
|
2205
2279
|
# @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
|
2206
2280
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2207
2281
|
# @return [ListTransformationsResponse]
|
2208
|
-
def list_transformations(sort = nil, order = nil, request_options = {})
|
2209
|
-
response = list_transformations_with_http_info(sort, order, request_options)
|
2282
|
+
def list_transformations(items_per_page = nil, page = nil, sort = nil, order = nil, request_options = {})
|
2283
|
+
response = list_transformations_with_http_info(items_per_page, page, sort, order, request_options)
|
2210
2284
|
@api_client.deserialize(
|
2211
2285
|
response.body,
|
2212
2286
|
request_options[:debug_return_type] || "Ingestion::ListTransformationsResponse"
|
@@ -2267,6 +2341,56 @@ module Algolia
|
|
2267
2341
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse")
|
2268
2342
|
end
|
2269
2343
|
|
2344
|
+
# Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
2345
|
+
#
|
2346
|
+
# Required API Key ACLs:
|
2347
|
+
# - addObject
|
2348
|
+
# - deleteIndex
|
2349
|
+
# - editSettings
|
2350
|
+
# @param source_id [String] Unique identifier of a source. (required)
|
2351
|
+
# @param run_source_payload [RunSourcePayload]
|
2352
|
+
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2353
|
+
# @return [Http::Response] the response
|
2354
|
+
def run_source_with_http_info(source_id, run_source_payload = nil, request_options = {})
|
2355
|
+
# verify the required parameter 'source_id' is set
|
2356
|
+
if @api_client.config.client_side_validation && source_id.nil?
|
2357
|
+
raise ArgumentError, "Parameter `source_id` is required when calling `run_source`."
|
2358
|
+
end
|
2359
|
+
|
2360
|
+
path = "/1/sources/{sourceID}/run".sub("{" + "sourceID" + "}", Transport.encode_uri(source_id.to_s))
|
2361
|
+
query_params = {}
|
2362
|
+
query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
|
2363
|
+
header_params = {}
|
2364
|
+
header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
|
2365
|
+
|
2366
|
+
post_body = request_options[:debug_body] || @api_client.object_to_http_body(run_source_payload)
|
2367
|
+
|
2368
|
+
new_options = request_options.merge(
|
2369
|
+
:operation => :"IngestionClient.run_source",
|
2370
|
+
:header_params => header_params,
|
2371
|
+
:query_params => query_params,
|
2372
|
+
:body => post_body,
|
2373
|
+
:use_read_transporter => false
|
2374
|
+
)
|
2375
|
+
|
2376
|
+
@api_client.call_api(:POST, path, new_options)
|
2377
|
+
end
|
2378
|
+
|
2379
|
+
# Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
2380
|
+
#
|
2381
|
+
# Required API Key ACLs:
|
2382
|
+
# - addObject
|
2383
|
+
# - deleteIndex
|
2384
|
+
# - editSettings
|
2385
|
+
# @param source_id [String] Unique identifier of a source. (required)
|
2386
|
+
# @param run_source_payload [RunSourcePayload]
|
2387
|
+
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
2388
|
+
# @return [RunSourceResponse]
|
2389
|
+
def run_source(source_id, run_source_payload = nil, request_options = {})
|
2390
|
+
response = run_source_with_http_info(source_id, run_source_payload, request_options)
|
2391
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunSourceResponse")
|
2392
|
+
end
|
2393
|
+
|
2270
2394
|
# Runs a task. You can check the status of task runs with the observability endpoints.
|
2271
2395
|
#
|
2272
2396
|
# Required API Key ACLs:
|
@@ -428,13 +428,10 @@ module Algolia
|
|
428
428
|
# - settings
|
429
429
|
# @param index_name [String] Query Suggestions index name. (required)
|
430
430
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
431
|
-
# @return [
|
431
|
+
# @return [ConfigStatus]
|
432
432
|
def get_config_status(index_name, request_options = {})
|
433
433
|
response = get_config_status_with_http_info(index_name, request_options)
|
434
|
-
@api_client.deserialize(
|
435
|
-
response.body,
|
436
|
-
request_options[:debug_return_type] || "QuerySuggestions::GetConfigStatus200Response"
|
437
|
-
)
|
434
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "QuerySuggestions::ConfigStatus")
|
438
435
|
end
|
439
436
|
|
440
437
|
# Retrieves the logs for a single Query Suggestions index.
|
@@ -475,13 +472,10 @@ module Algolia
|
|
475
472
|
# - settings
|
476
473
|
# @param index_name [String] Query Suggestions index name. (required)
|
477
474
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
478
|
-
# @return [
|
475
|
+
# @return [LogFile]
|
479
476
|
def get_log_file(index_name, request_options = {})
|
480
477
|
response = get_log_file_with_http_info(index_name, request_options)
|
481
|
-
@api_client.deserialize(
|
482
|
-
response.body,
|
483
|
-
request_options[:debug_return_type] || "QuerySuggestions::GetLogFile200Response"
|
484
|
-
)
|
478
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "QuerySuggestions::LogFile")
|
485
479
|
end
|
486
480
|
|
487
481
|
# Updates a QuerySuggestions configuration.
|
@@ -1389,10 +1389,10 @@ module Algolia
|
|
1389
1389
|
# @param object_id [String] Unique record identifier. (required)
|
1390
1390
|
# @param attributes_to_retrieve [Array<String>] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key.
|
1391
1391
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
1392
|
-
# @return [
|
1392
|
+
# @return [Object]
|
1393
1393
|
def get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {})
|
1394
1394
|
response = get_object_with_http_info(index_name, object_id, attributes_to_retrieve, request_options)
|
1395
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::
|
1395
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::Object")
|
1396
1396
|
end
|
1397
1397
|
|
1398
1398
|
# Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
|
@@ -275,7 +275,7 @@ module Algolia
|
|
275
275
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. (required)
|
276
276
|
# @param granularity [Granularity] Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. (default to 'daily')
|
277
277
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
278
|
-
# @return [
|
278
|
+
# @return [IndexUsage]
|
279
279
|
def get_index_usage(statistic, index_name, start_date, end_date, granularity = nil, request_options = {})
|
280
280
|
response = get_index_usage_with_http_info(
|
281
281
|
statistic,
|
@@ -285,7 +285,7 @@ module Algolia
|
|
285
285
|
granularity,
|
286
286
|
request_options
|
287
287
|
)
|
288
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::
|
288
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::IndexUsage")
|
289
289
|
end
|
290
290
|
|
291
291
|
# Retrieves usage statistics evaluated over a specified period.
|
@@ -339,10 +339,10 @@ module Algolia
|
|
339
339
|
# @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. (required)
|
340
340
|
# @param granularity [Granularity] Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. (default to 'daily')
|
341
341
|
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
|
342
|
-
# @return [
|
342
|
+
# @return [IndexUsage]
|
343
343
|
def get_usage(statistic, start_date, end_date, granularity = nil, request_options = {})
|
344
344
|
response = get_usage_with_http_info(statistic, start_date, end_date, granularity, request_options)
|
345
|
-
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::
|
345
|
+
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Usage::IndexUsage")
|
346
346
|
end
|
347
347
|
|
348
348
|
end
|
@@ -6,7 +6,7 @@ require "time"
|
|
6
6
|
module Algolia
|
7
7
|
module Abtesting
|
8
8
|
# Empty searches removed from the A/B test as a result of configuration settings.
|
9
|
-
class
|
9
|
+
class EmptySearchFilter
|
10
10
|
# Number of users removed from the A/B test.
|
11
11
|
attr_accessor :users_count
|
12
12
|
|
@@ -47,7 +47,7 @@ module Algolia
|
|
47
47
|
if (!attributes.is_a?(Hash))
|
48
48
|
raise(
|
49
49
|
ArgumentError,
|
50
|
-
"The input argument (attributes) must be a hash in `Algolia::
|
50
|
+
"The input argument (attributes) must be a hash in `Algolia::EmptySearchFilter` initialize method"
|
51
51
|
)
|
52
52
|
end
|
53
53
|
|
@@ -56,7 +56,7 @@ module Algolia
|
|
56
56
|
if (!self.class.attribute_map.key?(k.to_sym))
|
57
57
|
raise(
|
58
58
|
ArgumentError,
|
59
|
-
"`#{k}` is not a valid attribute in `Algolia::
|
59
|
+
"`#{k}` is not a valid attribute in `Algolia::EmptySearchFilter`. Please check the name to make sure it's valid. List of attributes: " +
|
60
60
|
self.class.attribute_map.keys.inspect
|
61
61
|
)
|
62
62
|
end
|
@@ -6,7 +6,7 @@ require "time"
|
|
6
6
|
module Algolia
|
7
7
|
module Abtesting
|
8
8
|
# Outliers removed from the A/B test as a result of configuration settings.
|
9
|
-
class
|
9
|
+
class OutliersFilter
|
10
10
|
# Number of users removed from the A/B test.
|
11
11
|
attr_accessor :users_count
|
12
12
|
|
@@ -47,7 +47,7 @@ module Algolia
|
|
47
47
|
if (!attributes.is_a?(Hash))
|
48
48
|
raise(
|
49
49
|
ArgumentError,
|
50
|
-
"The input argument (attributes) must be a hash in `Algolia::
|
50
|
+
"The input argument (attributes) must be a hash in `Algolia::OutliersFilter` initialize method"
|
51
51
|
)
|
52
52
|
end
|
53
53
|
|
@@ -56,7 +56,7 @@ module Algolia
|
|
56
56
|
if (!self.class.attribute_map.key?(k.to_sym))
|
57
57
|
raise(
|
58
58
|
ArgumentError,
|
59
|
-
"`#{k}` is not a valid attribute in `Algolia::
|
59
|
+
"`#{k}` is not a valid attribute in `Algolia::OutliersFilter`. Please check the name to make sure it's valid. List of attributes: " +
|
60
60
|
self.class.attribute_map.keys.inspect
|
61
61
|
)
|
62
62
|
end
|
@@ -6,7 +6,7 @@ require "time"
|
|
6
6
|
module Algolia
|
7
7
|
module Analytics
|
8
8
|
# Click position.
|
9
|
-
class
|
9
|
+
class ClickPosition
|
10
10
|
# Range of positions in the search results, using the pattern `[start,end]`. For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
|
11
11
|
attr_accessor :position
|
12
12
|
|
@@ -47,7 +47,7 @@ module Algolia
|
|
47
47
|
if (!attributes.is_a?(Hash))
|
48
48
|
raise(
|
49
49
|
ArgumentError,
|
50
|
-
"The input argument (attributes) must be a hash in `Algolia::
|
50
|
+
"The input argument (attributes) must be a hash in `Algolia::ClickPosition` initialize method"
|
51
51
|
)
|
52
52
|
end
|
53
53
|
|
@@ -56,7 +56,7 @@ module Algolia
|
|
56
56
|
if (!self.class.attribute_map.key?(k.to_sym))
|
57
57
|
raise(
|
58
58
|
ArgumentError,
|
59
|
-
"`#{k}` is not a valid attribute in `Algolia::
|
59
|
+
"`#{k}` is not a valid attribute in `Algolia::ClickPosition`. Please check the name to make sure it's valid. List of attributes: " +
|
60
60
|
self.class.attribute_map.keys.inspect
|
61
61
|
)
|
62
62
|
end
|
@@ -64,7 +64,7 @@ module Algolia
|
|
64
64
|
:count => :"Integer",
|
65
65
|
:click_through_rate => :"Float",
|
66
66
|
:average_click_position => :"Float",
|
67
|
-
:click_positions => :"Array<
|
67
|
+
:click_positions => :"Array<ClickPosition>",
|
68
68
|
:conversion_rate => :"Float",
|
69
69
|
:tracked_search_count => :"Integer",
|
70
70
|
:click_count => :"Integer",
|
@@ -84,7 +84,7 @@ module Algolia
|
|
84
84
|
:count => :"Integer",
|
85
85
|
:click_through_rate => :"Float",
|
86
86
|
:average_click_position => :"Float",
|
87
|
-
:click_positions => :"Array<
|
87
|
+
:click_positions => :"Array<ClickPosition>",
|
88
88
|
:conversion_rate => :"Float",
|
89
89
|
:tracked_search_count => :"Integer",
|
90
90
|
:click_count => :"Integer",
|
@@ -26,6 +26,8 @@ module Algolia
|
|
26
26
|
# Universally unique identifier (UUID) of an authentication resource.
|
27
27
|
attr_accessor :authentication_id
|
28
28
|
|
29
|
+
attr_accessor :transformation_ids
|
30
|
+
|
29
31
|
class EnumAttributeValidator
|
30
32
|
attr_reader :datatype
|
31
33
|
attr_reader :allowable_values
|
@@ -57,7 +59,8 @@ module Algolia
|
|
57
59
|
:input => :input,
|
58
60
|
:created_at => :createdAt,
|
59
61
|
:updated_at => :updatedAt,
|
60
|
-
:authentication_id => :authenticationID
|
62
|
+
:authentication_id => :authenticationID,
|
63
|
+
:transformation_ids => :transformationIDs
|
61
64
|
}
|
62
65
|
end
|
63
66
|
|
@@ -75,7 +78,8 @@ module Algolia
|
|
75
78
|
:input => :"DestinationInput",
|
76
79
|
:created_at => :"String",
|
77
80
|
:updated_at => :"String",
|
78
|
-
:authentication_id => :"String"
|
81
|
+
:authentication_id => :"String",
|
82
|
+
:transformation_ids => :"Array<String>"
|
79
83
|
}
|
80
84
|
end
|
81
85
|
|
@@ -146,6 +150,12 @@ module Algolia
|
|
146
150
|
if attributes.key?(:authentication_id)
|
147
151
|
self.authentication_id = attributes[:authentication_id]
|
148
152
|
end
|
153
|
+
|
154
|
+
if attributes.key?(:transformation_ids)
|
155
|
+
if (value = attributes[:transformation_ids]).is_a?(Array)
|
156
|
+
self.transformation_ids = value
|
157
|
+
end
|
158
|
+
end
|
149
159
|
end
|
150
160
|
|
151
161
|
# Checks equality by comparing each attribute.
|
@@ -159,7 +169,8 @@ module Algolia
|
|
159
169
|
input == other.input &&
|
160
170
|
created_at == other.created_at &&
|
161
171
|
updated_at == other.updated_at &&
|
162
|
-
authentication_id == other.authentication_id
|
172
|
+
authentication_id == other.authentication_id &&
|
173
|
+
transformation_ids == other.transformation_ids
|
163
174
|
end
|
164
175
|
|
165
176
|
# @see the `==` method
|
@@ -171,7 +182,7 @@ module Algolia
|
|
171
182
|
# Calculates hash code according to all attributes.
|
172
183
|
# @return [Integer] Hash code
|
173
184
|
def hash
|
174
|
-
[destination_id, type, name, input, created_at, updated_at, authentication_id].hash
|
185
|
+
[destination_id, type, name, input, created_at, updated_at, authentication_id, transformation_ids].hash
|
175
186
|
end
|
176
187
|
|
177
188
|
# Builds the object from hash
|
@@ -17,6 +17,8 @@ module Algolia
|
|
17
17
|
# Universally unique identifier (UUID) of an authentication resource.
|
18
18
|
attr_accessor :authentication_id
|
19
19
|
|
20
|
+
attr_accessor :transformation_ids
|
21
|
+
|
20
22
|
class EnumAttributeValidator
|
21
23
|
attr_reader :datatype
|
22
24
|
attr_reader :allowable_values
|
@@ -45,7 +47,8 @@ module Algolia
|
|
45
47
|
:type => :type,
|
46
48
|
:name => :name,
|
47
49
|
:input => :input,
|
48
|
-
:authentication_id => :authenticationID
|
50
|
+
:authentication_id => :authenticationID,
|
51
|
+
:transformation_ids => :transformationIDs
|
49
52
|
}
|
50
53
|
end
|
51
54
|
|
@@ -60,7 +63,8 @@ module Algolia
|
|
60
63
|
:type => :"DestinationType",
|
61
64
|
:name => :"String",
|
62
65
|
:input => :"DestinationInput",
|
63
|
-
:authentication_id => :"String"
|
66
|
+
:authentication_id => :"String",
|
67
|
+
:transformation_ids => :"Array<String>"
|
64
68
|
}
|
65
69
|
end
|
66
70
|
|
@@ -115,6 +119,12 @@ module Algolia
|
|
115
119
|
if attributes.key?(:authentication_id)
|
116
120
|
self.authentication_id = attributes[:authentication_id]
|
117
121
|
end
|
122
|
+
|
123
|
+
if attributes.key?(:transformation_ids)
|
124
|
+
if (value = attributes[:transformation_ids]).is_a?(Array)
|
125
|
+
self.transformation_ids = value
|
126
|
+
end
|
127
|
+
end
|
118
128
|
end
|
119
129
|
|
120
130
|
# Checks equality by comparing each attribute.
|
@@ -125,7 +135,8 @@ module Algolia
|
|
125
135
|
type == other.type &&
|
126
136
|
name == other.name &&
|
127
137
|
input == other.input &&
|
128
|
-
authentication_id == other.authentication_id
|
138
|
+
authentication_id == other.authentication_id &&
|
139
|
+
transformation_ids == other.transformation_ids
|
129
140
|
end
|
130
141
|
|
131
142
|
# @see the `==` method
|
@@ -137,7 +148,7 @@ module Algolia
|
|
137
148
|
# Calculates hash code according to all attributes.
|
138
149
|
# @return [Integer] Hash code
|
139
150
|
def hash
|
140
|
-
[type, name, input, authentication_id].hash
|
151
|
+
[type, name, input, authentication_id, transformation_ids].hash
|
141
152
|
end
|
142
153
|
|
143
154
|
# Builds the object from hash
|
@@ -17,6 +17,8 @@ module Algolia
|
|
17
17
|
# Universally unique identifier (UUID) of an authentication resource.
|
18
18
|
attr_accessor :authentication_id
|
19
19
|
|
20
|
+
attr_accessor :transformation_ids
|
21
|
+
|
20
22
|
class EnumAttributeValidator
|
21
23
|
attr_reader :datatype
|
22
24
|
attr_reader :allowable_values
|
@@ -45,7 +47,8 @@ module Algolia
|
|
45
47
|
:type => :type,
|
46
48
|
:name => :name,
|
47
49
|
:input => :input,
|
48
|
-
:authentication_id => :authenticationID
|
50
|
+
:authentication_id => :authenticationID,
|
51
|
+
:transformation_ids => :transformationIDs
|
49
52
|
}
|
50
53
|
end
|
51
54
|
|
@@ -60,7 +63,8 @@ module Algolia
|
|
60
63
|
:type => :"DestinationType",
|
61
64
|
:name => :"String",
|
62
65
|
:input => :"DestinationInput",
|
63
|
-
:authentication_id => :"String"
|
66
|
+
:authentication_id => :"String",
|
67
|
+
:transformation_ids => :"Array<String>"
|
64
68
|
}
|
65
69
|
end
|
66
70
|
|
@@ -109,6 +113,12 @@ module Algolia
|
|
109
113
|
if attributes.key?(:authentication_id)
|
110
114
|
self.authentication_id = attributes[:authentication_id]
|
111
115
|
end
|
116
|
+
|
117
|
+
if attributes.key?(:transformation_ids)
|
118
|
+
if (value = attributes[:transformation_ids]).is_a?(Array)
|
119
|
+
self.transformation_ids = value
|
120
|
+
end
|
121
|
+
end
|
112
122
|
end
|
113
123
|
|
114
124
|
# Checks equality by comparing each attribute.
|
@@ -119,7 +129,8 @@ module Algolia
|
|
119
129
|
type == other.type &&
|
120
130
|
name == other.name &&
|
121
131
|
input == other.input &&
|
122
|
-
authentication_id == other.authentication_id
|
132
|
+
authentication_id == other.authentication_id &&
|
133
|
+
transformation_ids == other.transformation_ids
|
123
134
|
end
|
124
135
|
|
125
136
|
# @see the `==` method
|
@@ -131,7 +142,7 @@ module Algolia
|
|
131
142
|
# Calculates hash code according to all attributes.
|
132
143
|
# @return [Integer] Hash code
|
133
144
|
def hash
|
134
|
-
[type, name, input, authentication_id].hash
|
145
|
+
[type, name, input, authentication_id, transformation_ids].hash
|
135
146
|
end
|
136
147
|
|
137
148
|
# Builds the object from hash
|