FalkorDBEmbeddingRetriever

FalkorDBEmbeddingRetriever

FalkorDB Document Store와 호환되는 임베딩 기반 리트리버예요.

출처: 문서

본문

• 파이프라인에서의 일반적인 위치: 1. RAG 파이프라인에서 Text Embedder 뒤, PromptBuilder 앞. 2. 시맨틱 검색 파이프라인의 마지막 컴포넌트.
• 필수 초기화 변수: document_store(FalkorDBDocumentStore 인스턴스)
• 필수 실행 변수: query_embedding(쿼리를 나타내는 벡터, float 리스트)
• 출력 변수: documents(문서 리스트)

개요 (Overview)

FalkorDBEmbeddingRetriever는 FalkorDB의 네이티브 벡터 인덱스를 사용해 FalkorDBDocumentStore에서 문서를 검색해요. 쿼리 임베딩을 문서 임베딩과 비교해 가장 유사한 문서를 반환해요.

query_embedding 외에도 이 리트리버는 검색 공간을 좁히는 선택적 filters와 결과 수를 제한하는 top_k를 받아요.

임베딩 차원과 유사도 함수는 초기화 시 FalkorDBDocumentStore에 설정해요.

설치 (Installation)

pip install falkordb-haystack

FalkorDB가 실행 중인지 확인하세요. 예를 들어 Docker로 실행할 수 있어요.

docker run -d -p 6379:6379 falkordb/falkordb:latest

이 페이지의 예시는 sentence-transformers-haystack 패키지의 Sentence Transformers 임베더를 사용해요. 예시를 실행하려면 설치하세요.

pip install sentence-transformers-haystack

사용법 (Usage)

단독 사용 (On its own)

from haystack import Document
from haystack_integrations.document_stores.falkordb import FalkorDBDocumentStore
from haystack_integrations.components.retrievers.falkordb import (
    FalkorDBEmbeddingRetriever,
)

document_store = FalkorDBDocumentStore(
    host="localhost",
    port=6379,
    embedding_dim=3,
    recreate_graph=True,
)
document_store.write_documents(
    [
        Document(
            content="There are over 7,000 languages spoken around the world today.",
            embedding=[0.1, 0.2, 0.3],
        ),
        Document(
            content="Elephants have been observed to recognize themselves in mirrors.",
            embedding=[0.8, 0.1, 0.5],
        ),
    ],
)

retriever = FalkorDBEmbeddingRetriever(document_store=document_store, top_k=1)
result = retriever.run(query_embedding=[0.1, 0.2, 0.3])
print(result["documents"][0].content)

파이프라인에서 사용 (In a pipeline)

from haystack import Document, Pipeline
from haystack.document_stores.types import DuplicatePolicy
from haystack_integrations.components.embedders.sentence_transformers import (
    SentenceTransformersDocumentEmbedder,
    SentenceTransformersTextEmbedder,
)
from haystack_integrations.document_stores.falkordb import FalkorDBDocumentStore
from haystack_integrations.components.retrievers.falkordb import (
    FalkorDBEmbeddingRetriever,
)

document_store = FalkorDBDocumentStore(
    host="localhost",
    port=6379,
    embedding_dim=384,
    recreate_graph=True,
)

documents = [
    Document(content="There are over 7,000 languages spoken around the world today."),
    Document(
        content="Elephants have been observed to recognize themselves in mirrors.",
    ),
    Document(
        content="Bioluminescent waves can be seen in the Maldives and Puerto Rico.",
    ),
]

document_embedder = SentenceTransformersDocumentEmbedder(
    model="sentence-transformers/all-MiniLM-L6-v2",
)
documents_with_embeddings = document_embedder.run(documents)

document_store.write_documents(
    documents_with_embeddings["documents"],
    policy=DuplicatePolicy.OVERWRITE,
)

query_pipeline = Pipeline()
query_pipeline.add_component(
    "text_embedder",
    SentenceTransformersTextEmbedder(model="sentence-transformers/all-MiniLM-L6-v2"),
)
query_pipeline.add_component(
    "retriever",
    FalkorDBEmbeddingRetriever(document_store=document_store, top_k=3),
)
query_pipeline.connect("text_embedder.embedding", "retriever.query_embedding")

result = query_pipeline.run(
    {"text_embedder": {"text": "How many languages are there?"}},
)
print(result["retriever"]["documents"][0].content)

더 알아보기 (Learn more)