GitHub
Docs
Preparing search index...
The search index is not available
Langfuse JS/TS SDKs
Langfuse JS/TS SDKs
langfuse-node
LangfuseGenerationClient
Class LangfuseGenerationClient
Hierarchy
LangfuseObservationClient
LangfuseGenerationClient
Index
Constructors
constructor
Properties
client
id
observation
Id
trace
Id
Methods
end
event
generation
get
Trace
Url
score
span
update
Constructors
constructor
new
Langfuse
Generation
Client
(
client
,
id
,
traceId
)
:
LangfuseGenerationClient
Parameters
client
:
LangfuseCore
id
:
string
traceId
:
string
Returns
LangfuseGenerationClient
Properties
Readonly
client
client
:
LangfuseCore
Readonly
id
id
:
string
Readonly
observation
Id
observation
Id
:
null
|
string
Readonly
trace
Id
trace
Id
:
string
Methods
end
end
(
body
?
)
:
this
Parameters
Optional
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"
|
"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
get
Trace
Url
get
Trace
Url
(
)
:
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
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
id
observation
Id
trace
Id
Methods
end
event
generation
get
Trace
Url
score
span
update
GitHub
Docs
Langfuse JS/TS SDKs
langfuse
default
ContentType
ChatPromptClient
HttpClient
Langfuse
LangfuseEventClient
LangfuseGenerationClient
LangfuseMedia
LangfusePublicApi
LangfuseSpanClient
LangfuseTraceClient
LangfuseWeb
TextPromptClient
ApiBaseEvent
ApiBasePrompt
ApiBaseScore
ApiChatMessage
ApiComment
ApiCommentsGetParams
ApiConfig
ApiConfigCategory
ApiCreateChatPromptRequest
ApiCreateCommentRequest
ApiCreateCommentResponse
ApiCreateDatasetItemRequest
ApiCreateDatasetRequest
ApiCreateDatasetRunItemRequest
ApiCreateModelRequest
ApiCreateScoreConfigRequest
ApiCreateScoreRequest
ApiCreateScoreResponse
ApiCreateTextPromptRequest
ApiDailyMetrics
ApiDailyMetricsDetails
ApiDataset
ApiDatasetItem
ApiDatasetItemsListParams
ApiDatasetRun
ApiDatasetRunItem
ApiDatasetsGetRunsParams
ApiDatasetsListParams
ApiGetCommentsResponse
ApiGetMediaResponse
ApiGetMediaUploadUrlRequest
ApiGetMediaUploadUrlResponse
ApiGetScoresResponse
ApiGetScoresResponseTraceData
ApiHealthResponse
ApiIngestionBatchPayload
ApiIngestionError
ApiIngestionResponse
ApiIngestionSuccess
ApiMetricsDailyParams
ApiModel
ApiModelsListParams
ApiObservation
ApiObservationBody
ApiObservations
ApiObservationsGetManyParams
ApiObservationsViews
ApiOpenAIUsage
ApiOpenAIUsageSchema
ApiOptionalObservationBody
ApiPaginatedDatasetItems
ApiPaginatedDatasetRuns
ApiPaginatedDatasets
ApiPaginatedModels
ApiPaginatedSessions
ApiPatchMediaBody
ApiProject
ApiProjects
ApiPromptMeta
ApiPromptMetaListResponse
ApiPromptsGetParams
ApiPromptsListParams
ApiPromptVersionUpdatePayload
ApiScoreBody
ApiScoreConfig
ApiScoreConfigs
ApiScoreConfigsGetParams
ApiScoreGetParams
ApiSDKLogBody
ApiSession
ApiSessionsListParams
ApiSort
ApiTrace
ApiTraceBody
ApiTraceListParams
ApiTraces
ApiUsage
ApiUsageByModel
ApiUtilsMetaResponse
FullRequestParams
HttpResponse
ApiBooleanScore
ApiCategoricalScore
ApiChatPrompt
ApiCommentObjectType
ApiCreateEventBody
ApiCreateEventEvent
ApiCreateGenerationBody
ApiCreateGenerationEvent
ApiCreateObservationEvent
ApiCreatePromptRequest
ApiCreateScoreValue
ApiCreateSpanBody
ApiCreateSpanEvent
ApiDatasetRunWithItems
ApiDatasetStatus
ApiGetScoresResponseData
ApiGetScoresResponseDataBoolean
ApiGetScoresResponseDataCategorical
ApiGetScoresResponseDataNumeric
ApiIngestionEvent
ApiIngestionUsage
ApiMapValue
ApiMediaContentType
ApiModelUsageUnit
ApiNumericScore
ApiObservationLevel
ApiObservationsView
ApiObservationType
ApiPrompt
ApiScore
ApiScoreDataType
ApiScoreEvent
ApiScoreSource
ApiSDKLogEvent
ApiSessionWithTraces
ApiTextPrompt
ApiTraceEvent
ApiTraceWithDetails
ApiTraceWithFullDetails
ApiUpdateEventBody
ApiUpdateGenerationBody
ApiUpdateGenerationEvent
ApiUpdateObservationEvent
ApiUpdateSpanBody
ApiUpdateSpanEvent
ApiUsageDetails
LangfuseConfig
LangfuseOptions
LangfuseParent
LangfusePromptClient
LangfusePromptRecord
QueryParamsType
RequestParams
ResponseFormat
observeOpenAI
langfuse-core
utils
RetriableOptions
assert
configLangfuseSDK
currentISOTime
currentTimestamp
encodeQueryParams
generateUUID
getEnv
removeTrailingSlash
retriable
safeSetTimeout
LangfusePersistedProperty
ChatPromptClient
LangfuseCore
LangfuseEventClient
LangfuseGenerationClient
LangfuseMedia
LangfuseMemoryStorage
LangfuseObjectClient
LangfuseSpanClient
LangfuseTraceClient
LangfuseWebStateless
TextPromptClient
components
operations
ParsedMediaReference
paths
$defs
ChatMessage
ChatPrompt
CreateChatPromptBody
CreateLangfuseDatasetBody
CreateLangfuseDatasetItemBody
CreateLangfuseDatasetItemResponse
CreateLangfuseDatasetResponse
CreateLangfuseDatasetRunItemBody
CreateLangfuseDatasetRunItemResponse
CreateLangfuseEventBody
CreateLangfuseGenerationBody
CreateLangfusePromptBody
CreateLangfusePromptResponse
CreateLangfuseScoreBody
CreateLangfuseSpanBody
CreateLangfuseTraceBody
CreatePromptBody
CreateTextPromptBody
DatasetItem
DatasetItemData
DeferRuntime
EventBody
GetLangfuseDatasetItemsQuery
GetLangfuseDatasetItemsResponse
GetLangfuseDatasetParams
GetLangfuseDatasetResponse
GetLangfuseDatasetRunParams
GetLangfuseDatasetRunResponse
GetLangfuseDatasetRunsPath
GetLangfuseDatasetRunsQuery
GetLangfuseDatasetRunsResponse
GetLangfuseObservationResponse
GetLangfuseObservationsQuery
GetLangfuseObservationsResponse
GetLangfusePromptFailureData
GetLangfusePromptResponse
GetLangfusePromptSuccessData
GetLangfuseSessionsQuery
GetLangfuseSessionsResponse
GetLangfuseTraceResponse
GetLangfuseTracesQuery
GetLangfuseTracesResponse
GetMediaResponse
GetMediaUploadUrlRequest
GetMediaUploadUrlResponse
IngestionBody
IngestionReturnType
JsonType
LangfuseCoreOptions
LangfuseEventProperties
LangfuseFetchOptions
LangfuseFetchResponse
LangfuseMediaResolveMediaReferencesParams
LangfuseMetadataProperties
LangfuseObject
LangfusePromptClient
LangfusePromptRecord
LangfuseQueueItem
LinkDatasetItem
MaskFunction
MediaContentType
PatchMediaBody
PromptInput
SingleIngestionEvent
TextPrompt
UpdateLangfuseGenerationBody
UpdateLangfuseSpanBody
UpdatePromptBody
Usage
UsageDetails
webhooks
langfuse-langchain
default
CallbackHandler
Langfuse
AnonymousLlmMessage
LlmMessage
createDatasetItemHandler
langfuse-node
default
Langfuse
LangfuseEventClient
LangfuseGenerationClient
LangfuseSpanClient
LangfuseTraceClient
langfuse-vercel
LangfuseExporter
"
"