插件 API

插件API 允许您在索引时添加任何其他元信息。您可以在插件页面的Dashbaord上创建和修改插件并连接到端点(endpoint)。为此，您需要先创建API端点，并在页面上创建新的插件

创建 API 端点

首先，您需要创建 API 端点 我们支持使用 RESTful API 和 GRPC方法的 POST方法。当 Soco-search 索引文档时，我们调用用户通过UI定义的API端点。

POST method

API应该监听具有特定主体的 Post 方法. 我们一般使用批处理处理数据，因此 API 主体应该接受批输入。

这是一个示例输入体。 “数据（data）”字段有一个包含“值(value)”和“配置(config)”的字典列表:

{
  "data": [
    {
      "value": "say hello", "configs":{"lang";"en}
    },
    {
      "value": "say hi", "configs":{"lang";"en}
    },
    .......
  ]
}

API 应处理此输入格式并按如下方式返回：

{
  "resp": [
    {
      "positive": 1.0
    },
    {
      "negative": 0.8
    },
    .......
  ]
}

返回应包含“resp”和一个列表，该列表具有在映射中定义的特定类型。上面的示例显示了 type 为 term_score 的情况。

在界面上创建新的插件

要创建新插件，只需单击创建新插件按钮，然后输入插件名称。

创建插件后，您将被定向到插件详细信息页面。然后，您可以添加有关此插件的信息。退出输入部分后，您输入的所有信息将自动保存。

Description 您可以为您的插件创建描述，以帮助您了解此插件的用途。

Url API 端点 Url

Method 支持“POST”和“GRPC”

Type 插件的输出数据类型

Header API的Header（如果适用）

Example Input 用于测试 API 是否有效的示例输入