# AI configuration overview

Use this page to understand the AI configuration area, review the AI workspace, and choose the
next page for configuring or referring to AI settings.

## AI configuration and workspace overview

AI Configuration is the administrative area for the provider and response settings used by
AI-supported documentation work. The AI workspace is the **AI Assistant** area for suggestions,
content-quality and readability analysis, summaries, and key points.

| If you need to… | Go to |
|---|---|
| Understand the page before using an AI surface | [Before you start](#before-you-start) |
| Find the two AI destinations | [Find the AI surfaces](#find-the-ai-surfaces) |
| Identify tabs, fields, and controls | [Understand the AI configuration screen](#understand-the-ai-configuration-screen) |
| Configure providers or response settings | [Configure AI](doc:configure-ai) |
| Review provider, usage, history, and settings details | [AI configuration reference](doc:ai-configuration-reference) |
| Move between application destinations | [Navigation basics](doc:navigation-basics) |
| Resolve an issue that the AI pages do not explain | [Getting help](doc:getting-help) |

The provider choices are the available AI services. The provider list includes Azure and direct
provider variants, and the settings page uses one selected provider as the default for AI
operations.

**Result:** You know whether you need the AI configuration area or the AI workspace, and which
section or related page to open next.

## Before you start

Use AI settings to control the application’s AI services and use the workspace for documentation
assistance.

**Prerequisites**

- Decide whether you need to change a provider or response setting, review usage, review request
  history, or use the workspace.
- Keep the settings in the browser where you use them. The settings are stored locally and are
  merged with the default values when the page loads.

No required markers are declared for the AI configuration controls. The initial settings are
`azure-claude`, `2000`, `0.7`, enabled streaming, and enabled auto-save when no stored values
override them.

**Result:** You know the purpose of the destination, the task you want to perform, and the local
settings behaviour before you open a control.

## Find the AI surfaces

Choose the destination that matches the work you need to do.

**Steps**

1. Open the destination that matches your task.

   | If you need to… | Open |
   |---|---|
   | Configure providers, review usage or history, or manage settings | [AI Configuration](#understand-the-ai-configuration-screen) |
   | Open the AI workspace | [AI Assistant](#choose-what-to-do-next) |

2. If the AI Configuration page displays `404`, use [Getting help](doc:getting-help) before
   continuing.

   A `404` page means that the destination is unavailable.

   

**Result:** You are at the selected AI destination, or you have the returned page state to use when
choosing the next support step.

## Understand the AI configuration screen

The AI configuration screen groups provider selection, usage, request history, advanced response
settings, and settings backup under four tabs.

| Tab | Use it to… |
|---|---|
| **Providers** | Choose the default provider and test an available provider connection. |
| **Usage** | Review current-billing-month usage. |
| **History** | Review recent AI requests, filter them, sort them, and refresh the list. |
| **Settings** | Adjust response parameters, feature switches, and settings backup. |

The **History** tab provides these choices:

| Control | Choices |
|---|---|
| **Status filter** | `All`, `Success`, `Error` |
| **Sort by** | `Time`, `Duration`, `Tokens` |

The **Settings** tab provides these fields and controls:

| Field or control | What it changes |
|---|---|
| **Max Tokens** | The maximum generated-token value; the range is `100` to `4000` in steps of `100`. |
| **Temperature** | Response randomness; the range is `0` to `1` in steps of `0.1`. |
| **Enable Streaming** | Whether responses stream in real time. |
| **Auto-Save Settings** | Whether changes save automatically to local storage. |
| **📥 Export Settings** | Downloads the settings as a JSON file. |
| **📤 Import Settings** | Selects a `.json` settings file for import. |
| **🔄 Reset to Defaults** | Restores the default settings and removes stored settings. |

Provider cards show a radio choice for the default provider and **Test Connection**. The connection
control is available only for an available provider and is disabled while that provider is being
tested. The provider cards can show `● Available` or `● Unavailable`, followed by `✓ Test Passed`
or `✗ Test Failed` after a connection test.

**Result:** You can identify the tab, field, choice, or backup control that matches your task.

## Configure or review AI

Use this procedure when you need to change a setting, inspect usage or history, test a provider, or
back up the settings.

**Prerequisites**

- Open [AI Configuration](#understand-the-ai-configuration-screen).
- Know which provider, response setting, review list, or backup action you need.

**Steps**

1. Select the tab for the task you need.

   | If you need to… | Select |
   |---|---|
   | Choose a default provider or test a connection | **Providers** |
   | Review current-billing-month totals | **Usage** |
   | Review, filter, sort, or reload requests | **History** |
   | Change response settings or back up settings | **Settings** |

2. Complete the task for the tab you selected.

   | If you need to… | Action |
   |---|---|
   | Set the default provider | On **Providers**, select the provider radio choice. |
   | Test an available provider | On **Providers**, select **Test Connection**. The card displays `✓ Test Passed` or `✗ Test Failed`. |
   | Filter or sort request history | On **History**, choose `All`, `Success`, or `Error` from **Status filter**, or choose `Time`, `Duration`, or `Tokens` from **Sort by**. |
   | Reload request history | On **History**, select **🔄 Refresh**. |
   | Change response settings | On **Settings**, change **Max Tokens**, **Temperature**, **Enable Streaming**, or **Auto-Save Settings**. The values are stored in the browser. |
   | Back up or restore settings | On **Settings**, select **📥 Export Settings**, **📤 Import Settings**, or **🔄 Reset to Defaults**. |

3. Confirm that the selected provider, response setting, review list, or backup result appears on
   screen.

**Result:** The selected provider, response settings, review list, or backup result is on screen.

## Handle the available AI states

Each tab answers a different review question, and the content changes with the available provider,
usage, and request data.

| When you are looking for… | The page shows… |
|---|---|
| Providers | Provider configuration. |
| Current-billing-month usage | Usage totals, or `No AI usage recorded this month` when no usage is present. |
| Recent requests | Request history, or `No request history found.` when no rows are present. |
| Advanced response settings | The settings manager. |
| Providers but none are returned | `No AI providers configured.` |
| Usage while it loads | `Loading usage…` |

Request history can first show loading placeholders under **Request History**. Provider cards show
`● Available` or `● Unavailable` for availability.

**Result:** You can match the visible state to the tab or data condition that produced it.

## When AI configuration goes wrong

Use the message on screen to choose the corrective route. The AI workspace is currently presented
as **Coming soon**, and it has no editable workspace fields or assistant action to select.

| What you see | What to do |
|---|---|
| `AI settings failed to load.` | Return to [AI Configuration](#understand-the-ai-configuration-screen) and use [Getting help](doc:getting-help) if the page still does not load. |
| `Failed to import settings:` followed by the import error | Select a JSON settings file and repeat **📤 Import Settings**. |
| `✗ Test Failed` | Check the provider configuration, then select **Test Connection** again. |
| The AI Configuration page reads `404` | Use [Getting help](doc:getting-help) for destination access assistance. |
| The AI Assistant page reads `Coming soon` | Use [Configure AI](doc:configure-ai) for available configuration work. |

**Result:** You have a message-specific next action and a support route for a page that does not
load.

## Choose what to do next

The AI configuration area handles provider selection, response settings, usage review, request
history, and local settings backup. The AI workspace currently displays **AI Assistant** and
**Coming soon** with no editable workspace fields or assistant actions.

| If you need to… | Go to |
|---|---|
| Change providers, response settings, or local settings backup | [Configure AI](doc:configure-ai) |
| Check provider names, fields, options, and messages | [AI configuration reference](doc:ai-configuration-reference) |
| Move between application areas | [Navigation basics](doc:navigation-basics) |
| Get help with a route or message | [Getting help](doc:getting-help) |
| Understand why there is no prompt or workspace action here | Continue with the configuration or reference page above. |

**Result:** You have a named next page for configuration, reference, navigation, or support.
