Faiss

FaissReader

Bases: BaseReader

Faiss阅读器。

通过现有的内存中的Faiss索引检索文档。 然后可以在下游的LlamaIndex数据结构中使用这些文档。 如果您希望使用Faiss本身作为索引来组织文档、插入文档并对其执行查询， 请使用带有FaissVectorStore的VectorStoreIndex。

Source code in llama_index/readers/faiss/base.py

class FaissReader(BaseReader):
    """Faiss阅读器。

    通过现有的内存中的Faiss索引检索文档。
    然后可以在下游的LlamaIndex数据结构中使用这些文档。
    如果您希望使用Faiss本身作为索引来组织文档、插入文档并对其执行查询，
    请使用带有FaissVectorStore的VectorStoreIndex。

    Args:
        faiss_index（faiss.Index）：Faiss索引对象（必需）"""

    def __init__(self, index: Any):
        """使用参数进行初始化。"""
        import_err_msg = """
            `faiss` package not found. For instructions on
            how to install `faiss` please visit
            https://github.com/facebookresearch/faiss/wiki/Installing-Faiss
        """
        try:
            import faiss  # noqa
        except ImportError:
            raise ImportError(import_err_msg)

        self._index = index

    def load_data(
        self,
        query: np.ndarray,
        id_to_text_map: Dict[str, str],
        k: int = 4,
        separate_documents: bool = True,
    ) -> List[Document]:
        """从Faiss加载数据。

Args:
    query（np.ndarray）：查询向量的二维numpy数组。
    id_to_text_map（Dict[str, str]）：ID到文本的映射。
    k（int）：要检索的最近邻居的数量。默认为4。
    separate_documents（Optional[bool]）：是否返回单独的文档。默认为True。

Returns:
    List[Document]：文档列表。
"""
        dists, indices = self._index.search(query, k)
        documents = []
        for qidx in range(indices.shape[0]):
            for didx in range(indices.shape[1]):
                doc_id = indices[qidx, didx]
                if doc_id not in id_to_text_map:
                    raise ValueError(
                        f"Document ID {doc_id} not found in id_to_text_map."
                    )
                text = id_to_text_map[doc_id]
                documents.append(Document(text=text))

        if not separate_documents:
            # join all documents into one
            text_list = [doc.get_content() for doc in documents]
            text = "\n\n".join(text_list)
            documents = [Document(text=text)]

        return documents

load_data

load_data(
    query: ndarray,
    id_to_text_map: Dict[str, str],
    k: int = 4,
    separate_documents: bool = True,
) -> List[Document]

从Faiss加载数据。

Returns:

Type	Description
List[Document]	List[Document]：文档列表。

Source code in llama_index/readers/faiss/base.py

    def load_data(
        self,
        query: np.ndarray,
        id_to_text_map: Dict[str, str],
        k: int = 4,
        separate_documents: bool = True,
    ) -> List[Document]:
        """从Faiss加载数据。

Args:
    query（np.ndarray）：查询向量的二维numpy数组。
    id_to_text_map（Dict[str, str]）：ID到文本的映射。
    k（int）：要检索的最近邻居的数量。默认为4。
    separate_documents（Optional[bool]）：是否返回单独的文档。默认为True。

Returns:
    List[Document]：文档列表。
"""
        dists, indices = self._index.search(query, k)
        documents = []
        for qidx in range(indices.shape[0]):
            for didx in range(indices.shape[1]):
                doc_id = indices[qidx, didx]
                if doc_id not in id_to_text_map:
                    raise ValueError(
                        f"Document ID {doc_id} not found in id_to_text_map."
                    )
                text = id_to_text_map[doc_id]
                documents.append(Document(text=text))

        if not separate_documents:
            # join all documents into one
            text_list = [doc.get_content() for doc in documents]
            text = "\n\n".join(text_list)
            documents = [Document(text=text)]

        return documents