AI provider setup
Quick start

OneView documentation

AI provider setup

Connect, test, rotate, and select the installation's AI provider and model.

AI provider setup

Open AI → Providers to connect the client installation to a supported external AI provider. The page is available only when the installed release supports the AI Module and the current license includes it.

ai_provider:read permits configuration visibility without revealing API keys. ai_provider:manage adds provider creation, key testing and rotation, enable/disable actions, and default selection. Assign read access as well so a provider administrator can navigate to and review the page.

Add a provider

  1. Select Add new provider.
  2. Choose a provider from the release catalogue.
  3. Choose one of the models made available for that provider. Recommended models are labelled in the list.
  4. Enter the provider-issued API key.
  5. Select whether this provider and model should become the default for all users.
  6. Select Test and add provider.

The available list is the intersection of provider adapters compiled into the installed release and the active provider/model catalogue managed by OneView's backoffice administrators. Model identifiers are never entered manually in the client installation. A new provider requires a compatible adapter and client update; a newly qualified model for an already supported provider normally appears after the catalogue refresh without another client release. Neither an update nor a catalogue change automatically configures a provider or replaces the client's default.

OneView tests the key against the selected model before saving the configuration. The page shows whether the last test passed, when it ran, and whether the configuration is active, disabled, or unavailable. The key is encrypted before storage and is never displayed again.

Default and readiness

The default configuration is the installation-wide provider and model used by context chat and automatic transaction investigation. A configuration is ready only while it is active, its last test succeeded, and its provider and model remain available in the installed release catalogue.

Use Make default to select another tested configuration. Disabling a non-default configuration prevents its use. The application does not offer disabling the current default directly; select another ready default first.

Use Rotate key when the provider issues a replacement credential. Enter the complete replacement key and run Test and rotate key. OneView keeps the existing configuration if the replacement cannot be validated.

Troubleshooting

  • Provider or model is missing — confirm the provider/model is active in the backoffice catalogue. For a provider, also check that the installed version contains its adapter and apply an approved update when required. A license refresh alone does not add provider code to an older release.
  • Key test fails — verify the credential, provider account status, model access, billing or quota, outbound HTTPS, and any provider IP restrictions. Do not place the key in logs, screenshots, or support messages.
  • AI remains unavailable — confirm the AI Module appears on the License page, the configuration is active, the last test passed, and one ready configuration is marked Default.
  • Automatic investigation cannot be enabled — configure the transaction-monitoring base currency first and then confirm the default AI provider is ready.

Provider availability and a successful test do not replace the client's privacy, security, procurement, or legal review. See AI in OneView and Data boundary & responsibilities.