# @elastic-suite/gally-sdk 中文文档

规范地址：https://npmcn.com/package/%40elastic-suite/gally-sdk/

版本：2\.3\.1
npm 元数据更新时间：2026-10-12T17:37:37.901Z
中文译文更新时间：2026-11-14T12:25:34.981Z
软件包许可：OSL-3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40elastic-suite/gally-sdk
原文对照：https://npmcn.com/package/%40elastic-suite/gally-sdk/?lang=original
项目主页：https://meetgally.com/

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

- 包体积（解压后）：448 kB，52 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-05-21T09:42:28.700Z
- 最新版本发布：2026-10-12T17:37:37.713Z
- 近 30 天下载量：2050（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

Gally 连接器的脚本 SDK 类型

## 安装

```sh
npm install @elastic-suite/gally-sdk
```

也可以使用：`pnpm add @elastic-suite/gally-sdk`、`yarn add @elastic-suite/gally-sdk`、`bun add @elastic-suite/gally-sdk`

## README

# @ 有弹性的套装/ gally-sdk

JS SDK 为 [伽利语Name](https://meetgally.com/) - 为电子商务提供强有力的搜寻和寻找解决办法.

SDK是:

-   使用 Javascript(使用 Medusa JS, Strapi等) 建立Gally 连接器,与 Gally 交互
-   执行使用 Gally (自动完成、 用户行为分析等) 前端特性

[![npm version](https://img.shields.io/npm/v/@elastic-suite/gally-sdk.svg)](https://www.npmjs.com/package/@elastic-suite/gally-sdk) [![License: OSL-3.0](https://img.shields.io/badge/License-OSL--3.0-blue.svg)](https://opensource.org/license/osl-3-0-php)

## 特征

✨ **目录管理** - 同步目录、元数据和源字段  
🔍 **高级搜索** - 全文搜索、过滤、面部和排序  
📊 **索引操作** - 创建、批量索引并管理搜索索引  
📈 **事件跟踪** - 跟踪视图、搜索、加载和订购  
🌐 **多地点** - 支持多种目录和语言  
⚡ **业绩** - 内置缓存、分批和优化  
🔒 **类型安全** - 全面类型定义的完整类型脚本支持

## 所需资源

-   节点.js >= 18.0.0(使用原生地) `fetch`(中文(简体) )
-   TypeScript QQ 5.3(用于开发)

## 安装

```bash
npm install @elastic-suite/gally-sdk
```

## 快速启动

📖 **[完整文档](https://github.com/Elastic-Suite/gally-admin/wiki/Getting-started-with-the-JS-SDK)** - 从Gally JS SDK开始

## 许可证

[OSL-3.0 (英语)](https://opensource.org/license/osl-3-0-php)

* * *

### 需要帮忙吗?

-   📖 [文档 维基](https://github.com/Elastic-Suite/gally-admin/wiki) - 详细指南和实例
-   🐛 [问题](https://github.com/Elastic-Suite/gally-admin/issues) - 报告错误或请求特性
-   💬 [讨论情况](https://github.com/Elastic-Suite/gally-admin/discussions) - 提问和交流想法

## 常见问题

### @elastic-suite/gally-sdk 是什么？

Gally 连接器的脚本 SDK 类型

### 如何安装 @elastic-suite/gally-sdk？

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

### @elastic-suite/gally-sdk 支持 TypeScript 吗？

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

### @elastic-suite/gally-sdk 支持 ESM 还是 CommonJS？

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

### @elastic-suite/gally-sdk 可以商用吗？

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

### @elastic-suite/gally-sdk 的下载量有多少？

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

### @elastic-suite/gally-sdk 还在维护吗？

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