Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/docs/en/db/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"---Introduction---",
"index",
"concepts",
"platforms",
"[ExternalLink][API Reference](/en/api-reference/)",
"---Guides---",
"quickstart",
Expand Down
191 changes: 191 additions & 0 deletions content/docs/en/db/platforms.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
---
title: Platform Support
description: Official language SDKs, supported operating systems and CPU architectures, and per-platform index availability for Zvec.
icon: MonitorSmartphone
---

import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';

## Language SDKs

All SDKs share one stable C API boundary — pick your language to see the install command and prebuilt platform coverage.

<Tabs items={['Python', 'Node.js', 'Go', 'Rust', 'Java', 'Dart / Flutter', 'C / C++']}>

<Tab value="Python">

```bash
pip install zvec
```

- **Prebuilt coverage**:
- Linux x86_64 / ARM64 (glibc and musl)
- macOS ARM64
- Windows x64
- **Requirements**: 64-bit Python 3.10–3.14
- **Repository**: [https://github.com/alibaba/zvec/tree/main/python](https://github.com/alibaba/zvec/tree/main/python)

</Tab>

<Tab value="Node.js">

```bash
npm install @zvec/zvec
```

- **Prebuilt coverage**:
- Linux x86_64 / ARM64 (glibc and musl)
- macOS ARM64 / x64
- Windows x64
- **Repository**: [https://github.com/zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node)

</Tab>

<Tab value="Go">

```bash
go get github.com/zvec-ai/zvec-go
```

- **Prebuilt coverage**:
- Linux x64 / ARM64
- macOS ARM64
- Windows x64
- **Repository**: [https://github.com/zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go)

</Tab>

<Tab value="Rust">

```bash
cargo add zvec-rust
```

- **Prebuilt coverage**:
- Linux x86_64 / ARM64
- macOS ARM64
- Windows x64
- **Repository**: [https://github.com/zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust)

</Tab>

<Tab value="Java">

```xml
<dependency>
<groupId>org.zvec</groupId>
<artifactId>zvec-java</artifactId>
</dependency>
```

- **Prebuilt coverage**:
- Linux x86_64 / ARM64 (glibc 2.27 or newer)
- macOS ARM64
- Windows x64
- **Repository**: [https://github.com/zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java)

</Tab>

<Tab value="Dart / Flutter">

```bash
flutter pub add zvec
```

- **Prebuilt coverage**:
- Android arm64-v8a
- iOS arm64
- macOS ARM64
- Linux x64
- Windows x64
- **Repository**: [https://github.com/zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart)

</Tab>

<Tab value="C / C++">

```bash
# Pick the archive for your platform from the releases page
curl -LO https://github.com/alibaba/zvec/releases/latest/download/zvec-sdk-linux-amd64.tar.gz
```

- **Prebuilt coverage**:
- Linux x86_64 / ARM64 (glibc and musl)
- macOS ARM64
- Windows x86_64
- Android arm64-v8a
- iOS arm64
- **Repository**: [https://github.com/alibaba/zvec](https://github.com/alibaba/zvec)

</Tab>

</Tabs>


## Supported Platforms

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

语言/安装方式/支持平台,这几部分可以合并一下吧,尽量让用户看起来一眼看完

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

建议保持分开,见最上面钦仁的讨论,之前是合到一起的,页面看着比较乱


| Platform | Architectures | Prebuilt artifacts |
| --- | --- | --- |
| Linux (glibc) | x86_64, ARM64 | ✅ |
| Linux (musl) | x86_64, ARM64 | ✅ |
| macOS | ARM64 (Apple Silicon), x86_64 (Intel) | ✅ |
| Windows | x86_64 | ✅ |
| Android | arm64-v8a | ✅ |
| iOS | arm64 | ✅ |
| RISC-V | riscv64 | ❌ (build from source) |


## Index Availability

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这部分可以默认折叠,默认只给用户最简单的信息:支持什么语言、平台、安装方式

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已修改


<Accordions type="single">
<Accordion title="Show the full matrix (9 index types × 7 platforms)">

| Index | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64-v8a | iOS arm64 | RISC-V |
| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Sparse vectors (Flat / HNSW) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| RaBitQ ([HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| [INVERT](../concepts/inverted-index/) (scalar) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [FTS](../concepts/fts-index/) (full-text) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |

<Callout className="text-base" type="info">
**RaBitQ** requires AVX2 and AVX-512, which is why it is limited to Linux x86_64 today.
</Callout>

</Accordion>
</Accordions>

## Related

<Cards>
<Card
title="Quickstart"
href="../quickstart/"
description="Install an SDK and run your first search"
icon={<Rocket className="text-teal-300" />}
/>
<Card
title="Building from Source"
href="../build/"
description="Compile Zvec for a platform without prebuilt artifacts"
icon={<Cpu className="text-teal-300" />}
/>
<Card
title="DiskANN Index"
href="../concepts/vector-index/diskann-index/"
description="Disk-based retrieval for billion-scale datasets"
icon={<HardDrive className="text-purple-300" />}
/>
<Card
title="Zvec-Grep"
href="../../zvec-grep/"
description="Local-first workspace search for humans and AI agents"
icon={<SearchCode className="text-purple-300" />}
/>
</Cards>
1 change: 1 addition & 0 deletions content/docs/zh/db/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"---入门---",
"index",
"concepts",
"platforms",
"[ExternalLink][API 参考](/zh/api-reference/)",
"---使用指南---",
"quickstart",
Expand Down
191 changes: 191 additions & 0 deletions content/docs/zh/db/platforms.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
---
title: 平台支持
description: Zvec 官方支持的语言 SDK、操作系统与 CPU 架构,以及各索引在不同平台上的可用性矩阵。
icon: MonitorSmartphone
---

import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';

## 语言 SDK

所有 SDK 共享同一条稳定的 C API 边界——选择你的语言,查看安装命令与预编译产物覆盖。

<Tabs items={['Python', 'Node.js', 'Go', 'Rust', 'Java', 'Dart / Flutter', 'C / C++']}>

<Tab value="Python">

```bash
pip install zvec
```

- **预编译覆盖**:
- Linux x86_64 / ARM64(glibc 与 musl)
- macOS ARM64
- Windows x64
- **版本要求**:64 位 Python 3.10–3.14
- **代码仓库**:[https://github.com/alibaba/zvec/tree/main/python](https://github.com/alibaba/zvec/tree/main/python)

</Tab>

<Tab value="Node.js">

```bash
npm install @zvec/zvec
```

- **预编译覆盖**:
- Linux x86_64 / ARM64(glibc 与 musl)
- macOS ARM64 / x64
- Windows x64
- **代码仓库**:[https://github.com/zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node)

</Tab>

<Tab value="Go">

```bash
go get github.com/zvec-ai/zvec-go
```

- **预编译覆盖**:
- Linux x64 / ARM64
- macOS ARM64
- Windows x64
- **代码仓库**:[https://github.com/zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go)

</Tab>

<Tab value="Rust">

```bash
cargo add zvec-rust
```

- **预编译覆盖**:
- Linux x86_64 / ARM64
- macOS ARM64
- Windows x64
- **代码仓库**:[https://github.com/zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust)

</Tab>

<Tab value="Java">

```xml
<dependency>
<groupId>org.zvec</groupId>
<artifactId>zvec-java</artifactId>
</dependency>
```

- **预编译覆盖**:
- Linux x86_64 / ARM64(glibc 2.27 及以上)
- macOS ARM64
- Windows x64
- **代码仓库**:[https://github.com/zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java)

</Tab>

<Tab value="Dart / Flutter">

```bash
flutter pub add zvec
```

- **预编译覆盖**:
- Android arm64-v8a
- iOS arm64
- macOS ARM64
- Linux x64
- Windows x64
- **代码仓库**:[https://github.com/zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart)

</Tab>

<Tab value="C / C++">

```bash
# 从 Releases 页选择对应平台的 SDK 压缩包
curl -LO https://github.com/alibaba/zvec/releases/latest/download/zvec-sdk-linux-amd64.tar.gz
```

- **预编译覆盖**:
- Linux x86_64 / ARM64(glibc 与 musl)
- macOS ARM64
- Windows x86_64
- Android arm64-v8a
- iOS arm64
- **代码仓库**:[https://github.com/alibaba/zvec](https://github.com/alibaba/zvec)

</Tab>

</Tabs>


## 支持的软硬件平台

| 平台 | 架构 | 预编译产物 |
| --- | --- | --- |
| Linux(glibc) | x86_64、ARM64 | ✅ |
| Linux(musl) | x86_64、ARM64 | ✅ |
| macOS | ARM64(Apple Silicon)、x86_64(Intel) | ✅ |
| Windows | x86_64 | ✅ |
| Android | arm64-v8a | ✅ |
| iOS | arm64 | ✅ |
| RISC-V | riscv64 | ❌(需源码构建) |


## 索引可用性矩阵

<Accordions type="single">
<Accordion title="展开完整矩阵(9 类索引 × 7 平台)">

| 索引 | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64-v8a | iOS arm64 | RISC-V |
| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| 稀疏向量(Flat / HNSW) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| RaBitQ([HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| [INVERT](../concepts/inverted-index/)(标量倒排) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [FTS](../concepts/fts-index/)(全文检索) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |

<Callout className="text-base" type="info">
**RaBitQ** 依赖 AVX2 与 AVX-512,因此目前仅支持 Linux x86_64。
</Callout>

</Accordion>
</Accordions>

## 相关阅读

<Cards>
<Card
title="快速开始"
href="../quickstart/"
description="安装 SDK 并跑通第一次检索"
icon={<Rocket className="text-teal-300" />}
/>
<Card
title="从源码构建"
href="../build/"
description="为没有预编译产物的平台自行编译 Zvec"
icon={<Cpu className="text-teal-300" />}
/>
<Card
title="DiskANN 索引"
href="../concepts/vector-index/diskann-index/"
description="面向十亿级数据的磁盘检索"
icon={<HardDrive className="text-purple-300" />}
/>
<Card
title="Zvec-Grep"
href="../../zvec-grep/"
description="面向人与 AI Agent 的本地工作区检索"
icon={<SearchCode className="text-purple-300" />}
/>
</Cards>
Loading