Class LangfuseWeb

Hierarchy

LangfuseWebStateless
- LangfuseWeb

Constructors

constructor

new LangfuseWeb(params?): LangfuseWeb
Parameters
- Optionalparams: Omit<LangfuseOptions, "secretKey">
Returns LangfuseWeb
Overrides LangfuseWebStateless.constructor
- Defined in langfuse/src/langfuse.ts:85

Properties

`Protected`_events

_events: SimpleEventEmitter

`Protected` `Optional`_flushTimer

_flushTimer?: any

`Protected`_retryOptions

_retryOptions: RetriableOptions

baseUrl

baseUrl: string

Methods

`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">>
Inherited from LangfuseWebStateless._getDataset
- Defined in langfuse-core/lib/index.d.ts:3736

`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">>
Inherited from LangfuseWebStateless._getDatasetItems
- Defined in langfuse-core/lib/index.d.ts:3737

_getFetchOptions

_getFetchOptions(p): LangfuseFetchOptions
Parameters
- p: {
      body?: string;
      fetchTimeout?: number;
      method:
          | "GET"
          | "POST"
          | "PUT"
          | "PATCH";
  }
  - Optionalbody?: string
  - OptionalfetchTimeout?: number
  - method:
        | "GET"
        | "POST"
        | "PUT"
        | "PATCH"
Returns LangfuseFetchOptions
Inherited from LangfuseWebStateless._getFetchOptions
- Defined in langfuse-core/lib/index.d.ts:3797

`Protected`_parsePayload

_parsePayload(response): any
Parameters
- response: any
Returns any
Inherited from LangfuseWebStateless._parsePayload
- Defined in langfuse-core/lib/index.d.ts:3768

`Protected`awaitAllQueuedAndPendingRequests

awaitAllQueuedAndPendingRequests(): Promise<void>
Returns Promise<void>
Inherited from LangfuseWebStateless.awaitAllQueuedAndPendingRequests
- Defined in langfuse-core/lib/index.d.ts:3807

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.
Inherited from LangfuseWebStateless.createDataset
- Defined in langfuse-core/lib/index.d.ts:3756

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.
Inherited from LangfuseWebStateless.createDatasetItem
- Defined in langfuse-core/lib/index.d.ts:3766

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">>
Inherited from LangfuseWebStateless.createDatasetRunItem
- Defined in langfuse-core/lib/index.d.ts:3749

createPromptStateless

createPromptStateless(body): Promise<{
    type: "chat";
} & {
    prompt: {
        content: string;
        role: string;
    }[];
} & {
    config: unknown;
    labels: string[];
    name: string;
    tags: string[];
    version: number;
} | {
    type: "text";
} & {
    prompt: string;
} & {
    config: unknown;
    labels: string[];
    name: string;
    tags: string[];
    version: number;
}>
Parameters
- body: CreateLangfusePromptBody
Returns Promise<{
    type: "chat";
} & {
    prompt: {
        content: string;
        role: string;
    }[];
} & {
    config: unknown;
    labels: string[];
    name: string;
    tags: string[];
    version: number;
} | {
    type: "text";
} & {
    prompt: string;
} & {
    config: unknown;
    labels: string[];
    name: string;
    tags: string[];
    version: number;
}>
Inherited from LangfuseWebStateless.createPromptStateless
- Defined in langfuse-core/lib/index.d.ts:3769

debug

debug(enabled?): void
Parameters
- Optionalenabled: boolean
Returns void
Inherited from LangfuseWebStateless.debug
- Defined in langfuse-core/lib/index.d.ts:3725

`Protected`enqueue

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
Inherited from LangfuseWebStateless.enqueue
- Defined in langfuse-core/lib/index.d.ts:3775

`Protected`eventStateless

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
Inherited from LangfuseWebStateless.eventStateless
- Defined in langfuse-core/lib/index.d.ts:3730

fetch

fetch(url, options): Promise<LangfuseFetchResponse>
Parameters
- url: string
- options: LangfuseFetchOptions
Returns Promise<LangfuseFetchResponse>
Overrides LangfuseWebStateless.fetch
- Defined in langfuse/src/langfuse.ts:122

fetchObservation

fetchObservation(observationId): Promise<{
    data: Omit<{
        calculatedInputCost?: null | number;
        calculatedOutputCost?: null | number;
        calculatedTotalCost?: null | number;
        completionStartTime?: null | Date;
        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"] | undefined;
        };
        name?: null | string;
        output?: any;
        outputPrice?: null | number;
        parentObservationId?: null | string;
        promptId?: null | string;
        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";
        };
        version?: null | string;
    }, "externalId" | "traceIdType">;
}>
Parameters
- observationId: string
Returns Promise<{
    data: Omit<{
        calculatedInputCost?: null | number;
        calculatedOutputCost?: null | number;
        calculatedTotalCost?: null | number;
        completionStartTime?: null | Date;
        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"] | undefined;
        };
        name?: null | string;
        output?: any;
        outputPrice?: null | number;
        parentObservationId?: null | string;
        promptId?: null | string;
        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";
        };
        version?: null | string;
    }, "externalId" | "traceIdType">;
}>
Inherited from LangfuseWebStateless.fetchObservation
- Defined in langfuse-core/lib/index.d.ts:3743

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;
        timeToFirstToken?: null | number;
        totalPrice?: null | number;
    } & {
        completionStartTime?: null | string;
        endTime?: null | string;
        id: string;
        input?: unknown;
        level:
            | "DEBUG"
            | "DEFAULT"
            | "WARNING"
            | "ERROR";
        metadata?: unknown;
        model?: null | string;
        modelParameters?: null | {
            [key: string]: (...)[(...)]["MapValue"] | undefined;
        };
        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";
        };
        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;
        timeToFirstToken?: null | number;
        totalPrice?: null | number;
    } & {
        completionStartTime?: null | string;
        endTime?: null | string;
        id: string;
        input?: unknown;
        level:
            | "DEBUG"
            | "DEFAULT"
            | "WARNING"
            | "ERROR";
        metadata?: unknown;
        model?: null | string;
        modelParameters?: null | {
            [key: string]: (...)[(...)]["MapValue"] | undefined;
        };
        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";
        };
        version?: null | string;
    })[];
    meta: {
        limit: number;
        page: number;
        totalItems: number;
        totalPages: number;
    };
}, "externalId" | "traceIdType">>
Inherited from LangfuseWebStateless.fetchObservations
- Defined in langfuse-core/lib/index.d.ts:3742

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">>
Inherited from LangfuseWebStateless.fetchSessions
- Defined in langfuse-core/lib/index.d.ts:3746

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;
            timeToFirstToken?: null | number;
            totalPrice?: null | number;
        } & {
            completionStartTime?: null | string;
            endTime?: null | string;
            id: string;
            input?: unknown;
            level:
                | "DEBUG"
                | "DEFAULT"
                | "WARNING"
                | "ERROR";
            metadata?: unknown;
            model?: null | string;
            modelParameters?: null | {
                [key: string]: (...)[(...)] | undefined;
            };
            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";
            };
            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;
            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;
            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;
            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;
            timeToFirstToken?: null | number;
            totalPrice?: null | number;
        } & {
            completionStartTime?: null | string;
            endTime?: null | string;
            id: string;
            input?: unknown;
            level:
                | "DEBUG"
                | "DEFAULT"
                | "WARNING"
                | "ERROR";
            metadata?: unknown;
            model?: null | string;
            modelParameters?: null | {
                [key: string]: (...)[(...)] | undefined;
            };
            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";
            };
            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;
            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;
            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;
            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">;
}>
Inherited from LangfuseWebStateless.fetchTrace
- Defined in langfuse-core/lib/index.d.ts:3739

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">>
Inherited from LangfuseWebStateless.fetchTraces
- Defined in langfuse-core/lib/index.d.ts:3738

flush

flush(callback?): void
Parameters
- Optionalcallback: ((err?: any, data?: any) => void)
  - - (err?, data?): void
    - Parameters
      Optionalerr: any
      Optionaldata: any
      Returns void
Returns void
Inherited from LangfuseWebStateless.flush
- Defined in langfuse-core/lib/index.d.ts:3792

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.
Inherited from LangfuseWebStateless.flushAsync
- Defined in langfuse-core/lib/index.d.ts:3791

`Protected`generationStateless

generationStateless(body): string
Parameters
- body: Omit<Omit<{
      completionStartTime?: null | Date;
      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"] | undefined;
      };
      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;
      };
      version?: null | string;
  }, "externalId" | "traceIdType">, "promptName" | "promptVersion"> & PromptInput
Returns string
Inherited from LangfuseWebStateless.generationStateless
- Defined in langfuse-core/lib/index.d.ts:3732

`Protected`getCommonEventProperties

getCommonEventProperties(): any
Returns any
Inherited from LangfuseWebStateless.getCommonEventProperties
- Defined in langfuse-core/lib/index.d.ts:3723

getCustomUserAgent

getCustomUserAgent(): void
Returns void
- Defined in langfuse/src/langfuse.ts:134

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">>
Inherited from LangfuseWebStateless.getDatasetItem
- Defined in langfuse-core/lib/index.d.ts:3767

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">>
Inherited from LangfuseWebStateless.getDatasetRun
- Defined in langfuse-core/lib/index.d.ts:3747

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">>
Inherited from LangfuseWebStateless.getDatasetRuns
- Defined in langfuse-core/lib/index.d.ts:3748

getLibraryId

getLibraryId(): string
Returns string
Overrides LangfuseWebStateless.getLibraryId
- Defined in langfuse/src/langfuse.ts:126

getLibraryVersion

getLibraryVersion(): string
Returns string
Overrides LangfuseWebStateless.getLibraryVersion
- Defined in langfuse/src/langfuse.ts:130

getPersistedProperty

getPersistedProperty<T>(key): undefined | T
Type Parameters
- T
Parameters
- key: LangfusePersistedProperty
Returns undefined | T
Overrides LangfuseWebStateless.getPersistedProperty
- Defined in langfuse/src/langfuse.ts:100

getPromptStateless

getPromptStateless(name, version?, label?, maxRetries?, requestTimeout?): Promise<GetLangfusePromptResponse>
Parameters
- name: string
- Optionalversion: number
- Optionallabel: string
- OptionalmaxRetries: number
- OptionalrequestTimeout: number
Returns Promise<GetLangfusePromptResponse>
Inherited from LangfuseWebStateless.getPromptStateless
- Defined in langfuse-core/lib/index.d.ts:3770

getSdkIntegration

getSdkIntegration(): string
Returns string
Inherited from LangfuseWebStateless.getSdkIntegration
- Defined in langfuse-core/lib/index.d.ts:3722

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
Inherited from LangfuseWebStateless.on
- Defined in langfuse-core/lib/index.d.ts:3724

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[]
Inherited from LangfuseWebStateless.processQueueItems
- Defined in langfuse-core/lib/index.d.ts:3793

score

score(body): Promise<LangfuseWeb>
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 Promise<LangfuseWeb>
Inherited from LangfuseWebStateless.score
- Defined in langfuse-core/lib/index.d.ts:3811

`Protected`scoreStateless

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
Inherited from LangfuseWebStateless.scoreStateless
- Defined in langfuse-core/lib/index.d.ts:3733

setPersistedProperty

setPersistedProperty<T>(key, value): void
Type Parameters
- T
Parameters
- key: LangfusePersistedProperty
- value: null | T
Returns void
Overrides LangfuseWebStateless.setPersistedProperty
- Defined in langfuse/src/langfuse.ts:108

shutdown

shutdown(): void
Returns void
Inherited from LangfuseWebStateless.shutdown
- Defined in langfuse-core/lib/index.d.ts:3806

shutdownAsync

shutdownAsync(): Promise<void>
Returns Promise<void>
Inherited from LangfuseWebStateless.shutdownAsync
- Defined in langfuse-core/lib/index.d.ts:3805

`Protected`spanStateless

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
Inherited from LangfuseWebStateless.spanStateless
- Defined in langfuse-core/lib/index.d.ts:3731

`Protected`traceStateless

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
Inherited from LangfuseWebStateless.traceStateless
- Defined in langfuse-core/lib/index.d.ts:3729

`Protected`truncateEventBody

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
Inherited from LangfuseWebStateless.truncateEventBody
- Defined in langfuse-core/lib/index.d.ts:3782

`Protected`updateGenerationStateless

updateGenerationStateless(body): string
Parameters
- body: Omit<Omit<{
      completionStartTime?: null | Date;
      endTime?: null | Date;
      id: string;
      input?: any;
      level?:
          | "DEBUG"
          | "DEFAULT"
          | "WARNING"
          | "ERROR";
      metadata?: any;
      model?: null | string;
      modelParameters?: null | {
          [key: string]: components["schemas"]["MapValue"] | undefined;
      };
      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;
      };
      version?: null | string;
  }, "externalId" | "traceIdType">, "promptName" | "promptVersion"> & PromptInput
Returns string
Inherited from LangfuseWebStateless.updateGenerationStateless
- Defined in langfuse-core/lib/index.d.ts:3735

`Protected`updateSpanStateless

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
Inherited from LangfuseWebStateless.updateSpanStateless
- Defined in langfuse-core/lib/index.d.ts:3734

Class LangfuseWeb

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LangfuseWeb

Properties

Protected_events

Protected Optional_flushTimer

Protected_retryOptions

baseUrl

Methods

Protected_getDataset

Parameters

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

Protected_getDatasetItems

Parameters

_getFetchOptions

Parameters

Optionalbody?: string

OptionalfetchTimeout?: number

method: | "GET" | "POST" | "PUT" | "PATCH"

Returns LangfuseFetchOptions

Protected_parsePayload

Parameters

Returns any

ProtectedawaitAllQueuedAndPendingRequests

Returns Promise<void>

createDataset

Parameters

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

createDatasetItem

Parameters

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">>

createDatasetRunItem

Parameters

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

createPromptStateless

Parameters

debug

Parameters

Returns void

Protectedenqueue

Parameters

Returns void

ProtectedeventStateless

Parameters

Returns string

fetch

Parameters

Returns Promise<LangfuseFetchResponse>

fetchObservation

Parameters

fetchObservations

Parameters

fetchSessions

Parameters

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

fetchTrace

Parameters

fetchTraces

Parameters

flush

Parameters

Parameters

Returns void

Returns void

flushAsync

Returns Promise<void>

ProtectedgenerationStateless

Parameters

Returns string

ProtectedgetCommonEventProperties

Returns any

getCustomUserAgent

Returns void

`Protected`_events

`Protected` `Optional`_flushTimer

`Protected`_retryOptions

`Protected`_getDataset

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

`Protected`_getDatasetItems

`Optional`body?: string

`Optional`fetchTimeout?: number

method:
| "GET"
| "POST"
| "PUT"
| "PATCH"

`Protected`_parsePayload

`Protected`awaitAllQueuedAndPendingRequests

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

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">>

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

`Protected`enqueue

`Protected`eventStateless

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

`Protected`generationStateless

`Protected`getCommonEventProperties

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">>

`Optional`limit?: null | number

`Optional`page?: null | number

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

`Protected`scoreStateless

`Protected`spanStateless

`Protected`traceStateless

`Protected`truncateEventBody

`Protected`updateGenerationStateless

`Protected`updateSpanStateless