From 00305cbbee8b90cc9c35dbcf478a8935b5133824 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Tue, 15 Oct 2024 14:02:28 +0000 Subject: [PATCH] fix(clients): escape char in comments (generated) https://github.com/algolia/api-clients-automation/pull/3973 Co-authored-by: algolia-bot --- lib/Model/Abtesting/Status.php | 2 +- lib/Model/Analytics/Operator.php | 2 +- lib/Model/Analytics/OrderBy.php | 2 +- lib/Model/Ingestion/AuthenticationType.php | 2 +- lib/Model/Ingestion/DestinationType.php | 2 +- lib/Model/Ingestion/OnDemandTriggerType.php | 2 +- lib/Model/Ingestion/RunReasonCode.php | 2 +- lib/Model/Ingestion/ShopifyInput.php | 2 +- lib/Model/Ingestion/StreamingInput.php | 2 +- lib/Model/Ingestion/TaskCreateV1.php | 2 +- lib/Model/Ingestion/TaskUpdateV1.php | 2 +- lib/Model/Ingestion/TaskV1.php | 2 +- lib/Model/Ingestion/TriggerType.php | 2 +- lib/Model/Insights/AddedToCartObjectIDs.php | 2 +- lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php | 2 +- lib/Model/Insights/ClickedObjectIDs.php | 2 +- lib/Model/Insights/ClickedObjectIDsAfterSearch.php | 2 +- lib/Model/Insights/ConvertedObjectIDs.php | 2 +- lib/Model/Insights/ConvertedObjectIDsAfterSearch.php | 2 +- lib/Model/Insights/Discount.php | 2 +- lib/Model/Insights/Price.php | 2 +- lib/Model/Insights/PurchasedObjectIDs.php | 2 +- lib/Model/Insights/PurchasedObjectIDsAfterSearch.php | 2 +- lib/Model/Insights/Value.php | 2 +- lib/Model/QuerySuggestions/LogLevel.php | 2 +- lib/Model/Recommend/AroundRadius.php | 2 +- lib/Model/Recommend/AroundRadiusAll.php | 2 +- lib/Model/Recommend/Distinct.php | 2 +- lib/Model/Recommend/ExactOnSingleWordQuery.php | 2 +- lib/Model/Recommend/FacetFilters.php | 2 +- lib/Model/Recommend/FbtModel.php | 2 +- lib/Model/Recommend/LookingSimilarModel.php | 2 +- lib/Model/Recommend/NumericFilters.php | 2 +- lib/Model/Recommend/OptionalFilters.php | 2 +- lib/Model/Recommend/QueryType.php | 2 +- lib/Model/Recommend/RankingInfo.php | 2 +- lib/Model/Recommend/RecommendedForYouModel.php | 2 +- lib/Model/Recommend/RelatedModel.php | 2 +- lib/Model/Recommend/RemoveStopWords.php | 2 +- lib/Model/Recommend/RemoveWordsIfNoResults.php | 2 +- lib/Model/Recommend/SortRemainingBy.php | 2 +- lib/Model/Recommend/TagFilters.php | 2 +- lib/Model/Recommend/TaskStatus.php | 2 +- lib/Model/Recommend/TypoTolerance.php | 2 +- lib/Model/Recommend/TypoToleranceEnum.php | 2 +- lib/Model/Search/Anchoring.php | 2 +- lib/Model/Search/AroundRadius.php | 2 +- lib/Model/Search/AroundRadiusAll.php | 2 +- lib/Model/Search/AutomaticFacetFilters.php | 2 +- lib/Model/Search/ConsequenceQuery.php | 2 +- lib/Model/Search/DictionaryLanguage.php | 2 +- lib/Model/Search/Distinct.php | 2 +- lib/Model/Search/ExactOnSingleWordQuery.php | 2 +- lib/Model/Search/FacetFilters.php | 2 +- lib/Model/Search/NumericFilters.php | 2 +- lib/Model/Search/OptionalFilters.php | 2 +- lib/Model/Search/QueryType.php | 2 +- lib/Model/Search/RankingInfo.php | 2 +- lib/Model/Search/RemoveStopWords.php | 2 +- lib/Model/Search/RemoveWordsIfNoResults.php | 2 +- lib/Model/Search/SearchParamsObject.php | 2 +- lib/Model/Search/SearchStrategy.php | 2 +- lib/Model/Search/SearchTypeDefault.php | 2 +- lib/Model/Search/SearchTypeFacet.php | 2 +- lib/Model/Search/SemanticSearch.php | 2 +- lib/Model/Search/SortRemainingBy.php | 2 +- lib/Model/Search/TagFilters.php | 2 +- lib/Model/Search/TaskStatus.php | 2 +- lib/Model/Search/TypoTolerance.php | 2 +- lib/Model/Search/TypoToleranceEnum.php | 2 +- 70 files changed, 70 insertions(+), 70 deletions(-) diff --git a/lib/Model/Abtesting/Status.php b/lib/Model/Abtesting/Status.php index 0e56a974..7bfae17c 100644 --- a/lib/Model/Abtesting/Status.php +++ b/lib/Model/Abtesting/Status.php @@ -9,7 +9,7 @@ * * @category Class * - * @description A/B test status. - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed. + * @description A/B test status. - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed. */ class Status { diff --git a/lib/Model/Analytics/Operator.php b/lib/Model/Analytics/Operator.php index 6e8a336c..c70233f1 100644 --- a/lib/Model/Analytics/Operator.php +++ b/lib/Model/Analytics/Operator.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator. + * @description Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator. */ class Operator { diff --git a/lib/Model/Analytics/OrderBy.php b/lib/Model/Analytics/OrderBy.php index 87e81c57..0da014fd 100644 --- a/lib/Model/Analytics/OrderBy.php +++ b/lib/Model/Analytics/OrderBy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. + * @description Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. */ class OrderBy { diff --git a/lib/Model/Ingestion/AuthenticationType.php b/lib/Model/Ingestion/AuthenticationType.php index 241ba0c8..4e0c627e 100644 --- a/lib/Model/Ingestion/AuthenticationType.php +++ b/lib/Model/Ingestion/AuthenticationType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Type of authentication. This determines the type of credentials required in the `input` object. + * @description Type of authentication. This determines the type of credentials required in the `input` object. */ class AuthenticationType { diff --git a/lib/Model/Ingestion/DestinationType.php b/lib/Model/Ingestion/DestinationType.php index 554cbeb9..ad33c606 100644 --- a/lib/Model/Ingestion/DestinationType.php +++ b/lib/Model/Ingestion/DestinationType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is recorded as user events in the Insights API. + * @description Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is recorded as user events in the Insights API. */ class DestinationType { diff --git a/lib/Model/Ingestion/OnDemandTriggerType.php b/lib/Model/Ingestion/OnDemandTriggerType.php index 175ad983..729346fe 100644 --- a/lib/Model/Ingestion/OnDemandTriggerType.php +++ b/lib/Model/Ingestion/OnDemandTriggerType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task is run manually, with the `/run` endpoint. + * @description Task is run manually, with the `/run` endpoint. */ class OnDemandTriggerType { diff --git a/lib/Model/Ingestion/RunReasonCode.php b/lib/Model/Ingestion/RunReasonCode.php index ddcef1d6..bffdc1e0 100644 --- a/lib/Model/Ingestion/RunReasonCode.php +++ b/lib/Model/Ingestion/RunReasonCode.php @@ -9,7 +9,7 @@ * * @category Class * - * @description A code for the task run's outcome. A readable description of the code is included in the `reason` response property. + * @description A code for the task run's outcome. A readable description of the code is included in the `reason` response property. */ class RunReasonCode { diff --git a/lib/Model/Ingestion/ShopifyInput.php b/lib/Model/Ingestion/ShopifyInput.php index ec0adba0..999363bc 100644 --- a/lib/Model/Ingestion/ShopifyInput.php +++ b/lib/Model/Ingestion/ShopifyInput.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Represents the required elements of the task input when using a `shopify` source. + * @description Represents the required elements of the task input when using a `shopify` source. */ class ShopifyInput extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Ingestion/StreamingInput.php b/lib/Model/Ingestion/StreamingInput.php index f0b22409..63470f7f 100644 --- a/lib/Model/Ingestion/StreamingInput.php +++ b/lib/Model/Ingestion/StreamingInput.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed. + * @description Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed. */ class StreamingInput extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Ingestion/TaskCreateV1.php b/lib/Model/Ingestion/TaskCreateV1.php index 4be61cfa..cb61f7cd 100644 --- a/lib/Model/Ingestion/TaskCreateV1.php +++ b/lib/Model/Ingestion/TaskCreateV1.php @@ -12,7 +12,7 @@ * * @category Class * - * @description API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. + * @description API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. */ class TaskCreateV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Ingestion/TaskUpdateV1.php b/lib/Model/Ingestion/TaskUpdateV1.php index 33f4af08..7ec0f1f4 100644 --- a/lib/Model/Ingestion/TaskUpdateV1.php +++ b/lib/Model/Ingestion/TaskUpdateV1.php @@ -12,7 +12,7 @@ * * @category Class * - * @description API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. + * @description API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. */ class TaskUpdateV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Ingestion/TaskV1.php b/lib/Model/Ingestion/TaskV1.php index dd2e0c98..c6b5bc46 100644 --- a/lib/Model/Ingestion/TaskV1.php +++ b/lib/Model/Ingestion/TaskV1.php @@ -12,7 +12,7 @@ * * @category Class * - * @description The V1 task object, please use methods and types that don't contain the V1 suffix. + * @description The V1 task object, please use methods and types that don't contain the V1 suffix. */ class TaskV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Ingestion/TriggerType.php b/lib/Model/Ingestion/TriggerType.php index dcc85235..7c939b4e 100644 --- a/lib/Model/Ingestion/TriggerType.php +++ b/lib/Model/Ingestion/TriggerType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task trigger, describing when a task should run. - `onDemand`. Manually trigger the task with the `/run` endpoint. - `schedule`. Regularly trigger the task on a `cron` schedule. - `subscription`. Trigger the task after an event is received, such as, a webhook. - `streaming`. Run the task continuously. + * @description Task trigger, describing when a task should run. - `onDemand`. Manually trigger the task with the `/run` endpoint. - `schedule`. Regularly trigger the task on a `cron` schedule. - `subscription`. Trigger the task after an event is received, such as, a webhook. - `streaming`. Run the task continuously. */ class TriggerType { diff --git a/lib/Model/Insights/AddedToCartObjectIDs.php b/lib/Model/Insights/AddedToCartObjectIDs.php index 67bb8f87..7f3a6bc5 100644 --- a/lib/Model/Insights/AddedToCartObjectIDs.php +++ b/lib/Model/Insights/AddedToCartObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event. + * @description Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event. */ class AddedToCartObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php b/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php index 9feede99..b1eb17c3 100644 --- a/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php +++ b/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. + * @description Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. */ class AddedToCartObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/ClickedObjectIDs.php b/lib/Model/Insights/ClickedObjectIDs.php index 2d401e56..cd092824 100644 --- a/lib/Model/Insights/ClickedObjectIDs.php +++ b/lib/Model/Insights/ClickedObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event. + * @description Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event. */ class ClickedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/ClickedObjectIDsAfterSearch.php b/lib/Model/Insights/ClickedObjectIDsAfterSearch.php index 2a93ea4d..1cbe2c01 100644 --- a/lib/Model/Insights/ClickedObjectIDsAfterSearch.php +++ b/lib/Model/Insights/ClickedObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event. + * @description Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event. */ class ClickedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/ConvertedObjectIDs.php b/lib/Model/Insights/ConvertedObjectIDs.php index db717a2b..d73d21a5 100644 --- a/lib/Model/Insights/ConvertedObjectIDs.php +++ b/lib/Model/Insights/ConvertedObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event. + * @description Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event. */ class ConvertedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php b/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php index 365ba7e7..92af986d 100644 --- a/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php +++ b/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart. If you're building your category pages with Algolia, you'll also use this event. + * @description Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart. If you're building your category pages with Algolia, you'll also use this event. */ class ConvertedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/Discount.php b/lib/Model/Insights/Discount.php index e550af0b..e01bfc33 100644 --- a/lib/Model/Insights/Discount.php +++ b/lib/Model/Insights/Discount.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Absolute value of the discount for this product, in units of `currency`. + * @description Absolute value of the discount for this product, in units of `currency`. */ class Discount extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/Price.php b/lib/Model/Insights/Price.php index 1d7a7725..7f6d03de 100644 --- a/lib/Model/Insights/Price.php +++ b/lib/Model/Insights/Price.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Total price of a product, including any discounts, in units of `currency`. + * @description Total price of a product, including any discounts, in units of `currency`. */ class Price extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/PurchasedObjectIDs.php b/lib/Model/Insights/PurchasedObjectIDs.php index d9591118..ea6ef409 100644 --- a/lib/Model/Insights/PurchasedObjectIDs.php +++ b/lib/Model/Insights/PurchasedObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia requests, use the \"Purchased object IDs after search\" event. + * @description Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia requests, use the \"Purchased object IDs after search\" event. */ class PurchasedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php b/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php index fdf3ee13..d994a206 100644 --- a/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php +++ b/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. + * @description Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. */ class PurchasedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Insights/Value.php b/lib/Model/Insights/Value.php index cbd41743..d0e32da0 100644 --- a/lib/Model/Insights/Value.php +++ b/lib/Model/Insights/Value.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Total monetary value of this event in units of `currency`. + * @description Total monetary value of this event in units of `currency`. */ class Value extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/QuerySuggestions/LogLevel.php b/lib/Model/QuerySuggestions/LogLevel.php index ab60fe36..1af5b4c9 100644 --- a/lib/Model/QuerySuggestions/LogLevel.php +++ b/lib/Model/QuerySuggestions/LogLevel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Type of log entry. - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error. + * @description Type of log entry. - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error. */ class LogLevel { diff --git a/lib/Model/Recommend/AroundRadius.php b/lib/Model/Recommend/AroundRadius.php index 92fd146b..72935cac 100644 --- a/lib/Model/Recommend/AroundRadius.php +++ b/lib/Model/Recommend/AroundRadius.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. + * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. */ class AroundRadius extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/AroundRadiusAll.php b/lib/Model/Recommend/AroundRadiusAll.php index 9d7e7194..5d713460 100644 --- a/lib/Model/Recommend/AroundRadiusAll.php +++ b/lib/Model/Recommend/AroundRadiusAll.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. + * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. */ class AroundRadiusAll { diff --git a/lib/Model/Recommend/Distinct.php b/lib/Model/Recommend/Distinct.php index 7dc70610..c574cf6b 100644 --- a/lib/Model/Recommend/Distinct.php +++ b/lib/Model/Recommend/Distinct.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. + * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. */ class Distinct extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/ExactOnSingleWordQuery.php b/lib/Model/Recommend/ExactOnSingleWordQuery.php index 1a67b9fc..aa2c05d6 100644 --- a/lib/Model/Recommend/ExactOnSingleWordQuery.php +++ b/lib/Model/Recommend/ExactOnSingleWordQuery.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. + * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. */ class ExactOnSingleWordQuery { diff --git a/lib/Model/Recommend/FacetFilters.php b/lib/Model/Recommend/FacetFilters.php index c1ae7224..ad27e66b 100644 --- a/lib/Model/Recommend/FacetFilters.php +++ b/lib/Model/Recommend/FacetFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. + * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. */ class FacetFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/FbtModel.php b/lib/Model/Recommend/FbtModel.php index 7893f77a..c6b7910c 100644 --- a/lib/Model/Recommend/FbtModel.php +++ b/lib/Model/Recommend/FbtModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID `objectID`. + * @description Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID `objectID`. */ class FbtModel { diff --git a/lib/Model/Recommend/LookingSimilarModel.php b/lib/Model/Recommend/LookingSimilarModel.php index 7292387c..1679db2b 100644 --- a/lib/Model/Recommend/LookingSimilarModel.php +++ b/lib/Model/Recommend/LookingSimilarModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Looking similar model. This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index. + * @description Looking similar model. This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index. */ class LookingSimilarModel { diff --git a/lib/Model/Recommend/NumericFilters.php b/lib/Model/Recommend/NumericFilters.php index d25a211e..1c22a4e5 100644 --- a/lib/Model/Recommend/NumericFilters.php +++ b/lib/Model/Recommend/NumericFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. + * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. */ class NumericFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/OptionalFilters.php b/lib/Model/Recommend/OptionalFilters.php index d69b8762..67e1d371 100644 --- a/lib/Model/Recommend/OptionalFilters.php +++ b/lib/Model/Recommend/OptionalFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. + * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. */ class OptionalFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/QueryType.php b/lib/Model/Recommend/QueryType.php index e76c68e7..674fe677 100644 --- a/lib/Model/Recommend/QueryType.php +++ b/lib/Model/Recommend/QueryType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). + * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). */ class QueryType { diff --git a/lib/Model/Recommend/RankingInfo.php b/lib/Model/Recommend/RankingInfo.php index a534d988..54afcf2a 100644 --- a/lib/Model/Recommend/RankingInfo.php +++ b/lib/Model/Recommend/RankingInfo.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Object with detailed information about the record's ranking. + * @description Object with detailed information about the record's ranking. */ class RankingInfo extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/RecommendedForYouModel.php b/lib/Model/Recommend/RecommendedForYouModel.php index 05030e5b..fd131fbc 100644 --- a/lib/Model/Recommend/RecommendedForYouModel.php +++ b/lib/Model/Recommend/RecommendedForYouModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description \"Recommened for you\" model. + * @description \"Recommened for you\" model. */ class RecommendedForYouModel { diff --git a/lib/Model/Recommend/RelatedModel.php b/lib/Model/Recommend/RelatedModel.php index b0cf9e62..c130399e 100644 --- a/lib/Model/Recommend/RelatedModel.php +++ b/lib/Model/Recommend/RelatedModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Related products or similar content model. This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes. + * @description Related products or similar content model. This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes. */ class RelatedModel { diff --git a/lib/Model/Recommend/RemoveStopWords.php b/lib/Model/Recommend/RemoveStopWords.php index aa4236e5..110d4ef7 100644 --- a/lib/Model/Recommend/RemoveStopWords.php +++ b/lib/Model/Recommend/RemoveStopWords.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. + * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. */ class RemoveStopWords extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/RemoveWordsIfNoResults.php b/lib/Model/Recommend/RemoveWordsIfNoResults.php index 6bc82a73..b7110b86 100644 --- a/lib/Model/Recommend/RemoveWordsIfNoResults.php +++ b/lib/Model/Recommend/RemoveWordsIfNoResults.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). + * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). */ class RemoveWordsIfNoResults { diff --git a/lib/Model/Recommend/SortRemainingBy.php b/lib/Model/Recommend/SortRemainingBy.php index 56674ec4..f0a6c942 100644 --- a/lib/Model/Recommend/SortRemainingBy.php +++ b/lib/Model/Recommend/SortRemainingBy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. + * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. */ class SortRemainingBy { diff --git a/lib/Model/Recommend/TagFilters.php b/lib/Model/Recommend/TagFilters.php index 491e7518..38755843 100644 --- a/lib/Model/Recommend/TagFilters.php +++ b/lib/Model/Recommend/TagFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. + * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. */ class TagFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/TaskStatus.php b/lib/Model/Recommend/TaskStatus.php index 2983ae3c..6a03132c 100644 --- a/lib/Model/Recommend/TaskStatus.php +++ b/lib/Model/Recommend/TaskStatus.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task status, `published` if the task is completed, `notPublished` otherwise. + * @description Task status, `published` if the task is completed, `notPublished` otherwise. */ class TaskStatus { diff --git a/lib/Model/Recommend/TypoTolerance.php b/lib/Model/Recommend/TypoTolerance.php index 9616409b..24cecfa9 100644 --- a/lib/Model/Recommend/TypoTolerance.php +++ b/lib/Model/Recommend/TypoTolerance.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. + * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. */ class TypoTolerance extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Recommend/TypoToleranceEnum.php b/lib/Model/Recommend/TypoToleranceEnum.php index 4477eb6e..41e4d49b 100644 --- a/lib/Model/Recommend/TypoToleranceEnum.php +++ b/lib/Model/Recommend/TypoToleranceEnum.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. + * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. */ class TypoToleranceEnum { diff --git a/lib/Model/Search/Anchoring.php b/lib/Model/Search/Anchoring.php index c86c9006..d367cce1 100644 --- a/lib/Model/Search/Anchoring.php +++ b/lib/Model/Search/Anchoring.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. + * @description Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. */ class Anchoring { diff --git a/lib/Model/Search/AroundRadius.php b/lib/Model/Search/AroundRadius.php index 299de4f5..1e32c05b 100644 --- a/lib/Model/Search/AroundRadius.php +++ b/lib/Model/Search/AroundRadius.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. + * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. */ class AroundRadius extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/AroundRadiusAll.php b/lib/Model/Search/AroundRadiusAll.php index 318fe0db..c95350e5 100644 --- a/lib/Model/Search/AroundRadiusAll.php +++ b/lib/Model/Search/AroundRadiusAll.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. + * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. */ class AroundRadiusAll { diff --git a/lib/Model/Search/AutomaticFacetFilters.php b/lib/Model/Search/AutomaticFacetFilters.php index 07e235f2..7677ec70 100644 --- a/lib/Model/Search/AutomaticFacetFilters.php +++ b/lib/Model/Search/AutomaticFacetFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter to be applied to the search. You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies. + * @description Filter to be applied to the search. You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies. */ class AutomaticFacetFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/ConsequenceQuery.php b/lib/Model/Search/ConsequenceQuery.php index 37a58b41..624b1da8 100644 --- a/lib/Model/Search/ConsequenceQuery.php +++ b/lib/Model/Search/ConsequenceQuery.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query. + * @description Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query. */ class ConsequenceQuery extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/DictionaryLanguage.php b/lib/Model/Search/DictionaryLanguage.php index 51b32408..b461ca11 100644 --- a/lib/Model/Search/DictionaryLanguage.php +++ b/lib/Model/Search/DictionaryLanguage.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Dictionary type. If `null`, this dictionary type isn't supported for the language. + * @description Dictionary type. If `null`, this dictionary type isn't supported for the language. */ class DictionaryLanguage extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/Distinct.php b/lib/Model/Search/Distinct.php index a89c9924..3220717a 100644 --- a/lib/Model/Search/Distinct.php +++ b/lib/Model/Search/Distinct.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. + * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. */ class Distinct extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/ExactOnSingleWordQuery.php b/lib/Model/Search/ExactOnSingleWordQuery.php index 0c7a38ff..1e334153 100644 --- a/lib/Model/Search/ExactOnSingleWordQuery.php +++ b/lib/Model/Search/ExactOnSingleWordQuery.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. + * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. */ class ExactOnSingleWordQuery { diff --git a/lib/Model/Search/FacetFilters.php b/lib/Model/Search/FacetFilters.php index d6eef00f..8b6c0469 100644 --- a/lib/Model/Search/FacetFilters.php +++ b/lib/Model/Search/FacetFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. + * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. */ class FacetFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/NumericFilters.php b/lib/Model/Search/NumericFilters.php index 4aa98280..9c86f216 100644 --- a/lib/Model/Search/NumericFilters.php +++ b/lib/Model/Search/NumericFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. + * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. */ class NumericFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/OptionalFilters.php b/lib/Model/Search/OptionalFilters.php index c7721219..db490885 100644 --- a/lib/Model/Search/OptionalFilters.php +++ b/lib/Model/Search/OptionalFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. + * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. */ class OptionalFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/QueryType.php b/lib/Model/Search/QueryType.php index 15e14f49..1a9924e9 100644 --- a/lib/Model/Search/QueryType.php +++ b/lib/Model/Search/QueryType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). + * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). */ class QueryType { diff --git a/lib/Model/Search/RankingInfo.php b/lib/Model/Search/RankingInfo.php index 89fd9512..bfadf432 100644 --- a/lib/Model/Search/RankingInfo.php +++ b/lib/Model/Search/RankingInfo.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Object with detailed information about the record's ranking. + * @description Object with detailed information about the record's ranking. */ class RankingInfo extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/RemoveStopWords.php b/lib/Model/Search/RemoveStopWords.php index 274b4d0a..7d2318ac 100644 --- a/lib/Model/Search/RemoveStopWords.php +++ b/lib/Model/Search/RemoveStopWords.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. + * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. */ class RemoveStopWords extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/RemoveWordsIfNoResults.php b/lib/Model/Search/RemoveWordsIfNoResults.php index c7390c40..edd11a2f 100644 --- a/lib/Model/Search/RemoveWordsIfNoResults.php +++ b/lib/Model/Search/RemoveWordsIfNoResults.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). + * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). */ class RemoveWordsIfNoResults { diff --git a/lib/Model/Search/SearchParamsObject.php b/lib/Model/Search/SearchParamsObject.php index 756a45df..c599e202 100644 --- a/lib/Model/Search/SearchParamsObject.php +++ b/lib/Model/Search/SearchParamsObject.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Each parameter value, including the `query` must not be larger than 512 bytes. + * @description Each parameter value, including the `query` must not be larger than 512 bytes. */ class SearchParamsObject extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/SearchStrategy.php b/lib/Model/Search/SearchStrategy.php index 19333c7f..61f990e4 100644 --- a/lib/Model/Search/SearchStrategy.php +++ b/lib/Model/Search/SearchStrategy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results. + * @description Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results. */ class SearchStrategy { diff --git a/lib/Model/Search/SearchTypeDefault.php b/lib/Model/Search/SearchTypeDefault.php index d03ae549..da710098 100644 --- a/lib/Model/Search/SearchTypeDefault.php +++ b/lib/Model/Search/SearchTypeDefault.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). */ class SearchTypeDefault { diff --git a/lib/Model/Search/SearchTypeFacet.php b/lib/Model/Search/SearchTypeFacet.php index 944627c5..72b23ad1 100644 --- a/lib/Model/Search/SearchTypeFacet.php +++ b/lib/Model/Search/SearchTypeFacet.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). */ class SearchTypeFacet { diff --git a/lib/Model/Search/SemanticSearch.php b/lib/Model/Search/SemanticSearch.php index 4339ee1b..59c8f70f 100644 --- a/lib/Model/Search/SemanticSearch.php +++ b/lib/Model/Search/SemanticSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. + * @description Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. */ class SemanticSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/SortRemainingBy.php b/lib/Model/Search/SortRemainingBy.php index 00bdeb5f..5d51e550 100644 --- a/lib/Model/Search/SortRemainingBy.php +++ b/lib/Model/Search/SortRemainingBy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. + * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. */ class SortRemainingBy { diff --git a/lib/Model/Search/TagFilters.php b/lib/Model/Search/TagFilters.php index 0f840fd0..857288c7 100644 --- a/lib/Model/Search/TagFilters.php +++ b/lib/Model/Search/TagFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. + * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. */ class TagFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/TaskStatus.php b/lib/Model/Search/TaskStatus.php index 3bd916c1..3edcbaf2 100644 --- a/lib/Model/Search/TaskStatus.php +++ b/lib/Model/Search/TaskStatus.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task status, `published` if the task is completed, `notPublished` otherwise. + * @description Task status, `published` if the task is completed, `notPublished` otherwise. */ class TaskStatus { diff --git a/lib/Model/Search/TypoTolerance.php b/lib/Model/Search/TypoTolerance.php index 5b6430ac..1f41e1fa 100644 --- a/lib/Model/Search/TypoTolerance.php +++ b/lib/Model/Search/TypoTolerance.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. + * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. */ class TypoTolerance extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/lib/Model/Search/TypoToleranceEnum.php b/lib/Model/Search/TypoToleranceEnum.php index 99c8ad4e..aa05374a 100644 --- a/lib/Model/Search/TypoToleranceEnum.php +++ b/lib/Model/Search/TypoToleranceEnum.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. + * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. */ class TypoToleranceEnum {