indexea_client 0.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (301) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +3413 -0
  4. data/Rakefile +8 -0
  5. data/docs/AccountApi.md +685 -0
  6. data/docs/AccountBean.md +27 -0
  7. data/docs/AccountPasswdBody.md +8 -0
  8. data/docs/AccountPortraitBody.md +7 -0
  9. data/docs/AccountProfileBody.md +8 -0
  10. data/docs/AccountResetpwdBody.md +9 -0
  11. data/docs/AccountSigninBody.md +9 -0
  12. data/docs/AccountSignupBody.md +10 -0
  13. data/docs/AccountsFeedbackBody.md +8 -0
  14. data/docs/AccountsMessageBody.md +8 -0
  15. data/docs/AnalyzeObject.md +8 -0
  16. data/docs/AnalyzeToken.md +11 -0
  17. data/docs/AppBean.md +23 -0
  18. data/docs/AppCompanyBody.md +22 -0
  19. data/docs/AppIndexBody.md +7 -0
  20. data/docs/AppLogAccount.md +9 -0
  21. data/docs/AppLogBean.md +19 -0
  22. data/docs/AppLogsBean.md +9 -0
  23. data/docs/AppMentorBean.md +14 -0
  24. data/docs/AppOauthBody.md +7 -0
  25. data/docs/AppOauthBody1.md +7 -0
  26. data/docs/AppOauthresetsecretBody.md +7 -0
  27. data/docs/AppTokensBody.md +7 -0
  28. data/docs/AppTokensBody1.md +7 -0
  29. data/docs/AppWidgetBody.md +7 -0
  30. data/docs/AppsApi.md +1843 -0
  31. data/docs/AppsAppBody.md +8 -0
  32. data/docs/AppsBody.md +8 -0
  33. data/docs/AutoCompleteItem.md +9 -0
  34. data/docs/BlacklistBean.md +12 -0
  35. data/docs/Bulletin.md +15 -0
  36. data/docs/CompanyBean.md +24 -0
  37. data/docs/ContactForm.md +11 -0
  38. data/docs/CrawlerLog.md +14 -0
  39. data/docs/CrawlerLogs.md +8 -0
  40. data/docs/CrawlerTask.md +16 -0
  41. data/docs/FieldsApi.md +215 -0
  42. data/docs/GlobalApi.md +258 -0
  43. data/docs/GlobalOptionForm.md +8 -0
  44. data/docs/IndexBean.md +26 -0
  45. data/docs/IndexFieldBean.md +8 -0
  46. data/docs/IndexForm.md +15 -0
  47. data/docs/IndexRebuildForm.md +12 -0
  48. data/docs/IndexSettings.md +10 -0
  49. data/docs/IndexSettingsBody.md +7 -0
  50. data/docs/IndexStatBean.md +14 -0
  51. data/docs/IndexSynonymsflushBody.md +7 -0
  52. data/docs/IndexTask.md +13 -0
  53. data/docs/IndexTemplate.md +17 -0
  54. data/docs/IndexTemplates.md +8 -0
  55. data/docs/IndexUploadBody.md +7 -0
  56. data/docs/IndicesApi.md +1620 -0
  57. data/docs/IntelligentMapping.md +8 -0
  58. data/docs/KeywordBindingBean.md +14 -0
  59. data/docs/MentorForm.md +8 -0
  60. data/docs/Message.md +18 -0
  61. data/docs/MessageApi.md +262 -0
  62. data/docs/Messages.md +8 -0
  63. data/docs/OauthAppBean.md +20 -0
  64. data/docs/OpenidBean.md +10 -0
  65. data/docs/OptionForm.md +10 -0
  66. data/docs/OrdersIdentBody.md +7 -0
  67. data/docs/PayResult.md +9 -0
  68. data/docs/PaymentApi.md +788 -0
  69. data/docs/PaymentInvoice.md +15 -0
  70. data/docs/PaymentOrder.md +25 -0
  71. data/docs/PaymentRecord.md +13 -0
  72. data/docs/PaymentService.md +12 -0
  73. data/docs/QueriesApi.md +1821 -0
  74. data/docs/QueryActionBean.md +27 -0
  75. data/docs/QueryBean.md +22 -0
  76. data/docs/QueryForm.md +15 -0
  77. data/docs/QueryNode.md +10 -0
  78. data/docs/QuerySortField.md +9 -0
  79. data/docs/QueryVariableBean.md +17 -0
  80. data/docs/RecommendApi.md +365 -0
  81. data/docs/RecommendBean.md +18 -0
  82. data/docs/RecordFilter.md +10 -0
  83. data/docs/RecordsApi.md +286 -0
  84. data/docs/SearchApi.md +646 -0
  85. data/docs/SearchEstimateResult.md +11 -0
  86. data/docs/SearchWord.md +8 -0
  87. data/docs/StatIndexBean.md +14 -0
  88. data/docs/StatsApi.md +245 -0
  89. data/docs/SynonymsBean.md +14 -0
  90. data/docs/TokenBean.md +12 -0
  91. data/docs/TriggerBean.md +13 -0
  92. data/docs/TriggerLogBean.md +15 -0
  93. data/docs/ValueOfField.md +8 -0
  94. data/docs/WidgetBean.md +21 -0
  95. data/docs/WidgetForm.md +13 -0
  96. data/docs/WidgetLogo.md +7 -0
  97. data/docs/WidgetLogoBody.md +7 -0
  98. data/docs/WidgetStatusForm.md +8 -0
  99. data/docs/WidgetsApi.md +573 -0
  100. data/git_push.sh +55 -0
  101. data/indexea_client.gemspec +38 -0
  102. data/lib/indexea_client/api/account_api.rb +846 -0
  103. data/lib/indexea_client/api/apps_api.rb +2271 -0
  104. data/lib/indexea_client/api/fields_api.rb +289 -0
  105. data/lib/indexea_client/api/global_api.rb +326 -0
  106. data/lib/indexea_client/api/indices_api.rb +2076 -0
  107. data/lib/indexea_client/api/message_api.rb +337 -0
  108. data/lib/indexea_client/api/payment_api.rb +975 -0
  109. data/lib/indexea_client/api/queries_api.rb +2320 -0
  110. data/lib/indexea_client/api/recommend_api.rb +461 -0
  111. data/lib/indexea_client/api/records_api.rb +375 -0
  112. data/lib/indexea_client/api/search_api.rb +892 -0
  113. data/lib/indexea_client/api/stats_api.rb +312 -0
  114. data/lib/indexea_client/api/widgets_api.rb +741 -0
  115. data/lib/indexea_client/api_client.rb +391 -0
  116. data/lib/indexea_client/api_error.rb +57 -0
  117. data/lib/indexea_client/configuration.rb +205 -0
  118. data/lib/indexea_client/models/account_bean.rb +396 -0
  119. data/lib/indexea_client/models/account_passwd_body.rb +227 -0
  120. data/lib/indexea_client/models/account_portrait_body.rb +206 -0
  121. data/lib/indexea_client/models/account_profile_body.rb +228 -0
  122. data/lib/indexea_client/models/account_resetpwd_body.rb +240 -0
  123. data/lib/indexea_client/models/account_signin_body.rb +237 -0
  124. data/lib/indexea_client/models/account_signup_body.rb +254 -0
  125. data/lib/indexea_client/models/accounts_feedback_body.rb +262 -0
  126. data/lib/indexea_client/models/accounts_message_body.rb +226 -0
  127. data/lib/indexea_client/models/analyze_object.rb +216 -0
  128. data/lib/indexea_client/models/analyze_token.rb +243 -0
  129. data/lib/indexea_client/models/app_bean.rb +360 -0
  130. data/lib/indexea_client/models/app_company_body.rb +357 -0
  131. data/lib/indexea_client/models/app_index_body.rb +212 -0
  132. data/lib/indexea_client/models/app_log_account.rb +224 -0
  133. data/lib/indexea_client/models/app_log_bean.rb +318 -0
  134. data/lib/indexea_client/models/app_logs_bean.rb +229 -0
  135. data/lib/indexea_client/models/app_mentor_bean.rb +277 -0
  136. data/lib/indexea_client/models/app_oauth_body.rb +206 -0
  137. data/lib/indexea_client/models/app_oauth_body_1.rb +212 -0
  138. data/lib/indexea_client/models/app_oauthresetsecret_body.rb +212 -0
  139. data/lib/indexea_client/models/app_tokens_body.rb +212 -0
  140. data/lib/indexea_client/models/app_tokens_body_1.rb +212 -0
  141. data/lib/indexea_client/models/app_widget_body.rb +212 -0
  142. data/lib/indexea_client/models/apps_app_body.rb +216 -0
  143. data/lib/indexea_client/models/apps_body.rb +221 -0
  144. data/lib/indexea_client/models/auto_complete_item.rb +224 -0
  145. data/lib/indexea_client/models/blacklist_bean.rb +258 -0
  146. data/lib/indexea_client/models/bulletin.rb +312 -0
  147. data/lib/indexea_client/models/company_bean.rb +378 -0
  148. data/lib/indexea_client/models/contact_form.rb +258 -0
  149. data/lib/indexea_client/models/crawler_log.rb +270 -0
  150. data/lib/indexea_client/models/crawler_logs.rb +217 -0
  151. data/lib/indexea_client/models/crawler_task.rb +288 -0
  152. data/lib/indexea_client/models/global_option_form.rb +218 -0
  153. data/lib/indexea_client/models/index_bean.rb +390 -0
  154. data/lib/indexea_client/models/index_field_bean.rb +217 -0
  155. data/lib/indexea_client/models/index_form.rb +283 -0
  156. data/lib/indexea_client/models/index_rebuild_form.rb +254 -0
  157. data/lib/indexea_client/models/index_settings.rb +234 -0
  158. data/lib/indexea_client/models/index_settings_body.rb +212 -0
  159. data/lib/indexea_client/models/index_stat_bean.rb +270 -0
  160. data/lib/indexea_client/models/index_synonymsflush_body.rb +212 -0
  161. data/lib/indexea_client/models/index_task.rb +261 -0
  162. data/lib/indexea_client/models/index_template.rb +299 -0
  163. data/lib/indexea_client/models/index_templates.rb +219 -0
  164. data/lib/indexea_client/models/index_upload_body.rb +208 -0
  165. data/lib/indexea_client/models/intelligent_mapping.rb +217 -0
  166. data/lib/indexea_client/models/keyword_binding_bean.rb +274 -0
  167. data/lib/indexea_client/models/mentor_form.rb +220 -0
  168. data/lib/indexea_client/models/message.rb +306 -0
  169. data/lib/indexea_client/models/messages.rb +217 -0
  170. data/lib/indexea_client/models/oauth_app_bean.rb +329 -0
  171. data/lib/indexea_client/models/openid_bean.rb +238 -0
  172. data/lib/indexea_client/models/option_form.rb +287 -0
  173. data/lib/indexea_client/models/orders_ident_body.rb +206 -0
  174. data/lib/indexea_client/models/pay_result.rb +258 -0
  175. data/lib/indexea_client/models/payment_invoice.rb +283 -0
  176. data/lib/indexea_client/models/payment_order.rb +412 -0
  177. data/lib/indexea_client/models/payment_record.rb +261 -0
  178. data/lib/indexea_client/models/payment_service.rb +258 -0
  179. data/lib/indexea_client/models/query_action_bean.rb +391 -0
  180. data/lib/indexea_client/models/query_bean.rb +348 -0
  181. data/lib/indexea_client/models/query_form.rb +285 -0
  182. data/lib/indexea_client/models/query_node.rb +234 -0
  183. data/lib/indexea_client/models/query_sort_field.rb +264 -0
  184. data/lib/indexea_client/models/query_variable_bean.rb +335 -0
  185. data/lib/indexea_client/models/recommend_bean.rb +318 -0
  186. data/lib/indexea_client/models/record_filter.rb +242 -0
  187. data/lib/indexea_client/models/search_estimate_result.rb +242 -0
  188. data/lib/indexea_client/models/search_word.rb +218 -0
  189. data/lib/indexea_client/models/stat_index_bean.rb +270 -0
  190. data/lib/indexea_client/models/synonyms_bean.rb +274 -0
  191. data/lib/indexea_client/models/token_bean.rb +252 -0
  192. data/lib/indexea_client/models/trigger_bean.rb +263 -0
  193. data/lib/indexea_client/models/trigger_log_bean.rb +279 -0
  194. data/lib/indexea_client/models/value_of_field.rb +217 -0
  195. data/lib/indexea_client/models/widget_bean.rb +387 -0
  196. data/lib/indexea_client/models/widget_form.rb +328 -0
  197. data/lib/indexea_client/models/widget_logo.rb +206 -0
  198. data/lib/indexea_client/models/widget_logo_body.rb +206 -0
  199. data/lib/indexea_client/models/widget_status_form.rb +223 -0
  200. data/lib/indexea_client/version.rb +14 -0
  201. data/lib/indexea_client.rb +133 -0
  202. data/spec/api/account_api_spec.rb +200 -0
  203. data/spec/api/apps_api_spec.rb +492 -0
  204. data/spec/api/fields_api_spec.rb +86 -0
  205. data/spec/api/global_api_spec.rb +98 -0
  206. data/spec/api/indices_api_spec.rb +434 -0
  207. data/spec/api/message_api_spec.rb +96 -0
  208. data/spec/api/payment_api_spec.rb +227 -0
  209. data/spec/api/queries_api_spec.rb +482 -0
  210. data/spec/api/recommend_api_spec.rb +125 -0
  211. data/spec/api/records_api_spec.rb +107 -0
  212. data/spec/api/search_api_spec.rb +220 -0
  213. data/spec/api/stats_api_spec.rb +99 -0
  214. data/spec/api/widgets_api_spec.rb +174 -0
  215. data/spec/api_client_spec.rb +225 -0
  216. data/spec/base_object_spec.rb +109 -0
  217. data/spec/configuration_spec.rb +41 -0
  218. data/spec/models/account_bean_spec.rb +160 -0
  219. data/spec/models/account_passwd_body_spec.rb +46 -0
  220. data/spec/models/account_portrait_body_spec.rb +40 -0
  221. data/spec/models/account_profile_body_spec.rb +46 -0
  222. data/spec/models/account_resetpwd_body_spec.rb +52 -0
  223. data/spec/models/account_signin_body_spec.rb +52 -0
  224. data/spec/models/account_signup_body_spec.rb +58 -0
  225. data/spec/models/accounts_feedback_body_spec.rb +50 -0
  226. data/spec/models/accounts_message_body_spec.rb +46 -0
  227. data/spec/models/analyze_object_spec.rb +46 -0
  228. data/spec/models/analyze_token_spec.rb +64 -0
  229. data/spec/models/app_bean_spec.rb +136 -0
  230. data/spec/models/app_company_body_spec.rb +130 -0
  231. data/spec/models/app_index_body_spec.rb +40 -0
  232. data/spec/models/app_log_account_spec.rb +52 -0
  233. data/spec/models/app_log_bean_spec.rb +112 -0
  234. data/spec/models/app_logs_bean_spec.rb +52 -0
  235. data/spec/models/app_mentor_bean_spec.rb +82 -0
  236. data/spec/models/app_oauth_body_1_spec.rb +40 -0
  237. data/spec/models/app_oauth_body_spec.rb +40 -0
  238. data/spec/models/app_oauthresetsecret_body_spec.rb +40 -0
  239. data/spec/models/app_tokens_body_1_spec.rb +40 -0
  240. data/spec/models/app_tokens_body_spec.rb +40 -0
  241. data/spec/models/app_widget_body_spec.rb +40 -0
  242. data/spec/models/apps_app_body_spec.rb +46 -0
  243. data/spec/models/apps_body_spec.rb +46 -0
  244. data/spec/models/auto_complete_item_spec.rb +52 -0
  245. data/spec/models/blacklist_bean_spec.rb +70 -0
  246. data/spec/models/bulletin_spec.rb +92 -0
  247. data/spec/models/company_bean_spec.rb +142 -0
  248. data/spec/models/contact_form_spec.rb +64 -0
  249. data/spec/models/crawler_log_spec.rb +82 -0
  250. data/spec/models/crawler_logs_spec.rb +46 -0
  251. data/spec/models/crawler_task_spec.rb +94 -0
  252. data/spec/models/global_option_form_spec.rb +46 -0
  253. data/spec/models/index_bean_spec.rb +154 -0
  254. data/spec/models/index_field_bean_spec.rb +46 -0
  255. data/spec/models/index_form_spec.rb +88 -0
  256. data/spec/models/index_rebuild_form_spec.rb +70 -0
  257. data/spec/models/index_settings_body_spec.rb +40 -0
  258. data/spec/models/index_settings_spec.rb +58 -0
  259. data/spec/models/index_stat_bean_spec.rb +82 -0
  260. data/spec/models/index_synonymsflush_body_spec.rb +40 -0
  261. data/spec/models/index_task_spec.rb +76 -0
  262. data/spec/models/index_template_spec.rb +100 -0
  263. data/spec/models/index_templates_spec.rb +46 -0
  264. data/spec/models/index_upload_body_spec.rb +40 -0
  265. data/spec/models/intelligent_mapping_spec.rb +46 -0
  266. data/spec/models/keyword_binding_bean_spec.rb +82 -0
  267. data/spec/models/mentor_form_spec.rb +46 -0
  268. data/spec/models/message_spec.rb +106 -0
  269. data/spec/models/messages_spec.rb +46 -0
  270. data/spec/models/oauth_app_bean_spec.rb +118 -0
  271. data/spec/models/openid_bean_spec.rb +58 -0
  272. data/spec/models/option_form_spec.rb +62 -0
  273. data/spec/models/orders_ident_body_spec.rb +40 -0
  274. data/spec/models/pay_result_spec.rb +56 -0
  275. data/spec/models/payment_invoice_spec.rb +88 -0
  276. data/spec/models/payment_order_spec.rb +152 -0
  277. data/spec/models/payment_record_spec.rb +76 -0
  278. data/spec/models/payment_service_spec.rb +70 -0
  279. data/spec/models/query_action_bean_spec.rb +160 -0
  280. data/spec/models/query_bean_spec.rb +130 -0
  281. data/spec/models/query_form_spec.rb +88 -0
  282. data/spec/models/query_node_spec.rb +58 -0
  283. data/spec/models/query_sort_field_spec.rb +56 -0
  284. data/spec/models/query_variable_bean_spec.rb +104 -0
  285. data/spec/models/recommend_bean_spec.rb +106 -0
  286. data/spec/models/record_filter_spec.rb +58 -0
  287. data/spec/models/search_estimate_result_spec.rb +64 -0
  288. data/spec/models/search_word_spec.rb +46 -0
  289. data/spec/models/stat_index_bean_spec.rb +82 -0
  290. data/spec/models/synonyms_bean_spec.rb +82 -0
  291. data/spec/models/token_bean_spec.rb +70 -0
  292. data/spec/models/trigger_bean_spec.rb +76 -0
  293. data/spec/models/trigger_log_bean_spec.rb +88 -0
  294. data/spec/models/value_of_field_spec.rb +46 -0
  295. data/spec/models/widget_bean_spec.rb +132 -0
  296. data/spec/models/widget_form_spec.rb +84 -0
  297. data/spec/models/widget_logo_body_spec.rb +40 -0
  298. data/spec/models/widget_logo_spec.rb +40 -0
  299. data/spec/models/widget_status_form_spec.rb +46 -0
  300. data/spec/spec_helper.rb +110 -0
  301. metadata +501 -0
@@ -0,0 +1,1620 @@
1
+ # IndexeaClient::IndicesApi
2
+
3
+ All URIs are relative to *https://api.indexea.com/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**index_cleanup**](IndicesApi.md#index_cleanup) | **POST** /indices/{app}/{index}/cleanup | 清空索引记录
8
+ [**index_copy_to**](IndicesApi.md#index_copy_to) | **POST** /indices/{app}/{index}/copyto | 导出索引数据
9
+ [**index_create**](IndicesApi.md#index_create) | **POST** /indices/{app} | 创建索引
10
+ [**index_create_template**](IndicesApi.md#index_create_template) | **POST** /indices/templates | 创建索引模板
11
+ [**index_delete**](IndicesApi.md#index_delete) | **DELETE** /indices/{app}/{index} | 删除索引
12
+ [**index_delete_crawler_task**](IndicesApi.md#index_delete_crawler_task) | **DELETE** /indices/{app}/{index}/crawler-settings | 删除索引的数据爬取任务
13
+ [**index_delete_template**](IndicesApi.md#index_delete_template) | **DELETE** /indices/templates | 删除索引模板
14
+ [**index_export**](IndicesApi.md#index_export) | **POST** /indices/{app}/{index}/export | 导出索引数据
15
+ [**index_flush**](IndicesApi.md#index_flush) | **POST** /indices/{app}/{index}/flush | 刷新索引数据,主要用于将内存中的索引数据写入磁盘
16
+ [**index_flush_settings**](IndicesApi.md#index_flush_settings) | **PUT** /indices/{app}/{index}/settings | 写入设置信息到索引
17
+ [**index_get**](IndicesApi.md#index_get) | **GET** /indices/{app}/{index} | 获取单个索引详情
18
+ [**index_get_crawler_logs**](IndicesApi.md#index_get_crawler_logs) | **GET** /indices/{app}/{index}/crawler-logs | 获取索引的爬虫任务的爬取日志
19
+ [**index_get_crawler_task**](IndicesApi.md#index_get_crawler_task) | **GET** /indices/{app}/{index}/crawler-settings | 获取索引的爬虫任务设定
20
+ [**index_get_filter_settings**](IndicesApi.md#index_get_filter_settings) | **GET** /indices/{app}/{index}/filter-settings | 获取索引设置信息
21
+ [**index_get_settings**](IndicesApi.md#index_get_settings) | **GET** /indices/{app}/{index}/settings | 获取索引设置信息
22
+ [**index_list**](IndicesApi.md#index_list) | **GET** /indices/{app} | 获取应用的索引列表
23
+ [**index_list_templates**](IndicesApi.md#index_list_templates) | **GET** /indices/templates | 获取所有可用的索引模板
24
+ [**index_prefetch**](IndicesApi.md#index_prefetch) | **GET** /indices/crawler | 获取目标网站内容预览
25
+ [**index_rebuild**](IndicesApi.md#index_rebuild) | **POST** /indices/{app}/{index}/rebuild | 重建索引数据
26
+ [**index_rebuild_task**](IndicesApi.md#index_rebuild_task) | **GET** /indices/{app}/{index}/rebuild | 获取重建索引任务的详情
27
+ [**index_submit_crawler_task**](IndicesApi.md#index_submit_crawler_task) | **POST** /indices/{app}/{index}/crawler-settings | 提交或者更新索引的数据爬取任务
28
+ [**index_update**](IndicesApi.md#index_update) | **PUT** /indices/{app}/{index} | 修改索引
29
+ [**index_update_settings**](IndicesApi.md#index_update_settings) | **POST** /indices/{app}/{index}/settings | 更新索引设置信息
30
+ [**index_update_template**](IndicesApi.md#index_update_template) | **PUT** /indices/templates | 修改索引模板
31
+ [**synonyms_add**](IndicesApi.md#synonyms_add) | **POST** /indices/{app}/{index}/synonyms | 添加同义词
32
+ [**synonyms_delete**](IndicesApi.md#synonyms_delete) | **DELETE** /indices/{app}/{index}/synonyms | 删除同义词
33
+ [**synonyms_enable**](IndicesApi.md#synonyms_enable) | **PATCH** /indices/{app}/{index}/synonyms | 启用禁用同义词
34
+ [**synonyms_flush**](IndicesApi.md#synonyms_flush) | **POST** /indices/{app}/{index}/synonyms-flush | 将同义词更新到搜索引擎的同义词表
35
+ [**synonyms_import**](IndicesApi.md#synonyms_import) | **POST** /indices/{app}/{index}/synonyms-import | 导入同义词
36
+ [**synonyms_list**](IndicesApi.md#synonyms_list) | **GET** /indices/{app}/{index}/synonyms | 获取索引的所有同义词
37
+ [**synonyms_update**](IndicesApi.md#synonyms_update) | **PUT** /indices/{app}/{index}/synonyms | 修改同义词
38
+
39
+ # **index_cleanup**
40
+ > Object index_cleanup(app, index, vcode)
41
+
42
+ 清空索引记录
43
+
44
+ ### Example
45
+ ```ruby
46
+ # load the gem
47
+ require 'indexea_client'
48
+ # setup authorization
49
+ IndexeaClient.configure do |config|
50
+ end
51
+
52
+ api_instance = IndexeaClient::IndicesApi.new
53
+ app = 'app_example' # String | 应用标识
54
+ index = 56 # Integer | 索引编号
55
+ vcode = 'vcode_example' # String | 验证码
56
+
57
+
58
+ begin
59
+ #清空索引记录
60
+ result = api_instance.index_cleanup(app, index, vcode)
61
+ p result
62
+ rescue IndexeaClient::ApiError => e
63
+ puts "Exception when calling IndicesApi->index_cleanup: #{e}"
64
+ end
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ Name | Type | Description | Notes
70
+ ------------- | ------------- | ------------- | -------------
71
+ **app** | **String**| 应用标识 |
72
+ **index** | **Integer**| 索引编号 |
73
+ **vcode** | **String**| 验证码 |
74
+
75
+ ### Return type
76
+
77
+ **Object**
78
+
79
+ ### Authorization
80
+
81
+ [TokenAuth](../README.md#TokenAuth)
82
+
83
+ ### HTTP request headers
84
+
85
+ - **Content-Type**: Not defined
86
+ - **Accept**: application/json
87
+
88
+
89
+
90
+ # **index_copy_to**
91
+ > IndexBean index_copy_to(app, index, name, fields, queries, records)
92
+
93
+ 导出索引数据
94
+
95
+ ### Example
96
+ ```ruby
97
+ # load the gem
98
+ require 'indexea_client'
99
+ # setup authorization
100
+ IndexeaClient.configure do |config|
101
+ end
102
+
103
+ api_instance = IndexeaClient::IndicesApi.new
104
+ app = 'app_example' # String | 应用标识
105
+ index = 56 # Integer | 索引编号
106
+ name = 'name_example' # String | 新索引的名称
107
+ fields = true # BOOLEAN | 是否复制字段定义
108
+ queries = true # BOOLEAN | 是否复制所有查询
109
+ records = true # BOOLEAN | 是否复制所有文档
110
+
111
+
112
+ begin
113
+ #导出索引数据
114
+ result = api_instance.index_copy_to(app, index, name, fields, queries, records)
115
+ p result
116
+ rescue IndexeaClient::ApiError => e
117
+ puts "Exception when calling IndicesApi->index_copy_to: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **app** | **String**| 应用标识 |
126
+ **index** | **Integer**| 索引编号 |
127
+ **name** | **String**| 新索引的名称 |
128
+ **fields** | **BOOLEAN**| 是否复制字段定义 |
129
+ **queries** | **BOOLEAN**| 是否复制所有查询 |
130
+ **records** | **BOOLEAN**| 是否复制所有文档 |
131
+
132
+ ### Return type
133
+
134
+ [**IndexBean**](IndexBean.md)
135
+
136
+ ### Authorization
137
+
138
+ [TokenAuth](../README.md#TokenAuth)
139
+
140
+ ### HTTP request headers
141
+
142
+ - **Content-Type**: Not defined
143
+ - **Accept**: application/json
144
+
145
+
146
+
147
+ # **index_create**
148
+ > IndexBean index_create(bodyapp)
149
+
150
+ 创建索引
151
+
152
+ ### Example
153
+ ```ruby
154
+ # load the gem
155
+ require 'indexea_client'
156
+ # setup authorization
157
+ IndexeaClient.configure do |config|
158
+ end
159
+
160
+ api_instance = IndexeaClient::IndicesApi.new
161
+ body = IndexeaClient::IndexForm.new # IndexForm |
162
+ app = 'app_example' # String | 应用标识
163
+
164
+
165
+ begin
166
+ #创建索引
167
+ result = api_instance.index_create(bodyapp)
168
+ p result
169
+ rescue IndexeaClient::ApiError => e
170
+ puts "Exception when calling IndicesApi->index_create: #{e}"
171
+ end
172
+ ```
173
+
174
+ ### Parameters
175
+
176
+ Name | Type | Description | Notes
177
+ ------------- | ------------- | ------------- | -------------
178
+ **body** | [**IndexForm**](IndexForm.md)| |
179
+ **app** | **String**| 应用标识 |
180
+
181
+ ### Return type
182
+
183
+ [**IndexBean**](IndexBean.md)
184
+
185
+ ### Authorization
186
+
187
+ [TokenAuth](../README.md#TokenAuth)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: application/json
192
+ - **Accept**: application/json
193
+
194
+
195
+
196
+ # **index_create_template**
197
+ > IndexTemplate index_create_template(body)
198
+
199
+ 创建索引模板
200
+
201
+ ### Example
202
+ ```ruby
203
+ # load the gem
204
+ require 'indexea_client'
205
+ # setup authorization
206
+ IndexeaClient.configure do |config|
207
+ end
208
+
209
+ api_instance = IndexeaClient::IndicesApi.new
210
+ body = IndexeaClient::IndexTemplate.new # IndexTemplate |
211
+
212
+
213
+ begin
214
+ #创建索引模板
215
+ result = api_instance.index_create_template(body)
216
+ p result
217
+ rescue IndexeaClient::ApiError => e
218
+ puts "Exception when calling IndicesApi->index_create_template: #{e}"
219
+ end
220
+ ```
221
+
222
+ ### Parameters
223
+
224
+ Name | Type | Description | Notes
225
+ ------------- | ------------- | ------------- | -------------
226
+ **body** | [**IndexTemplate**](IndexTemplate.md)| |
227
+
228
+ ### Return type
229
+
230
+ [**IndexTemplate**](IndexTemplate.md)
231
+
232
+ ### Authorization
233
+
234
+ [TokenAuth](../README.md#TokenAuth)
235
+
236
+ ### HTTP request headers
237
+
238
+ - **Content-Type**: application/json
239
+ - **Accept**: application/json
240
+
241
+
242
+
243
+ # **index_delete**
244
+ > BOOLEAN index_delete(appindex, opts)
245
+
246
+ 删除索引
247
+
248
+ ### Example
249
+ ```ruby
250
+ # load the gem
251
+ require 'indexea_client'
252
+ # setup authorization
253
+ IndexeaClient.configure do |config|
254
+ end
255
+
256
+ api_instance = IndexeaClient::IndicesApi.new
257
+ app = 'app_example' # String | 应用标识
258
+ index = 56 # Integer | 索引编号
259
+ opts = {
260
+ vcode: 'vcode_example' # String |
261
+ }
262
+
263
+ begin
264
+ #删除索引
265
+ result = api_instance.index_delete(appindex, opts)
266
+ p result
267
+ rescue IndexeaClient::ApiError => e
268
+ puts "Exception when calling IndicesApi->index_delete: #{e}"
269
+ end
270
+ ```
271
+
272
+ ### Parameters
273
+
274
+ Name | Type | Description | Notes
275
+ ------------- | ------------- | ------------- | -------------
276
+ **app** | **String**| 应用标识 |
277
+ **index** | **Integer**| 索引编号 |
278
+ **vcode** | **String**| | [optional]
279
+
280
+ ### Return type
281
+
282
+ **BOOLEAN**
283
+
284
+ ### Authorization
285
+
286
+ [TokenAuth](../README.md#TokenAuth)
287
+
288
+ ### HTTP request headers
289
+
290
+ - **Content-Type**: application/x-www-form-urlencoded
291
+ - **Accept**: application/json
292
+
293
+
294
+
295
+ # **index_delete_crawler_task**
296
+ > BOOLEAN index_delete_crawler_task(app, index)
297
+
298
+ 删除索引的数据爬取任务
299
+
300
+ ### Example
301
+ ```ruby
302
+ # load the gem
303
+ require 'indexea_client'
304
+ # setup authorization
305
+ IndexeaClient.configure do |config|
306
+ end
307
+
308
+ api_instance = IndexeaClient::IndicesApi.new
309
+ app = 'app_example' # String | 应用标识
310
+ index = 56 # Integer | 索引编号
311
+
312
+
313
+ begin
314
+ #删除索引的数据爬取任务
315
+ result = api_instance.index_delete_crawler_task(app, index)
316
+ p result
317
+ rescue IndexeaClient::ApiError => e
318
+ puts "Exception when calling IndicesApi->index_delete_crawler_task: #{e}"
319
+ end
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+ Name | Type | Description | Notes
325
+ ------------- | ------------- | ------------- | -------------
326
+ **app** | **String**| 应用标识 |
327
+ **index** | **Integer**| 索引编号 |
328
+
329
+ ### Return type
330
+
331
+ **BOOLEAN**
332
+
333
+ ### Authorization
334
+
335
+ [TokenAuth](../README.md#TokenAuth)
336
+
337
+ ### HTTP request headers
338
+
339
+ - **Content-Type**: Not defined
340
+ - **Accept**: application/json
341
+
342
+
343
+
344
+ # **index_delete_template**
345
+ > BOOLEAN index_delete_template(id)
346
+
347
+ 删除索引模板
348
+
349
+ ### Example
350
+ ```ruby
351
+ # load the gem
352
+ require 'indexea_client'
353
+ # setup authorization
354
+ IndexeaClient.configure do |config|
355
+ end
356
+
357
+ api_instance = IndexeaClient::IndicesApi.new
358
+ id = 56 # Integer |
359
+
360
+
361
+ begin
362
+ #删除索引模板
363
+ result = api_instance.index_delete_template(id)
364
+ p result
365
+ rescue IndexeaClient::ApiError => e
366
+ puts "Exception when calling IndicesApi->index_delete_template: #{e}"
367
+ end
368
+ ```
369
+
370
+ ### Parameters
371
+
372
+ Name | Type | Description | Notes
373
+ ------------- | ------------- | ------------- | -------------
374
+ **id** | **Integer**| |
375
+
376
+ ### Return type
377
+
378
+ **BOOLEAN**
379
+
380
+ ### Authorization
381
+
382
+ [TokenAuth](../README.md#TokenAuth)
383
+
384
+ ### HTTP request headers
385
+
386
+ - **Content-Type**: Not defined
387
+ - **Accept**: application/json
388
+
389
+
390
+
391
+ # **index_export**
392
+ > BOOLEAN index_export(app, index, format)
393
+
394
+ 导出索引数据
395
+
396
+ ### Example
397
+ ```ruby
398
+ # load the gem
399
+ require 'indexea_client'
400
+ # setup authorization
401
+ IndexeaClient.configure do |config|
402
+ end
403
+
404
+ api_instance = IndexeaClient::IndicesApi.new
405
+ app = 'app_example' # String | 应用标识
406
+ index = 56 # Integer | 索引编号
407
+ format = 'json' # String | 导出数据的格式
408
+
409
+
410
+ begin
411
+ #导出索引数据
412
+ result = api_instance.index_export(app, index, format)
413
+ p result
414
+ rescue IndexeaClient::ApiError => e
415
+ puts "Exception when calling IndicesApi->index_export: #{e}"
416
+ end
417
+ ```
418
+
419
+ ### Parameters
420
+
421
+ Name | Type | Description | Notes
422
+ ------------- | ------------- | ------------- | -------------
423
+ **app** | **String**| 应用标识 |
424
+ **index** | **Integer**| 索引编号 |
425
+ **format** | **String**| 导出数据的格式 | [default to json]
426
+
427
+ ### Return type
428
+
429
+ **BOOLEAN**
430
+
431
+ ### Authorization
432
+
433
+ [TokenAuth](../README.md#TokenAuth)
434
+
435
+ ### HTTP request headers
436
+
437
+ - **Content-Type**: Not defined
438
+ - **Accept**: application/json
439
+
440
+
441
+
442
+ # **index_flush**
443
+ > BOOLEAN index_flush(app, index)
444
+
445
+ 刷新索引数据,主要用于将内存中的索引数据写入磁盘
446
+
447
+ ### Example
448
+ ```ruby
449
+ # load the gem
450
+ require 'indexea_client'
451
+ # setup authorization
452
+ IndexeaClient.configure do |config|
453
+ end
454
+
455
+ api_instance = IndexeaClient::IndicesApi.new
456
+ app = 'app_example' # String | 应用标识
457
+ index = 56 # Integer | 索引编号
458
+
459
+
460
+ begin
461
+ #刷新索引数据,主要用于将内存中的索引数据写入磁盘
462
+ result = api_instance.index_flush(app, index)
463
+ p result
464
+ rescue IndexeaClient::ApiError => e
465
+ puts "Exception when calling IndicesApi->index_flush: #{e}"
466
+ end
467
+ ```
468
+
469
+ ### Parameters
470
+
471
+ Name | Type | Description | Notes
472
+ ------------- | ------------- | ------------- | -------------
473
+ **app** | **String**| 应用标识 |
474
+ **index** | **Integer**| 索引编号 |
475
+
476
+ ### Return type
477
+
478
+ **BOOLEAN**
479
+
480
+ ### Authorization
481
+
482
+ [TokenAuth](../README.md#TokenAuth)
483
+
484
+ ### HTTP request headers
485
+
486
+ - **Content-Type**: Not defined
487
+ - **Accept**: application/json
488
+
489
+
490
+
491
+ # **index_flush_settings**
492
+ > Object index_flush_settings(typeappindex, opts)
493
+
494
+ 写入设置信息到索引
495
+
496
+ ### Example
497
+ ```ruby
498
+ # load the gem
499
+ require 'indexea_client'
500
+ # setup authorization
501
+ IndexeaClient.configure do |config|
502
+ end
503
+
504
+ api_instance = IndexeaClient::IndicesApi.new
505
+ type = 'type_example' # String | 设置类型
506
+ app = 'app_example' # String | 应用标识
507
+ index = 56 # Integer | 索引编号
508
+ opts = {
509
+ password: 'password_example' # String |
510
+ }
511
+
512
+ begin
513
+ #写入设置信息到索引
514
+ result = api_instance.index_flush_settings(typeappindex, opts)
515
+ p result
516
+ rescue IndexeaClient::ApiError => e
517
+ puts "Exception when calling IndicesApi->index_flush_settings: #{e}"
518
+ end
519
+ ```
520
+
521
+ ### Parameters
522
+
523
+ Name | Type | Description | Notes
524
+ ------------- | ------------- | ------------- | -------------
525
+ **type** | **String**| 设置类型 |
526
+ **app** | **String**| 应用标识 |
527
+ **index** | **Integer**| 索引编号 |
528
+ **password** | [**String**](.md)| | [optional]
529
+
530
+ ### Return type
531
+
532
+ **Object**
533
+
534
+ ### Authorization
535
+
536
+ [TokenAuth](../README.md#TokenAuth)
537
+
538
+ ### HTTP request headers
539
+
540
+ - **Content-Type**: application/x-www-form-urlencoded
541
+ - **Accept**: application/json
542
+
543
+
544
+
545
+ # **index_get**
546
+ > IndexBean index_get(app, index)
547
+
548
+ 获取单个索引详情
549
+
550
+ ### Example
551
+ ```ruby
552
+ # load the gem
553
+ require 'indexea_client'
554
+ # setup authorization
555
+ IndexeaClient.configure do |config|
556
+ end
557
+
558
+ api_instance = IndexeaClient::IndicesApi.new
559
+ app = 'app_example' # String | 应用标识
560
+ index = 56 # Integer | 索引编号
561
+
562
+
563
+ begin
564
+ #获取单个索引详情
565
+ result = api_instance.index_get(app, index)
566
+ p result
567
+ rescue IndexeaClient::ApiError => e
568
+ puts "Exception when calling IndicesApi->index_get: #{e}"
569
+ end
570
+ ```
571
+
572
+ ### Parameters
573
+
574
+ Name | Type | Description | Notes
575
+ ------------- | ------------- | ------------- | -------------
576
+ **app** | **String**| 应用标识 |
577
+ **index** | **Integer**| 索引编号 |
578
+
579
+ ### Return type
580
+
581
+ [**IndexBean**](IndexBean.md)
582
+
583
+ ### Authorization
584
+
585
+ [TokenAuth](../README.md#TokenAuth)
586
+
587
+ ### HTTP request headers
588
+
589
+ - **Content-Type**: Not defined
590
+ - **Accept**: application/json
591
+
592
+
593
+
594
+ # **index_get_crawler_logs**
595
+ > CrawlerLogs index_get_crawler_logs(app, index, from, size)
596
+
597
+ 获取索引的爬虫任务的爬取日志
598
+
599
+ ### Example
600
+ ```ruby
601
+ # load the gem
602
+ require 'indexea_client'
603
+ # setup authorization
604
+ IndexeaClient.configure do |config|
605
+ end
606
+
607
+ api_instance = IndexeaClient::IndicesApi.new
608
+ app = 'app_example' # String | 应用标识
609
+ index = 56 # Integer | 索引编号
610
+ from = 56 # Integer |
611
+ size = 56 # Integer |
612
+
613
+
614
+ begin
615
+ #获取索引的爬虫任务的爬取日志
616
+ result = api_instance.index_get_crawler_logs(app, index, from, size)
617
+ p result
618
+ rescue IndexeaClient::ApiError => e
619
+ puts "Exception when calling IndicesApi->index_get_crawler_logs: #{e}"
620
+ end
621
+ ```
622
+
623
+ ### Parameters
624
+
625
+ Name | Type | Description | Notes
626
+ ------------- | ------------- | ------------- | -------------
627
+ **app** | **String**| 应用标识 |
628
+ **index** | **Integer**| 索引编号 |
629
+ **from** | **Integer**| |
630
+ **size** | **Integer**| |
631
+
632
+ ### Return type
633
+
634
+ [**CrawlerLogs**](CrawlerLogs.md)
635
+
636
+ ### Authorization
637
+
638
+ [TokenAuth](../README.md#TokenAuth)
639
+
640
+ ### HTTP request headers
641
+
642
+ - **Content-Type**: Not defined
643
+ - **Accept**: application/json
644
+
645
+
646
+
647
+ # **index_get_crawler_task**
648
+ > CrawlerTask index_get_crawler_task(app, index)
649
+
650
+ 获取索引的爬虫任务设定
651
+
652
+ ### Example
653
+ ```ruby
654
+ # load the gem
655
+ require 'indexea_client'
656
+ # setup authorization
657
+ IndexeaClient.configure do |config|
658
+ end
659
+
660
+ api_instance = IndexeaClient::IndicesApi.new
661
+ app = 'app_example' # String | 应用标识
662
+ index = 56 # Integer | 索引编号
663
+
664
+
665
+ begin
666
+ #获取索引的爬虫任务设定
667
+ result = api_instance.index_get_crawler_task(app, index)
668
+ p result
669
+ rescue IndexeaClient::ApiError => e
670
+ puts "Exception when calling IndicesApi->index_get_crawler_task: #{e}"
671
+ end
672
+ ```
673
+
674
+ ### Parameters
675
+
676
+ Name | Type | Description | Notes
677
+ ------------- | ------------- | ------------- | -------------
678
+ **app** | **String**| 应用标识 |
679
+ **index** | **Integer**| 索引编号 |
680
+
681
+ ### Return type
682
+
683
+ [**CrawlerTask**](CrawlerTask.md)
684
+
685
+ ### Authorization
686
+
687
+ [TokenAuth](../README.md#TokenAuth)
688
+
689
+ ### HTTP request headers
690
+
691
+ - **Content-Type**: Not defined
692
+ - **Accept**: application/json
693
+
694
+
695
+
696
+ # **index_get_filter_settings**
697
+ > Array<String> index_get_filter_settings(app, index, type)
698
+
699
+ 获取索引设置信息
700
+
701
+ ### Example
702
+ ```ruby
703
+ # load the gem
704
+ require 'indexea_client'
705
+ # setup authorization
706
+ IndexeaClient.configure do |config|
707
+ end
708
+
709
+ api_instance = IndexeaClient::IndicesApi.new
710
+ app = 'app_example' # String | 应用标识
711
+ index = 56 # Integer | 索引编号
712
+ type = 'type_example' # String | 设置类型
713
+
714
+
715
+ begin
716
+ #获取索引设置信息
717
+ result = api_instance.index_get_filter_settings(app, index, type)
718
+ p result
719
+ rescue IndexeaClient::ApiError => e
720
+ puts "Exception when calling IndicesApi->index_get_filter_settings: #{e}"
721
+ end
722
+ ```
723
+
724
+ ### Parameters
725
+
726
+ Name | Type | Description | Notes
727
+ ------------- | ------------- | ------------- | -------------
728
+ **app** | **String**| 应用标识 |
729
+ **index** | **Integer**| 索引编号 |
730
+ **type** | **String**| 设置类型 |
731
+
732
+ ### Return type
733
+
734
+ **Array<String>**
735
+
736
+ ### Authorization
737
+
738
+ [TokenAuth](../README.md#TokenAuth)
739
+
740
+ ### HTTP request headers
741
+
742
+ - **Content-Type**: Not defined
743
+ - **Accept**: application/json
744
+
745
+
746
+
747
+ # **index_get_settings**
748
+ > IndexSettings index_get_settings(app, index, type)
749
+
750
+ 获取索引设置信息
751
+
752
+ ### Example
753
+ ```ruby
754
+ # load the gem
755
+ require 'indexea_client'
756
+ # setup authorization
757
+ IndexeaClient.configure do |config|
758
+ end
759
+
760
+ api_instance = IndexeaClient::IndicesApi.new
761
+ app = 'app_example' # String | 应用标识
762
+ index = 56 # Integer | 索引编号
763
+ type = 'type_example' # String | 设置类型
764
+
765
+
766
+ begin
767
+ #获取索引设置信息
768
+ result = api_instance.index_get_settings(app, index, type)
769
+ p result
770
+ rescue IndexeaClient::ApiError => e
771
+ puts "Exception when calling IndicesApi->index_get_settings: #{e}"
772
+ end
773
+ ```
774
+
775
+ ### Parameters
776
+
777
+ Name | Type | Description | Notes
778
+ ------------- | ------------- | ------------- | -------------
779
+ **app** | **String**| 应用标识 |
780
+ **index** | **Integer**| 索引编号 |
781
+ **type** | **String**| 设置类型 |
782
+
783
+ ### Return type
784
+
785
+ [**IndexSettings**](IndexSettings.md)
786
+
787
+ ### Authorization
788
+
789
+ [TokenAuth](../README.md#TokenAuth)
790
+
791
+ ### HTTP request headers
792
+
793
+ - **Content-Type**: Not defined
794
+ - **Accept**: application/json
795
+
796
+
797
+
798
+ # **index_list**
799
+ > Array<IndexBean> index_list(app, opts)
800
+
801
+ 获取应用的索引列表
802
+
803
+ ### Example
804
+ ```ruby
805
+ # load the gem
806
+ require 'indexea_client'
807
+ # setup authorization
808
+ IndexeaClient.configure do |config|
809
+ end
810
+
811
+ api_instance = IndexeaClient::IndicesApi.new
812
+ app = 'app_example' # String | 应用标识
813
+ opts = {
814
+ stat: true # BOOLEAN | 是否包含索引的统计信息
815
+ }
816
+
817
+ begin
818
+ #获取应用的索引列表
819
+ result = api_instance.index_list(app, opts)
820
+ p result
821
+ rescue IndexeaClient::ApiError => e
822
+ puts "Exception when calling IndicesApi->index_list: #{e}"
823
+ end
824
+ ```
825
+
826
+ ### Parameters
827
+
828
+ Name | Type | Description | Notes
829
+ ------------- | ------------- | ------------- | -------------
830
+ **app** | **String**| 应用标识 |
831
+ **stat** | **BOOLEAN**| 是否包含索引的统计信息 | [optional] [default to true]
832
+
833
+ ### Return type
834
+
835
+ [**Array<IndexBean>**](IndexBean.md)
836
+
837
+ ### Authorization
838
+
839
+ [TokenAuth](../README.md#TokenAuth)
840
+
841
+ ### HTTP request headers
842
+
843
+ - **Content-Type**: Not defined
844
+ - **Accept**: application/json
845
+
846
+
847
+
848
+ # **index_list_templates**
849
+ > IndexTemplates index_list_templates(from, size)
850
+
851
+ 获取所有可用的索引模板
852
+
853
+ ### Example
854
+ ```ruby
855
+ # load the gem
856
+ require 'indexea_client'
857
+ # setup authorization
858
+ IndexeaClient.configure do |config|
859
+ end
860
+
861
+ api_instance = IndexeaClient::IndicesApi.new
862
+ from = 0 # Integer |
863
+ size = 100 # Integer |
864
+
865
+
866
+ begin
867
+ #获取所有可用的索引模板
868
+ result = api_instance.index_list_templates(from, size)
869
+ p result
870
+ rescue IndexeaClient::ApiError => e
871
+ puts "Exception when calling IndicesApi->index_list_templates: #{e}"
872
+ end
873
+ ```
874
+
875
+ ### Parameters
876
+
877
+ Name | Type | Description | Notes
878
+ ------------- | ------------- | ------------- | -------------
879
+ **from** | **Integer**| | [default to 0]
880
+ **size** | **Integer**| | [default to 100]
881
+
882
+ ### Return type
883
+
884
+ [**IndexTemplates**](IndexTemplates.md)
885
+
886
+ ### Authorization
887
+
888
+ [TokenAuth](../README.md#TokenAuth)
889
+
890
+ ### HTTP request headers
891
+
892
+ - **Content-Type**: Not defined
893
+ - **Accept**: application/json
894
+
895
+
896
+
897
+ # **index_prefetch**
898
+ > Array<Object> index_prefetch(type, url)
899
+
900
+ 获取目标网站内容预览
901
+
902
+ ### Example
903
+ ```ruby
904
+ # load the gem
905
+ require 'indexea_client'
906
+ # setup authorization
907
+ IndexeaClient.configure do |config|
908
+ end
909
+
910
+ api_instance = IndexeaClient::IndicesApi.new
911
+ type = 'type_example' # String |
912
+ url = 'url_example' # String |
913
+
914
+
915
+ begin
916
+ #获取目标网站内容预览
917
+ result = api_instance.index_prefetch(type, url)
918
+ p result
919
+ rescue IndexeaClient::ApiError => e
920
+ puts "Exception when calling IndicesApi->index_prefetch: #{e}"
921
+ end
922
+ ```
923
+
924
+ ### Parameters
925
+
926
+ Name | Type | Description | Notes
927
+ ------------- | ------------- | ------------- | -------------
928
+ **type** | **String**| |
929
+ **url** | **String**| |
930
+
931
+ ### Return type
932
+
933
+ **Array<Object>**
934
+
935
+ ### Authorization
936
+
937
+ [TokenAuth](../README.md#TokenAuth)
938
+
939
+ ### HTTP request headers
940
+
941
+ - **Content-Type**: Not defined
942
+ - **Accept**: application/json
943
+
944
+
945
+
946
+ # **index_rebuild**
947
+ > IndexTask index_rebuild(bodyappindex)
948
+
949
+ 重建索引数据
950
+
951
+ ### Example
952
+ ```ruby
953
+ # load the gem
954
+ require 'indexea_client'
955
+ # setup authorization
956
+ IndexeaClient.configure do |config|
957
+ end
958
+
959
+ api_instance = IndexeaClient::IndicesApi.new
960
+ body = IndexeaClient::IndexRebuildForm.new # IndexRebuildForm |
961
+ app = 'app_example' # String | 应用标识
962
+ index = 56 # Integer | 索引编号
963
+
964
+
965
+ begin
966
+ #重建索引数据
967
+ result = api_instance.index_rebuild(bodyappindex)
968
+ p result
969
+ rescue IndexeaClient::ApiError => e
970
+ puts "Exception when calling IndicesApi->index_rebuild: #{e}"
971
+ end
972
+ ```
973
+
974
+ ### Parameters
975
+
976
+ Name | Type | Description | Notes
977
+ ------------- | ------------- | ------------- | -------------
978
+ **body** | [**IndexRebuildForm**](IndexRebuildForm.md)| |
979
+ **app** | **String**| 应用标识 |
980
+ **index** | **Integer**| 索引编号 |
981
+
982
+ ### Return type
983
+
984
+ [**IndexTask**](IndexTask.md)
985
+
986
+ ### Authorization
987
+
988
+ [TokenAuth](../README.md#TokenAuth)
989
+
990
+ ### HTTP request headers
991
+
992
+ - **Content-Type**: application/json
993
+ - **Accept**: application/json
994
+
995
+
996
+
997
+ # **index_rebuild_task**
998
+ > IndexTask index_rebuild_task(app, index, task_id)
999
+
1000
+ 获取重建索引任务的详情
1001
+
1002
+ ### Example
1003
+ ```ruby
1004
+ # load the gem
1005
+ require 'indexea_client'
1006
+ # setup authorization
1007
+ IndexeaClient.configure do |config|
1008
+ end
1009
+
1010
+ api_instance = IndexeaClient::IndicesApi.new
1011
+ app = 'app_example' # String | 应用标识
1012
+ index = 56 # Integer | 索引编号
1013
+ task_id = 0 # Integer | 任务编号,传0则获取最新的任务信息
1014
+
1015
+
1016
+ begin
1017
+ #获取重建索引任务的详情
1018
+ result = api_instance.index_rebuild_task(app, index, task_id)
1019
+ p result
1020
+ rescue IndexeaClient::ApiError => e
1021
+ puts "Exception when calling IndicesApi->index_rebuild_task: #{e}"
1022
+ end
1023
+ ```
1024
+
1025
+ ### Parameters
1026
+
1027
+ Name | Type | Description | Notes
1028
+ ------------- | ------------- | ------------- | -------------
1029
+ **app** | **String**| 应用标识 |
1030
+ **index** | **Integer**| 索引编号 |
1031
+ **task_id** | **Integer**| 任务编号,传0则获取最新的任务信息 | [default to 0]
1032
+
1033
+ ### Return type
1034
+
1035
+ [**IndexTask**](IndexTask.md)
1036
+
1037
+ ### Authorization
1038
+
1039
+ [TokenAuth](../README.md#TokenAuth)
1040
+
1041
+ ### HTTP request headers
1042
+
1043
+ - **Content-Type**: Not defined
1044
+ - **Accept**: application/json
1045
+
1046
+
1047
+
1048
+ # **index_submit_crawler_task**
1049
+ > CrawlerTask index_submit_crawler_task(bodyappindex)
1050
+
1051
+ 提交或者更新索引的数据爬取任务
1052
+
1053
+ ### Example
1054
+ ```ruby
1055
+ # load the gem
1056
+ require 'indexea_client'
1057
+ # setup authorization
1058
+ IndexeaClient.configure do |config|
1059
+ end
1060
+
1061
+ api_instance = IndexeaClient::IndicesApi.new
1062
+ body = IndexeaClient::CrawlerTask.new # CrawlerTask |
1063
+ app = 'app_example' # String | 应用标识
1064
+ index = 56 # Integer | 索引编号
1065
+
1066
+
1067
+ begin
1068
+ #提交或者更新索引的数据爬取任务
1069
+ result = api_instance.index_submit_crawler_task(bodyappindex)
1070
+ p result
1071
+ rescue IndexeaClient::ApiError => e
1072
+ puts "Exception when calling IndicesApi->index_submit_crawler_task: #{e}"
1073
+ end
1074
+ ```
1075
+
1076
+ ### Parameters
1077
+
1078
+ Name | Type | Description | Notes
1079
+ ------------- | ------------- | ------------- | -------------
1080
+ **body** | [**CrawlerTask**](CrawlerTask.md)| |
1081
+ **app** | **String**| 应用标识 |
1082
+ **index** | **Integer**| 索引编号 |
1083
+
1084
+ ### Return type
1085
+
1086
+ [**CrawlerTask**](CrawlerTask.md)
1087
+
1088
+ ### Authorization
1089
+
1090
+ [TokenAuth](../README.md#TokenAuth)
1091
+
1092
+ ### HTTP request headers
1093
+
1094
+ - **Content-Type**: application/json
1095
+ - **Accept**: application/json
1096
+
1097
+
1098
+
1099
+ # **index_update**
1100
+ > IndexBean index_update(bodyappindex)
1101
+
1102
+ 修改索引
1103
+
1104
+ ### Example
1105
+ ```ruby
1106
+ # load the gem
1107
+ require 'indexea_client'
1108
+ # setup authorization
1109
+ IndexeaClient.configure do |config|
1110
+ end
1111
+
1112
+ api_instance = IndexeaClient::IndicesApi.new
1113
+ body = IndexeaClient::IndexForm.new # IndexForm |
1114
+ app = 'app_example' # String | 应用标识
1115
+ index = 56 # Integer | 索引编号
1116
+
1117
+
1118
+ begin
1119
+ #修改索引
1120
+ result = api_instance.index_update(bodyappindex)
1121
+ p result
1122
+ rescue IndexeaClient::ApiError => e
1123
+ puts "Exception when calling IndicesApi->index_update: #{e}"
1124
+ end
1125
+ ```
1126
+
1127
+ ### Parameters
1128
+
1129
+ Name | Type | Description | Notes
1130
+ ------------- | ------------- | ------------- | -------------
1131
+ **body** | [**IndexForm**](IndexForm.md)| |
1132
+ **app** | **String**| 应用标识 |
1133
+ **index** | **Integer**| 索引编号 |
1134
+
1135
+ ### Return type
1136
+
1137
+ [**IndexBean**](IndexBean.md)
1138
+
1139
+ ### Authorization
1140
+
1141
+ [TokenAuth](../README.md#TokenAuth)
1142
+
1143
+ ### HTTP request headers
1144
+
1145
+ - **Content-Type**: application/json
1146
+ - **Accept**: application/json
1147
+
1148
+
1149
+
1150
+ # **index_update_settings**
1151
+ > BOOLEAN index_update_settings(typeappindex, opts)
1152
+
1153
+ 更新索引设置信息
1154
+
1155
+ ### Example
1156
+ ```ruby
1157
+ # load the gem
1158
+ require 'indexea_client'
1159
+ # setup authorization
1160
+ IndexeaClient.configure do |config|
1161
+ end
1162
+
1163
+ api_instance = IndexeaClient::IndicesApi.new
1164
+ type = 'type_example' # String | 设置类型
1165
+ app = 'app_example' # String | 应用标识
1166
+ index = 56 # Integer | 索引编号
1167
+ opts = {
1168
+ body: 'body_example' # String |
1169
+ }
1170
+
1171
+ begin
1172
+ #更新索引设置信息
1173
+ result = api_instance.index_update_settings(typeappindex, opts)
1174
+ p result
1175
+ rescue IndexeaClient::ApiError => e
1176
+ puts "Exception when calling IndicesApi->index_update_settings: #{e}"
1177
+ end
1178
+ ```
1179
+
1180
+ ### Parameters
1181
+
1182
+ Name | Type | Description | Notes
1183
+ ------------- | ------------- | ------------- | -------------
1184
+ **type** | **String**| 设置类型 |
1185
+ **app** | **String**| 应用标识 |
1186
+ **index** | **Integer**| 索引编号 |
1187
+ **body** | [**String**](String.md)| | [optional]
1188
+
1189
+ ### Return type
1190
+
1191
+ **BOOLEAN**
1192
+
1193
+ ### Authorization
1194
+
1195
+ [TokenAuth](../README.md#TokenAuth)
1196
+
1197
+ ### HTTP request headers
1198
+
1199
+ - **Content-Type**: text/plain
1200
+ - **Accept**: application/json
1201
+
1202
+
1203
+
1204
+ # **index_update_template**
1205
+ > IndexTemplate index_update_template(body)
1206
+
1207
+ 修改索引模板
1208
+
1209
+ ### Example
1210
+ ```ruby
1211
+ # load the gem
1212
+ require 'indexea_client'
1213
+ # setup authorization
1214
+ IndexeaClient.configure do |config|
1215
+ end
1216
+
1217
+ api_instance = IndexeaClient::IndicesApi.new
1218
+ body = IndexeaClient::IndexTemplate.new # IndexTemplate |
1219
+
1220
+
1221
+ begin
1222
+ #修改索引模板
1223
+ result = api_instance.index_update_template(body)
1224
+ p result
1225
+ rescue IndexeaClient::ApiError => e
1226
+ puts "Exception when calling IndicesApi->index_update_template: #{e}"
1227
+ end
1228
+ ```
1229
+
1230
+ ### Parameters
1231
+
1232
+ Name | Type | Description | Notes
1233
+ ------------- | ------------- | ------------- | -------------
1234
+ **body** | [**IndexTemplate**](IndexTemplate.md)| |
1235
+
1236
+ ### Return type
1237
+
1238
+ [**IndexTemplate**](IndexTemplate.md)
1239
+
1240
+ ### Authorization
1241
+
1242
+ [TokenAuth](../README.md#TokenAuth)
1243
+
1244
+ ### HTTP request headers
1245
+
1246
+ - **Content-Type**: application/json
1247
+ - **Accept**: application/json
1248
+
1249
+
1250
+
1251
+ # **synonyms_add**
1252
+ > SynonymsBean synonyms_add(bodyappindex)
1253
+
1254
+ 添加同义词
1255
+
1256
+ ### Example
1257
+ ```ruby
1258
+ # load the gem
1259
+ require 'indexea_client'
1260
+ # setup authorization
1261
+ IndexeaClient.configure do |config|
1262
+ end
1263
+
1264
+ api_instance = IndexeaClient::IndicesApi.new
1265
+ body = IndexeaClient::SynonymsBean.new # SynonymsBean |
1266
+ app = 'app_example' # String | 应用标识
1267
+ index = 56 # Integer | 索引编号
1268
+
1269
+
1270
+ begin
1271
+ #添加同义词
1272
+ result = api_instance.synonyms_add(bodyappindex)
1273
+ p result
1274
+ rescue IndexeaClient::ApiError => e
1275
+ puts "Exception when calling IndicesApi->synonyms_add: #{e}"
1276
+ end
1277
+ ```
1278
+
1279
+ ### Parameters
1280
+
1281
+ Name | Type | Description | Notes
1282
+ ------------- | ------------- | ------------- | -------------
1283
+ **body** | [**SynonymsBean**](SynonymsBean.md)| |
1284
+ **app** | **String**| 应用标识 |
1285
+ **index** | **Integer**| 索引编号 |
1286
+
1287
+ ### Return type
1288
+
1289
+ [**SynonymsBean**](SynonymsBean.md)
1290
+
1291
+ ### Authorization
1292
+
1293
+ [TokenAuth](../README.md#TokenAuth)
1294
+
1295
+ ### HTTP request headers
1296
+
1297
+ - **Content-Type**: application/json
1298
+ - **Accept**: application/json
1299
+
1300
+
1301
+
1302
+ # **synonyms_delete**
1303
+ > BOOLEAN synonyms_delete(app, index, id)
1304
+
1305
+ 删除同义词
1306
+
1307
+ ### Example
1308
+ ```ruby
1309
+ # load the gem
1310
+ require 'indexea_client'
1311
+ # setup authorization
1312
+ IndexeaClient.configure do |config|
1313
+ end
1314
+
1315
+ api_instance = IndexeaClient::IndicesApi.new
1316
+ app = 'app_example' # String | 应用标识
1317
+ index = 56 # Integer | 索引编号
1318
+ id = 56 # Integer | 同义词编号
1319
+
1320
+
1321
+ begin
1322
+ #删除同义词
1323
+ result = api_instance.synonyms_delete(app, index, id)
1324
+ p result
1325
+ rescue IndexeaClient::ApiError => e
1326
+ puts "Exception when calling IndicesApi->synonyms_delete: #{e}"
1327
+ end
1328
+ ```
1329
+
1330
+ ### Parameters
1331
+
1332
+ Name | Type | Description | Notes
1333
+ ------------- | ------------- | ------------- | -------------
1334
+ **app** | **String**| 应用标识 |
1335
+ **index** | **Integer**| 索引编号 |
1336
+ **id** | **Integer**| 同义词编号 |
1337
+
1338
+ ### Return type
1339
+
1340
+ **BOOLEAN**
1341
+
1342
+ ### Authorization
1343
+
1344
+ [TokenAuth](../README.md#TokenAuth)
1345
+
1346
+ ### HTTP request headers
1347
+
1348
+ - **Content-Type**: Not defined
1349
+ - **Accept**: application/json
1350
+
1351
+
1352
+
1353
+ # **synonyms_enable**
1354
+ > BOOLEAN synonyms_enable(app, index, id, opts)
1355
+
1356
+ 启用禁用同义词
1357
+
1358
+ ### Example
1359
+ ```ruby
1360
+ # load the gem
1361
+ require 'indexea_client'
1362
+ # setup authorization
1363
+ IndexeaClient.configure do |config|
1364
+ end
1365
+
1366
+ api_instance = IndexeaClient::IndicesApi.new
1367
+ app = 'app_example' # String | 应用标识
1368
+ index = 56 # Integer | 索引编号
1369
+ id = 56 # Integer | 同义词编号
1370
+ opts = {
1371
+ enable: true, # BOOLEAN | 是否启用
1372
+ all: true # BOOLEAN | 是否对所有索引起作用
1373
+ }
1374
+
1375
+ begin
1376
+ #启用禁用同义词
1377
+ result = api_instance.synonyms_enable(app, index, id, opts)
1378
+ p result
1379
+ rescue IndexeaClient::ApiError => e
1380
+ puts "Exception when calling IndicesApi->synonyms_enable: #{e}"
1381
+ end
1382
+ ```
1383
+
1384
+ ### Parameters
1385
+
1386
+ Name | Type | Description | Notes
1387
+ ------------- | ------------- | ------------- | -------------
1388
+ **app** | **String**| 应用标识 |
1389
+ **index** | **Integer**| 索引编号 |
1390
+ **id** | **Integer**| 同义词编号 |
1391
+ **enable** | **BOOLEAN**| 是否启用 | [optional]
1392
+ **all** | **BOOLEAN**| 是否对所有索引起作用 | [optional]
1393
+
1394
+ ### Return type
1395
+
1396
+ **BOOLEAN**
1397
+
1398
+ ### Authorization
1399
+
1400
+ [TokenAuth](../README.md#TokenAuth)
1401
+
1402
+ ### HTTP request headers
1403
+
1404
+ - **Content-Type**: Not defined
1405
+ - **Accept**: application/json
1406
+
1407
+
1408
+
1409
+ # **synonyms_flush**
1410
+ > Object synonyms_flush(appindex, opts)
1411
+
1412
+ 将同义词更新到搜索引擎的同义词表
1413
+
1414
+ ### Example
1415
+ ```ruby
1416
+ # load the gem
1417
+ require 'indexea_client'
1418
+ # setup authorization
1419
+ IndexeaClient.configure do |config|
1420
+ end
1421
+
1422
+ api_instance = IndexeaClient::IndicesApi.new
1423
+ app = 'app_example' # String | 应用标识
1424
+ index = 56 # Integer | 索引编号
1425
+ opts = {
1426
+ password: 'password_example' # String |
1427
+ }
1428
+
1429
+ begin
1430
+ #将同义词更新到搜索引擎的同义词表
1431
+ result = api_instance.synonyms_flush(appindex, opts)
1432
+ p result
1433
+ rescue IndexeaClient::ApiError => e
1434
+ puts "Exception when calling IndicesApi->synonyms_flush: #{e}"
1435
+ end
1436
+ ```
1437
+
1438
+ ### Parameters
1439
+
1440
+ Name | Type | Description | Notes
1441
+ ------------- | ------------- | ------------- | -------------
1442
+ **app** | **String**| 应用标识 |
1443
+ **index** | **Integer**| 索引编号 |
1444
+ **password** | [**String**](.md)| | [optional]
1445
+
1446
+ ### Return type
1447
+
1448
+ **Object**
1449
+
1450
+ ### Authorization
1451
+
1452
+ [TokenAuth](../README.md#TokenAuth)
1453
+
1454
+ ### HTTP request headers
1455
+
1456
+ - **Content-Type**: application/x-www-form-urlencoded
1457
+ - **Accept**: application/json
1458
+
1459
+
1460
+
1461
+ # **synonyms_import**
1462
+ > Array<SynonymsBean> synonyms_import(bodyactionappindex)
1463
+
1464
+ 导入同义词
1465
+
1466
+ ### Example
1467
+ ```ruby
1468
+ # load the gem
1469
+ require 'indexea_client'
1470
+ # setup authorization
1471
+ IndexeaClient.configure do |config|
1472
+ end
1473
+
1474
+ api_instance = IndexeaClient::IndicesApi.new
1475
+ body = [IndexeaClient::SynonymsBean.new] # Array<SynonymsBean> |
1476
+ action = 56 # Integer | 覆盖方式
1477
+ app = 'app_example' # String | 应用标识
1478
+ index = 56 # Integer | 索引编号
1479
+
1480
+
1481
+ begin
1482
+ #导入同义词
1483
+ result = api_instance.synonyms_import(bodyactionappindex)
1484
+ p result
1485
+ rescue IndexeaClient::ApiError => e
1486
+ puts "Exception when calling IndicesApi->synonyms_import: #{e}"
1487
+ end
1488
+ ```
1489
+
1490
+ ### Parameters
1491
+
1492
+ Name | Type | Description | Notes
1493
+ ------------- | ------------- | ------------- | -------------
1494
+ **body** | [**Array&lt;SynonymsBean&gt;**](SynonymsBean.md)| |
1495
+ **action** | **Integer**| 覆盖方式 |
1496
+ **app** | **String**| 应用标识 |
1497
+ **index** | **Integer**| 索引编号 |
1498
+
1499
+ ### Return type
1500
+
1501
+ [**Array&lt;SynonymsBean&gt;**](SynonymsBean.md)
1502
+
1503
+ ### Authorization
1504
+
1505
+ [TokenAuth](../README.md#TokenAuth)
1506
+
1507
+ ### HTTP request headers
1508
+
1509
+ - **Content-Type**: application/json
1510
+ - **Accept**: application/json
1511
+
1512
+
1513
+
1514
+ # **synonyms_list**
1515
+ > Array&lt;SynonymsBean&gt; synonyms_list(app, index, size, opts)
1516
+
1517
+ 获取索引的所有同义词
1518
+
1519
+ ### Example
1520
+ ```ruby
1521
+ # load the gem
1522
+ require 'indexea_client'
1523
+ # setup authorization
1524
+ IndexeaClient.configure do |config|
1525
+ end
1526
+
1527
+ api_instance = IndexeaClient::IndicesApi.new
1528
+ app = 'app_example' # String | 应用标识
1529
+ index = 56 # Integer | 索引编号
1530
+ size = 99999 # Integer |
1531
+ opts = {
1532
+ type: 0, # Integer | 类型
1533
+ from: 0 # Integer |
1534
+ }
1535
+
1536
+ begin
1537
+ #获取索引的所有同义词
1538
+ result = api_instance.synonyms_list(app, index, size, opts)
1539
+ p result
1540
+ rescue IndexeaClient::ApiError => e
1541
+ puts "Exception when calling IndicesApi->synonyms_list: #{e}"
1542
+ end
1543
+ ```
1544
+
1545
+ ### Parameters
1546
+
1547
+ Name | Type | Description | Notes
1548
+ ------------- | ------------- | ------------- | -------------
1549
+ **app** | **String**| 应用标识 |
1550
+ **index** | **Integer**| 索引编号 |
1551
+ **size** | **Integer**| | [default to 99999]
1552
+ **type** | **Integer**| 类型 | [optional] [default to 0]
1553
+ **from** | **Integer**| | [optional] [default to 0]
1554
+
1555
+ ### Return type
1556
+
1557
+ [**Array&lt;SynonymsBean&gt;**](SynonymsBean.md)
1558
+
1559
+ ### Authorization
1560
+
1561
+ [TokenAuth](../README.md#TokenAuth)
1562
+
1563
+ ### HTTP request headers
1564
+
1565
+ - **Content-Type**: Not defined
1566
+ - **Accept**: application/json
1567
+
1568
+
1569
+
1570
+ # **synonyms_update**
1571
+ > SynonymsBean synonyms_update(bodyappindex)
1572
+
1573
+ 修改同义词
1574
+
1575
+ ### Example
1576
+ ```ruby
1577
+ # load the gem
1578
+ require 'indexea_client'
1579
+ # setup authorization
1580
+ IndexeaClient.configure do |config|
1581
+ end
1582
+
1583
+ api_instance = IndexeaClient::IndicesApi.new
1584
+ body = IndexeaClient::SynonymsBean.new # SynonymsBean |
1585
+ app = 'app_example' # String | 应用标识
1586
+ index = 56 # Integer | 索引编号
1587
+
1588
+
1589
+ begin
1590
+ #修改同义词
1591
+ result = api_instance.synonyms_update(bodyappindex)
1592
+ p result
1593
+ rescue IndexeaClient::ApiError => e
1594
+ puts "Exception when calling IndicesApi->synonyms_update: #{e}"
1595
+ end
1596
+ ```
1597
+
1598
+ ### Parameters
1599
+
1600
+ Name | Type | Description | Notes
1601
+ ------------- | ------------- | ------------- | -------------
1602
+ **body** | [**SynonymsBean**](SynonymsBean.md)| |
1603
+ **app** | **String**| 应用标识 |
1604
+ **index** | **Integer**| 索引编号 |
1605
+
1606
+ ### Return type
1607
+
1608
+ [**SynonymsBean**](SynonymsBean.md)
1609
+
1610
+ ### Authorization
1611
+
1612
+ [TokenAuth](../README.md#TokenAuth)
1613
+
1614
+ ### HTTP request headers
1615
+
1616
+ - **Content-Type**: application/json
1617
+ - **Accept**: application/json
1618
+
1619
+
1620
+