SimilaritySearchKit 使用教程

SimilaritySearchKit 使用教程

similarity-search-kit🔎 SimilaritySearchKit is a Swift package providing on-device text embeddings and semantic search functionality for iOS and macOS applications.项目地址:https://gitcode.com/gh_mirrors/si/similarity-search-kit

项目介绍

SimilaritySearchKit 是一个 Swift 包，提供设备上的文本嵌入和语义搜索功能，适用于 iOS 和 macOS 应用程序。该项目利用预训练模型和向量嵌入技术，支持自然语言处理（NLP）、信息检索、问答系统和语义相似度计算。

项目快速启动

安装

首先，在 Package.swift 文件中添加 SimilaritySearchKit 依赖：

dependencies: [
    .package(url: "https://github.com/ZachNagengast/similarity-search-kit.git", from: "0.0.1")
]

然后，在目标依赖中添加：

targets: [
    .target(
        name: "YourTarget",
        dependencies: ["SimilaritySearchKit"]
    )
]

使用

导入框架并创建 SimilarityIndex 实例：

import SimilaritySearchKit

let similarityIndex = await SimilarityIndex(
    model: NativeEmbeddings(),
    metric: CosineSimilarity()
)

添加文本到索引：

await similarityIndex.addItem(
    id: "id1",
    text: "Metal was released in June 2014",
    metadata: ["source": "example pdf"]
)

查询索引：

let results = await similarityIndex.search("When was metal released")
print(results)

应用案例和最佳实践

基本示例

创建一个基本的多平台应用程序，索引并比较一组硬编码字符串的相似度。

PDF 示例

使用 SimilaritySearchKit 索引 PDF 文档内容，实现文档内搜索和相似度比较。

典型生态项目

CoreML 和 Apple Neural Engine

利用 CoreML 和 Apple Neural Engine 加速距离计算和模型推理，提高搜索效率和响应速度。

预训练模型

SimilaritySearchKit 支持多种预训练模型，如 DistilBERT 和 MiniLM，可根据需求选择合适的模型进行文本嵌入和语义搜索。

通过以上步骤，您可以快速启动并使用 SimilaritySearchKit 进行文本嵌入和语义搜索，实现高效的信息检索和问答系统。

similarity-search-kit🔎 SimilaritySearchKit is a Swift package providing on-device text embeddings and semantic search functionality for iOS and macOS applications.项目地址:https://gitcode.com/gh_mirrors/si/similarity-search-kit