@algolia/client-search 5.0.0-alpha.1 → 5.0.0-alpha.100
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/builds/browser.d.ts +5 -5
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +5 -5
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/{client-search.cjs.js → client-search.cjs} +2116 -1869
- package/dist/client-search.esm.browser.js +2356 -2137
- package/dist/client-search.esm.node.js +2117 -1868
- package/dist/client-search.umd.js +2 -2
- package/dist/model/acl.d.ts +4 -1
- package/dist/model/acl.d.ts.map +1 -1
- package/dist/model/action.d.ts +4 -4
- package/dist/model/action.d.ts.map +1 -1
- package/dist/model/addApiKeyResponse.d.ts +10 -10
- package/dist/model/addApiKeyResponse.d.ts.map +1 -1
- package/dist/model/advancedSyntaxFeatures.d.ts +1 -1
- package/dist/model/advancedSyntaxFeatures.d.ts.map +1 -1
- package/dist/model/alternativesAsExact.d.ts +1 -1
- package/dist/model/alternativesAsExact.d.ts.map +1 -1
- package/dist/model/anchoring.d.ts +4 -4
- package/dist/model/anchoring.d.ts.map +1 -1
- package/dist/model/apiKey.d.ts +38 -38
- package/dist/model/apiKey.d.ts.map +1 -1
- package/dist/model/aroundPrecision.d.ts +6 -0
- package/dist/model/aroundPrecision.d.ts.map +1 -0
- package/dist/model/aroundPrecisionFromValueInner.d.ts +5 -0
- package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -0
- package/dist/model/aroundRadius.d.ts +5 -5
- package/dist/model/aroundRadius.d.ts.map +1 -1
- package/dist/model/aroundRadiusAll.d.ts +1 -1
- package/dist/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/model/assignUserIdParams.d.ts +9 -9
- package/dist/model/assignUserIdParams.d.ts.map +1 -1
- package/dist/model/attributeToUpdate.d.ts +3 -0
- package/dist/model/attributeToUpdate.d.ts.map +1 -0
- package/dist/model/automaticFacetFilter.d.ts +17 -17
- package/dist/model/automaticFacetFilter.d.ts.map +1 -1
- package/dist/model/automaticFacetFilters.d.ts +5 -5
- package/dist/model/automaticFacetFilters.d.ts.map +1 -1
- package/dist/model/baseGetApiKeyResponse.d.ts +11 -0
- package/dist/model/baseGetApiKeyResponse.d.ts.map +1 -0
- package/dist/model/baseIndexSettings.d.ts +66 -58
- package/dist/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/model/baseSearchParams.d.ts +3 -3
- package/dist/model/baseSearchParams.d.ts.map +1 -1
- package/dist/model/baseSearchParamsWithoutQuery.d.ts +118 -122
- package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/model/baseSearchResponse.d.ts +105 -101
- package/dist/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/model/batchAssignUserIdsParams.d.ts +13 -13
- package/dist/model/batchAssignUserIdsParams.d.ts.map +1 -1
- package/dist/model/batchDictionaryEntriesParams.d.ts +14 -14
- package/dist/model/batchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/model/batchDictionaryEntriesRequest.d.ts +6 -6
- package/dist/model/batchDictionaryEntriesRequest.d.ts.map +1 -1
- package/dist/model/batchParams.d.ts +7 -7
- package/dist/model/batchParams.d.ts.map +1 -1
- package/dist/model/batchRequest.d.ts +9 -0
- package/dist/model/batchRequest.d.ts.map +1 -0
- package/dist/model/batchResponse.d.ts +10 -10
- package/dist/model/batchResponse.d.ts.map +1 -1
- package/dist/model/batchWriteParams.d.ts +7 -7
- package/dist/model/batchWriteParams.d.ts.map +1 -1
- package/dist/model/browseParams.d.ts +4 -0
- package/dist/model/browseParams.d.ts.map +1 -0
- package/dist/model/browseParamsObject.d.ts +4 -0
- package/dist/model/browseParamsObject.d.ts.map +1 -0
- package/dist/model/browseResponse.d.ts +4 -4
- package/dist/model/browseResponse.d.ts.map +1 -1
- package/dist/model/builtInOperation.d.ts +11 -11
- package/dist/model/builtInOperation.d.ts.map +1 -1
- package/dist/model/builtInOperationType.d.ts +4 -4
- package/dist/model/builtInOperationType.d.ts.map +1 -1
- package/dist/model/clientMethodProps.d.ts +706 -703
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/condition.d.ts +16 -16
- package/dist/model/condition.d.ts.map +1 -1
- package/dist/model/consequence.d.ts +25 -25
- package/dist/model/consequence.d.ts.map +1 -1
- package/dist/model/consequenceHide.d.ts +9 -9
- package/dist/model/consequenceHide.d.ts.map +1 -1
- package/dist/model/consequenceParams.d.ts +4 -4
- package/dist/model/consequenceParams.d.ts.map +1 -1
- package/dist/model/consequenceQuery.d.ts +5 -5
- package/dist/model/consequenceQuery.d.ts.map +1 -1
- package/dist/model/consequenceQueryObject.d.ts +11 -11
- package/dist/model/consequenceQueryObject.d.ts.map +1 -1
- package/dist/model/createdAtResponse.d.ts +9 -9
- package/dist/model/createdAtResponse.d.ts.map +1 -1
- package/dist/model/cursor.d.ts +7 -0
- package/dist/model/cursor.d.ts.map +1 -0
- package/dist/model/deleteApiKeyResponse.d.ts +6 -6
- package/dist/model/deleteApiKeyResponse.d.ts.map +1 -1
- package/dist/model/deleteByParams.d.ts +27 -0
- package/dist/model/deleteByParams.d.ts.map +1 -0
- package/dist/model/deleteSourceResponse.d.ts +6 -6
- package/dist/model/deleteSourceResponse.d.ts.map +1 -1
- package/dist/model/deletedAtResponse.d.ts +13 -13
- package/dist/model/deletedAtResponse.d.ts.map +1 -1
- package/dist/model/dictionaryAction.d.ts +4 -4
- package/dist/model/dictionaryAction.d.ts.map +1 -1
- package/dist/model/dictionaryEntry.d.ts +27 -27
- package/dist/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/model/dictionaryEntryState.d.ts +4 -4
- package/dist/model/dictionaryEntryState.d.ts.map +1 -1
- package/dist/model/dictionaryLanguage.d.ts +9 -9
- package/dist/model/dictionaryLanguage.d.ts.map +1 -1
- package/dist/model/dictionarySettingsParams.d.ts +7 -7
- package/dist/model/dictionarySettingsParams.d.ts.map +1 -1
- package/dist/model/dictionaryType.d.ts +1 -1
- package/dist/model/dictionaryType.d.ts.map +1 -1
- package/dist/model/distinct.d.ts +5 -0
- package/dist/model/distinct.d.ts.map +1 -0
- package/dist/model/edit.d.ts +12 -12
- package/dist/model/edit.d.ts.map +1 -1
- package/dist/model/editType.d.ts +4 -4
- package/dist/model/editType.d.ts.map +1 -1
- package/dist/model/errorBase.d.ts +6 -6
- package/dist/model/errorBase.d.ts.map +1 -1
- package/dist/model/exactOnSingleWordQuery.d.ts +4 -4
- package/dist/model/exactOnSingleWordQuery.d.ts.map +1 -1
- package/dist/model/exhaustive.d.ts +26 -0
- package/dist/model/exhaustive.d.ts.map +1 -0
- package/dist/model/facetFilters.d.ts +5 -5
- package/dist/model/facetFilters.d.ts.map +1 -1
- package/dist/model/facetHits.d.ts +14 -14
- package/dist/model/facetHits.d.ts.map +1 -1
- package/dist/model/facetOrdering.d.ts +12 -12
- package/dist/model/facetOrdering.d.ts.map +1 -1
- package/dist/model/facets.d.ts +9 -9
- package/dist/model/facets.d.ts.map +1 -1
- package/dist/model/facetsStats.d.ts +18 -18
- package/dist/model/facetsStats.d.ts.map +1 -1
- package/dist/model/fetchedIndex.d.ts +46 -46
- package/dist/model/fetchedIndex.d.ts.map +1 -1
- package/dist/model/getApiKeyResponse.d.ts +4 -0
- package/dist/model/getApiKeyResponse.d.ts.map +1 -0
- package/dist/model/getDictionarySettingsResponse.d.ts +4 -4
- package/dist/model/getDictionarySettingsResponse.d.ts.map +1 -1
- package/dist/model/getLogsResponse.d.ts +4 -4
- package/dist/model/getLogsResponse.d.ts.map +1 -1
- package/dist/model/getObjectsParams.d.ts +7 -7
- package/dist/model/getObjectsParams.d.ts.map +1 -1
- package/dist/model/getObjectsRequest.d.ts +18 -0
- package/dist/model/getObjectsRequest.d.ts.map +1 -0
- package/dist/model/getObjectsResponse.d.ts +6 -6
- package/dist/model/getObjectsResponse.d.ts.map +1 -1
- package/dist/model/getTaskResponse.d.ts +4 -4
- package/dist/model/getTaskResponse.d.ts.map +1 -1
- package/dist/model/getTopUserIdsResponse.d.ts +10 -10
- package/dist/model/getTopUserIdsResponse.d.ts.map +1 -1
- package/dist/model/hasPendingMappingsResponse.d.ts +10 -10
- package/dist/model/hasPendingMappingsResponse.d.ts.map +1 -1
- package/dist/model/highlightResult.d.ts +2 -2
- package/dist/model/highlightResult.d.ts.map +1 -1
- package/dist/model/highlightResultOption.d.ts +19 -19
- package/dist/model/highlightResultOption.d.ts.map +1 -1
- package/dist/model/hit.d.ts +22 -22
- package/dist/model/hit.d.ts.map +1 -1
- package/dist/model/ignorePlurals.d.ts +4 -4
- package/dist/model/ignorePlurals.d.ts.map +1 -1
- package/dist/model/index.d.ts +163 -152
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/indexSettings.d.ts +6 -6
- package/dist/model/indexSettings.d.ts.map +1 -1
- package/dist/model/indexSettingsAsSearchParams.d.ts +162 -158
- package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/model/languages.d.ts +9 -9
- package/dist/model/languages.d.ts.map +1 -1
- package/dist/model/listApiKeysResponse.d.ts +7 -7
- package/dist/model/listApiKeysResponse.d.ts.map +1 -1
- package/dist/model/listClustersResponse.d.ts +9 -9
- package/dist/model/listClustersResponse.d.ts.map +1 -1
- package/dist/model/listIndicesResponse.d.ts +11 -11
- package/dist/model/listIndicesResponse.d.ts.map +1 -1
- package/dist/model/listUserIdsResponse.d.ts +10 -10
- package/dist/model/listUserIdsResponse.d.ts.map +1 -1
- package/dist/model/log.d.ts +63 -63
- package/dist/model/log.d.ts.map +1 -1
- package/dist/model/logQuery.d.ts +14 -14
- package/dist/model/logQuery.d.ts.map +1 -1
- package/dist/model/logType.d.ts +1 -1
- package/dist/model/logType.d.ts.map +1 -1
- package/dist/model/matchLevel.d.ts +4 -4
- package/dist/model/matchLevel.d.ts.map +1 -1
- package/dist/model/matchedGeoLocation.d.ts +14 -14
- package/dist/model/matchedGeoLocation.d.ts.map +1 -1
- package/dist/model/mixedSearchFilters.d.ts +1 -1
- package/dist/model/mixedSearchFilters.d.ts.map +1 -1
- package/dist/model/mode.d.ts +5 -0
- package/dist/model/mode.d.ts.map +1 -0
- package/dist/model/multipleBatchRequest.d.ts +13 -0
- package/dist/model/multipleBatchRequest.d.ts.map +1 -0
- package/dist/model/multipleBatchResponse.d.ts +10 -10
- package/dist/model/multipleBatchResponse.d.ts.map +1 -1
- package/dist/model/numericFilters.d.ts +5 -5
- package/dist/model/numericFilters.d.ts.map +1 -1
- package/dist/model/operationIndexParams.d.ts +13 -13
- package/dist/model/operationIndexParams.d.ts.map +1 -1
- package/dist/model/operationType.d.ts +4 -4
- package/dist/model/operationType.d.ts.map +1 -1
- package/dist/model/optionalFilters.d.ts +5 -5
- package/dist/model/optionalFilters.d.ts.map +1 -1
- package/dist/model/params.d.ts +12 -12
- package/dist/model/params.d.ts.map +1 -1
- package/dist/model/personalization.d.ts +14 -14
- package/dist/model/personalization.d.ts.map +1 -1
- package/dist/model/promote.d.ts +3 -3
- package/dist/model/promote.d.ts.map +1 -1
- package/dist/model/promoteObjectID.d.ts +13 -13
- package/dist/model/promoteObjectID.d.ts.map +1 -1
- package/dist/model/promoteObjectIDs.d.ts +13 -13
- package/dist/model/promoteObjectIDs.d.ts.map +1 -1
- package/dist/model/queryType.d.ts +4 -4
- package/dist/model/queryType.d.ts.map +1 -1
- package/dist/model/rankingInfo.d.ts +50 -50
- package/dist/model/rankingInfo.d.ts.map +1 -1
- package/dist/model/reRankingApplyFilter.d.ts +5 -5
- package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
- package/dist/model/redirect.d.ts +8 -0
- package/dist/model/redirect.d.ts.map +1 -0
- package/dist/model/redirectRuleIndexMetadata.d.ts +21 -0
- package/dist/model/redirectRuleIndexMetadata.d.ts.map +1 -0
- package/dist/model/redirectRuleIndexMetadataData.d.ts +7 -0
- package/dist/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
- package/dist/model/removeStopWords.d.ts +4 -4
- package/dist/model/removeStopWords.d.ts.map +1 -1
- package/dist/model/removeUserIdResponse.d.ts +6 -6
- package/dist/model/removeUserIdResponse.d.ts.map +1 -1
- package/dist/model/removeWordsIfNoResults.d.ts +4 -4
- package/dist/model/removeWordsIfNoResults.d.ts.map +1 -1
- package/dist/model/renderingContent.d.ts +7 -7
- package/dist/model/renderingContent.d.ts.map +1 -1
- package/dist/model/replaceSourceResponse.d.ts +6 -6
- package/dist/model/replaceSourceResponse.d.ts.map +1 -1
- package/dist/model/rule.d.ts +29 -29
- package/dist/model/rule.d.ts.map +1 -1
- package/dist/model/saveObjectResponse.d.ts +14 -11
- package/dist/model/saveObjectResponse.d.ts.map +1 -1
- package/dist/model/saveSynonymResponse.d.ts +14 -14
- package/dist/model/saveSynonymResponse.d.ts.map +1 -1
- package/dist/model/scopeType.d.ts +1 -1
- package/dist/model/scopeType.d.ts.map +1 -1
- package/dist/model/searchDictionaryEntriesParams.d.ts +21 -21
- package/dist/model/searchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/model/searchForFacetValuesRequest.d.ts +14 -14
- package/dist/model/searchForFacetValuesRequest.d.ts.map +1 -1
- package/dist/model/searchForFacetValuesResponse.d.ts +12 -4
- package/dist/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/model/searchForFacets.d.ts +3 -3
- package/dist/model/searchForFacets.d.ts.map +1 -1
- package/dist/model/searchForFacetsOptions.d.ts +20 -20
- package/dist/model/searchForFacetsOptions.d.ts.map +1 -1
- package/dist/model/searchForHits.d.ts +3 -3
- package/dist/model/searchForHits.d.ts.map +1 -1
- package/dist/model/searchForHitsOptions.d.ts +12 -12
- package/dist/model/searchForHitsOptions.d.ts.map +1 -1
- package/dist/model/searchHits.d.ts +12 -4
- package/dist/model/searchHits.d.ts.map +1 -1
- package/dist/model/searchMethodParams.d.ts +6 -6
- package/dist/model/searchMethodParams.d.ts.map +1 -1
- package/dist/model/searchParams.d.ts +3 -3
- package/dist/model/searchParams.d.ts.map +1 -1
- package/dist/model/searchParamsObject.d.ts +3 -3
- package/dist/model/searchParamsObject.d.ts.map +1 -1
- package/dist/model/searchParamsQuery.d.ts +6 -6
- package/dist/model/searchParamsQuery.d.ts.map +1 -1
- package/dist/model/searchParamsString.d.ts +6 -6
- package/dist/model/searchParamsString.d.ts.map +1 -1
- package/dist/model/searchQuery.d.ts +3 -3
- package/dist/model/searchQuery.d.ts.map +1 -1
- package/dist/model/searchResponse.d.ts +3 -3
- package/dist/model/searchResponse.d.ts.map +1 -1
- package/dist/model/searchResponses.d.ts +4 -4
- package/dist/model/searchResponses.d.ts.map +1 -1
- package/dist/model/searchResult.d.ts +4 -0
- package/dist/model/searchResult.d.ts.map +1 -0
- package/dist/model/searchRulesParams.d.ts +31 -31
- package/dist/model/searchRulesParams.d.ts.map +1 -1
- package/dist/model/searchRulesResponse.d.ts +19 -19
- package/dist/model/searchRulesResponse.d.ts.map +1 -1
- package/dist/model/searchStrategy.d.ts +4 -1
- package/dist/model/searchStrategy.d.ts.map +1 -1
- package/dist/model/searchSynonymsParams.d.ts +16 -6
- package/dist/model/searchSynonymsParams.d.ts.map +1 -1
- package/dist/model/searchSynonymsResponse.d.ts +11 -11
- package/dist/model/searchSynonymsResponse.d.ts.map +1 -1
- package/dist/model/searchTypeDefault.d.ts +4 -4
- package/dist/model/searchTypeDefault.d.ts.map +1 -1
- package/dist/model/searchTypeFacet.d.ts +4 -4
- package/dist/model/searchTypeFacet.d.ts.map +1 -1
- package/dist/model/searchUserIdsParams.d.ts +21 -21
- package/dist/model/searchUserIdsParams.d.ts.map +1 -1
- package/dist/model/searchUserIdsResponse.d.ts +26 -26
- package/dist/model/searchUserIdsResponse.d.ts.map +1 -1
- package/dist/model/semanticSearch.d.ts +10 -0
- package/dist/model/semanticSearch.d.ts.map +1 -0
- package/dist/model/snippetResult.d.ts +2 -2
- package/dist/model/snippetResult.d.ts.map +1 -1
- package/dist/model/snippetResultOption.d.ts +11 -11
- package/dist/model/snippetResultOption.d.ts.map +1 -1
- package/dist/model/sortRemainingBy.d.ts +4 -4
- package/dist/model/sortRemainingBy.d.ts.map +1 -1
- package/dist/model/source.d.ts +13 -13
- package/dist/model/source.d.ts.map +1 -1
- package/dist/model/standardEntries.d.ts +17 -17
- package/dist/model/standardEntries.d.ts.map +1 -1
- package/dist/model/synonymHit.d.ts +35 -37
- package/dist/model/synonymHit.d.ts.map +1 -1
- package/dist/model/synonymType.d.ts +4 -4
- package/dist/model/synonymType.d.ts.map +1 -1
- package/dist/model/tagFilters.d.ts +5 -5
- package/dist/model/tagFilters.d.ts.map +1 -1
- package/dist/model/taskStatus.d.ts +4 -1
- package/dist/model/taskStatus.d.ts.map +1 -1
- package/dist/model/timeRange.d.ts +10 -10
- package/dist/model/timeRange.d.ts.map +1 -1
- package/dist/model/typoTolerance.d.ts +5 -5
- package/dist/model/typoTolerance.d.ts.map +1 -1
- package/dist/model/typoToleranceEnum.d.ts +1 -1
- package/dist/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/model/updateApiKeyResponse.d.ts +10 -10
- package/dist/model/updateApiKeyResponse.d.ts.map +1 -1
- package/dist/model/updatedAtResponse.d.ts +13 -13
- package/dist/model/updatedAtResponse.d.ts.map +1 -1
- package/dist/model/updatedAtWithObjectIdResponse.d.ts +17 -17
- package/dist/model/updatedAtWithObjectIdResponse.d.ts.map +1 -1
- package/dist/model/updatedRuleResponse.d.ts +14 -14
- package/dist/model/updatedRuleResponse.d.ts.map +1 -1
- package/dist/model/userHighlightResult.d.ts +5 -11
- package/dist/model/userHighlightResult.d.ts.map +1 -1
- package/dist/model/userHit.d.ts +24 -24
- package/dist/model/userHit.d.ts.map +1 -1
- package/dist/model/userId.d.ts +21 -21
- package/dist/model/userId.d.ts.map +1 -1
- package/dist/model/value.d.ts +8 -8
- package/dist/model/value.d.ts.map +1 -1
- package/dist/src/searchClient.d.ts +845 -673
- package/dist/src/searchClient.d.ts.map +1 -1
- package/index.js +1 -1
- package/model/acl.ts +5 -1
- package/model/action.ts +2 -2
- package/model/addApiKeyResponse.ts +4 -3
- package/model/advancedSyntaxFeatures.ts +1 -1
- package/model/alternativesAsExact.ts +1 -1
- package/model/anchoring.ts +2 -2
- package/model/apiKey.ts +17 -10
- package/model/aroundPrecision.ts +8 -0
- package/model/aroundPrecisionFromValueInner.ts +7 -0
- package/model/aroundRadius.ts +2 -2
- package/model/aroundRadiusAll.ts +1 -1
- package/model/assignUserIdParams.ts +2 -2
- package/model/attributeToUpdate.ts +5 -0
- package/model/automaticFacetFilter.ts +3 -1
- package/model/automaticFacetFilters.ts +1 -1
- package/model/baseGetApiKeyResponse.ts +13 -0
- package/model/baseIndexSettings.ts +38 -15
- package/model/baseSearchParams.ts +1 -1
- package/model/baseSearchParamsWithoutQuery.ts +69 -42
- package/model/baseSearchResponse.ts +61 -31
- package/model/batchAssignUserIdsParams.ts +4 -3
- package/model/batchDictionaryEntriesParams.ts +5 -4
- package/model/batchDictionaryEntriesRequest.ts +2 -1
- package/model/batchParams.ts +4 -4
- package/model/batchRequest.ts +12 -0
- package/model/batchResponse.ts +4 -3
- package/model/batchWriteParams.ts +4 -4
- package/model/browseParams.ts +6 -0
- package/model/browseParamsObject.ts +6 -0
- package/model/browseResponse.ts +4 -4
- package/model/builtInOperation.ts +3 -2
- package/model/builtInOperationType.ts +2 -2
- package/model/clientMethodProps.ts +169 -166
- package/model/condition.ts +4 -1
- package/model/consequence.ts +10 -6
- package/model/consequenceHide.ts +3 -3
- package/model/consequenceParams.ts +1 -1
- package/model/consequenceQuery.ts +1 -1
- package/model/consequenceQueryObject.ts +2 -1
- package/model/createdAtResponse.ts +3 -3
- package/model/cursor.ts +8 -0
- package/model/deleteApiKeyResponse.ts +2 -2
- package/model/deleteByParams.ts +36 -0
- package/model/deleteSourceResponse.ts +2 -2
- package/model/deletedAtResponse.ts +5 -4
- package/model/dictionaryAction.ts +1 -1
- package/model/dictionaryEntry.ts +12 -7
- package/model/dictionaryEntryState.ts +2 -2
- package/model/dictionaryLanguage.ts +3 -3
- package/model/dictionarySettingsParams.ts +2 -2
- package/model/dictionaryType.ts +1 -1
- package/model/distinct.ts +6 -0
- package/model/edit.ts +3 -1
- package/model/editType.ts +1 -1
- package/model/errorBase.ts +1 -1
- package/model/exactOnSingleWordQuery.ts +2 -2
- package/model/exhaustive.ts +31 -0
- package/model/facetFilters.ts +2 -2
- package/model/facetHits.ts +6 -4
- package/model/facetOrdering.ts +4 -3
- package/model/facets.ts +2 -2
- package/model/facetsStats.ts +8 -5
- package/model/fetchedIndex.ts +13 -3
- package/model/getApiKeyResponse.ts +6 -0
- package/model/getDictionarySettingsResponse.ts +1 -1
- package/model/getLogsResponse.ts +1 -1
- package/model/getObjectsParams.ts +4 -4
- package/model/getObjectsRequest.ts +21 -0
- package/model/getObjectsResponse.ts +4 -4
- package/model/getTaskResponse.ts +1 -1
- package/model/getTopUserIdsResponse.ts +3 -3
- package/model/hasPendingMappingsResponse.ts +4 -3
- package/model/highlightResult.ts +5 -2
- package/model/highlightResultOption.ts +5 -2
- package/model/hit.ts +7 -3
- package/model/ignorePlurals.ts +2 -2
- package/model/index.ts +21 -10
- package/model/indexSettings.ts +2 -2
- package/model/indexSettingsAsSearchParams.ts +92 -44
- package/model/languages.ts +4 -2
- package/model/listApiKeysResponse.ts +4 -4
- package/model/listClustersResponse.ts +3 -3
- package/model/listIndicesResponse.ts +4 -3
- package/model/listUserIdsResponse.ts +3 -3
- package/model/log.ts +22 -8
- package/model/logQuery.ts +4 -2
- package/model/logType.ts +1 -1
- package/model/matchLevel.ts +1 -1
- package/model/matchedGeoLocation.ts +3 -1
- package/model/mixedSearchFilters.ts +1 -1
- package/model/mode.ts +6 -0
- package/model/multipleBatchRequest.ts +17 -0
- package/model/multipleBatchResponse.ts +6 -5
- package/model/numericFilters.ts +2 -2
- package/model/operationIndexParams.ts +5 -3
- package/model/operationType.ts +2 -2
- package/model/optionalFilters.ts +2 -2
- package/model/params.ts +5 -2
- package/model/personalization.ts +3 -1
- package/model/promote.ts +1 -1
- package/model/promoteObjectID.ts +5 -4
- package/model/promoteObjectIDs.ts +5 -4
- package/model/queryType.ts +2 -2
- package/model/rankingInfo.ts +13 -1
- package/model/reRankingApplyFilter.ts +2 -2
- package/model/redirect.ts +10 -0
- package/model/redirectRuleIndexMetadata.ts +27 -0
- package/model/redirectRuleIndexMetadataData.ts +8 -0
- package/model/removeStopWords.ts +2 -2
- package/model/removeUserIdResponse.ts +2 -2
- package/model/removeWordsIfNoResults.ts +2 -2
- package/model/renderingContent.ts +2 -2
- package/model/replaceSourceResponse.ts +2 -2
- package/model/rule.ts +11 -6
- package/model/saveObjectResponse.ts +10 -5
- package/model/saveSynonymResponse.ts +6 -4
- package/model/scopeType.ts +1 -1
- package/model/searchDictionaryEntriesParams.ts +9 -6
- package/model/searchForFacetValuesRequest.ts +5 -3
- package/model/searchForFacetValuesResponse.ts +11 -1
- package/model/searchForFacets.ts +1 -1
- package/model/searchForFacetsOptions.ts +8 -4
- package/model/searchForHits.ts +1 -1
- package/model/searchForHitsOptions.ts +3 -2
- package/model/searchHits.ts +13 -3
- package/model/searchMethodParams.ts +2 -1
- package/model/searchParams.ts +1 -1
- package/model/searchParamsObject.ts +1 -1
- package/model/searchParamsQuery.ts +2 -2
- package/model/searchParamsString.ts +2 -2
- package/model/searchQuery.ts +1 -1
- package/model/searchResponse.ts +3 -2
- package/model/searchResponses.ts +4 -4
- package/model/searchResult.ts +8 -0
- package/model/searchRulesParams.ts +15 -9
- package/model/searchRulesResponse.ts +4 -1
- package/model/searchStrategy.ts +4 -1
- package/model/searchSynonymsParams.ts +16 -2
- package/model/searchSynonymsResponse.ts +4 -3
- package/model/searchTypeDefault.ts +2 -2
- package/model/searchTypeFacet.ts +2 -2
- package/model/searchUserIdsParams.ts +8 -5
- package/model/searchUserIdsResponse.ts +10 -6
- package/model/semanticSearch.ts +11 -0
- package/model/snippetResult.ts +5 -2
- package/model/snippetResultOption.ts +3 -2
- package/model/sortRemainingBy.ts +2 -2
- package/model/source.ts +5 -4
- package/model/standardEntries.ts +7 -5
- package/model/synonymHit.ts +14 -9
- package/model/synonymType.ts +2 -2
- package/model/tagFilters.ts +2 -2
- package/model/taskStatus.ts +4 -1
- package/model/timeRange.ts +2 -1
- package/model/typoTolerance.ts +2 -2
- package/model/typoToleranceEnum.ts +1 -1
- package/model/updateApiKeyResponse.ts +4 -3
- package/model/updatedAtResponse.ts +5 -4
- package/model/updatedAtWithObjectIdResponse.ts +7 -5
- package/model/updatedRuleResponse.ts +6 -4
- package/model/userHighlightResult.ts +4 -9
- package/model/userHit.ts +7 -2
- package/model/userId.ts +6 -3
- package/model/value.ts +2 -1
- package/package.json +32 -13
- package/dist/model/attributeOrBuiltInOperation.d.ts +0 -3
- package/dist/model/attributeOrBuiltInOperation.d.ts.map +0 -1
- package/dist/model/baseBrowseResponse.d.ts +0 -7
- package/dist/model/baseBrowseResponse.d.ts.map +0 -1
- package/dist/model/batchOperation.d.ts +0 -9
- package/dist/model/batchOperation.d.ts.map +0 -1
- package/dist/model/browseRequest.d.ts +0 -11
- package/dist/model/browseRequest.d.ts.map +0 -1
- package/dist/model/createdAtObject.d.ts +0 -7
- package/dist/model/createdAtObject.d.ts.map +0 -1
- package/dist/model/key.d.ts +0 -4
- package/dist/model/key.d.ts.map +0 -1
- package/dist/model/multipleBatchOperation.d.ts +0 -13
- package/dist/model/multipleBatchOperation.d.ts.map +0 -1
- package/dist/model/multipleGetObjectsParams.d.ts +0 -18
- package/dist/model/multipleGetObjectsParams.d.ts.map +0 -1
- package/dist/model/synonymHitHighlightResult.d.ts +0 -12
- package/dist/model/synonymHitHighlightResult.d.ts.map +0 -1
- package/model/attributeOrBuiltInOperation.ts +0 -5
- package/model/baseBrowseResponse.ts +0 -8
- package/model/batchOperation.ts +0 -11
- package/model/browseRequest.ts +0 -12
- package/model/createdAtObject.ts +0 -8
- package/model/key.ts +0 -6
- package/model/multipleBatchOperation.ts +0 -15
- package/model/multipleGetObjectsParams.ts +0 -19
- package/model/synonymHitHighlightResult.ts +0 -14
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAsClD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;0TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;;OAUG;kFAME,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IA2BlC;;;;;;;OAOG;2CAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;;;IAOjC;;;;;;;OAOG;wCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc,GAC9B,QAAQ;QAAE,OAAO,EAAE,4BAA4B,EAAE,CAAA;KAAE,CAAC;IAKvD;;;;;;;;OAQG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;;;OAWG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;;;OAQG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;;OAUG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;OAOG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAqCzB;;;;;;;;;;OAUG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;;;OAUG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;;;OAUG;6CAE4B,WAAW,mBACvB,cAAc;IA0BjC;;;;;;;;;OASG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;;;OAUG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;;OAUG;oDAEiC,kBAAkB,mBACnC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;;OAUG;4CAE8B,aAAa,mBAC3B,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;;;OASG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;;;OAUG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;;;OAWG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;;;OASG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;;;OAWG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;OAMG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;OAOG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;;;OAOG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;;;OAYG;kDAEoC,YAAY,mBACjC,cAAc,GAAG,SAAS,GACzC,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;;;OAWG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;;;OAQG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;;;OAUG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;;;OASG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;;;OAOG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;;;OAUG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;;;OAUG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;;;OAOG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;;;OASG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;;;OASG;yCAEgB,uBAAuB,mBACxB,cAAc,GAAG,SAAS,GACzC,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;;;OAOG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;;;OAOG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;;;;OAUG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;;;;;OAUG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;OAKG;+BAEY,WAAW,mBACP,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA4BjC;;;;;;;;;;OAUG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA0C7B;;;;;;;;;;;;OAYG;yFAOE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAwCzC;;;;;;;;;OASG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAsBjC;;;;;;;;;OASG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;;;OAUG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA+B9B;;;;;;;;;;;;OAYG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;;;OAYG;4EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;;;OAYG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAmD/B;;;;;;;;;;;;OAYG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwC7B;;;;;;;;OAQG;oCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;IAwDjC;;;;;;;;;;OAUG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;;OAWG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAgCxC;;;;;;;;;;OAUG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA2B/B;;;;;;;;;;OAUG;wDAE4B,sBAAsB,mBAClC,cAAc;IA4BjC;;;;;;;;;;OAUG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IA2BlC;;;;;;;;OAQG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA8BjC;;;;;;;;OAQG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;;;OAWG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAmC7B;;;;;;;;;;OAUG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;EAqCnC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
package/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
// eslint-disable-next-line import/no-commonjs,import/extensions
|
|
2
|
-
module.exports = require('./dist/client-search.cjs
|
|
2
|
+
module.exports = require('./dist/client-search.cjs');
|
package/model/acl.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* API key permissions: `addObject`: required to add or update records, copy or move an index. `analytics`: required to access the Analytics API. `browse`: required to view records `deleteIndex`: required to delete indices. `deleteObject`: required to delete records. `editSettings`: required to change index settings. `inference`: required to access the Inference API. `listIndexes`: required to list indices. `logs`: required to access logs of search and indexing operations. `recommendation`: required to access the Personalization and Recommend APIs. `search`: required to search records `seeUnretrievableAttributes`: required to retrieve [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) for all operations that return records. `settings`: required to examine index settings.
|
|
5
|
+
*/
|
|
3
6
|
export type Acl =
|
|
4
7
|
| 'addObject'
|
|
5
8
|
| 'analytics'
|
|
@@ -7,6 +10,7 @@ export type Acl =
|
|
|
7
10
|
| 'deleteIndex'
|
|
8
11
|
| 'deleteObject'
|
|
9
12
|
| 'editSettings'
|
|
13
|
+
| 'inference'
|
|
10
14
|
| 'listIndexes'
|
|
11
15
|
| 'logs'
|
|
12
16
|
| 'personalization'
|
package/model/action.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Type of operation.
|
|
4
|
+
* Type of batch operation.
|
|
5
5
|
*/
|
|
6
6
|
export type Action =
|
|
7
7
|
| 'addObject'
|
|
@@ -1,12 +1,13 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
export type AddApiKeyResponse = {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* API key.
|
|
6
6
|
*/
|
|
7
7
|
key: string;
|
|
8
|
+
|
|
8
9
|
/**
|
|
9
|
-
*
|
|
10
|
+
* Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
|
|
10
11
|
*/
|
|
11
12
|
createdAt: string;
|
|
12
13
|
};
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
export type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
export type AlternativesAsExact =
|
|
4
4
|
| 'ignorePlurals'
|
package/model/anchoring.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Whether the pattern parameter
|
|
4
|
+
* Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
|
|
5
5
|
*/
|
|
6
6
|
export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
|
package/model/apiKey.ts
CHANGED
|
@@ -1,41 +1,48 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
import type { Acl } from './acl';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* API key object.
|
|
7
7
|
*/
|
|
8
8
|
export type ApiKey = {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
|
|
11
11
|
*/
|
|
12
12
|
acl: Acl[];
|
|
13
|
+
|
|
13
14
|
/**
|
|
14
|
-
*
|
|
15
|
+
* Description of an API key for you and your team members.
|
|
15
16
|
*/
|
|
16
17
|
description?: string;
|
|
18
|
+
|
|
17
19
|
/**
|
|
18
|
-
*
|
|
20
|
+
* Restricts this API key to a list of indices or index patterns. If the list is empty, all indices are allowed. Specify either an exact index name or a pattern with a leading or trailing wildcard character (or both). For example: - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\".
|
|
19
21
|
*/
|
|
20
22
|
indexes?: string[];
|
|
23
|
+
|
|
21
24
|
/**
|
|
22
|
-
* Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
|
|
25
|
+
* Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced. > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
|
|
23
26
|
*/
|
|
24
27
|
maxHitsPerQuery?: number;
|
|
28
|
+
|
|
25
29
|
/**
|
|
26
|
-
* Maximum number of API calls per hour allowed from a given IP address or
|
|
30
|
+
* Maximum number of API calls per hour allowed from a given IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). Each time an API call is performed with this key, a check is performed. If there were more than the specified number of calls within the last hour, the API returns an error with the status code `429` (Too Many Requests). > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
|
|
27
31
|
*/
|
|
28
32
|
maxQueriesPerIPPerHour?: number;
|
|
33
|
+
|
|
29
34
|
/**
|
|
30
|
-
*
|
|
35
|
+
* Force some [query parameters](https://www.algolia.com/doc/api-reference/api-parameters/) to be applied for each query made with this API key. It\'s a URL-encoded query string.
|
|
31
36
|
*/
|
|
32
37
|
queryParameters?: string;
|
|
38
|
+
|
|
33
39
|
/**
|
|
34
|
-
* Restrict this
|
|
40
|
+
* Restrict this API key to specific [referrers](https://www.algolia.com/doc/guides/security/api-keys/in-depth/api-key-restrictions/#http-referrers). If empty, all referrers are allowed. For example: - `https://algolia.com/_*` matches all referrers starting with \"https://algolia.com/\" - `*.algolia.com` matches all referrers ending with \".algolia.com\" - `*algolia.com*` allows everything in the domain \"algolia.com\".
|
|
35
41
|
*/
|
|
36
42
|
referers?: string[];
|
|
43
|
+
|
|
37
44
|
/**
|
|
38
|
-
* Validity
|
|
45
|
+
* Validity duration of a key (in seconds). The key will automatically be removed after this time has expired. The default value of 0 never expires. Short-lived API keys are useful to grant temporary access to your data. For example, in mobile apps, you can\'t [control when users update your app](https://www.algolia.com/doc/guides/security/security-best-practices/#use-secured-api-keys-in-mobile-apps). So instead of encoding keys into your app as you would for a web app, you should dynamically fetch them from your mobile app\'s backend.
|
|
39
46
|
*/
|
|
40
47
|
validity?: number;
|
|
41
48
|
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
|
|
7
|
+
*/
|
|
8
|
+
export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
export type AroundPrecisionFromValueInner = {
|
|
4
|
+
from?: number;
|
|
5
|
+
|
|
6
|
+
value?: number;
|
|
7
|
+
};
|
package/model/aroundRadius.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
import type { AroundRadiusAll } from './aroundRadiusAll';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* [Maximum radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
|
|
7
7
|
*/
|
|
8
8
|
export type AroundRadius = AroundRadiusAll | number;
|
package/model/aroundRadiusAll.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
export type AroundRadiusAll = 'all';
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Assign userID parameters.
|
|
5
5
|
*/
|
|
6
6
|
export type AssignUserIdParams = {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Cluster name.
|
|
9
9
|
*/
|
|
10
10
|
cluster: string;
|
|
11
11
|
};
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
import type { BuiltInOperation } from './builtInOperation';
|
|
4
|
+
|
|
5
|
+
export type AttributeToUpdate = BuiltInOperation | string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Automatic facet Filter.
|
|
@@ -8,10 +8,12 @@ export type AutomaticFacetFilter = {
|
|
|
8
8
|
* Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
|
|
9
9
|
*/
|
|
10
10
|
facet: string;
|
|
11
|
+
|
|
11
12
|
/**
|
|
12
13
|
* Score for the filter. Typically used for optional or disjunctive filters.
|
|
13
14
|
*/
|
|
14
15
|
score?: number;
|
|
16
|
+
|
|
15
17
|
/**
|
|
16
18
|
* Whether the filter is disjunctive (true) or conjunctive (false).
|
|
17
19
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
import type { AutomaticFacetFilter } from './automaticFacetFilter';
|
|
4
4
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
export type BaseGetApiKeyResponse = {
|
|
4
|
+
/**
|
|
5
|
+
* API key.
|
|
6
|
+
*/
|
|
7
|
+
value?: string;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
|
|
11
|
+
*/
|
|
12
|
+
createdAt: number;
|
|
13
|
+
};
|
|
@@ -1,60 +1,83 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
export type BaseIndexSettings = {
|
|
4
4
|
/**
|
|
5
|
-
* Creates replicas,
|
|
5
|
+
* Creates [replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/), which are copies of a primary index with the same records but different settings.
|
|
6
6
|
*/
|
|
7
7
|
replicas?: string[];
|
|
8
|
+
|
|
8
9
|
/**
|
|
9
|
-
*
|
|
10
|
+
* Maximum number of hits accessible through pagination.
|
|
10
11
|
*/
|
|
11
12
|
paginationLimitedTo?: number;
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Attributes that can\'t be retrieved at query time.
|
|
16
|
+
*/
|
|
17
|
+
unretrievableAttributes?: string[];
|
|
18
|
+
|
|
12
19
|
/**
|
|
13
|
-
*
|
|
20
|
+
* Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
|
|
14
21
|
*/
|
|
15
22
|
disableTypoToleranceOnWords?: string[];
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
|
-
*
|
|
25
|
+
* Attributes in your index to which [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead) applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.
|
|
18
26
|
*/
|
|
19
27
|
attributesToTransliterate?: string[];
|
|
28
|
+
|
|
20
29
|
/**
|
|
21
|
-
*
|
|
30
|
+
* Attributes on which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
|
|
22
31
|
*/
|
|
23
32
|
camelCaseAttributes?: string[];
|
|
33
|
+
|
|
24
34
|
/**
|
|
25
|
-
*
|
|
35
|
+
* Attributes in your index to which [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding) applies.
|
|
26
36
|
*/
|
|
27
37
|
decompoundedAttributes?: Record<string, any>;
|
|
38
|
+
|
|
28
39
|
/**
|
|
29
|
-
*
|
|
40
|
+
* Set the languages of your index, for language-specific processing steps such as [tokenization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/tokenization/) and [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
30
41
|
*/
|
|
31
42
|
indexLanguages?: string[];
|
|
43
|
+
|
|
32
44
|
/**
|
|
33
|
-
*
|
|
45
|
+
* Attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
|
|
34
46
|
*/
|
|
35
47
|
disablePrefixOnAttributes?: string[];
|
|
48
|
+
|
|
36
49
|
/**
|
|
37
|
-
*
|
|
50
|
+
* Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.
|
|
38
51
|
*/
|
|
39
52
|
allowCompressionOfIntegerArray?: boolean;
|
|
53
|
+
|
|
40
54
|
/**
|
|
41
|
-
*
|
|
55
|
+
* Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
|
|
42
56
|
*/
|
|
43
57
|
numericAttributesForFiltering?: string[];
|
|
58
|
+
|
|
44
59
|
/**
|
|
45
|
-
*
|
|
60
|
+
* Controls which separators are added to an Algolia index as part of [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean). Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
|
|
46
61
|
*/
|
|
47
62
|
separatorsToIndex?: string;
|
|
63
|
+
|
|
48
64
|
/**
|
|
49
|
-
*
|
|
65
|
+
* [Attributes used for searching](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/), including determining [if matches at the beginning of a word are important (ordered) or not (unordered)](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/how-to/configuring-searchable-attributes-the-right-way/#understanding-word-position).
|
|
50
66
|
*/
|
|
51
67
|
searchableAttributes?: string[];
|
|
68
|
+
|
|
52
69
|
/**
|
|
53
70
|
* Lets you store custom data in your indices.
|
|
54
71
|
*/
|
|
55
|
-
userData?:
|
|
72
|
+
userData?: any | null;
|
|
73
|
+
|
|
56
74
|
/**
|
|
57
|
-
*
|
|
75
|
+
* A list of characters and their normalized replacements to override Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
58
76
|
*/
|
|
59
77
|
customNormalization?: Record<string, Record<string, string>>;
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* Name of the deduplication attribute to be used with Algolia\'s [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
|
|
81
|
+
*/
|
|
82
|
+
attributeForDistinct?: string;
|
|
60
83
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
|
|
4
4
|
import type { SearchParamsQuery } from './searchParamsQuery';
|
|
@@ -1,125 +1,152 @@
|
|
|
1
|
-
//
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
2
|
|
|
3
|
+
import type { AroundPrecision } from './aroundPrecision';
|
|
3
4
|
import type { AroundRadius } from './aroundRadius';
|
|
4
5
|
import type { FacetFilters } from './facetFilters';
|
|
5
6
|
import type { NumericFilters } from './numericFilters';
|
|
6
7
|
import type { OptionalFilters } from './optionalFilters';
|
|
7
|
-
import type { ReRankingApplyFilter } from './reRankingApplyFilter';
|
|
8
8
|
import type { TagFilters } from './tagFilters';
|
|
9
9
|
|
|
10
10
|
export type BaseSearchParamsWithoutQuery = {
|
|
11
11
|
/**
|
|
12
|
-
* Overrides the query parameter and performs a more generic search
|
|
12
|
+
* Overrides the query parameter and performs a more generic search.
|
|
13
13
|
*/
|
|
14
14
|
similarQuery?: string;
|
|
15
|
+
|
|
15
16
|
/**
|
|
16
|
-
* Filter the query with numeric, facet
|
|
17
|
+
* [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
|
|
17
18
|
*/
|
|
18
19
|
filters?: string;
|
|
20
|
+
|
|
19
21
|
facetFilters?: FacetFilters;
|
|
22
|
+
|
|
20
23
|
optionalFilters?: OptionalFilters;
|
|
24
|
+
|
|
21
25
|
numericFilters?: NumericFilters;
|
|
26
|
+
|
|
22
27
|
tagFilters?: TagFilters;
|
|
28
|
+
|
|
23
29
|
/**
|
|
24
|
-
* Determines how to calculate
|
|
30
|
+
* Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
|
|
25
31
|
*/
|
|
26
32
|
sumOrFiltersScores?: boolean;
|
|
33
|
+
|
|
27
34
|
/**
|
|
28
|
-
*
|
|
35
|
+
* Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).
|
|
29
36
|
*/
|
|
30
|
-
|
|
37
|
+
restrictSearchableAttributes?: string[];
|
|
38
|
+
|
|
31
39
|
/**
|
|
32
|
-
*
|
|
40
|
+
* Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
|
|
33
41
|
*/
|
|
34
|
-
|
|
42
|
+
facets?: string[];
|
|
43
|
+
|
|
35
44
|
/**
|
|
36
|
-
*
|
|
45
|
+
* Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
|
|
37
46
|
*/
|
|
38
47
|
facetingAfterDistinct?: boolean;
|
|
48
|
+
|
|
39
49
|
/**
|
|
40
|
-
*
|
|
41
|
-
*/
|
|
42
|
-
sortFacetValuesBy?: string;
|
|
43
|
-
/**
|
|
44
|
-
* Specify the page to retrieve.
|
|
50
|
+
* Page to retrieve (the first page is `0`, not `1`).
|
|
45
51
|
*/
|
|
46
52
|
page?: number;
|
|
53
|
+
|
|
47
54
|
/**
|
|
48
|
-
*
|
|
55
|
+
* Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
|
|
49
56
|
*/
|
|
50
57
|
offset?: number;
|
|
58
|
+
|
|
51
59
|
/**
|
|
52
|
-
*
|
|
60
|
+
* Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
|
|
53
61
|
*/
|
|
54
62
|
length?: number;
|
|
63
|
+
|
|
55
64
|
/**
|
|
56
|
-
* Search for entries around a central geolocation, enabling a
|
|
65
|
+
* Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
|
|
57
66
|
*/
|
|
58
67
|
aroundLatLng?: string;
|
|
68
|
+
|
|
59
69
|
/**
|
|
60
|
-
* Search for entries around a
|
|
70
|
+
* Search for entries around a location. The location is automatically computed from the requester\'s IP address.
|
|
61
71
|
*/
|
|
62
72
|
aroundLatLngViaIP?: boolean;
|
|
73
|
+
|
|
63
74
|
aroundRadius?: AroundRadius;
|
|
75
|
+
|
|
76
|
+
aroundPrecision?: AroundPrecision;
|
|
77
|
+
|
|
64
78
|
/**
|
|
65
|
-
*
|
|
66
|
-
*/
|
|
67
|
-
aroundPrecision?: number;
|
|
68
|
-
/**
|
|
69
|
-
* Minimum radius (in meters) used for a geo search when aroundRadius is not set.
|
|
79
|
+
* Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
|
|
70
80
|
*/
|
|
71
81
|
minimumAroundRadius?: number;
|
|
82
|
+
|
|
72
83
|
/**
|
|
73
|
-
* Search inside a rectangular area (in
|
|
84
|
+
* Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
|
|
74
85
|
*/
|
|
75
|
-
insideBoundingBox?: number[];
|
|
86
|
+
insideBoundingBox?: number[][];
|
|
87
|
+
|
|
76
88
|
/**
|
|
77
|
-
* Search inside a polygon (in
|
|
89
|
+
* Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
|
|
78
90
|
*/
|
|
79
|
-
insidePolygon?: number[];
|
|
91
|
+
insidePolygon?: number[][];
|
|
92
|
+
|
|
80
93
|
/**
|
|
81
|
-
*
|
|
94
|
+
* Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
|
|
82
95
|
*/
|
|
83
96
|
naturalLanguages?: string[];
|
|
97
|
+
|
|
84
98
|
/**
|
|
85
|
-
*
|
|
99
|
+
* Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
|
|
86
100
|
*/
|
|
87
101
|
ruleContexts?: string[];
|
|
102
|
+
|
|
88
103
|
/**
|
|
89
|
-
*
|
|
104
|
+
* Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
90
105
|
*/
|
|
91
106
|
personalizationImpact?: number;
|
|
107
|
+
|
|
92
108
|
/**
|
|
93
|
-
* Associates a
|
|
109
|
+
* Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
|
|
94
110
|
*/
|
|
95
111
|
userToken?: string;
|
|
112
|
+
|
|
96
113
|
/**
|
|
97
|
-
*
|
|
114
|
+
* Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
|
|
98
115
|
*/
|
|
99
116
|
getRankingInfo?: boolean;
|
|
117
|
+
|
|
100
118
|
/**
|
|
101
|
-
*
|
|
119
|
+
* Enriches the API\'s response with information about how the query was processed.
|
|
120
|
+
*/
|
|
121
|
+
explain?: string[];
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Whether to take into account an index\'s synonyms for a particular search.
|
|
125
|
+
*/
|
|
126
|
+
synonyms?: boolean;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
|
|
102
130
|
*/
|
|
103
131
|
clickAnalytics?: boolean;
|
|
132
|
+
|
|
104
133
|
/**
|
|
105
|
-
*
|
|
134
|
+
* Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
|
|
106
135
|
*/
|
|
107
136
|
analytics?: boolean;
|
|
137
|
+
|
|
108
138
|
/**
|
|
109
|
-
*
|
|
139
|
+
* Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
110
140
|
*/
|
|
111
141
|
analyticsTags?: string[];
|
|
142
|
+
|
|
112
143
|
/**
|
|
113
144
|
* Whether to include or exclude a query from the processing-time percentile computation.
|
|
114
145
|
*/
|
|
115
146
|
percentileComputation?: boolean;
|
|
147
|
+
|
|
116
148
|
/**
|
|
117
|
-
*
|
|
149
|
+
* Incidates whether this search will be considered in A/B testing.
|
|
118
150
|
*/
|
|
119
151
|
enableABTest?: boolean;
|
|
120
|
-
/**
|
|
121
|
-
* Whether this search should use AI Re-Ranking.
|
|
122
|
-
*/
|
|
123
|
-
enableReRanking?: boolean;
|
|
124
|
-
reRankingApplyFilter?: ReRankingApplyFilter | null;
|
|
125
152
|
};
|