API 레퍼런스

`LynxTracer`

Lynx SDK의 중심이 되는 수집기입니다.

import { LynxTracer } from "@lynx/sdk";

const lynx = new LynxTracer(config);

`run(agentName, callback)`

코드를 Lynx trace context 안에서 실행합니다.

await lynx.run("SupportAgent", async () => {
  lynx.userInput("비밀번호를 재설정하고 싶어요");
});

`run(options, callback)`

구조화된 run metadata를 함께 넘길 수 있습니다.

await lynx.run(
  {
    agentName: "SupportAgent",
    workspaceId: "workspace_123",
    agentId: "agent_123",
    sessionId: "session_123",
  },
  async () => {
    // agent work
  },
);

Semantic 헬퍼

Method	목적
`userInput(input, metadata?)`	사용자 입력을 기록합니다.
`decision(reasonOrDecision, options?)`	에이전트의 판단을 기록합니다.
`context(labelOrData, dataOrMetadata?)`	검색되었거나 구성된 컨텍스트를 기록합니다.
`memory(label, payload)`	메모리 접근을 기록합니다.
`outcome(options)`	최종 세션 결과를 기록합니다.
`setAttributes(attributes)`	이후 이벤트에 붙일 공통 attribute를 설정합니다.
`annotate(label, payload)`	커스텀 annotation을 남깁니다.
`log(label, payload)`	커스텀 context alert를 기록합니다.

계측 헬퍼

Method	목적
`instrumentLLM(client, options?)`	LLM 클라이언트 객체를 감쌉니다.
`instrumentTool(name, fn, metadata?)`	도구 함수를 감쌉니다.
`guardTool(name, fn, options)`	도구 함수를 로컬 정책 평가와 함께 감쌉니다.

전송 헬퍼

Method	목적
`flush()`	큐에 쌓인 수집 데이터를 즉시 전송합니다.
`shutdown(options?)`	타이머를 정리하고 종료 전에 flush를 시도합니다.
`getStatus()`	로컬 큐, 서킷 브레이커, 전송 상태를 읽습니다.

`LynxPolicyError`

guardTool()이 도구 호출을 차단하면 LynxPolicyError를 던집니다.

import { LynxPolicyError } from "@lynx/sdk";

if (error instanceof LynxPolicyError) {
  console.log(error.action);
}

`lynx`

환경 변수에서 설정을 읽는 기본 tracer입니다.

import { lynx } from "@lynx/sdk";

간단한 애플리케이션에서는 이 기본 export를 사용하면 됩니다. 프로세스, tenant, test마다 설정을 명확히 분리해야 한다면 new LynxTracer()를 사용하세요.

​LynxTracer

​run(agentName, callback)

​run(options, callback)

​Semantic 헬퍼

​계측 헬퍼

​전송 헬퍼

​LynxPolicyError

​lynx