@arizeai/phoenix-evals 0.6.2 → 0.6.5
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/README.md +1 -0
- package/dist/esm/helpers/createEvaluator.d.ts +7 -7
- package/dist/esm/helpers/createEvaluator.js +2 -2
- package/dist/esm/helpers/index.d.ts +2 -0
- package/dist/esm/helpers/index.d.ts.map +1 -1
- package/dist/esm/helpers/index.js +2 -0
- package/dist/esm/helpers/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/src/helpers/createEvaluator.d.ts +7 -7
- package/dist/src/helpers/createEvaluator.js +2 -2
- package/dist/src/helpers/index.d.ts +2 -0
- package/dist/src/helpers/index.d.ts.map +1 -1
- package/dist/src/helpers/index.js +2 -0
- package/dist/src/helpers/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +9 -1
- package/src/helpers/createEvaluator.ts +7 -7
- package/src/helpers/index.ts +2 -0
|
@@ -18,7 +18,7 @@ function generateUniqueName(): string {
|
|
|
18
18
|
}
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* Options for creating a custom evaluator using {@link
|
|
21
|
+
* Options for creating a custom evaluator using {@link createEvaluator}.
|
|
22
22
|
*
|
|
23
23
|
* @public
|
|
24
24
|
*/
|
|
@@ -31,7 +31,7 @@ export type CreateEvaluatorOptions = {
|
|
|
31
31
|
*
|
|
32
32
|
* @example
|
|
33
33
|
* ```typescript
|
|
34
|
-
* const evaluator =
|
|
34
|
+
* const evaluator = createEvaluator(myFunction, { name: "custom-metric" });
|
|
35
35
|
* ```
|
|
36
36
|
*/
|
|
37
37
|
name?: string;
|
|
@@ -45,7 +45,7 @@ export type CreateEvaluatorOptions = {
|
|
|
45
45
|
*
|
|
46
46
|
* @example
|
|
47
47
|
* ```typescript
|
|
48
|
-
* const evaluator =
|
|
48
|
+
* const evaluator = createEvaluator(myFunction, { kind: "CODE" });
|
|
49
49
|
* ```
|
|
50
50
|
*/
|
|
51
51
|
kind?: EvaluationKind;
|
|
@@ -59,7 +59,7 @@ export type CreateEvaluatorOptions = {
|
|
|
59
59
|
*
|
|
60
60
|
* @example
|
|
61
61
|
* ```typescript
|
|
62
|
-
* const evaluator =
|
|
62
|
+
* const evaluator = createEvaluator(myFunction, {
|
|
63
63
|
* optimizationDirection: "MAXIMIZE"
|
|
64
64
|
* });
|
|
65
65
|
* ```
|
|
@@ -76,7 +76,7 @@ export type CreateEvaluatorOptions = {
|
|
|
76
76
|
*
|
|
77
77
|
* @example
|
|
78
78
|
* ```typescript
|
|
79
|
-
* const evaluator =
|
|
79
|
+
* const evaluator = createEvaluator(myFunction, {
|
|
80
80
|
* telemetry: { isEnabled: true, tracer: myTracer }
|
|
81
81
|
* });
|
|
82
82
|
* ```
|
|
@@ -118,7 +118,7 @@ export type CreateEvaluatorOptions = {
|
|
|
118
118
|
* @example
|
|
119
119
|
* Basic usage with a simple scoring function:
|
|
120
120
|
* ```typescript
|
|
121
|
-
* const accuracyEvaluator =
|
|
121
|
+
* const accuracyEvaluator = createEvaluator(
|
|
122
122
|
* ({ output, expected }) => {
|
|
123
123
|
* return output === expected ? 1 : 0;
|
|
124
124
|
* },
|
|
@@ -140,7 +140,7 @@ export type CreateEvaluatorOptions = {
|
|
|
140
140
|
* @example
|
|
141
141
|
* Returning a full EvaluationResult:
|
|
142
142
|
* ```typescript
|
|
143
|
-
* const qualityEvaluator =
|
|
143
|
+
* const qualityEvaluator = createEvaluator(
|
|
144
144
|
* ({ output }) => {
|
|
145
145
|
* const score = calculateQuality(output);
|
|
146
146
|
* return {
|
package/src/helpers/index.ts
CHANGED