全部产品
开放搜索

应用处理

更新时间:2017-09-13 11:06:04   分享:   

查看应用信息

查看指定应用信息

URL

/v3/openapi/apps/$app_name

  • $app_name 为您的应用名 或 应用ID
  • 以上 URL 省略了请求Header参数及编码等因素
  • 以上 URL 中省略了访问应用的 host 地址
  • 查询签名过程实现,请参考 V3版API 签名机制 文档中的描述

支持格式

JSON

HTTP请求方式

GET

返回结果

参数 类型 描述
errors string 查询报错信息,message代表错误信息。code 对应含义参考 错误码 文档
request_id string 该条查询的记录id,主要用于排查问题使用
status string 执行结果,OK为成功,FAIL为失败,请根据返回错误码进行排查
result string 应用信息

result 内容中主要参数

  • type:应用类型
  • schema:应用结构信息
  • tables:应用表结构配置信息
  • indexes:应用索引配置信息
  • quota:应用配额信息
  • qps:应用qps配额信息
  • doc_size:应用容量配额信息
  • used_qps:已使用qps信息
  • used_doc_size:已使用应用容量信息
  • first_ranks:粗排表达式信息
  • second_ranks:精排表达式信息
  • data_sources:数据源配置信息
  • summaries:摘要信息
  • suggests:下拉提示配置信息
  • query_processors:查询分析配置信息

group 内容中主要参数

  • id:应用ID
  • name:应用名
  • switched_time:应用版本切换时间
  • created:应用创建时间
  • updated:应用更新时间

示例

请求:(此处省略了请求Header参数及编码等因素)

  1. http://$host/v3/openapi/apps/app_schema_demo

成功返回:

  1. {
  2. "errors": [],
  3. "request_id": "150450787817934527664174",
  4. "status": "OK",
  5. "result": {
  6. "id": "120009914",
  7. "description": "",
  8. "status": 1,
  9. "unread_error_count": 2,
  10. "fetch_fields": [
  11. "id",
  12. "name",
  13. "phone",
  14. "int_arr",
  15. "literal_arr",
  16. "float_arr",
  17. "cate_id"
  18. ],
  19. "type": "advance",
  20. "virtual_cluster": "",
  21. "cluster_name": "in0",
  22. "schema": {
  23. "tables": {
  24. "tab": {
  25. "fields": {
  26. "id": {
  27. "name": "id",
  28. "type": "INT",
  29. "primary_key": true
  30. },
  31. "name": {
  32. "name": "name",
  33. "type": "TEXT",
  34. "primary_key": false
  35. },
  36. "phone": {
  37. "name": "phone",
  38. "type": "SHORT_TEXT",
  39. "primary_key": false
  40. },
  41. "int_arr": {
  42. "name": "int_arr",
  43. "type": "INT_ARRAY",
  44. "primary_key": false
  45. },
  46. "literal_arr": {
  47. "name": "literal_arr",
  48. "type": "LITERAL_ARRAY",
  49. "primary_key": false
  50. },
  51. "float_arr": {
  52. "name": "float_arr",
  53. "type": "FLOAT_ARRAY",
  54. "primary_key": false
  55. },
  56. "cate_id": {
  57. "name": "cate_id",
  58. "type": "INT",
  59. "primary_key": false
  60. }
  61. },
  62. "primary_table": true,
  63. "name": "tab"
  64. }
  65. },
  66. "indexes": {
  67. "search_fields": {
  68. "id": {
  69. "fields": [
  70. "id"
  71. ]
  72. },
  73. "name": {
  74. "fields": [
  75. "name"
  76. ],
  77. "analyzer": "chn_standard"
  78. },
  79. "phone": {
  80. "fields": [
  81. "phone"
  82. ],
  83. "analyzer": "fuzzy"
  84. },
  85. "int_arr": {
  86. "fields": [
  87. "int_arr"
  88. ]
  89. },
  90. "literal_arr": {
  91. "fields": [
  92. "literal_arr"
  93. ]
  94. },
  95. "cate_id": {
  96. "fields": [
  97. "cate_id"
  98. ]
  99. }
  100. },
  101. "filter_fields": [
  102. "id",
  103. "int_arr",
  104. "literal_arr",
  105. "float_arr",
  106. "cate_id"
  107. ]
  108. },
  109. "plugin_info": [],
  110. "route_field": null
  111. },
  112. "quota": {
  113. "id": "120009914",
  114. "qps": 5,
  115. "doc_size": 0.2,
  116. "used_qps": 0,
  117. "used_doc_size": 0.000001
  118. },
  119. "first_ranks": [
  120. {
  121. "id": "",
  122. "name": "default",
  123. "description": "",
  124. "active": true,
  125. "meta": [
  126. {
  127. "attribute": "static_bm25()",
  128. "arg": "",
  129. "weight": 1
  130. }
  131. ],
  132. "created": 0,
  133. "updated": 0
  134. },
  135. {
  136. "id": "76423",
  137. "name": "cp",
  138. "description": "",
  139. "active": false,
  140. "meta": [
  141. {
  142. "attribute": "static_bm25()",
  143. "arg": "",
  144. "weight": 1
  145. },
  146. {
  147. "attribute": "exact_match_boost()",
  148. "arg": "",
  149. "weight": 2
  150. }
  151. ],
  152. "created": 1495619541,
  153. "updated": 1504254559
  154. }
  155. ],
  156. "second_ranks": [
  157. {
  158. "id": "-1",
  159. "name": "default",
  160. "meta": "",
  161. "active": false,
  162. "description": "",
  163. "created": 0,
  164. "updated": 0
  165. },
  166. {
  167. "id": "76424",
  168. "name": "jp",
  169. "meta": "first_phase_score()+1",
  170. "active": false,
  171. "description": "",
  172. "created": 1495619558,
  173. "updated": 1504254559
  174. },
  175. {
  176. "id": "119791",
  177. "name": "normalize",
  178. "meta": "normalize(id)",
  179. "active": true,
  180. "description": "",
  181. "created": 1504254559,
  182. "updated": 1504254559
  183. }
  184. ],
  185. "data_sources": [],
  186. "summaries": [],
  187. "quota_reviewing_task": null,
  188. "created": 1495113686,
  189. "next_action": "0",
  190. "action_cause": "0",
  191. "suggests": [
  192. {
  193. "id": "74920",
  194. "app_id": "120009914",
  195. "status": "1",
  196. "fields": [
  197. "name"
  198. ],
  199. "online": 1,
  200. "reindex_ts": 1503606962,
  201. "white_list": [],
  202. "black_list": [],
  203. "name": "suggest"
  204. }
  205. ],
  206. "query_processors": [
  207. {
  208. "id": "74736",
  209. "name": "qp",
  210. "active": false,
  211. "indexes": [
  212. "_ALL_INDEXES_"
  213. ],
  214. "processors": [
  215. {
  216. "id": "1",
  217. "name": "stop_word",
  218. "title": "停用词",
  219. "desc": "根据系统内置的停用词典过滤查询中无意义的词(一般是使用频度过高的但不影响查询结果的词,比如标点符号、语气助词等)。例如:查询词“奔跑吧!兄弟”,经过停用词处理后标点符号“!”不参与召回。"
  220. },
  221. {
  222. "id": "2",
  223. "name": "spell_check",
  224. "title": "拼写检查",
  225. "desc": "检查用户查询串中的拼写错误,并给出纠错建议。对于确定的拼写错误将直接改写原始查询串,然后进行检索;对于可能的拼写错误将仍然使用原始查询串进行检索。例如:查询词“阿里爸爸”,经过拼写纠错会改写为“阿里巴巴”,然后进行检索。"
  226. },
  227. {
  228. "id": "3",
  229. "name": "term_weighting",
  230. "title": "词权重",
  231. "desc": "分析查询中每个词的重要程度,并将其量化成权重,权重较低的词可能不会参与召回。例如:查询词“开放搜索好不好”,经过词权重处理,只要包含“开放搜索”的文档都可以召回。"
  232. },
  233. {
  234. "id": "4",
  235. "name": "synonym",
  236. "title": "同义词",
  237. "desc": "根据系统提供的通用同义词库和语义模型,对查询串进行同义词扩展,以便扩大召回。例如:查询原词为\"KFC\",经过同义词处理后,包含\"肯德基\"或者\"KFC\"的文档都会被召回(配合词权重功能使用效果更佳)。"
  238. }
  239. ],
  240. "created": 1495113836,
  241. "updated": 1497510127
  242. }
  243. ],
  244. "name": "app_schema_demo",
  245. "rebuilding": false,
  246. "data_progress": 0,
  247. "switch_time": 0,
  248. "region": "internal",
  249. "progress_percent": 100,
  250. "dashboard": {
  251. "unread_error_count": 2,
  252. "rebuilding": false
  253. },
  254. "group": {
  255. "id": "120009914",
  256. "name": "app_schema_demo",
  257. "current_version": "120009914",
  258. "switched_time": 0,
  259. "versions": [
  260. "120009914"
  261. ],
  262. "created": 1495113686,
  263. "updated": 1495113686,
  264. "switch_time": 0,
  265. "region": "internal",
  266. "type": "advance"
  267. }
  268. }
  269. }

错误返回:

  1. {
  2. "errors": [
  3. {
  4. "code": 2001,
  5. "message": "待查应用不存在.待查应用不存在。",
  6. "params": {
  7. "friendly_message": "待查应用不存在。"
  8. }
  9. }
  10. ],
  11. "request_id": "150452485319940487135024",
  12. "status": "FAIL"
  13. }

获取应用列表

获取应用列表操作

URL

/v3/openapi/apps?page=1&size=10

  • 以上 URL 省略了请求Header参数及编码等因素
  • 以上 URL 中省略了访问应用的 host 地址
  • 查询签名过程实现,请参考 V3版API 签名机制 文档中的描述

支持格式

JSON

HTTP请求方式

GET

请求参数

参数 类型 必需 取值范围 默认值 描述
page int 获取第几页应用列表
size int 每页返回的应用个数

返回结果

参考上面单应用“返回结果”,此处获取应用列表数据信息与上面单应用召回信息是类似的,不再重复展示。

示例

请求:(此处省略了请求Header参数及编码等因素)

  1. http://$host/v3/openapi/apps?page=1&size=10

成功返回:

  • 参考上面单应用“成功返回”,此处为多个单应用信息集合,因内容较长,不再重复展示。

错误返回:

  • 参考上面单应用“错误返回”,此处报错信息与上面单应用查询报错内容是类似的,不再重复展示。
本文导读目录
本文导读目录
以上内容是否对您有帮助?