索引
Base index classes.
BaseIndex #
基类: Generic[IS]
, ABC
基础 LlamaIndex。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
nodes
|
List[Node]
|
要索引的节点列表 |
None
|
show_progress
|
bool
|
是否显示 tqdm 进度条。默认为 False。 |
False
|
源代码位于 llama-index-core/llama_index/core/indices/base.py
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 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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
|
from_documents classmethod
#
from_documents(documents: Sequence[Document], storage_context: Optional[StorageContext] = None, show_progress: bool = False, callback_manager: Optional[CallbackManager] = None, transformations: Optional[List[TransformComponent]] = None, **kwargs: Any) -> IndexType
从文档创建索引。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
documents
|
Optional[Sequence[BaseDocument]]
|
用于构建索引的文档列表。 |
必需 |
源代码位于 llama-index-core/llama_index/core/indices/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 124 125 126 127 128 129 |
|
set_index_id #
set_index_id(index_id: str) -> None
设置索引 ID。
注意:如果您决定手动在 index_struct
上设置 index_id
,您需要明确调用 index_store
上的 add_index_struct
来更新索引存储。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
index_id
|
str
|
要设置的索引 ID。 |
必需 |
源代码位于 llama-index-core/llama_index/core/indices/base.py
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
|
build_index_from_nodes #
build_index_from_nodes(nodes: Sequence[BaseNode], **build_kwargs: Any) -> IS
从节点构建索引。
源代码位于 llama-index-core/llama_index/core/indices/base.py
184 185 186 187 188 189 |
|
insert_nodes #
insert_nodes(nodes: Sequence[BaseNode], **insert_kwargs: Any) -> None
插入节点。
源代码位于 llama-index-core/llama_index/core/indices/base.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
|
insert #
insert(document: Document, **insert_kwargs: Any) -> None
插入文档。
源代码位于 llama-index-core/llama_index/core/indices/base.py
210 211 212 213 214 215 216 217 218 219 220 221 |
|
delete_nodes #
delete_nodes(node_ids: List[str], delete_from_docstore: bool = False, **delete_kwargs: Any) -> None
从索引中删除节点列表。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
doc_ids
|
List[str]
|
要删除节点的 doc_ids 列表 |
必需 |
源代码位于 llama-index-core/llama_index/core/indices/base.py
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
|
delete #
delete(doc_id: str, **delete_kwargs: Any) -> None
从索引中删除文档。索引中与该文档相关的所有节点都将被删除。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
doc_id
|
str
|
已摄取文档的 doc_id |
必需 |
源代码位于 llama-index-core/llama_index/core/indices/base.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
|
delete_ref_doc #
delete_ref_doc(ref_doc_id: str, delete_from_docstore: bool = False, **delete_kwargs: Any) -> None
使用 ref_doc_id 删除文档及其节点。
源代码位于 llama-index-core/llama_index/core/indices/base.py
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
|
update #
update(document: Document, **update_kwargs: Any) -> None
更新文档及其对应节点。
这相当于删除文档然后重新插入。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
document
|
Union[BaseDocument, BaseIndex]
|
要更新的文档 |
必需 |
insert_kwargs
|
Dict
|
要传递给 insert 的 kwargs |
必需 |
delete_kwargs
|
Dict
|
要传递给 delete 的 kwargs |
必需 |
源代码位于 llama-index-core/llama_index/core/indices/base.py
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
|
update_ref_doc #
update_ref_doc(document: Document, **update_kwargs: Any) -> None
更新文档及其对应节点。
这相当于删除文档然后重新插入。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
document
|
Union[BaseDocument, BaseIndex]
|
要更新的文档 |
必需 |
insert_kwargs
|
Dict
|
要传递给 insert 的 kwargs |
必需 |
delete_kwargs
|
Dict
|
要传递给 delete 的 kwargs |
必需 |
源代码位于 llama-index-core/llama_index/core/indices/base.py
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
|
refresh #
refresh(documents: Sequence[Document], **update_kwargs: Any) -> List[bool]
使用已更改的文档刷新索引。
这允许用户节省 LLM 和嵌入模型的调用次数,同时仅更新文本或元数据有任何更改的文档。它还会插入之前未存储的任何文档。
源代码位于 llama-index-core/llama_index/core/indices/base.py
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
|
refresh_ref_docs #
refresh_ref_docs(documents: Sequence[Document], **update_kwargs: Any) -> List[bool]
使用已更改的文档刷新索引。
这允许用户节省 LLM 和嵌入模型的调用次数,同时仅更新文本或元数据有任何更改的文档。它还会插入之前未存储的任何文档。
源代码位于 llama-index-core/llama_index/core/indices/base.py
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
|
as_query_engine #
as_query_engine(llm: Optional[LLMType] = None, **kwargs: Any) -> BaseQueryEngine
将索引转换为查询引擎。
调用 index.as_retriever(**kwargs)
获取检索器,然后将其包装在 RetrieverQueryEngine.from_args(retriever, **kwrags)
调用中。
源代码位于 llama-index-core/llama_index/core/indices/base.py
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
|
as_chat_engine #
as_chat_engine(chat_mode: ChatMode = BEST, llm: Optional[LLMType] = None, **kwargs: Any) -> BaseChatEngine
将索引转换为聊天引擎。
调用 index.as_query_engine(llm=llm, **kwargs)
获取查询引擎,然后根据聊天模式将其包装在聊天引擎中。
聊天模式
ChatMode.BEST
(默认):使用带有查询引擎工具的代理(react 或 openai)的聊天引擎ChatMode.CONTEXT
:使用检索器获取上下文的聊天引擎ChatMode.CONDENSE_QUESTION
:压缩问题的聊天引擎ChatMode.CONDENSE_PLUS_CONTEXT
:压缩问题并使用检索器获取上下文的聊天引擎ChatMode.SIMPLE
:直接使用 LLM 的简单聊天引擎ChatMode.REACT
:使用带有查询引擎工具的 react 代理的聊天引擎ChatMode.OPENAI
:使用带有查询引擎工具的 openai 代理的聊天引擎
源代码位于 llama-index-core/llama_index/core/indices/base.py
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
|