Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/algolia/algoliasearch-client-javascript
/ functions
Functions
947 in github.com/algolia/algoliasearch-client-javascript
⨍
Functions
947
◇
Types & classes
22
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/abtesting/src/abtestingV3Client.ts:473
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/client-search/src/searchClient.ts:1804
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/composition/src/compositionClient.ts:413
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/client-abtesting/src/abtestingClient.ts:400
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/ingestion/src/ingestionClient.ts:968
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/advanced-personalization/src/advancedPersonalizationClient.ts:398
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/client-query-suggestions/src/querySuggestionsClient.ts:391
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/client-analytics/src/analyticsClient.ts:368
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/agent-studio/src/agentStudioClient.ts:1446
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/recommend/src/recommendClient.ts:432
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/client-insights/src/insightsClient.ts:324
Function
customPutWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/monitoring/src/monitoringClient.ts:326
Function
debug
(message: string, args?: any | undefined)
packages/logger-console/src/logger.ts:6
Function
debug
(_message: string, _args?: any | undefined)
packages/client-common/src/logger/createNullLogger.ts:5
Function
defaultValue
()
packages/client-common/src/__tests__/cache/browser-local-storage-cache.test.ts:29
Function
defaultValue
()
packages/client-common/src/__tests__/cache/memory-cache.test.ts:19
Function
defaultValue
()
packages/client-common/src/__tests__/cache/fallbackable-cache.test.ts:24
Function
delete
(key: Record<string, any> | string)
packages/client-common/src/cache/createBrowserLocalStorageCache.ts:99
Function
delete
(_key: Record<string, any> | string)
packages/client-common/src/cache/createNullCache.ts:21
Function
delete
(key: Record<string, unknown> | string)
packages/client-common/src/cache/createMemoryCache.ts:31
Function
delete
(key: Record<string, any> | string)
packages/client-common/src/cache/createFallbackableCache.ts:31
Function
deleteABTest
* Deletes an A/B test by its ID. * * Required API Key ACLs: * - editSettings * @param deleteABTest - The deleteABTest object.
packages/abtesting/src/abtestingV3Client.ts:503
Function
deleteABTest
* This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by `DELETE /3/abtests/{id}`. Deletes an A/B test by its ID. *
packages/client-abtesting/src/abtestingClient.ts:432
Function
deleteABTestWithHTTPInfo
* Deletes an A/B test by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures the
packages/abtesting/src/abtestingV3Client.ts:531
Function
deleteABTestWithHTTPInfo
* This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by `DELETE /3/abtests/{id}`. Deletes an A/B test by its ID. *
packages/client-abtesting/src/abtestingClient.ts:462
Function
deleteAgent
* Delete the specified agent. * * Required API Key ACLs: * - editSettings * @param deleteAgent - The deleteAgent object. * @
packages/agent-studio/src/agentStudioClient.ts:1476
Function
deleteAgentConversations
* Deletes the conversations matching the given filters. * * Required API Key ACLs: * - logs * @param deleteAgentConversations - T
packages/agent-studio/src/agentStudioClient.ts:1535
Function
deleteAgentConversationsWithHTTPInfo
* Deletes the conversations matching the given filters. * * Resolves with the full HTTP response information: status code, headers (when the
packages/agent-studio/src/agentStudioClient.ts:1579
Function
deleteAgentWithHTTPInfo
* Delete the specified agent. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them),
packages/agent-studio/src/agentStudioClient.ts:1504
Function
deleteAllowedDomain
* Remove an allowed domain by id. * * Required API Key ACLs: * - editSettings * @param deleteAllowedDomain - The deleteAllowedDom
packages/agent-studio/src/agentStudioClient.ts:1620
Function
deleteAllowedDomainWithHTTPInfo
* Remove an allowed domain by id. * * Resolves with the full HTTP response information: status code, headers (when the requester captures th
packages/agent-studio/src/agentStudioClient.ts:1656
Function
deleteApiKey
* Deletes the API key. * * Required API Key ACLs: * - admin * @param deleteApiKey - The deleteApiKey object. * @param delete
packages/client-search/src/searchClient.ts:1834
Function
deleteApiKeyWithHTTPInfo
* Deletes the API key. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw bo
packages/client-search/src/searchClient.ts:1862
Function
deleteAuthentication
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination. * * Required AP
packages/ingestion/src/ingestionClient.ts:1000
Function
deleteAuthenticationWithHTTPInfo
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination. * * Resolves wi
packages/ingestion/src/ingestionClient.ts:1036
Function
deleteBy
* This operation doesn\'t accept empty filters. This operation is resource-intensive. Use it only if you can\'t get the object IDs of the records you
packages/client-search/src/searchClient.ts:1892
Function
deleteByWithHTTPInfo
* This operation doesn\'t accept empty filters. This operation is resource-intensive. Use it only if you can\'t get the object IDs of the records you
packages/client-search/src/searchClient.ts:1927
Function
deleteComposition
* Delete a composition from the current Algolia application. * * Required API Key ACLs: * - editSettings * @param deleteCompositi
packages/composition/src/compositionClient.ts:443
Function
deleteCompositionRule
* Delete a Composition Rule from the specified Composition ID. * * Required API Key ACLs: * - editSettings * @param deleteComposi
packages/composition/src/compositionClient.ts:510
Function
deleteCompositionRuleWithHTTPInfo
* Delete a Composition Rule from the specified Composition ID. * * Resolves with the full HTTP response information: status code, headers (w
packages/composition/src/compositionClient.ts:546
Function
deleteCompositionWithHTTPInfo
* Delete a composition from the current Algolia application. * * Resolves with the full HTTP response information: status code, headers (whe
packages/composition/src/compositionClient.ts:477
Function
deleteConfig
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the
packages/client-query-suggestions/src/querySuggestionsClient.ts:421
Function
deleteConfigWithHTTPInfo
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the
packages/client-query-suggestions/src/querySuggestionsClient.ts:449
Function
deleteConversation
* Deletes the conversation with the given ID. * * Required API Key ACLs: * - logs * @param deleteConversation - The deleteConvers
packages/agent-studio/src/agentStudioClient.ts:1690
Function
deleteConversationWithHTTPInfo
* Deletes the conversation with the given ID. * * Resolves with the full HTTP response information: status code, headers (when the requester
packages/agent-studio/src/agentStudioClient.ts:1726
Function
deleteDestination
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks. * * Required API Key ACLs: * - addObje
packages/ingestion/src/ingestionClient.ts:1070
Function
deleteDestinationWithHTTPInfo
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks. * * Resolves with the full HTTP response inf
packages/ingestion/src/ingestionClient.ts:1106
Function
deleteIndex
* Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the ope
packages/client-search/src/searchClient.ts:1959
Function
deleteIndexWithHTTPInfo
* Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the ope
packages/client-search/src/searchClient.ts:1987
Function
deleteObject
* Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
packages/client-search/src/searchClient.ts:2017
Function
deleteObjectWithHTTPInfo
* Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).
packages/client-search/src/searchClient.ts:2053
Function
deleteObjects
* Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at mo
packages/client-search/src/searchClient.ts:596
Function
deleteProvider
* Delete Provider. * * Required API Key ACLs: * - editSettings * @param deleteProvider - The deleteProvider object. * @param
packages/agent-studio/src/agentStudioClient.ts:1759
Function
deleteProviderWithHTTPInfo
* Delete Provider. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body a
packages/agent-studio/src/agentStudioClient.ts:1790
Function
deleteRecommendRule
* Deletes a Recommend rule from a recommendation scenario. * * Required API Key ACLs: * - editSettings * @param deleteRecommendRu
packages/recommend/src/recommendClient.ts:464
Function
deleteRecommendRuleWithHTTPInfo
* Deletes a Recommend rule from a recommendation scenario. * * Resolves with the full HTTP response information: status code, headers (when
packages/recommend/src/recommendClient.ts:504
Function
deleteRule
* Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
packages/client-search/src/searchClient.ts:2088
Function
deleteRuleWithHTTPInfo
* Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
packages/client-search/src/searchClient.ts:2129
Function
deleteSecretKey
* Delete Secret Key. * * Required API Key ACLs: * - admin * @param deleteSecretKey - The deleteSecretKey object. * @param de
packages/agent-studio/src/agentStudioClient.ts:1822
Function
deleteSecretKeyWithHTTPInfo
* Delete Secret Key. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body
packages/agent-studio/src/agentStudioClient.ts:1853
Function
deleteSource
* Deletes a source from the list of allowed sources. * * Required API Key ACLs: * - admin * @param deleteSource - The deleteSourc
packages/client-search/src/searchClient.ts:2166
Function
deleteSource
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks. * * Required API Key ACLs: * - addObject *
packages/ingestion/src/ingestionClient.ts:1140
Function
deleteSourceWithHTTPInfo
* Deletes a source from the list of allowed sources. * * Resolves with the full HTTP response information: status code, headers (when the re
packages/client-search/src/searchClient.ts:2194
Function
deleteSourceWithHTTPInfo
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks. * * Resolves with the full HTTP response information:
packages/ingestion/src/ingestionClient.ts:1170
Function
deleteSynonym
* Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/searc
packages/client-search/src/searchClient.ts:2225
Function
deleteSynonymWithHTTPInfo
* Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/searc
packages/client-search/src/searchClient.ts:2266
Function
deleteTask
* Deletes a task by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param delete
packages/ingestion/src/ingestionClient.ts:1201
Function
deleteTaskV1
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead. * * Required API Key ACLs: * - addObject * - deleteI
packages/ingestion/src/ingestionClient.ts:1264
Function
deleteTaskV1WithHTTPInfo
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead. * * Resolves with the full HTTP response information: status cod
packages/ingestion/src/ingestionClient.ts:1296
Function
deleteTaskWithHTTPInfo
* Deletes a task by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), r
packages/ingestion/src/ingestionClient.ts:1231
Function
deleteTransformation
* Deletes a transformation by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @pa
packages/ingestion/src/ingestionClient.ts:1327
Function
deleteTransformationWithHTTPInfo
* Deletes a transformation by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester capture
packages/ingestion/src/ingestionClient.ts:1363
Function
deleteUser
* Deletes a user profile. * * Required API Key ACLs: * - search * - browse * - recommendation * @param deleteUser - T
packages/advanced-personalization/src/advancedPersonalizationClient.ts:430
Function
deleteUserData
* Permanently deletes all messages for the given user token. Does not delete conversations. * * Required API Key ACLs: * - logs *
packages/agent-studio/src/agentStudioClient.ts:1885
Function
deleteUserDataWithHTTPInfo
* Permanently deletes all messages for the given user token. Does not delete conversations. * * Resolves with the full HTTP response informa
packages/agent-studio/src/agentStudioClient.ts:1913
Function
deleteUserProfile
* Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted. * * Required API Ke
packages/client-personalization/src/personalizationClient.ts:357
Function
deleteUserProfileWithHTTPInfo
* Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted. * * Resolves with t
packages/client-personalization/src/personalizationClient.ts:388
Function
deleteUserToken
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hour
packages/client-insights/src/insightsClient.ts:354
Function
deleteUserTokenWithHTTPInfo
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hour
packages/client-insights/src/insightsClient.ts:382
Function
deleteUserWithHTTPInfo
* Deletes a user profile. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw
packages/advanced-personalization/src/advancedPersonalizationClient.ts:460
Function
disableTask
* Disables a task. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param disableTask - T
packages/ingestion/src/ingestionClient.ts:1397
Function
disableTaskV1
* Disables a task using the v1 endpoint. Use `disableTask` instead. * * Required API Key ACLs: * - addObject * - deleteIndex
packages/ingestion/src/ingestionClient.ts:1460
Function
disableTaskV1WithHTTPInfo
* Disables a task using the v1 endpoint. Use `disableTask` instead. * * Resolves with the full HTTP response information: status code, heade
packages/ingestion/src/ingestionClient.ts:1492
Function
disableTaskWithHTTPInfo
* Disables a task. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body a
packages/ingestion/src/ingestionClient.ts:1427
Function
enableTask
* Enables a task. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param enableTask - The
packages/ingestion/src/ingestionClient.ts:1523
Function
enableTaskV1
* Enables a task using the v1 endpoint. Use `enableTask` instead. * * Required API Key ACLs: * - addObject * - deleteIndex
packages/ingestion/src/ingestionClient.ts:1586
Function
enableTaskV1WithHTTPInfo
* Enables a task using the v1 endpoint. Use `enableTask` instead. * * Resolves with the full HTTP response information: status code, headers
packages/ingestion/src/ingestionClient.ts:1618
Function
enableTaskWithHTTPInfo
* Enables a task. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body an
packages/ingestion/src/ingestionClient.ts:1553
Function
error
(message: string, args?: any | undefined)
packages/logger-console/src/logger.ts:35
Function
error
(_message: string, _args?: any | undefined)
packages/client-common/src/logger/createNullLogger.ts:11
Function
estimateABTest
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t
packages/abtesting/src/abtestingV3Client.ts:559
Function
estimateABTest
* This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by `POST /3/abtests/estimate`. Given the traffic percentage and the expe
packages/client-abtesting/src/abtestingClient.ts:492
Function
estimateABTestWithHTTPInfo
* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t
packages/abtesting/src/abtestingV3Client.ts:593
Function
estimateABTestWithHTTPInfo
* This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by `POST /3/abtests/estimate`. Given the traffic percentage and the expe
packages/client-abtesting/src/abtestingClient.ts:528
Function
exportConversations
* Exports all conversations based on the passed filters. * * Required API Key ACLs: * - logs * @param exportConversations - The e
packages/agent-studio/src/agentStudioClient.ts:1944
Function
exportConversationsWithHTTPInfo
* Exports all conversations based on the passed filters. * * Resolves with the full HTTP response information: status code, headers (when th
packages/agent-studio/src/agentStudioClient.ts:1988
Function
forgeSecuredUserToken
({ secretKey, secretKeyId, userId, expiresIn = 24 * 3600, // 24 hours }: { s
packages/agent-studio/builds/node.ts:53
Function
forgeSecuredUserToken
({ secretKey, secretKeyId, userId, expiresIn = 24 * 3600, // 24 hours }: { s
packages/agent-studio/builds/fetch.ts:53
Function
get
( key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEvent
packages/client-common/src/cache/createBrowserLocalStorageCache.ts:61
Function
get
( _key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEven
packages/client-common/src/cache/createNullCache.ts:5
← previous
next →
401–500 of 947, ranked by callers