Swift API overview

Import the Rollup module. Everything starts from the Rollup namespace and its shared client, Rollup.shared, which runs on the main actor.

import Rollup

Rollup.registerBackgroundTasks()
try Rollup.configure(publishableKey: "rk_live_...", indexing: IndexOptions())

let access = await Rollup.shared.requestPhotoAccess()
for await state in Rollup.shared.indexing.states { /* ... */ }

let results = try await Rollup.shared.search("ramen in Tokyo last spring")
let answer = try await Rollup.shared.query("Where do I eat most?")
let profile = try await Rollup.shared.profile(schema: schemaData)
try await Rollup.shared.reset()

Type	What it is
`Rollup`	Setup: `configure`, `registerBackgroundTasks`, the shared client and JSON coders.
`RollupClient`	`requestPhotoAccess`, `search`, `query`, `profile` and `reset`.
`Indexing`	Indexing state, its changes, `start()` and the current options.
`IndexOptions`	What to index.
`IndexingState`	Where indexing is.
`SearchResults`	What `search` returns.
`Answer`	What `query` returns.
`Profile`	What `profile` returns.
`RollupError`	Every error the SDK throws.
`JSONValue`	Any JSON value, for results without a fixed shape.

Codable results

Every public value type is Codable and Sendable, with camelCase keys. Enums encode as tagged objects, such as {"type":"indexing","indexed":10,"total":40,"searchable":true}. Use Rollup.jsonEncoder and Rollup.jsonDecoder, which write and read ISO 8601 dates, to pass results to a web view or another layer as JSON.

​Codable results

Codable results