# indexea_client **Repository Path**: oscstudio/indexea_client ## Basic Information - **Project Name**: indexea_client - **Description**: IndexeaClient - the Ruby gem for the Indexea OpenAPI This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-04-16 - **Last Updated**: 2024-08-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # indexea_client IndexeaClient - the Ruby gem for the Indexea OpenAPI 这是 Indexea 搜索服务平台的 OpenAPI,用于描述平台的所有接口信息,你可以通过这个页面来了解和在线验证平台的所有接口信息。 ### Errors 本 API 使用标准的 HTTP 状态码来指示操作成功或者失败,如果失败将会在 body 中以 JSON 格式提供详细的错误信息,如下所示: ``` { \"error\": 404, \"message\": \"page not found\" } ``` This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.0 - Package version: 0.1.0 - Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen For more information, please visit [https://indexea.com/about](https://indexea.com/about) ## Installation ### Build a gem To build the Ruby code into a gem: ```shell gem build indexea_client.gemspec ``` Then either install the gem locally: ```shell gem install ./indexea_client-0.1.0.gem ``` (for development, run `gem install --dev ./indexea_client-0.1.0.gem` to install the development dependencies) or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). Finally add this to the Gemfile: gem 'indexea_client', '~> 0.1.0' ### Install from Git If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile: gem 'indexea_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git' ### Include the Ruby code directly Include the Ruby code directly using `-I` as follows: ```shell ruby -Ilib script.rb ``` ## Getting Started Please follow the [installation](#installation) procedure and then run the following code: ```ruby # Load the gem require 'indexea_client' # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new begin #获取系统公告 result = api_instance.account_bulletin p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_bulletin: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new opts = { pwd: 'pwd_example', # String | vcode: 'vcode_example' # String | } begin #注销账号 result = api_instance.account_delete(opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_delete: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new type = 'type_example' # String | 三方账号类型 openid = 'openid_example' # String | 三方账号唯一标识 begin #解绑三方账号 result = api_instance.account_delete_openid(type, openid) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_delete_openid: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new begin #获取绑定的所有三方账号 result = api_instance.account_openid p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_openid: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new password = 'password_example' # String | new_password = 'new_password_example' # String | begin #修改账号密码 result = api_instance.account_passwd(password, new_password) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_passwd: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new portrait = 'portrait_example' # String | begin #修改账号头像 result = api_instance.account_portrait(portrait) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_portrait: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new opts = { account: 'account_example' # String | 获取指定账号信息,如果不指定,则返回当前登录账号 } begin #获取登录账号信息 result = api_instance.account_profile(opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_profile: #{e}" end api_instance = IndexeaClient::AccountApi.new opts = { account: 'account_example', # String | verify_code: 'verify_code_example', # String | pwd: 'pwd_example' # String | } begin #重置账号密码 result = api_instance.account_reset_pwd(opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_reset_pwd: #{e}" end api_instance = IndexeaClient::AccountApi.new account = 'account_example' # String | 账号 purpose = 'purpose_example' # String | 验证码的用途 begin #发送账号验证码 result = api_instance.account_send_verify_code(account, purpose) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_send_verify_code: #{e}" end api_instance = IndexeaClient::AccountApi.new account = 'account_example' # String | pwd = 'pwd_example' # String | keep_login = true # BOOLEAN | begin #登录系统 result = api_instance.account_signin(account, pwd, keep_login) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_signin: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new begin #退出登录状态 api_instance.account_signout rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_signout: #{e}" end api_instance = IndexeaClient::AccountApi.new opts = { account: 'account_example', # String | pwd: 'pwd_example', # String | name: 'name_example', # String | activate_code: 'activate_code_example' # String | } begin #注册新账号 result = api_instance.account_signup(opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_signup: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new body = IndexeaClient::AccountBean.new # AccountBean | begin #修改账号资料 result = api_instance.account_update(body) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_update: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AccountApi.new key = 'key_example' # String | type = 'type_example' # String | value = 'value_example' # String | vcode = 'vcode_example' # String | begin #修改账号设置 result = api_instance.account_update_settings(key, type, value, vcode) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AccountApi->account_update_settings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 account = 'account_example' # String | 成员账号 scopes = 'scopes_example' # String | 权限 opts = { name: 'name_example' # String | 备注名称 } begin #添加应用成员 result = api_instance.app_add_mentor(app, account, scopes, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_add_mentor: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 begin #获取黑名单信息 result = api_instance.app_blacklist(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_blacklist: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new opts = { name: 'name_example', # String | intro: 'intro_example' # String | } begin #创建应用 result = api_instance.app_create(opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_create: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new body = IndexeaClient::TokenBean.new # TokenBean | app = 'app_example' # String | 应用标识 begin #创建 Access Token result = api_instance.app_create_access_token(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_create_access_token: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new body = IndexeaClient::OauthAppBean.new # OauthAppBean | app = 'app_example' # String | 应用标识 begin #创建第三方应用 result = api_instance.app_create_oauth_app(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_create_oauth_app: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 begin #删除应用 result = api_instance.app_delete(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_delete: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 id = 56 # Integer | Access Token 编号 opts = { vcode: 'vcode_example' # String | } begin #删除 Access Token result = api_instance.app_delete_access_token(app, id, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_delete_access_token: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 account = 56 # Integer | 成员编号 begin #删除应用成员 result = api_instance.app_delete_mentor(app, account) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_delete_mentor: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 三方应用编号 opts = { vcode: 'vcode_example' # String | } begin #删除第三方应用 result = api_instance.app_delete_oauth_app(app, ident, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_delete_oauth_app: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 opts = { account: 0, # Integer | 账号 indices: [56], # Array | 索引 widget: 0, # Integer | 组件 query: 0, # Integer | 查询 type: 0, # Integer | 类型 start_date: Date.parse('2013-10-20'), # Date | 起始日期 end_date: Date.parse('2013-10-20') # Date | 结束日期 } begin #导出应用日志到 Excel result = api_instance.app_excel_of_logs(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_excel_of_logs: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 begin #获取应用详情 result = api_instance.app_get(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_get: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 begin #获取应用填写的公司信息 result = api_instance.app_get_company(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_get_company: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 type = 'type_example' # String | 获取图片的类型 [license,certificate] begin #获取公司营业执照或者一般纳税人证明 result = api_instance.app_get_company_pic(app, type) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_get_company_pic: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new begin #获取应用列表 result = api_instance.app_list p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 opts = { from: 0, # Integer | 开始位置 size: 20 # Integer | 获取的数量 } begin #获取应用成员列表 result = api_instance.app_list_mentors(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_list_mentors: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 begin #获取第三方应用列表 result = api_instance.app_list_oauth_apps(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_list_oauth_apps: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 opts = { account: 0, # Integer | 账号 indices: [56], # Array | 索引 widget: 0, # Integer | 组件 query: 0, # Integer | 查询 type: 0, # Integer | 类型 start_date: Date.parse('2013-10-20'), # Date | 起始日期 end_date: Date.parse('2013-10-20'), # Date | 结束日期 from: 0, # Integer | 起始位置 size: 20 # Integer | 数量 } begin #获取应用的日志列表 result = api_instance.app_logs(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_logs: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 id = 56 # Integer | Access Token 编号 opts = { vcode: 'vcode_example' # String | } begin #重置 Access Token result = api_instance.app_reset_access_token(app, id, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_reset_access_token: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 三方应用标识 opts = { vcode: 'vcode_example' # String | } begin #重新生成三方应用的密钥 result = api_instance.app_reset_oauth_app_secret(app, ident, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_reset_oauth_app_secret: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new body = IndexeaClient::BlacklistBean.new # BlacklistBean | app = 'app_example' # String | 应用标识 begin #修改应用的黑名单信息 result = api_instance.app_save_blacklist(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_save_blacklist: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 opts = { name: 'name_example', # String | url: 'url_example', # String | nation: 'nation_example', # String | province: 'province_example', # String | city: 'city_example', # String | taxpayer: 'taxpayer_example', # String | bank: 'bank_example', # String | account: 'account_example', # String | address: 'address_example', # String | tel: 'tel_example', # String | license: 'license_example', # String | certificate: 'certificate_example', # String | post_addr: 'post_addr_example', # String | post_code: 'post_code_example', # String | post_name: 'post_name_example', # String | post_tel: 'post_tel_example' # String | } begin #修改应用的公司信息 result = api_instance.app_save_company(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_save_company: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 days = 30 # Integer | 计算平均搜索数的最近天数 begin #获取搜索流量包使用配额信息 result = api_instance.app_searchs_estimate(app, days) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_searchs_estimate: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new body = IndexeaClient::TriggerBean.new # TriggerBean | app = 'app_example' # String | 应用标识 begin #修改应用的触发器信息 result = api_instance.app_set_trigger(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_set_trigger: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 begin #获取 Access Token 列表 result = api_instance.app_tokens(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_tokens: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 vcode = 'vcode_example' # String | 验证码 account = 56 # Integer | 目标账号 begin #转让应用给他人 result = api_instance.app_transfer(app, vcode, account) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_transfer: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 begin #获取应用触发器详情 result = api_instance.app_trigger(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_trigger: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 id = 999999999 # Integer | 起始日志编号 size = 20 # Integer | 日志数 begin #获取应用触发日志列表 result = api_instance.app_trigger_logs(app, id, size) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_trigger_logs: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 opts = { name: 'name_example', # String | intro: 'intro_example' # String | } begin #修改应用的基本信息 result = api_instance.app_update(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new body = IndexeaClient::TokenBean.new # TokenBean | app = 'app_example' # String | 应用标识 begin #修改 Access Token result = api_instance.app_update_access_token(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update_access_token: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 account = 56 # Integer | 成员编号 name = 'name_example' # String | 备注名称 scopes = 'scopes_example' # String | 权限 begin #修改成员备注和权限 result = api_instance.app_update_mentor(app, account, name, scopes) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update_mentor: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 opts = { name: 'name_example', # String | 应用备注名称,如果不填写则使用默认名称 report: false # BOOLEAN | 是否接收使用情况报告 } begin #修改应用成员自身的设置(包括应用名备注,是否接收报告等) result = api_instance.app_update_mentor_options(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update_mentor_options: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new key = 'key_example' # String | type = 'type_example' # String | value = 'value_example' # String | vcode = 'vcode_example' # String | app = 'app_example' # String | 应用标识 begin #修改应用成员自身的通知设置 result = api_instance.app_update_mentor_report_options(key, type, value, vcode, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update_mentor_report_options: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new body = IndexeaClient::OauthAppBean.new # OauthAppBean | app = 'app_example' # String | 应用标识 begin #修改第三方应用信息 result = api_instance.app_update_oauth_app(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update_oauth_app: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 三方应用标识 opts = { logo: 'logo_example' # String | } begin #修改三方应用图标 result = api_instance.app_update_oauth_app_logo(app, ident, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update_oauth_app_logo: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::AppsApi.new app = 'app_example' # String | 应用标识 vcode = 'vcode_example' # String | 验证码 status = 56 # Integer | 新状态 begin #修改应用的状态 result = api_instance.app_update_status(app, vcode, status) p result rescue IndexeaClient::ApiError => e puts "Exception when calling AppsApi->app_update_status: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::FieldsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #获取索引字段映射详情 result = api_instance.index_fields(app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling FieldsApi->index_fields: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::FieldsApi.new body = nil # Object | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #更新索引的字段映射 result = api_instance.index_update_fields(body, app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling FieldsApi->index_update_fields: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::FieldsApi.new body = nil # Object | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #更新索引的HTML过滤字段列表 result = api_instance.index_update_html_strip_fields(body, app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling FieldsApi->index_update_html_strip_fields: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::FieldsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 field = 'field_example' # String | 字段名称 size = 20 # Integer | values count begin #获取索引字段的所有值列表 result = api_instance.index_values_of_field(app, index, field, size) p result rescue IndexeaClient::ApiError => e puts "Exception when calling FieldsApi->index_values_of_field: #{e}" end api_instance = IndexeaClient::GlobalApi.new begin #接口定义(JSON) result = api_instance.json p result rescue IndexeaClient::ApiError => e puts "Exception when calling GlobalApi->json: #{e}" end api_instance = IndexeaClient::GlobalApi.new name = 'name_example' # String | keys = 'keys_example' # String | 配置项名,多个配置项请使用逗号隔开 begin #系统全局配置接口 result = api_instance.options_get(name, keys) p result rescue IndexeaClient::ApiError => e puts "Exception when calling GlobalApi->options_get: #{e}" end api_instance = IndexeaClient::GlobalApi.new begin #数据库服务状态测试 result = api_instance.status_database p result rescue IndexeaClient::ApiError => e puts "Exception when calling GlobalApi->status_database: #{e}" end api_instance = IndexeaClient::GlobalApi.new begin #搜索引擎状态测试 result = api_instance.status_engine p result rescue IndexeaClient::ApiError => e puts "Exception when calling GlobalApi->status_engine: #{e}" end api_instance = IndexeaClient::GlobalApi.new begin #接口欢迎信息 result = api_instance.welcome p result rescue IndexeaClient::ApiError => e puts "Exception when calling GlobalApi->welcome: #{e}" end api_instance = IndexeaClient::GlobalApi.new begin #接口定义(YAML) result = api_instance.yaml p result rescue IndexeaClient::ApiError => e puts "Exception when calling GlobalApi->yaml: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 vcode = 'vcode_example' # String | 验证码 begin #清空索引记录 result = api_instance.index_cleanup(app, index, vcode) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_cleanup: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 name = 'name_example' # String | 新索引的名称 fields = true # BOOLEAN | 是否复制字段定义 queries = true # BOOLEAN | 是否复制所有查询 records = true # BOOLEAN | 是否复制所有文档 begin #导出索引数据 result = api_instance.index_copy_to(app, index, name, fields, queries, records) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_copy_to: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::IndexForm.new # IndexForm | app = 'app_example' # String | 应用标识 begin #创建索引 result = api_instance.index_create(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_create: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::IndexTemplate.new # IndexTemplate | begin #创建索引模板 result = api_instance.index_create_template(body) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_create_template: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 opts = { vcode: 'vcode_example' # String | } begin #删除索引 result = api_instance.index_delete(app, index, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_delete: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #删除索引的数据爬取任务 result = api_instance.index_delete_crawler_task(app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_delete_crawler_task: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new id = 56 # Integer | begin #删除索引模板 result = api_instance.index_delete_template(id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_delete_template: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 format = 'json' # String | 导出数据的格式 begin #导出索引数据 result = api_instance.index_export(app, index, format) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_export: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #刷新索引数据,主要用于将内存中的索引数据写入磁盘 result = api_instance.index_flush(app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_flush: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 type = 'type_example' # String | 设置类型 opts = { password: 'password_example' # String | } begin #写入设置信息到索引 result = api_instance.index_flush_settings(app, index, type, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_flush_settings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #获取单个索引详情 result = api_instance.index_get(app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_get: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 from = 56 # Integer | size = 56 # Integer | begin #获取索引的爬虫任务的爬取日志 result = api_instance.index_get_crawler_logs(app, index, from, size) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_get_crawler_logs: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #获取索引的爬虫任务设定 result = api_instance.index_get_crawler_task(app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_get_crawler_task: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 type = 'type_example' # String | 设置类型 begin #获取索引设置信息 result = api_instance.index_get_filter_settings(app, index, type) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_get_filter_settings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 type = 'type_example' # String | 设置类型 begin #获取索引设置信息 result = api_instance.index_get_settings(app, index, type) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_get_settings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 opts = { stat: true # BOOLEAN | 是否包含索引的统计信息 } begin #获取应用的索引列表 result = api_instance.index_list(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new from = 0 # Integer | size = 100 # Integer | begin #获取所有可用的索引模板 result = api_instance.index_list_templates(from, size) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_list_templates: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new type = 'type_example' # String | url = 'url_example' # String | begin #获取目标网站内容预览 result = api_instance.index_prefetch(type, url) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_prefetch: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::IndexRebuildForm.new # IndexRebuildForm | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #重建索引数据 result = api_instance.index_rebuild(body, app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_rebuild: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 task_id = 0 # Integer | 任务编号,传0则获取最新的任务信息 begin #获取重建索引任务的详情 result = api_instance.index_rebuild_task(app, index, task_id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_rebuild_task: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::CrawlerTask.new # CrawlerTask | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #提交或者更新索引的数据爬取任务 result = api_instance.index_submit_crawler_task(body, app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_submit_crawler_task: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::IndexForm.new # IndexForm | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #修改索引 result = api_instance.index_update(body, app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_update: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 type = 'type_example' # String | 设置类型 opts = { body: 'body_example' # String | } begin #更新索引设置信息 result = api_instance.index_update_settings(app, index, type, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_update_settings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::IndexTemplate.new # IndexTemplate | begin #修改索引模板 result = api_instance.index_update_template(body) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->index_update_template: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::SynonymsBean.new # SynonymsBean | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #添加同义词 result = api_instance.synonyms_add(body, app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->synonyms_add: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 id = 56 # Integer | 同义词编号 begin #删除同义词 result = api_instance.synonyms_delete(app, index, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->synonyms_delete: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 id = 56 # Integer | 同义词编号 opts = { enable: true, # BOOLEAN | 是否启用 all: true # BOOLEAN | 是否对所有索引起作用 } begin #启用禁用同义词 result = api_instance.synonyms_enable(app, index, id, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->synonyms_enable: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 opts = { password: 'password_example' # String | } begin #将同义词更新到搜索引擎的同义词表 result = api_instance.synonyms_flush(app, index, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->synonyms_flush: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = [IndexeaClient::SynonymsBean.new] # Array | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 action = 56 # Integer | 覆盖方式 begin #导入同义词 result = api_instance.synonyms_import(body, app, index, action) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->synonyms_import: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 size = 99999 # Integer | opts = { type: 0, # Integer | 类型 from: 0 # Integer | } begin #获取索引的所有同义词 result = api_instance.synonyms_list(app, index, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->synonyms_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::IndicesApi.new body = IndexeaClient::SynonymsBean.new # SynonymsBean | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 begin #修改同义词 result = api_instance.synonyms_update(body, app, index) p result rescue IndexeaClient::ApiError => e puts "Exception when calling IndicesApi->synonyms_update: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::MessageApi.new id = 56 # Integer | 消息编号 begin #删除消息 result = api_instance.message_delete(id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling MessageApi->message_delete: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::MessageApi.new content = 'content_example' # String | type = 'type_example' # String | begin #反馈意见 result = api_instance.message_feedback(content, type) p result rescue IndexeaClient::ApiError => e puts "Exception when calling MessageApi->message_feedback: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::MessageApi.new scope = 'unread' # String | size = 10 # Integer | 消息数量 opts = { from: 0 # Integer | 用于翻页的起始位置 } begin #获取我相关的消息信息,包括未读消息数量、最新消息等 result = api_instance.message_list(scope, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling MessageApi->message_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::MessageApi.new id = 'id_example' # String | 消息编号,多个消息使用逗号隔开 begin #标识消息为已读 result = api_instance.message_read(id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling MessageApi->message_read: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::MessageApi.new receiver = 56 # Integer | msg = 'msg_example' # String | begin #发送消息 result = api_instance.message_send(receiver, msg) p result rescue IndexeaClient::ApiError => e puts "Exception when calling MessageApi->message_send: #{e}" end api_instance = IndexeaClient::PaymentApi.new begin #接受支付宝的支付结果 api_instance.payment_alipay rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_alipay: #{e}" end api_instance = IndexeaClient::PaymentApi.new begin #支付宝平台支付完毕后调整到该接口 api_instance.payment_alipay_return rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_alipay_return: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new body = ['body_example'] # Array | 申请开发票的订单编号列表 app = 'app_example' # String | 应用标识 type = 1 # Integer | 发票类型 begin #申请发票 result = api_instance.payment_apply_invoice(body, app, type) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_apply_invoice: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 订单号 type = 'type_example' # String | 支付方式 begin #支付订单 result = api_instance.payment_begin_pay(app, ident, type) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_begin_pay: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new body = IndexeaClient::PaymentService.new # PaymentService | app = 'app_example' # String | 应用标识 begin #下单购买 result = api_instance.payment_buy(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_buy: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 id = 56 # Integer | 发票编号 begin #删除发票 result = api_instance.payment_delete_invoice(app, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_delete_invoice: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 订单号 begin #取消订单 result = api_instance.payment_delete_order(app, ident) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_delete_order: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 begin #获取发票列表 result = api_instance.payment_invoices(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_invoices: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 订单号 begin #获取订单详情 result = api_instance.payment_order(app, ident) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_order: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 begin #订单列表 result = api_instance.payment_orders(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_orders: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 begin #获取未曾开票的订单列表 result = api_instance.payment_orders_without_invoice(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_orders_without_invoice: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 service = IndexeaClient::PaymentService.new # PaymentService | 配额信息 begin #获取套餐价格 result = api_instance.payment_price(app, service) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_price: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 订单号 id = 56 # Integer | 回执编号 begin #获取订单回执图片 result = api_instance.payment_receipt(app, ident, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_receipt: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new body = IndexeaClient::ContactForm.new # ContactForm | 客户联系信息 app = 'app_example' # String | 应用标识 begin #联系销售获取私有化报价 result = api_instance.payment_request_contact(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_request_contact: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::PaymentApi.new receipt = 'receipt_example' # String | app = 'app_example' # String | 应用标识 ident = 'ident_example' # String | 订单号 begin #上传转账回执 result = api_instance.payment_upload_receipt(receipt, app, ident) p result rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_upload_receipt: #{e}" end api_instance = IndexeaClient::PaymentApi.new begin #接受微信支付的支付结果 api_instance.payment_wepay rescue IndexeaClient::ApiError => e puts "Exception when calling PaymentApi->payment_wepay: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = IndexeaClient::AnalyzeObject.new # AnalyzeObject | app = 'app_example' # String | 应用标识 opts = { index: IndexeaClient::BigDecimal.new # BigDecimal | 索引编号,如果指定索引编号则使用索引的分词器 } begin #分词测试 result = api_instance.query_analyze(body, app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_analyze: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 源查询编号 begin #复制指定查询并创建新查询 result = api_instance.query_copy(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_copy: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 源查询编号 to = 56 # Integer | 目标查询编号 begin #复制查询到已有查询 result = api_instance.query_copy_to_query(app, query, to) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_copy_to_query: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = IndexeaClient::QueryForm.new # QueryForm | app = 'app_example' # String | 应用标识 begin #创建搜索 result = api_instance.query_create(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_create: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = IndexeaClient::KeywordBindingBean.new # KeywordBindingBean | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #创建新的关键词文档绑定 result = api_instance.query_create_keyword_bindings(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_create_keyword_bindings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = IndexeaClient::QueryVariableBean.new # QueryVariableBean | app = 'app_example' # String | 应用标识 begin #创建新的预定义查询变量 result = api_instance.query_create_variable(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_create_variable: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #删除搜索 result = api_instance.query_delete(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_delete: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 id = 56 # Integer | 关键词编号 begin #删除关键词文档绑定 result = api_instance.query_delete_keyword_bindings(app, query, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_delete_keyword_bindings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #清除查询条件的节点位置信息 result = api_instance.query_delete_node_positions(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_delete_node_positions: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 id = 56 # Integer | 自定义查询变量编号 begin #删除预定义查询变量 result = api_instance.query_delete_variable(app, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_delete_variable: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #获取查询关联的所有索引的字段信息 result = api_instance.query_fields(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_fields: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #获取查询的详情 result = api_instance.query_get(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_get: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #获取查询条件的节点位置信息 result = api_instance.query_get_node_positions(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_get_node_positions: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 _id = '_id_example' # String | 记录 _id 值 begin #获取记录的详情 result = api_instance.query_get_record(app, query, _id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_get_record: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #获取查询的关键词文档绑定列表 result = api_instance.query_keyword_bindings(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_keyword_bindings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 opts = { index: 56 # Integer | 索引编号 } begin #获取应用下所有索引下的查询列表(按索引进行分组) result = api_instance.query_list(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 记录编号 opts = { q: 'q_example' # String | 诊断关键字 } begin #获取搜索诊断信息 result = api_instance.query_profile(app, query, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_profile: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 id = 56 # Integer | 关键词绑定编号 begin #获取关键词绑定对应的记录列表 result = api_instance.query_records_of_keyword_binding(app, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_records_of_keyword_binding: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 opts = { fields: ['fields_example'] # Array | 字段列表 } begin #设置索引智能匹配字段 result = api_instance.query_save_intelligent_mappings(app, query, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_save_intelligent_mappings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = nil # Object | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #保存查询条件的节点位置信息 result = api_instance.query_save_node_positions(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_save_node_positions: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 from = 0 # Integer | 起始记录 size = 10 # Integer | 每页记录数量 opts = { q: 'q_example', # String | 查询关键字 params: {'key' => 'params_example'} # Hash | 聚合参数 } begin #搜索测试 result = api_instance.query_search(app, query, from, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_search: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 opts = { q: 'q_example' # String | 搜索关键字 } begin #获取最终查询的源码(JSON) result = api_instance.query_source(app, query, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_source: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 q = 'q_example' # String | 搜索关键字 begin #获取搜索建议列表 result = api_instance.query_suggest(app, query, q) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_suggest: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 q = 'q_example' # String | 搜索内容 opts = { fields: ['fields_example'] # Array | 字段列表 } begin #测试索引智能匹配字段 result = api_instance.query_test_intelligent_mappings(app, query, q, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_test_intelligent_mappings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = IndexeaClient::QueryForm.new # QueryForm | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #修改查询 result = api_instance.query_update(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_update: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = IndexeaClient::KeywordBindingBean.new # KeywordBindingBean | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #修改关键词文档绑定 result = api_instance.query_update_keyword_bindings(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_update_keyword_bindings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 记录编号 name = 'name_example' # String | 设置项名称 value = 'value_example' # String | 设置值 type = 'string' # String | 设置项类型 begin #更改查询的设置项 result = api_instance.query_update_settings(app, query, name, value, type) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_update_settings: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = IndexeaClient::QueryVariableBean.new # QueryVariableBean | app = 'app_example' # String | 应用标识 id = 56 # Integer | 自定义查询变量编号 begin #修改预定义查询变量 result = api_instance.query_update_variable(body, app, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_update_variable: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #获取搜索验证结果 result = api_instance.query_validate(app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_validate: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = nil # Object | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #验证聚合定义是否正确 result = api_instance.query_validate_aggregation(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_validate_aggregation: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = nil # Object | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #验证聚合定义是否正确 result = api_instance.query_validate_query(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_validate_query: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = nil # Object | app = 'app_example' # String | 应用标识 opts = { query: 56, # Integer | 查询编号, query 和 index 两个参数传一个即可 index: 56 # Integer | 索引编号, query 和 index 两个参数传一个即可 } begin #验证脚本字段是否正确 result = api_instance.query_validate_script_field(body, app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_validate_script_field: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = nil # Object | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #验证脚本字段是否正确 result = api_instance.query_validate_script_score(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_validate_script_score: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new body = nil # Object | app = 'app_example' # String | 应用标识 query = 56 # Integer | 查询编号 begin #验证建议是否正确 result = api_instance.query_validate_suggestion(body, app, query) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_validate_suggestion: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::QueriesApi.new app = 'app_example' # String | 应用标识 begin #获取应用的预定义查询变量列表 result = api_instance.query_variables(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling QueriesApi->query_variables: #{e}" end api_instance = IndexeaClient::RecommendApi.new ident = 'ident_example' # String | 推荐的唯一标识 action_id = 'action_id_example' # String | 对应推荐行为编号 doc_id = 'doc_id_example' # String | 对应索引中的内部记录编号 opts = { userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 x_token: 'x_token_example' # String | 如果要使用非发布的组件,需要组件作者授权 } begin #推荐结果点击行为收集 result = api_instance.recommend_click(ident, action_id, doc_id, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecommendApi->recommend_click: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecommendApi.new body = IndexeaClient::RecommendBean.new # RecommendBean | 推荐信息 app = 'app_example' # String | 应用标识 begin #创建新的推荐 result = api_instance.recommend_create(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecommendApi->recommend_create: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecommendApi.new app = 'app_example' # String | 应用标识 id = 56 # Integer | 推荐编号 begin #删除推荐 result = api_instance.recommend_delete(app, id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecommendApi->recommend_delete: #{e}" end api_instance = IndexeaClient::RecommendApi.new ident = 'ident_example' # String | 推荐定义的标识 opts = { x_token: 'x_token_example' # String | 如果要使用非发布的组件,需要组件作者授权 } begin #获取推荐的记录列表 result = api_instance.recommend_detail(ident, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecommendApi->recommend_detail: #{e}" end api_instance = IndexeaClient::RecommendApi.new ident = 'ident_example' # String | 推荐定义的标识 opts = { x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 userid: 'userid_example', # String | 访客的唯一标识,该标识由搜索前端生成,长度不超过64 condition: {'key' => 'condition_example'}, # Hash | 获取某个记录的参数,例如 id=11223(后端将使用 term query 进行匹配) from: 0, # Integer | 起始值 count: 10 # Integer | 推荐的记录数 } begin #获取推荐的记录列表 result = api_instance.recommend_fetch(ident, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecommendApi->recommend_fetch: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecommendApi.new app = 'app_example' # String | 应用标识 begin #获取已定义的推荐列表 result = api_instance.recommend_list(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecommendApi->recommend_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecommendApi.new body = IndexeaClient::RecommendBean.new # RecommendBean | 推荐信息 app = 'app_example' # String | 应用标识 begin #更新推荐信息 result = api_instance.recommend_update(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecommendApi->recommend_update: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 _id = ['_id_example'] # Array | 主键字段值 begin #删除记录数据 result = api_instance.record_delete(app, index, _id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_delete: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 query = 56 # Integer | 查询编号 opts = { params: {'key' => 'params_example'} # Hash | 查询参数 } begin #批量删除记录数据(delete_by_query),该接口传递查询参数获取要删除的记录并逐一删除 result = api_instance.record_delete_by_query(app, index, query, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_delete_by_query: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 _id = '_id_example' # String | 记录 _id 值 begin #获取单条记录详情 result = api_instance.record_get(app, index, _id) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_get: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 opts = { body: IndexeaClient::RecordFilter.new, # RecordFilter | q: 'q_example', # String | 搜索关键字 field: 'field_example', # String | 搜索字段 from: 0, # Integer | 起始记录 size: 20, # Integer | 获取记录数 save_filter: false # BOOLEAN | 是否保存过滤器信息 } begin #获取索引记录列表 result = api_instance.record_list(app, index, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new body = nil # Array | app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 opts = { combine: false # BOOLEAN | 更新策略:合并还是替换,combine=true 为合并模式 } begin #插入或者更新索引数据 result = api_instance.record_push(body, app, index, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_push: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new body = nil # Object | 要更新的字段和对应的新字段值,只支持最基本类型 app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 query = 56 # Integer | 查询编号 opts = { params: {'key' => 'params_example'} # Hash | 查询参数 } begin #批量修改记录数据(update_by_query),该接口传递查询参数获取要更新的记录,并使用 body 中的对象进行记录合并更新 result = api_instance.record_update_by_query(body, app, index, query, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_update_by_query: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 opts = { files: ['files_example'], # Array | combine: false, # BOOLEAN | 更新策略:合并还是替换,combine=true 为合并模式 use_id_as_id_value: true # BOOLEAN | 使用数据中的 id 值作为记录 _id, 如果没有 id 字段则自动生成 } begin #上传记录 result = api_instance.record_upload(app, index, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_upload: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::RecordsApi.new app = 'app_example' # String | 应用标识 index = 56 # Integer | 索引编号 opts = { files: ['files_example'], # Array | combine: false, # BOOLEAN | 更新策略:合并还是替换,combine=true 为合并模式 use_id_as_id_value: true # BOOLEAN | 使用数据中的 id 值作为记录 _id, 如果没有 id 字段则自动生成 } begin #上传记录,该接口已经废弃,请使用 /records/{app}/{index}/batch 接口 result = api_instance.record_upload_0(app, index, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling RecordsApi->record_upload_0: #{e}" end api_instance = IndexeaClient::SearchApi.new widget = 'widget_example' # String | 组件唯一标识 action_id = 'action_id_example' # String | 对应搜索行为编号 doc_id = 'doc_id_example' # String | 对应索引中的内部记录编号 opts = { userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 x_token: 'x_token_example' # String | 如果要使用非发布的组件,需要组件作者授权 } begin #搜索结果点击行为收集 result = api_instance.search_click(widget, action_id, doc_id, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_click: #{e}" end api_instance = IndexeaClient::SearchApi.new widget = 'widget_example' # String | 组件唯一标识 strategy = 'popular' # String | 搜索记录策略 size = 10 # Integer | 数量 opts = { userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 x_token: 'x_token_example', # String | 如果要使用非公开的组件,需要组件作者授权 query: 0 # Integer | 指定关联查询的编号 } begin #获取当前搜索用户的最新搜索记录 result = api_instance.search_histories(widget, strategy, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_histories: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::SearchApi.new app = 'app_example' # String | 应用标识 opts = { indices: [56], # Array | 只看指定索引 scope: 'all', # String | 搜索范围 widget: 0, # Integer | 搜索组件 query: 0, # Integer | 指定查询 recomm: 0, # Integer | 推荐组件 start_date: Date.parse('2013-10-20'), # Date | 统计起始日期 end_date: Date.parse('2013-10-20'), # Date | 统计结束日期 from: 0, # Integer | 起始位置 size: 50 # Integer | 每页记录数量 } begin #获取搜索日志 result = api_instance.search_logs(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_logs: #{e}" end api_instance = IndexeaClient::SearchApi.new query = 'query_example' # String | 查询唯一标识 strategy = 'popular' # String | 搜索记录策略 size = 10 # Integer | 数量 opts = { userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 x_token: 'x_token_example' # String | 如果要使用非公开查询,需要组件作者授权 } begin #获取当前搜索用户的最新搜索记录 result = api_instance.search_query_histories(query, strategy, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_query_histories: #{e}" end api_instance = IndexeaClient::SearchApi.new query = 'query_example' # String | 查询标识 scope = 'all' # String | 时间范围 count = 10 # Integer | 获取热词数量 opts = { x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 userid: 'userid_example' # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 } begin #获取查询相关热词 result = api_instance.search_query_hot_words(query, scope, count, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_query_hot_words: #{e}" end api_instance = IndexeaClient::SearchApi.new query = 'query_example' # String | 查询标识 id = 'id_example' # String | scroll_id 值,该值的有效期是 1 分钟 opts = { x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 userid: 'userid_example' # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 } begin #读取滚动搜索结果 result = api_instance.search_query_repeat_scroll(query, id, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_query_repeat_scroll: #{e}" end api_instance = IndexeaClient::SearchApi.new query = 'query_example' # String | 查询标识 opts = { x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 size: 100, # Integer | 单次滚动的记录数 q: 'q_example', # String | 搜索关键字 params: {'key' => 'params_example'} # Hash | 聚合参数 } begin #基于查询的滚动搜索 result = api_instance.search_query_scroll(query, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_query_scroll: #{e}" end api_instance = IndexeaClient::SearchApi.new query = 'query_example' # String | 查询标识 from = 0 # Integer | 起始记录 size = 20 # Integer | 每页记录数量 opts = { x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 q: 'q_example', # String | 搜索关键字 params: {'key' => 'params_example'} # Hash | 聚合参数 } begin #基于查询的公开搜索 result = api_instance.search_query_search(query, from, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_query_search: #{e}" end api_instance = IndexeaClient::SearchApi.new widget = 'widget_example' # String | 组件唯一标识 q = 'q_example' # String | 搜索关键字 size = 10 # Integer | 数量 opts = { userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 query: 0 # Integer | 查询编号 } begin #基于组件的搜索词自动完成 result = api_instance.search_widget_auto_complete(widget, q, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_widget_auto_complete: #{e}" end api_instance = IndexeaClient::SearchApi.new widget = 'widget_example' # String | 组件唯一标识 opts = { x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 query: 56, # Integer | 查询编号 scope: 'scope_example', # String | 时间范围 count: 10 # Integer | 获取热词数量 } begin #获取组件搜索的相关热词 result = api_instance.search_widget_hot_words(widget, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_widget_hot_words: #{e}" end api_instance = IndexeaClient::SearchApi.new widget = 'widget_example' # String | 组件唯一标识 from = 0 # Integer | 起始记录 size = -1 # Integer | 每页记录数量, 如果值小于0则使用预设值的记录数 opts = { userid: 'userid_example', # String | 搜索者的唯一标识,该标识由搜索前端生成,长度不超过64 x_token: 'x_token_example', # String | 如果要使用非发布的组件,需要组件作者授权 original: 'original_example', # String | 搜索动作的延续,在 Web 组件中一边输入即时搜索时,使用的是同一个 original,original 值等于第一个搜索动作产生结果中的 action 值 query: 0, # Integer | 查询编号 q: 'q_example', # String | 搜索关键字 params: {'key' => 'params_example'} # Hash | 聚合参数 } begin #基于组件的公开搜索 result = api_instance.search_widget_search(widget, from, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling SearchApi->search_widget_search: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::StatsApi.new app = 'app_example' # String | 应用标识 opts = { recomm: 0, # Integer | 统计指定推荐 start_date: Date.parse('2013-10-20'), # Date | 统计起始日期 end_date: Date.parse('2013-10-20'), # Date | 统计结束日期 interval: 'date' # String | 统计间隔 - 日、周、月、季度、年 } begin #获取推荐日志的汇总信息 result = api_instance.stats_recomms(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling StatsApi->stats_recomms: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::StatsApi.new app = 'app_example' # String | 应用标识 opts = { index: 0, # Integer | 统计指定索引 query: 0, # Integer | 统计指定查询 widget: 0, # Integer | 统计指定组件 start_date: Date.parse('2013-10-20'), # Date | 统计起始日期 end_date: Date.parse('2013-10-20'), # Date | 统计结束日期 interval: 'date' # String | 统计间隔 - 日、周、月、季度、年 } begin #获取搜索日志的汇总信息 result = api_instance.stats_searchs(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling StatsApi->stats_searchs: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::StatsApi.new app = 'app_example' # String | 应用标识 size = 10 # Integer | 排行榜大小 opts = { index: 0, # Integer | 统计指定索引 query: 0, # Integer | 统计指定查询 recomm: 0, # Integer | 统计指定推荐组件 widget: 0, # Integer | 统计指定组件 start_date: Date.parse('2013-10-20'), # Date | 统计起始日期 end_date: Date.parse('2013-10-20') # Date | 统计结束日期 } begin #获取点击排行榜 result = api_instance.stats_top_clicks(app, size, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling StatsApi->stats_top_clicks: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::StatsApi.new app = 'app_example' # String | 应用标识 opts = { widget: 0, # Integer | 统计指定模板或组件 start_date: Date.parse('2013-10-20'), # Date | 统计起始日期 end_date: Date.parse('2013-10-20'), # Date | 统计结束日期 interval: 'date' # String | 统计间隔 - 日、周、月、季度、年 } begin #获取模板与组件的统计信息 result = api_instance.stats_widgets(app, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling StatsApi->stats_widgets: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new app = 'app_example' # String | 应用标识 widget = 56 # Integer | 源组件编号 begin #复制指定组件并创建新组件 result = api_instance.widget_copy(app, widget) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_copy: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new app = 'app_example' # String | 应用标识 widget = 56 # Integer | 源组件编号 to = 56 # Integer | 目标组件编号 begin #复制组件到已有组件 result = api_instance.widget_copy_to_widget(app, widget, to) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_copy_to_widget: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new body = IndexeaClient::WidgetForm.new # WidgetForm | app = 'app_example' # String | 应用标识 begin #创建组件 result = api_instance.widget_create(body, app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_create: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new app = 'app_example' # String | 应用标识 widget = 56 # Integer | 组件编号 opts = { password: 'password_example' # String | } begin #删除组件 result = api_instance.widget_delete(app, widget, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_delete: #{e}" end api_instance = IndexeaClient::WidgetsApi.new ident = 'ident_example' # String | UI组件的唯一标识 opts = { x_token: 'x_token_example' # String | 如果要使用非发布的组件,需要组件作者授权 } begin #获取UI组件的所有相关信息 result = api_instance.widget_detail(ident, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_detail: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new app = 'app_example' # String | 应用标识 widget = 56 # Integer | 组件编号 framework = 'framework_example' # String | 指定的技术框架 begin #下载组件应用源码 result = api_instance.widget_download(app, widget, framework) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_download: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new app = 'app_example' # String | 应用标识 widget = 56 # Integer | 组件编号 begin #获取组件的详情 result = api_instance.widget_get(app, widget) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_get: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new app = 'app_example' # String | 应用标识 begin #获取应用的组件列表 result = api_instance.widget_list(app) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_list: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new app = 'app_example' # String | 应用标识 widget = 56 # Integer | 组件编号 opts = { logo: 'logo_example' # String | } begin #设置组件 Logo result = api_instance.widget_logo(app, widget, opts) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_logo: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new body = IndexeaClient::WidgetForm.new # WidgetForm | app = 'app_example' # String | 应用标识 widget = 56 # Integer | 组件编号 begin #修改组件 result = api_instance.widget_update(body, app, widget) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_update: #{e}" end # Setup authorization IndexeaClient.configure do |config| end api_instance = IndexeaClient::WidgetsApi.new key = 'key_example' # String | type = 'type_example' # String | value = 'value_example' # String | vcode = 'vcode_example' # String | app = 'app_example' # String | 应用标识 widget = 56 # Integer | 组件编号 begin #修改组件设置参数 result = api_instance.widget_update_settings(key, type, value, vcode, app, widget) p result rescue IndexeaClient::ApiError => e puts "Exception when calling WidgetsApi->widget_update_settings: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *https://api.indexea.com/v1* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *IndexeaClient::AccountApi* | [**account_bulletin**](docs/AccountApi.md#account_bulletin) | **GET** /accounts/bulletin | 获取系统公告 *IndexeaClient::AccountApi* | [**account_delete**](docs/AccountApi.md#account_delete) | **DELETE** /account/profile | 注销账号 *IndexeaClient::AccountApi* | [**account_delete_openid**](docs/AccountApi.md#account_delete_openid) | **DELETE** /account/openid | 解绑三方账号 *IndexeaClient::AccountApi* | [**account_openid**](docs/AccountApi.md#account_openid) | **GET** /account/openid | 获取绑定的所有三方账号 *IndexeaClient::AccountApi* | [**account_passwd**](docs/AccountApi.md#account_passwd) | **POST** /account/passwd | 修改账号密码 *IndexeaClient::AccountApi* | [**account_portrait**](docs/AccountApi.md#account_portrait) | **POST** /account/portrait | 修改账号头像 *IndexeaClient::AccountApi* | [**account_profile**](docs/AccountApi.md#account_profile) | **GET** /account/profile | 获取登录账号信息 *IndexeaClient::AccountApi* | [**account_reset_pwd**](docs/AccountApi.md#account_reset_pwd) | **POST** /account/reset-pwd | 重置账号密码 *IndexeaClient::AccountApi* | [**account_send_verify_code**](docs/AccountApi.md#account_send_verify_code) | **GET** /account/send-verify-code | 发送账号验证码 *IndexeaClient::AccountApi* | [**account_signin**](docs/AccountApi.md#account_signin) | **POST** /account/signin | 登录系统 *IndexeaClient::AccountApi* | [**account_signout**](docs/AccountApi.md#account_signout) | **POST** /account/sign-out | 退出登录状态 *IndexeaClient::AccountApi* | [**account_signup**](docs/AccountApi.md#account_signup) | **POST** /account/signup | 注册新账号 *IndexeaClient::AccountApi* | [**account_update**](docs/AccountApi.md#account_update) | **POST** /account/profile | 修改账号资料 *IndexeaClient::AccountApi* | [**account_update_settings**](docs/AccountApi.md#account_update_settings) | **POST** /account/settings | 修改账号设置 *IndexeaClient::AppsApi* | [**app_add_mentor**](docs/AppsApi.md#app_add_mentor) | **POST** /apps/{app}/mentors | 添加应用成员 *IndexeaClient::AppsApi* | [**app_blacklist**](docs/AppsApi.md#app_blacklist) | **GET** /apps/{app}/blacklist | 获取黑名单信息 *IndexeaClient::AppsApi* | [**app_create**](docs/AppsApi.md#app_create) | **POST** /apps | 创建应用 *IndexeaClient::AppsApi* | [**app_create_access_token**](docs/AppsApi.md#app_create_access_token) | **POST** /apps/{app}/tokens | 创建 Access Token *IndexeaClient::AppsApi* | [**app_create_oauth_app**](docs/AppsApi.md#app_create_oauth_app) | **POST** /apps/{app}/oauth | 创建第三方应用 *IndexeaClient::AppsApi* | [**app_delete**](docs/AppsApi.md#app_delete) | **DELETE** /apps/{app} | 删除应用 *IndexeaClient::AppsApi* | [**app_delete_access_token**](docs/AppsApi.md#app_delete_access_token) | **DELETE** /apps/{app}/tokens | 删除 Access Token *IndexeaClient::AppsApi* | [**app_delete_mentor**](docs/AppsApi.md#app_delete_mentor) | **DELETE** /apps/{app}/mentors | 删除应用成员 *IndexeaClient::AppsApi* | [**app_delete_oauth_app**](docs/AppsApi.md#app_delete_oauth_app) | **DELETE** /apps/{app}/oauth | 删除第三方应用 *IndexeaClient::AppsApi* | [**app_excel_of_logs**](docs/AppsApi.md#app_excel_of_logs) | **GET** /apps/{app}/logs | 导出应用日志到 Excel *IndexeaClient::AppsApi* | [**app_get**](docs/AppsApi.md#app_get) | **GET** /apps/{app} | 获取应用详情 *IndexeaClient::AppsApi* | [**app_get_company**](docs/AppsApi.md#app_get_company) | **POST** /apps/{app}/company | 获取应用填写的公司信息 *IndexeaClient::AppsApi* | [**app_get_company_pic**](docs/AppsApi.md#app_get_company_pic) | **GET** /apps/{app}/company | 获取公司营业执照或者一般纳税人证明 *IndexeaClient::AppsApi* | [**app_list**](docs/AppsApi.md#app_list) | **GET** /apps | 获取应用列表 *IndexeaClient::AppsApi* | [**app_list_mentors**](docs/AppsApi.md#app_list_mentors) | **GET** /apps/{app}/mentors | 获取应用成员列表 *IndexeaClient::AppsApi* | [**app_list_oauth_apps**](docs/AppsApi.md#app_list_oauth_apps) | **GET** /apps/{app}/oauth | 获取第三方应用列表 *IndexeaClient::AppsApi* | [**app_logs**](docs/AppsApi.md#app_logs) | **POST** /apps/{app}/logs | 获取应用的日志列表 *IndexeaClient::AppsApi* | [**app_reset_access_token**](docs/AppsApi.md#app_reset_access_token) | **PATCH** /apps/{app}/tokens | 重置 Access Token *IndexeaClient::AppsApi* | [**app_reset_oauth_app_secret**](docs/AppsApi.md#app_reset_oauth_app_secret) | **POST** /apps/{app}/oauth-reset-secret | 重新生成三方应用的密钥 *IndexeaClient::AppsApi* | [**app_save_blacklist**](docs/AppsApi.md#app_save_blacklist) | **PUT** /apps/{app}/blacklist | 修改应用的黑名单信息 *IndexeaClient::AppsApi* | [**app_save_company**](docs/AppsApi.md#app_save_company) | **PUT** /apps/{app}/company | 修改应用的公司信息 *IndexeaClient::AppsApi* | [**app_searchs_estimate**](docs/AppsApi.md#app_searchs_estimate) | **GET** /apps/{app}/searchs-estimate | 获取搜索流量包使用配额信息 *IndexeaClient::AppsApi* | [**app_set_trigger**](docs/AppsApi.md#app_set_trigger) | **PUT** /apps/{app}/trigger | 修改应用的触发器信息 *IndexeaClient::AppsApi* | [**app_tokens**](docs/AppsApi.md#app_tokens) | **GET** /apps/{app}/tokens | 获取 Access Token 列表 *IndexeaClient::AppsApi* | [**app_transfer**](docs/AppsApi.md#app_transfer) | **POST** /apps/{app}/transfer | 转让应用给他人 *IndexeaClient::AppsApi* | [**app_trigger**](docs/AppsApi.md#app_trigger) | **GET** /apps/{app}/trigger | 获取应用触发器详情 *IndexeaClient::AppsApi* | [**app_trigger_logs**](docs/AppsApi.md#app_trigger_logs) | **GET** /apps/{app}/trigger-logs | 获取应用触发日志列表 *IndexeaClient::AppsApi* | [**app_update**](docs/AppsApi.md#app_update) | **PUT** /apps/{app} | 修改应用的基本信息 *IndexeaClient::AppsApi* | [**app_update_access_token**](docs/AppsApi.md#app_update_access_token) | **PUT** /apps/{app}/tokens | 修改 Access Token *IndexeaClient::AppsApi* | [**app_update_mentor**](docs/AppsApi.md#app_update_mentor) | **PATCH** /apps/{app}/mentors | 修改成员备注和权限 *IndexeaClient::AppsApi* | [**app_update_mentor_options**](docs/AppsApi.md#app_update_mentor_options) | **POST** /apps/{app}/mentors-options | 修改应用成员自身的设置(包括应用名备注,是否接收报告等) *IndexeaClient::AppsApi* | [**app_update_mentor_report_options**](docs/AppsApi.md#app_update_mentor_report_options) | **PATCH** /apps/{app}/mentors-options | 修改应用成员自身的通知设置 *IndexeaClient::AppsApi* | [**app_update_oauth_app**](docs/AppsApi.md#app_update_oauth_app) | **PATCH** /apps/{app}/oauth | 修改第三方应用信息 *IndexeaClient::AppsApi* | [**app_update_oauth_app_logo**](docs/AppsApi.md#app_update_oauth_app_logo) | **PUT** /apps/{app}/oauth | 修改三方应用图标 *IndexeaClient::AppsApi* | [**app_update_status**](docs/AppsApi.md#app_update_status) | **PATCH** /apps/{app} | 修改应用的状态 *IndexeaClient::FieldsApi* | [**index_fields**](docs/FieldsApi.md#index_fields) | **GET** /indices/{app}/{index}/fields | 获取索引字段映射详情 *IndexeaClient::FieldsApi* | [**index_update_fields**](docs/FieldsApi.md#index_update_fields) | **POST** /indices/{app}/{index}/fields | 更新索引的字段映射 *IndexeaClient::FieldsApi* | [**index_update_html_strip_fields**](docs/FieldsApi.md#index_update_html_strip_fields) | **PATCH** /indices/{app}/{index}/fields | 更新索引的HTML过滤字段列表 *IndexeaClient::FieldsApi* | [**index_values_of_field**](docs/FieldsApi.md#index_values_of_field) | **GET** /indices/{app}/{index}/fields/{field} | 获取索引字段的所有值列表 *IndexeaClient::GlobalApi* | [**json**](docs/GlobalApi.md#json) | **GET** /json | 接口定义(JSON) *IndexeaClient::GlobalApi* | [**options_get**](docs/GlobalApi.md#options_get) | **GET** /options | 系统全局配置接口 *IndexeaClient::GlobalApi* | [**status_database**](docs/GlobalApi.md#status_database) | **GET** /status/database | 数据库服务状态测试 *IndexeaClient::GlobalApi* | [**status_engine**](docs/GlobalApi.md#status_engine) | **GET** /status/engine | 搜索引擎状态测试 *IndexeaClient::GlobalApi* | [**welcome**](docs/GlobalApi.md#welcome) | **GET** / | 接口欢迎信息 *IndexeaClient::GlobalApi* | [**yaml**](docs/GlobalApi.md#yaml) | **GET** /yaml | 接口定义(YAML) *IndexeaClient::IndicesApi* | [**index_cleanup**](docs/IndicesApi.md#index_cleanup) | **POST** /indices/{app}/{index}/cleanup | 清空索引记录 *IndexeaClient::IndicesApi* | [**index_copy_to**](docs/IndicesApi.md#index_copy_to) | **POST** /indices/{app}/{index}/copyto | 导出索引数据 *IndexeaClient::IndicesApi* | [**index_create**](docs/IndicesApi.md#index_create) | **POST** /indices/{app} | 创建索引 *IndexeaClient::IndicesApi* | [**index_create_template**](docs/IndicesApi.md#index_create_template) | **POST** /indices/templates | 创建索引模板 *IndexeaClient::IndicesApi* | [**index_delete**](docs/IndicesApi.md#index_delete) | **DELETE** /indices/{app}/{index} | 删除索引 *IndexeaClient::IndicesApi* | [**index_delete_crawler_task**](docs/IndicesApi.md#index_delete_crawler_task) | **DELETE** /indices/{app}/{index}/crawler-settings | 删除索引的数据爬取任务 *IndexeaClient::IndicesApi* | [**index_delete_template**](docs/IndicesApi.md#index_delete_template) | **DELETE** /indices/templates | 删除索引模板 *IndexeaClient::IndicesApi* | [**index_export**](docs/IndicesApi.md#index_export) | **POST** /indices/{app}/{index}/export | 导出索引数据 *IndexeaClient::IndicesApi* | [**index_flush**](docs/IndicesApi.md#index_flush) | **POST** /indices/{app}/{index}/flush | 刷新索引数据,主要用于将内存中的索引数据写入磁盘 *IndexeaClient::IndicesApi* | [**index_flush_settings**](docs/IndicesApi.md#index_flush_settings) | **PUT** /indices/{app}/{index}/settings | 写入设置信息到索引 *IndexeaClient::IndicesApi* | [**index_get**](docs/IndicesApi.md#index_get) | **GET** /indices/{app}/{index} | 获取单个索引详情 *IndexeaClient::IndicesApi* | [**index_get_crawler_logs**](docs/IndicesApi.md#index_get_crawler_logs) | **GET** /indices/{app}/{index}/crawler-logs | 获取索引的爬虫任务的爬取日志 *IndexeaClient::IndicesApi* | [**index_get_crawler_task**](docs/IndicesApi.md#index_get_crawler_task) | **GET** /indices/{app}/{index}/crawler-settings | 获取索引的爬虫任务设定 *IndexeaClient::IndicesApi* | [**index_get_filter_settings**](docs/IndicesApi.md#index_get_filter_settings) | **GET** /indices/{app}/{index}/filter-settings | 获取索引设置信息 *IndexeaClient::IndicesApi* | [**index_get_settings**](docs/IndicesApi.md#index_get_settings) | **GET** /indices/{app}/{index}/settings | 获取索引设置信息 *IndexeaClient::IndicesApi* | [**index_list**](docs/IndicesApi.md#index_list) | **GET** /indices/{app} | 获取应用的索引列表 *IndexeaClient::IndicesApi* | [**index_list_templates**](docs/IndicesApi.md#index_list_templates) | **GET** /indices/templates | 获取所有可用的索引模板 *IndexeaClient::IndicesApi* | [**index_prefetch**](docs/IndicesApi.md#index_prefetch) | **GET** /indices/crawler | 获取目标网站内容预览 *IndexeaClient::IndicesApi* | [**index_rebuild**](docs/IndicesApi.md#index_rebuild) | **POST** /indices/{app}/{index}/rebuild | 重建索引数据 *IndexeaClient::IndicesApi* | [**index_rebuild_task**](docs/IndicesApi.md#index_rebuild_task) | **GET** /indices/{app}/{index}/rebuild | 获取重建索引任务的详情 *IndexeaClient::IndicesApi* | [**index_submit_crawler_task**](docs/IndicesApi.md#index_submit_crawler_task) | **POST** /indices/{app}/{index}/crawler-settings | 提交或者更新索引的数据爬取任务 *IndexeaClient::IndicesApi* | [**index_update**](docs/IndicesApi.md#index_update) | **PUT** /indices/{app}/{index} | 修改索引 *IndexeaClient::IndicesApi* | [**index_update_settings**](docs/IndicesApi.md#index_update_settings) | **POST** /indices/{app}/{index}/settings | 更新索引设置信息 *IndexeaClient::IndicesApi* | [**index_update_template**](docs/IndicesApi.md#index_update_template) | **PUT** /indices/templates | 修改索引模板 *IndexeaClient::IndicesApi* | [**synonyms_add**](docs/IndicesApi.md#synonyms_add) | **POST** /indices/{app}/{index}/synonyms | 添加同义词 *IndexeaClient::IndicesApi* | [**synonyms_delete**](docs/IndicesApi.md#synonyms_delete) | **DELETE** /indices/{app}/{index}/synonyms | 删除同义词 *IndexeaClient::IndicesApi* | [**synonyms_enable**](docs/IndicesApi.md#synonyms_enable) | **PATCH** /indices/{app}/{index}/synonyms | 启用禁用同义词 *IndexeaClient::IndicesApi* | [**synonyms_flush**](docs/IndicesApi.md#synonyms_flush) | **POST** /indices/{app}/{index}/synonyms-flush | 将同义词更新到搜索引擎的同义词表 *IndexeaClient::IndicesApi* | [**synonyms_import**](docs/IndicesApi.md#synonyms_import) | **POST** /indices/{app}/{index}/synonyms-import | 导入同义词 *IndexeaClient::IndicesApi* | [**synonyms_list**](docs/IndicesApi.md#synonyms_list) | **GET** /indices/{app}/{index}/synonyms | 获取索引的所有同义词 *IndexeaClient::IndicesApi* | [**synonyms_update**](docs/IndicesApi.md#synonyms_update) | **PUT** /indices/{app}/{index}/synonyms | 修改同义词 *IndexeaClient::MessageApi* | [**message_delete**](docs/MessageApi.md#message_delete) | **DELETE** /accounts/message | 删除消息 *IndexeaClient::MessageApi* | [**message_feedback**](docs/MessageApi.md#message_feedback) | **POST** /accounts/feedback | 反馈意见 *IndexeaClient::MessageApi* | [**message_list**](docs/MessageApi.md#message_list) | **GET** /accounts/message | 获取我相关的消息信息,包括未读消息数量、最新消息等 *IndexeaClient::MessageApi* | [**message_read**](docs/MessageApi.md#message_read) | **PATCH** /accounts/message | 标识消息为已读 *IndexeaClient::MessageApi* | [**message_send**](docs/MessageApi.md#message_send) | **POST** /accounts/message | 发送消息 *IndexeaClient::PaymentApi* | [**payment_alipay**](docs/PaymentApi.md#payment_alipay) | **POST** /payment/alipay | 接受支付宝的支付结果 *IndexeaClient::PaymentApi* | [**payment_alipay_return**](docs/PaymentApi.md#payment_alipay_return) | **GET** /payment/alipay | 支付宝平台支付完毕后调整到该接口 *IndexeaClient::PaymentApi* | [**payment_apply_invoice**](docs/PaymentApi.md#payment_apply_invoice) | **POST** /payment/{app}/invoices | 申请发票 *IndexeaClient::PaymentApi* | [**payment_begin_pay**](docs/PaymentApi.md#payment_begin_pay) | **POST** /payment/{app}/orders/{ident} | 支付订单 *IndexeaClient::PaymentApi* | [**payment_buy**](docs/PaymentApi.md#payment_buy) | **PUT** /payment/{app}/orders | 下单购买 *IndexeaClient::PaymentApi* | [**payment_delete_invoice**](docs/PaymentApi.md#payment_delete_invoice) | **DELETE** /payment/{app}/invoices | 删除发票 *IndexeaClient::PaymentApi* | [**payment_delete_order**](docs/PaymentApi.md#payment_delete_order) | **DELETE** /payment/{app}/orders/{ident} | 取消订单 *IndexeaClient::PaymentApi* | [**payment_invoices**](docs/PaymentApi.md#payment_invoices) | **GET** /payment/{app}/invoices | 获取发票列表 *IndexeaClient::PaymentApi* | [**payment_order**](docs/PaymentApi.md#payment_order) | **GET** /payment/{app}/orders/{ident} | 获取订单详情 *IndexeaClient::PaymentApi* | [**payment_orders**](docs/PaymentApi.md#payment_orders) | **POST** /payment/{app}/orders | 订单列表 *IndexeaClient::PaymentApi* | [**payment_orders_without_invoice**](docs/PaymentApi.md#payment_orders_without_invoice) | **GET** /payment/{app}/orders_without_invoice | 获取未曾开票的订单列表 *IndexeaClient::PaymentApi* | [**payment_price**](docs/PaymentApi.md#payment_price) | **GET** /payment/{app}/price | 获取套餐价格 *IndexeaClient::PaymentApi* | [**payment_receipt**](docs/PaymentApi.md#payment_receipt) | **GET** /payment/{app}/orders | 获取订单回执图片 *IndexeaClient::PaymentApi* | [**payment_request_contact**](docs/PaymentApi.md#payment_request_contact) | **POST** /payment/{app}/contact | 联系销售获取私有化报价 *IndexeaClient::PaymentApi* | [**payment_upload_receipt**](docs/PaymentApi.md#payment_upload_receipt) | **PUT** /payment/{app}/orders/{ident} | 上传转账回执 *IndexeaClient::PaymentApi* | [**payment_wepay**](docs/PaymentApi.md#payment_wepay) | **POST** /payment/wepay | 接受微信支付的支付结果 *IndexeaClient::QueriesApi* | [**query_analyze**](docs/QueriesApi.md#query_analyze) | **POST** /queries/{app}/analyze | 分词测试 *IndexeaClient::QueriesApi* | [**query_copy**](docs/QueriesApi.md#query_copy) | **POST** /queries/{app}/copy | 复制指定查询并创建新查询 *IndexeaClient::QueriesApi* | [**query_copy_to_query**](docs/QueriesApi.md#query_copy_to_query) | **PUT** /queries/{app}/copy | 复制查询到已有查询 *IndexeaClient::QueriesApi* | [**query_create**](docs/QueriesApi.md#query_create) | **POST** /queries/{app} | 创建搜索 *IndexeaClient::QueriesApi* | [**query_create_keyword_bindings**](docs/QueriesApi.md#query_create_keyword_bindings) | **POST** /queries/{app}/keyword-bindings | 创建新的关键词文档绑定 *IndexeaClient::QueriesApi* | [**query_create_variable**](docs/QueriesApi.md#query_create_variable) | **POST** /queries/{app}/variables | 创建新的预定义查询变量 *IndexeaClient::QueriesApi* | [**query_delete**](docs/QueriesApi.md#query_delete) | **DELETE** /queries/{app} | 删除搜索 *IndexeaClient::QueriesApi* | [**query_delete_keyword_bindings**](docs/QueriesApi.md#query_delete_keyword_bindings) | **DELETE** /queries/{app}/keyword-bindings | 删除关键词文档绑定 *IndexeaClient::QueriesApi* | [**query_delete_node_positions**](docs/QueriesApi.md#query_delete_node_positions) | **DELETE** /queries/{app}/node-positions | 清除查询条件的节点位置信息 *IndexeaClient::QueriesApi* | [**query_delete_variable**](docs/QueriesApi.md#query_delete_variable) | **DELETE** /queries/{app}/variables | 删除预定义查询变量 *IndexeaClient::QueriesApi* | [**query_fields**](docs/QueriesApi.md#query_fields) | **GET** /queries/{app}/fields | 获取查询关联的所有索引的字段信息 *IndexeaClient::QueriesApi* | [**query_get**](docs/QueriesApi.md#query_get) | **GET** /queries/{app}/{query} | 获取查询的详情 *IndexeaClient::QueriesApi* | [**query_get_node_positions**](docs/QueriesApi.md#query_get_node_positions) | **GET** /queries/{app}/node-positions | 获取查询条件的节点位置信息 *IndexeaClient::QueriesApi* | [**query_get_record**](docs/QueriesApi.md#query_get_record) | **GET** /queries/{app}/record | 获取记录的详情 *IndexeaClient::QueriesApi* | [**query_keyword_bindings**](docs/QueriesApi.md#query_keyword_bindings) | **GET** /queries/{app}/keyword-bindings | 获取查询的关键词文档绑定列表 *IndexeaClient::QueriesApi* | [**query_list**](docs/QueriesApi.md#query_list) | **GET** /queries/{app} | 获取应用下所有索引下的查询列表(按索引进行分组) *IndexeaClient::QueriesApi* | [**query_profile**](docs/QueriesApi.md#query_profile) | **GET** /queries/{app}/profiler | 获取搜索诊断信息 *IndexeaClient::QueriesApi* | [**query_records_of_keyword_binding**](docs/QueriesApi.md#query_records_of_keyword_binding) | **GET** /queries/{app}/keyword-bindings-records | 获取关键词绑定对应的记录列表 *IndexeaClient::QueriesApi* | [**query_save_intelligent_mappings**](docs/QueriesApi.md#query_save_intelligent_mappings) | **PUT** /queries/{app}/intelligent-mappings | 设置索引智能匹配字段 *IndexeaClient::QueriesApi* | [**query_save_node_positions**](docs/QueriesApi.md#query_save_node_positions) | **PUT** /queries/{app}/node-positions | 保存查询条件的节点位置信息 *IndexeaClient::QueriesApi* | [**query_search**](docs/QueriesApi.md#query_search) | **GET** /queries/{app}/search | 搜索测试 *IndexeaClient::QueriesApi* | [**query_source**](docs/QueriesApi.md#query_source) | **POST** /queries/{app}/{query} | 获取最终查询的源码(JSON) *IndexeaClient::QueriesApi* | [**query_suggest**](docs/QueriesApi.md#query_suggest) | **GET** /queries/{app}/suggest | 获取搜索建议列表 *IndexeaClient::QueriesApi* | [**query_test_intelligent_mappings**](docs/QueriesApi.md#query_test_intelligent_mappings) | **POST** /queries/{app}/intelligent-mappings | 测试索引智能匹配字段 *IndexeaClient::QueriesApi* | [**query_update**](docs/QueriesApi.md#query_update) | **PUT** /queries/{app} | 修改查询 *IndexeaClient::QueriesApi* | [**query_update_keyword_bindings**](docs/QueriesApi.md#query_update_keyword_bindings) | **PATCH** /queries/{app}/keyword-bindings | 修改关键词文档绑定 *IndexeaClient::QueriesApi* | [**query_update_settings**](docs/QueriesApi.md#query_update_settings) | **POST** /queries/{app}/settings | 更改查询的设置项 *IndexeaClient::QueriesApi* | [**query_update_variable**](docs/QueriesApi.md#query_update_variable) | **PATCH** /queries/{app}/variables | 修改预定义查询变量 *IndexeaClient::QueriesApi* | [**query_validate**](docs/QueriesApi.md#query_validate) | **GET** /queries/{app}/validate | 获取搜索验证结果 *IndexeaClient::QueriesApi* | [**query_validate_aggregation**](docs/QueriesApi.md#query_validate_aggregation) | **POST** /queries/{app}/validate-aggregation | 验证聚合定义是否正确 *IndexeaClient::QueriesApi* | [**query_validate_query**](docs/QueriesApi.md#query_validate_query) | **POST** /queries/{app}/validate-query | 验证聚合定义是否正确 *IndexeaClient::QueriesApi* | [**query_validate_script_field**](docs/QueriesApi.md#query_validate_script_field) | **POST** /queries/{app}/validate-script-field | 验证脚本字段是否正确 *IndexeaClient::QueriesApi* | [**query_validate_script_score**](docs/QueriesApi.md#query_validate_script_score) | **POST** /queries/{app}/validate-script-score | 验证脚本字段是否正确 *IndexeaClient::QueriesApi* | [**query_validate_suggestion**](docs/QueriesApi.md#query_validate_suggestion) | **POST** /queries/{app}/validate-suggest | 验证建议是否正确 *IndexeaClient::QueriesApi* | [**query_variables**](docs/QueriesApi.md#query_variables) | **GET** /queries/{app}/variables | 获取应用的预定义查询变量列表 *IndexeaClient::RecommendApi* | [**recommend_click**](docs/RecommendApi.md#recommend_click) | **POST** /recommend/{ident}/click | 推荐结果点击行为收集 *IndexeaClient::RecommendApi* | [**recommend_create**](docs/RecommendApi.md#recommend_create) | **POST** /recommends/{app} | 创建新的推荐 *IndexeaClient::RecommendApi* | [**recommend_delete**](docs/RecommendApi.md#recommend_delete) | **DELETE** /recommends/{app} | 删除推荐 *IndexeaClient::RecommendApi* | [**recommend_detail**](docs/RecommendApi.md#recommend_detail) | **GET** /recommend/{ident} | 获取推荐的记录列表 *IndexeaClient::RecommendApi* | [**recommend_fetch**](docs/RecommendApi.md#recommend_fetch) | **POST** /recommend/{ident} | 获取推荐的记录列表 *IndexeaClient::RecommendApi* | [**recommend_list**](docs/RecommendApi.md#recommend_list) | **GET** /recommends/{app} | 获取已定义的推荐列表 *IndexeaClient::RecommendApi* | [**recommend_update**](docs/RecommendApi.md#recommend_update) | **PUT** /recommends/{app} | 更新推荐信息 *IndexeaClient::RecordsApi* | [**record_delete**](docs/RecordsApi.md#record_delete) | **DELETE** /records/{app}/{index} | 删除记录数据 *IndexeaClient::RecordsApi* | [**record_delete_by_query**](docs/RecordsApi.md#record_delete_by_query) | **DELETE** /records/{app}/{index}/bulk | 批量删除记录数据(delete_by_query),该接口传递查询参数获取要删除的记录并逐一删除 *IndexeaClient::RecordsApi* | [**record_get**](docs/RecordsApi.md#record_get) | **GET** /records/{app}/{index} | 获取单条记录详情 *IndexeaClient::RecordsApi* | [**record_list**](docs/RecordsApi.md#record_list) | **POST** /records/{app}/{index} | 获取索引记录列表 *IndexeaClient::RecordsApi* | [**record_push**](docs/RecordsApi.md#record_push) | **PUT** /records/{app}/{index} | 插入或者更新索引数据 *IndexeaClient::RecordsApi* | [**record_update_by_query**](docs/RecordsApi.md#record_update_by_query) | **PATCH** /records/{app}/{index}/bulk | 批量修改记录数据(update_by_query),该接口传递查询参数获取要更新的记录,并使用 body 中的对象进行记录合并更新 *IndexeaClient::RecordsApi* | [**record_upload**](docs/RecordsApi.md#record_upload) | **POST** /records/{app}/{index}/bulk | 上传记录 *IndexeaClient::RecordsApi* | [**record_upload_0**](docs/RecordsApi.md#record_upload_0) | **POST** /records/{app}/{index}/upload | 上传记录,该接口已经废弃,请使用 /records/{app}/{index}/batch 接口 *IndexeaClient::SearchApi* | [**search_click**](docs/SearchApi.md#search_click) | **POST** /search/widget/{widget}/click | 搜索结果点击行为收集 *IndexeaClient::SearchApi* | [**search_histories**](docs/SearchApi.md#search_histories) | **GET** /search/widget/{widget}/histories | 获取当前搜索用户的最新搜索记录 *IndexeaClient::SearchApi* | [**search_logs**](docs/SearchApi.md#search_logs) | **GET** /apps/{app}/logs-searchs | 获取搜索日志 *IndexeaClient::SearchApi* | [**search_query_histories**](docs/SearchApi.md#search_query_histories) | **GET** /search/query/{query}/histories | 获取当前搜索用户的最新搜索记录 *IndexeaClient::SearchApi* | [**search_query_hot_words**](docs/SearchApi.md#search_query_hot_words) | **GET** /search/query/{query}/hotwords | 获取查询相关热词 *IndexeaClient::SearchApi* | [**search_query_repeat_scroll**](docs/SearchApi.md#search_query_repeat_scroll) | **POST** /search/scroll/{query} | 读取滚动搜索结果 *IndexeaClient::SearchApi* | [**search_query_scroll**](docs/SearchApi.md#search_query_scroll) | **GET** /search/scroll/{query} | 基于查询的滚动搜索 *IndexeaClient::SearchApi* | [**search_query_search**](docs/SearchApi.md#search_query_search) | **GET** /search/query/{query} | 基于查询的公开搜索 *IndexeaClient::SearchApi* | [**search_widget_auto_complete**](docs/SearchApi.md#search_widget_auto_complete) | **GET** /search/widget/{widget}/autocomplete | 基于组件的搜索词自动完成 *IndexeaClient::SearchApi* | [**search_widget_hot_words**](docs/SearchApi.md#search_widget_hot_words) | **GET** /search/widget/{widget}/hotwords | 获取组件搜索的相关热词 *IndexeaClient::SearchApi* | [**search_widget_search**](docs/SearchApi.md#search_widget_search) | **GET** /search/widget/{widget} | 基于组件的公开搜索 *IndexeaClient::StatsApi* | [**stats_recomms**](docs/StatsApi.md#stats_recomms) | **GET** /stats/{app}/recomms | 获取推荐日志的汇总信息 *IndexeaClient::StatsApi* | [**stats_searchs**](docs/StatsApi.md#stats_searchs) | **GET** /stats/{app}/searchs | 获取搜索日志的汇总信息 *IndexeaClient::StatsApi* | [**stats_top_clicks**](docs/StatsApi.md#stats_top_clicks) | **GET** /stats/{app}/top-clicks | 获取点击排行榜 *IndexeaClient::StatsApi* | [**stats_widgets**](docs/StatsApi.md#stats_widgets) | **GET** /stats/{app}/widgets | 获取模板与组件的统计信息 *IndexeaClient::WidgetsApi* | [**widget_copy**](docs/WidgetsApi.md#widget_copy) | **POST** /widget/{app}/copy | 复制指定组件并创建新组件 *IndexeaClient::WidgetsApi* | [**widget_copy_to_widget**](docs/WidgetsApi.md#widget_copy_to_widget) | **PUT** /widget/{app}/copy | 复制组件到已有组件 *IndexeaClient::WidgetsApi* | [**widget_create**](docs/WidgetsApi.md#widget_create) | **POST** /widgets/{app} | 创建组件 *IndexeaClient::WidgetsApi* | [**widget_delete**](docs/WidgetsApi.md#widget_delete) | **DELETE** /widgets/{app}/{widget} | 删除组件 *IndexeaClient::WidgetsApi* | [**widget_detail**](docs/WidgetsApi.md#widget_detail) | **GET** /widget/{ident} | 获取UI组件的所有相关信息 *IndexeaClient::WidgetsApi* | [**widget_download**](docs/WidgetsApi.md#widget_download) | **GET** /widgets/{app}/{widget}/download | 下载组件应用源码 *IndexeaClient::WidgetsApi* | [**widget_get**](docs/WidgetsApi.md#widget_get) | **GET** /widgets/{app}/{widget} | 获取组件的详情 *IndexeaClient::WidgetsApi* | [**widget_list**](docs/WidgetsApi.md#widget_list) | **GET** /widgets/{app} | 获取应用的组件列表 *IndexeaClient::WidgetsApi* | [**widget_logo**](docs/WidgetsApi.md#widget_logo) | **POST** /widgets/{app}/{widget}/logo | 设置组件 Logo *IndexeaClient::WidgetsApi* | [**widget_update**](docs/WidgetsApi.md#widget_update) | **PUT** /widgets/{app}/{widget} | 修改组件 *IndexeaClient::WidgetsApi* | [**widget_update_settings**](docs/WidgetsApi.md#widget_update_settings) | **PATCH** /widgets/{app}/{widget} | 修改组件设置参数 ## Documentation for Models - [IndexeaClient::AccountBean](docs/AccountBean.md) - [IndexeaClient::AccountPasswdBody](docs/AccountPasswdBody.md) - [IndexeaClient::AccountPortraitBody](docs/AccountPortraitBody.md) - [IndexeaClient::AccountProfileBody](docs/AccountProfileBody.md) - [IndexeaClient::AccountResetpwdBody](docs/AccountResetpwdBody.md) - [IndexeaClient::AccountSigninBody](docs/AccountSigninBody.md) - [IndexeaClient::AccountSignupBody](docs/AccountSignupBody.md) - [IndexeaClient::AccountsFeedbackBody](docs/AccountsFeedbackBody.md) - [IndexeaClient::AccountsMessageBody](docs/AccountsMessageBody.md) - [IndexeaClient::AnalyzeObject](docs/AnalyzeObject.md) - [IndexeaClient::AnalyzeToken](docs/AnalyzeToken.md) - [IndexeaClient::AppBean](docs/AppBean.md) - [IndexeaClient::AppCompanyBody](docs/AppCompanyBody.md) - [IndexeaClient::AppIndexBody](docs/AppIndexBody.md) - [IndexeaClient::AppLogAccount](docs/AppLogAccount.md) - [IndexeaClient::AppLogBean](docs/AppLogBean.md) - [IndexeaClient::AppLogsBean](docs/AppLogsBean.md) - [IndexeaClient::AppMentorBean](docs/AppMentorBean.md) - [IndexeaClient::AppOauthBody](docs/AppOauthBody.md) - [IndexeaClient::AppOauthBody1](docs/AppOauthBody1.md) - [IndexeaClient::AppOauthresetsecretBody](docs/AppOauthresetsecretBody.md) - [IndexeaClient::AppTokensBody](docs/AppTokensBody.md) - [IndexeaClient::AppTokensBody1](docs/AppTokensBody1.md) - [IndexeaClient::AppWidgetBody](docs/AppWidgetBody.md) - [IndexeaClient::AppsAppBody](docs/AppsAppBody.md) - [IndexeaClient::AppsBody](docs/AppsBody.md) - [IndexeaClient::AutoCompleteItem](docs/AutoCompleteItem.md) - [IndexeaClient::BlacklistBean](docs/BlacklistBean.md) - [IndexeaClient::Bulletin](docs/Bulletin.md) - [IndexeaClient::CompanyBean](docs/CompanyBean.md) - [IndexeaClient::ContactForm](docs/ContactForm.md) - [IndexeaClient::CrawlerLog](docs/CrawlerLog.md) - [IndexeaClient::CrawlerLogs](docs/CrawlerLogs.md) - [IndexeaClient::CrawlerTask](docs/CrawlerTask.md) - [IndexeaClient::GlobalOptionForm](docs/GlobalOptionForm.md) - [IndexeaClient::IndexBean](docs/IndexBean.md) - [IndexeaClient::IndexBulkBody](docs/IndexBulkBody.md) - [IndexeaClient::IndexFieldBean](docs/IndexFieldBean.md) - [IndexeaClient::IndexForm](docs/IndexForm.md) - [IndexeaClient::IndexRebuildForm](docs/IndexRebuildForm.md) - [IndexeaClient::IndexSettings](docs/IndexSettings.md) - [IndexeaClient::IndexSettingsBody](docs/IndexSettingsBody.md) - [IndexeaClient::IndexStatBean](docs/IndexStatBean.md) - [IndexeaClient::IndexSynonymsflushBody](docs/IndexSynonymsflushBody.md) - [IndexeaClient::IndexTask](docs/IndexTask.md) - [IndexeaClient::IndexTemplate](docs/IndexTemplate.md) - [IndexeaClient::IndexTemplates](docs/IndexTemplates.md) - [IndexeaClient::IndexUploadBody](docs/IndexUploadBody.md) - [IndexeaClient::IntelligentMapping](docs/IntelligentMapping.md) - [IndexeaClient::KeywordBindingBean](docs/KeywordBindingBean.md) - [IndexeaClient::MentorForm](docs/MentorForm.md) - [IndexeaClient::Message](docs/Message.md) - [IndexeaClient::Messages](docs/Messages.md) - [IndexeaClient::OauthAppBean](docs/OauthAppBean.md) - [IndexeaClient::OpenidBean](docs/OpenidBean.md) - [IndexeaClient::OptionForm](docs/OptionForm.md) - [IndexeaClient::OrdersIdentBody](docs/OrdersIdentBody.md) - [IndexeaClient::PayResult](docs/PayResult.md) - [IndexeaClient::PaymentInvoice](docs/PaymentInvoice.md) - [IndexeaClient::PaymentOrder](docs/PaymentOrder.md) - [IndexeaClient::PaymentRecord](docs/PaymentRecord.md) - [IndexeaClient::PaymentService](docs/PaymentService.md) - [IndexeaClient::QueryActionBean](docs/QueryActionBean.md) - [IndexeaClient::QueryBean](docs/QueryBean.md) - [IndexeaClient::QueryForm](docs/QueryForm.md) - [IndexeaClient::QueryNode](docs/QueryNode.md) - [IndexeaClient::QuerySortField](docs/QuerySortField.md) - [IndexeaClient::QueryVariableBean](docs/QueryVariableBean.md) - [IndexeaClient::RecommendBean](docs/RecommendBean.md) - [IndexeaClient::RecordFilter](docs/RecordFilter.md) - [IndexeaClient::SearchEstimateResult](docs/SearchEstimateResult.md) - [IndexeaClient::SearchWord](docs/SearchWord.md) - [IndexeaClient::StatIndexBean](docs/StatIndexBean.md) - [IndexeaClient::SynonymsBean](docs/SynonymsBean.md) - [IndexeaClient::TokenBean](docs/TokenBean.md) - [IndexeaClient::TriggerBean](docs/TriggerBean.md) - [IndexeaClient::TriggerLogBean](docs/TriggerLogBean.md) - [IndexeaClient::ValueOfField](docs/ValueOfField.md) - [IndexeaClient::WidgetBean](docs/WidgetBean.md) - [IndexeaClient::WidgetForm](docs/WidgetForm.md) - [IndexeaClient::WidgetLogo](docs/WidgetLogo.md) - [IndexeaClient::WidgetLogoBody](docs/WidgetLogoBody.md) - [IndexeaClient::WidgetStatusForm](docs/WidgetStatusForm.md) ## Documentation for Authorization ### TokenAuth