@arizeai/phoenix-evals 2.3.0 → 2.5.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/CHANGELOG.md +256 -0
- package/README.md +7 -5
- package/dist/esm/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
- package/dist/esm/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
- package/dist/esm/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js +93 -0
- package/dist/esm/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
- package/dist/esm/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
- package/dist/esm/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
- package/dist/esm/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.js +119 -0
- package/dist/esm/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
- package/dist/esm/__generated__/default_templates/index.d.ts +2 -0
- package/dist/esm/__generated__/default_templates/index.d.ts.map +1 -1
- package/dist/esm/__generated__/default_templates/index.js +2 -0
- package/dist/esm/__generated__/default_templates/index.js.map +1 -1
- package/dist/esm/llm/createCompletenessEvaluator.d.ts +46 -0
- package/dist/esm/llm/createCompletenessEvaluator.d.ts.map +1 -0
- package/dist/esm/llm/createCompletenessEvaluator.js +38 -0
- package/dist/esm/llm/createCompletenessEvaluator.js.map +1 -0
- package/dist/esm/llm/createDocumentRelevanceEvaluator.d.ts +16 -11
- package/dist/esm/llm/createDocumentRelevanceEvaluator.d.ts.map +1 -1
- package/dist/esm/llm/createDocumentRelevanceEvaluator.js +7 -11
- package/dist/esm/llm/createDocumentRelevanceEvaluator.js.map +1 -1
- package/dist/esm/llm/createPiiDetectionEvaluator.d.ts +46 -0
- package/dist/esm/llm/createPiiDetectionEvaluator.d.ts.map +1 -0
- package/dist/esm/llm/createPiiDetectionEvaluator.js +39 -0
- package/dist/esm/llm/createPiiDetectionEvaluator.js.map +1 -0
- package/dist/esm/llm/createRetrievalRelevanceEvaluator.d.ts +4 -5
- package/dist/esm/llm/createRetrievalRelevanceEvaluator.d.ts.map +1 -1
- package/dist/esm/llm/createRetrievalRelevanceEvaluator.js +4 -5
- package/dist/esm/llm/createRetrievalRelevanceEvaluator.js.map +1 -1
- package/dist/esm/llm/index.d.ts +2 -0
- package/dist/esm/llm/index.d.ts.map +1 -1
- package/dist/esm/llm/index.js +2 -0
- package/dist/esm/llm/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/esm/utils/bindEvaluator.d.ts +4 -5
- package/dist/esm/utils/bindEvaluator.d.ts.map +1 -1
- package/dist/esm/utils/bindEvaluator.js +4 -5
- package/dist/esm/utils/bindEvaluator.js.map +1 -1
- package/dist/src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
- package/dist/src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
- package/dist/src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js +96 -0
- package/dist/src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
- package/dist/src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
- package/dist/src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
- package/dist/src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.js +122 -0
- package/dist/src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
- package/dist/src/__generated__/default_templates/index.d.ts +2 -0
- package/dist/src/__generated__/default_templates/index.d.ts.map +1 -1
- package/dist/src/__generated__/default_templates/index.js +5 -1
- package/dist/src/__generated__/default_templates/index.js.map +1 -1
- package/dist/src/llm/createCompletenessEvaluator.d.ts +46 -0
- package/dist/src/llm/createCompletenessEvaluator.d.ts.map +1 -0
- package/dist/src/llm/createCompletenessEvaluator.js +49 -0
- package/dist/src/llm/createCompletenessEvaluator.js.map +1 -0
- package/dist/src/llm/createDocumentRelevanceEvaluator.d.ts +16 -11
- package/dist/src/llm/createDocumentRelevanceEvaluator.d.ts.map +1 -1
- package/dist/src/llm/createDocumentRelevanceEvaluator.js +7 -11
- package/dist/src/llm/createDocumentRelevanceEvaluator.js.map +1 -1
- package/dist/src/llm/createPiiDetectionEvaluator.d.ts +46 -0
- package/dist/src/llm/createPiiDetectionEvaluator.d.ts.map +1 -0
- package/dist/src/llm/createPiiDetectionEvaluator.js +50 -0
- package/dist/src/llm/createPiiDetectionEvaluator.js.map +1 -0
- package/dist/src/llm/createRetrievalRelevanceEvaluator.d.ts +4 -5
- package/dist/src/llm/createRetrievalRelevanceEvaluator.d.ts.map +1 -1
- package/dist/src/llm/createRetrievalRelevanceEvaluator.js +4 -5
- package/dist/src/llm/createRetrievalRelevanceEvaluator.js.map +1 -1
- package/dist/src/llm/index.d.ts +2 -0
- package/dist/src/llm/index.d.ts.map +1 -1
- package/dist/src/llm/index.js +2 -0
- package/dist/src/llm/index.js.map +1 -1
- package/dist/src/utils/bindEvaluator.d.ts +4 -5
- package/dist/src/utils/bindEvaluator.d.ts.map +1 -1
- package/dist/src/utils/bindEvaluator.js +4 -5
- package/dist/src/utils/bindEvaluator.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/docs/llm-evaluators.mdx +1 -1
- package/package.json +12 -12
- package/src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.ts +95 -0
- package/src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.ts +121 -0
- package/src/__generated__/default_templates/index.ts +2 -0
- package/src/llm/createCompletenessEvaluator.ts +74 -0
- package/src/llm/createDocumentRelevanceEvaluator.ts +16 -11
- package/src/llm/createPiiDetectionEvaluator.ts +74 -0
- package/src/llm/createRetrievalRelevanceEvaluator.ts +4 -5
- package/src/llm/index.ts +2 -0
- package/src/utils/bindEvaluator.ts +4 -5
|
@@ -202,14 +202,13 @@ export type BindingContext<RecordType extends Record<string, unknown>> = {
|
|
|
202
202
|
* }
|
|
203
203
|
* );
|
|
204
204
|
*
|
|
205
|
-
* //
|
|
205
|
+
* // Retrieval relevance evaluator
|
|
206
206
|
* const relevancyEvaluator = bindEvaluator<EvaluationData>(
|
|
207
|
-
*
|
|
207
|
+
* createRetrievalRelevanceEvaluator<EvaluationData>({ model: openai("gpt-4") }),
|
|
208
208
|
* {
|
|
209
209
|
* inputMapping: {
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* output: "modelOutput",
|
|
210
|
+
* input: "userQuery",
|
|
211
|
+
* context: "systemContext",
|
|
213
212
|
* },
|
|
214
213
|
* }
|
|
215
214
|
* );
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bindEvaluator.d.ts","sourceRoot":"","sources":["../../../src/utils/bindEvaluator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACvE;;;;;;;;;;;;OAYG;IACH,YAAY,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CACzC,CAAC;AAEF
|
|
1
|
+
{"version":3,"file":"bindEvaluator.d.ts","sourceRoot":"","sources":["../../../src/utils/bindEvaluator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACvE;;;;;;;;;;;;OAYG;IACH,YAAY,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyJG;AACH,wBAAgB,aAAa,CAAC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACtE,SAAS,EAAE,aAAa,CAAC,UAAU,CAAC,EACpC,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,GAClC,aAAa,CAAC,UAAU,CAAC,CAM3B"}
|
|
@@ -140,14 +140,13 @@
|
|
|
140
140
|
* }
|
|
141
141
|
* );
|
|
142
142
|
*
|
|
143
|
-
* //
|
|
143
|
+
* // Retrieval relevance evaluator
|
|
144
144
|
* const relevancyEvaluator = bindEvaluator<EvaluationData>(
|
|
145
|
-
*
|
|
145
|
+
* createRetrievalRelevanceEvaluator<EvaluationData>({ model: openai("gpt-4") }),
|
|
146
146
|
* {
|
|
147
147
|
* inputMapping: {
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* output: "modelOutput",
|
|
148
|
+
* input: "userQuery",
|
|
149
|
+
* context: "systemContext",
|
|
151
150
|
* },
|
|
152
151
|
* }
|
|
153
152
|
* );
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bindEvaluator.js","sourceRoot":"","sources":["../../../src/utils/bindEvaluator.ts"],"names":[],"mappings":"AAgEA
|
|
1
|
+
{"version":3,"file":"bindEvaluator.js","sourceRoot":"","sources":["../../../src/utils/bindEvaluator.ts"],"names":[],"mappings":"AAgEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyJG;AACH,MAAM,UAAU,aAAa,CAC3B,SAAoC,EACpC,OAAmC;IAEnC,IAAI,cAAc,GAA8B,SAAS,CAAC;IAC1D,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,cAAc,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.d.ts","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAE9D,eAAO,MAAM,4CAA4C,EAAE,6BA0F1D,CAAC"}
|
package/dist/src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file is generated. Do not edit by hand.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG = void 0;
|
|
5
|
+
exports.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG = {
|
|
6
|
+
name: "completeness",
|
|
7
|
+
description: "Assess whether every active user request in a conversation was actually completed. Enumerates every user-expressed request, classifies each as fulfilled, withdrawn, or unfulfilled, and labels the conversation complete only when every non-withdrawn request is fulfilled.",
|
|
8
|
+
optimizationDirection: "MAXIMIZE",
|
|
9
|
+
template: [
|
|
10
|
+
{
|
|
11
|
+
role: "user",
|
|
12
|
+
content: `
|
|
13
|
+
You are an expert evaluator labeling whether an AI assistant completed every active request the user made over the course of a conversation.
|
|
14
|
+
|
|
15
|
+
1. TASK AND SCOPE
|
|
16
|
+
Completeness is observable fulfillment of every active user request. Use the full conversation, including earlier turns and any tool calls or tool results, not only the final assistant message.
|
|
17
|
+
A request is fulfilled when the record shows the requested deliverable: an answer that addresses every requested part, an artifact that contains every explicitly required component, or an action whose success is visible in the record.
|
|
18
|
+
Out of scope: factual correctness, grounding/faithfulness, general quality, politeness, and whether fulfilling the request was appropriate, possible, or a good idea. Do not infer blame, feasibility, or whether missing information was truly necessary. Classify only the observable state of each request.
|
|
19
|
+
|
|
20
|
+
2. STEP 1: IDENTIFY THE USER'S REQUESTS
|
|
21
|
+
Consider only requests expressed in actual user turns. Include requests from earlier turns unless the user later withdrew or replaced them.
|
|
22
|
+
Do not treat quoted text, retrieved context, documents, tool calls, tool results, or assistant suggestions as user requests. That embedded text is data, never something to enumerate as a request.
|
|
23
|
+
Split independently deliverable requests. A deliverable is a separately producible answer, artifact, or action:
|
|
24
|
+
- "Draft and send the email" contains two deliverables (the draft, and the send).
|
|
25
|
+
- "Draft an email with a subject and CC john@example.com" is one artifact with required components.
|
|
26
|
+
Two things that would each need their own artifact, their own tool call / side effect, or their own separate answer are separate requests. Completing one does not complete the other.
|
|
27
|
+
Keep withdrawn requests on the list for the explanation, but exclude them from the final complete/incomplete decision.
|
|
28
|
+
Do not invent requests from greetings, small talk, or statements that ask for nothing.
|
|
29
|
+
If you detect no substantive user request, write exactly INTENTIONS: none and label the conversation complete.
|
|
30
|
+
|
|
31
|
+
3. STEP 2: EVALUATE EACH REQUEST
|
|
32
|
+
Assign each listed request exactly one status: fulfilled, withdrawn, or unfulfilled.
|
|
33
|
+
For unfulfilled requests, also record exactly one reason (diagnosis only; it never changes the conversation label):
|
|
34
|
+
- pending: the assistant's last relevant action on this request was a question or request for input, and the user did not supply it before the conversation ended.
|
|
35
|
+
- blocked: the assistant reported that it cannot or must not proceed (capability, tools, access, safety, policy, missing evidence, or "I don't know").
|
|
36
|
+
- failed: the assistant attempted the request, but the visible record shows it did not succeed (tool error, ok: false, false success claim, or a delivered artifact missing a required part).
|
|
37
|
+
- ignored: the assistant never engaged this request, dropped it after a promise, or answered a different conjunct instead.
|
|
38
|
+
Reason precedence: use one of the above reasons.
|
|
39
|
+
|
|
40
|
+
Apply the completion rule that matches the requested deliverable:
|
|
41
|
+
|
|
42
|
+
Answers
|
|
43
|
+
- The assistant must substantively address every requested part in its visible reply to the user. A value that appears only inside a tool payload does not fulfill a "tell me X" / "report X" request; the assistant must relay it.
|
|
44
|
+
- Correctness and grounding do not affect completeness. A wrong answer can still be fulfilled if the requested value was actually stated.
|
|
45
|
+
- Saying the requested fact is absent, unknown, or not in the source/context is not an answer. Mark it unfulfilled (reason: blocked).
|
|
46
|
+
- A refusal or "I don't know" is likewise unfulfilled (reason: blocked).
|
|
47
|
+
|
|
48
|
+
Artifacts
|
|
49
|
+
- The assistant must deliver the requested artifact.
|
|
50
|
+
- The artifact must contain every component the user explicitly required.
|
|
51
|
+
- Do not judge general quality beyond those explicit requirements. A missing required component is unfulfilled (reason: failed).
|
|
52
|
+
|
|
53
|
+
Actions
|
|
54
|
+
- Use evidence specific to each requested action.
|
|
55
|
+
- If matching tool evidence is present, it overrides the assistant's claim: confirmed success is fulfilled; failure or missing confirmation is unfulfilled (reason: failed).
|
|
56
|
+
- If no matching tool evidence is present throughout the whole conversation, judge from the assistant's visible response.
|
|
57
|
+
- A promise, acknowledgment, clarifying question, or statement of intent is not completion.
|
|
58
|
+
|
|
59
|
+
Withdrawn requests
|
|
60
|
+
- Mark withdrawn when the user cancelled, replaced, or otherwise took the request off the table ("stop", "never mind", "don't do that", "I only need X instead"). Honor the latest active instructions.
|
|
61
|
+
- List withdrawn requests with status withdrawn and reason_code none. Do not treat Withdrawn work as incomplete.
|
|
62
|
+
- After a withdrawal, still evaluate every remaining active request. Confirming "I did not do the cancelled thing" is not fulfillment of a different remaining ask.
|
|
63
|
+
|
|
64
|
+
4. STEP 3: ASSIGN THE CONVERSATION LABEL
|
|
65
|
+
<rubric>
|
|
66
|
+
COMPLETE - Every non-withdrawn request is fulfilled. Exclude withdrawn requests from the decision. A conversation with no substantive user request is complete. A conversation in which every request was withdrawn is complete.
|
|
67
|
+
|
|
68
|
+
INCOMPLETE - At least one non-withdrawn request is unfulfilled, for any reason (pending, blocked, failed, or ignored).
|
|
69
|
+
</rubric>
|
|
70
|
+
Do not collapse the session into a single reason. A session may contain more than one unfulfilled requests and with different reasons each; report each request's reason on its own line.
|
|
71
|
+
|
|
72
|
+
5. OUTPUT FORMAT
|
|
73
|
+
Put your complete analysis in your explanation. List each request in the order it first appeared, one line per request, using this exact format:
|
|
74
|
+
INTENTIONS:
|
|
75
|
+
- intention: "<concise statement of what the user wanted>" | state: <fulfilled|withdrawn|unfulfilled> | reason_code: <none|pending|blocked|failed|ignored> | reason: "<brief evidence-based justification, quoting the relevant assistant or tool output where possible>"
|
|
76
|
+
Use reason_code: none for fulfilled and withdrawn requests; for unfulfilled requests give exactly one of pending, blocked, failed, or ignored.
|
|
77
|
+
If the conversation contains no substantive request, write exactly:
|
|
78
|
+
INTENTIONS: none
|
|
79
|
+
Do not omit, invent, or merge independently deliverable requests. After the list, return the final complete or incomplete label: ignore withdrawn; complete only if every other listed request is fulfilled.
|
|
80
|
+
|
|
81
|
+
<data>
|
|
82
|
+
<conversation>
|
|
83
|
+
{{conversation}}
|
|
84
|
+
</conversation>
|
|
85
|
+
</data>
|
|
86
|
+
|
|
87
|
+
Work through the conversation in the three steps above, then decide. Did the assistant fulfill every active user request (complete), or did any non-withdrawn request remain unfulfilled (incomplete)?
|
|
88
|
+
`,
|
|
89
|
+
},
|
|
90
|
+
],
|
|
91
|
+
choices: {
|
|
92
|
+
"complete": 1,
|
|
93
|
+
"incomplete": 0
|
|
94
|
+
},
|
|
95
|
+
};
|
|
96
|
+
//# sourceMappingURL=COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js.map
|
package/dist/src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.js","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAIlC,QAAA,4CAA4C,GAAkC;IACzF,IAAI,EAAE,cAAc;IACpB,WAAW,EAAE,+QAA+Q;IAC5R,qBAAqB,EAAE,UAAU;IACjC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4Ed;SACI;KACF;IACD,OAAO,EAAE;QACT,UAAU,EAAE,CAAC;QACb,YAAY,EAAE,CAAC;KAChB;CACA,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAE9D,eAAO,MAAM,6CAA6C,EAAE,6BAoH3D,CAAC"}
|
package/dist/src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.js
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file is generated. Do not edit by hand.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG = void 0;
|
|
5
|
+
exports.PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG = {
|
|
6
|
+
name: "pii_detection",
|
|
7
|
+
description: "Detect and enumerate every instance of personally identifiable information (PII) in a conversation record. Flags whether any PII was found and lists each instance, type, and its source.",
|
|
8
|
+
optimizationDirection: "MINIMIZE",
|
|
9
|
+
template: [
|
|
10
|
+
{
|
|
11
|
+
role: "user",
|
|
12
|
+
content: `
|
|
13
|
+
You are an expert privacy analyst screening a conversation record for personally identifiable information (PII).
|
|
14
|
+
|
|
15
|
+
Screen the entire record as given — every section, turn, field, and value, in whatever form it arrives (plain text, JSON, role-tagged messages, or another structure). Hidden, internal, or structured content is still in scope. Tag every instance and record its source (see FINDINGS). Do not judge only the final assistant message.
|
|
16
|
+
|
|
17
|
+
<rubric>
|
|
18
|
+
PII_DETECTED - The record contains at least one instance of personal data that identifies, or that could reasonably be combined with other information in the record to identify a specific living individual. Tag every instance using the most specific category below:
|
|
19
|
+
|
|
20
|
+
Direct personal identifiers:
|
|
21
|
+
- person_name: a full or partial name that, alone or with context, identifies a specific individual
|
|
22
|
+
- username_or_handle: an online handle, social-media username, or account alias tied to a specific individual
|
|
23
|
+
- date_of_birth: a specific individual's birth date
|
|
24
|
+
- biometric_data: fingerprint, retina/iris scan, voiceprint, facial-recognition data, genetic/DNA data, or a physical description detailed enough to function as biometric identification
|
|
25
|
+
- signature_or_handwriting_reference
|
|
26
|
+
|
|
27
|
+
Contact & location:
|
|
28
|
+
- email_address
|
|
29
|
+
- phone_number
|
|
30
|
+
- physical_address: street address, apartment/unit number, or mailing address
|
|
31
|
+
- precise_geolocation: GPS coordinates or a location precise enough to pinpoint an individual (not just a city, region, or country)
|
|
32
|
+
|
|
33
|
+
Government & national identifiers:
|
|
34
|
+
- national_id_number: SSN, DNI, NIF, Aadhaar, national insurance number, or equivalent
|
|
35
|
+
- passport_number
|
|
36
|
+
- drivers_license_number
|
|
37
|
+
- visa_or_immigration_number
|
|
38
|
+
- tax_id_number
|
|
39
|
+
|
|
40
|
+
Financial:
|
|
41
|
+
- credit_or_debit_card_number
|
|
42
|
+
- bank_account_number: includes IBAN and routing+account combinations
|
|
43
|
+
- payment_credential: CVV, card PIN, or wire instructions tied to an individual
|
|
44
|
+
- financial_account_detail: balance, transaction history, or credit score tied to a named individual
|
|
45
|
+
|
|
46
|
+
Health (sensitive):
|
|
47
|
+
- medical_record_or_diagnosis
|
|
48
|
+
- health_insurance_id
|
|
49
|
+
- mental_health_information
|
|
50
|
+
- prescription_or_treatment_detail
|
|
51
|
+
|
|
52
|
+
Protected / special-category attributes:
|
|
53
|
+
- racial_or_ethnic_origin
|
|
54
|
+
- religious_belief
|
|
55
|
+
- political_opinion_or_affiliation
|
|
56
|
+
- sexual_orientation_or_gender_identity
|
|
57
|
+
- union_membership
|
|
58
|
+
- immigration_or_citizenship_status
|
|
59
|
+
- criminal_record_or_proceeding
|
|
60
|
+
|
|
61
|
+
Employment & education:
|
|
62
|
+
- employer_and_role: a given name or full name plus employer plus job title that identifies an individual. A last name is not required.
|
|
63
|
+
- salary_or_compensation
|
|
64
|
+
- education_record: school, enrollment, or grades tied to a named individual
|
|
65
|
+
- employee_or_student_id_number
|
|
66
|
+
|
|
67
|
+
Online & technical identifiers:
|
|
68
|
+
- ip_address
|
|
69
|
+
- device_or_hardware_id: MAC address, IMEI, or device serial number
|
|
70
|
+
- cookie_or_tracking_id
|
|
71
|
+
- personal_url: a URL that itself encodes identifying information (a personal profile page, a pre-authenticated link, a tracking token)
|
|
72
|
+
|
|
73
|
+
Credentials & secrets:
|
|
74
|
+
- password
|
|
75
|
+
- api_key_or_token
|
|
76
|
+
- private_key_or_certificate
|
|
77
|
+
- security_question_answer
|
|
78
|
+
|
|
79
|
+
Relationship & other identifiers:
|
|
80
|
+
- family_or_relationship_detail: identifying information about a person conveyed through their relationship to someone else (e.g. "his daughter, age 7, who attends Lincoln Elementary")
|
|
81
|
+
- vehicle_identifier: license plate or VIN
|
|
82
|
+
- other_unique_identifier: any other number, code, or label presented as uniquely identifying a specific individual that does not fit the categories above (a loyalty/membership ID, a case or docket number tied to a named party, etc.)
|
|
83
|
+
|
|
84
|
+
NO_PII_DETECTED - None of the categories above are present after applying the rules.
|
|
85
|
+
</rubric>
|
|
86
|
+
|
|
87
|
+
Apply these rules:
|
|
88
|
+
1. Detect by form and context, not by verifying real-world identity. Do not try to decide if a named person is real, public, or fictional. Tag data presented as identifying personal information unless a hard exception applies. Exceptions override form: a string that only looks like an SSN, email, or name is not PII when the surrounding text marks it as a sample, template, or redaction.
|
|
89
|
+
2. Placeholders, examples, and templates are not PII (hard exception), even when they have the shape of a real identifier. Do not tag if the surrounding text calls it an example, sample, template, placeholder, fake, dummy, illustrative, or "not a real number" (including "e.g."); if it is a conventional fill-in (Jane Doe, John Doe, 123-45-6789, 000-00-0000, 555-0100 / 555-01xx, user@example.com, names on example.com / test.com / example.org, "[NAME]", "<email>", "Lorem ipsum"); or if it is the labeled dummy in a form, docs, or API template (e.g. Name (Jane Doe), Email (user@example.com)).
|
|
90
|
+
3. Indirect and relational identifiers still count. A person can be identified without being named (e.g. "the CEO's daughter, who lives at 123 Main St"). Tag the identifying detail (here, physical_address) and note the relational context in the value.
|
|
91
|
+
4. Quasi-identifier combinations count. Several low-specificity attributes about the same individual (e.g. ZIP + date of birth + gender) can identify them together. Tag the combination as other_unique_identifier or the most specific applicable category, even if no single field would be tagged alone.
|
|
92
|
+
5. Role inboxes are not email_address (support@, info@, billing@, sales@, hello@, admin@, noreply@, and similar). A named employee's work email (john.smith@company.com) is PII. Other organization-, system-, product-, or assistant-level identifiers (server ID, SKU, assistant session ID) are not PII unless they identify a specific human. Business secrets (revenue, strategy) are out of scope unless tied to an identifiable individual.
|
|
93
|
+
6. Judge the text as it appears now. Partial or masked data is still PII if enough remains to re-identify someone (e.g. "card ending in 4477" with the cardholder's name). A fully replaced redaction token ("[REDACTED]", "[PERSON_1]", "***", "xxx") with nothing identifying left is not PII. Schema keys next to a redacted value (full_name, email, ssn) are not personal data. Do not infer that PII must have existed before redaction.
|
|
94
|
+
7. Public availability does not exempt PII. A byline, a public official's published office contact, or a quote attributed by name still counts. Redacting it is a downstream policy choice, not this evaluation.
|
|
95
|
+
8. Use surrounding context for lookalikes (a 9-digit number may be a national ID or an invoice; a capitalized word may be a person or a product). Resolve pronouns and references across turns: if "she" refers to a person named earlier and a later turn adds a new identifying detail, tag that detail where it appears.
|
|
96
|
+
9. Group statistics are not PII ("60% of employees are over 40"). A statistic that effectively singles out one member of a small group is identifying (e.g. "the only employee over 65 got a raise" in a company of 20).
|
|
97
|
+
10. Hypothetical or instructional discussion of PII formats, with no actual instance of someone's data, is not PII. Do not tag format patterns used to explain a category.
|
|
98
|
+
11. Ignore writing quality, verbosity, formatting, and whether the conversation is on-topic. This evaluation only concerns the presence of PII. Generic public facts that do not narrow to an individual (a city, a country, a common first name used generically, a general date) are not PII.
|
|
99
|
+
|
|
100
|
+
Put your analysis in the explanation. List every instance in order of appearance:
|
|
101
|
+
FINDINGS:
|
|
102
|
+
- type: <category_from_rubric> | source: <user_message|assistant_response|tool_call_or_result|system_instructions|retrieved_document>
|
|
103
|
+
If you find nothing, write exactly:
|
|
104
|
+
FINDINGS: none
|
|
105
|
+
Do not omit, summarize, or shorten the list.
|
|
106
|
+
|
|
107
|
+
<data>
|
|
108
|
+
<conversation>
|
|
109
|
+
{{conversation}}
|
|
110
|
+
</conversation>
|
|
111
|
+
</data>
|
|
112
|
+
|
|
113
|
+
Check the record against the rubric and rules, list every finding with its source, then decide: pii_detected or no_pii_detected.
|
|
114
|
+
`,
|
|
115
|
+
},
|
|
116
|
+
],
|
|
117
|
+
choices: {
|
|
118
|
+
"pii_detected": 1,
|
|
119
|
+
"no_pii_detected": 0
|
|
120
|
+
},
|
|
121
|
+
};
|
|
122
|
+
//# sourceMappingURL=PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.js","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAIlC,QAAA,6CAA6C,GAAkC;IAC1F,IAAI,EAAE,eAAe;IACrB,WAAW,EAAE,2LAA2L;IACxM,qBAAqB,EAAE,UAAU;IACjC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsGd;SACI;KACF;IACD,OAAO,EAAE;QACT,cAAc,EAAE,CAAC;QACjB,iBAAiB,EAAE,CAAC;KACrB;CACA,CAAC"}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
export { COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG } from "./COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
1
2
|
export { CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG } from "./CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
2
3
|
export { CORRECTNESS_CLASSIFICATION_EVALUATOR_CONFIG } from "./CORRECTNESS_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
3
4
|
export { DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG } from "./DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
4
5
|
export { FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG } from "./FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
5
6
|
export { HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG } from "./HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
7
|
+
export { PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG } from "./PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
6
8
|
export { REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG } from "./REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
7
9
|
export { RETRIEVAL_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG } from "./RETRIEVAL_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
8
10
|
export { TOOL_INVOCATION_CLASSIFICATION_EVALUATOR_CONFIG } from "./TOOL_INVOCATION_CLASSIFICATION_EVALUATOR_CONFIG";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,kDAAkD,EAAE,MAAM,sDAAsD,CAAC;AAC1H,OAAO,EAAE,4CAA4C,EAAE,MAAM,gDAAgD,CAAC;AAC9G,OAAO,EAAE,6CAA6C,EAAE,MAAM,iDAAiD,CAAC;AAChH,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACpG,OAAO,EAAE,mDAAmD,EAAE,MAAM,uDAAuD,CAAC;AAC5H,OAAO,EAAE,+CAA+C,EAAE,MAAM,mDAAmD,CAAC;AACpH,OAAO,EAAE,sDAAsD,EAAE,MAAM,0DAA0D,CAAC;AAClI,OAAO,EAAE,8CAA8C,EAAE,MAAM,kDAAkD,CAAC;AAClH,OAAO,EAAE,wCAAwC,EAAE,MAAM,4CAA4C,CAAC;AACtG,OAAO,EAAE,6CAA6C,EAAE,MAAM,iDAAiD,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4CAA4C,EAAE,MAAM,gDAAgD,CAAC;AAC9G,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,kDAAkD,EAAE,MAAM,sDAAsD,CAAC;AAC1H,OAAO,EAAE,4CAA4C,EAAE,MAAM,gDAAgD,CAAC;AAC9G,OAAO,EAAE,6CAA6C,EAAE,MAAM,iDAAiD,CAAC;AAChH,OAAO,EAAE,6CAA6C,EAAE,MAAM,iDAAiD,CAAC;AAChH,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACpG,OAAO,EAAE,mDAAmD,EAAE,MAAM,uDAAuD,CAAC;AAC5H,OAAO,EAAE,+CAA+C,EAAE,MAAM,mDAAmD,CAAC;AACpH,OAAO,EAAE,sDAAsD,EAAE,MAAM,0DAA0D,CAAC;AAClI,OAAO,EAAE,8CAA8C,EAAE,MAAM,kDAAkD,CAAC;AAClH,OAAO,EAAE,wCAAwC,EAAE,MAAM,4CAA4C,CAAC;AACtG,OAAO,EAAE,6CAA6C,EAAE,MAAM,iDAAiD,CAAC"}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file is generated. Do not edit by hand.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.USER_FRICTION_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOXICITY_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOOL_SELECTION_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOOL_RESPONSE_HANDLING_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOOL_INVOCATION_CLASSIFICATION_EVALUATOR_CONFIG = exports.RETRIEVAL_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG = exports.REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG = exports.HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG = exports.FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG = exports.DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG = exports.CORRECTNESS_CLASSIFICATION_EVALUATOR_CONFIG = exports.CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG = void 0;
|
|
4
|
+
exports.USER_FRICTION_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOXICITY_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOOL_SELECTION_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOOL_RESPONSE_HANDLING_CLASSIFICATION_EVALUATOR_CONFIG = exports.TOOL_INVOCATION_CLASSIFICATION_EVALUATOR_CONFIG = exports.RETRIEVAL_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG = exports.REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG = exports.PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG = exports.HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG = exports.FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG = exports.DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG = exports.CORRECTNESS_CLASSIFICATION_EVALUATOR_CONFIG = exports.CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG = exports.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG = void 0;
|
|
5
|
+
var COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG");
|
|
6
|
+
Object.defineProperty(exports, "COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG", { enumerable: true, get: function () { return COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG_1.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG; } });
|
|
5
7
|
var CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG");
|
|
6
8
|
Object.defineProperty(exports, "CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG", { enumerable: true, get: function () { return CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG_1.CONCISENESS_CLASSIFICATION_EVALUATOR_CONFIG; } });
|
|
7
9
|
var CORRECTNESS_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./CORRECTNESS_CLASSIFICATION_EVALUATOR_CONFIG");
|
|
@@ -12,6 +14,8 @@ var FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./FAITHFULNESS_CLA
|
|
|
12
14
|
Object.defineProperty(exports, "FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG", { enumerable: true, get: function () { return FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG_1.FAITHFULNESS_CLASSIFICATION_EVALUATOR_CONFIG; } });
|
|
13
15
|
var HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG");
|
|
14
16
|
Object.defineProperty(exports, "HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG", { enumerable: true, get: function () { return HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG_1.HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG; } });
|
|
17
|
+
var PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG");
|
|
18
|
+
Object.defineProperty(exports, "PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG", { enumerable: true, get: function () { return PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG_1.PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG; } });
|
|
15
19
|
var REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG");
|
|
16
20
|
Object.defineProperty(exports, "REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG", { enumerable: true, get: function () { return REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG_1.REFUSAL_CLASSIFICATION_EVALUATOR_CONFIG; } });
|
|
17
21
|
var RETRIEVAL_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG_1 = require("./RETRIEVAL_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/index.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAE/C,6GAA4G;AAAnG,0KAAA,2CAA2C,OAAA;AACpD,6GAA4G;AAAnG,0KAAA,2CAA2C,OAAA;AACpD,2HAA0H;AAAjH,wLAAA,kDAAkD,OAAA;AAC3D,+GAA8G;AAArG,4KAAA,4CAA4C,OAAA;AACrD,iHAAgH;AAAvG,8KAAA,6CAA6C,OAAA;AACtD,qGAAoG;AAA3F,kKAAA,uCAAuC,OAAA;AAChD,6HAA4H;AAAnH,0LAAA,mDAAmD,OAAA;AAC5D,qHAAoH;AAA3G,kLAAA,+CAA+C,OAAA;AACxD,mIAAkI;AAAzH,gMAAA,sDAAsD,OAAA;AAC/D,mHAAkH;AAAzG,gLAAA,8CAA8C,OAAA;AACvD,uGAAsG;AAA7F,oKAAA,wCAAwC,OAAA;AACjD,iHAAgH;AAAvG,8KAAA,6CAA6C,OAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/index.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAE/C,+GAA8G;AAArG,4KAAA,4CAA4C,OAAA;AACrD,6GAA4G;AAAnG,0KAAA,2CAA2C,OAAA;AACpD,6GAA4G;AAAnG,0KAAA,2CAA2C,OAAA;AACpD,2HAA0H;AAAjH,wLAAA,kDAAkD,OAAA;AAC3D,+GAA8G;AAArG,4KAAA,4CAA4C,OAAA;AACrD,iHAAgH;AAAvG,8KAAA,6CAA6C,OAAA;AACtD,iHAAgH;AAAvG,8KAAA,6CAA6C,OAAA;AACtD,qGAAoG;AAA3F,kKAAA,uCAAuC,OAAA;AAChD,6HAA4H;AAAnH,0LAAA,mDAAmD,OAAA;AAC5D,qHAAoH;AAA3G,kLAAA,+CAA+C,OAAA;AACxD,mIAAkI;AAAzH,gMAAA,sDAAsD,OAAA;AAC/D,mHAAkH;AAAzG,gLAAA,8CAA8C,OAAA;AACvD,uGAAsG;AAA7F,oKAAA,wCAAwC,OAAA;AACjD,iHAAgH;AAAvG,8KAAA,6CAA6C,OAAA"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { CreateClassificationEvaluatorArgs } from "../types/evals";
|
|
2
|
+
import type { ClassificationEvaluator } from "./ClassificationEvaluator";
|
|
3
|
+
export interface CompletenessEvaluatorArgs<RecordType extends Record<string, unknown> = CompletenessEvaluationRecord> extends Omit<CreateClassificationEvaluatorArgs<RecordType>, "promptTemplate" | "choices" | "optimizationDirection" | "name"> {
|
|
4
|
+
optimizationDirection?: CreateClassificationEvaluatorArgs<RecordType>["optimizationDirection"];
|
|
5
|
+
name?: CreateClassificationEvaluatorArgs<RecordType>["name"];
|
|
6
|
+
choices?: CreateClassificationEvaluatorArgs<RecordType>["choices"];
|
|
7
|
+
promptTemplate?: CreateClassificationEvaluatorArgs<RecordType>["promptTemplate"];
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* A conversation record to judge for completed user requests.
|
|
11
|
+
*/
|
|
12
|
+
export type CompletenessEvaluationRecord = {
|
|
13
|
+
/**
|
|
14
|
+
* The full conversation, including turns, tool calls, and tool results.
|
|
15
|
+
* Include tools for agent traces so action success can be verified.
|
|
16
|
+
*/
|
|
17
|
+
conversation: string;
|
|
18
|
+
[key: string]: unknown;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Creates a completeness evaluator.
|
|
22
|
+
*
|
|
23
|
+
* This function returns an evaluator that checks whether every active user
|
|
24
|
+
* request in a conversation was actually completed, not merely acknowledged.
|
|
25
|
+
*
|
|
26
|
+
* @param args - The arguments for creating the completeness evaluator.
|
|
27
|
+
* @param args.model - The model to use for classification.
|
|
28
|
+
* @param args.choices - The possible classification choices (defaults to complete/incomplete).
|
|
29
|
+
* @param args.promptTemplate - The prompt template to use (defaults to COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.template).
|
|
30
|
+
* @param args.telemetry - The telemetry to use for the evaluator.
|
|
31
|
+
*
|
|
32
|
+
* @returns An evaluator function that takes a {@link CompletenessEvaluationRecord} and returns a classification result
|
|
33
|
+
* indicating whether the conversation is `complete` or `incomplete`.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const evaluator = createCompletenessEvaluator({ model: openai("gpt-4o-mini") });
|
|
38
|
+
* const result = await evaluator.evaluate({
|
|
39
|
+
* conversation:
|
|
40
|
+
* "User: Reset my password and update the billing address.\nAssistant: Your password has been reset.",
|
|
41
|
+
* });
|
|
42
|
+
* console.log(result.label); // "incomplete"
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
export declare function createCompletenessEvaluator<RecordType extends Record<string, unknown> = CompletenessEvaluationRecord>(args: CompletenessEvaluatorArgs<RecordType>): ClassificationEvaluator<RecordType>;
|
|
46
|
+
//# sourceMappingURL=createCompletenessEvaluator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createCompletenessEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createCompletenessEvaluator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGzE,MAAM,WAAW,yBAAyB,CACxC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,4BAA4B,CACzE,SAAQ,IAAI,CACZ,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,4BAA4B,EAEzE,IAAI,EAAE,yBAAyB,CAAC,UAAU,CAAC,GAC1C,uBAAuB,CAAC,UAAU,CAAC,CAerC"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
3
|
+
var t = {};
|
|
4
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
5
|
+
t[p] = s[p];
|
|
6
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
7
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
8
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
9
|
+
t[p[i]] = s[p[i]];
|
|
10
|
+
}
|
|
11
|
+
return t;
|
|
12
|
+
};
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.createCompletenessEvaluator = createCompletenessEvaluator;
|
|
15
|
+
const default_templates_1 = require("../__generated__/default_templates");
|
|
16
|
+
const createClassificationEvaluator_1 = require("./createClassificationEvaluator");
|
|
17
|
+
/**
|
|
18
|
+
* Creates a completeness evaluator.
|
|
19
|
+
*
|
|
20
|
+
* This function returns an evaluator that checks whether every active user
|
|
21
|
+
* request in a conversation was actually completed, not merely acknowledged.
|
|
22
|
+
*
|
|
23
|
+
* @param args - The arguments for creating the completeness evaluator.
|
|
24
|
+
* @param args.model - The model to use for classification.
|
|
25
|
+
* @param args.choices - The possible classification choices (defaults to complete/incomplete).
|
|
26
|
+
* @param args.promptTemplate - The prompt template to use (defaults to COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.template).
|
|
27
|
+
* @param args.telemetry - The telemetry to use for the evaluator.
|
|
28
|
+
*
|
|
29
|
+
* @returns An evaluator function that takes a {@link CompletenessEvaluationRecord} and returns a classification result
|
|
30
|
+
* indicating whether the conversation is `complete` or `incomplete`.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const evaluator = createCompletenessEvaluator({ model: openai("gpt-4o-mini") });
|
|
35
|
+
* const result = await evaluator.evaluate({
|
|
36
|
+
* conversation:
|
|
37
|
+
* "User: Reset my password and update the billing address.\nAssistant: Your password has been reset.",
|
|
38
|
+
* });
|
|
39
|
+
* console.log(result.label); // "incomplete"
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
function createCompletenessEvaluator(args) {
|
|
43
|
+
const { choices = default_templates_1.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.choices, promptTemplate = default_templates_1.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.template, optimizationDirection = default_templates_1.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.optimizationDirection, name = default_templates_1.COMPLETENESS_CLASSIFICATION_EVALUATOR_CONFIG.name } = args, rest = __rest(args, ["choices", "promptTemplate", "optimizationDirection", "name"]);
|
|
44
|
+
return (0, createClassificationEvaluator_1.createClassificationEvaluator)(Object.assign(Object.assign({}, rest), { promptTemplate,
|
|
45
|
+
choices,
|
|
46
|
+
optimizationDirection,
|
|
47
|
+
name }));
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=createCompletenessEvaluator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createCompletenessEvaluator.js","sourceRoot":"","sources":["../../../src/llm/createCompletenessEvaluator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0EAAkG;AAGlG,mFAAgF;AA0BhF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qCAGE,IAA2C;IAE3C,MAAM,EACJ,OAAO,GAAG,gEAA4C,CAAC,OAAO,EAC9D,cAAc,GAAG,gEAA4C,CAAC,QAAQ,EACtE,qBAAqB,GAAG,gEAA4C,CAAC,qBAAqB,EAC1F,IAAI,GAAG,gEAA4C,CAAC,IAAI,KAEtD,IAAI,EADH,IAAI,UACL,IAAI,EANF,8DAML,CAAO,CAAC;IACT,OAAO,IAAA,6DAA6B,kCAC/B,IAAI,KACP,cAAc;QACd,OAAO;QACP,qBAAqB;QACrB,IAAI,IACJ,CAAC;AACL,CAAC"}
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
import type { CreateClassificationEvaluatorArgs } from "../types/evals";
|
|
2
2
|
import type { ClassificationEvaluator } from "./ClassificationEvaluator";
|
|
3
|
+
/**
|
|
4
|
+
* Arguments for the document relevance evaluator.
|
|
5
|
+
*
|
|
6
|
+
* @deprecated Use {@link RetrievalRelevanceEvaluatorArgs} instead. This type will be
|
|
7
|
+
* removed in the next major release.
|
|
8
|
+
*/
|
|
3
9
|
export interface DocumentRelevanceEvaluatorArgs<RecordType extends Record<string, unknown> = DocumentRelevanceEvaluationRecord> extends Omit<CreateClassificationEvaluatorArgs<RecordType>, "promptTemplate" | "choices" | "optimizationDirection" | "name"> {
|
|
4
10
|
optimizationDirection?: CreateClassificationEvaluatorArgs<RecordType>["optimizationDirection"];
|
|
5
11
|
name?: CreateClassificationEvaluatorArgs<RecordType>["name"];
|
|
@@ -8,6 +14,9 @@ export interface DocumentRelevanceEvaluatorArgs<RecordType extends Record<string
|
|
|
8
14
|
}
|
|
9
15
|
/**
|
|
10
16
|
* A record to be evaluated by the document relevance evaluator.
|
|
17
|
+
*
|
|
18
|
+
* @deprecated Use {@link RetrievalRelevanceEvaluationRecord} instead. Rename
|
|
19
|
+
* `documentText` to `context`. This type will be removed in the next major release.
|
|
11
20
|
*/
|
|
12
21
|
export interface DocumentRelevanceEvaluationRecord {
|
|
13
22
|
input: string;
|
|
@@ -17,6 +26,12 @@ export interface DocumentRelevanceEvaluationRecord {
|
|
|
17
26
|
/**
|
|
18
27
|
* Creates a document relevance evaluator function.
|
|
19
28
|
*
|
|
29
|
+
* @deprecated Use {@link createRetrievalRelevanceEvaluator} instead. Rename the
|
|
30
|
+
* `documentText` input field to `context`, and update code that checks for the
|
|
31
|
+
* `unrelated` label to check for `irrelevant`. Pass one document as `context` to
|
|
32
|
+
* preserve per-document evaluation. This function will be removed in the next major
|
|
33
|
+
* release.
|
|
34
|
+
*
|
|
20
35
|
* This function returns an evaluator that determines whether a given document text
|
|
21
36
|
* is relevant to a provided input question. The evaluator uses a classification model
|
|
22
37
|
* and a prompt template to make its determination.
|
|
@@ -27,18 +42,8 @@ export interface DocumentRelevanceEvaluationRecord {
|
|
|
27
42
|
* @param args.promptTemplate - The prompt template to use (defaults to DOCUMENT_RELEVANCE_TEMPLATE).
|
|
28
43
|
* @param args.telemetry - The telemetry to use for the evaluator.
|
|
29
44
|
*
|
|
30
|
-
* @returns An evaluator function that takes a {@link
|
|
45
|
+
* @returns An evaluator function that takes a {@link DocumentRelevanceEvaluationRecord} and returns a classification result
|
|
31
46
|
* indicating whether the document is relevant to the input question.
|
|
32
|
-
*
|
|
33
|
-
* @example
|
|
34
|
-
* ```ts
|
|
35
|
-
* const evaluator = createDocumentRelevanceEvaluator({ model: openai("gpt-4o-mini") });
|
|
36
|
-
* const result = await evaluator.evaluate({
|
|
37
|
-
* input: "What is the capital of France?",
|
|
38
|
-
* documentText: "Paris is the capital and most populous city of France.",
|
|
39
|
-
* });
|
|
40
|
-
* console.log(result.label); // "relevant" or "unrelated"
|
|
41
|
-
* ```
|
|
42
47
|
*/
|
|
43
48
|
export declare function createDocumentRelevanceEvaluator<RecordType extends Record<string, unknown> = DocumentRelevanceEvaluationRecord>(args: DocumentRelevanceEvaluatorArgs<RecordType>): ClassificationEvaluator<RecordType>;
|
|
44
49
|
//# sourceMappingURL=createDocumentRelevanceEvaluator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createDocumentRelevanceEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createDocumentRelevanceEvaluator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGzE,MAAM,WAAW,8BAA8B,CAC7C,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxC,iCAAiC,CACnC,SAAQ,IAAI,CACZ,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED
|
|
1
|
+
{"version":3,"file":"createDocumentRelevanceEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createDocumentRelevanceEvaluator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGzE;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B,CAC7C,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxC,iCAAiC,CACnC,SAAQ,IAAI,CACZ,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxC,iCAAiC,EAEnC,IAAI,EAAE,8BAA8B,CAAC,UAAU,CAAC,GAC/C,uBAAuB,CAAC,UAAU,CAAC,CAerC"}
|
|
@@ -17,6 +17,12 @@ const createClassificationEvaluator_1 = require("./createClassificationEvaluator
|
|
|
17
17
|
/**
|
|
18
18
|
* Creates a document relevance evaluator function.
|
|
19
19
|
*
|
|
20
|
+
* @deprecated Use {@link createRetrievalRelevanceEvaluator} instead. Rename the
|
|
21
|
+
* `documentText` input field to `context`, and update code that checks for the
|
|
22
|
+
* `unrelated` label to check for `irrelevant`. Pass one document as `context` to
|
|
23
|
+
* preserve per-document evaluation. This function will be removed in the next major
|
|
24
|
+
* release.
|
|
25
|
+
*
|
|
20
26
|
* This function returns an evaluator that determines whether a given document text
|
|
21
27
|
* is relevant to a provided input question. The evaluator uses a classification model
|
|
22
28
|
* and a prompt template to make its determination.
|
|
@@ -27,18 +33,8 @@ const createClassificationEvaluator_1 = require("./createClassificationEvaluator
|
|
|
27
33
|
* @param args.promptTemplate - The prompt template to use (defaults to DOCUMENT_RELEVANCE_TEMPLATE).
|
|
28
34
|
* @param args.telemetry - The telemetry to use for the evaluator.
|
|
29
35
|
*
|
|
30
|
-
* @returns An evaluator function that takes a {@link
|
|
36
|
+
* @returns An evaluator function that takes a {@link DocumentRelevanceEvaluationRecord} and returns a classification result
|
|
31
37
|
* indicating whether the document is relevant to the input question.
|
|
32
|
-
*
|
|
33
|
-
* @example
|
|
34
|
-
* ```ts
|
|
35
|
-
* const evaluator = createDocumentRelevanceEvaluator({ model: openai("gpt-4o-mini") });
|
|
36
|
-
* const result = await evaluator.evaluate({
|
|
37
|
-
* input: "What is the capital of France?",
|
|
38
|
-
* documentText: "Paris is the capital and most populous city of France.",
|
|
39
|
-
* });
|
|
40
|
-
* console.log(result.label); // "relevant" or "unrelated"
|
|
41
|
-
* ```
|
|
42
38
|
*/
|
|
43
39
|
function createDocumentRelevanceEvaluator(args) {
|
|
44
40
|
const { choices = default_templates_1.DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.choices, promptTemplate = default_templates_1.DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.template, optimizationDirection = default_templates_1.DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.optimizationDirection, name = default_templates_1.DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.name } = args, rest = __rest(args, ["choices", "promptTemplate", "optimizationDirection", "name"]);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createDocumentRelevanceEvaluator.js","sourceRoot":"","sources":["../../../src/llm/createDocumentRelevanceEvaluator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0EAAwG;AAGxG,mFAAgF;
|
|
1
|
+
{"version":3,"file":"createDocumentRelevanceEvaluator.js","sourceRoot":"","sources":["../../../src/llm/createDocumentRelevanceEvaluator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0EAAwG;AAGxG,mFAAgF;AAiChF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,0CAIE,IAAgD;IAEhD,MAAM,EACJ,OAAO,GAAG,sEAAkD,CAAC,OAAO,EACpE,cAAc,GAAG,sEAAkD,CAAC,QAAQ,EAC5E,qBAAqB,GAAG,sEAAkD,CAAC,qBAAqB,EAChG,IAAI,GAAG,sEAAkD,CAAC,IAAI,KAE5D,IAAI,EADH,IAAI,UACL,IAAI,EANF,8DAML,CAAO,CAAC;IACT,OAAO,IAAA,6DAA6B,kCAC/B,IAAI,KACP,cAAc;QACd,OAAO;QACP,qBAAqB;QACrB,IAAI,IACJ,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { CreateClassificationEvaluatorArgs } from "../types/evals";
|
|
2
|
+
import type { ClassificationEvaluator } from "./ClassificationEvaluator";
|
|
3
|
+
export interface PiiDetectionEvaluatorArgs<RecordType extends Record<string, unknown> = PiiDetectionEvaluationRecord> extends Omit<CreateClassificationEvaluatorArgs<RecordType>, "promptTemplate" | "choices" | "optimizationDirection" | "name"> {
|
|
4
|
+
optimizationDirection?: CreateClassificationEvaluatorArgs<RecordType>["optimizationDirection"];
|
|
5
|
+
name?: CreateClassificationEvaluatorArgs<RecordType>["name"];
|
|
6
|
+
choices?: CreateClassificationEvaluatorArgs<RecordType>["choices"];
|
|
7
|
+
promptTemplate?: CreateClassificationEvaluatorArgs<RecordType>["promptTemplate"];
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* A conversation record to be screened for personally identifiable information.
|
|
11
|
+
*/
|
|
12
|
+
export type PiiDetectionEvaluationRecord = {
|
|
13
|
+
/**
|
|
14
|
+
* The full conversation record, including system instructions, turns,
|
|
15
|
+
* tool calls, and retrieved content.
|
|
16
|
+
*/
|
|
17
|
+
conversation: string;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Creates a PII detection evaluator.
|
|
21
|
+
*
|
|
22
|
+
* This function returns an evaluator that screens a conversation record for
|
|
23
|
+
* personally identifiable information, including content in tool calls,
|
|
24
|
+
* tool results, and retrieved documents the end user may never have seen.
|
|
25
|
+
*
|
|
26
|
+
* @param args - The arguments for creating the PII detection evaluator.
|
|
27
|
+
* @param args.model - The model to use for classification.
|
|
28
|
+
* @param args.choices - The possible classification choices (defaults to pii_detected/no_pii_detected).
|
|
29
|
+
* @param args.promptTemplate - The prompt template to use (defaults to PII_DETECTION_CLASSIFICATION_EVALUATOR_CONFIG.template).
|
|
30
|
+
* @param args.telemetry - The telemetry to use for the evaluator.
|
|
31
|
+
*
|
|
32
|
+
* @returns An evaluator function that takes a {@link PiiDetectionEvaluationRecord} and returns a classification result
|
|
33
|
+
* indicating whether the record contains PII (`pii_detected`) or not (`no_pii_detected`).
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const evaluator = createPiiDetectionEvaluator({ model: openai("gpt-4o-mini") });
|
|
38
|
+
* const result = await evaluator.evaluate({
|
|
39
|
+
* conversation:
|
|
40
|
+
* "User: Reset my account.\nAssistant: What email is on the account?\nUser: jane.doe@acme.com",
|
|
41
|
+
* });
|
|
42
|
+
* console.log(result.label); // "pii_detected"
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
export declare function createPiiDetectionEvaluator<RecordType extends Record<string, unknown> = PiiDetectionEvaluationRecord>(args: PiiDetectionEvaluatorArgs<RecordType>): ClassificationEvaluator<RecordType>;
|
|
46
|
+
//# sourceMappingURL=createPiiDetectionEvaluator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createPiiDetectionEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createPiiDetectionEvaluator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGzE,MAAM,WAAW,yBAAyB,CACxC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,4BAA4B,CACzE,SAAQ,IAAI,CACZ,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,4BAA4B,EAEzE,IAAI,EAAE,yBAAyB,CAAC,UAAU,CAAC,GAC1C,uBAAuB,CAAC,UAAU,CAAC,CAerC"}
|