构造器.io JavaScript 客户端

JavaScript 客户端 构造器.io。 。 。 . 构造器.io 提供搜索作为一种服务,利用人工智能优化结果(包括自然语言处理,重新排序以优化转换,以及用户个性化).

此客户端旨在用于浏览器环境中,但也可用于基于React Industrial的移动应用程序. 关于在反照原生情况下的利用的更多信息,可在 维基。如果想要JavaScript客户端用于服务器侧集成,请使用 @ 构造- io/ 构造- 节点

文档

API 文档全文可见于 Github 页面

1. 安装

此软件包可以通过 npm 安装 : npm i @constructor-io/constructorio-client-javascript。安装后,只需将软件包导入或要求输入您的仓库.

或者,由单个 JavaScript 文件组成的捆绑版本会在 ./dist 关于 Github 的文件夹。 如果本地主机 - - 请不要直接链接到 Github 主机版本。 。 。 .

重要: 此库只应在客户端的背景中使用, 客户端使用标准的 HTTP 请求头( E) User-Agent, (中文(简体) ), Referer(见a/c.5/49/70,附件).

2. 获取 API 密钥

你可以从你身上找到这个 构造器.io仪表板联系销售,如果你想注册, 或支持 如果你相信你的公司已经有一个账户.

3. 执行客户

一旦导入,可以创建一个客户端实例如下:

const ConstructorioClient = require('@constructor-io/constructorio-client-javascript');

const constructorio = new ConstructorioClient({
    apiKey: 'YOUR API KEY',
});

4. 获取结果

在即兴播放客户端实例后,七个模块会作为属性被曝光来帮助检索数据或发送行为事件: search, (中文(简体) ), browse, (中文(简体) ), autocomplete, (中文(简体) ), recommendations, (中文(简体) ), quizzes, (中文(简体) ), agent,以及 tracker。 。 。 .

AI 购物代理和产品透视代理

• agent 检索AI购物代理(ASA)结果为一流.
• agent.pia 检索产品透视代理(PIA)问答.
• tracker 拥有 trackAgent* aSA事件和 trackProductInsightsAgent* pIA事件的方法.

说明:

1. 这个 assistant 名称空间已贬值。 使用 agent 换句话说.

2. agent 通过浏览器接收结果 EventSource 接口。 本地反应不包括 EventSource。如果您使用 agent 在“反应土著”中,添加一个 EventSource 混合填充剂.

调度活动

模块可能在浏览器上发送自定义事件 window 与请求完成时的响应数据。 事件名称遵循以下结构: 1 cio.client.[moduleName].[methodName].completed。消费代码如下:

window.addEventListener('cio.client.search.getSearchResults.completed', (event) => {
  // `event.detail` will be response data
}, false);

开发/ npm 命令

npm run prepare       # one-time after cloning: install husky git hooks (pre-push lint)
npm run lint          # run lint on source code and tests
npm run test          # run tests
npm run coverage      # run tests and serves coverage reports from localhost:8081
npm run docs          # output documentation to `./docs` directory

npm version <patch|minor|major> --ignore-scripts=false   # bump version (see note below)

说明: .npmrc 套装 ignore-scripts=true 用于供应链安全,因此生命周期脚本不会自动运行. 这影响到两个工作流程:

• 胡斯基接钩: 运行 npm run prepare 克隆后一次,以便 pre-push 灵钩.
• npm version数字 : 页:1 version 生命周期脚本( 重生) src/version.js文档和 ./dist 将他们捆绑起来放入释放中)被跳出. 总是通过 --ignore-scripts=false 当这个版本被撞倒时 这些文物就会被重新生成.