langchain_qdrant.fastembed_sparse.FastEmbedSparse

class langchain_qdrant.fastembed_sparse.FastEmbedSparse(model_name: str = 'Qdrant/bm25', batch_size: int = 256, cache_dir: Optional[str] = None, threads: Optional[int] = None, providers: Optional[Sequence[Any]] = None, parallel: Optional[int] = None, **kwargs: Any)[source]

与 Qdrant 一起使用的稀疏嵌入模型接口。

使用 FastEmbed 实现的稀疏编码器 - https://qdrant.github.io/fastembed/ 可用模型列表请见 https://qdrant.github.io/fastembed/examples/Supported_Models/

参数

  • model_name (str) – 要使用的模型的名称。默认为“Qdrant/bm25”。

  • batch_size (int) – 编码的批大小。默认为 256。

  • cache_dir (str, 可选) – 模型缓存目录的路径。也可以通过“FASTEMBED_CACHE_PATH”环境变量设置。

  • threads (int, 可选) – onnxruntime 会话可以使用的线程数。

  • providers (Sequence[Any], 可选) – ONNX 执行提供者列表。parallel (int, 可选): 如果 >1，将使用数据并行编码，推荐用于大型数据集的编码。如果 0，使用所有可用核心。如果 None，则不使用数据并行处理，使用默认的 onnxruntime 线程。默认为 None。

  • kwargs (Any) – 传递给 fastembed.SparseTextEmbedding 的附加选项

  • parallel (Optional[int]) –

异常

ValueError – 如果 model_name 在 SparseTextEmbedding 中不受支持。

方法

__init__([model_name, batch_size, ...])

使用 FastEmbed 实现的稀疏编码器 - https://qdrant.github.io/fastembed/ 可用模型列表请见 https://qdrant.github.io/fastembed/examples/Supported_Models/

aembed_documents(texts)

异步嵌入搜索文档。

aembed_query(text)

异步嵌入查询文本。

embed_documents(texts)

嵌入搜索文档。

embed_query(text)

嵌入查询文本。
__init__(model_name: str = 'Qdrant/bm25', batch_size: int = 256, cache_dir: Optional[str] = None, threads: Optional[int] = None, providers: Optional[Sequence[Any] = None, parallel: Optional[int] = None, **kwargs: Any) → None[source]

使用 FastEmbed 实现的稀疏编码器 - https://qdrant.github.io/fastembed/ 可用模型列表请见 https://qdrant.github.io/fastembed/examples/Supported_Models/

参数

  • model_name (str) – 要使用的模型的名称。默认为“Qdrant/bm25”。

  • batch_size (int) – 编码的批大小。默认为 256。

  • cache_dir (str, 可选) – 模型缓存目录的路径。也可以通过“FASTEMBED_CACHE_PATH”环境变量设置。

  • threads (int, 可选) – onnxruntime 会话可以使用的线程数。

  • providers (Sequence[Any], 可选) – ONNX 执行提供者列表。parallel (int, 可选): 如果 >1，将使用数据并行编码，推荐用于大型数据集的编码。如果 0，使用所有可用核心。如果 None，则不使用数据并行处理，使用默认的 onnxruntime 线程。默认为 None。

  • kwargs (Any) – 传递给 fastembed.SparseTextEmbedding 的附加选项

  • parallel (Optional[int]) –

异常

ValueError – 如果 model_name 在 SparseTextEmbedding 中不受支持。

返回类型

None

async aembed_documents(texts: List[str]) → List[SparseVector]

异步嵌入搜索文档。

参数

texts (列表<字符串><) –

返回类型

列表[SparseVector]

async aembed_query(text: str) → SparseVector

异步嵌入查询文本。

参数

text (str) –

返回类型

SparseVector

embed_documents(texts: List[str]) → List[SparseVector][source]

嵌入搜索文档。

参数

texts (列表<字符串><) –

返回类型

列表[SparseVector]

embed_query(text: str) → SparseVector[source]

嵌入查询文本。

参数

text (str) –

返回类型

SparseVector