Support
We're happy to help with questions, bug reports and feature requests.
When reporting a problem
These details help us find the cause quickly:
- Your Vicaya version (Vicaya ▸ About Vicaya) and macOS version.
- What you did, what you expected, and what happened instead.
- Your chunking, index and answering settings, if the problem is with search results.
- A screenshot, or a small sample document that shows the problem, if you can share one.
- For problems in your iOS app, the iOS version and device model.
Frequently asked questions
What are the system requirements?
Vicaya runs on macOS 27. Knowledge bundles exported from Vicaya use iOS 27 features, so your app needs to target iOS 27.
Which file types can I add?
Markdown, PDF and plain text. You can add individual files or whole folders.
Do I need machine learning experience?
No. Start with the Document Q&A template, which uses sensible defaults. Vicaya only offers settings that work together, and the built-in tests show you whether a change made results better or worse.
How do I add a knowledge bundle to my app?
- Export the bundle from Vicaya.
- Add the bundle file to your Xcode project and include it in your app target.
- Add the runtime package and enable the included build plugin.
- Build. The plugin generates a typed Swift API with a search tool and an answer call you can use right away.
Why am I seeing a warning that the device differs?
Each bundle records the model and settings it was built and tested with. In debug builds, the runtime warns you when the device running your app differs from that, because answers may not match what you saw in Vicaya. Re-run your tests in Vicaya against the new environment to confirm the results still hold.
Why doesn't my question retrieve the right content?
Open the question in the evaluation results to see which chunks came back instead. Common fixes:
- Try chunking by heading if your documents have clear sections.
- Switch to hybrid search when questions use different words than your documents.
- Turn on contextual notes if several sections look alike.
- Increase top-k, or lower chunk size so more relevant pieces fit your context budget.
Can I run builds and tests in CI?
Yes. The command-line tool runs the same builds and evaluations as the app, using the project file in your repository.
Where are my documents processed?
Indexing, embeddings and answers use Apple's on-device frameworks on your Mac. Your documents are never sent to us. See the Privacy Policy.
Feature requests
Have an idea that would make Vicaya more useful? Email avitsadok@me.com and tell us what you're building.