From 1348fd869db7b3945d55d8617d5c78dd02386bed Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Fri, 17 May 2024 10:16:41 +0000 Subject: [PATCH] chore: release 9.0.0-beta.2 Co-authored-by: algolia-bot Co-authored-by: Thomas Raffray --- .openapi-generator/FILES | 179 ++---------------- AlgoliaSearchClient.podspec | 4 +- CHANGELOG.md | 6 + Sources/Core/Helpers/Version.swift | 2 +- .../Models/DestinationIndexName.swift | 2 +- Sources/Recommend/Models/FallbackParams.swift | 6 +- .../Recommend/Models/ParamsConsequence.swift | 2 +- .../Models/RecommendBaseSearchParams.swift | 2 +- ...ecommendBaseSearchParamsWithoutQuery.swift | 2 +- .../Recommend/Models/RecommendCondition.swift | 2 +- ...RecommendIndexSettingsAsSearchParams.swift | 4 +- .../Recommend/Models/RecommendQueryType.swift | 2 +- .../Models/RecommendSearchParams.swift | 6 +- .../Models/RecommendSearchParamsObject.swift | 6 +- .../Models/RecommendSortRemainingBy.swift | 2 +- Sources/Usage/UsageClient.swift | 32 ++-- 16 files changed, 54 insertions(+), 205 deletions(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 4988cb212..9a64fdd53 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -1,171 +1,14 @@ -.openapi-generator-ignore AlgoliaSearchClient.podspec Package.swift Sources/Core/Helpers/Version.swift -Sources/Search/Models/Acl.swift -Sources/Search/Models/Action.swift -Sources/Search/Models/AddApiKeyResponse.swift -Sources/Search/Models/ApiKey.swift -Sources/Search/Models/ApiKeyOperation.swift -Sources/Search/Models/AssignUserIdParams.swift -Sources/Search/Models/AttributeToUpdate.swift -Sources/Search/Models/BaseGetApiKeyResponse.swift -Sources/Search/Models/BaseIndexSettings.swift -Sources/Search/Models/BatchAssignUserIdsParams.swift -Sources/Search/Models/BatchDictionaryEntriesParams.swift -Sources/Search/Models/BatchDictionaryEntriesRequest.swift -Sources/Search/Models/BatchParams.swift -Sources/Search/Models/BatchRequest.swift -Sources/Search/Models/BatchResponse.swift -Sources/Search/Models/BatchWriteParams.swift -Sources/Search/Models/BrowseParams.swift -Sources/Search/Models/BrowseParamsObject.swift -Sources/Search/Models/BrowseResponse.swift -Sources/Search/Models/BuiltInOperation.swift -Sources/Search/Models/BuiltInOperationType.swift -Sources/Search/Models/CreatedAtResponse.swift -Sources/Search/Models/Cursor.swift -Sources/Search/Models/DeleteApiKeyResponse.swift -Sources/Search/Models/DeleteByParams.swift -Sources/Search/Models/DeleteSourceResponse.swift -Sources/Search/Models/DictionaryAction.swift -Sources/Search/Models/DictionaryEntry.swift -Sources/Search/Models/DictionaryEntryState.swift -Sources/Search/Models/DictionaryLanguage.swift -Sources/Search/Models/DictionarySettingsParams.swift -Sources/Search/Models/DictionaryType.swift -Sources/Search/Models/FacetHits.swift -Sources/Search/Models/FetchedIndex.swift -Sources/Search/Models/GetApiKeyResponse.swift -Sources/Search/Models/GetDictionarySettingsResponse.swift -Sources/Search/Models/GetLogsResponse.swift -Sources/Search/Models/GetObjectsParams.swift -Sources/Search/Models/GetObjectsRequest.swift -Sources/Search/Models/GetObjectsResponse.swift -Sources/Search/Models/GetTaskResponse.swift -Sources/Search/Models/GetTopUserIdsResponse.swift -Sources/Search/Models/HasPendingMappingsResponse.swift -Sources/Search/Models/Hit.swift -Sources/Search/Models/IndexSettings.swift -Sources/Search/Models/ListApiKeysResponse.swift -Sources/Search/Models/ListClustersResponse.swift -Sources/Search/Models/ListIndicesResponse.swift -Sources/Search/Models/ListUserIdsResponse.swift -Sources/Search/Models/Log.swift -Sources/Search/Models/LogQuery.swift -Sources/Search/Models/LogType.swift -Sources/Search/Models/MultipleBatchRequest.swift -Sources/Search/Models/MultipleBatchResponse.swift -Sources/Search/Models/OperationIndexParams.swift -Sources/Search/Models/OperationType.swift -Sources/Search/Models/RemoveUserIdResponse.swift -Sources/Search/Models/ReplaceSourceResponse.swift -Sources/Search/Models/Rule.swift -Sources/Search/Models/SaveObjectResponse.swift -Sources/Search/Models/SaveSynonymResponse.swift -Sources/Search/Models/ScopeType.swift -Sources/Search/Models/SearchAdvancedSyntaxFeatures.swift -Sources/Search/Models/SearchAlternativesAsExact.swift -Sources/Search/Models/SearchAnchoring.swift -Sources/Search/Models/SearchAroundPrecision.swift -Sources/Search/Models/SearchAroundPrecisionFromValueInner.swift -Sources/Search/Models/SearchAroundRadius.swift -Sources/Search/Models/SearchAroundRadiusAll.swift -Sources/Search/Models/SearchAutomaticFacetFilter.swift -Sources/Search/Models/SearchAutomaticFacetFilters.swift -Sources/Search/Models/SearchBaseSearchParams.swift -Sources/Search/Models/SearchBaseSearchParamsWithoutQuery.swift -Sources/Search/Models/SearchBaseSearchResponse.swift -Sources/Search/Models/SearchCondition.swift -Sources/Search/Models/SearchConsequence.swift -Sources/Search/Models/SearchConsequenceHide.swift -Sources/Search/Models/SearchConsequenceParams.swift -Sources/Search/Models/SearchConsequenceQuery.swift -Sources/Search/Models/SearchConsequenceQueryObject.swift -Sources/Search/Models/SearchDeletedAtResponse.swift -Sources/Search/Models/SearchDictionaryEntriesParams.swift -Sources/Search/Models/SearchDictionaryEntriesResponse.swift -Sources/Search/Models/SearchDistinct.swift -Sources/Search/Models/SearchEdit.swift -Sources/Search/Models/SearchEditType.swift -Sources/Search/Models/SearchErrorBase.swift -Sources/Search/Models/SearchExactOnSingleWordQuery.swift -Sources/Search/Models/SearchExhaustive.swift -Sources/Search/Models/SearchFacetFilters.swift -Sources/Search/Models/SearchFacetOrdering.swift -Sources/Search/Models/SearchFacets.swift -Sources/Search/Models/SearchFacetsStats.swift -Sources/Search/Models/SearchForFacetValuesRequest.swift -Sources/Search/Models/SearchForFacetValuesResponse.swift -Sources/Search/Models/SearchForFacets.swift -Sources/Search/Models/SearchForFacetsOptions.swift -Sources/Search/Models/SearchForHits.swift -Sources/Search/Models/SearchForHitsOptions.swift -Sources/Search/Models/SearchHighlightResult.swift -Sources/Search/Models/SearchHighlightResultOption.swift -Sources/Search/Models/SearchHits.swift -Sources/Search/Models/SearchIgnorePlurals.swift -Sources/Search/Models/SearchIndexSettingsAsSearchParams.swift -Sources/Search/Models/SearchLanguages.swift -Sources/Search/Models/SearchMatchLevel.swift -Sources/Search/Models/SearchMatchedGeoLocation.swift -Sources/Search/Models/SearchMethodParams.swift -Sources/Search/Models/SearchMode.swift -Sources/Search/Models/SearchNumericFilters.swift -Sources/Search/Models/SearchOptionalFilters.swift -Sources/Search/Models/SearchParams.swift -Sources/Search/Models/SearchParamsString.swift -Sources/Search/Models/SearchPersonalization.swift -Sources/Search/Models/SearchPromote.swift -Sources/Search/Models/SearchPromoteObjectID.swift -Sources/Search/Models/SearchPromoteObjectIDs.swift -Sources/Search/Models/SearchQuery.swift -Sources/Search/Models/SearchQueryType.swift -Sources/Search/Models/SearchRankingInfo.swift -Sources/Search/Models/SearchReRankingApplyFilter.swift -Sources/Search/Models/SearchRedirect.swift -Sources/Search/Models/SearchRedirectRuleIndexMetadata.swift -Sources/Search/Models/SearchRedirectRuleIndexMetadataData.swift -Sources/Search/Models/SearchRemoveStopWords.swift -Sources/Search/Models/SearchRemoveWordsIfNoResults.swift -Sources/Search/Models/SearchRenderingContent.swift -Sources/Search/Models/SearchResponse.swift -Sources/Search/Models/SearchResponses.swift -Sources/Search/Models/SearchResult.swift -Sources/Search/Models/SearchRulesParams.swift -Sources/Search/Models/SearchRulesResponse.swift -Sources/Search/Models/SearchSearchParams.swift -Sources/Search/Models/SearchSearchParamsObject.swift -Sources/Search/Models/SearchSearchParamsQuery.swift -Sources/Search/Models/SearchSemanticSearch.swift -Sources/Search/Models/SearchSnippetResult.swift -Sources/Search/Models/SearchSnippetResultOption.swift -Sources/Search/Models/SearchSortRemainingBy.swift -Sources/Search/Models/SearchSource.swift -Sources/Search/Models/SearchStrategy.swift -Sources/Search/Models/SearchSupportedLanguage.swift -Sources/Search/Models/SearchSynonymsParams.swift -Sources/Search/Models/SearchSynonymsResponse.swift -Sources/Search/Models/SearchTagFilters.swift -Sources/Search/Models/SearchTaskStatus.swift -Sources/Search/Models/SearchTypeDefault.swift -Sources/Search/Models/SearchTypeFacet.swift -Sources/Search/Models/SearchTypoTolerance.swift -Sources/Search/Models/SearchTypoToleranceEnum.swift -Sources/Search/Models/SearchUserIdsParams.swift -Sources/Search/Models/SearchUserIdsResponse.swift -Sources/Search/Models/SearchValue.swift -Sources/Search/Models/SecuredAPIKeyRestrictions.swift -Sources/Search/Models/StandardEntries.swift -Sources/Search/Models/SynonymHit.swift -Sources/Search/Models/SynonymType.swift -Sources/Search/Models/TimeRange.swift -Sources/Search/Models/UpdateApiKeyResponse.swift -Sources/Search/Models/UpdatedAtResponse.swift -Sources/Search/Models/UpdatedAtWithObjectIdResponse.swift -Sources/Search/Models/UpdatedRuleResponse.swift -Sources/Search/Models/UserHighlightResult.swift -Sources/Search/Models/UserHit.swift -Sources/Search/Models/UserId.swift -Sources/Search/SearchClient.swift -Sources/Search/SearchClientConfiguration.swift +Sources/Usage/Models/GetUsage200Response.swift +Sources/Usage/Models/GetUsage200ResponseStatisticsInner.swift +Sources/Usage/Models/GetUsage400Response.swift +Sources/Usage/Models/GetUsage400ResponseError.swift +Sources/Usage/Models/GetUsage400ResponseErrorErrorsInner.swift +Sources/Usage/Models/Granularity.swift +Sources/Usage/Models/Statistic.swift +Sources/Usage/Models/StatisticValue.swift +Sources/Usage/Models/UsageErrorBase.swift +Sources/Usage/UsageClient.swift +Sources/Usage/UsageClientConfiguration.swift diff --git a/AlgoliaSearchClient.podspec b/AlgoliaSearchClient.podspec index e3b5b2448..fbc506a11 100644 --- a/AlgoliaSearchClient.podspec +++ b/AlgoliaSearchClient.podspec @@ -1,8 +1,8 @@ Pod::Spec.new do |s| s.name = 'AlgoliaSearchClient' s.module_name = 'AlgoliaSearchClient' - s.version = '9.0.0-beta.1' - s.source = { :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :tag => '9.0.0-beta.1' } + s.version = '9.0.0-beta.2' + s.source = { :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :tag => '9.0.0-beta.2' } s.authors = { 'Algolia' => 'contact@algolia.com' } s.license = { :type => 'MIT', :file => 'LICENSE' } s.homepage = 'https://github.com/algolia/algoliasearch-client-swift/tree/next' diff --git a/CHANGELOG.md b/CHANGELOG.md index 818306179..3fdd3a929 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [9.0.0-beta.2](https://github.com/algolia/algoliasearch-client-swift/compare/9.0.0-beta.1...9.0.0-beta.2) + +- [2b70d9ea5](https://github.com/algolia/api-clients-automation/commit/2b70d9ea5) fix(specs): exhaustiveFacetsCount is not deprecated for sffv ([#3089](https://github.com/algolia/api-clients-automation/pull/3089)) by [@kai687](https://github.com/kai687/) +- [1250c2b3c](https://github.com/algolia/api-clients-automation/commit/1250c2b3c) fix(specs): simplify filter types ([#3042](https://github.com/algolia/api-clients-automation/pull/3042)) by [@millotp](https://github.com/millotp/) +- [3aaa27710](https://github.com/algolia/api-clients-automation/commit/3aaa27710) chore(swift): add privacy manifest ([#3039](https://github.com/algolia/api-clients-automation/pull/3039)) by [@Fluf22](https://github.com/Fluf22/) + ## [9.0.0-beta.1](https://github.com/algolia/algoliasearch-client-swift/compare/9.0.0-beta.0...9.0.0-beta.1) - [b621988bc](https://github.com/algolia/api-clients-automation/commit/b621988bc) feat(specs): promote @kai687 to code owner ([#3014](https://github.com/algolia/api-clients-automation/pull/3014)) by [@Fluf22](https://github.com/Fluf22/) diff --git a/Sources/Core/Helpers/Version.swift b/Sources/Core/Helpers/Version.swift index 191d9a7ba..161c1faee 100644 --- a/Sources/Core/Helpers/Version.swift +++ b/Sources/Core/Helpers/Version.swift @@ -48,5 +48,5 @@ extension Version: CustomStringConvertible { } public extension Version { - static let current: Version = .init(version: "9.0.0-beta.1") + static let current: Version = .init(version: "9.0.0-beta.2") } diff --git a/Sources/Ingestion/Models/DestinationIndexName.swift b/Sources/Ingestion/Models/DestinationIndexName.swift index 225f86cde..061256387 100644 --- a/Sources/Ingestion/Models/DestinationIndexName.swift +++ b/Sources/Ingestion/Models/DestinationIndexName.swift @@ -13,7 +13,7 @@ public struct DestinationIndexName: Codable, JSONEncodable { /// Attributes from your source to exclude from Algolia records. Not all your data attributes will be useful for /// searching. Keeping your Algolia records small increases indexing and search performance. - Exclude nested /// attributes with `.` notation. For example, `foo.bar` indexes the `foo` attribute and all its children **except** - /// the `bar` attribute. - Exclude attributes from arrays with `[i]`, where `i` is the index of the array element. + /// the `bar` attribute. - Exclude attributes from arrays with `[i]`, where `i` is the index of the array element. /// For example, `foo.[0].bar` only excludes the `bar` attribute from the first element of the `foo` array, but /// indexes the complete `foo` attribute for all other elements. Use `*` as wildcard: `foo.[*].bar` excludes `bar` /// from all elements of the `foo` array. diff --git a/Sources/Recommend/Models/FallbackParams.swift b/Sources/Recommend/Models/FallbackParams.swift index c8d695603..04da46399 100644 --- a/Sources/Recommend/Models/FallbackParams.swift +++ b/Sources/Recommend/Models/FallbackParams.swift @@ -21,7 +21,7 @@ public struct FallbackParams: Codable, JSONEncodable { /// upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet /// attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` /// (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and - /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. + /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. /// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not /// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not /// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet @@ -221,7 +221,7 @@ public struct FallbackParams: Codable, JSONEncodable { /// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - /// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches. public var alternativesAsExact: [RecommendAlternativesAsExact]? - /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. + /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. /// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". - /// `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` /// matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax` @@ -261,7 +261,7 @@ public struct FallbackParams: Codable, JSONEncodable { /// attribute is determined by the order in the `searchableAttributes` setting. public var attributeCriteriaComputedByMinProximity: Bool? public var renderingContent: RecommendRenderingContent? - /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). + /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). /// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. public var enableReRanking: Bool? public var reRankingApplyFilter: RecommendReRankingApplyFilter? diff --git a/Sources/Recommend/Models/ParamsConsequence.swift b/Sources/Recommend/Models/ParamsConsequence.swift index 19e76c141..69a4e3443 100644 --- a/Sources/Recommend/Models/ParamsConsequence.swift +++ b/Sources/Recommend/Models/ParamsConsequence.swift @@ -16,7 +16,7 @@ public struct ParamsConsequence: Codable, JSONEncodable { /// upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet /// attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` /// (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and - /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. + /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. /// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not /// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not /// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet diff --git a/Sources/Recommend/Models/RecommendBaseSearchParams.swift b/Sources/Recommend/Models/RecommendBaseSearchParams.swift index f74ac05c8..cb6e117d2 100644 --- a/Sources/Recommend/Models/RecommendBaseSearchParams.swift +++ b/Sources/Recommend/Models/RecommendBaseSearchParams.swift @@ -21,7 +21,7 @@ public struct RecommendBaseSearchParams: Codable, JSONEncodable { /// upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet /// attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` /// (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and - /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. + /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. /// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not /// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not /// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet diff --git a/Sources/Recommend/Models/RecommendBaseSearchParamsWithoutQuery.swift b/Sources/Recommend/Models/RecommendBaseSearchParamsWithoutQuery.swift index e7389437c..88e3bd7fc 100644 --- a/Sources/Recommend/Models/RecommendBaseSearchParamsWithoutQuery.swift +++ b/Sources/Recommend/Models/RecommendBaseSearchParamsWithoutQuery.swift @@ -19,7 +19,7 @@ public struct RecommendBaseSearchParamsWithoutQuery: Codable, JSONEncodable { /// upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet /// attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` /// (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and - /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. + /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. /// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not /// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not /// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet diff --git a/Sources/Recommend/Models/RecommendCondition.swift b/Sources/Recommend/Models/RecommendCondition.swift index 8b71b27eb..155022f98 100644 --- a/Sources/Recommend/Models/RecommendCondition.swift +++ b/Sources/Recommend/Models/RecommendCondition.swift @@ -14,7 +14,7 @@ public struct RecommendCondition: Codable, JSONEncodable { /// upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet /// attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` /// (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and - /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. + /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. /// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not /// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not /// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet diff --git a/Sources/Recommend/Models/RecommendIndexSettingsAsSearchParams.swift b/Sources/Recommend/Models/RecommendIndexSettingsAsSearchParams.swift index 566e6894e..eedab2d87 100644 --- a/Sources/Recommend/Models/RecommendIndexSettingsAsSearchParams.swift +++ b/Sources/Recommend/Models/RecommendIndexSettingsAsSearchParams.swift @@ -125,7 +125,7 @@ public struct RecommendIndexSettingsAsSearchParams: Codable, JSONEncodable { /// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - /// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches. public var alternativesAsExact: [RecommendAlternativesAsExact]? - /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. + /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. /// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". - /// `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` /// matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax` @@ -165,7 +165,7 @@ public struct RecommendIndexSettingsAsSearchParams: Codable, JSONEncodable { /// attribute is determined by the order in the `searchableAttributes` setting. public var attributeCriteriaComputedByMinProximity: Bool? public var renderingContent: RecommendRenderingContent? - /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). + /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). /// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. public var enableReRanking: Bool? public var reRankingApplyFilter: RecommendReRankingApplyFilter? diff --git a/Sources/Recommend/Models/RecommendQueryType.swift b/Sources/Recommend/Models/RecommendQueryType.swift index 2de4217aa..909344a88 100644 --- a/Sources/Recommend/Models/RecommendQueryType.swift +++ b/Sources/Recommend/Models/RecommendQueryType.swift @@ -8,7 +8,7 @@ import Foundation /// Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as /// 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. +/// 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/). public enum RecommendQueryType: String, Codable, CaseIterable { case prefixLast diff --git a/Sources/Recommend/Models/RecommendSearchParams.swift b/Sources/Recommend/Models/RecommendSearchParams.swift index 1ecb92601..692b93c87 100644 --- a/Sources/Recommend/Models/RecommendSearchParams.swift +++ b/Sources/Recommend/Models/RecommendSearchParams.swift @@ -21,7 +21,7 @@ public struct RecommendSearchParams: Codable, JSONEncodable { /// upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet /// attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` /// (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and - /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. + /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. /// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not /// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not /// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet @@ -221,7 +221,7 @@ public struct RecommendSearchParams: Codable, JSONEncodable { /// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - /// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches. public var alternativesAsExact: [RecommendAlternativesAsExact]? - /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. + /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. /// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". - /// `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` /// matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax` @@ -261,7 +261,7 @@ public struct RecommendSearchParams: Codable, JSONEncodable { /// attribute is determined by the order in the `searchableAttributes` setting. public var attributeCriteriaComputedByMinProximity: Bool? public var renderingContent: RecommendRenderingContent? - /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). + /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). /// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. public var enableReRanking: Bool? public var reRankingApplyFilter: RecommendReRankingApplyFilter? diff --git a/Sources/Recommend/Models/RecommendSearchParamsObject.swift b/Sources/Recommend/Models/RecommendSearchParamsObject.swift index d5801c73e..ab1dfb256 100644 --- a/Sources/Recommend/Models/RecommendSearchParamsObject.swift +++ b/Sources/Recommend/Models/RecommendSearchParamsObject.swift @@ -22,7 +22,7 @@ public struct RecommendSearchParamsObject: Codable, JSONEncodable { /// upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet /// attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` /// (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and - /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. + /// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. /// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not /// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not /// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet @@ -222,7 +222,7 @@ public struct RecommendSearchParamsObject: Codable, JSONEncodable { /// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - /// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches. public var alternativesAsExact: [RecommendAlternativesAsExact]? - /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. + /// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. /// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". - /// `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` /// matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax` @@ -262,7 +262,7 @@ public struct RecommendSearchParamsObject: Codable, JSONEncodable { /// attribute is determined by the order in the `searchableAttributes` setting. public var attributeCriteriaComputedByMinProximity: Bool? public var renderingContent: RecommendRenderingContent? - /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). + /// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). /// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. public var enableReRanking: Bool? public var reRankingApplyFilter: RecommendReRankingApplyFilter? diff --git a/Sources/Recommend/Models/RecommendSortRemainingBy.swift b/Sources/Recommend/Models/RecommendSortRemainingBy.swift index 9909b00dc..a22b42d71 100644 --- a/Sources/Recommend/Models/RecommendSortRemainingBy.swift +++ b/Sources/Recommend/Models/RecommendSortRemainingBy.swift @@ -8,7 +8,7 @@ import Foundation /// 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`. +/// containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. /// Don't show facet values that aren't explicitly positioned. public enum RecommendSortRemainingBy: String, Codable, CaseIterable { case count diff --git a/Sources/Usage/UsageClient.swift b/Sources/Usage/UsageClient.swift index dafbe936a..a605f6ce4 100644 --- a/Sources/Usage/UsageClient.swift +++ b/Sources/Usage/UsageClient.swift @@ -318,7 +318,7 @@ open class UsageClient { /// operations. - `set_settings_operations`. Number of [set /// settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. /// Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - - /// `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. + /// `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. /// **Record operations** - `record_operations`. All record operations. - /// `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number /// of @@ -377,7 +377,7 @@ open class UsageClient { /// - /// `90p_processing_time`. 90th percentile of processing time (in milliseconds). - /// `99p_processing_time`. 99th percentile of processing time (in milliseconds). - - /// `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. + /// `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. /// **Indices** - `records`. Number of records. - `data_size`. The size of the records (in /// bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per /// second** - `max_qps`. [Maximum queries per @@ -390,7 +390,7 @@ open class UsageClient { /// server. - `region_used_search_capacity`. Maximum search capacity used per region. - /// `region_avg_used_search_capacity`. Average search capacity used per region. - /// `total_used_search_capacity`. Maximum search capacity used for all servers. - - /// `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** + /// `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** /// Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - /// `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search /// engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. @@ -402,7 +402,7 @@ open class UsageClient { /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. /// - parameter granularity: (query) Granularity of the aggregated metrics. - `hourly`: the maximum time - /// range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. + /// range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. /// (optional) /// - returns: GetUsage200Response @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *) @@ -462,7 +462,7 @@ open class UsageClient { // operations. - `set_settings_operations`. Number of [set // settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. // Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - - // `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. + // `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. // **Record operations** - `record_operations`. All record operations. - // `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number // of @@ -518,7 +518,7 @@ open class UsageClient { // operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - // `90p_processing_time`. 90th percentile of processing time (in milliseconds). - // `99p_processing_time`. 99th percentile of processing time (in milliseconds). - - // `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. + // `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. // **Indices** - `records`. Number of records. - `data_size`. The size of the records (in // bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per // second** - `max_qps`. [Maximum queries per @@ -530,7 +530,7 @@ open class UsageClient { // server. - `region_used_search_capacity`. Maximum search capacity used per region. - // `region_avg_used_search_capacity`. Average search capacity used per region. - // `total_used_search_capacity`. Maximum search capacity used for all servers. - - // `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** + // `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** // Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - // `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search // engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. @@ -546,7 +546,7 @@ open class UsageClient { // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. // // - parameter granularity: (query) Granularity of the aggregated metrics. - `hourly`: the maximum time - // range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. + // range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. // (optional) // - returns: RequestBuilder @@ -639,7 +639,7 @@ open class UsageClient { /// operations. - `set_settings_operations`. Number of [set /// settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. /// Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - - /// `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. + /// `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. /// **Record operations** - `record_operations`. All record operations. - /// `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number /// of @@ -698,7 +698,7 @@ open class UsageClient { /// - /// `90p_processing_time`. 90th percentile of processing time (in milliseconds). - /// `99p_processing_time`. 99th percentile of processing time (in milliseconds). - - /// `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. + /// `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. /// **Indices** - `records`. Number of records. - `data_size`. The size of the records (in /// bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per /// second** - `max_qps`. [Maximum queries per @@ -711,7 +711,7 @@ open class UsageClient { /// server. - `region_used_search_capacity`. Maximum search capacity used per region. - /// `region_avg_used_search_capacity`. Average search capacity used per region. - /// `total_used_search_capacity`. Maximum search capacity used for all servers. - - /// `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** + /// `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** /// Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - /// `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search /// engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. @@ -722,7 +722,7 @@ open class UsageClient { /// - parameter startDate: (query) Start date of the period to analyze, in `YYYY-MM-DD` format. /// - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. /// - parameter granularity: (query) Granularity of the aggregated metrics. - `hourly`: the maximum time - /// range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. + /// range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. /// (optional) /// - returns: GetUsage200Response @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *) @@ -780,7 +780,7 @@ open class UsageClient { // operations. - `set_settings_operations`. Number of [set // settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. // Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - - // `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. + // `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. // **Record operations** - `record_operations`. All record operations. - // `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number // of @@ -836,7 +836,7 @@ open class UsageClient { // operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - // `90p_processing_time`. 90th percentile of processing time (in milliseconds). - // `99p_processing_time`. 99th percentile of processing time (in milliseconds). - - // `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. + // `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. // **Indices** - `records`. Number of records. - `data_size`. The size of the records (in // bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per // second** - `max_qps`. [Maximum queries per @@ -848,7 +848,7 @@ open class UsageClient { // server. - `region_used_search_capacity`. Maximum search capacity used per region. - // `region_avg_used_search_capacity`. Average search capacity used per region. - // `total_used_search_capacity`. Maximum search capacity used for all servers. - - // `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** + // `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** // Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - // `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search // engine having to read from the server's SSD. - `degraded_queries_ssd_used_seconds_impacted`. @@ -862,7 +862,7 @@ open class UsageClient { // - parameter endDate: (query) End date of the period to analyze, in `YYYY-MM-DD` format. // // - parameter granularity: (query) Granularity of the aggregated metrics. - `hourly`: the maximum time - // range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. + // range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. // (optional) // - returns: RequestBuilder