MCPcopy Create free account

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

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

FunctionlistTasksWithHTTPInfo
* Retrieves a list of tasks. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them),
packages/ingestion/src/ingestionClient.ts:2932
FunctionlistTransformations
* Retrieves a list of transformations. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @p
packages/ingestion/src/ingestionClient.ts:3173
FunctionlistTransformationsWithHTTPInfo
* Retrieves a list of transformations. * * Resolves with the full HTTP response information: status code, headers (when the requester captur
packages/ingestion/src/ingestionClient.ts:3228
FunctionlistUserIds
* Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the respons
packages/client-search/src/searchClient.ts:3427
FunctionlistUserIdsWithHTTPInfo
* Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the respons
packages/client-search/src/searchClient.ts:3467
FunctionliteClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/algoliasearch/lite/builds/browser.ts:19
FunctionliteClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/algoliasearch/lite/builds/node.ts:18
FunctionmonitoringClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/monitoring/builds/browser.ts:19
FunctionmonitoringClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/monitoring/builds/worker.ts:16
FunctionmonitoringClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/monitoring/builds/fetch.ts:18
FunctionmultipleBatch
* Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions a
packages/client-search/src/searchClient.ts:3501
FunctionmultipleBatch
* Adds, updates, or deletes compositions with a single API request. * * Required API Key ACLs: * - editSettings * @param batchPar
packages/composition/src/compositionClient.ts:863
FunctionmultipleBatchWithHTTPInfo
* Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions a
packages/client-search/src/searchClient.ts:3531
FunctionmultipleBatchWithHTTPInfo
* Adds, updates, or deletes compositions with a single API request. * * Resolves with the full HTTP response information: status code, heade
packages/composition/src/compositionClient.ts:893
FunctionnodeEchoRequester
(status: number = 200)
packages/requester-testing/src/nodeEchoRequester.ts:7
FunctionoperationIndex
* Copies or moves (renames) an index within the same Algolia application. Notes: - Existing destination indices are overwritten, except for their ana
packages/client-search/src/searchClient.ts:3564
FunctionoperationIndexWithHTTPInfo
* Copies or moves (renames) an index within the same Algolia application. Notes: - Existing destination indices are overwritten, except for their ana
packages/client-search/src/searchClient.ts:3602
FunctionpartialUpdateObject
* Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to th
packages/client-search/src/searchClient.ts:3644
FunctionpartialUpdateObjectWithHTTPInfo
* Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to th
packages/client-search/src/searchClient.ts:3689
FunctionpartialUpdateObjects
* Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the
packages/client-search/src/searchClient.ts:626
FunctionpartialUpdateObjectsWithTransformation
( { indexName, objects, createIfNotExists, batchSize, waitForTasks, maxRetries }, requestOptions,
packages/algoliasearch/builds/browser.ts:186
FunctionpartialUpdateObjectsWithTransformation
( { indexName, objects, createIfNotExists, batchSize, waitForTasks, maxRetries }, requestOptions,
packages/algoliasearch/builds/node.ts:186
FunctionpartialUpdateObjectsWithTransformation
( { indexName, objects, createIfNotExists, batchSize, waitForTasks, maxRetries }, requestOptions,
packages/algoliasearch/builds/worker.ts:186
FunctionpartialUpdateObjectsWithTransformation
( { indexName, objects, createIfNotExists, batchSize, waitForTasks, maxRetries }, requestOptions,
packages/algoliasearch/builds/fetch.ts:186
FunctionpersonalizationClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/client-personalization/builds/browser.ts:24
FunctionpersonalizationClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/client-personalization/builds/worker.ts:21
FunctionpersonalizationClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/client-personalization/builds/fetch.ts:23
FunctionpublishAgent
* Publish the specified agent. * * Required API Key ACLs: * - editSettings * @param publishAgent - The publishAgent object.
packages/agent-studio/src/agentStudioClient.ts:2867
FunctionpublishAgentWithHTTPInfo
* Publish the specified agent. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them)
packages/agent-studio/src/agentStudioClient.ts:2895
Functionpush
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous ca
packages/ingestion/src/ingestionClient.ts:3280
FunctionpushEvents
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbs
packages/client-insights/src/insightsClient.ts:410
FunctionpushEventsWithHTTPInfo
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbs
packages/client-insights/src/insightsClient.ts:440
FunctionpushTask
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous ca
packages/ingestion/src/ingestionClient.ts:3397
FunctionpushTaskWithHTTPInfo
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous ca
packages/ingestion/src/ingestionClient.ts:3452
FunctionpushWithHTTPInfo
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous ca
packages/ingestion/src/ingestionClient.ts:3340
FunctionputComposition
* Update and insert a composition in the current Algolia application. * * Required API Key ACLs: * - editSettings * @param putCom
packages/composition/src/compositionClient.ts:926
FunctionputCompositionRule
* If a composition rule with the provided ID already exists, it\'s replaced. Otherwise, a new one is added. * * Required API Key ACLs:
packages/composition/src/compositionClient.ts:1009
FunctionputCompositionRuleWithHTTPInfo
* If a composition rule with the provided ID already exists, it\'s replaced. Otherwise, a new one is added. * * Resolves with the full HTTP
packages/composition/src/compositionClient.ts:1052
FunctionputCompositionWithHTTPInfo
* Update and insert a composition in the current Algolia application. * * Resolves with the full HTTP response information: status code, hea
packages/composition/src/compositionClient.ts:968
FunctionputConfig
* Updates the configuration. The configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index,
packages/advanced-personalization/src/advancedPersonalizationClient.ts:785
FunctionputConfigWithHTTPInfo
* Updates the configuration. The configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index,
packages/advanced-personalization/src/advancedPersonalizationClient.ts:827
FunctionqueryParameters
()
packages/client-common/src/createAuth.ts:21
FunctionqueryPatternsDistribution
* **Beta**: this endpoint is under active development and may change without notice. Buckets one or more numeric fields into histograms and returns a
packages/client-analytics/src/analyticsClient.ts:2654
FunctionqueryPatternsDistributionWithHTTPInfo
* **Beta**: this endpoint is under active development and may change without notice. Buckets one or more numeric fields into histograms and returns a
packages/client-analytics/src/analyticsClient.ts:2698
FunctionqueryPatternsScalar
* **Beta**: this endpoint is under active development and may change without notice. Aggregates the requested `metrics` over the whole period and ret
packages/client-analytics/src/analyticsClient.ts:2744
FunctionqueryPatternsScalarWithHTTPInfo
* **Beta**: this endpoint is under active development and may change without notice. Aggregates the requested `metrics` over the whole period and ret
packages/client-analytics/src/analyticsClient.ts:2784
FunctionqueryPatternsTable
* **Beta**: this endpoint is under active development and may change without notice. Returns `rows`, each a flat object of the requested fields. `met
packages/client-analytics/src/analyticsClient.ts:2822
FunctionqueryPatternsTableWithHTTPInfo
* **Beta**: this endpoint is under active development and may change without notice. Returns `rows`, each a flat object of the requested fields. `met
packages/client-analytics/src/analyticsClient.ts:2862
FunctionqueryPatternsTimeseries
* **Beta**: this endpoint is under active development and may change without notice. Returns one time series per `groupBy` combination, each with per
packages/client-analytics/src/analyticsClient.ts:2900
FunctionqueryPatternsTimeseriesWithHTTPInfo
* **Beta**: this endpoint is under active development and may change without notice. Returns one time series per `groupBy` combination, each with per
packages/client-analytics/src/analyticsClient.ts:2940
FunctionquerySuggestionsClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/client-query-suggestions/builds/browser.ts:24
FunctionquerySuggestionsClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/client-query-suggestions/builds/worker.ts:21
FunctionquerySuggestionsClient
( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )
packages/client-query-suggestions/builds/fetch.ts:23
FunctionrecommendClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/recommend/builds/browser.ts:19
FunctionrecommendClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/recommend/builds/worker.ts:16
FunctionrecommendClient
(appId: string, apiKey: string, options?: ClientOptions | undefined)
packages/recommend/builds/fetch.ts:18
FunctionremoveUserId
* Deletes a user ID and its associated data from the clusters. * * Required API Key ACLs: * - admin * * @deprecated * @
packages/client-search/src/searchClient.ts:3731
FunctionremoveUserIdWithHTTPInfo
* Deletes a user ID and its associated data from the clusters. * * Resolves with the full HTTP response information: status code, headers (w
packages/client-search/src/searchClient.ts:3761
FunctionreplaceAllObjects
* Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order
packages/client-search/src/searchClient.ts:658
FunctionreplaceAllObjectsWithTransformation
( { indexName, objects, batchSize, scopes, maxRetries = DEFAULT_
packages/algoliasearch/builds/browser.ts:209
FunctionreplaceAllObjectsWithTransformation
( { indexName, objects, batchSize, scopes, maxRetries = DEFAULT_
packages/algoliasearch/builds/node.ts:209
FunctionreplaceAllObjectsWithTransformation
( { indexName, objects, batchSize, scopes, maxRetries = DEFAULT_
packages/algoliasearch/builds/worker.ts:209
FunctionreplaceAllObjectsWithTransformation
( { indexName, objects, batchSize, scopes, maxRetries = DEFAULT_
packages/algoliasearch/builds/fetch.ts:209
FunctionreplaceSources
* Replaces the list of allowed sources. * * Required API Key ACLs: * - admin * @param replaceSources - The replaceSources object.
packages/client-search/src/searchClient.ts:3790
FunctionreplaceSourcesWithHTTPInfo
* Replaces the list of allowed sources. * * Resolves with the full HTTP response information: status code, headers (when the requester captu
packages/client-search/src/searchClient.ts:3819
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:3504
FunctionreplaceTaskWithHTTPInfo
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields. * * Resolves with the full HTTP respo
packages/ingestion/src/ingestionClient.ts:3544
FunctionrequestStream
( request: Request, requestOptions: RequestOptions = {}, )
packages/client-common/src/transporter/createTransporter.ts:368
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:3849
FunctionrestoreApiKeyWithHTTPInfo
* 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:3877
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:3582
FunctionrunSourceWithHTTPInfo
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task. * * Resolv
packages/ingestion/src/ingestionClient.ts:3617
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:3650
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:3717
FunctionrunTaskV1WithHTTPInfo
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints. * * Reso
packages/ingestion/src/ingestionClient.ts:3751
FunctionrunTaskWithHTTPInfo
* Runs a task. You can check the status of task runs with the observability endpoints. * * Resolves with the full HTTP response information:
packages/ingestion/src/ingestionClient.ts:3682
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:3907
FunctionsaveObjectWithHTTPInfo
* 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:3942
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:574
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/browser.ts:170
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/node.ts:170
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/worker.ts:170
FunctionsaveObjectsWithTransformation
( { indexName, objects, batchSize, waitForTasks, maxRetries }, requestOptions, )
packages/algoliasearch/builds/fetch.ts:170
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:3977
FunctionsaveRuleWithHTTPInfo
* 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:4025
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:4071
FunctionsaveRules
* Create or update or delete multiple composition rules. * * Required API Key ACLs: * - editSettings * @param saveRules - The sav
packages/composition/src/compositionClient.ts:1092
FunctionsaveRulesWithHTTPInfo
* 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:4116
FunctionsaveRulesWithHTTPInfo
* Create or update or delete multiple composition rules. * * Resolves with the full HTTP response information: status code, headers (when th
packages/composition/src/compositionClient.ts:1130
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:4159
FunctionsaveSynonymWithHTTPInfo
* 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:4207
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:4253
FunctionsaveSynonymsWithHTTPInfo
* 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:4298
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:4337
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:1166
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:330
FunctionsearchAuthentications
* Searches for authentication resources. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings *
packages/ingestion/src/ingestionClient.ts:3782
FunctionsearchAuthenticationsWithHTTPInfo
* Searches for authentication resources. * * Resolves with the full HTTP response information: status code, headers (when the requester capt
packages/ingestion/src/ingestionClient.ts:3821
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
← previousnext →701–800 of 918, ranked by callers