SentenceTransformersSparseTextEmbedder

Sentence Transformers 모델을 사용해 단일 문자열(예: 쿼리)을 희소(sparse) 벡터로 임베딩하는 컴포넌트예요.

출처: 문서

본문

항목	내용
파이프라인에서 가장 흔한 위치	쿼리/RAG 파이프라인에서 희소 임베딩 Retriever 앞
필수 run 변수	`text`: 문자열
출력 변수	`sparse_embedding`: `SparseEmbedding` 객체
API reference	Sentence Transformers
GitHub 링크	sentence_transformers 통합
패키지 이름	`sentence-transformers-haystack`

문서 목록을 임베딩하려면 SentenceTransformersSparseDocumentEmbedder를 사용하세요. 이 컴포넌트는 계산된 희소 임베딩으로 문서를 풍부하게 만들어요.

개요

SentenceTransformersSparseTextEmbedder는 Sentence Transformers 라이브러리가 지원하는 희소 임베딩 모델을 사용해 문자열을 희소 벡터로 변환해요.

희소 임베딩 검색을 수행할 때는 이 컴포넌트를 먼저 사용해 쿼리를 희소 벡터로 변환하세요. 그러면 Retriever가 그 희소 벡터로 유사하거나 관련 있는 문서를 검색해요.

호환 모델

기본 임베딩 모델은 prithivida/Splade_PP_en_v2예요. 컴포넌트 초기화 시 model 파라미터로 다른 모델을 지정할 수 있어요.

호환 모델은 SPLADE(SParse Lexical AnD Expansion)에 기반해요. SPLADE는 텍스트의 희소 표현을 만드는 기법으로, 임베딩의 각 0이 아닌 값은 어휘에서 용어의 중요도 가중치를 나타내요. 이 접근 방식은 학습된 희소 표현의 장점과 전통적인 희소 검색 방법의 효율성을 결합하죠. 자세한 내용은 희소 임베딩 기반 Retriever를 설명하는 우리 문서를 참고하세요.

호환되는 SPLADE 모델은 Hugging Face Model Hub에서 찾을 수 있어요.

인증

Hugging Face API 토큰 인증은 비공개 또는 게이트 모델에만 필요해요.

컴포넌트는 HF_API_TOKEN 또는 HF_TOKEN 환경 변수를 사용하거나, 초기화 시 Hugging Face API 토큰을 전달할 수 있어요. 자세한 내용은 Secret Management 페이지를 참고하세요.

from haystack.utils import Secret
from haystack_integrations.components.embedders.sentence_transformers import (
    SentenceTransformersSparseTextEmbedder,
)

text_embedder = SentenceTransformersSparseTextEmbedder(
    token=Secret.from_token("<your-api-key>"),
)

백엔드 옵션

이 컴포넌트는 모델 실행을 위해 여러 백엔드를 지원해요.

torch (기본값): 표준 PyTorch 백엔드
onnx: 더 빠른 추론을 위한 최적화된 ONNX Runtime 백엔드
openvino: Intel 하드웨어에서 추가 최적화를 제공하는 Intel OpenVINO 백엔드

초기화 중에 백엔드를 지정할 수 있어요:

embedder = SentenceTransformersSparseTextEmbedder(
    model="prithivida/Splade_PP_en_v2",
    backend="onnx",
)

가속 및 양자화 옵션에 대한 자세한 내용은 Sentence Transformers 문서를 참고하세요.

접두사와 접미사

일부 모델은 임베딩 전에 텍스트에 접두사나 접미사를 추가하는 것이 유용할 수 있어요. 초기화 중에 지정할 수 있죠:

embedder = SentenceTransformersSparseTextEmbedder(
    model="prithivida/Splade_PP_en_v2",
    prefix="query: ",
    suffix="",
)

팁: 같은 모델 기반의 Sparse Text Embedder와 Sparse Document Embedder를 만들면, Haystack이 리소스를 절약하기 위해 뒤에서 같은 리소스를 사용하도록 처리해요.

사용법

SentenceTransformersSparseTextEmbedder를 사용하려면 sentence-transformers-haystack 패키지를 설치하세요:

pip install sentence-transformers-haystack

단독으로 사용하기

from haystack_integrations.components.embedders.sentence_transformers import (
    SentenceTransformersSparseTextEmbedder,
)

text_to_embed = "I love pizza!"
text_embedder = SentenceTransformersSparseTextEmbedder()
print(text_embedder.run(text_to_embed))
# {'sparse_embedding': SparseEmbedding(indices=[999, 1045, ...], values=[0.918, 0.867, ...])}

파이프라인에서 사용하기

현재 희소 임베딩 검색은 QdrantDocumentStore만 지원해요.

먼저 필요한 패키지를 설치하세요:

pip install qdrant-haystack

그런 다음 이 파이프라인을 시도해 보세요:

from haystack import Document, Pipeline
from haystack_integrations.components.embedders.sentence_transformers import (
    SentenceTransformersSparseDocumentEmbedder,
    SentenceTransformersSparseTextEmbedder,
)
from haystack_integrations.components.retrievers.qdrant import (
    QdrantSparseEmbeddingRetriever,
)
from haystack_integrations.document_stores.qdrant import QdrantDocumentStore

document_store = QdrantDocumentStore(
    ":memory:",
    recreate_index=True,
    use_sparse_embeddings=True,
)

documents = [
    Document(content="My name is Wolfgang and I live in Berlin"),
    Document(content="I saw a black horse running"),
    Document(content="Germany has many big cities"),
    Document(content="Sentence Transformers provides sparse embedding models."),
]

# Embed and write documents
sparse_document_embedder = SentenceTransformersSparseDocumentEmbedder(
    model="prithivida/Splade_PP_en_v2",
)
documents_with_sparse_embeddings = sparse_document_embedder.run(documents)["documents"]
document_store.write_documents(documents_with_sparse_embeddings)

# Query pipeline
query_pipeline = Pipeline()
query_pipeline.add_component(
    "sparse_text_embedder",
    SentenceTransformersSparseTextEmbedder(),
)
query_pipeline.add_component(
    "sparse_retriever",
    QdrantSparseEmbeddingRetriever(document_store=document_store),
)
query_pipeline.connect(
    "sparse_text_embedder.sparse_embedding",
    "sparse_retriever.query_sparse_embedding",
)

query = "Who provides sparse embedding models?"
result = query_pipeline.run({"sparse_text_embedder": {"text": query}})
print(result["sparse_retriever"]["documents"][0])
# Document(id=...,
#  content: 'Sentence Transformers provides sparse embedding models.',
#  score: 0.56...)

SentenceTransformersSparseTextEmbedder