MCPcopy Create free account

hub / github.com/algolia/algoliasearch-client-javascript / functions

Functions600 in github.com/algolia/algoliasearch-client-javascript

⨍ Functions 600◇ Types & classes 20
FunctionreplaceAllObjectsWithTransformation
( { indexName, objects, batchSize, scopes, maxRetries = DEFAULT_
packages/algoliasearch/builds/worker.ts:207
FunctionreplaceAllObjectsWithTransformation
( { indexName, objects, batchSize, scopes, maxRetries = DEFAULT_
packages/algoliasearch/builds/fetch.ts:207
FunctionreplaceSources
* Replaces the list of allowed sources. * * Required API Key ACLs: * - admin * @param replaceSources - The replaceSources object.
packages/client-search/src/searchClient.ts:2183
FunctionreplaceTask
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields. * * Required API Key ACLs: * -
packages/ingestion/src/ingestionClient.ts:1863
FunctionrequestStream
( request: Request, requestOptions: RequestOptions = {}, )
packages/client-common/src/transporter/createTransporter.ts:316
FunctionrestoreApiKey
* Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create m
packages/client-search/src/searchClient.ts:2210
FunctionrunSource
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task. * * Requir
packages/ingestion/src/ingestionClient.ts:1901
FunctionrunTask
* Runs a task. You can check the status of task runs with the observability endpoints. * * Required API Key ACLs: * - addObject *
packages/ingestion/src/ingestionClient.ts:1934
FunctionrunTaskV1
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints. * * Requ
packages/ingestion/src/ingestionClient.ts:1966
FunctionsaveObject
* Adds a record to an index or replaces it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to you
packages/client-search/src/searchClient.ts:2237
FunctionsaveObjects
* Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with
packages/client-search/src/searchClient.ts:563
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/browser.ts:168
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/node.ts:168
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/worker.ts:168
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/fetch.ts:168
FunctionsaveRule
* If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced. To create or update more than one r
packages/client-search/src/searchClient.ts:2272
FunctionsaveRules
* Create or update multiple rules. If a rule with the specified object ID doesn\'t exist, Algolia creates a new one. Otherwise, existing rules are re
packages/client-search/src/searchClient.ts:2318
FunctionsaveRules
* Create or update or delete multiple composition rules. * * Required API Key ACLs: * - editSettings * @param saveRules - The sav
packages/composition/src/compositionClient.ts:630
FunctionsaveSynonym
* If a synonym with the specified object ID doesn\'t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synon
packages/client-search/src/searchClient.ts:2361
FunctionsaveSynonyms
* If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. This operation is subject to [i
packages/client-search/src/searchClient.ts:2407
Functionsearch
* Runs multiple search queries against one or more indices in a single API request. Use cases include: - Searching different indices, such as produc
packages/client-search/src/searchClient.ts:2446
Functionsearch
* Runs a query on a single composition and returns matching results. * * Required API Key ACLs: * - search * @param search - The
packages/composition/src/compositionClient.ts:666
Functionsearch
* Runs multiple search queries against one or more indices in a single API request. Use cases include: - Searching different indices, such as produc
packages/algoliasearch/lite/src/liteClient.ts:251
FunctionsearchAuthentications
* Searches for authentication resources. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings *
packages/ingestion/src/ingestionClient.ts:1994
FunctionsearchClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/client-search/builds/browser.ts:19
FunctionsearchClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/client-search/builds/worker.ts:23
FunctionsearchClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/client-search/builds/fetch.ts:40
FunctionsearchCompositionRules
* Searches for composition rules in your index. * * Required API Key ACLs: * - settings * @param searchCompositionRules - The sea
packages/composition/src/compositionClient.ts:704
FunctionsearchDestinations
* Searches for destinations. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param desti
packages/ingestion/src/ingestionClient.ts:2031
FunctionsearchDictionaryEntries
* Searches for standard and custom dictionary entries. * * Required API Key ACLs: * - settings * @param searchDictionaryEntries -
packages/client-search/src/searchClient.ts:2505
FunctionsearchForFacetValues
* Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sort
packages/client-search/src/searchClient.ts:2550
FunctionsearchForFacetValues
* Searches for values of a specified facet attribute on the composition\'s main source\'s index. - By default, facet values are sorted by decreasing
packages/composition/src/compositionClient.ts:739
FunctionsearchForFacets
* Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits). * Disclaimer: We don't as
packages/client-search/src/searchClient.ts:760
FunctionsearchForFacets
* Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits). * Disclaimer: We don't as
packages/algoliasearch/lite/src/liteClient.ts:165
FunctionsearchForHits
* Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets. * Disclaimer: We don't as
packages/client-search/src/searchClient.ts:745
FunctionsearchForHits
* Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets. * Disclaimer: We don't as
packages/algoliasearch/lite/src/liteClient.ts:150
FunctionsearchRecommendRules
* Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario. * * Required API Key ACLs: * -
packages/recommend/src/recommendClient.ts:460
FunctionsearchRules
* Searches for rules in your index. * * Required API Key ACLs: * - settings * @param searchRules - The searchRules object. *
packages/client-search/src/searchClient.ts:2587
FunctionsearchSingleIndex
* Searches a single index and returns matching search results as hits. This method lets you retrieve up to 1,000 hits. If you need more, use the [`br
packages/client-search/src/searchClient.ts:2620
FunctionsearchSources
* Searches for sources. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param sourceSear
packages/ingestion/src/ingestionClient.ts:2064
FunctionsearchSynonyms
* Searches for synonyms in your index. * * Required API Key ACLs: * - settings * @param searchSynonyms - The searchSynonyms objec
packages/client-search/src/searchClient.ts:2653
FunctionsearchTasks
* Searches for tasks. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param taskSearch -
packages/ingestion/src/ingestionClient.ts:2094
FunctionsearchTasksV1
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead. * * Required API Key ACLs: * - addObject * - deleteIndex
packages/ingestion/src/ingestionClient.ts:2126
FunctionsearchTransformations
* Searches for transformations. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param tr
packages/ingestion/src/ingestionClient.ts:2156
FunctionsearchUserIds
* Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time. To ensure rapid updates, the user IDs i
packages/client-search/src/searchClient.ts:2689
Functionsend
(request: EndRequest)
packages/requester-fetch/src/createFetchRequester.ts:19
Functionsend
(request: EndRequest)
packages/requester-testing/src/createEchoRequester.ts:61
Functionsend
(request: EndRequest)
packages/algoliasearch/__tests__/algoliasearch.common.test.ts:294
Functionsend
(request: EndRequest)
packages/requester-node-http/src/createHttpRequester.ts:33
Functionsend
(request: EndRequest)
packages/requester-browser-xhr/src/createXhrRequester.ts:6
FunctionsendStream
(request: EndRequest)
packages/requester-fetch/src/createFetchRequester.ts:73
FunctionsendStream
(request: EndRequest)
packages/requester-testing/src/createEchoRequester.ts:80
FunctionsendStream
(request: EndRequest)
packages/requester-node-http/src/createHttpRequester.ts:129
Functionset
(key: Record<string, any> | string, value: TValue)
packages/client-common/src/cache/createBrowserLocalStorageCache.ts:84
Functionset
(_key: Record<string, any> | string, value: TValue)
packages/client-common/src/cache/createNullCache.ts:17
Functionset
(key: Record<string, any> | string, value: TValue)
packages/client-common/src/cache/createMemoryCache.ts:25
Functionset
(key: Record<string, any> | string, value: TValue)
packages/client-common/src/cache/createFallbackableCache.ts:25
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/client-personalization/src/personalizationClient.ts:110
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/abtesting/src/abtestingV3Client.ts:116
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/client-search/src/searchClient.ts:241
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/composition/src/compositionClient.ts:160
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/client-abtesting/src/abtestingClient.ts:114
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/ingestion/src/ingestionClient.ts:233
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/advanced-personalization/src/advancedPersonalizationClient.ts:117
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/client-query-suggestions/src/querySuggestionsClient.ts:114
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/client-analytics/src/analyticsClient.ts:144
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/agent-studio/src/agentStudioClient.ts:178
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/recommend/src/recommendClient.ts:141
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/client-insights/src/insightsClient.ts:107
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/monitoring/src/monitoringClient.ts:109
FunctionsetClientApiKey
* Helper method to switch the API key used to authenticate the requests. * * @param params - Method params. * @param params.apiKey - Th
packages/algoliasearch/lite/src/liteClient.ts:134
FunctionsetDictionarySettings
* Turns standard stop word dictionary entries on or off for a given language. * * Required API Key ACLs: * - editSettings * @para
packages/client-search/src/searchClient.ts:2722
FunctionsetPersonalizationStrategy
* Creates a new personalization strategy. * * Required API Key ACLs: * - recommendation * @param personalizationStrategyParams -
packages/client-personalization/src/personalizationClient.ts:318
FunctionsetSettings
* Update the specified index settings. Index settings that you don\'t specify are left unchanged. Specify `null` to reset a setting to its default va
packages/client-search/src/searchClient.ts:2760
Functionstart
(controller)
packages/requester-testing/src/createEchoRequester.ts:96
FunctionstopABTest
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests. * * Required API Key ACLs: * - editSettings * @param stopAB
packages/abtesting/src/abtestingV3Client.ts:452
FunctionstopABTest
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests. * * Required API Key ACLs: * - editSettings * @param stopAB
packages/client-abtesting/src/abtestingClient.ts:400
FunctiontriggerDockerSourceDiscover
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airby
packages/ingestion/src/ingestionClient.ts:2194
FunctiontryTransformation
* Try a transformation before creating it. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings
packages/ingestion/src/ingestionClient.ts:2233
FunctiontryTransformationBeforeUpdate
* Try a transformation before updating it. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings
packages/ingestion/src/ingestionClient.ts:2268
FunctionunpublishAgent
* Unpublish the specified agent. * * Required API Key ACLs: * - editSettings * @param unpublishAgent - The unpublishAgent object.
packages/agent-studio/src/agentStudioClient.ts:1549
FunctionupdateAgent
* Update the specified agent. * * Required API Key ACLs: * - editSettings * @param updateAgent - The updateAgent object. * @
packages/agent-studio/src/agentStudioClient.ts:1582
FunctionupdateApiKey
* Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value. * * Required API K
packages/client-search/src/searchClient.ts:2797
FunctionupdateAuthentication
* Updates an authentication resource. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @pa
packages/ingestion/src/ingestionClient.ts:2312
FunctionupdateConfig
* Updates a QuerySuggestions configuration. * * Required API Key ACLs: * - editSettings * @param updateConfig - The updateConfig
packages/client-query-suggestions/src/querySuggestionsClient.ts:396
FunctionupdateConfiguration
* Patch Configuration. * * Required API Key ACLs: * - logs * @param applicationConfigPatch - The applicationConfigPatch object.
packages/agent-studio/src/agentStudioClient.ts:1613
FunctionupdateDestination
* Updates the destination by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @par
packages/ingestion/src/ingestionClient.ts:2350
FunctionupdateProvider
* Update Provider. * * Required API Key ACLs: * - editSettings * @param updateProvider - The updateProvider object. * @param
packages/agent-studio/src/agentStudioClient.ts:1644
FunctionupdateSecretKey
* Patch Secret Key. * * Required API Key ACLs: * - admin * @param updateSecretKey - The updateSecretKey object. * @param upd
packages/agent-studio/src/agentStudioClient.ts:1680
FunctionupdateSortingStrategyComposition
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create a new sorting strategy mapping or replace the config
packages/composition/src/compositionClient.ts:776
FunctionupdateSource
* Updates a source by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param upda
packages/ingestion/src/ingestionClient.ts:2388
FunctionupdateTask
* Partially updates a task by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @pa
packages/ingestion/src/ingestionClient.ts:2423
FunctionupdateTaskV1
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead. * * Required API Key ACLs: * - addObject * - deleteI
packages/ingestion/src/ingestionClient.ts:2457
FunctionupdateTransformation
* Updates a transformation by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @pa
packages/ingestion/src/ingestionClient.ts:2492
FunctionvalidateSource
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia. * * Required API Key ACLs:
packages/ingestion/src/ingestionClient.ts:2530
FunctionvalidateSourceBeforeUpdate
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia. * * Required API K
packages/ingestion/src/ingestionClient.ts:2570
FunctionwaitForApiKey
* Helper: Wait for an API key to be added, updated or deleted based on a given `operation`. * * @summary Helper method that waits for an API
packages/client-search/src/searchClient.ts:329
FunctionwaitForAppTask
* Helper: Wait for an application-level task to complete for a given `taskID`. * * @summary Helper method that waits for a task to be publis
packages/client-search/src/searchClient.ts:294
FunctionwaitForCompositionTask
* Helper: Wait for a composition-level task to be published (completed) for a given `compositionID` and `taskID`. * * @summary Helper method
packages/composition/src/compositionClient.ts:179
FunctionwaitForTask
* Helper: Wait for a task to be published (completed) for a given `indexName` and `taskID`. * * @summary Helper method that waits for a task
packages/client-search/src/searchClient.ts:260
← previous501–600 of 600, ranked by callers