README

这是一个用于构建与 Elastic App Search 一流、相关搜索体验的 Magento 集成。

⚠️ 这是客户端的测试版。查看已知问题。

内容

入门
用法
开发
常见问题解答
贡献
许可证

入门 🐣

使用此客户端假设您已经

在 https://swiftype.com/ 上创建了一个 App Search 帐户，或者您已经有了可自行管理的 App Search 版本
PHP >= 7.1
已安装并运行 Magento >= 2.2.6

您可以通过在您的 Magento 项目根目录中使用以下 composer 命令来安装模块

composer require elastic/app-search-magento:1.0.0-beta3@beta

一旦模块安装完毕，您应该清理您的缓存，并更新您的 Magento 实例（如果已安装）

bin/magento cache:clean
bin/magento setup:upgrade

用法

配置 App Search 凭据

要配置您的凭据，您需要收集以下信息

您的 App Search API 端点
您的 App Search 私有 API 密钥
您的 App Search 公共搜索密钥

如果您使用 swiftype.com 帐户，您可以在 https://app.swiftype.com/as/credentials 获取这些信息。

自行管理的用户应连接到他们的 App Search 实例以检索他们的凭据。

从 Magento 管理员

您可以通过浏览到 商店 > 配置 > 一般 > Elastic App Search 部分在 Magento 管理员中提供您的 App Search 凭据

注意：该模块将为每个商店视图创建一个 App Search 引擎。新引擎将使用客户端内可配置的前缀：例如 magento2-catalogfulltext-search-1。

更新此设置（例如 my-website-staging），如果您计划为多个环境使用相同的帐户。

从 Magento CLI

您可以使用 Magento CLI 更新凭据

bin/magento config:set elastic_appsearch/client/api_endpoint "https://host-xxxx.api.swiftype.com"
bin/magento config:set elastic_appsearch/client/private_api_key "private-XXXXX"
bin/magento config:set elastic_appsearch/client/search_api_key "search-XXXXX"

您还可以设置引擎前缀

bin/magento config:set elastic_appsearch/client/engine_prefix "my-website-staging"

将 App Search 配置为 Magento 默认搜索引擎

一旦您在 Magento 中设置了凭据，您需要更新 Magento 配置以使用 App Search 而不是默认的 MySQL 搜索引擎。

浏览到 商店 > 配置 > 目录 > 目录搜索 部分以执行此操作

作为替代方案，您可以使用 Magento CLI 来更改默认的搜索引擎

bin/magento config:set catalog/search/engine "elastic_appsearch"

重新索引内容

要完成安装，您需要清理您的缓存并将内容重新索引到 App Search 中

bin/magento cache:clean
bin/magento indexer:reindex catalogsearch_fulltext

已知问题

该模块处于其第一个测试版。这个测试版旨在作为一个技术预览，旨在将 App Search 集成到 Magento 搜索适配器界面。

当前实现有一些注意事项

App Search 允许的字段最大数量（目前为 64）不允许您索引具有过多产品属性的目录 (#37)
我们需要重新设计如何将产品价格存储到 App Search 中，以便允许具有大量客户组的网站被索引 (#38)
搜索相关性仍在调整中。

开发

我们热爱开发者，并希望每个人都能为此模块做出贡献。

我们已使用 Magento 示例数据构建了一个完全 dockerized 的开发环境，以帮助您测试模块并贡献代码。

设置环境的全套文档可在此处找到。

常见问题 🔮

我在哪里报告客户端的问题？

如果某个功能不符合预期，请创建一个问题。

我在哪里可以找到完整的App Search API文档？

您最好的选择是阅读文档。

我还可以去哪里寻求帮助？

您可以访问Elastic社区讨论论坛。

贡献 🚀

我们欢迎对该项目的贡献者。在您开始之前，请注意以下几点...

在提交拉取请求之前，请创建一个问题来讨论您提案的范围。
请编写简洁的代码和文档，在适当的时候。

许可证 📗

感谢所有贡献者！

elastic / app-search-magento

维护者

详细信息