Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/algolia/algoliasearch-client-javascript
/ functions
Functions
918 in github.com/algolia/algoliasearch-client-javascript
⨍
Functions
918
◇
Types & classes
20
Function
getStatusWithHTTPInfo
* Retrieves the status of all Algolia clusters and instances. * * Resolves with the full HTTP response information: status code, headers (wh
packages/monitoring/src/monitoringClient.ts:781
Function
getSynonym
* Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/se
packages/client-search/src/searchClient.ts:2936
Function
getSynonymWithHTTPInfo
* Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/se
packages/client-search/src/searchClient.ts:2969
Function
getTask
* Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queu
packages/client-search/src/searchClient.ts:3003
Function
getTask
* Checks the status of a given task. * * Required API Key ACLs: * - editSettings * - settings * - addObject * - dele
packages/composition/src/compositionClient.ts:718
Function
getTask
* Retrieves a task by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param getT
packages/ingestion/src/ingestionClient.ts:1976
Function
getTaskV1
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead. * * Required API Key ACLs: * - addObject * - deleteIn
packages/ingestion/src/ingestionClient.ts:2036
Function
getTaskV1WithHTTPInfo
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead. * * Resolves with the full HTTP response information: status code
packages/ingestion/src/ingestionClient.ts:2068
Function
getTaskWithHTTPInfo
* Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queu
packages/client-search/src/searchClient.ts:3036
Function
getTaskWithHTTPInfo
* Checks the status of a given task. * * Resolves with the full HTTP response information: status code, headers (when the requester captures
packages/composition/src/compositionClient.ts:755
Function
getTaskWithHTTPInfo
* Retrieves a task by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them),
packages/ingestion/src/ingestionClient.ts:2006
Function
getTimeseries
* Retrieves timeseries for an A/B test by its ID. * * Required API Key ACLs: * - analytics * @param getTimeseries - The getTimese
packages/abtesting/src/abtestingV3Client.ts:617
Function
getTimeseriesWithHTTPInfo
* Retrieves timeseries for an A/B test by its ID. * * Resolves with the full HTTP response information: status code, headers (when the reque
packages/abtesting/src/abtestingV3Client.ts:663
Function
getTopCountries
* Retrieves the countries with the most searches in your index. * * Required API Key ACLs: * - analytics * @param getTopCountries
packages/client-analytics/src/analyticsClient.ts:1724
Function
getTopCountriesWithHTTPInfo
* Retrieves the countries with the most searches in your index. * * Resolves with the full HTTP response information: status code, headers (
packages/client-analytics/src/analyticsClient.ts:1784
Function
getTopFilterAttributes
* Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` s
packages/client-analytics/src/analyticsClient.ts:1843
Function
getTopFilterAttributesWithHTTPInfo
* Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` s
packages/client-analytics/src/analyticsClient.ts:1908
Function
getTopFilterForAttribute
* Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attr
packages/client-analytics/src/analyticsClient.ts:1972
Function
getTopFilterForAttributeWithHTTPInfo
* Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attr
packages/client-analytics/src/analyticsClient.ts:2040
Function
getTopFiltersNoResults
* Retrieves the 1,000 most frequently used filters for a search that didn\'t return any results. To get the most frequent searches without results, u
packages/client-analytics/src/analyticsClient.ts:2105
Function
getTopFiltersNoResultsWithHTTPInfo
* Retrieves the 1,000 most frequently used filters for a search that didn\'t return any results. To get the most frequent searches without results, u
packages/client-analytics/src/analyticsClient.ts:2170
Function
getTopHits
* Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to `true`, the response also in
packages/client-analytics/src/analyticsClient.ts:2235
Function
getTopHitsWithHTTPInfo
* Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to `true`, the response also in
packages/client-analytics/src/analyticsClient.ts:2310
Function
getTopSearches
* Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` query parameter to
packages/client-analytics/src/analyticsClient.ts:2384
Function
getTopSearchesWithHTTPInfo
* Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` query parameter to
packages/client-analytics/src/analyticsClient.ts:2475
Function
getTopUserIds
* Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clus
packages/client-search/src/searchClient.ts:3069
Function
getTopUserIdsWithHTTPInfo
* Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clus
packages/client-search/src/searchClient.ts:3095
Function
getTransformation
* Retrieves a transformation by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @
packages/ingestion/src/ingestionClient.ts:2099
Function
getTransformationWithHTTPInfo
* Retrieves a transformation by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captu
packages/ingestion/src/ingestionClient.ts:2135
Function
getUser
* Retrieves a user profile. * * Required API Key ACLs: * - search * - browse * - recommendation * @param getUser - Th
packages/advanced-personalization/src/advancedPersonalizationClient.ts:600
Function
getUserData
* Retrieves all memories, conversations and their messages for the given user token. * * Required API Key ACLs: * - logs * @param
packages/agent-studio/src/agentStudioClient.ts:2174
Function
getUserDataWithHTTPInfo
* Retrieves all memories, conversations and their messages for the given user token. * * Resolves with the full HTTP response information: s
packages/agent-studio/src/agentStudioClient.ts:2202
Function
getUserId
* Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn\'t re
packages/client-search/src/searchClient.ts:3123
Function
getUserIdWithHTTPInfo
* Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn\'t re
packages/client-search/src/searchClient.ts:3153
Function
getUserTokenProfile
* Retrieves a user profile and their affinities for different facets. * * Required API Key ACLs: * - recommendation * @param getU
packages/client-personalization/src/personalizationClient.ts:465
Function
getUserTokenProfileWithHTTPInfo
* Retrieves a user profile and their affinities for different facets. * * Resolves with the full HTTP response information: status code, hea
packages/client-personalization/src/personalizationClient.ts:499
Function
getUserWithHTTPInfo
* Retrieves a user profile. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), r
packages/advanced-personalization/src/advancedPersonalizationClient.ts:630
Function
getUsers
* Retrieves a list of user profiles in [lexicographical order](https://www.educative.io/answers/what-is-a-lexicographic-order). * * Required
packages/advanced-personalization/src/advancedPersonalizationClient.ts:664
Function
getUsersCount
* Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the
packages/client-analytics/src/analyticsClient.ts:2558
Function
getUsersCountWithHTTPInfo
* Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the
packages/client-analytics/src/analyticsClient.ts:2608
Function
getUsersWithHTTPInfo
* Retrieves a list of user profiles in [lexicographical order](https://www.educative.io/answers/what-is-a-lexicographic-order). * * Resolves
packages/advanced-personalization/src/advancedPersonalizationClient.ts:729
Function
gzipCompress
(data: string)
packages/client-common/src/__tests__/transporter/compression.test.ts:16
Function
hasPendingMappings
* To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this ope
packages/client-search/src/searchClient.ts:3184
Function
hasPendingMappingsWithHTTPInfo
* To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this ope
packages/client-search/src/searchClient.ts:3219
Function
headers
()
packages/client-common/src/createAuth.ts:17
Function
indexExists
({ indexName }: GetSettingsProps, requestOptions?: RequestOptions | undefined)
packages/client-search/src/searchClient.ts:755
Function
info
(message: string, args?: any | undefined)
packages/logger-console/src/logger.ts:14
Function
info
(_message: string, _args?: any | undefined)
packages/client-common/src/logger/createNullLogger.ts:8
Function
ingestionClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/ingestion/builds/browser.ts:24
Function
ingestionClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/ingestion/builds/worker.ts:21
Function
ingestionClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/ingestion/builds/fetch.ts:23
Function
insightsClient
( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )
packages/client-insights/builds/browser.ts:24
Function
insightsClient
( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )
packages/client-insights/builds/worker.ts:21
Function
insightsClient
( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )
packages/client-insights/builds/fetch.ts:23
Function
invalidateAgentCache
* Invalidate cached completions for this agent. Filter with `before` (exclusive). * * Required API Key ACLs: * - editSettings * @
packages/agent-studio/src/agentStudioClient.ts:2232
Function
invalidateAgentCacheWithHTTPInfo
* Invalidate cached completions for this agent. Filter with `before` (exclusive). * * Resolves with the full HTTP response information: stat
packages/agent-studio/src/agentStudioClient.ts:2268
Function
isOnDemandTrigger
(trigger: TaskCreateTrigger | Trigger)
packages/ingestion/src/ingestionClient.ts:139
Function
isScheduleTrigger
(trigger: TaskCreateTrigger | Trigger)
packages/ingestion/src/ingestionClient.ts:149
Function
isSubscriptionTrigger
(trigger: TaskCreateTrigger | Trigger)
packages/ingestion/src/ingestionClient.ts:159
Function
isTimedOut
()
packages/client-common/src/transporter/createStatefulHost.ts:14
Function
isUp
()
packages/client-common/src/transporter/createStatefulHost.ts:10
Function
listABTests
* Lists all A/B tests you configured for this application. * * Required API Key ACLs: * - analytics * @param listABTests - The li
packages/abtesting/src/abtestingV3Client.ts:708
Function
listABTests
* Lists all A/B tests you configured for this application. * * Required API Key ACLs: * - analytics * @param listABTests - The li
packages/client-abtesting/src/abtestingClient.ts:613
Function
listABTestsWithHTTPInfo
* Lists all A/B tests you configured for this application. * * Resolves with the full HTTP response information: status code, headers (when
packages/abtesting/src/abtestingV3Client.ts:761
Function
listABTestsWithHTTPInfo
* Lists all A/B tests you configured for this application. * * Resolves with the full HTTP response information: status code, headers (when
packages/client-abtesting/src/abtestingClient.ts:661
Function
listAgentAllowedDomains
* List all allowed domain patterns for this agent. * * Required API Key ACLs: * - settings * @param listAgentAllowedDomains - The
packages/agent-studio/src/agentStudioClient.ts:2301
Function
listAgentAllowedDomainsWithHTTPInfo
* List all allowed domain patterns for this agent. * * Resolves with the full HTTP response information: status code, headers (when the requ
packages/agent-studio/src/agentStudioClient.ts:2335
Function
listAgentConversations
* Retrieves the conversations for the given agent ID. * * Required API Key ACLs: * - logs * @param listAgentConversations - The l
packages/agent-studio/src/agentStudioClient.ts:2374
Function
listAgentConversationsWithHTTPInfo
* Retrieves the conversations for the given agent ID. * * Resolves with the full HTTP response information: status code, headers (when the r
packages/agent-studio/src/agentStudioClient.ts:2452
Function
listAgents
* List all agents with pagination and filtering. * * Required API Key ACLs: * - settings * @param listAgents - The listAgents obj
packages/agent-studio/src/agentStudioClient.ts:2523
Function
listAgentsWithHTTPInfo
* List all agents with pagination and filtering. * * Resolves with the full HTTP response information: status code, headers (when the reques
packages/agent-studio/src/agentStudioClient.ts:2566
Function
listApiKeys
* Lists all API keys associated with your Algolia application, including their permissions and restrictions. * * Required API Key ACLs:
packages/client-search/src/searchClient.ts:3248
Function
listApiKeysWithHTTPInfo
* Lists all API keys associated with your Algolia application, including their permissions and restrictions. * * Resolves with the full HTTP
packages/client-search/src/searchClient.ts:3272
Function
listAuthentications
* Retrieves a list of all authentication resources. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSetti
packages/ingestion/src/ingestionClient.ts:2174
Function
listAuthenticationsWithHTTPInfo
* Retrieves a list of all authentication resources. * * Resolves with the full HTTP response information: status code, headers (when the req
packages/ingestion/src/ingestionClient.ts:2234
Function
listClusters
* Lists the available clusters in a multi-cluster setup. * * Required API Key ACLs: * - admin * * @deprecated * @param
packages/client-search/src/searchClient.ts:3298
Function
listClustersWithHTTPInfo
* Lists the available clusters in a multi-cluster setup. * * Resolves with the full HTTP response information: status code, headers (when th
packages/client-search/src/searchClient.ts:3324
Function
listCompositions
* Lists all compositions in the current Algolia application. * * Required API Key ACLs: * - editSettings * - settings * @pa
packages/composition/src/compositionClient.ts:790
Function
listCompositionsWithHTTPInfo
* Lists all compositions in the current Algolia application. * * Resolves with the full HTTP response information: status code, headers (whe
packages/composition/src/compositionClient.ts:829
Function
listDestinations
* Retrieves a list of destinations. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @para
packages/ingestion/src/ingestionClient.ts:2293
Function
listDestinationsWithHTTPInfo
* Retrieves a list of destinations. * * Resolves with the full HTTP response information: status code, headers (when the requester captures
packages/ingestion/src/ingestionClient.ts:2358
Function
listEvents
* Retrieves a list of events for a task run, identified by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex
packages/ingestion/src/ingestionClient.ts:2423
Function
listEventsWithHTTPInfo
* Retrieves a list of events for a task run, identified by its ID. * * Resolves with the full HTTP response information: status code, header
packages/ingestion/src/ingestionClient.ts:2496
Function
listIndices
* Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request. *
packages/client-search/src/searchClient.ts:3351
Function
listIndicesWithHTTPInfo
* Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request. *
packages/client-search/src/searchClient.ts:3389
Function
listModels
* Get Provider Models. * * Required API Key ACLs: * - settings * @param requestOptions - The requestOptions to send along with th
packages/agent-studio/src/agentStudioClient.ts:2603
Function
listModelsWithHTTPInfo
* Get Provider Models. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw bo
packages/agent-studio/src/agentStudioClient.ts:2627
Function
listProviderModels
* Get available models for a specific provider. * * Required API Key ACLs: * - settings * @param listProviderModels - The listPro
packages/agent-studio/src/agentStudioClient.ts:2653
Function
listProviderModelsWithHTTPInfo
* Get available models for a specific provider. * * Resolves with the full HTTP response information: status code, headers (when the request
packages/agent-studio/src/agentStudioClient.ts:2687
Function
listProviders
* List Providers. * * Required API Key ACLs: * - settings * @param listProviders - The listProviders object. * @param listPr
packages/agent-studio/src/agentStudioClient.ts:2720
Function
listProvidersWithHTTPInfo
* List Providers. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body an
packages/agent-studio/src/agentStudioClient.ts:2758
Function
listRuns
* Retrieve a list of task runs. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param li
packages/ingestion/src/ingestionClient.ts:2567
Function
listRunsWithHTTPInfo
* Retrieve a list of task runs. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them
packages/ingestion/src/ingestionClient.ts:2642
Function
listSecretKeys
* List Secret Keys. * * Required API Key ACLs: * - settings * @param listSecretKeys - The listSecretKeys object. * @param li
packages/agent-studio/src/agentStudioClient.ts:2794
Function
listSecretKeysWithHTTPInfo
* List Secret Keys. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body
packages/agent-studio/src/agentStudioClient.ts:2832
Function
listSources
* Retrieves a list of sources. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param lis
packages/ingestion/src/ingestionClient.ts:2712
Function
listSourcesWithHTTPInfo
* Retrieves a list of sources. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them)
packages/ingestion/src/ingestionClient.ts:2772
Function
listTasks
* Retrieves a list of tasks. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param listT
packages/ingestion/src/ingestionClient.ts:2835
Function
listTasksV1
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead. * * Required API Key ACLs: * - addObject * - deleteIn
packages/ingestion/src/ingestionClient.ts:3027
Function
listTasksV1WithHTTPInfo
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead. * * Resolves with the full HTTP response information: status code
packages/ingestion/src/ingestionClient.ts:3104
← previous
next →
601–700 of 918, ranked by callers