SDK 레퍼런스

SDK 레퍼런스 (SDK Reference)

SDK의 최상위 계층에서 노출되는 모든 함수와 클래스를 정리한 문서예요. import agentops만으로 바로 사용할 수 있는 기능들을 함께 살펴볼게요.

출처: 문서

본문

import agentops만으로 사용할 수 있는 함수와 클래스들이에요.

함수 (Functions)

`init()`

AgentOps의 첫 단계는 항상 .init()을 호출하는 것이에요.

파라미터 (Parameters):

api_key (str, optional): AgentOps 서비스용 API 키예요. 제공하지 않으면 AGENTOPS_API_KEY 환경 변수에서 키를 읽어요.
endpoint (str, optional): AgentOps 서비스의 엔드포인트예요. 기본값은 'https://api.agentops.ai'.
max_wait_time (int, optional): 큐(queue)를 flush하기 전에 기다리는 최대 시간(밀리초)이에요. 기본값은 30,000(30초).
max_queue_size (int, optional): 이벤트 큐의 최대 크기예요. 기본값은 100.
tags (List[str], optional): 그룹화나 정렬을 위한 세션 태그예요 (예: ["GPT-4"]).
override (bool, optional): [Deprecated] LLM 호출을 계측하고 LLMEvents를 발행할지 여부를 결정하려면 instrument_llm_calls를 사용하세요.
instrument_llm_calls (bool): LLM 호출을 계측하고 LLMEvents를 발행할지 여부예요.
auto_start_session (bool): 클라이언트가 생성될 때 세션을 자동으로 시작할지 여부예요. 추가 설정을 하거나 자식 프로세스에서 세션을 시작하려면 세션 시작을 지연시키고 싶을 수 있어요.
inherited_session_id (str, optional): 클라이언트를 만들 때 이 값을 전달하면 클라이언트가 기존 세션에 연결돼요. 별도의 프로세스가 같은 세션에 기여할 때 유용해요.
skip_auto_end_session (bool, optional): Crew 같은 프레임워크를 사용한다면 프레임워크가 실행 중단 시점을 결정할 수 있어요. 이 파라미터를 true로 설정하면 그때 agentops 세션이 끝나지 않아요.

반환값 (Returns):

현재 또는 새 세션의 세션 ID.

`start_session()`

이벤트 기록을 위한 새 Session을 시작해요.

파라미터 (Parameters):

tags (List[str], optional): 세션 태그예요.
config (Config, optional): 클라이언트 설정 객체예요.
inherited_session_id (str, optional): 기존 세션에서 이어서 진행할 세션 ID예요.

반환값 (Returns):

시작된 세션의 세션 ID.

`end_session()`

AgentOps 서비스로 현재 세션을 종료해요.

파라미터 (Parameters):

end_state (str): 세션의 최종 상태예요. 옵션: Success, Fail, 또는 Indeterminate.
end_state_reason (str, optional): 세션을 종료한 이유예요.
video (str, optional): 세션 녹화 영상의 URL이에요.

`record()`

AgentOps 서비스로 이벤트를 기록해요.

파라미터 (Parameters):

event (Union[Event, ErrorEvent]): 기록할 이벤트예요.

`get_api_key()`

클라이언트가 사용하는 API 키를 검색해요.

반환값 (Returns):

문자열 형태의 API 키.

타입 (Types)

`Config`

AgentOps 클라이언트의 설정값을 저장해요.

파라미터 (Parameters):

api_key (str, optional): AgentOps 서비스용 API 키예요. 제공하지 않으면 AGENTOPS_API_KEY 환경 변수에서 키를 읽어요. 키를 찾지 못하면 ConfigurationError가 발생해요.
endpoint (str, optional): AgentOps 서비스의 엔드포인트예요. 제공하지 않으면 AGENTOPS_API_ENDPOINT 환경 변수에서 읽어요. 기본값은 'https://api.agentops.ai'.
max_wait_time (int, optional): 큐를 flush하기 전에 기다리는 최대 시간(밀리초)이에요. 기본값은 30000.
max_queue_size (int, optional): 이벤트 큐의 최대 크기예요. 기본값은 100.

프로퍼티 (Properties)

api_key (str): AgentOps 서비스용 API 키를 가져오거나 설정해요.
endpoint (str): AgentOps 서비스의 엔드포인트를 가져오거나 설정해요.
max_wait_time (int): 큐를 flush하기 전에 기다리는 최대 시간(밀리초)을 가져오거나 설정해요.
max_queue_size (int): 이벤트 큐의 최대 크기를 가져오거나 설정해요.

`LangchainCallbackHandler`

Reference

이 콜백 핸들러는 AgentOps 자동 계측(auto-instrumenting) 대신 옵션으로 사용하기 위한 것이에요. LLM 호출 라이브러리로 LangChain을 사용할 때만 유용해요.

SDK 레퍼런스