@arizeai/phoenix-client 1.2.0 → 2.0.0

package/dist/src/datasets/listDatasets.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listDatasets = listDatasets;
+const client_1 = require("../client");
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+/**
+ * List the information about all datasets available to the client.
+ *
+ * @example
+ * ```ts
+ * import { listDatasets } from "@arizeai/phoenix-client/datasets";
+ *
+ * const datasets = await listDatasets({});
+ * console.log(datasets);
+ * ```
+ *
+ * @throws {Error} If the datasets cannot be listed or the response is invalid.
+ */
+function listDatasets(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ client: _client, }) {
+        var _b;
+        const client = _client || (0, client_1.createClient)();
+        const response = yield client.GET("/v1/datasets");
+        (0, tiny_invariant_1.default)((_b = response.data) === null || _b === void 0 ? void 0 : _b.data, "Failed to list datasets");
+        return response.data.data.map((dataset) => (Object.assign(Object.assign({}, dataset), { startDate: new Date(dataset.created_at), endDate: new Date(dataset.updated_at) })));
+    });
+}
+//# sourceMappingURL=listDatasets.js.map

package/dist/src/datasets/listDatasets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listDatasets.js","sourceRoot":"","sources":["../../../src/datasets/listDatasets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAyBA,oCAWC;AApCD,sCAAyC;AAGzC,oEAAuC;AASvC;;;;;;;;;;;;GAYG;AACH,SAAsB,YAAY;yDAAC,EACjC,MAAM,EAAE,OAAO,GACI;;QACnB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;QACzC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAClD,IAAA,wBAAS,EAAC,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EAAE,yBAAyB,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCACtC,OAAO,KACV,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EACvC,OAAO,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IACrC,CAAC,CAAC;IACN,CAAC;CAAA"}

package/dist/src/experiments/getExperiment.d.ts

@@ -0,0 +1,14 @@
+import { ClientFn } from "../types/core";
+import { RanExperiment } from "../types/experiments";
+export type GetExperimentResultParams = ClientFn & {
+    /**
+     * The experiment ID.
+     */
+    experimentId: string;
+};
+/**
+ * A function that gets the result of a experiment.
+ * Fetches the experiment data as well as the runs.
+ */
+export declare function getExperiment({ client: _client, experimentId, }: GetExperimentResultParams): Promise<RanExperiment>;
+//# sourceMappingURL=getExperiment.d.ts.map

package/dist/src/experiments/getExperiment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperiment.d.ts","sourceRoot":"","sources":["../../../src/experiments/getExperiment.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAqB,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAIxE,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAClC,MAAM,EAAE,OAAO,EACf,YAAY,GACb,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,CAmBpD"}

package/dist/src/experiments/getExperiment.js

@@ -0,0 +1,36 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExperiment = getExperiment;
+const client_1 = require("../client");
+const getExperimentInfo_1 = require("./getExperimentInfo");
+const getExperimentRuns_1 = require("./getExperimentRuns");
+/**
+ * A function that gets the result of a experiment.
+ * Fetches the experiment data as well as the runs.
+ */
+function getExperiment(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ client: _client, experimentId, }) {
+        const client = _client || (0, client_1.createClient)();
+        const [experiment, experimentRuns] = yield Promise.all([
+            (0, getExperimentInfo_1.getExperimentInfo)({ client, experimentId }),
+            (0, getExperimentRuns_1.getExperimentRuns)({ client, experimentId }),
+        ]);
+        const experimentRunsMap = {
+            runs: experimentRuns.runs.reduce((acc, run) => {
+                acc[run.id] = run;
+                return acc;
+            }, {}),
+        };
+        return Object.assign(Object.assign({}, experiment), experimentRunsMap);
+    });
+}
+//# sourceMappingURL=getExperiment.js.map

package/dist/src/experiments/getExperiment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperiment.js","sourceRoot":"","sources":["../../../src/experiments/getExperiment.ts"],"names":[],"mappings":";;;;;;;;;;;AAiBA,sCAsBC;AAvCD,sCAAyC;AAGzC,2DAAwD;AACxD,2DAAwD;AASxD;;;GAGG;AACH,SAAsB,aAAa;yDAAC,EAClC,MAAM,EAAE,OAAO,EACf,YAAY,GACc;QAC1B,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;QACzC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACrD,IAAA,qCAAiB,EAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;YAC3C,IAAA,qCAAiB,EAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;SAC5C,CAAC,CAAC;QACH,MAAM,iBAAiB,GAAsB;YAC3C,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,MAAM,CAC9B,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACX,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;gBAClB,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAA+B,CAChC;SACF,CAAC;QACF,uCACK,UAAU,GACV,iBAAiB,EACpB;IACJ,CAAC;CAAA"}

package/dist/src/experiments/getExperimentInfo.d.ts

@@ -0,0 +1,13 @@
+import { ClientFn } from "../types/core";
+import { type ExperimentInfo } from "../types/experiments";
+export type GetExperimentParams = ClientFn & {
+    /**
+     * The experiment ID
+     */
+    experimentId: string;
+};
+/**
+ * Returns an object containing the high-level info about an experiment
+ */
+export declare function getExperimentInfo({ client: _client, experimentId: experiment_id, }: GetExperimentParams): Promise<ExperimentInfo>;
+//# sourceMappingURL=getExperimentInfo.d.ts.map

package/dist/src/experiments/getExperimentInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentInfo.d.ts","sourceRoot":"","sources":["../../../src/experiments/getExperimentInfo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,aAAa,GAC5B,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC,CAoB/C"}

package/dist/src/experiments/getExperimentInfo.js

@@ -0,0 +1,41 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExperimentInfo = getExperimentInfo;
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const client_1 = require("../client");
+/**
+ * Returns an object containing the high-level info about an experiment
+ */
+function getExperimentInfo(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ client: _client, experimentId: experiment_id, }) {
+        const client = _client || (0, client_1.createClient)();
+        const { data: { data: experimentData } = {} } = yield client.GET("/v1/experiments/{experiment_id}", {
+            params: {
+                path: {
+                    experiment_id,
+                },
+            },
+        });
+        (0, tiny_invariant_1.default)(experimentData, "Failed to get experiment");
+        return {
+            id: experimentData.id,
+            datasetId: experimentData.dataset_id,
+            datasetVersionId: experimentData.dataset_version_id,
+            projectName: experimentData.project_name || "", // This will never happen
+            metadata: experimentData.metadata,
+        };
+    });
+}
+//# sourceMappingURL=getExperimentInfo.js.map

package/dist/src/experiments/getExperimentInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentInfo.js","sourceRoot":"","sources":["../../../src/experiments/getExperimentInfo.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAeA,8CAuBC;AAtCD,oEAAuC;AACvC,sCAAyC;AAWzC;;GAEG;AACH,SAAsB,iBAAiB;yDAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,aAAa,GACP;QACpB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;QACzC,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CAC9D,iCAAiC,EACjC;YACE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,aAAa;iBACd;aACF;SACF,CACF,CAAC;QACF,IAAA,wBAAS,EAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;QACtD,OAAO;YACL,EAAE,EAAE,cAAc,CAAC,EAAE;YACrB,SAAS,EAAE,cAAc,CAAC,UAAU;YACpC,gBAAgB,EAAE,cAAc,CAAC,kBAAkB;YACnD,WAAW,EAAE,cAAc,CAAC,YAAY,IAAI,EAAE,EAAE,yBAAyB;YACzE,QAAQ,EAAE,cAAc,CAAC,QAAQ;SAClC,CAAC;IACJ,CAAC;CAAA"}

package/dist/src/experiments/getExperimentRuns.d.ts

@@ -0,0 +1,15 @@
+import { ClientFn } from "../types/core";
+import { ExperimentRun } from "../types/experiments";
+export type GetExperimentRunsParams = ClientFn & {
+    /**
+     * The experiment ID.
+     */
+    experimentId: string;
+};
+/**
+ * A function that gets the runs (e.g. the results) of a experiment
+ */
+export declare function getExperimentRuns({ client: _client, experimentId, }: GetExperimentRunsParams): Promise<{
+    runs: ExperimentRun[];
+}>;
+//# sourceMappingURL=getExperimentRuns.d.ts.map

package/dist/src/experiments/getExperimentRuns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentRuns.d.ts","sourceRoot":"","sources":["../../../src/experiments/getExperimentRuns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG;IAC/C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,GACb,EAAE,uBAAuB,GAAG,OAAO,CAAC;IAAE,IAAI,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CA0B9D"}

package/dist/src/experiments/getExperimentRuns.js

@@ -0,0 +1,50 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExperimentRuns = getExperimentRuns;
+const client_1 = require("../client");
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+/**
+ * A function that gets the runs (e.g. the results) of a experiment
+ */
+function getExperimentRuns(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ client: _client, experimentId, }) {
+        const client = _client || (0, client_1.createClient)();
+        const getRunsPromise = client.GET("/v1/experiments/{experiment_id}/runs", {
+            params: {
+                path: {
+                    experiment_id: experimentId,
+                },
+            },
+        });
+        const [experimentRunResponse] = yield Promise.all([getRunsPromise]);
+        const { data: { data: experimentRunsData } = {} } = experimentRunResponse;
+        (0, tiny_invariant_1.default)(experimentRunsData, "Failed to retrieve experiment runs");
+        return {
+            runs: experimentRunsData.map((run) => {
+                return {
+                    id: run.id,
+                    traceId: run.trace_id || null,
+                    experimentId: run.experiment_id,
+                    datasetExampleId: run.dataset_example_id,
+                    startTime: new Date(run.start_time),
+                    endTime: new Date(run.end_time),
+                    output: run.output,
+                    error: run.error || null,
+                };
+            }),
+        };
+    });
+}
+//# sourceMappingURL=getExperimentRuns.js.map

package/dist/src/experiments/getExperimentRuns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getExperimentRuns.js","sourceRoot":"","sources":["../../../src/experiments/getExperimentRuns.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAeA,8CA6BC;AA5CD,sCAAyC;AACzC,oEAAuC;AAWvC;;GAEG;AACH,SAAsB,iBAAiB;yDAAC,EACtC,MAAM,EAAE,OAAO,EACf,YAAY,GACY;QACxB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;QACzC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,sCAAsC,EAAE;YACxE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,aAAa,EAAE,YAAY;iBAC5B;aACF;SACF,CAAC,CAAC;QACH,MAAM,CAAC,qBAAqB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;QACpE,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,EAAE,EAAE,GAAG,qBAAqB,CAAC;QAC1E,IAAA,wBAAS,EAAC,kBAAkB,EAAE,oCAAoC,CAAC,CAAC;QACpE,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACnC,OAAO;oBACL,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,OAAO,EAAE,GAAG,CAAC,QAAQ,IAAI,IAAI;oBAC7B,YAAY,EAAE,GAAG,CAAC,aAAa;oBAC/B,gBAAgB,EAAE,GAAG,CAAC,kBAAkB;oBACxC,SAAS,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC;oBACnC,OAAO,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;oBAC/B,MAAM,EAAE,GAAG,CAAC,MAAiC;oBAC7C,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,IAAI;iBACzB,CAAC;YACJ,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;CAAA"}

package/dist/src/experiments/index.d.ts

@@ -1,2 +1,5 @@
+export * from "./getExperimentInfo";
+export * from "./getExperiment";
+export * from "./getExperimentRuns";
 export * from "./runExperiment";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/experiments/index.d.ts.map

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

package/dist/src/experiments/index.js

@@ -14,5 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./getExperimentInfo"), exports);
+__exportStar(require("./getExperiment"), exports);
+__exportStar(require("./getExperimentRuns"), exports);
 __exportStar(require("./runExperiment"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/experiments/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/experiments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/experiments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,kDAAgC;AAChC,sDAAoC;AACpC,kDAAgC"}

package/dist/src/experiments/instrumention.d.ts

@@ -0,0 +1,18 @@
+import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
+import { HeadersOptions } from "openapi-fetch";
+/**
+ * Creates a provider that exports traces to Phoenix.
+ */
+export declare function createProvider({ projectName, baseUrl, headers, }: {
+    projectName: string;
+    headers: HeadersOptions;
+    /**
+     * The base URL of the Phoenix. Doesn't include the /v1/traces path.
+     */
+    baseUrl: string;
+}): NodeTracerProvider;
+/**
+ * For dry runs we create a provider that doesn't export traces.
+ */
+export declare function createNoOpProvider(): NodeTracerProvider;
+//# sourceMappingURL=instrumention.d.ts.map

package/dist/src/experiments/instrumention.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumention.d.ts","sourceRoot":"","sources":["../../../src/experiments/instrumention.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C;;GAEG;AACH,wBAAgB,cAAc,CAAC,EAC7B,WAAW,EACX,OAAO,EACP,OAAO,GACR,EAAE;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,sBAoBA;AAED;;GAEG;AACH,wBAAgB,kBAAkB,uBAIjC"}

package/dist/src/experiments/instrumention.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProvider = createProvider;
+exports.createNoOpProvider = createNoOpProvider;
+const api_1 = require("@opentelemetry/api");
+const exporter_trace_otlp_proto_1 = require("@opentelemetry/exporter-trace-otlp-proto");
+const resources_1 = require("@opentelemetry/resources");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const openinference_semantic_conventions_1 = require("@arizeai/openinference-semantic-conventions");
+/**
+ * Creates a provider that exports traces to Phoenix.
+ */
+function createProvider({ projectName, baseUrl, headers, }) {
+    api_1.diag.setLogger(new api_1.DiagConsoleLogger(), api_1.DiagLogLevel.ERROR);
+    const provider = new sdk_trace_node_1.NodeTracerProvider({
+        resource: (0, resources_1.resourceFromAttributes)({
+            [openinference_semantic_conventions_1.SEMRESATTRS_PROJECT_NAME]: projectName,
+        }),
+        spanProcessors: [
+            new sdk_trace_base_1.SimpleSpanProcessor(new exporter_trace_otlp_proto_1.OTLPTraceExporter({
+                url: `${baseUrl}/v1/traces`,
+                headers: Array.isArray(headers)
+                    ? Object.fromEntries(headers)
+                    : headers,
+            })),
+        ],
+    });
+    return provider;
+}
+/**
+ * For dry runs we create a provider that doesn't export traces.
+ */
+function createNoOpProvider() {
+    const provider = new sdk_trace_node_1.NodeTracerProvider({});
+    return provider;
+}
+//# sourceMappingURL=instrumention.js.map

package/dist/src/experiments/instrumention.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumention.js","sourceRoot":"","sources":["../../../src/experiments/instrumention.ts"],"names":[],"mappings":";;AAWA,wCA+BC;AAKD,gDAIC;AAnDD,4CAA2E;AAC3E,wFAA6E;AAC7E,wDAAkE;AAClE,kEAAoE;AACpE,kEAAmE;AACnE,oGAAuF;AAGvF;;GAEG;AACH,SAAgB,cAAc,CAAC,EAC7B,WAAW,EACX,OAAO,EACP,OAAO,GAQR;IACC,UAAI,CAAC,SAAS,CAAC,IAAI,uBAAiB,EAAE,EAAE,kBAAY,CAAC,KAAK,CAAC,CAAC;IAE5D,MAAM,QAAQ,GAAG,IAAI,mCAAkB,CAAC;QACtC,QAAQ,EAAE,IAAA,kCAAsB,EAAC;YAC/B,CAAC,6DAAwB,CAAC,EAAE,WAAW;SACxC,CAAC;QACF,cAAc,EAAE;YACd,IAAI,oCAAmB,CACrB,IAAI,6CAAiB,CAAC;gBACpB,GAAG,EAAE,GAAG,OAAO,YAAY;gBAC3B,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;oBAC7B,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;oBAC7B,CAAC,CAAC,OAAO;aACZ,CAAC,CACH;SACF;KACF,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB;IAChC,MAAM,QAAQ,GAAG,IAAI,mCAAkB,CAAC,EAAE,CAAC,CAAC;IAE5C,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/src/experiments/runExperiment.d.ts

@@ -1,6 +1,6 @@
 import { type PhoenixClient } from "../client";
 import { ClientFn } from "../types/core";
-import { Dataset, Example } from "../types/datasets";
+import { DatasetSelector } from "../types/datasets";
 import type { Evaluator, ExperimentTask, RanExperiment } from "../types/experiments";
 import { type Logger } from "../types/logger";
 import { AnnotatorKind } from "../types/annotations";
@@ -21,12 +21,13 @@ export type RunExperimentParams = ClientFn & {
     experimentDescription?: string;
     /**
      * Experiment metadata
+     * E.x. modelName
      */
     experimentMetadata?: Record<string, unknown>;
     /**
      * The dataset to run the experiment on
      */
-    dataset: Dataset | string | Example[];
+    dataset: DatasetSelector;
     /**
      * The task to run
      */
@@ -35,10 +36,6 @@ export type RunExperimentParams = ClientFn & {
      * The evaluators to use
      */
     evaluators?: Evaluator[];
-    /**
-     * The project under which the experiment task traces are recorded
-     */
-    projectName?: string;
     /**
      * The logger to use
      */
@@ -58,7 +55,23 @@ export type RunExperimentParams = ClientFn & {
     dryRun?: number | boolean;
 };
 /**
- * Run an experiment.
+ * Runs an experiment using a given set of dataset of examples.
+ *
+ *   An experiment is a user-defined task that runs on each example in a dataset. The results from
+ *   each experiment can be evaluated using any number of evaluators to measure the behavior of the
+ *   task. The experiment and evaluation results are stored in the Phoenix database for comparison
+ *   and analysis.
+ *
+ *   A `task` is either a sync or async function that returns a JSON serializable
+ *   output. If the `task` is a function of one argument then that argument will be bound to the
+ *   `input` field of the dataset example. Alternatively, the `task` can be a function of any
+ *   combination of specific argument names that will be bound to special values:
+ *
+ *   - `input`: The input field of the dataset example
+ *   - `expected`: The expected or reference output of the dataset example
+ *   - `reference`: An alias for `expected`
+ *   - `metadata`: Metadata associated with the dataset example
+ *   - `example`: The dataset `Example` object with all associated fields
  *
  * @example
  * ```ts
@@ -68,14 +81,12 @@ export type RunExperimentParams = ClientFn & {
  *   dataset: "my-dataset",
  *   task: async (example) => example.input,
  *   evaluators: [
- *     asEvaluator("my-evaluator", "CODE", async (params) => params.output),
+ *     asEvaluator({ name: "my-evaluator", kind: "CODE", evaluate: async (params) => params.output }),
  *   ],
  * });
  * ```
- *
- * @experimental This feature is not complete, and will change in the future.
  */
-export declare function runExperiment({ experimentName: _experimentName, experimentDescription, experimentMetadata, client: _client, dataset: _dataset, task, evaluators, projectName, logger, record, concurrency, dryRun, }: RunExperimentParams): Promise<RanExperiment>;
+export declare function runExperiment({ experimentName, experimentDescription, experimentMetadata, client: _client, dataset: DatasetSelector, task, evaluators, logger, record, concurrency, dryRun, }: RunExperimentParams): Promise<RanExperiment>;
 /**
  * Evaluate an experiment.
  *
@@ -84,7 +95,6 @@ export declare function runExperiment({ experimentName: _experimentName, experim
 export declare function evaluateExperiment({ experiment, evaluators, client: _client, logger, concurrency, dryRun, }: {
     /**
      * The experiment to evaluate
-     * @todo also accept Experiment, and attempt to fetch the runs from the server
      **/
     experiment: RanExperiment;
     /** The evaluators to use */
@@ -92,9 +102,9 @@ export declare function evaluateExperiment({ experiment, evaluators, client: _cl
     /** The client to use */
     client?: PhoenixClient;
     /** The logger to use */
-    logger: Logger;
+    logger?: Logger;
     /** The number of evaluators to run in parallel */
-    concurrency: number;
+    concurrency?: number;
     /**
      * Whether to run the evaluation as a dry run
      * If a number is provided, the evaluation will be run for the first n runs
@@ -116,11 +126,4 @@ export declare function asEvaluator({ name, kind, evaluate, }: {
     kind: AnnotatorKind;
     evaluate: Evaluator["evaluate"];
 }): Evaluator;
-/**
- * Generate a unique id.
- *
- * @deprecated Use id generated by phoenix instead.
- * @returns A unique id.
- */
-export declare function id(): string;
 //# sourceMappingURL=runExperiment.d.ts.map

package/dist/src/experiments/runExperiment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runExperiment.d.ts","sourceRoot":"","sources":["../../../src/experiments/runExperiment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EACV,SAAS,EAKT,cAAc,EACd,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAI9C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG;IAC3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7C;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,EAAE,CAAC;IACtC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,aAAa,CAAC,EAClC,cAAc,EAAE,eAAe,EAC/B,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,QAAQ,EACjB,IAAI,EACJ,UAAU,EACV,WAAuB,EACvB,MAAgB,EAChB,MAAa,EACb,WAAe,EACf,MAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAmG9C;AA4FD;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,UAAU,EACV,MAAM,EAAE,OAAO,EACf,MAAM,EACN,WAAe,EACf,MAAc,GACf,EAAE;IACD;;;QAGI;IACJ,UAAU,EAAE,aAAa,CAAC;IAC1B,4BAA4B;IAC5B,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,wBAAwB;IACxB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,kDAAkD;IAClD,WAAW,EAAE,MAAM,CAAC;IACpB;;;;SAIK;IACL,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B,GAAG,OAAO,CAAC,aAAa,CAAC,CA6FzB;AAmDD;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,EAC1B,IAAI,EACJ,IAAI,EACJ,QAAQ,GACT,EAAE;IACD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;CACjC,GAAG,SAAS,CAMZ;AAID;;;;;GAKG;AACH,wBAAgB,EAAE,IAAI,MAAM,CAK3B"}
+{"version":3,"file":"runExperiment.d.ts","sourceRoot":"","sources":["../../../src/experiments/runExperiment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAEL,eAAe,EAGhB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,SAAS,EAKT,cAAc,EACd,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAI9C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAYrD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG;IAC3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7C;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,aAAa,CAAC,EAClC,cAAc,EACd,qBAAqB,EACrB,kBAAuB,EACvB,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,eAAe,EACxB,IAAI,EACJ,UAAU,EACV,MAAgB,EAChB,MAAa,EACb,WAAe,EACf,MAAc,GACf,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAoH9C;AAwHD;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,UAAU,EACV,MAAM,EAAE,OAAO,EACf,MAAgB,EAChB,WAAe,EACf,MAAc,GACf,EAAE;IACD;;QAEI;IACJ,UAAU,EAAE,aAAa,CAAC;IAC1B,4BAA4B;IAC5B,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,wBAAwB;IACxB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;SAIK;IACL,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B,GAAG,OAAO,CAAC,aAAa,CAAC,CAgKzB;AA8DD;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,EAC1B,IAAI,EACJ,IAAI,EACJ,QAAQ,GACT,EAAE;IACD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;CACjC,GAAG,SAAS,CAMZ"}