@arizeai/phoenix-evals 0.6.2 → 0.6.5

package/README.md

@@ -19,6 +19,7 @@
     <a href="https://arize-ai.github.io/phoenix/">
         <img src="https://img.shields.io/badge/docs-blue?logo=typescript&logoColor=white" alt="Documentation">
     </a>
+    <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=8e8e8b34-7900-43fa-a38f-1f070bd48c64&page=js/packages/phoenix-evals/README.md" />
 </p>
 
 This package provides a TypeScript evaluation library. It is vendor agnostic and can be used in isolation of any framework or platform. This package is still under active development and is subject to change.

package/dist/esm/helpers/createEvaluator.d.ts

@@ -2,7 +2,7 @@ import { EvaluatorBase } from "../core/EvaluatorBase.js";
 import { EvaluationKind, OptimizationDirection, TelemetryConfig } from "../types/index.js";
 type AnyFn = (...args: any[]) => any;
 /**
- * Options for creating a custom evaluator using {@link CreateEvaluator}.
+ * Options for creating a custom evaluator using {@link createEvaluator}.
  *
  * @public
  */
@@ -15,7 +15,7 @@ export type CreateEvaluatorOptions = {
      *
      * @example
      * ```typescript
-     * const evaluator = CreateEvaluator(myFunction, { name: "custom-metric" });
+     * const evaluator = createEvaluator(myFunction, { name: "custom-metric" });
      * ```
      */
     name?: string;
@@ -29,7 +29,7 @@ export type CreateEvaluatorOptions = {
      *
      * @example
      * ```typescript
-     * const evaluator = CreateEvaluator(myFunction, { kind: "CODE" });
+     * const evaluator = createEvaluator(myFunction, { kind: "CODE" });
      * ```
      */
     kind?: EvaluationKind;
@@ -43,7 +43,7 @@ export type CreateEvaluatorOptions = {
      *
      * @example
      * ```typescript
-     * const evaluator = CreateEvaluator(myFunction, {
+     * const evaluator = createEvaluator(myFunction, {
      *   optimizationDirection: "MAXIMIZE"
      * });
      * ```
@@ -60,7 +60,7 @@ export type CreateEvaluatorOptions = {
      *
      * @example
      * ```typescript
-     * const evaluator = CreateEvaluator(myFunction, {
+     * const evaluator = createEvaluator(myFunction, {
      *   telemetry: { isEnabled: true, tracer: myTracer }
      * });
      * ```
@@ -101,7 +101,7 @@ export type CreateEvaluatorOptions = {
  * @example
  * Basic usage with a simple scoring function:
  * ```typescript
- * const accuracyEvaluator = CreateEvaluator(
+ * const accuracyEvaluator = createEvaluator(
  *   ({ output, expected }) => {
  *     return output === expected ? 1 : 0;
  *   },
@@ -123,7 +123,7 @@ export type CreateEvaluatorOptions = {
  * @example
  * Returning a full EvaluationResult:
  * ```typescript
- * const qualityEvaluator = CreateEvaluator(
+ * const qualityEvaluator = createEvaluator(
  *   ({ output }) => {
  *     const score = calculateQuality(output);
  *     return {

package/dist/esm/helpers/createEvaluator.js

@@ -38,7 +38,7 @@ function generateUniqueName() {
  * @example
  * Basic usage with a simple scoring function:
  * ```typescript
- * const accuracyEvaluator = CreateEvaluator(
+ * const accuracyEvaluator = createEvaluator(
  *   ({ output, expected }) => {
  *     return output === expected ? 1 : 0;
  *   },
@@ -60,7 +60,7 @@ function generateUniqueName() {
  * @example
  * Returning a full EvaluationResult:
  * ```typescript
- * const qualityEvaluator = CreateEvaluator(
+ * const qualityEvaluator = createEvaluator(
  *   ({ output }) => {
  *     const score = calculateQuality(output);
  *     return {

package/dist/esm/helpers/index.d.ts

@@ -1,2 +1,4 @@
+export * from "./asEvaluatorFn.js";
 export * from "./createEvaluator.js";
+export * from "./toEvaluationResult.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/helpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}

package/dist/esm/helpers/index.js

@@ -1,2 +1,4 @@
+export * from "./asEvaluatorFn.js";
 export * from "./createEvaluator.js";
+export * from "./toEvaluationResult.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}