@langfuse/client 4.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2023 Finto Technologies GmbH
+
+Copyright (c) 2022 PostHog (part of Hiberly Inc)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/LangfuseClient.d.ts

@@ -0,0 +1,90 @@
+import { LangfuseAPIClient } from "@langfuse/core";
+import { DatasetManager } from "./dataset/index.js";
+import { MediaManager } from "./media/index.js";
+import { PromptManager } from "./prompt/index.js";
+import { ScoreManager } from "./score/index.js";
+export interface LangfuseClientParams {
+    publicKey?: string;
+    secretKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    additionalHeaders?: Record<string, string>;
+}
+export declare class LangfuseClient {
+    api: LangfuseAPIClient;
+    prompt: PromptManager;
+    dataset: DatasetManager;
+    score: ScoreManager;
+    media: MediaManager;
+    private baseUrl;
+    private projectId;
+    /**
+     * @deprecated Use prompt.get instead
+     */
+    getPrompt: typeof PromptManager.prototype.get;
+    /**
+     * @deprecated Use prompt.create instead
+     */
+    createPrompt: typeof PromptManager.prototype.create;
+    /**
+     * @deprecated Use prompt.update instead
+     */
+    updatePrompt: typeof PromptManager.prototype.update;
+    /**
+     * @deprecated Use dataset.get instead
+     */
+    getDataset: typeof DatasetManager.prototype.get;
+    /**
+     * @deprecated Use api.trace.get instead
+     */
+    fetchTrace: typeof LangfuseAPIClient.prototype.trace.get;
+    /**
+     * @deprecated Use api.trace.list instead
+     */
+    fetchTraces: typeof LangfuseAPIClient.prototype.trace.list;
+    /**
+     * @deprecated Use api.observations.get instead
+     */
+    fetchObservation: typeof LangfuseAPIClient.prototype.observations.get;
+    /**
+     * @deprecated Use api.observations.list instead
+     */
+    fetchObservations: typeof LangfuseAPIClient.prototype.observations.getMany;
+    /**
+     * @deprecated Use api.sessions.get instead
+     */
+    fetchSessions: typeof LangfuseAPIClient.prototype.sessions.get;
+    /**
+     * @deprecated Use api.datasets.getRun instead
+     */
+    getDatasetRun: typeof LangfuseAPIClient.prototype.datasets.getRun;
+    /**
+     * @deprecated Use api.datasets.getRuns instead
+     */
+    getDatasetRuns: typeof LangfuseAPIClient.prototype.datasets.getRuns;
+    /**
+     * @deprecated Use api.datasets.create instead
+     */
+    createDataset: typeof LangfuseAPIClient.prototype.datasets.create;
+    /**
+     * @deprecated Use api.datasetItems.get instead
+     */
+    getDatasetItem: typeof LangfuseAPIClient.prototype.datasetItems.get;
+    /**
+     * @deprecated Use api.datasetItems.create instead
+     */
+    createDatasetItem: typeof LangfuseAPIClient.prototype.datasetItems.create;
+    /**
+     * @deprecated Use api.media.get instead
+     */
+    fetchMedia: typeof LangfuseAPIClient.prototype.media.get;
+    /**
+     * @deprecated Use media.resolveReferences instead
+     */
+    resolveMediaReferences: typeof MediaManager.prototype.resolveReferences;
+    constructor(params?: LangfuseClientParams);
+    flush(): Promise<void>;
+    shutdown(): Promise<void>;
+    getTraceUrl(traceId: string): Promise<string>;
+}
+//# sourceMappingURL=LangfuseClient.d.ts.map

package/dist/LangfuseClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LangfuseClient.d.ts","sourceRoot":"","sources":["../src/LangfuseClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAIlB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5C;AAED,qBAAa,cAAc;IAClB,GAAG,EAAE,iBAAiB,CAAC;IACvB,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,YAAY,CAAC;IACpB,KAAK,EAAE,YAAY,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAuB;IAExC;;OAEG;IACI,SAAS,EAAE,OAAO,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC;IACrD;;OAEG;IACI,YAAY,EAAE,OAAO,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC;IAC3D;;OAEG;IACI,YAAY,EAAE,OAAO,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC;IAC3D;;OAEG;IACI,UAAU,EAAE,OAAO,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC;IACvD;;OAEG;IACI,UAAU,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;IAChE;;OAEG;IACI,WAAW,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;IAClE;;OAEG;IACI,gBAAgB,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC;IAC7E;;OAEG;IACI,iBAAiB,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC;IAClF;;OAEG;IACI,aAAa,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;IACtE;;OAEG;IACI,aAAa,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;IACzE;;OAEG;IACI,cAAc,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC3E;;OAEG;IACI,aAAa,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;IACzE;;OAEG;IACI,cAAc,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC;IAC3E;;OAEG;IACI,iBAAiB,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC;IACjF;;OAEG;IACI,UAAU,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;IAChE;;OAEG;IACI,sBAAsB,EAAE,OAAO,YAAY,CAAC,SAAS,CAAC,iBAAiB,CAAC;gBAEnE,MAAM,CAAC,EAAE,oBAAoB;IAiE5B,KAAK;IAIL,QAAQ;IAIR,WAAW,CAAC,OAAO,EAAE,MAAM;CAYzC"}

package/dist/LangfuseClient.js

@@ -0,0 +1,74 @@
+import { LangfuseAPIClient, LANGFUSE_SDK_VERSION, getGlobalLogger, getEnv, } from "@langfuse/core";
+import { DatasetManager } from "./dataset/index.js";
+import { MediaManager } from "./media/index.js";
+import { PromptManager } from "./prompt/index.js";
+import { ScoreManager } from "./score/index.js";
+export class LangfuseClient {
+    constructor(params) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        this.projectId = null;
+        const logger = getGlobalLogger();
+        const publicKey = (_a = params === null || params === void 0 ? void 0 : params.publicKey) !== null && _a !== void 0 ? _a : getEnv("LANGFUSE_PUBLIC_KEY");
+        const secretKey = (_b = params === null || params === void 0 ? void 0 : params.secretKey) !== null && _b !== void 0 ? _b : getEnv("LANGFUSE_SECRET_KEY");
+        this.baseUrl =
+            (_e = (_d = (_c = params === null || params === void 0 ? void 0 : params.baseUrl) !== null && _c !== void 0 ? _c : getEnv("LANGFUSE_BASE_URL")) !== null && _d !== void 0 ? _d : getEnv("LANGFUSE_BASEURL")) !== null && _e !== void 0 ? _e : "https://cloud.langfuse.com";
+        if (!publicKey) {
+            logger.warn("No public key provided in constructor or as LANGFUSE_PUBLIC_KEY env var. Client operations will fail.");
+        }
+        if (!secretKey) {
+            logger.warn("No secret key provided in constructor or as LANGFUSE_SECRET_KEY env var. Client operations will fail.");
+        }
+        const timeoutSeconds = (_f = params === null || params === void 0 ? void 0 : params.timeout) !== null && _f !== void 0 ? _f : Number((_g = getEnv("LANGFUSE_TIMEOUT")) !== null && _g !== void 0 ? _g : 5);
+        this.api = new LangfuseAPIClient({
+            baseUrl: this.baseUrl,
+            username: publicKey,
+            password: secretKey,
+            xLangfusePublicKey: publicKey,
+            xLangfuseSdkVersion: LANGFUSE_SDK_VERSION,
+            xLangfuseSdkName: "javascript",
+            environment: "", // noop as baseUrl is set
+            headers: params === null || params === void 0 ? void 0 : params.additionalHeaders,
+        });
+        logger.debug("Initialized LangfuseClient with params:", {
+            publicKey,
+            baseUrl: this.baseUrl,
+            timeoutSeconds,
+        });
+        this.prompt = new PromptManager({ apiClient: this.api });
+        this.dataset = new DatasetManager({ apiClient: this.api });
+        this.score = new ScoreManager({ apiClient: this.api });
+        this.media = new MediaManager({ apiClient: this.api });
+        // Keep v3 compat by exposing old interface
+        this.getPrompt = this.prompt.get.bind(this.prompt); // keep correct this context for cache access
+        this.createPrompt = this.prompt.create.bind(this.prompt);
+        this.updatePrompt = this.prompt.update.bind(this.prompt);
+        this.getDataset = this.dataset.get;
+        this.fetchTrace = this.api.trace.get;
+        this.fetchTraces = this.api.trace.list;
+        this.fetchObservation = this.api.observations.get;
+        this.fetchObservations = this.api.observations.getMany;
+        this.fetchSessions = this.api.sessions.get;
+        this.getDatasetRun = this.api.datasets.getRun;
+        this.getDatasetRuns = this.api.datasets.getRuns;
+        this.createDataset = this.api.datasets.create;
+        this.getDatasetItem = this.api.datasetItems.get;
+        this.createDatasetItem = this.api.datasetItems.create;
+        this.fetchMedia = this.api.media.get;
+        this.resolveMediaReferences = this.media.resolveReferences;
+    }
+    async flush() {
+        return this.score.flush();
+    }
+    async shutdown() {
+        return this.score.shutdown();
+    }
+    async getTraceUrl(traceId) {
+        let projectId = this.projectId;
+        if (!projectId) {
+            projectId = (await this.api.projects.get()).data[0].id;
+            this.projectId = projectId;
+        }
+        const traceUrl = `${this.baseUrl}/project/${projectId}/traces/${traceId}`;
+        return traceUrl;
+    }
+}

package/dist/dataset/index.d.ts

@@ -0,0 +1,23 @@
+import { LangfuseAPIClient, Dataset, DatasetRunItem, DatasetItem } from "@langfuse/core";
+import { Span } from "@opentelemetry/api";
+export type LinkDatasetItemFunction = (obj: {
+    otelSpan: Span;
+}, runName: string, runArgs?: {
+    description?: string;
+    metadata?: any;
+}) => Promise<DatasetRunItem>;
+export declare class DatasetManager {
+    private apiClient;
+    constructor(params: {
+        apiClient: LangfuseAPIClient;
+    });
+    get(name: string, options?: {
+        fetchItemsPageSize: number;
+    }): Promise<Dataset & {
+        items: (DatasetItem & {
+            link: LinkDatasetItemFunction;
+        })[];
+    }>;
+    private createDatasetItemLinkFunction;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/dataset/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dataset/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,OAAO,EACP,cAAc,EACd,WAAW,EACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE1C,MAAM,MAAM,uBAAuB,GAAG,CACpC,GAAG,EAAE;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,EACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IACR,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,GAAG,CAAC;CAChB,KACE,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7B,qBAAa,cAAc;IACzB,OAAO,CAAC,SAAS,CAAoB;gBAEzB,MAAM,EAAE;QAAE,SAAS,EAAE,iBAAiB,CAAA;KAAE;IAI9C,GAAG,CACP,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,kBAAkB,EAAE,MAAM,CAAC;KAC5B,GACA,OAAO,CACR,OAAO,GAAG;QACR,KAAK,EAAE,CAAC,WAAW,GAAG;YAAE,IAAI,EAAE,uBAAuB,CAAA;SAAE,CAAC,EAAE,CAAC;KAC5D,CACF;IAiCD,OAAO,CAAC,6BAA6B;CAsBtC"}

package/dist/dataset/index.js

@@ -0,0 +1,43 @@
+export class DatasetManager {
+    constructor(params) {
+        this.apiClient = params.apiClient;
+    }
+    async get(name, options) {
+        var _a;
+        const dataset = await this.apiClient.datasets.get(name);
+        const items = [];
+        let page = 1;
+        while (true) {
+            const itemsResponse = await this.apiClient.datasetItems.list({
+                datasetName: name,
+                limit: (_a = options === null || options === void 0 ? void 0 : options.fetchItemsPageSize) !== null && _a !== void 0 ? _a : 50,
+                page,
+            });
+            items.push(...itemsResponse.data);
+            if (itemsResponse.meta.totalPages <= page) {
+                break;
+            }
+            page++;
+        }
+        const returnDataset = {
+            ...dataset,
+            items: items.map((item) => ({
+                ...item,
+                link: this.createDatasetItemLinkFunction(item),
+            })),
+        };
+        return returnDataset;
+    }
+    createDatasetItemLinkFunction(item) {
+        const linkFunction = async (obj, runName, runArgs) => {
+            return await this.apiClient.datasetRunItems.create({
+                runName,
+                datasetItemId: item.id,
+                traceId: obj.otelSpan.spanContext().traceId,
+                runDescription: runArgs === null || runArgs === void 0 ? void 0 : runArgs.description,
+                metadata: runArgs === null || runArgs === void 0 ? void 0 : runArgs.metadata,
+            });
+        };
+        return linkFunction;
+    }
+}