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
agentStudioClient
( appId: string, apiKey: string, options?: ClientOptions | undefined, )
packages/agent-studio/builds/fetch.ts:22
Function
aggregator
(response: SearchRulesResponse)
packages/client-search/builds/fetch.ts:175
Function
analyticsClient
( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )
packages/client-analytics/builds/browser.ts:24
Function
analyticsClient
( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )
packages/client-analytics/builds/worker.ts:21
Function
analyticsClient
( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )
packages/client-analytics/builds/fetch.ts:23
Function
appendSource
* Adds a source to the list of allowed sources. * * Required API Key ACLs: * - admin * @param source - Source to add. * @par
packages/client-search/src/searchClient.ts:946
Function
appendSourceWithHTTPInfo
* Adds a source to the list of allowed sources. * * Resolves with the full HTTP response information: status code, headers (when the request
packages/client-search/src/searchClient.ts:976
Function
applyVariantSettings
* Applies the captured settings of the given variant to the control index. The settings must first be captured with the `saveVariantSettings` operati
packages/abtesting/src/abtestingV3Client.ts:207
Function
applyVariantSettingsWithHTTPInfo
* Applies the captured settings of the given variant to the control index. The settings must first be captured with the `saveVariantSettings` operati
packages/abtesting/src/abtestingV3Client.ts:241
Function
assignUserId
* Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. *
packages/client-search/src/searchClient.ts:1011
Function
assignUserIdWithHTTPInfo
* Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. *
packages/client-search/src/searchClient.ts:1054
Function
batch
* 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:1093
Function
batchAssignUserIds
* Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**. * * Required API Key ACLs: * - admin *
packages/client-search/src/searchClient.ts:1164
Function
batchAssignUserIdsWithHTTPInfo
* Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**. * * Resolves with the full HTTP response informati
packages/client-search/src/searchClient.ts:1208
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 `object
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 `object
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:203
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:243
Function
bulkDeleteAllowedDomains
* Delete allowed domains by id list. * * Required API Key ACLs: * - editSettings * @param bulkDeleteAllowedDomains - The bulkDele
packages/agent-studio/src/agentStudioClient.ts:285
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:329
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:94
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:158
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
compactContext
* Summarize the older part of a conversation into a single user message via the caller\'s LLM. Everything except the trailing `keepLastMessages` mess
packages/agent-studio/src/agentStudioClient.ts:369
Function
compactContextWithHTTPInfo
* Summarize the older part of a conversation into a single user message via the caller\'s LLM. Everything except the trailing `keepLastMessages` mess
packages/agent-studio/src/agentStudioClient.ts:404
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
(status: number, body: string, headers?: Headers | undefined)
packages/client-common/src/transporter/errors.ts:81
Method
constructor
(message: string, response: Response, correlationId?: string | undefined)
packages/client-common/src/transporter/errors.ts:93
Method
constructor
( message: string, status: number, error: DetailedError, stackTrace: StackFrame[], correla
packages/client-common/src/transporter/errors.ts:120
Function
createAgent
* Create a new agent. * * Required API Key ACLs: * - editSettings * @param agentConfigCreate - The agentConfigCreate object.
packages/agent-studio/src/agentStudioClient.ts:441
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:509
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:549
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:597
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:812
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:744
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:676
Function
createAgentTask
* Run a configured task and return the generated object as ``{ output }``. With ``?stream=true``, returns the raw partial JSON text stream expected b
packages/agent-studio/src/agentStudioClient.ts:860
Function
createAgentTaskStream
* Run a configured task and return the generated object as ``{ output }``. With ``?stream=true``, returns the raw partial JSON text stream expected b
packages/agent-studio/src/agentStudioClient.ts:1000
Function
createAgentTaskStreamRaw
* Run a configured task and return the generated object as ``{ output }``. With ``?stream=true``, returns the raw partial JSON text stream expected b
packages/agent-studio/src/agentStudioClient.ts:956
Function
createAgentTaskWithHTTPInfo
* Run a configured task and return the generated object as ``{ output }``. With ``?stream=true``, returns the raw partial JSON text stream expected b
packages/agent-studio/src/agentStudioClient.ts:912
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:475
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:1025
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:1060
Function
createProvider
* Create Provider. * * Required API Key ACLs: * - editSettings * @param providerAuthenticationCreate - The providerAuthentication
packages/agent-studio/src/agentStudioClient.ts:1101
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:1140
Function
createRequest
(request: Request, requestOptions: RequestOptions = {})
packages/client-common/src/transporter/createTransporter.ts:292
Function
createRequestWithHttpInfo
( request: Request, requestOptions: RequestOptions = {}, )
packages/client-common/src/transporter/createTransporter.ts:376
Function
createSecretKey
* Create Secret Key. * * Required API Key ACLs: * - admin * @param secretKeyCreate - The secretKeyCreate object. * @param re
packages/agent-studio/src/agentStudioClient.ts:1185
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:1215
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
← previous
next →
201–300 of 947, ranked by callers