核心回调类#
回调管理器 #
基类: BaseCallbackHandler
, ABC
处理LlamaIndex内部事件回调的回调管理器。
回调管理器提供了一种在事件开始/结束时调用处理程序的方式。
此外,回调管理器会追踪当前的事件堆栈。 它通过以下几个关键属性实现这一功能: - trace_stack - 当前尚未结束的事件堆栈。 当某个事件结束时,会从堆栈中移除。 由于这是一个上下文变量,每个线程/任务都拥有独立的堆栈。 - trace_map - 事件ID到其子事件的映射关系。 在事件开始时,会使用trace_stack底部的事件作为trace_map中的当前父事件。 - trace_id - 当前追踪的简单名称,通常表示入口点(如query查询、index_construction索引构建、insert插入等)
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
handlers
|
List[BaseCallbackHandler]
|
要使用的处理程序列表。 |
None
|
Usage
使用 callback_manager.event(CBEventType.QUERY) 作为事件: 事件开始时(payload={key, val}) ... 事件结束时(payload={key, val})
Source code in llama-index-core/llama_index/core/callbacks/base.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|
事件开始时 #
on_event_start(event_type: CBEventType, payload: Optional[Dict[str, Any]] = None, event_id: Optional[str] = None, parent_id: Optional[str] = None, **kwargs: Any) -> str
在事件开始时运行处理程序并返回事件ID。
Source code in llama-index-core/llama_index/core/callbacks/base.py
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
|
on_event_end #
on_event_end(event_type: CBEventType, payload: Optional[Dict[str, Any]] = None, event_id: Optional[str] = None, **kwargs: Any) -> None
当事件结束时运行处理程序。
Source code in llama-index-core/llama_index/core/callbacks/base.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
|
add_handler #
add_handler(handler: BaseCallbackHandler) -> None
向回调管理器添加一个处理程序。
Source code in llama-index-core/llama_index/core/callbacks/base.py
144 145 146 |
|
remove_handler #
remove_handler(handler: BaseCallbackHandler) -> None
从回调管理器中移除一个处理程序。
Source code in llama-index-core/llama_index/core/callbacks/base.py
148 149 150 |
|
set_handlers #
set_handlers(handlers: List[BaseCallbackHandler]) -> None
将处理程序设置为回调管理器上的唯一处理程序。
Source code in llama-index-core/llama_index/core/callbacks/base.py
152 153 154 |
|
事件 #
event(event_type: CBEventType, payload: Optional[Dict[str, Any]] = None, event_id: Optional[str] = None) -> Generator[EventContext, None, None]
用于启动和关闭事件的上下文管理器。
处理向指定事件的处理程序发送on_event_start和on_event_end。
Usage
使用 callback_manager.event(CBEventType.QUERY, payload={key, val}) 作为事件: ... event.on_end(payload={key, val}) # 可选
Source code in llama-index-core/llama_index/core/callbacks/base.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
|
as_trace #
as_trace(trace_id: str) -> Generator[None, None, None]
用于启动和关闭跟踪的上下文管理器跟踪器。
Source code in llama-index-core/llama_index/core/callbacks/base.py
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
|
start_trace #
start_trace(trace_id: Optional[str] = None) -> None
在整体追踪启动时运行。
Source code in llama-index-core/llama_index/core/callbacks/base.py
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
|
end_trace #
end_trace(trace_id: Optional[str] = None, trace_map: Optional[Dict[str, List[str]]] = None) -> None
当整体跟踪退出时运行。
Source code in llama-index-core/llama_index/core/callbacks/base.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
|
BaseCallbackHandler #
基类: ABC
基础回调处理器,可用于追踪事件的开始和结束。
Source code in llama-index-core/llama_index/core/callbacks/base_handler.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
on_event_start
abstractmethod
#
on_event_start(event_type: CBEventType, payload: Optional[Dict[str, Any]] = None, event_id: str = '', parent_id: str = '', **kwargs: Any) -> str
在事件开始时运行并返回事件ID。
Source code in llama-index-core/llama_index/core/callbacks/base_handler.py
24 25 26 27 28 29 30 31 32 33 |
|
on_event_end
abstractmethod
#
on_event_end(event_type: CBEventType, payload: Optional[Dict[str, Any]] = None, event_id: str = '', **kwargs: Any) -> None
在事件结束时运行。
Source code in llama-index-core/llama_index/core/callbacks/base_handler.py
35 36 37 38 39 40 41 42 43 |
|
start_trace
abstractmethod
#
start_trace(trace_id: Optional[str] = None) -> None
在整体追踪启动时运行。
Source code in llama-index-core/llama_index/core/callbacks/base_handler.py
45 46 47 |
|
end_trace
abstractmethod
#
end_trace(trace_id: Optional[str] = None, trace_map: Optional[Dict[str, List[str]]] = None) -> None
当整体跟踪退出时运行。
Source code in llama-index-core/llama_index/core/callbacks/base_handler.py
49 50 51 52 53 54 55 |
|
回调管理器的基础模式。
CBEvent
dataclass
#
用于存储事件信息的通用类。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
event_type
|
CBEventType
|
|
required |
payload
|
Dict[str, Any] | None
|
|
None
|
time
|
str
|
|
''
|
id_
|
str
|
|
''
|
Source code in llama-index-core/llama_index/core/callbacks/schema.py
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
|
CBEventType #
基础类: str
, Enum
回调管理器事件类型。
属性:
名称 | 类型 | 描述 |
---|---|---|
CHUNKING |
文本分割前后的日志记录。 |
|
NODE_PARSING |
文档及其解析生成的节点的日志记录。 |
|
EMBEDDING |
记录已嵌入文本的数量。 |
|
LLM |
记录LLM调用的模板和响应日志。 |
|
QUERY |
记录每个查询的开始和结束。 |
|
RETRIEVE |
查询所检索节点的日志。 |
|
SYNTHESIZE |
合成调用的结果日志。 |
|
TREE |
生成的摘要及其级别的日志记录。 |
|
SUB_QUESTION |
生成的子问题及回答的日志。 |
Source code in llama-index-core/llama_index/core/callbacks/schema.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
|
事件负载 #
基础类: str
, Enum
Source code in llama-index-core/llama_index/core/callbacks/schema.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|