WeaviateEmbeddingRetriever

Weaviate Document Store와 호환되는 임베딩 기반 Retriever예요. 쿼리와 문서 임베딩을 비교해서 관련 문서를 가져와요.

파이프라인에서 가장 흔한 위치: 1. RAG 파이프라인에서 Text Embedder 다음, PromptBuilder 앞 / 2. 의미 검색 파이프라인의 마지막 컴포넌트 / 3. 추출형 QA 파이프라인에서 Text Embedder 다음, TransformersExtractiveReader 앞 필수 init 변수: document_store — WeaviateDocumentStore 인스턴스 필수 run 변수: query_embedding — float 리스트 출력 변수: documents — 문서 리스트 API 레퍼런스: Weaviate GitHub 링크: https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/weaviate 패키지 이름: weaviate-haystack

출처: 문서

본문

개요 (Overview)

WeaviateEmbeddingRetriever는 WeaviateDocumentStore와 호환되는 임베딩 기반 Retriever예요. 쿼리와 Document 임베딩을 비교하고, 그 결과에 따라 WeaviateDocumentStore에서 쿼리와 가장 관련 있는 Document를 가져와요.

파라미터 (Parameters)

NLP 시스템에서 WeaviateEmbeddingRetriever를 쓸 때는 쿼리와 Document 임베딩이 준비돼 있어야 해요. 인덱싱 파이프라인에 Document Embedder를, 쿼리 파이프라인에 Text Embedder를 추가하면 돼요.

query_embedding 외에도 WeaviateEmbeddingRetriever는 top_k(가져올 최대 Document 수)와 filters(검색 범위를 좁히는 데 쓰임) 같은 선택적 파라미터를 받아요.

또한 distance(임베딩 사이의 허용 최대 거리)와 certainty(결과 항목과 검색 임베딩 사이의 정규화된 거리)를 지정할 수 있어요. distance의 동작은 컬렉션(Collection)에서 사용하는 거리 메트릭에 따라 달라져요. 자세한 내용은 공식 Weaviate 문서를 참고하세요.

임베딩 유사도 함수는 WeaviateDocumentStore 컬렉션에서 사용하는 벡터라이저에 따라 달라져요. 지원되는 모든 벡터라이저는 공식 Weaviate 문서에서 확인할 수 있어요.

사용법 (Usage)

설치 (Installation)

Haystack에서 Weaviate를 쓰려면 패키지를 설치해요:

pip install weaviate-haystack

단독으로 사용하기 (On its own)

이 Retriever는 동작하려면 WeaviateDocumentStore 인스턴스와 인덱싱된 Document가 필요해요.

from haystack_integrations.document_stores.weaviate.document_store import (
    WeaviateDocumentStore,
)
from haystack_integrations.components.retrievers.weaviate import (
    WeaviateEmbeddingRetriever,
)

document_store = WeaviateDocumentStore(url="http://localhost:8080")
retriever = WeaviateEmbeddingRetriever(document_store=document_store)
# using a fake vector to keep the example simpler
retriever.run(query_embedding=[0.1] * 768)

파이프라인 안에서 사용하기 (In a Pipeline)

이 페이지의 예시들은 sentence-transformers-haystack 패키지의 Sentence Transformers embedder를 사용해요. 예시를 실행하려면 설치하세요:

pip install sentence-transformers-haystack

from haystack.document_stores.types import DuplicatePolicy
from haystack import Document
from haystack import Pipeline
from haystack_integrations.components.embedders.sentence_transformers import (
    SentenceTransformersTextEmbedder,
    SentenceTransformersDocumentEmbedder,
)
from haystack_integrations.document_stores.weaviate.document_store import (
    WeaviateDocumentStore,
)
from haystack_integrations.components.retrievers.weaviate import (
    WeaviateEmbeddingRetriever,
)

document_store = WeaviateDocumentStore(url="http://localhost:8080")
documents = [
    Document(content="There are over 7,000 languages spoken around the world today."),
    Document(
        content="Elephants have been observed to behave in a way that indicates a high level of self-awareness, such as recognizing themselves in mirrors.",
    ),
    Document(
        content="In certain parts of the world, like the Maldives, Puerto Rico, and San Diego, you can witness the phenomenon of bioluminescent waves.",
    ),
]
document_embedder = SentenceTransformersDocumentEmbedder()
documents_with_embeddings = document_embedder.run(documents)

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

query_pipeline = Pipeline()
query_pipeline.add_component("text_embedder", SentenceTransformersTextEmbedder())
query_pipeline.add_component(
    "retriever",
    WeaviateEmbeddingRetriever(document_store=document_store),
)
query_pipeline.connect("text_embedder.embedding", "retriever.query_embedding")

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

WeaviateEmbeddingRetriever