Providers and models
Arkivra keeps AI disabled until a platform administrator configures providers, selects models, and enables the instance-wide AI switch. Uploads, Docling processing, previews, versions, tags, trash, and keyword search continue to work without AI.
Supported provider paths
Section titled “Supported provider paths”Arkivra currently discovers and uses models from:
- Ollama-compatible endpoints for chat, translation, embeddings, and optional ingestion-time image captioning;
- Google Gemini through Google’s OpenAI-compatible inference endpoints for chat, translation, and embeddings, with the native Models API used during discovery.
These are the implemented first-class providers. Do not assume that an arbitrary OpenAI-compatible service will work merely because one inference path uses an OpenAI-compatible protocol.
Configure Ollama
Section titled “Configure Ollama”-
Run an Ollama-compatible service and pull the models you intend to use.
-
Set its base URL in the Arkivra environment:
ARKIVRA_OLLAMA_HOST=http://127.0.0.1:11434From the repository Docker container to Ollama on the host, use:
ARKIVRA_OLLAMA_HOST=http://host.docker.internal:11434 -
Restart Arkivra.
-
Open Administration → AI Settings and confirm Ollama is healthy and its models are discovered.
The Ollama base URL does not use an OpenAI /v1 suffix in Arkivra’s configuration. Arkivra calls the Ollama-compatible model and embedding routes it implements.
Configure Gemini
Section titled “Configure Gemini”-
Put the API key in the Arkivra process environment:
GEMINI_API_KEY=<api-key> -
Restart Arkivra.
-
Open AI Settings and confirm Google Gemini is healthy.
AI Settings stores the name of an environment variable containing the secret, not the raw key. The default reference is GEMINI_API_KEY. If you use another environment-variable name, configure that reference in the admin UI and make the variable available to both API and worker processes.
Arkivra checks Google’s native model metadata against the OpenAI-compatible model listing and exposes models with capabilities usable by Arkivra. There is no static fallback catalog; discovery failure makes Gemini unavailable until it succeeds.
Select models
Section titled “Select models”AI Settings separates three choices:
- Chat models — choose the default and the additional models users may select.
- Translation model — choose the provider and model used for PDF translation.
- Search engine — choose the embedding provider, model, and dimensions used for semantic indexing.
Arkivra currently requires a complete embedding selection before the overall AI switch can be enabled. Chat and translation health are also reported as unavailable when the configured embedding platform is unhealthy, because the current AI configuration treats that search engine as a shared dependency.
Changing the embedding model or dimensions creates a new index rather than mixing incompatible vectors. Read Semantic indexing before confirming that change.
Enable AI for users
Section titled “Enable AI for users”After providers and model choices are healthy, enable AI from the top of AI Settings. Then grant regular users the Use AI platform privilege under Administration → Users. Administrators receive platform capabilities implicitly.
AI privileges do not bypass vault permissions for regular users. Chat and semantic search restrict their source documents to readable vaults. Platform administrators have implemented instance-wide vault access; see Users and permissions.
Optional image captioning
Section titled “Optional image captioning”Arkivra can caption images extracted during document processing using an Ollama vision model:
ARKIVRA_OLLAMA_IMAGE_CAPTIONING_ENABLED=trueARKIVRA_OLLAMA_IMAGE_CAPTIONING_MODEL=<vision-capable-model>Captions become derived document text for search and embeddings. This runs during ingestion and is separate from the chat and translation model choices. It is disabled by default.
Remote-provider data exposure
Section titled “Remote-provider data exposure”Arkivra sends the content needed for a request to the selected endpoint:
- retrieved document chunks, prompts, and conversation history for chat;
- query text for embeddings and semantic search;
- chunk text when building an embedding index;
- selected text or rendered page images for translation;
- extracted images for captioning when enabled.
A provider outside the operator’s infrastructure may log, retain, or process this data under its own policies. Review Privacy and security before enabling it.
Diagnose provider problems
Section titled “Diagnose provider problems”- Confirm the endpoint is reachable from both API and worker networks.
- For Gemini, confirm the referenced environment variable exists in both processes.
- For Ollama, confirm the model is pulled and appears in model discovery.
- Reopen AI Settings and refresh health after changing environment configuration.
- Do not enable
ARKIVRA_OLLAMA_LOG_REQUESTSwith sensitive documents unless logs are deliberately protected and reviewed; it can expose provider payloads.