FastEmbedSparse#

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

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

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

Parameters:

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

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

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

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

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

  • kwargs (Any) – 传递给 fastembed.SparseTextEmbedding 的额外选项

  • parallel (int | None)

Raises:

ValueError – 如果 SparseTextEmbedding 中不支持 model_name。

方法

__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: str | None = None, threads: int | None = None, providers: Sequence[Any] | None = None, parallel: int | None = None, **kwargs: Any) → None[source]#

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

Parameters:

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

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

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

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

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

  • kwargs (Any) – 传递给 fastembed.SparseTextEmbedding 的额外选项

  • parallel (int | None)

Raises:

ValueError – 如果 SparseTextEmbedding 中不支持 model_name。

Return type:

无

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

异步嵌入搜索文档。

Parameters:

文本 (列表[字符串])

Return type:

列表[SparseVector]

async aembed_query(text: str) → SparseVector#

异步嵌入查询文本。

Parameters:

文本 (str)

Return type:

SparseVector

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

嵌入搜索文档。

Parameters:

文本 (列表[字符串])

Return type:

列表[SparseVector]

embed_query(text: str) → SparseVector[source]#

嵌入查询文本。

Parameters:

文本 (str)

Return type:

SparseVector