维度值关键词召回

维度值关键词召回

根据输入的原始词召回工作区中的维度值关键词，并返回候选词对应的字段映射。调用前，需为该工作区所属客户配置向量服务。

请求方式

Request Method: POST
Request URL:    /openapi/v1/workspaces/{workspaceId}/keywords/recall/
Request Header:
  Authorization: "{连接密钥}"
  Content-Type: application/json

请求参数

{
  "words": ["门店", "商店"],
  "n_results": 10
}

参数	类型	必填	默认值	说明
连接密钥	string	是		API 密钥，放在请求 Header 中
workspaceId	string	是		工作区 ID，放在路径中
words	list	是		原始词列表，至少包含一个非空字符串
n_results	int	否	20	每个原始词的最大候选数，范围 1–100

返回结果

成功时，返回列表顺序与 words 的输入顺序一致；没有召回结果的原始词，其 results 为空列表。

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "source": "门店",
      "results": [
        {
          "word": "北京门店",
          "distance": 0.12,
          "prop": "d1=北京门店",
          "field": "d1",
          "tuids": "model-1"
        }
      ]
    },
    {
      "source": "商店",
      "results": []
    }
  ]
}

参数	类型	说明
data	list	原始词对应的召回结果列表
data.N.source	string	输入的原始词
data.N.results	list	候选词列表
data.N.results.N.word	string	召回到的维度值关键词
data.N.results.N.distance	number	候选词与原始词的距离
data.N.results.N.prop	string	维度值属性
data.N.results.N.field	string	维度字段
data.N.results.N.tuids	string	所属模型标识

未配置向量服务

若工作区所属客户未配置向量服务，接口返回：

{
  "errcode": 400,
  "errmsg": "当前工作区未配置向量服务，请先配置向量服务后重试。"
}