App Search instruction

Elastic App Search

Elastic App Search 是 Elastic Enterprise Search 的一部分，和 Elasticsearch 一起使用，是免费使用的。

App Search 可以轻松实现高级搜索，通过完善的 API 集合以及直观的仪表板，Elastic App Search 为您的公司网站、电子商务网站或应用带来了 Elasticsearch 的强大功能。获得无缝的可扩展性、可调的相关性控制、详尽的文档、经过良好维护的客户端和强大的分析能力，为您的客户打造领先的搜索体验。

亮点

轻松完成索引

不限平台，不限数据，不限位置，通过不区分模式的数据采集方式以及直观的仪表板，您马上就能完成准备工作并开始查询。只需使用网络爬虫或经过良好维护的 API 客户端之一对您的数据加以索引，然后便可开始查询啦。
功能强大的搜索

相关性高，容错性优异，Elastic App Search 由 Elasticsearch 提供支持，其相关性模型已针对实际搜索情况进行优化。“允许拼写错误”、词干提取、双连词等功能均可直接使用。
搜索分析

实时数据，可付诸实践的见解，Elastic App Search 的分析结果能够让您洞悉用户的全部行为，并为您提供改进建议以及达到目标的方式。
相关性调整

定义您自己的搜索方式，使用直观界面调校搜索的相关性。创建同义词组，针对特定查询对结果进行重排序，以及分配权重和系数，这些都有助于对整体精准度进行微调。
爬取过程便捷

高效索引所有公开的网站内容。只需点击鼠标——无需代码——用户便可自定义网络爬虫规则，从而指定入口点，并且/或者将特定页面、内容或词汇排除在外。

部署

因为 App Search 是 Enterprise Search 的一部分，所有只需要部署 Enterprise Search 即可使用 App Search。

以 Docker 部署举例

拉取镜像

1

docker pull docker.elastic.co/enterprise-search/enterprise-search:7.12.0

用 Docker Cli 启动

1
2
3
4
5
6
7
8


docker run \

  -p 3002:3002 \

  -e elasticsearch.host='http://host.docker.internal:9200' \

  -e elasticsearch.username=elastic \

  -e elasticsearch.password=changeme \

  -e allow_es_settings_modification=true \

  -e secret_management.encryption_keys='[4a2cd3f81d39bf28738c10db0ca782095ffac07279561809eecc722e0c20eb09]' \

docker.elastic.co/enterprise-search/enterprise-search:7.12.0

allow_es_settings_modification 和 secret_management.encryption_keys 必须配置。

用 Docker Compose 启动

1

docker compose up --remove-orphans

docker-compose.yml 文件内容如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65


version: "7.12.0"
   
networks:
  elastic:
    driver: bridge
   
volumes:
  elasticsearch:
    driver: local
   
services:
  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:{version}
    restart: unless-stopped
    environment:
      - "discovery.type=single-node"
      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
      - "xpack.security.enabled=true"
      - "xpack.security.authc.api_key.enabled=true"
      - "ELASTIC_PASSWORD=changeme"
    ulimits:
      memlock:
        soft: -1
        hard: -1
    volumes:
      - elasticsearch:/usr/share/elasticsearch/data
    ports:
      - 127.0.0.1:9200:9200
    networks:
      - elastic
   
  ent-search:
    image: docker.elastic.co/enterprise-search/enterprise-search:{version}
    restart: unless-stopped
    depends_on:
      - "elasticsearch"
    environment:
      - "JAVA_OPTS=-Xms512m -Xmx512m"
      - "ENT_SEARCH_DEFAULT_PASSWORD=changeme"
      - "elasticsearch.username=elastic"
      - "elasticsearch.password=changeme"
      - "elasticsearch.host=http://elasticsearch:9200"
      - "allow_es_settings_modification=true"
      - "secret_management.encryption_keys=[4a2cd3f81d39bf28738c10db0ca782095ffac07279561809eecc722e0c20eb09]"
      - "elasticsearch.startup_retry.interval=15"
    ports:
      - 127.0.0.1:3002:3002
    networks:
      - elastic
   
  kibana:
    image: docker.elastic.co/kibana/kibana:{version}
    restart: unless-stopped
    depends_on:
      - "elasticsearch"
      - "ent-search"
    ports:
      - 127.0.0.1:5601:5601
    environment:
      ELASTICSEARCH_HOSTS: http://elasticsearch:9200
      ENTERPRISESEARCH_HOST: http://ent-search:3002
      ELASTICSEARCH_USERNAME: elastic
      ELASTICSEARCH_PASSWORD: changeme
    networks:
      - elastic

启动成功后，可以通过 kibana -> Enterprise Search -> App Search 访问，或者访问单独的 UI ， http://localhost:3002

使用

创建 Engine

点击首页 Create an Engine 输入 Engines name 选择语言进行创建，每个 Engine 最终都会在 Elasticsearch 中有对应的一个 index。

导入数据

数据导入方式有以下四种

Paste JSON

直接粘贴 JSON 内容
Upload a JSON file

上传 json 文件，将文件内容写入
Use the web crawler(BETA)

使用爬虫器进行爬取
Index by API

使用 Rest API 写入数据

我们根据场景选择不同的数据导入方式，以下以 Rest API 举例，如果不指定id，会自动生成

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45


curl -X POST 'http://localhost:3002/api/as/v1/engines/kyle-test-engine/documents' \

  -H 'Content-Type: application/json' \

  -H 'Authorization: Bearer private-q849axzc6sv37qf83oxbn32r' \

  -d '[
        {
          "id": "park_rocky-mountain",
          "title": "Rocky Mountain",
          "description": "Bisected north to south by the Continental Divide, this portion of the Rockies has ecosystems varying from over 150 riparian lakes to montane and subalpine forests to treeless alpine tundra. Wildlife including mule deer, bighorn sheep, black bears, and cougars inhabit its igneous mountains and glacial valleys. Longs Peak, a classic Colorado fourteener, and the scenic Bear Lake are popular destinations, as well as the historic Trail Ridge Road, which reaches an elevation of more than 12,000 feet (3,700 m).",
          "nps_link": "https://www.nps.gov/romo/index.htm",
          "states": [
            "Colorado"
          ],
          "visitors": 4517585,
          "world_heritage_site": false,
          "location": "40.4,-105.58",
          "acres": 265795.2,
          "square_km": 1075.6,
          "date_established": "1915-01-26T06:00:00Z"
        },
        {
          "id": "park_saguaro",
          "title": "Saguaro",
          "description": "Split into the separate Rincon Mountain and Tucson Mountain districts, this park is evidence that the dry Sonoran Desert is still home to a great variety of life spanning six biotic communities. Beyond the namesake giant saguaro cacti, there are barrel cacti, chollas, and prickly pears, as well as lesser long-nosed bats, spotted owls, and javelinas.",
          "nps_link": "https://www.nps.gov/sagu/index.htm",
          "states": [
            "Arizona"
          ],
          "visitors": 820426,
          "world_heritage_site": false,
          "location": "32.25,-110.5",
          "acres": 91715.72,
          "square_km": 371.2,
          "date_established": "1994-10-14T05:00:00Z"
        }
      ]'
# [
#   {
#     "id": "park_rocky-mountain",
#     "errors": []
#   },
#   {
#     "id": "park_saguaro",
#     "errors": []
#   }
# ]

点击 Documents 开始搜索，可以通过 Customize 设置过滤字段和排序字段。
Reference UI 快速创建搜索界面

设置过滤、排序等字段。

搜索页面，可以点击 Download ZIP Package 下载代码解压，然后执行 npm install, npm start 就可以有单独搜索的页面。
可以通过 UI Schema 调整字段的类型，默认 text，目前仅支持 text、number、date、geolocation 四种类型
Synonyms 同义词设置
Curations 结果设置

Curations 允许手动提升或隐藏特定查询的文档，可用于增加每次点击的搜索比率或执行推广特定内容的活动。
相关性得分设置
结果设置
通过 Overview 和 Analytics 可以查看到所有 API 的使用情况，方便定义问题及优化。