Skip to content

Streaming events

Chat messages, Responses API 호출 시 stream 을 true로 설정하면 응답 메시지가 생성됨에 따라 클라이언트로 이벤트를 전송합니다.

이벤트 스트리밍에 대해 자세히 알아보세요.

on_chat_model_(start|stream|end)

언어 모델에 의해 생성되는 이벤트들입니다.


id string
메시지에 대한 고유 ID입니다.


parent_id string
언어 모델을 호출한 부모 에이전트나 체인의 고유 ID입니다.


on_chat_model_start

언어 모델이 메시지 생성을 시작할 때 전송되는 이벤트입니다.


time integer
메시지 생성이 시작된 시점의 유닉스 타임스탬프(초)입니다.


on_chat_model_stream

언어 모델이 생성 중인 메시지 청크들을 스트리밍할 때 전송되는 이벤트입니다.


content string
모델이 생성중인 메시지 내용


additional_kwargs object
메시지와 관련된 추가 페이로드용 데이터로 예약된 필드입니다.
추론 메시지가 생성될 경우 이 필드에 저장됩니다.

Click to expand reasoning_content string or null
모델이 생성중인 추론 메시지 내용

on_chat_model_end

언어 모델이 메시지 생성을 완료했을 때 전송되는 이벤트입니다.


model string
메시지 생성을 위해 사용된 모델입니다.


finish_reason string
모델이 토큰 생성을 종료한 원인으로 stop, length 중 하나입니다. 모델이 자연스러운 중지 지점에 도달하면 stop, 모델이 허용하는 최대 토큰 수에 도달하면 length가 반환됩니다.


usage_metadata object
토큰 개수와 같은 생성된 메시지에 대한 사용 통계입니다.


time integer
메시지 생성이 완료된 시점의 유닉스 타임스탬프(초)입니다.

event: on_chat_model_start
data: {"id": "cmpl-228581414379d85eed41075d", "parent_id": "run-8f21edd5a549864455c4fdbd", "time": 1760495609}

event: on_chat_model_stream
data: {"content": "안녕", "additional_kwargs": {}, "id": "cmpl-228581414379d85eed41075d", "parent_id": "run-8f21edd5a549864455c4fdbd"}

event: on_chat_model_stream
data: {"content": "하세요", "additional_kwargs": {}, "id": "cmpl-228581414379d85eed41075d", "parent_id": "run-8f21edd5a549864455c4fdbd"}

event: on_chat_model_end
data: {"model": "Konan-LLM-ENT-11", "finish_reason": "stop", "usage_metadata": {"input_tokens": 89, "output_tokens": 9, "total_tokens": 98, "input_token_details": {}, "output_token_details": {}}, "id": "cmpl-228581414379d85eed41075d", "parent_id": "run-8f21edd5a549864455c4fdbd", "time": 1760495609}

event: done
data: {}

on_chain_(start|stream|end)

사용자 지시에 대한 응답을 만들기 위해 실행되는 에이전트(혹은 체인)들이 발생시키는 이벤트들입니다.


name string
실행 중인 에이전트의 이름


id string
실행 중인 에이전트의 ID


parent_id string or null
에이전트를 실행한 부모 에이전트의 ID.
최초 실행되는 최상위 에이전트의 경우 null 값을 가진다.


on_chain_start

에이전트가 실행이 시작될 때 전송되는 이벤트입니다.


time integer
에이전트 실행이 시작된 시점의 유닉스 타임스탬프(초)입니다.


on_chain_stream

에이전트 진행 상황에 맞춰 스트리밍됩니다.


content string
에이전트 진행 상황을 나타내는 문자열


on_chain_end

에이전트 실행이 완료되는 시점에 전송되는 이벤트입니다.


time integer
에이전트 실행이 완료된 시점의 유닉스 타임스탬프(초)입니다.

event: on_chain_start
data: {"name": "kylin-service", "id": "run-79d8f7d6166ea560f2436b25", "parent_id": null, "time": 1760423229}

event: on_chain_stream
data: {"content": "준비중...", "name": "kylin-service", "id": "run-79d8f7d6166ea560f2436b25", "parent_id": null}

event: on_chain_stream
data: {"content": "관련있는 문서를 검색합니다.", "name": "kylin-service", "id": "run-79d8f7d6166ea560f2436b25", "parent_id": null}

event: on_chain_end
data: {"name": "kylin-service", "id": "run-79d8f7d6166ea560f2436b25", "parent_id": null, "time": 1760423235}

on_tool_(start|end)

에이전트가 실행하는 도구에 대해 전송되는 이벤트들입니다.


name string
실행 중인 도구의 이름


id string
실행 중인 도구의 ID


parent_id string or null
도구를 실행한 부모 에이전트의 ID


on_tool_start

도구를 실행하는 시점에 전송되는 이벤트입니다.


time integer
도구 실행 시점의 유닉스 타임스탬프(초)입니다.


on_tool_end

도구 실행이 완료되는 시점에 전송되는 이벤트입니다.


content string or object, array
도구 실행 결과
형식은 도구에 따라 달라질 수 있습니다.
예를 들어 retriever 의 경우 chunk 배열이 포함됩니다.


time integer
도구 실행이 완료된 시점의 유닉스 타임스탬프(초)입니다.

event: on_tool_start
data: {"name": "retriever", "id": "cmpl-f736509dcec588e2c9bba2c0", "parent_id": "run-79d8f7d6166ea560f2436b25", "time": 1760423234}

event: on_tool_end
data: {"content": [{"cid": "a3f5412e6784aa37d91104cc4df3d2dd", "content": "프랑스 혁명.txt\n \n \n## 프랑스 대혁명\n\n1789년 프랑스 왕국에서 발발하여 ...왕권을 더욱 더 강화했다.", "page": 1, "title": "프랑스 혁명.txt\n ", "url": "/ksm/rag/record/u6f92b5f2/a3f5412e6784aa37d91104cc4df3d2dd", "uuid": "9cf123d0-cd13-4e9a-a7be-ad189b444567"}], "name": "retriever", "id": "cmpl-f736509dcec588e2c9bba2c0", "parent_id": "run-79d8f7d6166ea560f2436b25", "time": 1760423234}

on_custom_event

최종 사용자에게 안내 메시지나 JSON 오브젝트 전달을 위해 전송되는 이벤트입니다.


done

메시지 전송이 모두 완료되면 전송되는 이벤트입니다.

error

오류 발생 시 전송되는 이벤트입니다.


content string
오류 메시지


finish_reason string
항상 error 입니다.