Class Langfuse

Hierarchy

  • LangfuseCore
    • Langfuse

Constructors

constructor

Properties

_events _flushTimer? _retryOptions additionalHeaders api baseUrl isLocalEventExportEnabled publicKey sdkIntegration secretKey

Methods

_exportLocalEvents _fetchMedia _getDataset _getDatasetItems _getFetchOptions _parsePayload _updateGeneration _updateSpan awaitAllQueuedAndPendingRequests constructAuthorizationHeader createDataset createDatasetItem createDatasetRunItem createPrompt createPromptStateless debug enqueue event eventStateless fetch fetchMedia fetchObservation fetchObservations fetchSessions fetchTrace fetchTraces findAndProcessMedia flush flushAsync generation generationStateless getCommonEventProperties getCustomUserAgent getDataset getDatasetItem getDatasetRun getDatasetRuns getLibraryId getLibraryVersion getPersistedProperty getPrompt getPromptStateless getSdkIntegration on parseTraceId processEnqueueEvent processMediaInEvent processQueueItems resolveMediaReferences score scoreStateless setPersistedProperty shutdown shutdownAsync span spanStateless trace traceStateless truncateEventBody updateGenerationStateless updatePrompt updatePromptStateless updateSpanStateless

Constructors

constructor

  • new Langfuse(params?): Langfuse

  • Parameters

    • Optionalparams: {
          publicKey?: string;
          secretKey?: string;
      } & {
          enabled?: boolean;
          persistence?:
              | "localStorage"
              | "sessionStorage"
              | "memory"
              | "cookie";
          persistence_name?: string;
      } & LangfuseCoreOptions

    Returns Langfuse

Properties

Protected_events

_events: SimpleEventEmitter

Protected Optional_flushTimer

_flushTimer?: any

Protected_retryOptions

_retryOptions: RetriableOptions

additionalHeaders

additionalHeaders: Record<string, string>

api

api: {
    commentsCreate: ((data: ApiCreateCommentRequest, params?: RequestParams) => Promise<ApiCreateCommentResponse>);
    commentsGet: ((query: ApiCommentsGetParams, params?: RequestParams) => Promise<ApiGetCommentsResponse>);
    commentsGetById: ((commentId: string, params?: RequestParams) => Promise<ApiComment>);
    datasetItemsCreate: ((data: ApiCreateDatasetItemRequest, params?: RequestParams) => Promise<ApiDatasetItem>);
    datasetItemsGet: ((id: string, params?: RequestParams) => Promise<ApiDatasetItem>);
    datasetItemsList: ((query: ApiDatasetItemsListParams, params?: RequestParams) => Promise<ApiPaginatedDatasetItems>);
    datasetRunItemsCreate: ((data: ApiCreateDatasetRunItemRequest, params?: RequestParams) => Promise<ApiDatasetRunItem>);
    datasetsCreate: ((data: ApiCreateDatasetRequest, params?: RequestParams) => Promise<ApiDataset>);
    datasetsGet: ((datasetName: string, params?: RequestParams) => Promise<ApiDataset>);
    datasetsGetRun: ((datasetName: string, runName: string, params?: RequestParams) => Promise<ApiDatasetRunWithItems>);
    datasetsGetRuns: ((__namedParameters: ApiDatasetsGetRunsParams, params?: RequestParams) => Promise<ApiPaginatedDatasetRuns>);
    datasetsList: ((query: ApiDatasetsListParams, params?: RequestParams) => Promise<ApiPaginatedDatasets>);
    healthHealth: ((params?: RequestParams) => Promise<ApiHealthResponse>);
    ingestionBatch: ((data: ApiIngestionBatchPayload, params?: RequestParams) => Promise<ApiIngestionResponse>);
    mediaGet: ((mediaId: string, params?: RequestParams) => Promise<ApiGetMediaResponse>);
    mediaGetUploadUrl: ((data: ApiGetMediaUploadUrlRequest, params?: RequestParams) => Promise<ApiGetMediaUploadUrlResponse>);
    mediaPatch: ((mediaId: string, data: ApiPatchMediaBody, params?: RequestParams) => Promise<void>);
    metricsDaily: ((query: ApiMetricsDailyParams, params?: RequestParams) => Promise<ApiDailyMetrics>);
    modelsCreate: ((data: ApiCreateModelRequest, params?: RequestParams) => Promise<ApiModel>);
    modelsDelete: ((id: string, params?: RequestParams) => Promise<void>);
    modelsGet: ((id: string, params?: RequestParams) => Promise<ApiModel>);
    modelsList: ((query: ApiModelsListParams, params?: RequestParams) => Promise<ApiPaginatedModels>);
    observationsGet: ((observationId: string, params?: RequestParams) => Promise<ApiObservationsView>);
    observationsGetMany: ((query: ApiObservationsGetManyParams, params?: RequestParams) => Promise<ApiObservationsViews>);
    projectsGet: ((params?: RequestParams) => Promise<ApiProjects>);
    promptsCreate: ((data: ApiCreatePromptRequest, params?: RequestParams) => Promise<ApiPrompt>);
    promptsGet: ((__namedParameters: ApiPromptsGetParams, params?: RequestParams) => Promise<ApiPrompt>);
    promptsList: ((query: ApiPromptsListParams, params?: RequestParams) => Promise<ApiPromptMetaListResponse>);
    promptVersionUpdate: ((name: string, version: number, data: ApiPromptVersionUpdatePayload, params?: RequestParams) => Promise<ApiPrompt>);
    scoreConfigsCreate: ((data: ApiCreateScoreConfigRequest, params?: RequestParams) => Promise<ApiScoreConfig>);
    scoreConfigsGet: ((query: ApiScoreConfigsGetParams, params?: RequestParams) => Promise<ApiScoreConfigs>);
    scoreConfigsGetById: ((configId: string, params?: RequestParams) => Promise<ApiScoreConfig>);
    scoreCreate: ((data: ApiCreateScoreRequest, params?: RequestParams) => Promise<ApiCreateScoreResponse>);
    scoreDelete: ((scoreId: string, params?: RequestParams) => Promise<void>);
    scoreGet: ((query: ApiScoreGetParams, params?: RequestParams) => Promise<ApiGetScoresResponse>);
    scoreGetById: ((scoreId: string, params?: RequestParams) => Promise<ApiScore>);
    sessionsGet: ((sessionId: string, params?: RequestParams) => Promise<ApiSessionWithTraces>);
    sessionsList: ((query: ApiSessionsListParams, params?: RequestParams) => Promise<ApiPaginatedSessions>);
    traceGet: ((traceId: string, params?: RequestParams) => Promise<ApiTraceWithFullDetails>);
    traceList: ((query: ApiTraceListParams, params?: RequestParams) => Promise<ApiTraces>);
}

Type declaration

baseUrl

baseUrl: string

ProtectedisLocalEventExportEnabled

isLocalEventExportEnabled: boolean

ProtectedpublicKey

publicKey: string

ProtectedsdkIntegration

sdkIntegration: string

ProtectedsecretKey

secretKey: undefined | string

Methods

_exportLocalEvents

  • _exportLocalEvents(projectId): Promise<(
        | {
            type: "trace-create";
        } & {
            body: {
                id?: null | string;
                input?: unknown;
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                public?: null | boolean;
                release?: null | string;
                sessionId?: null | string;
                tags?: null | string[];
                timestamp?: null | string;
                userId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "score-create";
        } & {
            body: {
                comment?: null | string;
                configId?: null | string;
                dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                id?: null | string;
                name: string;
                observationId?: null | string;
                traceId: string;
                value: string | number;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "span-create";
        } & {
            body: {
                endTime?: null | string;
            } & {
                id?: null | string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "span-update";
        } & {
            body: {
                endTime?: null | string;
            } & {
                id: string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "generation-create";
        } & {
            body: {
                completionStartTime?: null | string;
                costDetails?: null | {
                    [key: string]: number;
                };
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: (...)[(...)]["MapValue"];
                };
                promptName?: null | string;
                promptVersion?: null | number;
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                } | {
                    completionTokens?: null | number;
                    promptTokens?: null | number;
                    totalTokens?: null | number;
                };
                usageDetails?: {
                    [key: string]: number;
                } | {
                    completion_tokens: number;
                    completion_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    prompt_tokens: number;
                    prompt_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    total_tokens: number;
                };
            } & {
                endTime?: null | string;
            } & {
                id?: null | string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "generation-update";
        } & {
            body: {
                completionStartTime?: null | string;
                costDetails?: null | {
                    [key: string]: number;
                };
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: (...)[(...)]["MapValue"];
                };
                promptName?: null | string;
                promptVersion?: null | number;
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                } | {
                    completionTokens?: null | number;
                    promptTokens?: null | number;
                    totalTokens?: null | number;
                };
                usageDetails?: {
                    [key: string]: number;
                } | {
                    completion_tokens: number;
                    completion_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    prompt_tokens: number;
                    prompt_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    total_tokens: number;
                };
            } & {
                endTime?: null | string;
            } & {
                id: string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "event-create";
        } & {
            body: {
                id?: null | string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "sdk-log";
        } & {
            body: {
                log: unknown;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "observation-create";
        } & {
            body: {
                completionStartTime?: null | string;
                endTime?: null | string;
                id?: null | string;
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: components["schemas"]["MapValue"];
                };
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                type: "SPAN" | "GENERATION" | "EVENT";
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "observation-update";
        } & {
            body: {
                completionStartTime?: null | string;
                endTime?: null | string;
                id?: null | string;
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: components["schemas"]["MapValue"];
                };
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                type: "SPAN" | "GENERATION" | "EVENT";
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        })[]>

  • Parameters

    • projectId: string

    Returns Promise<(
        | {
            type: "trace-create";
        } & {
            body: {
                id?: null | string;
                input?: unknown;
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                public?: null | boolean;
                release?: null | string;
                sessionId?: null | string;
                tags?: null | string[];
                timestamp?: null | string;
                userId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "score-create";
        } & {
            body: {
                comment?: null | string;
                configId?: null | string;
                dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
                id?: null | string;
                name: string;
                observationId?: null | string;
                traceId: string;
                value: string | number;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "span-create";
        } & {
            body: {
                endTime?: null | string;
            } & {
                id?: null | string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "span-update";
        } & {
            body: {
                endTime?: null | string;
            } & {
                id: string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "generation-create";
        } & {
            body: {
                completionStartTime?: null | string;
                costDetails?: null | {
                    [key: string]: number;
                };
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: (...)[(...)]["MapValue"];
                };
                promptName?: null | string;
                promptVersion?: null | number;
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                } | {
                    completionTokens?: null | number;
                    promptTokens?: null | number;
                    totalTokens?: null | number;
                };
                usageDetails?: {
                    [key: string]: number;
                } | {
                    completion_tokens: number;
                    completion_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    prompt_tokens: number;
                    prompt_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    total_tokens: number;
                };
            } & {
                endTime?: null | string;
            } & {
                id?: null | string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "generation-update";
        } & {
            body: {
                completionStartTime?: null | string;
                costDetails?: null | {
                    [key: string]: number;
                };
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: (...)[(...)]["MapValue"];
                };
                promptName?: null | string;
                promptVersion?: null | number;
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                } | {
                    completionTokens?: null | number;
                    promptTokens?: null | number;
                    totalTokens?: null | number;
                };
                usageDetails?: {
                    [key: string]: number;
                } | {
                    completion_tokens: number;
                    completion_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    prompt_tokens: number;
                    prompt_tokens_details?: null | {
                        [key: ...]: ...;
                    };
                    total_tokens: number;
                };
            } & {
                endTime?: null | string;
            } & {
                id: string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "event-create";
        } & {
            body: {
                id?: null | string;
            } & {
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "sdk-log";
        } & {
            body: {
                log: unknown;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "observation-create";
        } & {
            body: {
                completionStartTime?: null | string;
                endTime?: null | string;
                id?: null | string;
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: components["schemas"]["MapValue"];
                };
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                type: "SPAN" | "GENERATION" | "EVENT";
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        }
        | {
            type: "observation-update";
        } & {
            body: {
                completionStartTime?: null | string;
                endTime?: null | string;
                id?: null | string;
                input?: unknown;
                level?:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: components["schemas"]["MapValue"];
                };
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                startTime?: null | string;
                statusMessage?: null | string;
                traceId?: null | string;
                type: "SPAN" | "GENERATION" | "EVENT";
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
                version?: null | string;
            };
        } & {
            id: string;
            metadata?: unknown;
            timestamp: string;
        })[]>

Protected_fetchMedia

  • _fetchMedia(id): Promise<Omit<{
        contentLength: number;
        contentType: string;
        mediaId: string;
        uploadedAt: string;
        url: string;
        urlExpiry: string;
    }, "externalId" | "traceIdType">>

  • Parameters

    • id: string

    Returns Promise<Omit<{
        contentLength: number;
        contentType: string;
        mediaId: string;
        uploadedAt: string;
        url: string;
        urlExpiry: string;
    }, "externalId" | "traceIdType">>

Protected_getDataset

  • _getDataset(name): Promise<Omit<{
        createdAt: Date;
        description?: null | string;
        id: string;
        metadata?: any;
        name: string;
        projectId: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

  • Parameters

    • name: string

    Returns Promise<Omit<{
        createdAt: Date;
        description?: null | string;
        id: string;
        metadata?: any;
        name: string;
        projectId: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

Protected_getDatasetItems

  • _getDatasetItems(query): Promise<Omit<{
        data: {
            createdAt: string;
            datasetId: string;
            datasetName: string;
            expectedOutput?: unknown;
            id: string;
            input?: unknown;
            metadata?: unknown;
            sourceObservationId?: null | string;
            sourceTraceId?: null | string;
            status: "ACTIVE" | "ARCHIVED";
            updatedAt: string;
        }[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

  • Parameters

    • query: undefined | {
          datasetName?: null | string;
          limit?: null | number;
          page?: null | number;
          sourceObservationId?: null | string;
          sourceTraceId?: null | string;
      }

    Returns Promise<Omit<{
        data: {
            createdAt: string;
            datasetId: string;
            datasetName: string;
            expectedOutput?: unknown;
            id: string;
            input?: unknown;
            metadata?: unknown;
            sourceObservationId?: null | string;
            sourceTraceId?: null | string;
            status: "ACTIVE" | "ARCHIVED";
            updatedAt: string;
        }[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

_getFetchOptions

  • _getFetchOptions(p): LangfuseFetchOptions

  • Parameters

    • p: {
          body?: string | Buffer;
          fetchTimeout?: number;
          method:
              | "GET"
              | "POST"
              | "PUT"
              | "PATCH";
      }
      • Optionalbody?: string | Buffer
      • OptionalfetchTimeout?: number
      • method:
            | "GET"
            | "POST"
            | "PUT"
            | "PATCH"

    Returns LangfuseFetchOptions

Protected_parsePayload

  • _parsePayload(response): any

  • Parameters

    • response: any

    Returns any

_updateGeneration

  • _updateGeneration(body): this

  • Parameters

    • body: Omit<{
          completionStartTime?: null | Date;
          costDetails?: null | {
              [key: string]: number;
          };
          endTime?: null | Date;
          id: string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          model?: null | string;
          modelParameters?: null | {
              [key: string]: components["schemas"]["MapValue"];
          };
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          promptName?: null | string;
          promptVersion?: null | number;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          usage?: {
              input?: null | number;
              inputCost?: null | number;
              output?: null | number;
              outputCost?: null | number;
              total?: null | number;
              totalCost?: null | number;
              unit?:
                  | "CHARACTERS"
                  | "TOKENS"
                  | "MILLISECONDS"
                  | "SECONDS"
                  | "IMAGES"
                  | "REQUESTS";
          } | {
              completionTokens?: null | number;
              promptTokens?: null | number;
              totalTokens?: null | number;
          };
          usageDetails?: {
              [key: string]: number;
          } | {
              completion_tokens: number;
              completion_tokens_details?: null | {
                  [key: string]: number;
              };
              prompt_tokens: number;
              prompt_tokens_details?: null | {
                  [key: string]: number;
              };
              total_tokens: number;
          };
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns this

_updateSpan

  • _updateSpan(body): this

  • Parameters

    • body: Omit<{
          endTime?: null | Date;
          id: string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns this

ProtectedawaitAllQueuedAndPendingRequests

  • awaitAllQueuedAndPendingRequests(): Promise<void>

  • Returns Promise<void>

ProtectedconstructAuthorizationHeader

  • constructAuthorizationHeader(publicKey, secretKey?): {
        Authorization: string;
    }

  • Parameters

    • publicKey: string
    • OptionalsecretKey: string

    Returns {
        Authorization: string;
    }

    • Authorization: string

createDataset

  • createDataset(dataset): Promise<Omit<{
        createdAt: Date;
        description?: null | string;
        id: string;
        metadata?: any;
        name: string;
        projectId: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

  • Creates a dataset. Upserts the dataset if it already exists.

    Parameters

    • dataset: string | {
          description?: string;
          metadata?: any;
          name: string;
      }

      Can be either a string (name) or an object with name, description and metadata

    Returns Promise<Omit<{
        createdAt: Date;
        description?: null | string;
        id: string;
        metadata?: any;
        name: string;
        projectId: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

    A promise that resolves to the response of the create operation.

createDatasetItem

  • createDatasetItem(body): Promise<Omit<{
        createdAt: Date;
        datasetId: string;
        datasetName: string;
        expectedOutput?: any;
        id: string;
        input?: any;
        metadata?: any;
        sourceObservationId?: null | string;
        sourceTraceId?: null | string;
        status: "ACTIVE" | "ARCHIVED";
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

  • Creates a dataset item. Upserts the item if it already exists.

    Parameters

    • body: Omit<{
          datasetName: string;
          expectedOutput?: any;
          id?: null | string;
          input?: any;
          metadata?: any;
          sourceObservationId?: null | string;
          sourceTraceId?: null | string;
          status?: "ACTIVE" | "ARCHIVED";
      }, "externalId" | "traceIdType">

      The body of the dataset item to be created.

    Returns Promise<Omit<{
        createdAt: Date;
        datasetId: string;
        datasetName: string;
        expectedOutput?: any;
        id: string;
        input?: any;
        metadata?: any;
        sourceObservationId?: null | string;
        sourceTraceId?: null | string;
        status: "ACTIVE" | "ARCHIVED";
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

    A promise that resolves to the response of the create operation.

createDatasetRunItem

  • createDatasetRunItem(body): Promise<Omit<{
        createdAt: Date;
        datasetItemId: string;
        datasetRunId: string;
        datasetRunName: string;
        id: string;
        observationId?: null | string;
        traceId: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

  • Parameters

    • body: Omit<{
          datasetItemId: string;
          metadata?: any;
          observationId?: null | string;
          runDescription?: null | string;
          runName: string;
          traceId?: null | string;
      }, "externalId" | "traceIdType">

    Returns Promise<Omit<{
        createdAt: Date;
        datasetItemId: string;
        datasetRunId: string;
        datasetRunName: string;
        id: string;
        observationId?: null | string;
        traceId: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

createPrompt

  • createPrompt(body): Promise<ChatPromptClient>

  • Parameters

    • body: CreateChatPromptBody

    Returns Promise<ChatPromptClient>

  • createPrompt(body): Promise<TextPromptClient>

  • Parameters

    • body: CreateTextPromptBody

    Returns Promise<TextPromptClient>

createPromptStateless

  • createPromptStateless(body): Promise<{
        type: "chat";
    } & {
        prompt: {
            content: string;
            role: string;
        }[];
    } & {
        commitMessage?: null | string;
        config: unknown;
        labels: string[];
        name: string;
        tags: string[];
        version: number;
    } | {
        type: "text";
    } & {
        prompt: string;
    } & {
        commitMessage?: null | string;
        config: unknown;
        labels: string[];
        name: string;
        tags: string[];
        version: number;
    }>

  • Parameters

    • body: CreateLangfusePromptBody

    Returns Promise<{
        type: "chat";
    } & {
        prompt: {
            content: string;
            role: string;
        }[];
    } & {
        commitMessage?: null | string;
        config: unknown;
        labels: string[];
        name: string;
        tags: string[];
        version: number;
    } | {
        type: "text";
    } & {
        prompt: string;
    } & {
        commitMessage?: null | string;
        config: unknown;
        labels: string[];
        name: string;
        tags: string[];
        version: number;
    }>

debug

  • debug(enabled?): void

  • Parameters

    • Optionalenabled: boolean

    Returns void

Protectedenqueue

  • enqueue(type, body): void

  • ** QUEUEING AND FLUSHING *

    Parameters

    • type:
          | "trace-create"
          | "score-create"
          | "span-create"
          | "span-update"
          | "generation-create"
          | "generation-update"
          | "event-create"
          | "sdk-log"
          | "observation-create"
          | "observation-update"
    • body: EventBody

    Returns void

event

  • event(body): LangfuseEventClient

  • Parameters

    • body: Omit<{
          id?: null | string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns LangfuseEventClient

ProtectedeventStateless

  • eventStateless(body): string

  • Parameters

    • body: Omit<{
          id?: null | string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns string

fetch

  • fetch(url, options): Promise<LangfuseFetchResponse>

  • Parameters

    • url: string
    • options: LangfuseFetchOptions

    Returns Promise<LangfuseFetchResponse>

fetchMedia

  • fetchMedia(id): Promise<Omit<{
        contentLength: number;
        contentType: string;
        mediaId: string;
        uploadedAt: string;
        url: string;
        urlExpiry: string;
    }, "externalId" | "traceIdType">>

  • Parameters

    • id: string

    Returns Promise<Omit<{
        contentLength: number;
        contentType: string;
        mediaId: string;
        uploadedAt: string;
        url: string;
        urlExpiry: string;
    }, "externalId" | "traceIdType">>

fetchObservation

  • fetchObservation(observationId): Promise<{
        data: Omit<{
            calculatedInputCost?: null | number;
            calculatedOutputCost?: null | number;
            calculatedTotalCost?: null | number;
            completionStartTime?: null | Date;
            costDetails?: null | {
                [key: string]: number;
            };
            endTime?: null | Date;
            id: string;
            input?: any;
            inputPrice?: null | number;
            latency?: null | number;
            level:
                | "DEBUG"
                | "DEFAULT"
                | "WARNING"
                | "ERROR";
            metadata?: any;
            model?: null | string;
            modelId?: null | string;
            modelParameters?: null | {
                [key: string]: components["schemas"]["MapValue"];
            };
            name?: null | string;
            output?: any;
            outputPrice?: null | number;
            parentObservationId?: null | string;
            promptId?: null | string;
            promptName?: null | string;
            promptVersion?: null | number;
            startTime: Date;
            statusMessage?: null | string;
            timeToFirstToken?: null | number;
            totalPrice?: null | number;
            traceId?: null | string;
            type: string;
            usage?: {
                input?: null | number;
                inputCost?: null | number;
                output?: null | number;
                outputCost?: null | number;
                total?: null | number;
                totalCost?: null | number;
                unit?:
                    | "CHARACTERS"
                    | "TOKENS"
                    | "MILLISECONDS"
                    | "SECONDS"
                    | "IMAGES"
                    | "REQUESTS";
            };
            usageDetails?: null | {
                [key: string]: number;
            };
            version?: null | string;
        }, "externalId" | "traceIdType">;
    }>

  • Parameters

    • observationId: string

    Returns Promise<{
        data: Omit<{
            calculatedInputCost?: null | number;
            calculatedOutputCost?: null | number;
            calculatedTotalCost?: null | number;
            completionStartTime?: null | Date;
            costDetails?: null | {
                [key: string]: number;
            };
            endTime?: null | Date;
            id: string;
            input?: any;
            inputPrice?: null | number;
            latency?: null | number;
            level:
                | "DEBUG"
                | "DEFAULT"
                | "WARNING"
                | "ERROR";
            metadata?: any;
            model?: null | string;
            modelId?: null | string;
            modelParameters?: null | {
                [key: string]: components["schemas"]["MapValue"];
            };
            name?: null | string;
            output?: any;
            outputPrice?: null | number;
            parentObservationId?: null | string;
            promptId?: null | string;
            promptName?: null | string;
            promptVersion?: null | number;
            startTime: Date;
            statusMessage?: null | string;
            timeToFirstToken?: null | number;
            totalPrice?: null | number;
            traceId?: null | string;
            type: string;
            usage?: {
                input?: null | number;
                inputCost?: null | number;
                output?: null | number;
                outputCost?: null | number;
                total?: null | number;
                totalCost?: null | number;
                unit?:
                    | "CHARACTERS"
                    | "TOKENS"
                    | "MILLISECONDS"
                    | "SECONDS"
                    | "IMAGES"
                    | "REQUESTS";
            };
            usageDetails?: null | {
                [key: string]: number;
            };
            version?: null | string;
        }, "externalId" | "traceIdType">;
    }>

fetchObservations

  • fetchObservations(query?): Promise<Omit<{
        data: ({
            calculatedInputCost?: null | number;
            calculatedOutputCost?: null | number;
            calculatedTotalCost?: null | number;
            inputPrice?: null | number;
            latency?: null | number;
            modelId?: null | string;
            outputPrice?: null | number;
            promptName?: null | string;
            promptVersion?: null | number;
            timeToFirstToken?: null | number;
            totalPrice?: null | number;
        } & {
            completionStartTime?: null | string;
            costDetails?: null | {
                [key: string]: number;
            };
            endTime?: null | string;
            id: string;
            input?: unknown;
            level:
                | "DEBUG"
                | "DEFAULT"
                | "WARNING"
                | "ERROR";
            metadata?: unknown;
            model?: null | string;
            modelParameters?: null | {
                [key: string]: components["schemas"]["MapValue"];
            };
            name?: null | string;
            output?: unknown;
            parentObservationId?: null | string;
            promptId?: null | string;
            startTime: string;
            statusMessage?: null | string;
            traceId?: null | string;
            type: string;
            usage?: {
                input?: null | number;
                inputCost?: null | number;
                output?: null | number;
                outputCost?: null | number;
                total?: null | number;
                totalCost?: null | number;
                unit?:
                    | "CHARACTERS"
                    | "TOKENS"
                    | "MILLISECONDS"
                    | "SECONDS"
                    | "IMAGES"
                    | "REQUESTS";
            };
            usageDetails?: null | {
                [key: string]: number;
            };
            version?: null | string;
        })[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

  • Parameters

    • Optionalquery: GetLangfuseObservationsQuery

    Returns Promise<Omit<{
        data: ({
            calculatedInputCost?: null | number;
            calculatedOutputCost?: null | number;
            calculatedTotalCost?: null | number;
            inputPrice?: null | number;
            latency?: null | number;
            modelId?: null | string;
            outputPrice?: null | number;
            promptName?: null | string;
            promptVersion?: null | number;
            timeToFirstToken?: null | number;
            totalPrice?: null | number;
        } & {
            completionStartTime?: null | string;
            costDetails?: null | {
                [key: string]: number;
            };
            endTime?: null | string;
            id: string;
            input?: unknown;
            level:
                | "DEBUG"
                | "DEFAULT"
                | "WARNING"
                | "ERROR";
            metadata?: unknown;
            model?: null | string;
            modelParameters?: null | {
                [key: string]: components["schemas"]["MapValue"];
            };
            name?: null | string;
            output?: unknown;
            parentObservationId?: null | string;
            promptId?: null | string;
            startTime: string;
            statusMessage?: null | string;
            traceId?: null | string;
            type: string;
            usage?: {
                input?: null | number;
                inputCost?: null | number;
                output?: null | number;
                outputCost?: null | number;
                total?: null | number;
                totalCost?: null | number;
                unit?:
                    | "CHARACTERS"
                    | "TOKENS"
                    | "MILLISECONDS"
                    | "SECONDS"
                    | "IMAGES"
                    | "REQUESTS";
            };
            usageDetails?: null | {
                [key: string]: number;
            };
            version?: null | string;
        })[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

fetchSessions

  • fetchSessions(query?): Promise<Omit<{
        data: {
            createdAt: string;
            id: string;
            projectId: string;
        }[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

  • Parameters

    • Optionalquery: GetLangfuseSessionsQuery

    Returns Promise<Omit<{
        data: {
            createdAt: string;
            id: string;
            projectId: string;
        }[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

fetchTrace

  • fetchTrace(traceId): Promise<{
        data: Omit<{
            htmlPath: string;
            id: string;
            input?: any;
            latency: number;
            metadata?: any;
            name?: null | string;
            observations: ({
                calculatedInputCost?: null | number;
                calculatedOutputCost?: null | number;
                calculatedTotalCost?: null | number;
                inputPrice?: null | number;
                latency?: null | number;
                modelId?: null | string;
                outputPrice?: null | number;
                promptName?: null | string;
                promptVersion?: null | number;
                timeToFirstToken?: null | number;
                totalPrice?: null | number;
            } & {
                completionStartTime?: null | string;
                costDetails?: null | {
                    [key: string]: number;
                };
                endTime?: null | string;
                id: string;
                input?: unknown;
                level:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: (...)[(...)]["MapValue"];
                };
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                promptId?: null | string;
                startTime: string;
                statusMessage?: null | string;
                traceId?: null | string;
                type: string;
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
                usageDetails?: null | {
                    [key: string]: number;
                };
                version?: null | string;
            })[];
            output?: any;
            public?: null | boolean;
            release?: null | string;
            scores: ({
                dataType: "NUMERIC";
            } & {
                value: number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            } | {
                dataType: "CATEGORICAL";
            } & {
                stringValue: string;
                value?: null | number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            } | {
                dataType: "BOOLEAN";
            } & {
                stringValue: string;
                value: number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            })[];
            sessionId?: null | string;
            tags?: null | string[];
            timestamp: Date;
            totalCost: number;
            userId?: null | string;
            version?: null | string;
        }, "externalId" | "traceIdType">;
    }>

  • Parameters

    • traceId: string

    Returns Promise<{
        data: Omit<{
            htmlPath: string;
            id: string;
            input?: any;
            latency: number;
            metadata?: any;
            name?: null | string;
            observations: ({
                calculatedInputCost?: null | number;
                calculatedOutputCost?: null | number;
                calculatedTotalCost?: null | number;
                inputPrice?: null | number;
                latency?: null | number;
                modelId?: null | string;
                outputPrice?: null | number;
                promptName?: null | string;
                promptVersion?: null | number;
                timeToFirstToken?: null | number;
                totalPrice?: null | number;
            } & {
                completionStartTime?: null | string;
                costDetails?: null | {
                    [key: string]: number;
                };
                endTime?: null | string;
                id: string;
                input?: unknown;
                level:
                    | "DEBUG"
                    | "DEFAULT"
                    | "WARNING"
                    | "ERROR";
                metadata?: unknown;
                model?: null | string;
                modelParameters?: null | {
                    [key: string]: (...)[(...)]["MapValue"];
                };
                name?: null | string;
                output?: unknown;
                parentObservationId?: null | string;
                promptId?: null | string;
                startTime: string;
                statusMessage?: null | string;
                traceId?: null | string;
                type: string;
                usage?: {
                    input?: null | number;
                    inputCost?: null | number;
                    output?: null | number;
                    outputCost?: null | number;
                    total?: null | number;
                    totalCost?: null | number;
                    unit?:
                        | "CHARACTERS"
                        | "TOKENS"
                        | "MILLISECONDS"
                        | "SECONDS"
                        | "IMAGES"
                        | "REQUESTS";
                };
                usageDetails?: null | {
                    [key: string]: number;
                };
                version?: null | string;
            })[];
            output?: any;
            public?: null | boolean;
            release?: null | string;
            scores: ({
                dataType: "NUMERIC";
            } & {
                value: number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            } | {
                dataType: "CATEGORICAL";
            } & {
                stringValue: string;
                value?: null | number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            } | {
                dataType: "BOOLEAN";
            } & {
                stringValue: string;
                value: number;
            } & {
                authorUserId?: null | string;
                comment?: null | string;
                configId?: null | string;
                createdAt: string;
                id: string;
                name: string;
                observationId?: null | string;
                queueId?: null | string;
                source: "ANNOTATION" | "API" | "EVAL";
                timestamp: string;
                traceId: string;
                updatedAt: string;
            })[];
            sessionId?: null | string;
            tags?: null | string[];
            timestamp: Date;
            totalCost: number;
            userId?: null | string;
            version?: null | string;
        }, "externalId" | "traceIdType">;
    }>

fetchTraces

  • fetchTraces(query?): Promise<Omit<{
        data: ({
            htmlPath: string;
            latency: number;
            observations: string[];
            scores: string[];
            totalCost: number;
        } & {
            id: string;
            input?: unknown;
            metadata?: unknown;
            name?: null | string;
            output?: unknown;
            public?: null | boolean;
            release?: null | string;
            sessionId?: null | string;
            tags?: null | string[];
            timestamp: string;
            userId?: null | string;
            version?: null | string;
        })[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

  • Parameters

    • Optionalquery: GetLangfuseTracesQuery

    Returns Promise<Omit<{
        data: ({
            htmlPath: string;
            latency: number;
            observations: string[];
            scores: string[];
            totalCost: number;
        } & {
            id: string;
            input?: unknown;
            metadata?: unknown;
            name?: null | string;
            output?: unknown;
            public?: null | boolean;
            release?: null | string;
            sessionId?: null | string;
            tags?: null | string[];
            timestamp: string;
            userId?: null | string;
            version?: null | string;
        })[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

ProtectedfindAndProcessMedia

  • findAndProcessMedia(__namedParameters): Promise<any>

  • Parameters

    • __namedParameters: {
          data: any;
          field: "input" | "output" | "metadata";
          observationId?: string;
          traceId: string;
      }
      • data: any
      • field: "input" | "output" | "metadata"
      • OptionalobservationId?: string
      • traceId: string

    Returns Promise<any>

flush

  • flush(callback?): void

  • Parameters

    • Optionalcallback: ((err?: any, data?: any) => void)
        • (err?, data?): void

        • Parameters

          • Optionalerr: any
          • Optionaldata: any

          Returns void

    Returns void

flushAsync

  • flushAsync(): Promise<void>

  • Asynchronously flushes all events that are not yet sent to the server. This function always resolves, even if there were errors when flushing. Errors are emitted as "error" events and the promise resolves.

    Returns Promise<void>

    A promise that resolves when the flushing is completed.

generation

  • generation(body): LangfuseGenerationClient

  • Parameters

    • body: Omit<Omit<{
          completionStartTime?: null | Date;
          costDetails?: null | {
              [key: string]: number;
          };
          endTime?: null | Date;
          id?: null | string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          model?: null | string;
          modelParameters?: null | {
              [key: string]: components["schemas"]["MapValue"];
          };
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          promptName?: null | string;
          promptVersion?: null | number;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          usage?: {
              input?: null | number;
              inputCost?: null | number;
              output?: null | number;
              outputCost?: null | number;
              total?: null | number;
              totalCost?: null | number;
              unit?:
                  | "CHARACTERS"
                  | "TOKENS"
                  | "MILLISECONDS"
                  | "SECONDS"
                  | "IMAGES"
                  | "REQUESTS";
          } | {
              completionTokens?: null | number;
              promptTokens?: null | number;
              totalTokens?: null | number;
          };
          usageDetails?: {
              [key: string]: number;
          } | {
              completion_tokens: number;
              completion_tokens_details?: null | {
                  [key: string]: number;
              };
              prompt_tokens: number;
              prompt_tokens_details?: null | {
                  [key: string]: number;
              };
              total_tokens: number;
          };
          version?: null | string;
      }, "externalId" | "traceIdType">, "promptName" | "promptVersion"> & PromptInput

    Returns LangfuseGenerationClient

ProtectedgenerationStateless

  • generationStateless(body): string

  • Parameters

    • body: Omit<Omit<{
          completionStartTime?: null | Date;
          costDetails?: null | {
              [key: string]: number;
          };
          endTime?: null | Date;
          id?: null | string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          model?: null | string;
          modelParameters?: null | {
              [key: string]: components["schemas"]["MapValue"];
          };
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          promptName?: null | string;
          promptVersion?: null | number;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          usage?: {
              input?: null | number;
              inputCost?: null | number;
              output?: null | number;
              outputCost?: null | number;
              total?: null | number;
              totalCost?: null | number;
              unit?:
                  | "CHARACTERS"
                  | "TOKENS"
                  | "MILLISECONDS"
                  | "SECONDS"
                  | "IMAGES"
                  | "REQUESTS";
          } | {
              completionTokens?: null | number;
              promptTokens?: null | number;
              totalTokens?: null | number;
          };
          usageDetails?: {
              [key: string]: number;
          } | {
              completion_tokens: number;
              completion_tokens_details?: null | {
                  [key: string]: number;
              };
              prompt_tokens: number;
              prompt_tokens_details?: null | {
                  [key: string]: number;
              };
              total_tokens: number;
          };
          version?: null | string;
      }, "externalId" | "traceIdType">, "promptName" | "promptVersion"> & PromptInput

    Returns string

ProtectedgetCommonEventProperties

  • getCommonEventProperties(): any

  • Returns any

getCustomUserAgent

  • getCustomUserAgent(): void

  • Returns void

getDataset

  • getDataset(name, options?): Promise<{
        description?: string;
        id: string;
        items: DatasetItem[];
        metadata?: any;
        name: string;
        projectId: string;
    }>

  • Parameters

    • name: string
    • Optionaloptions: {
          fetchItemsPageSize: number;
      }
      • fetchItemsPageSize: number

    Returns Promise<{
        description?: string;
        id: string;
        items: DatasetItem[];
        metadata?: any;
        name: string;
        projectId: string;
    }>

getDatasetItem

  • getDatasetItem(id): Promise<Omit<{
        createdAt: Date;
        datasetId: string;
        datasetName: string;
        expectedOutput?: any;
        id: string;
        input?: any;
        metadata?: any;
        sourceObservationId?: null | string;
        sourceTraceId?: null | string;
        status: "ACTIVE" | "ARCHIVED";
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

  • Parameters

    • id: string

    Returns Promise<Omit<{
        createdAt: Date;
        datasetId: string;
        datasetName: string;
        expectedOutput?: any;
        id: string;
        input?: any;
        metadata?: any;
        sourceObservationId?: null | string;
        sourceTraceId?: null | string;
        status: "ACTIVE" | "ARCHIVED";
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

getDatasetRun

  • getDatasetRun(params): Promise<Omit<{
        createdAt: Date;
        datasetId: string;
        datasetName: string;
        datasetRunItems: {
            createdAt: string;
            datasetItemId: string;
            datasetRunId: string;
            datasetRunName: string;
            id: string;
            observationId?: null | string;
            traceId: string;
            updatedAt: string;
        }[];
        description?: null | string;
        id: string;
        metadata?: any;
        name: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

  • Parameters

    • params: Omit<{
          datasetName: string;
          runName: string;
      }, "externalId" | "traceIdType">

    Returns Promise<Omit<{
        createdAt: Date;
        datasetId: string;
        datasetName: string;
        datasetRunItems: {
            createdAt: string;
            datasetItemId: string;
            datasetRunId: string;
            datasetRunName: string;
            id: string;
            observationId?: null | string;
            traceId: string;
            updatedAt: string;
        }[];
        description?: null | string;
        id: string;
        metadata?: any;
        name: string;
        updatedAt: Date;
    }, "externalId" | "traceIdType">>

getDatasetRuns

  • getDatasetRuns(datasetName, query?): Promise<Omit<{
        data: {
            createdAt: string;
            datasetId: string;
            datasetName: string;
            description?: null | string;
            id: string;
            metadata?: unknown;
            name: string;
            updatedAt: string;
        }[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

  • Parameters

    • datasetName: string
    • Optionalquery: {
          limit?: null | number;
          page?: null | number;
      }
      • Optionallimit?: null | number

        Description

        limit of items per page

      • Optionalpage?: null | number

        Description

        page number, starts at 1

    Returns Promise<Omit<{
        data: {
            createdAt: string;
            datasetId: string;
            datasetName: string;
            description?: null | string;
            id: string;
            metadata?: unknown;
            name: string;
            updatedAt: string;
        }[];
        meta: {
            limit: number;
            page: number;
            totalItems: number;
            totalPages: number;
        };
    }, "externalId" | "traceIdType">>

getLibraryId

  • getLibraryId(): string

  • Returns string

getLibraryVersion

  • getLibraryVersion(): string

  • Returns string

getPersistedProperty

  • getPersistedProperty<T>(key): undefined | T

  • Type Parameters

    • T

    Parameters

    • key: LangfusePersistedProperty

    Returns undefined | T

getPrompt

  • getPrompt(name, version?, options?): Promise<TextPromptClient>

  • Parameters

    • name: string
    • Optionalversion: number
    • Optionaloptions: {
          cacheTtlSeconds?: number;
          fallback?: string;
          fetchTimeoutMs?: number;
          label?: string;
          maxRetries?: number;
          type?: "text";
      }
      • OptionalcacheTtlSeconds?: number
      • Optionalfallback?: string
      • OptionalfetchTimeoutMs?: number
      • Optionallabel?: string
      • OptionalmaxRetries?: number
      • Optionaltype?: "text"

    Returns Promise<TextPromptClient>

  • getPrompt(name, version?, options?): Promise<ChatPromptClient>

  • Parameters

    • name: string
    • Optionalversion: number
    • Optionaloptions: {
          cacheTtlSeconds?: number;
          fallback?: Omit<{
              content: string;
              role: string;
          }, "externalId" | "traceIdType">[];
          fetchTimeoutMs?: number;
          label?: string;
          maxRetries?: number;
          type: "chat";
      }
      • OptionalcacheTtlSeconds?: number
      • Optionalfallback?: Omit<{
            content: string;
            role: string;
        }, "externalId" | "traceIdType">[]
      • OptionalfetchTimeoutMs?: number
      • Optionallabel?: string
      • OptionalmaxRetries?: number
      • type: "chat"

    Returns Promise<ChatPromptClient>

getPromptStateless

  • getPromptStateless(name, version?, label?, maxRetries?, requestTimeout?): Promise<GetLangfusePromptResponse>

  • Parameters

    • name: string
    • Optionalversion: number
    • Optionallabel: string
    • OptionalmaxRetries: number
    • OptionalrequestTimeout: number

    Returns Promise<GetLangfusePromptResponse>

getSdkIntegration

  • getSdkIntegration(): string

  • Returns string

on

  • on(event, cb): (() => void)

  • Parameters

    • event: string
    • cb: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    Returns (() => void)

      • (): void

      • Returns void

ProtectedparseTraceId

  • parseTraceId(type, body): undefined | null | string

  • Parameters

    • type:
          | "trace-create"
          | "score-create"
          | "span-create"
          | "span-update"
          | "generation-create"
          | "generation-update"
          | "event-create"
          | "sdk-log"
          | "observation-create"
          | "observation-update"
    • body: EventBody

    Returns undefined | null | string

ProtectedprocessEnqueueEvent

  • processEnqueueEvent(type, body): Promise<void>

  • Parameters

    • type:
          | "trace-create"
          | "score-create"
          | "span-create"
          | "span-update"
          | "generation-create"
          | "generation-update"
          | "event-create"
          | "sdk-log"
          | "observation-create"
          | "observation-update"
    • body: EventBody

    Returns Promise<void>

ProtectedprocessMediaInEvent

  • processMediaInEvent(type, body): Promise<void>

  • Parameters

    • type:
          | "trace-create"
          | "score-create"
          | "span-create"
          | "span-update"
          | "generation-create"
          | "generation-update"
          | "event-create"
          | "sdk-log"
          | "observation-create"
          | "observation-update"
    • body: EventBody

    Returns Promise<void>

processQueueItems

  • processQueueItems(queue, MAX_MSG_SIZE, BATCH_SIZE_LIMIT): {
        processedItems: LangfuseQueueItem[];
        remainingItems: LangfuseQueueItem[];
    }

  • Parameters

    • queue: LangfuseQueueItem[]
    • MAX_MSG_SIZE: number
    • BATCH_SIZE_LIMIT: number

    Returns {
        processedItems: LangfuseQueueItem[];
        remainingItems: LangfuseQueueItem[];
    }

    • processedItems: LangfuseQueueItem[]
    • remainingItems: LangfuseQueueItem[]

resolveMediaReferences

  • resolveMediaReferences<T>(params): Promise<T>

  • Replaces the media reference strings in an object with base64 data URIs for the media content.

    This method recursively traverses an object (up to a maximum depth of 10) looking for media reference strings in the format "@@@langfuseMedia:...@@@". When found, it fetches the actual media content using the provided Langfuse client and replaces the reference string with a base64 data URI.

    If fetching media content fails for a reference string, a warning is logged and the reference string is left unchanged.

    Type Parameters

    • T

    Parameters

    • params: Omit<LangfuseMediaResolveMediaReferencesParams<T>, "langfuseClient">

      Configuration object

    Returns Promise<T>

    A deep copy of the input object with all media references replaced with base64 data URIs where possible

    Example

    const obj = {
      image: "@@@langfuseMedia:type=image/jpeg|id=123|source=bytes@@@",
      nested: {
        pdf: "@@@langfuseMedia:type=application/pdf|id=456|source=bytes@@@"
      }
    };

    const result = await LangfuseMedia.resolveMediaReferences({
      obj,
      langfuseClient
    });

    // Result:
    // {
    //   image: "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
    //   nested: {
    //     pdf: "data:application/pdf;base64,JVBERi0xLjcK..."
    //   }
    // }

score

  • score(body): this

  • Parameters

    • body: Omit<{
          comment?: null | string;
          configId?: null | string;
          dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
          id?: null | string;
          name: string;
          observationId?: null | string;
          traceId: string;
          value: string | number;
      }, "externalId" | "traceIdType">

    Returns this

ProtectedscoreStateless

  • scoreStateless(body): string

  • Parameters

    • body: Omit<{
          comment?: null | string;
          configId?: null | string;
          dataType?: "NUMERIC" | "BOOLEAN" | "CATEGORICAL";
          id?: null | string;
          name: string;
          observationId?: null | string;
          traceId: string;
          value: string | number;
      }, "externalId" | "traceIdType">

    Returns string

setPersistedProperty

  • setPersistedProperty<T>(key, value): void

  • Type Parameters

    • T

    Parameters

    • key: LangfusePersistedProperty
    • value: null | T

    Returns void

shutdown

  • shutdown(): void

  • Returns void

shutdownAsync

  • shutdownAsync(): Promise<void>

  • Returns Promise<void>

span

  • span(body): LangfuseSpanClient

  • Parameters

    • body: Omit<{
          endTime?: null | Date;
          id?: null | string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns LangfuseSpanClient

ProtectedspanStateless

  • spanStateless(body): string

  • Parameters

    • body: Omit<{
          endTime?: null | Date;
          id?: null | string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns string

trace

  • trace(body?): LangfuseTraceClient

  • Parameters

    • Optionalbody: Omit<{
          id?: null | string;
          input?: any;
          metadata?: any;
          name?: null | string;
          output?: any;
          public?: null | boolean;
          release?: null | string;
          sessionId?: null | string;
          tags?: null | string[];
          timestamp?: null | Date;
          userId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns LangfuseTraceClient

ProtectedtraceStateless

  • traceStateless(body): string

  • ** Handlers for each object type *

    Parameters

    • body: Omit<{
          id?: null | string;
          input?: any;
          metadata?: any;
          name?: null | string;
          output?: any;
          public?: null | boolean;
          release?: null | string;
          sessionId?: null | string;
          tags?: null | string[];
          timestamp?: null | Date;
          userId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns string

ProtectedtruncateEventBody

  • truncateEventBody(body, maxByteSize): EventBody

  • Truncates the event body if its byte size exceeds the specified maximum byte size. Emits a warning event if truncation occurs. The fields that may be truncated are: "input", "output", and "metadata". The fields are truncated in the order of their size, from largest to smallest until the total byte size is within the limit.

    Parameters

    • body: EventBody
    • maxByteSize: number

    Returns EventBody

ProtectedupdateGenerationStateless

  • updateGenerationStateless(body): string

  • Parameters

    • body: Omit<Omit<{
          completionStartTime?: null | Date;
          costDetails?: null | {
              [key: string]: number;
          };
          endTime?: null | Date;
          id: string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          model?: null | string;
          modelParameters?: null | {
              [key: string]: components["schemas"]["MapValue"];
          };
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          promptName?: null | string;
          promptVersion?: null | number;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          usage?: {
              input?: null | number;
              inputCost?: null | number;
              output?: null | number;
              outputCost?: null | number;
              total?: null | number;
              totalCost?: null | number;
              unit?:
                  | "CHARACTERS"
                  | "TOKENS"
                  | "MILLISECONDS"
                  | "SECONDS"
                  | "IMAGES"
                  | "REQUESTS";
          } | {
              completionTokens?: null | number;
              promptTokens?: null | number;
              totalTokens?: null | number;
          };
          usageDetails?: {
              [key: string]: number;
          } | {
              completion_tokens: number;
              completion_tokens_details?: null | {
                  [key: string]: number;
              };
              prompt_tokens: number;
              prompt_tokens_details?: null | {
                  [key: string]: number;
              };
              total_tokens: number;
          };
          version?: null | string;
      }, "externalId" | "traceIdType">, "promptName" | "promptVersion"> & PromptInput

    Returns string

updatePrompt

  • updatePrompt(body): Promise<LangfusePromptClient>

  • Parameters

    • body: {
          name: string;
          newLabels: string[];
          version: number;
      }
      • name: string
      • newLabels: string[]
      • version: number

    Returns Promise<LangfusePromptClient>

updatePromptStateless

  • updatePromptStateless(body): Promise<LangfusePromptClient>

  • Parameters

    • body: Omit<{
          newLabels: string[];
      }, "externalId" | "traceIdType"> & {
          name: string;
          version: number;
      }

    Returns Promise<LangfusePromptClient>

ProtectedupdateSpanStateless

  • updateSpanStateless(body): string

  • Parameters

    • body: Omit<{
          endTime?: null | Date;
          id: string;
          input?: any;
          level?:
              | "DEBUG"
              | "DEFAULT"
              | "WARNING"
              | "ERROR";
          metadata?: any;
          name?: null | string;
          output?: any;
          parentObservationId?: null | string;
          startTime?: null | Date;
          statusMessage?: null | string;
          traceId?: null | string;
          version?: null | string;
      }, "externalId" | "traceIdType">

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
_exportLocalEvents_fetchMedia_getDataset_getDatasetItems_getFetchOptions_parsePayload_updateGeneration_updateSpanawaitAllQueuedAndPendingRequestsconstructAuthorizationHeadercreateDatasetcreateDatasetItemcreateDatasetRunItemcreatePromptcreatePromptStatelessdebugenqueueeventeventStatelessfetchfetchMediafetchObservationfetchObservationsfetchSessionsfetchTracefetchTracesfindAndProcessMediaflushflushAsyncgenerationgenerationStatelessgetCommonEventPropertiesgetCustomUserAgentgetDatasetgetDatasetItemgetDatasetRungetDatasetRunsgetLibraryIdgetLibraryVersiongetPersistedPropertygetPromptgetPromptStatelessgetSdkIntegrationonparseTraceIdprocessEnqueueEventprocessMediaInEventprocessQueueItemsresolveMediaReferencesscorescoreStatelesssetPersistedPropertyshutdownshutdownAsyncspanspanStatelesstracetraceStatelesstruncateEventBodyupdateGenerationStatelessupdatePromptupdatePromptStatelessupdateSpanStateless