# @getmetal/metal-sdk 中文文档

规范地址：https://npmcn.com/package/%40getmetal/metal-sdk/

版本：7\.7\.1
npm 元数据更新时间：2023-11-09T22:49:39.441Z
中文译文更新时间：2026-11-16T06:25:13.853Z
软件包许可：Apache 2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40getmetal/metal-sdk
原文对照：https://npmcn.com/package/%40getmetal/metal-sdk/?lang=original
项目主页：https://getmetal.io/
源码仓库：https://github.com/getmetal/metal-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：90.9 kB，31 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- 首次发布：2023-02-06T05:23:23.351Z
- 最新版本发布：2023-11-09T22:49:39.235Z
- 近 30 天下载量：29024（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 0 个）

## 中文简介

金属 SDK

## 安装

```sh
npm install @getmetal/metal-sdk
```

也可以使用：`pnpm add @getmetal/metal-sdk`、`yarn add @getmetal/metal-sdk`、`bun add @getmetal/metal-sdk`

## README

# 金属节点 SDK

[**开发者文档**](https://docs.getmetal.io/sdk-typescript)

## 安装

```bash
  npm install @getmetal/metal-sdk
  # or
  yarn add @getmetal/metal-sdk
```

## 检索使用

### 设置

```ts
import { Metal } from '@getmetal/metal-sdk'
const metal = new Metal('pk_123', 'ci_123', 'idx_123')
```

### 索引编制

```ts
import { Metal } from '@getmetal/metal-sdk'

const metal = new Metal('api-key', 'client-id', 'index-id')

// Index Text
await metal.index({
  id: '666', // Id is optional <> if not provided, Metal will generate one
  text: 'Ozzy Osbourne',
  metadata: { band: 'Black Sabbath' },
})

// Index Image from URL
await metal.index({ imageUrl: 'https://image.png' })
// Index Image from Base64
await metal.index({ imageBase64: '<base-64-str>' })
```

### 搜索中

```ts
import { Metal } from '@getmetal/metal-sdk'

const metal = new Metal('api-key', 'client-id', 'index-id')

// Search Text
await metal.search({
  text: 'Who is the lead singer of Black Sabbath?',
  limit: 1,
})

await metal.search({ imageUrl: 'search-by-image.png' })

// Filtered Search
await metal.search({
  text: 'Heavy Metal',
  filters: [{ field: 'band', value: 'Black Sabbath' }],
})
```

## 内存使用

### 设置

```ts
import { Motorhead } from '@getmetal/metal-sdk'
const motor = new Motorhead({ apiKey: 'pk_123', clientId: 'ci_123' })
```

### 添加内存

```ts
const memoryPayload = {
  messages: [
    { role: 'Human', content: 'Who is the best vocalist of all time?' },
    { role: 'AI', content: 'Ozzy!' },
  ],
  context: 'User ask what can he eat in Colombia. The AI responds arepas are really nice',
}

await motorhead.addMemory('session-id', memoryPayload)
```

### 获取内存

```ts
await motorhead.getMemory('session-id')
```

* * *

查看完整文档 [https://docs.getmetal.io/sdks/节点](https://docs.getmetal.io/sdks/node)

## 常见问题

### @getmetal/metal-sdk 是什么？

金属 SDK

### 如何安装 @getmetal/metal-sdk？

在项目目录运行 npm install @getmetal/metal-sdk，或使用 pnpm add / yarn add / bun add。

### @getmetal/metal-sdk 支持 TypeScript 吗？

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

### @getmetal/metal-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @getmetal/metal-sdk 需要什么版本的 Node\.js？

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

### @getmetal/metal-sdk 可以商用吗？

@getmetal/metal-sdk 使用 Apache 2\.0 许可。声明的许可为 Apache 2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @getmetal/metal-sdk 的下载量有多少？

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

### @getmetal/metal-sdk 还在维护吗？

最新版本 7\.7\.1 发布于 2023/11/10（3 年前）；至今共发布 45 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/02/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

