@coveo/push-api-客户端.js
Coveo Push API 客户端
安装
npm i @coveo/push-api-client
特征
- 上传数据到 Push 和 Catalog 来源
- 预推文件验证
- 自动自定义字段创建
- 完整目录上传和渐进文档更新
- 最大有效载荷上传
使用量
import {PushSource, DocumentBuilder} from '@coveo/push-api-client';
async function main() {
const source = new PushSource('my_api_key', 'my_coveo_organization_id');
const myDocument = new DocumentBuilder(
'https://my.document.uri',
'My document title'
).withData('these words will be searchable');
await source.addOrUpdateDocument('my_source_id', myDocument);
}
main();
您也可以将数据上传到目录来源
async function main() {
const source = new CatalogSource('my_api_key', 'my_coveo_organization_id');
await source
.batchStreamDocumentsFromFiles('my_source_id', ['path/to/file_or_folder'])
.batch();
}
main();
更多信息见 ./samples 文件夹.
代理配置
你可以用这个 HTTPS_PROXY 或者说 https_proxy 用于代理配置的环境变量.
更多关于它的内容 这里。 。 。 .
指示后退重试配置
默认情况下,SDK利用了指数回放回放机制. 指向回放允许SDK多次尝试解决被节制的请求,增加了等待每次后续尝试的时间. 发出中的请求会在 429 状态代码从平台返回 .
指数后退参数如下:
-
retryAfter- 等待请求的时间,以毫秒计.可选的,默认为5000.
-
maxRetries- 重试节奏请求的最大次数.可选,默认为10.
-
timeMultiple- 增加每次请求请求之间等待时间的倍数.可选,默认为2.
您可以配置将应用到所有向外请求的指数后退 。 为此,请具体说明 PlatformOptions 创建时的对象 CatalogSource 或者说 PushSource 对象 :
const catalogSource = new CatalogSource(
'my_api_key',
'my_coveo_organization_id',
{maxRetries: 10, retryAfter: 2000, timeMultiple: 3}
);
const pushSource = new PushSource(
'my_other_api_key',
'my_other_coveo_organization_id',
{maxRetries: 3, retryAfter: 600000}
);
默认情况下,请求最多将重试10次,在第一次尝试后再等5秒,时间多为2次(这相当于最大执行时间约1.5小时).
地方发展
npm i- 复制
env.sample改为.env,并用适当的值替换变量. npm run dev编译和运行./src/localtest.ts。 。 。 .npm run test用于单位测试.
提交
使用 npm run commit 以获得一个格式化的输入消息,这将有助于控制版本和 ChangeGELOG 生成.
释放
运行 Github 动作 release,它会凸起版本,标记并发布到 npm.