Index
Base schema for data structures.
BaseComponent #
Bases: BaseModel
Base component object to capture class names.
Source code in llama-index-core/llama_index/core/schema.py
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 |
|
class_name
classmethod
#
class_name() -> str
Get the class name, used as a unique ID in serialization.
This provides a key that makes serialization robust against actual class name changes.
Source code in llama-index-core/llama_index/core/schema.py
64 65 66 67 68 69 70 71 72 |
|
TransformComponent #
Bases: BaseComponent
, DispatcherSpanMixin
Base class for transform components.
Source code in llama-index-core/llama_index/core/schema.py
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
|
acall
async
#
Async transform nodes.
Source code in llama-index-core/llama_index/core/schema.py
164 165 166 167 168 |
|
NodeRelationship #
Bases: str
, Enum
Node relationships used in BaseNode
class.
Attributes:
Name | Type | Description |
---|---|---|
SOURCE |
The node is the source document. |
|
PREVIOUS |
The node is the previous node in the document. |
|
NEXT |
The node is the next node in the document. |
|
PARENT |
The node is the parent node in the document. |
|
CHILD |
The node is a child node in the document. |
Source code in llama-index-core/llama_index/core/schema.py
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
|
RelatedNodeInfo #
Bases: BaseComponent
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_id
|
str
|
|
required |
node_type
|
ObjectType | None
|
|
None
|
metadata
|
Dict[str, Any]
|
|
{}
|
hash
|
str | None
|
|
None
|
Source code in llama-index-core/llama_index/core/schema.py
204 205 206 207 208 209 210 211 212 |
|
BaseNode #
Bases: BaseComponent
Base node Object.
Generic abstract interface for retrievable nodes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id_
|
str
|
Unique ID of the node. |
'bc69a7d2-c633-4122-9b86-fde9d911adac'
|
embedding
|
List[float] | None
|
Embedding of the node. |
None
|
metadata
|
Dict[str, Any]
|
A flat dictionary of metadata fields |
{}
|
excluded_embed_metadata_keys
|
List[str]
|
Metadata keys that are excluded from text for the embed model. |
[]
|
excluded_llm_metadata_keys
|
List[str]
|
Metadata keys that are excluded from text for the LLM. |
[]
|
relationships
|
Dict[NodeRelationship, Union[RelatedNodeInfo, List[RelatedNodeInfo]]]
|
A mapping of relationships to other node information. |
{}
|
Source code in llama-index-core/llama_index/core/schema.py
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 |
|
embedding
class-attribute
instance-attribute
#
embedding: Optional[List[float]] = Field(default=None, description='Embedding of the node.')
" metadata fields - injected as part of the text shown to LLMs as context - injected as part of the text for generating embeddings - used by vector DBs for metadata filtering
source_node
property
#
source_node: Optional[RelatedNodeInfo]
Source object node.
Extracted from the relationships field.
get_type
abstractmethod
classmethod
#
get_type() -> str
Get Object type.
Source code in llama-index-core/llama_index/core/schema.py
261 262 263 264 |
|
get_content
abstractmethod
#
get_content(metadata_mode: MetadataMode = ALL) -> str
Get object content.
Source code in llama-index-core/llama_index/core/schema.py
266 267 268 |
|
get_metadata_str
abstractmethod
#
get_metadata_str(mode: MetadataMode = ALL) -> str
Metadata string.
Source code in llama-index-core/llama_index/core/schema.py
270 271 272 |
|
set_content
abstractmethod
#
set_content(value: Any) -> None
Set the content of the node.
Source code in llama-index-core/llama_index/core/schema.py
274 275 276 |
|
get_embedding #
get_embedding() -> List[float]
Get embedding.
Errors if embedding is None.
Source code in llama-index-core/llama_index/core/schema.py
372 373 374 375 376 377 378 379 380 |
|
as_related_node_info #
as_related_node_info() -> RelatedNodeInfo
Get node as RelatedNodeInfo.
Source code in llama-index-core/llama_index/core/schema.py
382 383 384 385 386 387 388 389 |
|
TextNode #
Bases: BaseNode
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text
|
str
|
Text content of the node. |
''
|
mimetype
|
str
|
MIME type of the node content. |
'text/plain'
|
start_char_idx
|
int | None
|
Start char index of the node. |
None
|
end_char_idx
|
int | None
|
End char index of the node. |
None
|
text_template
|
str
|
Template for how text is formatted, with {content} and {metadata_str} placeholders. |
'{metadata_str}\n\n{content}'
|
metadata_template
|
str
|
Template for how metadata is formatted, with {key} and {value} placeholders. |
'{key}: {value}'
|
metadata_seperator
|
str
|
Separator between metadata fields when converting to string. |
'\n'
|
Source code in llama-index-core/llama_index/core/schema.py
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 479 480 481 482 483 |
|
get_type
classmethod
#
get_type() -> str
Get Object type.
Source code in llama-index-core/llama_index/core/schema.py
431 432 433 434 |
|
get_content #
get_content(metadata_mode: MetadataMode = NONE) -> str
Get object content.
Source code in llama-index-core/llama_index/core/schema.py
436 437 438 439 440 441 442 443 444 |
|
get_metadata_str #
get_metadata_str(mode: MetadataMode = ALL) -> str
Metadata info string.
Source code in llama-index-core/llama_index/core/schema.py
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 |
|
set_content #
set_content(value: str) -> None
Set the content of the node.
Source code in llama-index-core/llama_index/core/schema.py
469 470 471 |
|
get_node_info #
get_node_info() -> Dict[str, Any]
Get node info.
Source code in llama-index-core/llama_index/core/schema.py
473 474 475 |
|
ImageNode #
Bases: TextNode
Node with image.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
image
|
str | None
|
|
None
|
image_path
|
str | None
|
|
None
|
image_url
|
str | None
|
|
None
|
image_mimetype
|
str | None
|
|
None
|
text_embedding
|
List[float] | None
|
Text embedding of image node, if text field is filled out |
None
|
Source code in llama-index-core/llama_index/core/schema.py
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 |
|
resolve_image #
resolve_image() -> ImageType
Resolve an image such that PIL can read it.
Source code in llama-index-core/llama_index/core/schema.py
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
IndexNode #
Bases: TextNode
Node with reference to any object.
This can include other indices, query engines, retrievers.
This can also include other nodes (though this is overlapping with relationships
on the Node class).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
index_id
|
str
|
|
required |
obj
|
Any
|
|
None
|
Source code in llama-index-core/llama_index/core/schema.py
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 |
|
from_text_node
classmethod
#
Create index node from text node.
Source code in llama-index-core/llama_index/core/schema.py
573 574 575 576 577 578 579 580 581 582 583 584 |
|
NodeWithScore #
Bases: BaseComponent
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node
|
BaseNode
|
|
required |
score
|
float | None
|
|
None
|
Source code in llama-index-core/llama_index/core/schema.py
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 |
|
get_score #
get_score(raise_error: bool = False) -> float
Get score.
Source code in llama-index-core/llama_index/core/schema.py
626 627 628 629 630 631 632 633 634 |
|
Document #
Bases: TextNode
Generic interface for a data document.
This document connects to data sources.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id_
|
str
|
Unique ID of the node. |
'804c3332-bda6-4495-9971-42fb4b9bc8c2'
|
Source code in llama-index-core/llama_index/core/schema.py
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 |
|
get_type
classmethod
#
get_type() -> str
Get Document type.
Source code in llama-index-core/llama_index/core/schema.py
696 697 698 699 |
|
get_doc_id #
get_doc_id() -> str
TODO: Deprecated: Get document ID.
Source code in llama-index-core/llama_index/core/schema.py
715 716 717 |
|
to_langchain_format #
to_langchain_format() -> Document
Convert struct to LangChain document format.
Source code in llama-index-core/llama_index/core/schema.py
724 725 726 727 728 729 |
|
from_langchain_format
classmethod
#
from_langchain_format(doc: Document) -> Document
Convert struct from LangChain document format.
Source code in llama-index-core/llama_index/core/schema.py
731 732 733 734 735 736 |
|
to_haystack_format #
to_haystack_format() -> Document
Convert struct to Haystack document format.
Source code in llama-index-core/llama_index/core/schema.py
738 739 740 741 742 743 744 |
|
from_haystack_format
classmethod
#
from_haystack_format(doc: Document) -> Document
Convert struct from Haystack document format.
Source code in llama-index-core/llama_index/core/schema.py
746 747 748 749 750 751 |
|
to_embedchain_format #
to_embedchain_format() -> Dict[str, Any]
Convert struct to EmbedChain document format.
Source code in llama-index-core/llama_index/core/schema.py
753 754 755 756 757 758 |
|
from_embedchain_format
classmethod
#
from_embedchain_format(doc: Dict[str, Any]) -> Document
Convert struct from EmbedChain document format.
Source code in llama-index-core/llama_index/core/schema.py
760 761 762 763 764 765 766 767 |
|
to_semantic_kernel_format #
to_semantic_kernel_format() -> MemoryRecord
Convert struct to Semantic Kernel document format.
Source code in llama-index-core/llama_index/core/schema.py
769 770 771 772 773 774 775 776 777 778 779 |
|
from_semantic_kernel_format
classmethod
#
from_semantic_kernel_format(doc: MemoryRecord) -> Document
Convert struct from Semantic Kernel document format.
Source code in llama-index-core/llama_index/core/schema.py
781 782 783 784 785 786 787 788 789 |
|
to_vectorflow #
to_vectorflow(client: Any) -> None
Send a document to vectorflow, since they don't have a document object.
Source code in llama-index-core/llama_index/core/schema.py
791 792 793 794 795 796 797 798 799 |
|
to_cloud_document #
to_cloud_document() -> CloudDocument
Convert to LlamaCloud document type.
Source code in llama-index-core/llama_index/core/schema.py
812 813 814 815 816 817 818 819 820 821 822 |
|
from_cloud_document
classmethod
#
from_cloud_document(doc: CloudDocument) -> Document
Convert from LlamaCloud document type.
Source code in llama-index-core/llama_index/core/schema.py
824 825 826 827 828 829 830 831 832 833 834 835 836 |
|
ImageDocument #
QueryBundle
dataclass
#
Bases: DataClassJsonMixin
Query bundle.
This dataclass contains the original query string and associated transformations.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
query_str
|
str
|
the original user-specified query string. This is currently used by all non embedding-based queries. |
required |
custom_embedding_strs
|
list[str]
|
list of strings used for embedding the query. This is currently used by all embedding-based queries. |
required |
embedding
|
list[float]
|
the stored embedding for the query. |
required |
image_path
|
str | None
|
|
None
|
Source code in llama-index-core/llama_index/core/schema.py
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
|