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
batchDictionaryEntries
* Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries. * * Required API Key ACLs: * - editSett
packages/client-search/src/searchClient.ts:1256
Function
batchDictionaryEntriesWithHTTPInfo
* Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries. * * Resolves with the full HTTP response info
packages/client-search/src/searchClient.ts:1300
Function
batchRecommendRules
* Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectI
packages/recommend/src/recommendClient.ts:161
Function
batchRecommendRulesWithHTTPInfo
* Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectI
packages/recommend/src/recommendClient.ts:199
Function
batchWithHTTPInfo
* Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - A
packages/client-search/src/searchClient.ts:1127
Function
browse
* Retrieves records from an index, up to 1,000 per request. Searching returns _hits_ (records augmented with highlighting and ranking details). Brows
packages/client-search/src/searchClient.ts:1346
Function
browseObjects
* Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index. * * @summary Helper method that iterates on
packages/client-search/src/searchClient.ts:406
Function
browseRules
* Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index. * * @summary Helper method that iterates
packages/client-search/src/searchClient.ts:442
Function
browseSynonyms
* Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index. * * @summary Helper method that itera
packages/client-search/src/searchClient.ts:481
Function
browseWithHTTPInfo
* Retrieves records from an index, up to 1,000 per request. Searching returns _hits_ (records augmented with highlighting and ranking details). Brows
packages/client-search/src/searchClient.ts:1377
Function
bulkCreateAllowedDomains
* Add multiple allowed domain patterns. Duplicates are skipped. * * Required API Key ACLs: * - editSettings * @param bulkCreateAl
packages/agent-studio/src/agentStudioClient.ts:197
Function
bulkCreateAllowedDomainsWithHTTPInfo
* Add multiple allowed domain patterns. Duplicates are skipped. * * Resolves with the full HTTP response information: status code, headers (
packages/agent-studio/src/agentStudioClient.ts:237
Function
bulkDeleteAllowedDomains
* Delete allowed domains by id list. * * Required API Key ACLs: * - editSettings * @param bulkDeleteAllowedDomains - The bulkDele
packages/agent-studio/src/agentStudioClient.ts:279
Function
bulkDeleteAllowedDomainsWithHTTPInfo
* Delete allowed domains by id list. * * Resolves with the full HTTP response information: status code, headers (when the requester captures
packages/agent-studio/src/agentStudioClient.ts:323
Function
chunkedBatch
* Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests. * * @summary Helper: C
packages/client-search/src/searchClient.ts:529
Function
chunkedPush
* Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `push` requests by leveraging the Transformation p
packages/ingestion/src/ingestionClient.ts:256
Function
clear
()
packages/client-common/src/cache/createBrowserLocalStorageCache.ts:109
Function
clear
()
packages/client-common/src/cache/createNullCache.ts:25
Function
clear
()
packages/client-common/src/cache/createMemoryCache.ts:37
Function
clear
()
packages/client-common/src/cache/createFallbackableCache.ts:37
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/client-personalization/src/personalizationClient.ts:84
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/abtesting/src/abtestingV3Client.ts:90
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/client-search/src/searchClient.ts:217
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/composition/src/compositionClient.ts:135
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/client-abtesting/src/abtestingClient.ts:88
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/ingestion/src/ingestionClient.ts:207
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/advanced-personalization/src/advancedPersonalizationClient.ts:91
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/client-query-suggestions/src/querySuggestionsClient.ts:88
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/client-analytics/src/analyticsClient.ts:125
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/agent-studio/src/agentStudioClient.ts:152
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/recommend/src/recommendClient.ts:115
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/client-insights/src/insightsClient.ts:81
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/monitoring/src/monitoringClient.ts:83
Function
clearCache
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
packages/algoliasearch/lite/src/liteClient.ts:108
Function
clearObjects
* Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing ra
packages/client-search/src/searchClient.ts:1408
Function
clearObjectsWithHTTPInfo
* Deletes only the records from an index while keeping settings, synonyms, and rules. This operation is resource-intensive and subject to [indexing ra
packages/client-search/src/searchClient.ts:1436
Function
clearRules
* Deletes all rules from the index. * * Required API Key ACLs: * - editSettings * @param clearRules - The clearRules object.
packages/client-search/src/searchClient.ts:1466
Function
clearRulesWithHTTPInfo
* Deletes all rules from the index. * * Resolves with the full HTTP response information: status code, headers (when the requester captures
packages/client-search/src/searchClient.ts:1502
Function
clearSynonyms
* Deletes all synonyms from the index. * * Required API Key ACLs: * - editSettings * @param clearSynonyms - The clearSynonyms obj
packages/client-search/src/searchClient.ts:1536
Function
clearSynonymsWithHTTPInfo
* Deletes all synonyms from the index. * * Resolves with the full HTTP response information: status code, headers (when the requester captur
packages/client-search/src/searchClient.ts:1572
Function
compositionClient
( appId: string, apiKey: string, options?: ClientOptions | undefined, )
packages/composition/builds/browser.ts:19
Function
compositionClient
( appId: string, apiKey: string, options?: ClientOptions | undefined, )
packages/composition/builds/node.ts:18
Function
compositionClient
( appId: string, apiKey: string, options?: ClientOptions | undefined, )
packages/composition/builds/worker.ts:16
Function
compositionClient
( appId: string, apiKey: string, options?: ClientOptions | undefined, )
packages/composition/builds/fetch.ts:18
Function
computeRealtimeUser
* Sends a request to compute the real-time user\'s personalization profile. * * Required API Key ACLs: * - recommendation *
packages/advanced-personalization/src/advancedPersonalizationClient.ts:137
Function
computeRealtimeUserWithHTTPInfo
* Sends a request to compute the real-time user\'s personalization profile. * * Resolves with the full HTTP response information: status cod
packages/advanced-personalization/src/advancedPersonalizationClient.ts:170
Method
constructor
(message: string, name: string)
packages/client-common/src/transporter/errors.ts:6
Method
constructor
(indexName: string)
packages/client-common/src/transporter/errors.ts:16
Method
constructor
()
packages/client-common/src/transporter/errors.ts:22
Method
constructor
(indexName: string)
packages/client-common/src/transporter/errors.ts:28
Method
constructor
(message: string, stackTrace: StackFrame[], name: string, correlationId?: string | undefined)
packages/client-common/src/transporter/errors.ts:38
Method
constructor
(stackTrace: StackFrame[], correlationId?: string | undefined)
packages/client-common/src/transporter/errors.ts:47
Method
constructor
( message: string, status: number, stackTrace: StackFrame[], name = 'ApiError', correlatio
packages/client-common/src/transporter/errors.ts:60
Method
constructor
(message: string, response: Response, correlationId?: string | undefined)
packages/client-common/src/transporter/errors.ts:77
Method
constructor
( message: string, status: number, error: DetailedError, stackTrace: StackFrame[], correla
packages/client-common/src/transporter/errors.ts:104
Function
createAgent
* Create a new agent. * * Required API Key ACLs: * - editSettings * @param agentConfigCreate - The agentConfigCreate object.
packages/agent-studio/src/agentStudioClient.ts:363
Function
createAgentAllowedDomain
* Add a single allowed domain pattern (e.g. https://app.example.com or *.example.com). * * Required API Key ACLs: * - editSettings
packages/agent-studio/src/agentStudioClient.ts:431
Function
createAgentAllowedDomainWithHTTPInfo
* Add a single allowed domain pattern (e.g. https://app.example.com or *.example.com). * * Resolves with the full HTTP response information:
packages/agent-studio/src/agentStudioClient.ts:471
Function
createAgentCompletion
* Create a completion for the specified agent. This endpoint handles two types of requests: 1. Normal completion request: User message -> Agent respo
packages/agent-studio/src/agentStudioClient.ts:519
Function
createAgentCompletionStream
* Create a completion for the specified agent. This endpoint handles two types of requests: 1. Normal completion request: User message -> Agent respo
packages/agent-studio/src/agentStudioClient.ts:734
Function
createAgentCompletionStreamRaw
* Create a completion for the specified agent. This endpoint handles two types of requests: 1. Normal completion request: User message -> Agent respo
packages/agent-studio/src/agentStudioClient.ts:666
Function
createAgentCompletionWithHTTPInfo
* Create a completion for the specified agent. This endpoint handles two types of requests: 1. Normal completion request: User message -> Agent respo
packages/agent-studio/src/agentStudioClient.ts:598
Function
createAgentWithHTTPInfo
* Create a new agent. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw bod
packages/agent-studio/src/agentStudioClient.ts:397
Function
createAuthentication
* Creates a new authentication resource. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings *
packages/ingestion/src/ingestionClient.ts:347
Function
createAuthenticationWithHTTPInfo
* Creates a new authentication resource. * * Resolves with the full HTTP response information: status code, headers (when the requester capt
packages/ingestion/src/ingestionClient.ts:384
Function
createConfig
* Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application. * * Required API Key ACLs:
packages/client-query-suggestions/src/querySuggestionsClient.ts:131
Function
createConfigWithHTTPInfo
* Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application. * * Resolves with the full
packages/client-query-suggestions/src/querySuggestionsClient.ts:162
Function
createDestination
* Creates a new destination. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param desti
packages/ingestion/src/ingestionClient.ts:419
Function
createDestinationWithHTTPInfo
* Creates a new destination. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them),
packages/ingestion/src/ingestionClient.ts:456
Function
createFeedback
* Create new feedback entry. * * Required API Key ACLs: * - search * @param feedbackCreationRequest - The feedbackCreationRequest
packages/agent-studio/src/agentStudioClient.ts:777
Function
createFeedbackWithHTTPInfo
* Create new feedback entry. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them),
packages/agent-studio/src/agentStudioClient.ts:812
Function
createProvider
* Create Provider. * * Required API Key ACLs: * - editSettings * @param providerAuthenticationCreate - The providerAuthentication
packages/agent-studio/src/agentStudioClient.ts:853
Function
createProviderWithHTTPInfo
* Create 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:892
Function
createRequest
(request: Request, requestOptions: RequestOptions = {})
packages/client-common/src/transporter/createTransporter.ts:264
Function
createRequestWithHttpInfo
( request: Request, requestOptions: RequestOptions = {}, )
packages/client-common/src/transporter/createTransporter.ts:348
Function
createSecretKey
* Create Secret Key. * * Required API Key ACLs: * - admin * @param secretKeyCreate - The secretKeyCreate object. * @param re
packages/agent-studio/src/agentStudioClient.ts:937
Function
createSecretKeyWithHTTPInfo
* Create 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:967
Function
createSource
* Creates a new source. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param sourceCrea
packages/ingestion/src/ingestionClient.ts:491
Function
createSourceWithHTTPInfo
* Creates a new source. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw b
packages/ingestion/src/ingestionClient.ts:524
Function
createTask
* Creates a new task. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param taskCreate -
packages/ingestion/src/ingestionClient.ts:558
Function
createTaskV1
* Creates a new task using the v1 endpoint. Use `createTask` instead. * * Required API Key ACLs: * - addObject * - deleteIndex
packages/ingestion/src/ingestionClient.ts:629
Function
createTaskV1WithHTTPInfo
* Creates a new task using the v1 endpoint. Use `createTask` instead. * * Resolves with the full HTTP response information: status code, hea
packages/ingestion/src/ingestionClient.ts:666
Function
createTaskWithHTTPInfo
* Creates a new task. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw bod
packages/ingestion/src/ingestionClient.ts:592
Function
createTransformation
* Creates a new transformation. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param tr
packages/ingestion/src/ingestionClient.ts:702
Function
createTransformationWithHTTPInfo
* Creates a new transformation. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them
packages/ingestion/src/ingestionClient.ts:737
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/client-personalization/src/personalizationClient.ts:126
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/abtesting/src/abtestingV3Client.ts:199
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/client-search/src/searchClient.ts:1603
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/composition/src/compositionClient.ts:212
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/client-abtesting/src/abtestingClient.ts:195
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/ingestion/src/ingestionClient.ts:767
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/advanced-personalization/src/advancedPersonalizationClient.ts:197
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/client-query-suggestions/src/querySuggestionsClient.ts:190
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/client-analytics/src/analyticsClient.ts:167
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/agent-studio/src/agentStudioClient.ts:997
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/recommend/src/recommendClient.ts:231
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/client-insights/src/insightsClient.ts:123
Function
customDelete
* This method lets you send requests to the Algolia REST API. * @param customDelete - The customDelete object. * @param customDelete.path -
packages/monitoring/src/monitoringClient.ts:125
Function
customDeleteWithHTTPInfo
* This method lets you send requests to the Algolia REST API. * * Resolves with the full HTTP response information: status code, headers (wh
packages/client-personalization/src/personalizationClient.ts:155
Function
customDeleteWithHTTPInfo
* 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:228
← previous
next →
201–300 of 918, ranked by callers