Vectorindex
VectorIndexing ¶
Bases: BaseIndexing
Ingest the document, run through the embedding, and store the embedding in a vector store.
This pipeline supports the following set of inputs
- List of documents
- List of texts
Source code in libs\kotaemon\kotaemon\indices\vectorindex.py
to_retrieval_pipeline ¶
Convert the indexing pipeline to a retrieval pipeline
Source code in libs\kotaemon\kotaemon\indices\vectorindex.py
VectorRetrieval ¶
Bases: BaseRetrieval
Retrieve list of documents from vector store
Source code in libs\kotaemon\kotaemon\indices\vectorindex.py
run ¶
Retrieve a list of documents from vector store
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str | Document
|
the text to retrieve similar documents |
required |
top_k |
Optional[int]
|
number of top similar documents to return |
None
|
Returns:
Type | Description |
---|---|
list[RetrievedDocument]
|
list[RetrievedDocument]: list of retrieved documents |