Class LangfuseGenerationClient

Hierarchy

  • LangfuseObservationClient
    • LangfuseGenerationClient

Constructors

constructor

  • new LangfuseGenerationClient(client, id, traceId): LangfuseGenerationClient

  • Parameters

    • client: LangfuseCore
    • id: string
    • traceId: string

    Returns LangfuseGenerationClient

Properties

Readonlyclient

client: LangfuseCore

Readonlyid

id: string

ReadonlyobservationId

observationId: null | string

ReadonlytraceId

traceId: string

Methods

end

  • end(body?): this

  • Parameters

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

    Returns this

event

  • event(body): LangfuseEventClient

  • Parameters

    • body: Omit<Omit<{
          environment?: null | string;
          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">, "traceId" | "parentObservationId">

    Returns LangfuseEventClient

generation

  • generation(body): LangfuseGenerationClient

  • Parameters

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

    Returns LangfuseGenerationClient

getTraceUrl

  • getTraceUrl(): string

  • Returns string

score

  • score(body): this

  • Parameters

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

    Returns this

span

  • span(body): LangfuseSpanClient

  • Parameters

    • body: Omit<Omit<{
          endTime?: null | Date;
          environment?: null | string;
          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">, "traceId" | "parentObservationId">

    Returns LangfuseSpanClient

update

  • update(body): this

  • Parameters

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

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
""