algolia 3.28.0 → 3.28.1
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/.github/workflows/do-not-edit-this-repository.yml +1 -1
- data/.github/workflows/release.yml +1 -1
- data/CHANGELOG.md +7 -0
- data/Gemfile.lock +1 -1
- data/README.md +3 -4
- data/lib/algolia/api/search_client.rb +20 -20
- data/lib/algolia/models/composition/base_injection_query_parameters.rb +1 -1
- data/lib/algolia/models/composition/exhaustive.rb +1 -1
- data/lib/algolia/models/composition/facet_hits.rb +1 -1
- data/lib/algolia/models/composition/main_injection_query_parameters.rb +1 -1
- data/lib/algolia/models/composition/params.rb +1 -1
- data/lib/algolia/models/composition/search_for_facet_values_results.rb +1 -1
- data/lib/algolia/models/ingestion/event.rb +1 -1
- data/lib/algolia/models/recommend/exhaustive.rb +1 -1
- data/lib/algolia/models/recommend/fallback_params.rb +1 -1
- data/lib/algolia/models/recommend/recommend_search_params.rb +1 -1
- data/lib/algolia/models/search/automatic_facet_filter.rb +1 -1
- data/lib/algolia/models/search/browse_params_object.rb +1 -1
- data/lib/algolia/models/search/consequence_params.rb +1 -1
- data/lib/algolia/models/search/event.rb +1 -1
- data/lib/algolia/models/search/exhaustive.rb +1 -1
- data/lib/algolia/models/search/facet_hits.rb +1 -1
- data/lib/algolia/models/search/search_for_facet_values_response.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/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4a9a8d49f4f5bc3ae8b75a1c9470c8c6a4b6f1af6e3c3609e166aa2835af5813
|
4
|
+
data.tar.gz: 382f6cdab4882f0c945134500e700f6a92ee4adf12845b780d0ee56fe9f575a5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fad587a7862d83615860d0abbfb1f64b253bb1f90648d7568c3e48fe69a9be5f9c670f115b58534a787c763d9f16719fbbedc863f2414271ed0194f18c71ef08
|
7
|
+
data.tar.gz: 103375b059468d554ef7578fe8f01eb240fb5e1eee585c914a3dde2f52243e2995d31f36adebedfe313e4a0e8ae30bec25568a090e9b16a1e0f02abdb7123d6b
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,10 @@
|
|
1
|
+
## [3.28.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.28.0...3.28.1)
|
2
|
+
|
3
|
+
- [9a92b3269](https://github.com/algolia/api-clients-automation/commit/9a92b3269) chore(deps): dependencies 2025-10-13 ([#5453](https://github.com/algolia/api-clients-automation/pull/5453)) by [@algolia-bot](https://github.com/algolia-bot/)
|
4
|
+
- [02b6a90ae](https://github.com/algolia/api-clients-automation/commit/02b6a90ae) fix(clients): upgrade linter ([#5476](https://github.com/algolia/api-clients-automation/pull/5476)) by [@millotp](https://github.com/millotp/)
|
5
|
+
- [3fc252bec](https://github.com/algolia/api-clients-automation/commit/3fc252bec) chore: remove dead links ([#5472](https://github.com/algolia/api-clients-automation/pull/5472)) by [@millotp](https://github.com/millotp/)
|
6
|
+
- [9eebe5113](https://github.com/algolia/api-clients-automation/commit/9eebe5113) docs: replace links for the new doc ([#5478](https://github.com/algolia/api-clients-automation/pull/5478)) by [@millotp](https://github.com/millotp/)
|
7
|
+
|
1
8
|
## [3.28.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.27.0...3.28.0)
|
2
9
|
|
3
10
|
- [7de94353f](https://github.com/algolia/api-clients-automation/commit/7de94353f) feat(specs): add compositions deduplication setting ([#5418](https://github.com/algolia/api-clients-automation/pull/5418)) by [@ben-kalmus](https://github.com/ben-kalmus/)
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -13,12 +13,11 @@
|
|
13
13
|
</p>
|
14
14
|
|
15
15
|
<p align="center">
|
16
|
-
<a href="https://www.algolia.com/doc/libraries/ruby
|
16
|
+
<a href="https://www.algolia.com/doc/libraries/sdk/install#ruby" target="_blank">Documentation</a> •
|
17
17
|
<a href="https://github.com/algolia/algoliasearch-rails" target="_blank">Rails</a> •
|
18
18
|
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
|
19
19
|
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
|
20
20
|
<a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a> •
|
21
|
-
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a> •
|
22
21
|
<a href="https://alg.li/support" target="_blank">Support</a>
|
23
22
|
</p>
|
24
23
|
|
@@ -47,11 +46,11 @@ Finally, you may begin searching a object using the `search` method:
|
|
47
46
|
objects = client.search_single_index('your_index_name', 'Foo')
|
48
47
|
```
|
49
48
|
|
50
|
-
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/ruby
|
49
|
+
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/sdk/install#ruby)**.
|
51
50
|
|
52
51
|
## ❓ Troubleshooting
|
53
52
|
|
54
|
-
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://
|
53
|
+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://support.algolia.com/hc/sections/15061037630609-API-Client-FAQs) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
|
55
54
|
|
56
55
|
## Contributing
|
57
56
|
|
@@ -267,7 +267,7 @@ module Algolia
|
|
267
267
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::CreatedAtResponse")
|
268
268
|
end
|
269
269
|
|
270
|
-
# Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
270
|
+
# Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
271
271
|
|
272
272
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
273
273
|
# @param batch_write_params [BatchWriteParams] (required)
|
@@ -302,7 +302,7 @@ module Algolia
|
|
302
302
|
@api_client.call_api(:POST, path, new_options)
|
303
303
|
end
|
304
304
|
|
305
|
-
# Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
305
|
+
# Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
306
306
|
|
307
307
|
# @param index_name [String] Name of the index on which to perform the operation. (required)
|
308
308
|
# @param batch_write_params [BatchWriteParams] (required)
|
@@ -474,7 +474,7 @@ module Algolia
|
|
474
474
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::BrowseResponse")
|
475
475
|
end
|
476
476
|
|
477
|
-
# Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/
|
477
|
+
# Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
478
478
|
#
|
479
479
|
# Required API Key ACLs:
|
480
480
|
# - deleteIndex
|
@@ -506,7 +506,7 @@ module Algolia
|
|
506
506
|
@api_client.call_api(:POST, path, new_options)
|
507
507
|
end
|
508
508
|
|
509
|
-
# Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/
|
509
|
+
# Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
510
510
|
#
|
511
511
|
# Required API Key ACLs:
|
512
512
|
# - deleteIndex
|
@@ -832,7 +832,7 @@ module Algolia
|
|
832
832
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeleteApiKeyResponse")
|
833
833
|
end
|
834
834
|
|
835
|
-
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
835
|
+
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
836
836
|
#
|
837
837
|
# Required API Key ACLs:
|
838
838
|
# - deleteIndex
|
@@ -869,7 +869,7 @@ module Algolia
|
|
869
869
|
@api_client.call_api(:POST, path, new_options)
|
870
870
|
end
|
871
871
|
|
872
|
-
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
872
|
+
# This operation doesn't accept empty filters. This operation is resource-intensive. You should only use it if you can't get the object IDs of the records you want to delete. It's more efficient to get a list of object IDs with the [`browse` operation](https://www.algolia.com/doc/rest-api/search/browse), and then delete the records using the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
873
873
|
#
|
874
874
|
# Required API Key ACLs:
|
875
875
|
# - deleteIndex
|
@@ -1294,7 +1294,7 @@ module Algolia
|
|
1294
1294
|
)
|
1295
1295
|
end
|
1296
1296
|
|
1297
|
-
# The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/
|
1297
|
+
# The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/articles/17245378392977-How-does-Algolia-count-records-and-operations) but doesn't appear in the logs itself.
|
1298
1298
|
#
|
1299
1299
|
# Required API Key ACLs:
|
1300
1300
|
# - logs
|
@@ -1328,7 +1328,7 @@ module Algolia
|
|
1328
1328
|
@api_client.call_api(:GET, path, new_options)
|
1329
1329
|
end
|
1330
1330
|
|
1331
|
-
# The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/
|
1331
|
+
# The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/articles/17245378392977-How-does-Algolia-count-records-and-operations) but doesn't appear in the logs itself.
|
1332
1332
|
#
|
1333
1333
|
# Required API Key ACLs:
|
1334
1334
|
# - logs
|
@@ -1975,7 +1975,7 @@ module Algolia
|
|
1975
1975
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ListUserIdsResponse")
|
1976
1976
|
end
|
1977
1977
|
|
1978
|
-
# Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
1978
|
+
# Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
1979
1979
|
|
1980
1980
|
# @param batch_params [BatchParams] (required)
|
1981
1981
|
# @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)
|
@@ -2005,7 +2005,7 @@ module Algolia
|
|
2005
2005
|
@api_client.call_api(:POST, path, new_options)
|
2006
2006
|
end
|
2007
2007
|
|
2008
|
-
# Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2008
|
+
# Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2009
2009
|
|
2010
2010
|
# @param batch_params [BatchParams] (required)
|
2011
2011
|
# @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)
|
@@ -2015,7 +2015,7 @@ module Algolia
|
|
2015
2015
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::MultipleBatchResponse")
|
2016
2016
|
end
|
2017
2017
|
|
2018
|
-
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2018
|
+
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2019
2019
|
#
|
2020
2020
|
# Required API Key ACLs:
|
2021
2021
|
# - addObject
|
@@ -2052,7 +2052,7 @@ module Algolia
|
|
2052
2052
|
@api_client.call_api(:POST, path, new_options)
|
2053
2053
|
end
|
2054
2054
|
|
2055
|
-
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2055
|
+
# Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. - This operation is resource-intensive. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2056
2056
|
#
|
2057
2057
|
# Required API Key ACLs:
|
2058
2058
|
# - addObject
|
@@ -2065,7 +2065,7 @@ module Algolia
|
|
2065
2065
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
|
2066
2066
|
end
|
2067
2067
|
|
2068
|
-
# Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, this operation replaces its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. When updating multiple attributes or using multiple operations targeting the same record, you should use a single partial update for faster processing. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2068
|
+
# Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, this operation replaces its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. When updating multiple attributes or using multiple operations targeting the same record, you should use a single partial update for faster processing. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2069
2069
|
#
|
2070
2070
|
# Required API Key ACLs:
|
2071
2071
|
# - addObject
|
@@ -2117,7 +2117,7 @@ module Algolia
|
|
2117
2117
|
@api_client.call_api(:POST, path, new_options)
|
2118
2118
|
end
|
2119
2119
|
|
2120
|
-
# Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, this operation replaces its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. When updating multiple attributes or using multiple operations targeting the same record, you should use a single partial update for faster processing. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2120
|
+
# Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, this operation replaces its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. When updating multiple attributes or using multiple operations targeting the same record, you should use a single partial update for faster processing. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2121
2121
|
#
|
2122
2122
|
# Required API Key ACLs:
|
2123
2123
|
# - addObject
|
@@ -2280,7 +2280,7 @@ module Algolia
|
|
2280
2280
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::AddApiKeyResponse")
|
2281
2281
|
end
|
2282
2282
|
|
2283
|
-
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2283
|
+
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2284
2284
|
#
|
2285
2285
|
# Required API Key ACLs:
|
2286
2286
|
# - addObject
|
@@ -2317,7 +2317,7 @@ module Algolia
|
|
2317
2317
|
@api_client.call_api(:POST, path, new_options)
|
2318
2318
|
end
|
2319
2319
|
|
2320
|
-
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2320
|
+
# Adds a record to an index or replaces it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](https://www.algolia.com/doc/rest-api/search/partial-update-object). To add, update, or replace multiple records, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch). This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2321
2321
|
#
|
2322
2322
|
# Required API Key ACLs:
|
2323
2323
|
# - addObject
|
@@ -2391,7 +2391,7 @@ module Algolia
|
|
2391
2391
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
|
2392
2392
|
end
|
2393
2393
|
|
2394
|
-
# Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2394
|
+
# Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2395
2395
|
#
|
2396
2396
|
# Required API Key ACLs:
|
2397
2397
|
# - editSettings
|
@@ -2438,7 +2438,7 @@ module Algolia
|
|
2438
2438
|
@api_client.call_api(:POST, path, new_options)
|
2439
2439
|
end
|
2440
2440
|
|
2441
|
-
# Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2441
|
+
# Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2442
2442
|
#
|
2443
2443
|
# Required API Key ACLs:
|
2444
2444
|
# - editSettings
|
@@ -2532,7 +2532,7 @@ module Algolia
|
|
2532
2532
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SaveSynonymResponse")
|
2533
2533
|
end
|
2534
2534
|
|
2535
|
-
# If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2535
|
+
# If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2536
2536
|
#
|
2537
2537
|
# Required API Key ACLs:
|
2538
2538
|
# - editSettings
|
@@ -2579,7 +2579,7 @@ module Algolia
|
|
2579
2579
|
@api_client.call_api(:POST, path, new_options)
|
2580
2580
|
end
|
2581
2581
|
|
2582
|
-
# If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/
|
2582
|
+
# If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
|
2583
2583
|
#
|
2584
2584
|
# Required API Key ACLs:
|
2585
2585
|
# - editSettings
|
@@ -35,7 +35,7 @@ module Algolia
|
|
35
35
|
# Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
|
36
36
|
attr_accessor :attributes_to_snippet
|
37
37
|
|
38
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
38
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
39
39
|
attr_accessor :click_analytics
|
40
40
|
|
41
41
|
# Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
@@ -9,7 +9,7 @@ module Algolia
|
|
9
9
|
module Composition
|
10
10
|
# Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
|
11
11
|
class Exhaustive
|
12
|
-
# Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/
|
12
|
+
# Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
|
13
13
|
attr_accessor :facets_count
|
14
14
|
|
15
15
|
# The value is `false` if not all facet values are retrieved.
|
@@ -14,7 +14,7 @@ module Algolia
|
|
14
14
|
# Highlighted attribute value, including HTML tags.
|
15
15
|
attr_accessor :highlighted
|
16
16
|
|
17
|
-
# Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/
|
17
|
+
# Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
|
18
18
|
attr_accessor :count
|
19
19
|
|
20
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -35,7 +35,7 @@ module Algolia
|
|
35
35
|
# Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
|
36
36
|
attr_accessor :attributes_to_snippet
|
37
37
|
|
38
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
38
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
39
39
|
attr_accessor :click_analytics
|
40
40
|
|
41
41
|
# Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
@@ -65,7 +65,7 @@ module Algolia
|
|
65
65
|
# Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
|
66
66
|
attr_accessor :user_token
|
67
67
|
|
68
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
68
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
69
69
|
attr_accessor :click_analytics
|
70
70
|
|
71
71
|
# Whether this search will be included in Analytics.
|
@@ -13,7 +13,7 @@ module Algolia
|
|
13
13
|
# Matching facet values.
|
14
14
|
attr_accessor :facet_hits
|
15
15
|
|
16
|
-
# Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/
|
16
|
+
# Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
|
17
17
|
attr_accessor :exhaustive_facets_count
|
18
18
|
|
19
19
|
# Time the server took to process the request, in milliseconds.
|
@@ -7,7 +7,7 @@ require "time"
|
|
7
7
|
|
8
8
|
module Algolia
|
9
9
|
module Ingestion
|
10
|
-
# An event describe a step of the task execution flow
|
10
|
+
# An event describe a step of the task execution flow.
|
11
11
|
class Event
|
12
12
|
# Universally unique identifier (UUID) of an event.
|
13
13
|
attr_accessor :event_id
|
@@ -9,7 +9,7 @@ module Algolia
|
|
9
9
|
module Recommend
|
10
10
|
# Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
|
11
11
|
class Exhaustive
|
12
|
-
# Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/
|
12
|
+
# Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
|
13
13
|
attr_accessor :facets_count
|
14
14
|
|
15
15
|
# The value is `false` if not all facet values are retrieved.
|
@@ -70,7 +70,7 @@ module Algolia
|
|
70
70
|
# Whether to take into account an index's synonyms for this search.
|
71
71
|
attr_accessor :synonyms
|
72
72
|
|
73
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
73
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
74
74
|
attr_accessor :click_analytics
|
75
75
|
|
76
76
|
# Whether this search will be included in Analytics.
|
@@ -71,7 +71,7 @@ module Algolia
|
|
71
71
|
# Whether to take into account an index's synonyms for this search.
|
72
72
|
attr_accessor :synonyms
|
73
73
|
|
74
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
74
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
75
75
|
attr_accessor :click_analytics
|
76
76
|
|
77
77
|
# Whether this search will be included in Analytics.
|
@@ -15,7 +15,7 @@ module Algolia
|
|
15
15
|
# Filter scores to give different weights to individual filters.
|
16
16
|
attr_accessor :score
|
17
17
|
|
18
|
-
# Whether the filter is disjunctive or conjunctive. If true the filter has multiple matches, multiple
|
18
|
+
# Whether the filter is disjunctive or conjunctive. If true the filter has multiple matches, multiple occurrences are combined with the logical `OR` operation. If false, multiple occurrences are combined with the logical `AND` operation.
|
19
19
|
attr_accessor :disjunctive
|
20
20
|
|
21
21
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -82,7 +82,7 @@ module Algolia
|
|
82
82
|
# Whether to take into account an index's synonyms for this search.
|
83
83
|
attr_accessor :synonyms
|
84
84
|
|
85
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
85
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
86
86
|
attr_accessor :click_analytics
|
87
87
|
|
88
88
|
# Whether this search will be included in Analytics.
|
@@ -79,7 +79,7 @@ module Algolia
|
|
79
79
|
# Whether to take into account an index's synonyms for this search.
|
80
80
|
attr_accessor :synonyms
|
81
81
|
|
82
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
82
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
83
83
|
attr_accessor :click_analytics
|
84
84
|
|
85
85
|
# Whether this search will be included in Analytics.
|
@@ -9,7 +9,7 @@ module Algolia
|
|
9
9
|
module Search
|
10
10
|
# Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
|
11
11
|
class Exhaustive
|
12
|
-
# Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/
|
12
|
+
# Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
|
13
13
|
attr_accessor :facets_count
|
14
14
|
|
15
15
|
# The value is `false` if not all facet values are retrieved.
|
@@ -14,7 +14,7 @@ module Algolia
|
|
14
14
|
# Highlighted attribute value, including HTML tags.
|
15
15
|
attr_accessor :highlighted
|
16
16
|
|
17
|
-
# Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/
|
17
|
+
# Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
|
18
18
|
attr_accessor :count
|
19
19
|
|
20
20
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -11,7 +11,7 @@ module Algolia
|
|
11
11
|
# Matching facet values.
|
12
12
|
attr_accessor :facet_hits
|
13
13
|
|
14
|
-
# Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/
|
14
|
+
# Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
|
15
15
|
attr_accessor :exhaustive_facets_count
|
16
16
|
|
17
17
|
# Time the server took to process the request, in milliseconds.
|
@@ -85,7 +85,7 @@ module Algolia
|
|
85
85
|
# Whether to take into account an index's synonyms for this search.
|
86
86
|
attr_accessor :synonyms
|
87
87
|
|
88
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
88
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
89
89
|
attr_accessor :click_analytics
|
90
90
|
|
91
91
|
# Whether this search will be included in Analytics.
|
@@ -85,7 +85,7 @@ module Algolia
|
|
85
85
|
# Whether to take into account an index's synonyms for this search.
|
86
86
|
attr_accessor :synonyms
|
87
87
|
|
88
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
88
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
89
89
|
attr_accessor :click_analytics
|
90
90
|
|
91
91
|
# Whether this search will be included in Analytics.
|
@@ -83,7 +83,7 @@ module Algolia
|
|
83
83
|
# Whether to take into account an index's synonyms for this search.
|
84
84
|
attr_accessor :synonyms
|
85
85
|
|
86
|
-
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
|
86
|
+
# Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
|
87
87
|
attr_accessor :click_analytics
|
88
88
|
|
89
89
|
# Whether this search will be included in Analytics.
|
data/lib/algolia/version.rb
CHANGED