类型总览

@yingdao-ai/agent-observability 导出的所有类型。

配置类型

ObserverConfig

type ObserverConfig = {
  transport: Transport
}

LangfuseDirectConfig

type LangfuseDirectConfig = {
  host: string
  publicKey?: string
  secretKey?: string
  authHeaders?: (sessionId: string) => Record<string, string>
  environment?: string
  release?: string
  version?: string
  log?: LogFn
  fetch?: typeof fetch
}

输入类型

RunInput

type RunInput = {
  id: string
  name: string
  input?: unknown
  userId?: string
  tags?: string[]
  metadata?: Record<string, unknown>
}

GenerationInput

type GenerationInput = {
  model: string
  input?: unknown
  metadata?: Record<string, unknown>
  name?: string
}

ToolInput

type ToolInput = {
  id: string
  name: string
  input?: unknown
  metadata?: Record<string, unknown>
}

AgentContext

type AgentContext = {
  userId?: string
  tags?: string[]
  metadata?: Record<string, unknown>
}

数据类型

TokenUsage

type TokenUsage = {
  input?: number
  output?: number
  total?: number
  reasoning?: number
  cache?: {
    read?: number
    write?: number
  }
}

ScoreSpec

type ScoreSpec = {
  name: string
  value: string | number | boolean
  dataType: "CATEGORICAL" | "NUMERIC" | "BOOLEAN"
  comment?: string
}

RedactRuleConfig

type RedactRuleConfig = {
  kind: "key" | "value"
  name: string
  pattern: string
  flags?: string
  replacement?: string
}

Transport 接口

Transport

type Transport = {
  enabled(): boolean
  environment(): string
  startRun(input: RunInput): TransportRun | undefined
  score(input: {
    traceId: string
    scores: ScoreSpec[]
    sessionId: string
    agent: string
    environment: string
  }): Promise<void>
  flush(): Promise<void>
}

TransportRun

type TransportRun = {
  startGeneration(input: GenerationInput): TransportGeneration
  endGeneration(opts?: { output?: unknown; usage?: TokenUsage; cost?: number }): void
  startTool(input: ToolInput): TransportTool
  endTool(id: string, opts?: { output?: unknown; error?: string }): void
  end(output?: unknown): void
  setMeta(meta: Partial<RunInput>): void
}

TransportGeneration

type TransportGeneration = {
  appendText(text: string): void
  appendReasoning(text: string): void
  end(opts?: { output?: unknown; usage?: TokenUsage; cost?: number }): void
}

TransportTool

type TransportTool = {
  end(opts?: { output?: unknown; error?: string }): void
}

工具函数类型

LogFn

type LogFn = (event: string, data?: Record<string, unknown>) => void