Helper methods extend or combine API operations to make using the Search API easier.

Browse for records

Required ACL: browse

Retrieves all records from an index.

This helper method iterates over the paginated API response from the Browse API operation and lets you run an aggregator function on every iteration.

You can use this, for example, to retrieve all records from your index.

1
2
3
4
5
6
7
8
@discardableResult
func browseObjects<T: Codable>(
  indexName: String,
  browseParams: BrowseParamsObject,
  validate: (BrowseResponse<T>) -> Bool
  aggregator: (BrowseResponse<T>) -> Void,
  requestOptions: RequestOptions?,
) async throws -> BrowseResponse<T>

Parameters

indexName
type: String
Required

Index name from which to get all records.

browseParams
type: BrowseParamsObject
Required

Parameters for the Browse for records request.

aggregator
type: (BrowseResponse<T>) -> Void
Required

A function that runs on every iteration, for example, to aggregate all records from the response.

validate
type: (BrowseResponse<T>) -> Bool
default: { response in response.cursor == nil }

A function that returns true when the iteration should stop. By default, the iteration stops if the API response does not contain a cursor property.

T
type: type parameter

The model of your index’s records.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Browse for rules

Required ACL: settings

Retrieves all rules from an index.

This helper method iterates over the paginated API response from the Search for rules API operation and lets you run an aggregator function on every iteration.

You can use this, for example, to retrieve all rules from your index.

1
2
3
4
5
6
7
8
@discardableResult
func browseRules(
  indexName: String,
  searchRulesParams: SearchRulesParams,
  validate: ((SearchRulesResponse) -> Bool)?,
  aggregator: (SearchRulesResponse) -> Void,
  requestOptions: RequestOptions?,
) async throws -> SearchRulesResponse 

Parameters

indexName
type: String
Required

Index name from which to get all rules.

searchRulesParams
type: SearchRulesParams

Parameters for the Search for rules request.

aggregator
type: (SearchRulesResponse) -> Void
Required

A function that takes the API response and performs the operation you want, for example, aggregating all rules into an array.

validate
type: (SearchRulesResponse) -> Bool
default: nil

A function that takes the API response and returns true when the iteration should be stopped. By default, the iteration stops if the API response has fewer hits than the maximum number of hits per page (1,000).

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Browse for synonyms

Required ACL: settings

Retrieves all synonyms from an index.

This helper method is based on the Search for synonyms API operation.

It iterates over the paginated API response and aggregates all synonyms.

1
2
3
4
5
6
7
8
@discardable
func browseSynonyms(
  indexName: String,
  searchSynonymsParams: SearchSynonymsParams ,
  validate: ((SearchSynonymsResponse) -> Bool)?,
  aggregator: (SearchSynonymsResponse) -> Void,
  requestOptions: RequestOptions?,
) async throws -> SearchSynonymsResponse

Parameters

indexName
type: String
Required

Index name from which to get all synonyms.

searchSynonymsParams
type: SearchSynonymsParams

Parameters for the Search for synonyms request.

aggregator
type: (SearchRulesResponse) -> Void
Required

A function that takes the API response and performs the operation you want, for example, aggregating all synonyms into an array.

validate
type: (SearchRulesResponse) -> Bool
default: nil

A function that takes the API response and returns true when the iteration should be stopped. By default, the iteration stops if the API response has fewer hits than the maximum number of hits per page (1,000).

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Delete records

Required ACL: deleteObject

Deletes records from an index using their object IDs.

This helper method creates batch write requests with deleteObject actions and sends these requests in batches of 1,000.

1
2
3
4
5
6
func deleteObjects(
  indexName: String,
  objectIDs: [String],
  waitForTasks: Bool,
  requestOptions: RequestOptions?,
) async throws -> [BatchResponse]

Examples

1
2
3
4
5
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.deleteObjects(indexName: "ALGOLIA_INDEX_NAME", objectIDs: ["1", "2"])

Parameters

indexName
type: String
Required

Index name from which to delete records.

objectIDs
type: Array
items: String
Required

Object IDs to delete.

waitForTasks
type: Bool
default: false

Whether to wait until all tasks created by this method are completed.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Create secured API keys

Creates a secured API key without any calls to Algolia’s servers.

This helper method takes a parent API key and adds restrictions to it, which can’t be changed at query time.

Secured API keys are forms of hash-based message authentication codes (HMAC).

This helper performs these steps to create a secured API key:

  1. Compute a SHA-256 HMAC with the parent API key as secret, and a URL-encoded list of query parameters as message. These query parameters will be applied with every use of the API key and can’t be changed by users.

  2. Concatenate the SHA-256 HMAC with the list of query parameters to a single string.

  3. Encode the whole string in base64.

1
2
3
4
func generateSecuredApiKey(
  parentApiKey: String,
  restrictions: SecuredApiKeyRestrictions,
) throws -> String?

Examples

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try client.generateSecuredApiKey(
    parentApiKey: "2640659426d5107b6e47d75db9cbaef8",
    restrictions: SecuredApiKeyRestrictions(
        searchParams: SearchSearchParamsObject(
            query: "batman",
            aroundRadius: SearchAroundRadius.searchAroundRadiusAll(SearchAroundRadiusAll.all),
            hitsPerPage: 10,
            typoTolerance: SearchTypoTolerance.searchTypoToleranceEnum(SearchTypoToleranceEnum.strict),
            mode: SearchMode.neuralSearch,
            optionalWords: SearchOptionalWords.arrayOfString(["one", "two"])
        ),
        filters: "category:Book OR category:Ebook AND _tags:published",
        validUntil: Int64(2_524_604_400),
        restrictIndices: ["Movies", "cts_e2e_settings"],
        restrictSources: "192.168.1.0/24",
        userToken: "user123"
    )
)

Parameters

parentApiKey
type: String
Required

The API key to be used as secret for the secured API key. The secured API key inherits all restrictions from this API key. You can’t use an Admin API key.

restrictions
type: SecuredApiKeyRestrictions

Restrictions to apply to the secured API key. You must add at least one restriction. If you make requests with a secured API key with the same restrictions as the parent_api_key, the API returns an error with the status 403.

restrictions ➔ SecuredApiKeyRestrictions

searchParams
type: SearchParamsObject

Search parameters that will always be applied with this API key. For more information, see Search.

filters
type: String

Filters that will always be applied with this API key.

validUntil
type: Int

Timestamp when the API key expires, in seconds since the Unix epoch.

restrictIndices
type: Array
items: String

Index names that this API key should be allowed to access. You can use the wildcard character *. For example, restrict_indices: "dev_*" permits using all indices with names starting with dev_.

restrictSources
type: String

IP network range that is allowed to use this API key.

userToken
type: String

Pseudonymous user identifier to restrict usage of this API key to specific users. By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.

Get secured API key remaining validity

Retrieves the time in seconds until the secured API key expires.

This helper method returns the number of seconds left until the secured API key expires, as defined by its validUntil property. If the key already expired, this method returns a negative number, indicating the number of seconds since the key expired.

1
2
3
func getSecuredApiKeyRemainingValidity(
  securedApiKey: String,
) -> TimeInterval?

Parameters

securedApiKey
type: String
Required

Secured API key for which to retrieve the time of validity.

Check if index exists

Required ACL: settings

Checks whether an index exists.

This helper method makes a request to the Retrieve index settings endpoint, and returns true if that request returns a success response.

1
2
3
func indexExists(
  indexName: String
) async throws -> Bool

Examples

1
2
3
4
5
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.indexExists(indexName: "ALGOLIA_INDEX_NAME")

Parameters

indexName
type: String
Required

Index name to check.

Update attributes of records

Required ACL: addObject

Adds or updates attributes of records

This helper method creates batch write requests with partialUpdateObject or partialUpdateObjectNoCreate actions (depending on whether the createIfNotExists option is true or false) and sends these requests in batches of 1,000.

The underlying method is subject to indexing rate limits.

1
2
3
4
5
6
7
func partialUpdateObjects(
  indexName: String,
  objects: [some Encodable],
  createIfNotExists: Bool,
  waitForTasks: Bool,
  requestOptions: RequestOptions?,
) async throws -> [BatchResponse]

Examples

1
2
3
4
5
6
7
8
9
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.partialUpdateObjects(
    indexName: "ALGOLIA_INDEX_NAME",
    objects: [["objectID": "1", "name": "Adam"], ["objectID": "2", "name": "Benoit"]],
    createIfNotExists: true
)

Parameters

indexName
type: String
Required

Index name where to update records.

objects
type: Array
items: Encodable
Required

Records to update

createIfNotExists
type: Bool
default: false

Whether to create a new record if it doesn’t exist.

waitForTasks
type: Bool
default: false

Whether to wait until all tasks created by this method are completed.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Replace all records

Required ACL: addObject

Replaces all records in an index with new ones.

This helper lets you replace all records in an index without interrupting the ability to search.

It combines batch, copy, and move requests:

  1. Copy settings, synonyms, and rules to a temporary index.
  2. Add the records from the objects parameter to the temporary index.
  3. Move the temporary index to the original index to replace it.

If you use an API key with indexes restrictions, you need to allow access to the index INDEX_NAME_tmp_* (replace INDEX_NAME with the name of your original index).

The underlying methods are subject to indexing rate limits.

The response from this method contains the API responses from the individual requests:

1
2
3
4
5
6
public struct ReplaceAllObjectsResponse: Codable, JSONEncodable {
    public var copyOperationResponse: UpdatedAtResponse
    /// The response of the `batch` request(s).
    public var batchResponses: [BatchResponse]
    public var moveOperationResponse: UpdatedAtResponse
}
1
2
3
4
5
6
7
@discardableResult
func replaceAllObjects(
  indexName: String,
  objects: [some Encodable],
  batchSize: Int,
  requestOptions: RequestOptions?,
) async throws -> [RelaceAllObjectsResponse]

Examples

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.replaceAllObjects(
    indexName: "ALGOLIA_INDEX_NAME",
    objects: [
        ["objectID": "1", "name": "Adam"],
        ["objectID": "2", "name": "Benoit"],
        ["objectID": "3", "name": "Cyril"],
        ["objectID": "4", "name": "David"],
        ["objectID": "5", "name": "Eva"],
        ["objectID": "6", "name": "Fiona"],
        ["objectID": "7", "name": "Gael"],
        ["objectID": "8", "name": "Hugo"],
        ["objectID": "9", "name": "Igor"],
        ["objectID": "10", "name": "Julia"],
    ],
    batchSize: 3
)

Parameters

indexName
type: String
Required

Index name where to replace all records.

objects
type: Array
items: Encodable
Required

Records that replace the existing records in your index.

batchSize
type: Int
default: 1,000

Batch size for the indexing operation.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Save records

Required ACL: addObject

Adds records to an index.

This helper method creates batch write requests with addObject actions and sends these requests in batches in 1,000.

The underlying method is subject to indexing rate limits.

1
2
3
4
5
6
func saveObjects(
  indexName: String,
  objects: [some Encodable],
  waitForTasks: Bool,
  requestOptions: RequestOptions?,
) async throws -> [BatchResponse]

Examples

1
2
3
4
5
6
7
8
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.saveObjects(
    indexName: "ALGOLIA_INDEX_NAME",
    objects: [["objectID": "1", "name": "Adam"], ["objectID": "2", "name": "Benoit"]]
)

Parameters

indexName
type: String
Required

Index name to which to add records.

objects
type: Array
items: Encodable
Required

Records to add.

waitForTasks
type: Bool
default: false

Whether to wait until all tasks created by this method are completed.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Wait for API keys

Waits for an API key operation to be finished.

When you add, update, or delete API keys, it might take a while before the change is applied.

1
2
3
4
5
6
7
8
9
@discardableResult
func waitForApiKey(
  key: String,
  operation: ApiKeyOperation,
  apiKey: ApiKey?,
  maxRetries: Int,
  timeout: (Int) -> TimeInterval,
  requestOptions: RequestOptions?,
) async throws -> GetApiKeyResponse?

Examples

Wait until an API key is added:

1
2
3
4
5
6
7
8
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.waitForApiKey(
    key: "api-key-add-operation-test-swift",
    operation: ApiKeyOperation.add
)

Wait until an API key is updated:

1
2
3
4
5
6
7
8
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.waitForApiKey(
    key: "api-key-add-operation-test-swift",
    operation: ApiKeyOperation.add
)

Wait until an API key is deleted:

1
2
3
4
5
6
7
8
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.waitForApiKey(
    key: "api-key-add-operation-test-swift",
    operation: ApiKeyOperation.add
)

Parameters

key
type: String
Required

The API key that was added, updated, or deleted. For example, you can get this value from the API response when creating or updating.

operation
type: ApiKeyOperation
Required

The type of operation to wait for:

  • ApiKeyOperation.add. Wait for the addition of a new API key
  • ApiKeyOperation.update. Wait for the update of an existing API key
  • ApiKeyOperation.delete. Wait for the deletion of an API key.
apiKey
type: ApiKey
default: nil

When waiting for an API key to be updated, apiKey expects the original ApiKey object you passed to the Update API key operation.

maxRetries
type: Int
default: 50

Maximum number of times the task status should be checked.

timeout
type: (Int) -> TimeInterval
default: min(TimeInterval(retryCount) * 0.2, 5)

A function that takes one parameter, the current number of retries, and returns the number of seconds after which to check the task’s status again.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Wait for application-level tasks

Waits for an application-level task to complete.

Some tasks are application-level tasks, such as working with dictionaries. They’re asynchronous: when you make a request, Algolia adds the task to a queue and runs it depending on the server load. The response includes a task_id property that you can use to wait until the task is complete.

This helper method polls the Check application task status API operation and stops if the task’s status is published.

1
2
3
4
5
6
7
@discardableResult
func waitForAppTask(
  taskID: Int64,
  maxRetries: Int,
  timeout: (Int) -> TimeInterval,
  requestOptions: RequestOptions?,
) async throws -> GetTaskResponse

Examples

1
2
3
4
5
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.waitForAppTask(taskID: Int64(123))

Parameters

taskID
type: Int64
Required

Task ID for which to wait.

maxRetries
type: Int
default: 50

Maximum number of times the task status should be checked.

timeout
type: (Int) -> TimeInterval
default: min(TimeInterval(retryCount) * 0.2, 5)

A function that takes one parameter, the current number of retries, and returns the number of seconds after which to check the task’s status again.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Wait for index operations

Waits for an indexing task to complete.

Indexing operations are asynchronous. When you make a request for an indexing operation, such as, adding or updating records, Algolia adds a task to a queue and returns a task_id property with the response. The task itself runs separately, depending on the server load.

This helper method polls the Check task status API operation and stops if the task’s status is published.

1
2
3
4
5
6
7
8
@discardableResult
func waitForTask(
  indexName: String,
  taskID: Int64,
  maxRetries: Int,
  timeout: (Int) -> TimeInterval,
  requestOptions: RequestOptions?,
) async throws -> GetTaskResponse

Examples

1
2
3
4
5
import Search

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

let response = try await client.waitForTask(indexName: "ALGOLIA_INDEX_NAME", taskID: Int64(123))

Parameters

indexName
type: String
Required

Index name for which to check the task.

taskID
type: Int64
Required

Task ID for which to wait.

maxRetries
type: Int
default: 50

Maximum number of times the task status should be checked.

timeout
type: (Int) -> TimeInterval
default: min(TimeInterval(retryCount) * 0.2, 5)

A function that takes one parameter, the current number of retries, and returns the number of seconds after which to check the task’s status again.

requestOptions
type: RequestOptions
default: nil

Extra parameters, such as headers or timeouts. For more information, see Request options.

Did you find this page helpful?