@nulab/datadog-ai-guard-middleware-ai-v2 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +177 -0
- package/dist/ai.d.ts +24 -0
- package/dist/ai.js +94 -0
- package/dist/convert.d.ts +4 -0
- package/dist/convert.js +54 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +1 -0
- package/dist/marker.d.ts +30 -0
- package/dist/marker.js +41 -0
- package/package.json +40 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Nulab Inc.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# @nulab/datadog-ai-guard-middleware-ai-v2
|
|
2
|
+
|
|
3
|
+
Datadog AI Guard middleware for [Vercel AI SDK](https://sdk.vercel.ai/) v5 (`@ai-sdk/provider@^2`).
|
|
4
|
+
|
|
5
|
+
> Using AI SDK v6? See [`@nulab/datadog-ai-guard-middleware-ai-v3`](https://www.npmjs.com/package/@nulab/datadog-ai-guard-middleware-ai-v3) instead.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @nulab/datadog-ai-guard-middleware-ai-v2
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### Peer Dependencies
|
|
14
|
+
|
|
15
|
+
- `@ai-sdk/provider` ^2.0.0
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
### Initializing dd-trace
|
|
20
|
+
|
|
21
|
+
Initialize dd-trace with AI Guard enabled and pass `ddtracer.aiguard` (the `AIGuardEvaluator`) to the middleware.
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import ddtracer from "dd-trace";
|
|
25
|
+
|
|
26
|
+
ddtracer.init({
|
|
27
|
+
experimental: {
|
|
28
|
+
aiguard: { enabled: true },
|
|
29
|
+
},
|
|
30
|
+
});
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
> Authentication follows **dd-trace environment variables** (`DD_API_KEY`, `DD_APP_KEY`, etc.). The AI Guard endpoint is **resolved by dd-trace from `DD_SITE`** (e.g., `ap1.datadoghq.com` -> `https://app.ap1.datadoghq.com/api/v2/ai-guard`).
|
|
34
|
+
|
|
35
|
+
### Creating a Guarded Model
|
|
36
|
+
|
|
37
|
+
Use `wrapLanguageModel` to create a middleware-applied model that can be reused with both `generateText` and `streamText`.
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
import { wrapLanguageModel } from "ai";
|
|
41
|
+
|
|
42
|
+
const guardedModel = wrapLanguageModel({
|
|
43
|
+
model: yourModel,
|
|
44
|
+
middleware: [
|
|
45
|
+
new AIGuardMiddleware({
|
|
46
|
+
evaluator: ddtracer.aiguard,
|
|
47
|
+
}),
|
|
48
|
+
],
|
|
49
|
+
});
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Non-Streaming
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
import { generateText } from "ai";
|
|
56
|
+
import {
|
|
57
|
+
AIGuardMiddleware,
|
|
58
|
+
AIGuardMiddlewareAbortError,
|
|
59
|
+
} from "@nulab/datadog-ai-guard-middleware-ai-v2";
|
|
60
|
+
|
|
61
|
+
try {
|
|
62
|
+
const result = await generateText({
|
|
63
|
+
model: guardedModel,
|
|
64
|
+
prompt: "Hello",
|
|
65
|
+
});
|
|
66
|
+
console.log(result.text);
|
|
67
|
+
} catch (err) {
|
|
68
|
+
if (err instanceof AIGuardMiddlewareAbortError) {
|
|
69
|
+
// Blocked by AI Guard security policy
|
|
70
|
+
} else {
|
|
71
|
+
throw err;
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
- The prompt is evaluated **before** being sent to the LLM. If Datadog's **blocking policy** is active and the prompt violates it, an `AIGuardMiddlewareAbortError` is thrown.
|
|
77
|
+
- After the LLM responds, the **entire assistant turn** is evaluated once. If Datadog returns `DENY` / `ABORT` without a blocking policy, only a **warning** is logged.
|
|
78
|
+
|
|
79
|
+
### Streaming
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
import { streamText } from "ai";
|
|
83
|
+
|
|
84
|
+
const { stream } = await streamText({
|
|
85
|
+
model: guardedModel,
|
|
86
|
+
prompt: "Hello",
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
for await (const part of stream) {
|
|
90
|
+
if (part.type === "text-delta") process.stdout.write(part.text);
|
|
91
|
+
if (part.type === "error") {
|
|
92
|
+
// AIGuardStreamTripWire error: tool call blocked by AI Guard
|
|
93
|
+
console.error("blocked:", String(part.error?.message));
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
- In streaming mode, **text-only assistant output is not sent to AI Guard**. AI Guard evaluates only prompts and `tool-call` chunks.
|
|
99
|
+
- When evaluating a `tool-call`, **preceding sibling tool calls from the same turn** are included in the same evaluation request.
|
|
100
|
+
|
|
101
|
+
## Options
|
|
102
|
+
|
|
103
|
+
```ts
|
|
104
|
+
interface AIGuardMiddlewareOptions {
|
|
105
|
+
evaluator: AIGuardEvaluator;
|
|
106
|
+
allowOnFailure?: boolean;
|
|
107
|
+
createAbortError?: (kind: AIGuardKind, message: string) => Error;
|
|
108
|
+
logger?: AIGuardLogger;
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
| Option | Type | Default | Description |
|
|
113
|
+
|--------|------|---------|-------------|
|
|
114
|
+
| `evaluator` | `AIGuardEvaluator` | (required) | Object with an `evaluate(messages, opts)` method. Pass `ddtracer.aiguard` when using dd-trace. Any object satisfying the `AIGuardEvaluator` interface works. |
|
|
115
|
+
| `allowOnFailure` | `boolean` | `true` | `true`: fail-open (continue on evaluation errors). `false`: throw `AIGuardMiddlewareClientError` when evaluation is unavailable. Covers both API failures and message normalization/conversion errors. |
|
|
116
|
+
| `createAbortError` | `(kind, message) => Error` | — | Factory to create a custom error when AI Guard blocks a request. `markAsNonRetryable()` is automatically applied. Useful for framework integration (e.g., injecting Mastra's `TripWire`). |
|
|
117
|
+
| `logger` | `AIGuardLogger` | `console` | Logger with `info`, `warn`, `error` methods. Defaults to `console` so security events are always visible. Pass a no-op logger (`{ info() {}, warn() {}, error() {} }`) to suppress output. |
|
|
118
|
+
|
|
119
|
+
> When Datadog returns `DENY` / `ABORT` without a blocking policy, the middleware logs a **warning** and continues regardless of `allowOnFailure`.
|
|
120
|
+
|
|
121
|
+
## API
|
|
122
|
+
|
|
123
|
+
### Classes
|
|
124
|
+
|
|
125
|
+
| Export | Description |
|
|
126
|
+
|--------|-------------|
|
|
127
|
+
| `AIGuardMiddleware` | Main middleware class. Pass to `wrapLanguageModel` for use. |
|
|
128
|
+
| `AIGuardMiddlewareAbortError` | Thrown when Datadog AI Guard's blocking policy blocks a request (default when `createAbortError` is not specified). Use `instanceof` to identify policy blocks. |
|
|
129
|
+
| `AIGuardMiddlewareClientError` | Thrown when AI Guard evaluation cannot be performed (`allowOnFailure: false`). Distinguishes service failures from policy blocks (`AIGuardMiddlewareAbortError`). |
|
|
130
|
+
| `AIGuardStreamTripWire` | Error used in streaming error chunks (`{ type: "error" }`). Identifies AI Guard-specific errors on the stream consumer side. |
|
|
131
|
+
|
|
132
|
+
### Types
|
|
133
|
+
|
|
134
|
+
| Export | Description |
|
|
135
|
+
|--------|-------------|
|
|
136
|
+
| `AIGuardMiddlewareOptions` | Constructor argument type for `AIGuardMiddleware`. |
|
|
137
|
+
| `AIGuardEvaluator` | Interface with an `evaluate(messages, opts)` method. `ddtracer.aiguard` satisfies this interface. |
|
|
138
|
+
| `AIGuardLogger` | Interface with `info`, `warn`, `error` methods. |
|
|
139
|
+
| `AIGuardKind` | `"Prompt" \| "Assistant response" \| "Tool call"` union type. |
|
|
140
|
+
| `AIGuardMessage` | Message type sent to AI Guard. Argument type for `AIGuardEvaluator.evaluate()`. |
|
|
141
|
+
|
|
142
|
+
### Error Classes
|
|
143
|
+
|
|
144
|
+
| Class | Code | Condition |
|
|
145
|
+
|-------|------|-----------|
|
|
146
|
+
| `AIGuardMiddlewareAbortError` | `AI_GUARD_MIDDLEWARE_ABORT` | Datadog AI Guard blocked the request via blocking policy |
|
|
147
|
+
| `AIGuardMiddlewareClientError` | `AI_GUARD_MIDDLEWARE_CLIENT_ERROR` | AI Guard evaluation unavailable + `allowOnFailure=false` |
|
|
148
|
+
| `AIGuardStreamTripWire` | — | Streaming error chunk: policy block or fail-close evaluation failure |
|
|
149
|
+
|
|
150
|
+
> **Security**: These errors intentionally hide details from the original AI Guard SDK error (`reason`, `tags`, etc.).
|
|
151
|
+
|
|
152
|
+
## Evaluation Scope
|
|
153
|
+
|
|
154
|
+
- **Prompt**: Evaluated once before sending to the LLM
|
|
155
|
+
- **Assistant response (non-streaming)**: Evaluated once per assistant turn after `doGenerate`
|
|
156
|
+
- **Tool calls (streaming)**: Evaluated on each `tool-call` chunk with accumulated sibling tool calls
|
|
157
|
+
- **Tool execution results**: Automatically evaluated as part of the next turn's prompt in agent loops
|
|
158
|
+
|
|
159
|
+
> Blocking decisions are made by **Datadog AI Guard's blocking policy**. The middleware sends `block: true` but only blocks when Datadog returns `AIGuardAbortError`.
|
|
160
|
+
|
|
161
|
+
## Known Limitations
|
|
162
|
+
|
|
163
|
+
- **dd-trace AI Guard experimental feature** must be enabled (use a compatible version).
|
|
164
|
+
- **Blocking requires a Datadog-side blocking policy**. Without one, `DENY` / `ABORT` only produces warnings.
|
|
165
|
+
- Streaming **text-only output is not protected by AI Guard**. Use non-streaming for strict blocking of all assistant output.
|
|
166
|
+
- **Multimodal evaluation supports images (`image/*`) only**. Non-image files (e.g., PDF) are not sent to AI Guard.
|
|
167
|
+
- Evaluation API calls increase **per assistant turn (non-streaming)** or **per `tool-call` chunk (streaming)**.
|
|
168
|
+
|
|
169
|
+
## Requirements
|
|
170
|
+
|
|
171
|
+
- Node.js >= 22
|
|
172
|
+
- `@ai-sdk/provider` ^2.0.0
|
|
173
|
+
- [dd-trace](https://github.com/DataDog/dd-trace-js) >= 5 with AI Guard enabled
|
|
174
|
+
|
|
175
|
+
## License
|
|
176
|
+
|
|
177
|
+
[Apache-2.0](https://github.com/nulab/datadog-ai-guard-middleware/blob/main/LICENSE)
|
package/dist/ai.d.ts
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { LanguageModelV2, LanguageModelV2CallOptions } from "@ai-sdk/provider";
|
|
2
|
+
import type { AIGuardMiddlewareOptions } from "@nulab/datadog-ai-guard-middleware-core";
|
|
3
|
+
export type { AIGuardEvaluator, AIGuardKind, AIGuardLogger, AIGuardMiddlewareOptions, } from "@nulab/datadog-ai-guard-middleware-core";
|
|
4
|
+
export { AIGuardClientError as AIGuardMiddlewareClientError, AIGuardStreamTripWire, } from "@nulab/datadog-ai-guard-middleware-core";
|
|
5
|
+
export { AIGuardMiddlewareAbortError } from "./marker.js";
|
|
6
|
+
type DoGenerateResult = Awaited<ReturnType<LanguageModelV2["doGenerate"]>>;
|
|
7
|
+
type DoStreamResult = Awaited<ReturnType<LanguageModelV2["doStream"]>>;
|
|
8
|
+
/** AI Guard middleware for Vercel AI SDK (LanguageModelV2Middleware compatible). */
|
|
9
|
+
export declare class AIGuardMiddleware {
|
|
10
|
+
#private;
|
|
11
|
+
constructor(options: AIGuardMiddlewareOptions);
|
|
12
|
+
wrapGenerate({ doGenerate, params, }: {
|
|
13
|
+
doGenerate: () => ReturnType<LanguageModelV2["doGenerate"]>;
|
|
14
|
+
doStream: () => ReturnType<LanguageModelV2["doStream"]>;
|
|
15
|
+
params: LanguageModelV2CallOptions;
|
|
16
|
+
model: LanguageModelV2;
|
|
17
|
+
}): Promise<DoGenerateResult>;
|
|
18
|
+
wrapStream({ doStream, params, }: {
|
|
19
|
+
doGenerate: () => ReturnType<LanguageModelV2["doGenerate"]>;
|
|
20
|
+
doStream: () => ReturnType<LanguageModelV2["doStream"]>;
|
|
21
|
+
params: LanguageModelV2CallOptions;
|
|
22
|
+
model: LanguageModelV2;
|
|
23
|
+
}): Promise<DoStreamResult>;
|
|
24
|
+
}
|
package/dist/ai.js
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { AIGuardEvaluationEngine } from "@nulab/datadog-ai-guard-middleware-core";
|
|
2
|
+
import { convertToAIGuardFormat } from "./convert.js";
|
|
3
|
+
import { AIGuardMiddlewareAbortError, markAsNonRetryable } from "./marker.js";
|
|
4
|
+
export { AIGuardClientError as AIGuardMiddlewareClientError, AIGuardStreamTripWire, } from "@nulab/datadog-ai-guard-middleware-core";
|
|
5
|
+
export { AIGuardMiddlewareAbortError } from "./marker.js";
|
|
6
|
+
// NOTE: async/await is required by Vercel AI SDK middleware interface
|
|
7
|
+
/** AI Guard middleware for Vercel AI SDK (LanguageModelV2Middleware compatible). */
|
|
8
|
+
export class AIGuardMiddleware {
|
|
9
|
+
#engine;
|
|
10
|
+
constructor(options) {
|
|
11
|
+
const { evaluator, allowOnFailure = true, createAbortError, logger = console } = options || {};
|
|
12
|
+
if (!evaluator) {
|
|
13
|
+
throw new TypeError("AIGuardMiddleware: evaluator is required");
|
|
14
|
+
}
|
|
15
|
+
this.#engine = new AIGuardEvaluationEngine({
|
|
16
|
+
evaluator,
|
|
17
|
+
allowOnFailure,
|
|
18
|
+
logger,
|
|
19
|
+
buildAbortError: (kind) => {
|
|
20
|
+
if (createAbortError) {
|
|
21
|
+
const customError = createAbortError(kind, `${kind} blocked by AI Guard security policy`);
|
|
22
|
+
markAsNonRetryable(customError);
|
|
23
|
+
return customError;
|
|
24
|
+
}
|
|
25
|
+
return new AIGuardMiddlewareAbortError(kind);
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
this.wrapGenerate = this.wrapGenerate.bind(this);
|
|
29
|
+
this.wrapStream = this.wrapStream.bind(this);
|
|
30
|
+
}
|
|
31
|
+
async #evaluatePrompt(prompt) {
|
|
32
|
+
const roles = prompt.map((m) => m.role);
|
|
33
|
+
const meta = `roles=[${roles.join(",")}]`;
|
|
34
|
+
const messages = this.#engine.convertOrHandleUnavailable("Prompt", meta, () => convertToAIGuardFormat(prompt));
|
|
35
|
+
if (!messages) {
|
|
36
|
+
return undefined;
|
|
37
|
+
}
|
|
38
|
+
await this.#engine.evaluate(messages, "Prompt", meta);
|
|
39
|
+
return messages;
|
|
40
|
+
}
|
|
41
|
+
async wrapGenerate({ doGenerate, params, }) {
|
|
42
|
+
const baseMessages = await this.#evaluatePrompt(params.prompt);
|
|
43
|
+
const result = await doGenerate();
|
|
44
|
+
if (result.content.length > 0) {
|
|
45
|
+
await this.#engine.evaluateAssistantResponse(result.content, baseMessages);
|
|
46
|
+
}
|
|
47
|
+
return result;
|
|
48
|
+
}
|
|
49
|
+
async wrapStream({ doStream, params, }) {
|
|
50
|
+
const baseMessages = await this.#evaluatePrompt(params.prompt);
|
|
51
|
+
const result = await doStream();
|
|
52
|
+
let stopped = false;
|
|
53
|
+
const seenToolCalls = [];
|
|
54
|
+
const transform = new TransformStream({
|
|
55
|
+
transform: async (chunk, controller) => {
|
|
56
|
+
if (stopped) {
|
|
57
|
+
return;
|
|
58
|
+
}
|
|
59
|
+
if (chunk.type === "tool-call") {
|
|
60
|
+
try {
|
|
61
|
+
const converted = await this.#engine.evaluateToolCall(chunk, baseMessages, seenToolCalls);
|
|
62
|
+
if (converted) {
|
|
63
|
+
seenToolCalls.push(converted);
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
catch (error) {
|
|
67
|
+
stopped = true;
|
|
68
|
+
if (this.#engine.isBlockedByPolicy(error)) {
|
|
69
|
+
this.#engine.logger.warn("[AI Guard] wrapStream — tool call blocked, terminating stream");
|
|
70
|
+
}
|
|
71
|
+
else {
|
|
72
|
+
this.#engine.logger.warn("[AI Guard] wrapStream — tool call could not be evaluated, terminating stream");
|
|
73
|
+
}
|
|
74
|
+
controller.enqueue({
|
|
75
|
+
type: "error",
|
|
76
|
+
error: this.#engine.createStreamErrorForAbort(error),
|
|
77
|
+
});
|
|
78
|
+
controller.terminate();
|
|
79
|
+
return;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
if (chunk.type === "finish") {
|
|
83
|
+
seenToolCalls.length = 0;
|
|
84
|
+
}
|
|
85
|
+
controller.enqueue(chunk);
|
|
86
|
+
},
|
|
87
|
+
});
|
|
88
|
+
const wrappedStream = result.stream.pipeThrough(transform);
|
|
89
|
+
return {
|
|
90
|
+
...result,
|
|
91
|
+
stream: wrappedStream,
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { LanguageModelV2Message } from "@ai-sdk/provider";
|
|
2
|
+
import type { AIGuardMessage } from "@nulab/datadog-ai-guard-middleware-core";
|
|
3
|
+
export type { AIGuardMessage } from "@nulab/datadog-ai-guard-middleware-core";
|
|
4
|
+
export declare function convertToAIGuardFormat(prompt: LanguageModelV2Message[]): AIGuardMessage[];
|
package/dist/convert.js
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { convertAssistantContentToAIGuardMessages, convertPromptContent, extractToolResultContent, } from "@nulab/datadog-ai-guard-middleware-core";
|
|
2
|
+
function convertMessage(message) {
|
|
3
|
+
switch (message.role) {
|
|
4
|
+
case "system":
|
|
5
|
+
return {
|
|
6
|
+
role: message.role,
|
|
7
|
+
content: convertPromptContent(message.content),
|
|
8
|
+
};
|
|
9
|
+
case "user":
|
|
10
|
+
return {
|
|
11
|
+
role: message.role,
|
|
12
|
+
content: convertPromptContent(message.content),
|
|
13
|
+
};
|
|
14
|
+
case "assistant":
|
|
15
|
+
return convertAssistantContentToAIGuardMessages(message.content);
|
|
16
|
+
case "tool": {
|
|
17
|
+
if (!Array.isArray(message.content)) {
|
|
18
|
+
return { role: message.role, content: "" };
|
|
19
|
+
}
|
|
20
|
+
const toolMessages = [];
|
|
21
|
+
for (const part of message.content) {
|
|
22
|
+
if (part.type === "tool-result") {
|
|
23
|
+
if (typeof part.toolCallId !== "string" || part.toolCallId.trim() === "") {
|
|
24
|
+
throw new TypeError("Tool result must have a non-empty tool_call_id");
|
|
25
|
+
}
|
|
26
|
+
toolMessages.push({
|
|
27
|
+
role: "tool",
|
|
28
|
+
tool_call_id: part.toolCallId,
|
|
29
|
+
content: extractToolResultContent(part),
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
return toolMessages;
|
|
34
|
+
}
|
|
35
|
+
default: {
|
|
36
|
+
// Defensive fallback for unexpected roles at runtime
|
|
37
|
+
const msg = message;
|
|
38
|
+
return { role: msg.role, content: convertPromptContent(msg.content) };
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
export function convertToAIGuardFormat(prompt) {
|
|
43
|
+
const result = [];
|
|
44
|
+
for (const message of prompt) {
|
|
45
|
+
const converted = convertMessage(message);
|
|
46
|
+
if (Array.isArray(converted)) {
|
|
47
|
+
result.push(...converted);
|
|
48
|
+
}
|
|
49
|
+
else {
|
|
50
|
+
result.push(converted);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
return result;
|
|
54
|
+
}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export type { AIGuardEvaluator, AIGuardKind, AIGuardLogger, AIGuardMiddlewareOptions, } from "./ai.js";
|
|
2
|
+
export { AIGuardMiddleware, AIGuardMiddlewareAbortError, AIGuardMiddlewareClientError, AIGuardStreamTripWire, } from "./ai.js";
|
|
3
|
+
export type { AIGuardMessage } from "./convert.js";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { AIGuardMiddleware, AIGuardMiddlewareAbortError, AIGuardMiddlewareClientError, AIGuardStreamTripWire, } from "./ai.js";
|
package/dist/marker.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { AIGuardKind } from "@nulab/datadog-ai-guard-middleware-core";
|
|
2
|
+
import { AIGuardAbortError } from "@nulab/datadog-ai-guard-middleware-core";
|
|
3
|
+
/**
|
|
4
|
+
* Applies Vercel AI SDK non-retryable markers to an error.
|
|
5
|
+
*
|
|
6
|
+
* After calling this, the error will be recognized by the AI SDK's
|
|
7
|
+
* `APICallError.isInstance()` duck-type check and skipped by
|
|
8
|
+
* `retryWithExponentialBackoff` due to `isRetryable=false`.
|
|
9
|
+
*
|
|
10
|
+
* Any existing `isRetryable` property is overwritten to guarantee
|
|
11
|
+
* the error will not be retried.
|
|
12
|
+
*/
|
|
13
|
+
export declare function markAsNonRetryable(error: Error): void;
|
|
14
|
+
/**
|
|
15
|
+
* Non-retryable error thrown when AI Guard blocks a request by security policy.
|
|
16
|
+
*
|
|
17
|
+
* The Vercel AI SDK APICallError markers with isRetryable=false prevent
|
|
18
|
+
* retryWithExponentialBackoff from retrying within the same model.
|
|
19
|
+
*
|
|
20
|
+
* For framework integration (e.g. Mastra), use the `createAbortError` option
|
|
21
|
+
* in `AIGuardMiddlewareOptions` to supply a custom error class that your
|
|
22
|
+
* framework recognizes. The middleware automatically calls `markAsNonRetryable`
|
|
23
|
+
* on the custom error.
|
|
24
|
+
*/
|
|
25
|
+
export declare class AIGuardMiddlewareAbortError extends AIGuardAbortError {
|
|
26
|
+
readonly name = "AIGuardMiddlewareAbortError";
|
|
27
|
+
readonly code = "AI_GUARD_MIDDLEWARE_ABORT";
|
|
28
|
+
readonly isRetryable = false;
|
|
29
|
+
constructor(kind: AIGuardKind);
|
|
30
|
+
}
|
package/dist/marker.js
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { AIGuardAbortError } from "@nulab/datadog-ai-guard-middleware-core";
|
|
2
|
+
// Vercel AI SDK marker symbols used by APICallError.isInstance() for duck-type checking.
|
|
3
|
+
// When both markers are present and isRetryable is false, the AI SDK's
|
|
4
|
+
// retryWithExponentialBackoff skips retries for non-transient security policy blocks.
|
|
5
|
+
const AI_SDK_ERROR_MARKER = Symbol.for("vercel.ai.error.AI_SDKError");
|
|
6
|
+
const API_CALL_ERROR_MARKER = Symbol.for("vercel.ai.error.AI_APICallError");
|
|
7
|
+
/**
|
|
8
|
+
* Applies Vercel AI SDK non-retryable markers to an error.
|
|
9
|
+
*
|
|
10
|
+
* After calling this, the error will be recognized by the AI SDK's
|
|
11
|
+
* `APICallError.isInstance()` duck-type check and skipped by
|
|
12
|
+
* `retryWithExponentialBackoff` due to `isRetryable=false`.
|
|
13
|
+
*
|
|
14
|
+
* Any existing `isRetryable` property is overwritten to guarantee
|
|
15
|
+
* the error will not be retried.
|
|
16
|
+
*/
|
|
17
|
+
export function markAsNonRetryable(error) {
|
|
18
|
+
Object.defineProperty(error, AI_SDK_ERROR_MARKER, { value: true });
|
|
19
|
+
Object.defineProperty(error, API_CALL_ERROR_MARKER, { value: true });
|
|
20
|
+
Object.defineProperty(error, "isRetryable", { value: false, configurable: true });
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Non-retryable error thrown when AI Guard blocks a request by security policy.
|
|
24
|
+
*
|
|
25
|
+
* The Vercel AI SDK APICallError markers with isRetryable=false prevent
|
|
26
|
+
* retryWithExponentialBackoff from retrying within the same model.
|
|
27
|
+
*
|
|
28
|
+
* For framework integration (e.g. Mastra), use the `createAbortError` option
|
|
29
|
+
* in `AIGuardMiddlewareOptions` to supply a custom error class that your
|
|
30
|
+
* framework recognizes. The middleware automatically calls `markAsNonRetryable`
|
|
31
|
+
* on the custom error.
|
|
32
|
+
*/
|
|
33
|
+
export class AIGuardMiddlewareAbortError extends AIGuardAbortError {
|
|
34
|
+
name = "AIGuardMiddlewareAbortError";
|
|
35
|
+
code = "AI_GUARD_MIDDLEWARE_ABORT";
|
|
36
|
+
isRetryable = false;
|
|
37
|
+
constructor(kind) {
|
|
38
|
+
super(kind);
|
|
39
|
+
markAsNonRetryable(this);
|
|
40
|
+
}
|
|
41
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@nulab/datadog-ai-guard-middleware-ai-v2",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"engines": {
|
|
7
|
+
"node": ">=22"
|
|
8
|
+
},
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"import": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"dist"
|
|
19
|
+
],
|
|
20
|
+
"dependencies": {
|
|
21
|
+
"@nulab/datadog-ai-guard-middleware-core": "0.1.0"
|
|
22
|
+
},
|
|
23
|
+
"peerDependencies": {
|
|
24
|
+
"@ai-sdk/provider": "^2.0.0"
|
|
25
|
+
},
|
|
26
|
+
"devDependencies": {
|
|
27
|
+
"@ai-sdk/openai": "^2.0.0",
|
|
28
|
+
"@ai-sdk/provider": "^2.0.0",
|
|
29
|
+
"@types/node": "^25.5.0",
|
|
30
|
+
"ai": "^5.0.0",
|
|
31
|
+
"@nulab/datadog-ai-guard-middleware-internal": "0.0.0"
|
|
32
|
+
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"clean": "rm -rf dist",
|
|
35
|
+
"build": "pnpm run clean && tsc",
|
|
36
|
+
"test": "vitest run",
|
|
37
|
+
"test:coverage": "vitest run --coverage",
|
|
38
|
+
"test:integration": "vitest run --config vitest.integration.config.ts"
|
|
39
|
+
}
|
|
40
|
+
}
|