algoliasearch 5.0.0-alpha.105 → 5.0.0-alpha.107
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/algoliasearch/builds/browser.d.ts +2 -2
- package/dist/algoliasearch/builds/node.d.ts +2 -2
- package/dist/algoliasearch.cjs +191 -191
- package/dist/algoliasearch.esm.browser.js +191 -191
- package/dist/algoliasearch.esm.node.js +191 -191
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/aBTestResponse.d.ts +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +2 -2
- package/dist/client-abtesting/src/abtestingClient.d.ts +3 -3
- package/dist/client-analytics/model/clientMethodProps.d.ts +65 -65
- package/dist/client-analytics/model/searchNoResultEvent.d.ts +1 -1
- package/dist/client-analytics/model/topSearch.d.ts +1 -1
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +66 -66
- package/dist/client-personalization/src/personalizationClient.d.ts +1 -1
- package/dist/client-search/model/acl.d.ts +1 -1
- package/dist/client-search/model/action.d.ts +1 -1
- package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/anchoring.d.ts +1 -1
- package/dist/client-search/model/apiKey.d.ts +8 -8
- package/dist/client-search/model/aroundPrecision.d.ts +1 -1
- package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts +9 -0
- package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
- package/dist/client-search/model/aroundRadius.d.ts +1 -1
- package/dist/client-search/model/aroundRadiusAll.d.ts +3 -0
- package/dist/client-search/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/client-search/model/automaticFacetFilter.d.ts +4 -4
- package/dist/client-search/model/automaticFacetFilters.d.ts +1 -1
- package/dist/client-search/model/baseIndexSettings.d.ts +20 -16
- package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +24 -28
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchResponse.d.ts +6 -6
- package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +3 -3
- package/dist/client-search/model/batchResponse.d.ts +2 -2
- package/dist/client-search/model/builtInOperation.d.ts +2 -2
- package/dist/client-search/model/builtInOperationType.d.ts +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +63 -63
- package/dist/client-search/model/condition.d.ts +7 -3
- package/dist/client-search/model/condition.d.ts.map +1 -1
- package/dist/client-search/model/consequence.d.ts +5 -5
- package/dist/client-search/model/consequenceHide.d.ts +2 -2
- package/dist/client-search/model/consequenceQuery.d.ts +1 -1
- package/dist/client-search/model/consequenceQueryObject.d.ts +2 -2
- package/dist/client-search/model/createdAtResponse.d.ts +1 -1
- package/dist/client-search/model/cursor.d.ts +1 -1
- package/dist/client-search/model/deleteByParams.d.ts +4 -4
- package/dist/client-search/model/deletedAtResponse.d.ts +1 -1
- package/dist/client-search/model/dictionaryEntry.d.ts +5 -5
- package/dist/client-search/model/dictionaryEntryState.d.ts +1 -1
- package/dist/client-search/model/dictionaryLanguage.d.ts +2 -2
- package/dist/client-search/model/dictionarySettingsParams.d.ts +1 -1
- package/dist/client-search/model/distinct.d.ts +1 -1
- package/dist/client-search/model/edit.d.ts +1 -1
- package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/client-search/model/facetFilters.d.ts +1 -1
- package/dist/client-search/model/facetHits.d.ts +2 -2
- package/dist/client-search/model/facetOrdering.d.ts +2 -2
- package/dist/client-search/model/facets.d.ts +2 -2
- package/dist/client-search/model/getObjectsRequest.d.ts +3 -3
- package/dist/client-search/model/getObjectsResponse.d.ts +1 -1
- package/dist/client-search/model/hasPendingMappingsResponse.d.ts +1 -1
- package/dist/client-search/model/highlightResultOption.d.ts +3 -3
- package/dist/client-search/model/hit.d.ts +4 -4
- package/dist/client-search/model/ignorePlurals.d.ts +1 -1
- package/dist/client-search/model/index.d.ts +1 -0
- package/dist/client-search/model/index.d.ts.map +1 -1
- package/dist/client-search/model/indexSettings.d.ts +1 -1
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +30 -34
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/client-search/model/log.d.ts +11 -11
- package/dist/client-search/model/logQuery.d.ts +1 -1
- package/dist/client-search/model/matchLevel.d.ts +1 -1
- package/dist/client-search/model/mode.d.ts +1 -1
- package/dist/client-search/model/multipleBatchResponse.d.ts +2 -2
- package/dist/client-search/model/numericFilters.d.ts +1 -1
- package/dist/client-search/model/operationIndexParams.d.ts +2 -2
- package/dist/client-search/model/operationType.d.ts +1 -1
- package/dist/client-search/model/optionalFilters.d.ts +1 -1
- package/dist/client-search/model/params.d.ts +1 -1
- package/dist/client-search/model/promoteObjectID.d.ts +2 -2
- package/dist/client-search/model/promoteObjectIDs.d.ts +2 -2
- package/dist/client-search/model/queryType.d.ts +1 -1
- package/dist/client-search/model/rankingInfo.d.ts +10 -7
- package/dist/client-search/model/rankingInfo.d.ts.map +1 -1
- package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/client-search/model/removeStopWords.d.ts +1 -1
- package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/client-search/model/renderingContent.d.ts +1 -1
- package/dist/client-search/model/rule.d.ts +5 -5
- package/dist/client-search/model/saveObjectResponse.d.ts +3 -3
- package/dist/client-search/model/saveSynonymResponse.d.ts +1 -1
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +4 -4
- package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/client-search/model/searchForFacetValuesRequest.d.ts +1 -1
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts +3 -0
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchForFacetsOptions.d.ts +2 -2
- package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
- package/dist/client-search/model/searchHits.d.ts +6 -3
- package/dist/client-search/model/searchHits.d.ts.map +1 -1
- package/dist/client-search/model/searchParamsQuery.d.ts +1 -1
- package/dist/client-search/model/searchRulesParams.d.ts +4 -8
- package/dist/client-search/model/searchRulesParams.d.ts.map +1 -1
- package/dist/client-search/model/searchRulesResponse.d.ts +2 -2
- package/dist/client-search/model/searchStrategy.d.ts +1 -1
- package/dist/client-search/model/searchSynonymsParams.d.ts +2 -2
- package/dist/client-search/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/client-search/model/searchUserIdsParams.d.ts +1 -1
- package/dist/client-search/model/searchUserIdsResponse.d.ts +2 -2
- package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +5 -5
- package/dist/client-search/model/semanticSearch.d.ts +2 -2
- package/dist/client-search/model/snippetResultOption.d.ts +2 -2
- package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
- package/dist/client-search/model/tagFilters.d.ts +1 -1
- package/dist/client-search/model/taskStatus.d.ts +1 -1
- package/dist/client-search/model/timeRange.d.ts +2 -2
- package/dist/client-search/model/typoTolerance.d.ts +1 -1
- package/dist/client-search/model/typoToleranceEnum.d.ts +3 -0
- package/dist/client-search/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/client-search/model/updatedAtResponse.d.ts +1 -1
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +2 -2
- package/dist/client-search/model/updatedRuleResponse.d.ts +2 -2
- package/dist/client-search/model/userHit.d.ts +1 -1
- package/dist/client-search/model/userId.d.ts +1 -1
- package/dist/client-search/model/value.d.ts +1 -1
- package/dist/client-search/src/searchClient.d.ts +124 -123
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/lite.cjs +3 -3
- package/dist/lite/lite.esm.browser.js +3 -3
- package/dist/lite/lite.esm.node.js +3 -3
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/acl.d.ts +1 -1
- package/dist/lite/model/action.d.ts +1 -1
- package/dist/lite/model/addApiKeyResponse.d.ts +1 -1
- package/dist/lite/model/anchoring.d.ts +1 -1
- package/dist/lite/model/apiKey.d.ts +8 -8
- package/dist/lite/model/aroundPrecision.d.ts +1 -1
- package/dist/lite/model/aroundPrecisionFromValueInner.d.ts +9 -0
- package/dist/lite/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
- package/dist/lite/model/aroundRadius.d.ts +1 -1
- package/dist/lite/model/aroundRadiusAll.d.ts +3 -0
- package/dist/lite/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/lite/model/automaticFacetFilter.d.ts +4 -4
- package/dist/lite/model/automaticFacetFilters.d.ts +1 -1
- package/dist/lite/model/baseIndexSettings.d.ts +20 -16
- package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +24 -28
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/lite/model/baseSearchResponse.d.ts +6 -6
- package/dist/lite/model/builtInOperation.d.ts +2 -2
- package/dist/lite/model/builtInOperationType.d.ts +1 -1
- package/dist/lite/model/condition.d.ts +7 -3
- package/dist/lite/model/condition.d.ts.map +1 -1
- package/dist/lite/model/consequence.d.ts +5 -5
- package/dist/lite/model/consequenceHide.d.ts +2 -2
- package/dist/lite/model/consequenceQuery.d.ts +1 -1
- package/dist/lite/model/consequenceQueryObject.d.ts +2 -2
- package/dist/lite/model/cursor.d.ts +1 -1
- package/dist/lite/model/deleteByParams.d.ts +4 -4
- package/dist/lite/model/dictionaryEntry.d.ts +5 -5
- package/dist/lite/model/dictionaryEntryState.d.ts +1 -1
- package/dist/lite/model/dictionaryLanguage.d.ts +2 -2
- package/dist/lite/model/distinct.d.ts +1 -1
- package/dist/lite/model/edit.d.ts +1 -1
- package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/lite/model/facetFilters.d.ts +1 -1
- package/dist/lite/model/facetHits.d.ts +2 -2
- package/dist/lite/model/facetOrdering.d.ts +2 -2
- package/dist/lite/model/facets.d.ts +2 -2
- package/dist/lite/model/highlightResultOption.d.ts +3 -3
- package/dist/lite/model/hit.d.ts +4 -4
- package/dist/lite/model/ignorePlurals.d.ts +1 -1
- package/dist/lite/model/index.d.ts +1 -0
- package/dist/lite/model/index.d.ts.map +1 -1
- package/dist/lite/model/indexSettings.d.ts +1 -1
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts +30 -34
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/lite/model/matchLevel.d.ts +1 -1
- package/dist/lite/model/mode.d.ts +1 -1
- package/dist/lite/model/numericFilters.d.ts +1 -1
- package/dist/lite/model/operationType.d.ts +1 -1
- package/dist/lite/model/optionalFilters.d.ts +1 -1
- package/dist/lite/model/params.d.ts +1 -1
- package/dist/lite/model/promoteObjectID.d.ts +2 -2
- package/dist/lite/model/promoteObjectIDs.d.ts +2 -2
- package/dist/lite/model/queryType.d.ts +1 -1
- package/dist/lite/model/rankingInfo.d.ts +10 -7
- package/dist/lite/model/rankingInfo.d.ts.map +1 -1
- package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/lite/model/removeStopWords.d.ts +1 -1
- package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/lite/model/renderingContent.d.ts +1 -1
- package/dist/lite/model/rule.d.ts +5 -5
- package/dist/lite/model/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/lite/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts +3 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/lite/model/searchForFacetsOptions.d.ts +2 -2
- package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
- package/dist/lite/model/searchHits.d.ts +6 -3
- package/dist/lite/model/searchHits.d.ts.map +1 -1
- package/dist/lite/model/searchParamsQuery.d.ts +1 -1
- package/dist/lite/model/searchStrategy.d.ts +1 -1
- package/dist/lite/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/lite/model/securedAPIKeyRestrictions.d.ts +5 -5
- package/dist/lite/model/semanticSearch.d.ts +2 -2
- package/dist/lite/model/snippetResultOption.d.ts +2 -2
- package/dist/lite/model/sortRemainingBy.d.ts +1 -1
- package/dist/lite/model/tagFilters.d.ts +1 -1
- package/dist/lite/model/taskStatus.d.ts +1 -1
- package/dist/lite/model/timeRange.d.ts +2 -2
- package/dist/lite/model/typoTolerance.d.ts +1 -1
- package/dist/lite/model/typoToleranceEnum.d.ts +3 -0
- package/dist/lite/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/lite/model/updatedRuleResponse.d.ts +2 -2
- package/dist/lite/model/userId.d.ts +1 -1
- package/dist/lite/model/value.d.ts +1 -1
- package/dist/lite/src/liteClient.d.ts +3 -3
- package/dist/lite/src/liteClient.d.ts.map +1 -1
- package/lite/model/acl.ts +1 -1
- package/lite/model/action.ts +1 -1
- package/lite/model/addApiKeyResponse.ts +1 -1
- package/lite/model/anchoring.ts +1 -1
- package/lite/model/apiKey.ts +8 -8
- package/lite/model/aroundPrecision.ts +1 -1
- package/lite/model/aroundPrecisionFromValueInner.ts +9 -0
- package/lite/model/aroundRadius.ts +1 -1
- package/lite/model/aroundRadiusAll.ts +3 -0
- package/lite/model/automaticFacetFilter.ts +4 -4
- package/lite/model/automaticFacetFilters.ts +1 -1
- package/lite/model/baseIndexSettings.ts +21 -16
- package/lite/model/baseSearchParamsWithoutQuery.ts +24 -29
- package/lite/model/baseSearchResponse.ts +6 -6
- package/lite/model/builtInOperation.ts +2 -2
- package/lite/model/builtInOperationType.ts +1 -1
- package/lite/model/condition.ts +8 -3
- package/lite/model/consequence.ts +5 -5
- package/lite/model/consequenceHide.ts +2 -2
- package/lite/model/consequenceQuery.ts +1 -1
- package/lite/model/consequenceQueryObject.ts +2 -2
- package/lite/model/cursor.ts +1 -1
- package/lite/model/deleteByParams.ts +4 -4
- package/lite/model/dictionaryEntry.ts +5 -5
- package/lite/model/dictionaryEntryState.ts +1 -1
- package/lite/model/dictionaryLanguage.ts +2 -2
- package/lite/model/distinct.ts +1 -1
- package/lite/model/edit.ts +1 -1
- package/lite/model/exactOnSingleWordQuery.ts +1 -1
- package/lite/model/facetFilters.ts +1 -1
- package/lite/model/facetHits.ts +2 -2
- package/lite/model/facetOrdering.ts +2 -2
- package/lite/model/facets.ts +2 -2
- package/lite/model/highlightResultOption.ts +3 -3
- package/lite/model/hit.ts +4 -4
- package/lite/model/ignorePlurals.ts +1 -1
- package/lite/model/index.ts +1 -0
- package/lite/model/indexSettings.ts +1 -1
- package/lite/model/indexSettingsAsSearchParams.ts +30 -35
- package/lite/model/matchLevel.ts +1 -1
- package/lite/model/mode.ts +1 -1
- package/lite/model/numericFilters.ts +1 -1
- package/lite/model/operationType.ts +1 -1
- package/lite/model/optionalFilters.ts +1 -1
- package/lite/model/params.ts +1 -1
- package/lite/model/promoteObjectID.ts +2 -2
- package/lite/model/promoteObjectIDs.ts +2 -2
- package/lite/model/queryType.ts +1 -1
- package/lite/model/rankingInfo.ts +10 -7
- package/lite/model/reRankingApplyFilter.ts +1 -1
- package/lite/model/removeStopWords.ts +1 -1
- package/lite/model/removeWordsIfNoResults.ts +1 -1
- package/lite/model/renderingContent.ts +1 -1
- package/lite/model/rule.ts +5 -5
- package/lite/model/searchDictionaryEntriesResponse.ts +25 -0
- package/lite/model/searchForFacetValuesResponse.ts +3 -0
- package/lite/model/searchForFacetsOptions.ts +2 -2
- package/lite/model/searchForHitsOptions.ts +1 -1
- package/lite/model/searchHits.ts +6 -3
- package/lite/model/searchParamsQuery.ts +1 -1
- package/lite/model/searchStrategy.ts +1 -1
- package/lite/model/searchSynonymsResponse.ts +2 -2
- package/lite/model/securedAPIKeyRestrictions.ts +5 -5
- package/lite/model/semanticSearch.ts +2 -2
- package/lite/model/snippetResultOption.ts +2 -2
- package/lite/model/sortRemainingBy.ts +1 -1
- package/lite/model/tagFilters.ts +1 -1
- package/lite/model/taskStatus.ts +1 -1
- package/lite/model/timeRange.ts +2 -2
- package/lite/model/typoTolerance.ts +1 -1
- package/lite/model/typoToleranceEnum.ts +3 -0
- package/lite/model/updatedRuleResponse.ts +2 -2
- package/lite/model/userId.ts +1 -1
- package/lite/model/value.ts +1 -1
- package/lite/src/liteClient.ts +3 -3
- package/package.json +11 -11
|
@@ -17,7 +17,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
|
|
|
17
17
|
import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
|
|
18
18
|
import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
|
|
19
19
|
import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
|
|
20
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
20
|
+
export declare const apiClientVersion = "5.0.0-alpha.107";
|
|
21
21
|
export declare const REGIONS: readonly ["de", "us"];
|
|
22
22
|
export type Region = (typeof REGIONS)[number];
|
|
23
23
|
export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
@@ -88,9 +88,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
88
88
|
* - analytics.
|
|
89
89
|
*
|
|
90
90
|
* @param getAverageClickPosition - The getAverageClickPosition object.
|
|
91
|
-
* @param getAverageClickPosition.index - Index name
|
|
92
|
-
* @param getAverageClickPosition.startDate - Start date (
|
|
93
|
-
* @param getAverageClickPosition.endDate - End date (
|
|
91
|
+
* @param getAverageClickPosition.index - Index name.
|
|
92
|
+
* @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
93
|
+
* @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
94
94
|
* @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
95
95
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
96
96
|
*/
|
|
@@ -102,9 +102,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
102
102
|
* - analytics.
|
|
103
103
|
*
|
|
104
104
|
* @param getClickPositions - The getClickPositions object.
|
|
105
|
-
* @param getClickPositions.index - Index name
|
|
106
|
-
* @param getClickPositions.startDate - Start date (
|
|
107
|
-
* @param getClickPositions.endDate - End date (
|
|
105
|
+
* @param getClickPositions.index - Index name.
|
|
106
|
+
* @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
107
|
+
* @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
108
108
|
* @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
109
109
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
110
110
|
*/
|
|
@@ -116,9 +116,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
116
116
|
* - analytics.
|
|
117
117
|
*
|
|
118
118
|
* @param getClickThroughRate - The getClickThroughRate object.
|
|
119
|
-
* @param getClickThroughRate.index - Index name
|
|
120
|
-
* @param getClickThroughRate.startDate - Start date (
|
|
121
|
-
* @param getClickThroughRate.endDate - End date (
|
|
119
|
+
* @param getClickThroughRate.index - Index name.
|
|
120
|
+
* @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
121
|
+
* @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
122
122
|
* @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
123
123
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
124
124
|
*/
|
|
@@ -130,9 +130,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
130
130
|
* - analytics.
|
|
131
131
|
*
|
|
132
132
|
* @param getConversationRate - The getConversationRate object.
|
|
133
|
-
* @param getConversationRate.index - Index name
|
|
134
|
-
* @param getConversationRate.startDate - Start date (
|
|
135
|
-
* @param getConversationRate.endDate - End date (
|
|
133
|
+
* @param getConversationRate.index - Index name.
|
|
134
|
+
* @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
135
|
+
* @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
136
136
|
* @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
137
137
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
138
138
|
*/
|
|
@@ -144,9 +144,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
144
144
|
* - analytics.
|
|
145
145
|
*
|
|
146
146
|
* @param getNoClickRate - The getNoClickRate object.
|
|
147
|
-
* @param getNoClickRate.index - Index name
|
|
148
|
-
* @param getNoClickRate.startDate - Start date (
|
|
149
|
-
* @param getNoClickRate.endDate - End date (
|
|
147
|
+
* @param getNoClickRate.index - Index name.
|
|
148
|
+
* @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
149
|
+
* @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
150
150
|
* @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
151
151
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
152
152
|
*/
|
|
@@ -158,9 +158,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
158
158
|
* - analytics.
|
|
159
159
|
*
|
|
160
160
|
* @param getNoResultsRate - The getNoResultsRate object.
|
|
161
|
-
* @param getNoResultsRate.index - Index name
|
|
162
|
-
* @param getNoResultsRate.startDate - Start date (
|
|
163
|
-
* @param getNoResultsRate.endDate - End date (
|
|
161
|
+
* @param getNoResultsRate.index - Index name.
|
|
162
|
+
* @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
163
|
+
* @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
164
164
|
* @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
165
165
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
166
166
|
*/
|
|
@@ -172,9 +172,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
172
172
|
* - analytics.
|
|
173
173
|
*
|
|
174
174
|
* @param getSearchesCount - The getSearchesCount object.
|
|
175
|
-
* @param getSearchesCount.index - Index name
|
|
176
|
-
* @param getSearchesCount.startDate - Start date (
|
|
177
|
-
* @param getSearchesCount.endDate - End date (
|
|
175
|
+
* @param getSearchesCount.index - Index name.
|
|
176
|
+
* @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
177
|
+
* @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
178
178
|
* @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
179
179
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
180
180
|
*/
|
|
@@ -186,11 +186,11 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
186
186
|
* - analytics.
|
|
187
187
|
*
|
|
188
188
|
* @param getSearchesNoClicks - The getSearchesNoClicks object.
|
|
189
|
-
* @param getSearchesNoClicks.index - Index name
|
|
190
|
-
* @param getSearchesNoClicks.startDate - Start date (
|
|
191
|
-
* @param getSearchesNoClicks.endDate - End date (
|
|
192
|
-
* @param getSearchesNoClicks.limit - Number of
|
|
193
|
-
* @param getSearchesNoClicks.offset - Position of the
|
|
189
|
+
* @param getSearchesNoClicks.index - Index name.
|
|
190
|
+
* @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
191
|
+
* @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
192
|
+
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
193
|
+
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
194
194
|
* @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
195
195
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
196
196
|
*/
|
|
@@ -202,11 +202,11 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
202
202
|
* - analytics.
|
|
203
203
|
*
|
|
204
204
|
* @param getSearchesNoResults - The getSearchesNoResults object.
|
|
205
|
-
* @param getSearchesNoResults.index - Index name
|
|
206
|
-
* @param getSearchesNoResults.startDate - Start date (
|
|
207
|
-
* @param getSearchesNoResults.endDate - End date (
|
|
208
|
-
* @param getSearchesNoResults.limit - Number of
|
|
209
|
-
* @param getSearchesNoResults.offset - Position of the
|
|
205
|
+
* @param getSearchesNoResults.index - Index name.
|
|
206
|
+
* @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
207
|
+
* @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
208
|
+
* @param getSearchesNoResults.limit - Number of items to return.
|
|
209
|
+
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
210
210
|
* @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
211
211
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
212
212
|
*/
|
|
@@ -218,7 +218,7 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
218
218
|
* - analytics.
|
|
219
219
|
*
|
|
220
220
|
* @param getStatus - The getStatus object.
|
|
221
|
-
* @param getStatus.index - Index name
|
|
221
|
+
* @param getStatus.index - Index name.
|
|
222
222
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
223
223
|
*/
|
|
224
224
|
getStatus({ index }: GetStatusProps, requestOptions?: RequestOptions): Promise<GetStatusResponse>;
|
|
@@ -229,11 +229,11 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
229
229
|
* - analytics.
|
|
230
230
|
*
|
|
231
231
|
* @param getTopCountries - The getTopCountries object.
|
|
232
|
-
* @param getTopCountries.index - Index name
|
|
233
|
-
* @param getTopCountries.startDate - Start date (
|
|
234
|
-
* @param getTopCountries.endDate - End date (
|
|
235
|
-
* @param getTopCountries.limit - Number of
|
|
236
|
-
* @param getTopCountries.offset - Position of the
|
|
232
|
+
* @param getTopCountries.index - Index name.
|
|
233
|
+
* @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
234
|
+
* @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
235
|
+
* @param getTopCountries.limit - Number of items to return.
|
|
236
|
+
* @param getTopCountries.offset - Position of the first item to return.
|
|
237
237
|
* @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
238
238
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
239
239
|
*/
|
|
@@ -245,12 +245,12 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
245
245
|
* - analytics.
|
|
246
246
|
*
|
|
247
247
|
* @param getTopFilterAttributes - The getTopFilterAttributes object.
|
|
248
|
-
* @param getTopFilterAttributes.index - Index name
|
|
248
|
+
* @param getTopFilterAttributes.index - Index name.
|
|
249
249
|
* @param getTopFilterAttributes.search - User query.
|
|
250
|
-
* @param getTopFilterAttributes.startDate - Start date (
|
|
251
|
-
* @param getTopFilterAttributes.endDate - End date (
|
|
252
|
-
* @param getTopFilterAttributes.limit - Number of
|
|
253
|
-
* @param getTopFilterAttributes.offset - Position of the
|
|
250
|
+
* @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
251
|
+
* @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
252
|
+
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
253
|
+
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
254
254
|
* @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
255
255
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
256
256
|
*/
|
|
@@ -263,12 +263,12 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
263
263
|
*
|
|
264
264
|
* @param getTopFilterForAttribute - The getTopFilterForAttribute object.
|
|
265
265
|
* @param getTopFilterForAttribute.attribute - Attribute name.
|
|
266
|
-
* @param getTopFilterForAttribute.index - Index name
|
|
266
|
+
* @param getTopFilterForAttribute.index - Index name.
|
|
267
267
|
* @param getTopFilterForAttribute.search - User query.
|
|
268
|
-
* @param getTopFilterForAttribute.startDate - Start date (
|
|
269
|
-
* @param getTopFilterForAttribute.endDate - End date (
|
|
270
|
-
* @param getTopFilterForAttribute.limit - Number of
|
|
271
|
-
* @param getTopFilterForAttribute.offset - Position of the
|
|
268
|
+
* @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
269
|
+
* @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
270
|
+
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
271
|
+
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
272
272
|
* @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
273
273
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
274
274
|
*/
|
|
@@ -280,12 +280,12 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
280
280
|
* - analytics.
|
|
281
281
|
*
|
|
282
282
|
* @param getTopFiltersNoResults - The getTopFiltersNoResults object.
|
|
283
|
-
* @param getTopFiltersNoResults.index - Index name
|
|
283
|
+
* @param getTopFiltersNoResults.index - Index name.
|
|
284
284
|
* @param getTopFiltersNoResults.search - User query.
|
|
285
|
-
* @param getTopFiltersNoResults.startDate - Start date (
|
|
286
|
-
* @param getTopFiltersNoResults.endDate - End date (
|
|
287
|
-
* @param getTopFiltersNoResults.limit - Number of
|
|
288
|
-
* @param getTopFiltersNoResults.offset - Position of the
|
|
285
|
+
* @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
286
|
+
* @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
287
|
+
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
288
|
+
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
289
289
|
* @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
290
290
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
291
291
|
*/
|
|
@@ -297,13 +297,13 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
297
297
|
* - analytics.
|
|
298
298
|
*
|
|
299
299
|
* @param getTopHits - The getTopHits object.
|
|
300
|
-
* @param getTopHits.index - Index name
|
|
300
|
+
* @param getTopHits.index - Index name.
|
|
301
301
|
* @param getTopHits.search - User query.
|
|
302
302
|
* @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
|
|
303
|
-
* @param getTopHits.startDate - Start date (
|
|
304
|
-
* @param getTopHits.endDate - End date (
|
|
305
|
-
* @param getTopHits.limit - Number of
|
|
306
|
-
* @param getTopHits.offset - Position of the
|
|
303
|
+
* @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
304
|
+
* @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
305
|
+
* @param getTopHits.limit - Number of items to return.
|
|
306
|
+
* @param getTopHits.offset - Position of the first item to return.
|
|
307
307
|
* @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
308
308
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
309
309
|
*/
|
|
@@ -315,14 +315,14 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
315
315
|
* - analytics.
|
|
316
316
|
*
|
|
317
317
|
* @param getTopSearches - The getTopSearches object.
|
|
318
|
-
* @param getTopSearches.index - Index name
|
|
318
|
+
* @param getTopSearches.index - Index name.
|
|
319
319
|
* @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
|
|
320
|
-
* @param getTopSearches.startDate - Start date (
|
|
321
|
-
* @param getTopSearches.endDate - End date (
|
|
320
|
+
* @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
321
|
+
* @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
322
322
|
* @param getTopSearches.orderBy - Reorder the results.
|
|
323
323
|
* @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
|
|
324
|
-
* @param getTopSearches.limit - Number of
|
|
325
|
-
* @param getTopSearches.offset - Position of the
|
|
324
|
+
* @param getTopSearches.limit - Number of items to return.
|
|
325
|
+
* @param getTopSearches.offset - Position of the first item to return.
|
|
326
326
|
* @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
327
327
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
328
328
|
*/
|
|
@@ -334,9 +334,9 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
334
334
|
* - analytics.
|
|
335
335
|
*
|
|
336
336
|
* @param getUsersCount - The getUsersCount object.
|
|
337
|
-
* @param getUsersCount.index - Index name
|
|
338
|
-
* @param getUsersCount.startDate - Start date (
|
|
339
|
-
* @param getUsersCount.endDate - End date (
|
|
337
|
+
* @param getUsersCount.index - Index name.
|
|
338
|
+
* @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
339
|
+
* @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
340
340
|
* @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
341
341
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
342
342
|
*/
|
|
@@ -4,7 +4,7 @@ import type { DeleteUserProfileResponse } from '../model/deleteUserProfileRespon
|
|
|
4
4
|
import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
|
|
5
5
|
import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
|
|
6
6
|
import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
7
|
+
export declare const apiClientVersion = "5.0.0-alpha.107";
|
|
8
8
|
export declare const REGIONS: readonly ["eu", "us"];
|
|
9
9
|
export type Region = (typeof REGIONS)[number];
|
|
10
10
|
export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Access control list permissions.
|
|
3
3
|
*/
|
|
4
4
|
export type Acl = 'addObject' | 'analytics' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'inference' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
|
|
5
5
|
//# sourceMappingURL=acl.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Which part of the search query the pattern should match: - `startsWith`. The pattern must match the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as pattern with `anchoring: is`.
|
|
3
3
|
*/
|
|
4
4
|
export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
|
|
5
5
|
//# sourceMappingURL=anchoring.d.ts.map
|
|
@@ -4,35 +4,35 @@ import type { Acl } from './acl';
|
|
|
4
4
|
*/
|
|
5
5
|
export type ApiKey = {
|
|
6
6
|
/**
|
|
7
|
-
* [
|
|
7
|
+
* Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint\'s reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
|
|
8
8
|
*/
|
|
9
9
|
acl: Acl[];
|
|
10
10
|
/**
|
|
11
|
-
* Description of an API key
|
|
11
|
+
* Description of an API key to help you identify this API key.
|
|
12
12
|
*/
|
|
13
13
|
description?: string;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
|
|
16
16
|
*/
|
|
17
17
|
indexes?: string[];
|
|
18
18
|
/**
|
|
19
|
-
* Maximum number of
|
|
19
|
+
* Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
|
|
20
20
|
*/
|
|
21
21
|
maxHitsPerQuery?: number;
|
|
22
22
|
/**
|
|
23
|
-
* Maximum number of API
|
|
23
|
+
* Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there\'s no limit.
|
|
24
24
|
*/
|
|
25
25
|
maxQueriesPerIPPerHour?: number;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address that\'s outside the restricted range.
|
|
28
28
|
*/
|
|
29
29
|
queryParameters?: string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`): - `https://algolia.com/_*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\". Like all HTTP headers, referrers can be spoofed. Don\'t rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
|
|
32
32
|
*/
|
|
33
33
|
referers?: string[];
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Duration (in seconds) after which the API key expires. By default, API keys don\'t expire.
|
|
36
36
|
*/
|
|
37
37
|
validity?: number;
|
|
38
38
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
|
|
2
2
|
/**
|
|
3
|
-
* Precision of a
|
|
3
|
+
* Precision of a coordinate-based search in meters to group results with similar distances. The Geo ranking criterion considers all matches within the same range of distances to be equal.
|
|
4
4
|
*/
|
|
5
5
|
export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
|
|
6
6
|
//# sourceMappingURL=aroundPrecision.d.ts.map
|
|
@@ -1,5 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Range object with lower and upper values in meters to define custom ranges.
|
|
3
|
+
*/
|
|
1
4
|
export type AroundPrecisionFromValueInner = {
|
|
5
|
+
/**
|
|
6
|
+
* Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
|
|
7
|
+
*/
|
|
2
8
|
from?: number;
|
|
9
|
+
/**
|
|
10
|
+
* Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
|
|
11
|
+
*/
|
|
3
12
|
value?: number;
|
|
4
13
|
};
|
|
5
14
|
//# sourceMappingURL=aroundPrecisionFromValueInner.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
|
|
1
|
+
{"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { AroundRadiusAll } from './aroundRadiusAll';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
|
|
4
4
|
*/
|
|
5
5
|
export type AroundRadius = AroundRadiusAll | number;
|
|
6
6
|
//# sourceMappingURL=aroundRadius.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}
|
|
1
|
+
{"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Filter or optional filter to be applied to the search.
|
|
3
3
|
*/
|
|
4
4
|
export type AutomaticFacetFilter = {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
|
|
7
7
|
*/
|
|
8
8
|
facet: string;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Filter scores to give different weights to individual filters.
|
|
11
11
|
*/
|
|
12
12
|
score?: number;
|
|
13
13
|
/**
|
|
14
|
-
* Whether the filter is disjunctive
|
|
14
|
+
* Whether the filter is disjunctive or conjunctive. If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
|
|
15
15
|
*/
|
|
16
16
|
disjunctive?: boolean;
|
|
17
17
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { AutomaticFacetFilter } from './automaticFacetFilter';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Filter to be applied to the search. You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies.
|
|
4
4
|
*/
|
|
5
5
|
export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
|
|
6
6
|
//# sourceMappingURL=automaticFacetFilters.d.ts.map
|
|
@@ -1,66 +1,70 @@
|
|
|
1
1
|
export type BaseIndexSettings = {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are ways to categorize search results based on attributes. Facets can be used to let user filter search results. By default, no attribute is used for faceting. **Modifiers** <dl> <dt><code>filterOnly(\"ATTRIBUTE\")</code></dt> <dd>Allows using this attribute as a filter, but doesn\'t evalue the facet values.</dd> <dt><code>searchable(\"ATTRIBUTE\")</code></dt> <dd>Allows searching for facet values.</dd> <dt><code>afterDistinct(\"ATTRIBUTE\")</code></dt> <dd> Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. </dd> </dl> Without modifiers, the attribute is used as a regular facet.
|
|
4
|
+
*/
|
|
5
|
+
attributesForFaceting?: string[];
|
|
6
|
+
/**
|
|
7
|
+
* Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. **Modifier** <dl> <dt><code>virtual(\"REPLICA\")</code></dt> <dd> Create a virtual replica, Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). </dd> </dl> Without modifier, a standard replica is created, which duplicates your record count and is used for strict, or [exhaustive sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/exhaustive-sort/).
|
|
4
8
|
*/
|
|
5
9
|
replicas?: string[];
|
|
6
10
|
/**
|
|
7
|
-
* Maximum number of
|
|
11
|
+
* Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can\'t be guaranteed.
|
|
8
12
|
*/
|
|
9
13
|
paginationLimitedTo?: number;
|
|
10
14
|
/**
|
|
11
|
-
* Attributes that can\'t be retrieved at query time.
|
|
15
|
+
* Attributes that can\'t be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results.
|
|
12
16
|
*/
|
|
13
17
|
unretrievableAttributes?: string[];
|
|
14
18
|
/**
|
|
15
|
-
* Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
|
|
19
|
+
* Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
|
|
16
20
|
*/
|
|
17
21
|
disableTypoToleranceOnWords?: string[];
|
|
18
22
|
/**
|
|
19
|
-
* Attributes
|
|
23
|
+
* Attributes, for which you want to support [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). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese.
|
|
20
24
|
*/
|
|
21
25
|
attributesToTransliterate?: string[];
|
|
22
26
|
/**
|
|
23
|
-
* Attributes
|
|
27
|
+
* Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
|
|
24
28
|
*/
|
|
25
29
|
camelCaseAttributes?: string[];
|
|
26
30
|
/**
|
|
27
|
-
*
|
|
31
|
+
* Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).
|
|
28
32
|
*/
|
|
29
33
|
decompoundedAttributes?: Record<string, any>;
|
|
30
34
|
/**
|
|
31
|
-
*
|
|
35
|
+
* [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for a language for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
|
|
32
36
|
*/
|
|
33
37
|
indexLanguages?: string[];
|
|
34
38
|
/**
|
|
35
|
-
*
|
|
39
|
+
* Searchable 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).
|
|
36
40
|
*/
|
|
37
41
|
disablePrefixOnAttributes?: string[];
|
|
38
42
|
/**
|
|
39
|
-
*
|
|
43
|
+
* Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
|
|
40
44
|
*/
|
|
41
45
|
allowCompressionOfIntegerArray?: boolean;
|
|
42
46
|
/**
|
|
43
|
-
* 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).
|
|
47
|
+
* 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). By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** <dl> <dt><code>equalOnly(\"ATTRIBUTE\")</code></dt> <dd> Support only filtering based on equality comparisons `=` and `!=`. </dd> </dl> Without modifier, all numeric comparisons are supported.
|
|
44
48
|
*/
|
|
45
49
|
numericAttributesForFiltering?: string[];
|
|
46
50
|
/**
|
|
47
|
-
* Controls which separators are
|
|
51
|
+
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren\'t indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
|
|
48
52
|
*/
|
|
49
53
|
separatorsToIndex?: string;
|
|
50
54
|
/**
|
|
51
|
-
*
|
|
55
|
+
* Attributes used for searching. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** <dl> <dt><code>unordered(\"ATTRIBUTE\")</code></dt> <dd> Ignore the position of a match within the attribute. </dd> </dl> Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
|
|
52
56
|
*/
|
|
53
57
|
searchableAttributes?: string[];
|
|
54
58
|
/**
|
|
55
|
-
*
|
|
59
|
+
* An object with custom data. You can store up to 32 kB as custom data.
|
|
56
60
|
*/
|
|
57
61
|
userData?: any | null;
|
|
58
62
|
/**
|
|
59
|
-
*
|
|
63
|
+
* Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
60
64
|
*/
|
|
61
65
|
customNormalization?: Record<string, Record<string, string>>;
|
|
62
66
|
/**
|
|
63
|
-
*
|
|
67
|
+
* Attribute that should be used to establish groups of results. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
|
|
64
68
|
*/
|
|
65
69
|
attributeForDistinct?: string;
|
|
66
70
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"baseIndexSettings.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseIndexSettings.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7D;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC"}
|
|
1
|
+
{"version":3,"file":"baseIndexSettings.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseIndexSettings.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7D;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC"}
|