Class Langfuse

Hierarchy

LangfuseCore
- Langfuse

Index

Constructors

constructor

Properties

_events _flushTimer? _retryOptions additionalHeaders baseUrl isLocalEventExportEnabled

Methods

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
Overrides LangfuseCore.constructor
- Defined in langfuse/src/langfuse.ts:28

Properties

`Protected`_events

_events: SimpleEventEmitter

`Protected` `Optional`_flushTimer

_flushTimer?: any

`Protected`_retryOptions

_retryOptions: RetriableOptions

additionalHeaders

additionalHeaders: Record<string, string>

baseUrl

baseUrl: string

`Protected`isLocalEventExportEnabled

isLocalEventExportEnabled: boolean

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;
            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;
            };
        } & {
            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;
            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;
            };
        } & {
            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;
            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;
            };
        } & {
            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;
            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;
            };
        } & {
            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;
    })[]>
Inherited from LangfuseCore._exportLocalEvents
- Defined in langfuse-core/lib/index.d.ts:4526

`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 LangfuseCore._getDataset
- Defined in langfuse-core/lib/index.d.ts:4446

`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 LangfuseCore._getDatasetItems
- Defined in langfuse-core/lib/index.d.ts:4447

_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
Inherited from LangfuseCore._getFetchOptions
- Defined in langfuse-core/lib/index.d.ts:4517

`Protected`_parsePayload

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

_updateGeneration

_updateGeneration(body): this
Parameters
- body: 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"];
      };
      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">
Returns this
Inherited from LangfuseCore._updateGeneration
- Defined in langfuse-core/lib/index.d.ts:4573

_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
Inherited from LangfuseCore._updateSpan
- Defined in langfuse-core/lib/index.d.ts:4572

`Protected`awaitAllQueuedAndPendingRequests

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

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 LangfuseCore.createDataset
- Defined in langfuse-core/lib/index.d.ts:4466

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 LangfuseCore.createDatasetItem
- Defined in langfuse-core/lib/index.d.ts:4476

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 LangfuseCore.createDatasetRunItem
- Defined in langfuse-core/lib/index.d.ts:4459

createPrompt

createPrompt(body): Promise<ChatPromptClient>
Parameters
- body: CreateChatPromptBody
Returns Promise<ChatPromptClient>
Inherited from LangfuseCore.createPrompt
- Defined in langfuse-core/lib/index.d.ts:4552
createPrompt(body): Promise<TextPromptClient>
Parameters
- body: CreateTextPromptBody
Returns Promise<TextPromptClient>
Inherited from LangfuseCore.createPrompt
- Defined in langfuse-core/lib/index.d.ts:4553

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 LangfuseCore.createPromptStateless
- Defined in langfuse-core/lib/index.d.ts:4479

debug

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

`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 LangfuseCore.enqueue
- Defined in langfuse-core/lib/index.d.ts:4485

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
Inherited from LangfuseCore.event
- Defined in langfuse-core/lib/index.d.ts:4540

`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 LangfuseCore.eventStateless
- Defined in langfuse-core/lib/index.d.ts:4440

fetch

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

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"];
        };
        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";
        };
        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"];
        };
        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";
        };
        version?: null | string;
    }, "externalId" | "traceIdType">;
}>
Inherited from LangfuseCore.fetchObservation
- Defined in langfuse-core/lib/index.d.ts:4453

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;
        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";
        };
        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;
        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";
        };
        version?: null | string;
    })[];
    meta: {
        limit: number;
        page: number;
        totalItems: number;
        totalPages: number;
    };
}, "externalId" | "traceIdType">>
Inherited from LangfuseCore.fetchObservations
- Defined in langfuse-core/lib/index.d.ts:4452

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 LangfuseCore.fetchSessions
- Defined in langfuse-core/lib/index.d.ts:4456

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;
            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";
            };
            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;
            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";
            };
            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">;
}>
Inherited from LangfuseCore.fetchTrace
- Defined in langfuse-core/lib/index.d.ts:4449

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 LangfuseCore.fetchTraces
- Defined in langfuse-core/lib/index.d.ts:4448

`Protected`findAndProcessMedia

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>
Inherited from LangfuseCore.findAndProcessMedia
- Defined in langfuse-core/lib/index.d.ts:4497

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 LangfuseCore.flush
- Defined in langfuse-core/lib/index.d.ts:4512

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 LangfuseCore.flushAsync
- Defined in langfuse-core/lib/index.d.ts:4511

generation

generation(body): LangfuseGenerationClient
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"];
      };
      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 LangfuseGenerationClient
Inherited from LangfuseCore.generation
- Defined in langfuse-core/lib/index.d.ts:4539

`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"];
      };
      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 LangfuseCore.generationStateless
- Defined in langfuse-core/lib/index.d.ts:4442

`Protected`getCommonEventProperties

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

getCustomUserAgent

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

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;
}>
Inherited from LangfuseCore.getDataset
- Defined in langfuse-core/lib/index.d.ts:4542

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 LangfuseCore.getDatasetItem
- Defined in langfuse-core/lib/index.d.ts:4477

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 LangfuseCore.getDatasetRun
- Defined in langfuse-core/lib/index.d.ts:4457

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 LangfuseCore.getDatasetRuns
- Defined in langfuse-core/lib/index.d.ts:4458

getLibraryId

getLibraryId(): string
Returns string
Overrides LangfuseCore.getLibraryId
- Defined in langfuse/src/langfuse.ts:69

getLibraryVersion

getLibraryVersion(): string
Returns string
Overrides LangfuseCore.getLibraryVersion
- Defined in langfuse/src/langfuse.ts:73

getPersistedProperty

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

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>
Inherited from LangfuseCore.getPrompt
- Defined in langfuse-core/lib/index.d.ts:4554
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>
Inherited from LangfuseCore.getPrompt
- Defined in langfuse-core/lib/index.d.ts:4562

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 LangfuseCore.getPromptStateless
- Defined in langfuse-core/lib/index.d.ts:4480

getSdkIntegration

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

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 LangfuseCore.on
- Defined in langfuse-core/lib/index.d.ts:4434

`Protected`processEnqueueEvent

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>
Inherited from LangfuseCore.processEnqueueEvent
- Defined in langfuse-core/lib/index.d.ts:4486

`Protected`processMediaInEvent

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>
Inherited from LangfuseCore.processMediaInEvent
- Defined in langfuse-core/lib/index.d.ts:4496

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 LangfuseCore.processQueueItems
- Defined in langfuse-core/lib/index.d.ts:4513

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
Inherited from LangfuseCore.score
- Defined in langfuse-core/lib/index.d.ts:4541

`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 LangfuseCore.scoreStateless
- Defined in langfuse-core/lib/index.d.ts:4443

setPersistedProperty

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

shutdown

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

shutdownAsync

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

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
Inherited from LangfuseCore.span
- Defined in langfuse-core/lib/index.d.ts:4538

`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 LangfuseCore.spanStateless
- Defined in langfuse-core/lib/index.d.ts:4441

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
Inherited from LangfuseCore.trace
- Defined in langfuse-core/lib/index.d.ts:4537

`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 LangfuseCore.traceStateless
- Defined in langfuse-core/lib/index.d.ts:4439

`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 LangfuseCore.truncateEventBody
- Defined in langfuse-core/lib/index.d.ts:4494

`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"];
      };
      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 LangfuseCore.updateGenerationStateless
- Defined in langfuse-core/lib/index.d.ts:4445

`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 LangfuseCore.updateSpanStateless
- Defined in langfuse-core/lib/index.d.ts:4444

Class Langfuse

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Langfuse

Properties

Protected_events

Protected Optional_flushTimer

Protected_retryOptions

additionalHeaders

baseUrl

ProtectedisLocalEventExportEnabled

Methods

_exportLocalEvents

Parameters

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

OptionalfetchTimeout?: number

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

Returns LangfuseFetchOptions

Protected_parsePayload

Parameters

Returns any

_updateGeneration

Parameters

Returns this

_updateSpan

Parameters

Returns this

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

createPrompt

Parameters

Returns Promise<ChatPromptClient>

Parameters

Returns Promise<TextPromptClient>

createPromptStateless

Parameters

debug

Parameters

Returns void

Protectedenqueue

Parameters

Returns void

event

Parameters

Returns LangfuseEventClient

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

`Protected`_events

`Protected` `Optional`_flushTimer

`Protected`_retryOptions

`Protected`isLocalEventExportEnabled

`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 | Buffer

`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`findAndProcessMedia

`Optional`observationId?: string

`Protected`generationStateless

`Protected`getCommonEventProperties

Returns Promise<{
description?: string;
id: string;
items: DatasetItem[];
metadata?: any;
name: string;
projectId: 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">>

`Optional`limit?: null | number

`Optional`page?: null | number

`Optional`cacheTtlSeconds?: number

`Optional`fallback?: string

`Optional`fetchTimeoutMs?: number

`Optional`label?: string

`Optional`maxRetries?: number

`Optional`type?: "text"