> For the complete documentation index, see [llms.txt](https://ai.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ai.ortusbooks.com/advanced/reference/built-in-functions/aidecisionstore.md).

# aiDecisionStore

Creates an IDecisionStore — the backing store for durable human-approval grants used by Human-in-the-Loop.

Creates an `IDecisionStore` — the backing store for durable human-approval grants (`approve_always` and `approve_session`) used by [Human-in-the-Loop](https://ai.ortusbooks.com/main-components/human-in-the-loop.md).

## Syntax

```javascript
aiDecisionStore( store, config )
```

## Parameters

| Parameter | Type     | Required | Default                                | Description                                   |
| --------- | -------- | -------- | -------------------------------------- | --------------------------------------------- |
| `store`   | `string` | ❌        | `settings.hitl.decisionStore.provider` | `cache`, `jdbc`, `file`, or a full class path |
| `config`  | `struct` | ❌        | `settings.hitl.decisionStore.config`   | Configuration for the chosen store            |

Called with no arguments, it resolves the application-wide default from module settings — the same fallback `HumanInTheLoopMiddleware` uses when it isn't given a store explicitly.

## Returns

An `IDecisionStore` instance.

## Throws

`InvalidDecisionStoreType` for an unrecognised type that isn't a class path.

## Store Types

| Type    | Aliases                               | Backing        | Config                           |
| ------- | ------------------------------------- | -------------- | -------------------------------- |
| `cache` | `CacheDecisionStore`                  | CacheBox       | `cacheName`                      |
| `jdbc`  | `database`, `db`, `JdbcDecisionStore` | Any datasource | `datasource` (required), `table` |
| `file`  | `FileDecisionStore`                   | JSON on disk   | `directoryPath`                  |

## Store Contract

| Method                                          | Returns   | Description                                     |
| ----------------------------------------------- | --------- | ----------------------------------------------- |
| `grant( identity, toolName, scope, expiresAt )` | `void`    | Record a grant                                  |
| `isGranted( identity, toolName, scope )`        | `boolean` | Whether a live grant exists                     |
| `revoke( identity, toolName, scope )`           | `void`    | Remove a grant                                  |
| `listGrants( identity )`                        | `array`   | `[ { toolName, scope, grantedAt, expiresAt } ]` |

## Examples

### Application-Wide Default

```json
{
  "modules": {
    "bxai": {
      "settings": {
        "hitl": {
          "decisionStore": { "provider": "cache", "config": {} }
        }
      }
    }
  }
}
```

```javascript
// Resolves the configured default
store = aiDecisionStore()
```

### Explicit Stores

```javascript
// Database-backed, survives restarts and is shared across nodes
store = aiDecisionStore( "jdbc", { datasource: "myDSN", table: "ai_decisions" } )

// File-backed
store = aiDecisionStore( "file", { directoryPath: "/var/bxai/decisions" } )

// Cache-backed
store = aiDecisionStore( "cache", { cacheName: "default" } )
```

### Attaching to HITL

```javascript
import bxModules.bxai.models.middleware.core.HumanInTheLoopMiddleware;

hitl = new HumanInTheLoopMiddleware(
    toolsRequiringApproval: [ "placeOrder" ],
    decisionStore         : aiDecisionStore( "jdbc", { datasource: "myDSN" } )
)
```

### Auditing and Revoking Grants

```javascript
store = aiDecisionStore()

// What has this user permanently allowed?
grants = store.listGrants( "alice@example.com" )

// Take it back
store.revoke( "alice@example.com", "placeOrder" )
```

## Events

Fires `onAiDecisionStoreCreate` with `{ storeType, storeClass, storeConfig }`.

## Related

* [Human-in-the-Loop](https://ai.ortusbooks.com/main-components/human-in-the-loop.md)
* [Gateways](https://ai.ortusbooks.com/main-components/gateways.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ai.ortusbooks.com/advanced/reference/built-in-functions/aidecisionstore.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
