跳到主要内容
版本:V1.1.0

Jina AI

Jina AI 提供多种 Embedding 模型,可用于语义检索及相关检索任务。seekdb 提供 JinaEmbeddingFunction 封装,用于在写入 documents 或使用 query_texts 查询时,自动调用 Jina 生成向量并完成相似性检索。

提示

使用 Jina AI 服务需要遵循 Jina AI 的收费规则,可能产生相应费用。请在继续前,访问其官网或查阅相关文档,确认并接受其收费标准。如不同意,请勿继续操作。

依赖与鉴权

使用该 Embedding Function 通常需要:

  • 已获取 Jina AI API Key,并具备调用目标 Embedding 模型的权限
  • 鉴权可通过参数传入 API Key,或通过环境变量提供(默认读取 JINA_API_KEY);若使用其他环境变量名,可通过 apiKeyEnvVar 指定

安装

npm i seekdb @seekdb/jina

示例:创建 Jina Embedding Function

import { JinaEmbeddingFunction } from "@seekdb/jina";

const ef = new JinaEmbeddingFunction({
modelName: "jina-clip-v2",
// apiKeyEnvVar: "JINA_API_KEY",
});

配置项说明:

  • apiKey:Jina API Key(可选;若不提供,则尝试从环境变量读取)
  • apiKeyEnvVar:API Key 的环境变量名(默认:"JINA_API_KEY"
  • modelName:Embedding 模型名称(默认:"jina-clip-v2"