@energetic-ai/embeddings

中文文档
0.2.0发布于 2023/06/12Apache-2.0TypeScriptCommonJS零依赖近 30 天下载 3857

Fast, easy-to-use AI text embeddings, optimized for serverless functions.

原始使用文档
文档目录6 节
  1. Install
  2. Usage
  3. Examples
  4. Development
  5. License
  6. Acknowledgements

EnergeticAI

Fast, easy-to-use AI sentence embeddings, optimized for serverless functions.

EnergeticAI Embeddings

EnergeticAI Embeddings is a library for computing sentence embeddings, which are vector representations of sentences that capture their meaning.

Sentence embeddings can be used for semantic search, recommendations, clustering, and more.

It leverages the Universal Sentence Encoder model from Google Research, which is trained on a variety of data sources and outputs 512-dimensional embeddings.

Install

Install this package, along with @energetic-ai/core and model weights (e.g. @energetic-ai/model-embeddings-en):

npm install @energetic-ai/core @energetic-ai/embeddings @energetic-ai/model-embeddings-en

Usage

You can easily call this method to compute embeddings for a list of sentences, and compare distances:

import { initModel, distance } from "@energetic-ai/embeddings";
import { modelSource } from "@energetic-ai/model-embeddings-en";
(async () => {
  const model = await initModel(modelSource);
  const embeddings = await model.embed(["hello", "world"]);
  console.log(distance(embeddings[0], embeddings[1])));
})();

Examples

See the examples directory for examples.

Development

This repository uses Lerna to manage packages, and Vitest to run tests.

Run tests with this method:

npm run test

License

Apache 2.0, except for dependencies.

Acknowledgements

This project is derived from TensorFlow.js and the Universal Sentence Encoder model library, which are also Apache 2.0 licensed.

版本与发布记录

@energetic-ai/embeddings 共发布 5 个版本,首次发布于 2023/06/03;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.2.0latest2023/06/123 年前
0.1.32023/06/083 年前
0.1.22023/06/063 年前
0.1.12023/06/043 年前
0.1.02023/06/033 年前

关于 @energetic-ai/embeddings 的常见问题

@energetic-ai/embeddings 是什么?

Fast, easy-to-use AI text embeddings, optimized for serverless functions.

如何安装 @energetic-ai/embeddings?

在项目目录运行 npm install @energetic-ai/embeddings,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@energetic-ai/core(^0.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@energetic-ai/embeddings 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@energetic-ai/embeddings 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@energetic-ai/embeddings 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@energetic-ai/embeddings 可以商用吗?

@energetic-ai/embeddings 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@energetic-ai/embeddings 的下载量有多少?

根据 npm 官方下载统计,@energetic-ai/embeddings 在 2026/10/14 – 2026/11/12 这 30 天内被下载 3,857 次,日均约 129 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@energetic-ai/embeddings 还在维护吗?

最新版本 0.2.0 发布于 2023/06/12(3 年前);至今共发布 5 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/06/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。