# indexea-ruby-sdk

**Repository Path**: indexea/indexea-ruby-sdk

## Basic Information

- **Project Name**: indexea-ruby-sdk
- **Description**: Indexea Ruby SDK
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-19
- **Last Updated**: 2024-06-13

## Categories & Tags

**Categories**: search-engine

**Tags**: None

## README

# indexea

Indexea - 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 [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0
- Build package: org.openapitools.codegen.languages.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.gemspec
```

Then either install the gem locally:

```shell
gem install ./indexea-1.0.gem
```

(for development, run `gem install --dev ./indexea-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', '~> 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', :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'

# Setup authorization
Indexea.configure do |config|
  # Configure Bearer authorization (Random): TokenAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = Indexea::AccountApi.new

begin
  #获取系统公告
  result = api_instance.account_bulletin
  p result
rescue Indexea::ApiError => e
  puts "Exception when calling AccountApi->account_bulletin: #{e}"
end

```

## Documentation for API Endpoints

All URIs are relative to *https://api.indexea.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Indexea::AccountApi* | [**account_bulletin**](docs/AccountApi.md#account_bulletin) | **GET** /accounts/bulletin | 获取系统公告
*Indexea::AccountApi* | [**account_delete**](docs/AccountApi.md#account_delete) | **DELETE** /account/profile | 注销账号
*Indexea::AccountApi* | [**account_delete_openid**](docs/AccountApi.md#account_delete_openid) | **DELETE** /account/openid | 解绑三方账号
*Indexea::AccountApi* | [**account_openid**](docs/AccountApi.md#account_openid) | **GET** /account/openid | 获取绑定的所有三方账号
*Indexea::AccountApi* | [**account_passwd**](docs/AccountApi.md#account_passwd) | **POST** /account/passwd | 修改账号密码
*Indexea::AccountApi* | [**account_portrait**](docs/AccountApi.md#account_portrait) | **POST** /account/portrait | 修改账号头像
*Indexea::AccountApi* | [**account_profile**](docs/AccountApi.md#account_profile) | **GET** /account/profile | 获取登录账号信息
*Indexea::AccountApi* | [**account_reset_pwd**](docs/AccountApi.md#account_reset_pwd) | **POST** /account/reset-pwd | 重置账号密码
*Indexea::AccountApi* | [**account_send_verify_code**](docs/AccountApi.md#account_send_verify_code) | **GET** /account/send-verify-code | 发送账号验证码
*Indexea::AccountApi* | [**account_signin**](docs/AccountApi.md#account_signin) | **POST** /account/signin | 登录系统
*Indexea::AccountApi* | [**account_signout**](docs/AccountApi.md#account_signout) | **POST** /account/sign-out | 退出登录状态
*Indexea::AccountApi* | [**account_signup**](docs/AccountApi.md#account_signup) | **POST** /account/signup | 注册新账号
*Indexea::AccountApi* | [**account_update**](docs/AccountApi.md#account_update) | **POST** /account/profile | 修改账号资料
*Indexea::AccountApi* | [**account_update_settings**](docs/AccountApi.md#account_update_settings) | **POST** /account/settings | 修改账号设置
*Indexea::AppsApi* | [**app_add_mentor**](docs/AppsApi.md#app_add_mentor) | **POST** /apps/{app}/mentors | 添加应用成员
*Indexea::AppsApi* | [**app_blacklist**](docs/AppsApi.md#app_blacklist) | **GET** /apps/{app}/blacklist | 获取黑名单信息
*Indexea::AppsApi* | [**app_create**](docs/AppsApi.md#app_create) | **POST** /apps | 创建应用
*Indexea::AppsApi* | [**app_create_access_token**](docs/AppsApi.md#app_create_access_token) | **POST** /apps/{app}/tokens | 创建 Access Token
*Indexea::AppsApi* | [**app_create_oauth_app**](docs/AppsApi.md#app_create_oauth_app) | **POST** /apps/{app}/oauth | 创建第三方应用
*Indexea::AppsApi* | [**app_delete**](docs/AppsApi.md#app_delete) | **DELETE** /apps/{app} | 删除应用
*Indexea::AppsApi* | [**app_delete_access_token**](docs/AppsApi.md#app_delete_access_token) | **DELETE** /apps/{app}/tokens | 删除 Access Token
*Indexea::AppsApi* | [**app_delete_mentor**](docs/AppsApi.md#app_delete_mentor) | **DELETE** /apps/{app}/mentors | 删除应用成员
*Indexea::AppsApi* | [**app_delete_oauth_app**](docs/AppsApi.md#app_delete_oauth_app) | **DELETE** /apps/{app}/oauth | 删除第三方应用
*Indexea::AppsApi* | [**app_excel_of_logs**](docs/AppsApi.md#app_excel_of_logs) | **GET** /apps/{app}/logs | 导出应用日志到 Excel
*Indexea::AppsApi* | [**app_get**](docs/AppsApi.md#app_get) | **GET** /apps/{app} | 获取应用详情
*Indexea::AppsApi* | [**app_get_company**](docs/AppsApi.md#app_get_company) | **POST** /apps/{app}/company | 获取应用填写的公司信息
*Indexea::AppsApi* | [**app_get_company_pic**](docs/AppsApi.md#app_get_company_pic) | **GET** /apps/{app}/company | 获取公司营业执照或者一般纳税人证明
*Indexea::AppsApi* | [**app_list**](docs/AppsApi.md#app_list) | **GET** /apps | 获取应用列表
*Indexea::AppsApi* | [**app_list_mentors**](docs/AppsApi.md#app_list_mentors) | **GET** /apps/{app}/mentors | 获取应用成员列表
*Indexea::AppsApi* | [**app_list_oauth_apps**](docs/AppsApi.md#app_list_oauth_apps) | **GET** /apps/{app}/oauth | 获取第三方应用列表
*Indexea::AppsApi* | [**app_logs**](docs/AppsApi.md#app_logs) | **POST** /apps/{app}/logs | 获取应用的日志列表
*Indexea::AppsApi* | [**app_reset_access_token**](docs/AppsApi.md#app_reset_access_token) | **PATCH** /apps/{app}/tokens | 重置 Access Token
*Indexea::AppsApi* | [**app_reset_oauth_app_secret**](docs/AppsApi.md#app_reset_oauth_app_secret) | **POST** /apps/{app}/oauth-reset-secret | 重新生成三方应用的密钥
*Indexea::AppsApi* | [**app_save_blacklist**](docs/AppsApi.md#app_save_blacklist) | **PUT** /apps/{app}/blacklist | 修改应用的黑名单信息
*Indexea::AppsApi* | [**app_save_company**](docs/AppsApi.md#app_save_company) | **PUT** /apps/{app}/company | 修改应用的公司信息
*Indexea::AppsApi* | [**app_searchs_estimate**](docs/AppsApi.md#app_searchs_estimate) | **GET** /apps/{app}/searchs-estimate | 获取搜索流量包使用配额信息
*Indexea::AppsApi* | [**app_set_trigger**](docs/AppsApi.md#app_set_trigger) | **PUT** /apps/{app}/trigger | 修改应用的触发器信息
*Indexea::AppsApi* | [**app_tokens**](docs/AppsApi.md#app_tokens) | **GET** /apps/{app}/tokens | 获取 Access Token 列表
*Indexea::AppsApi* | [**app_transfer**](docs/AppsApi.md#app_transfer) | **POST** /apps/{app}/transfer | 转让应用给他人
*Indexea::AppsApi* | [**app_trigger**](docs/AppsApi.md#app_trigger) | **GET** /apps/{app}/trigger | 获取应用触发器详情
*Indexea::AppsApi* | [**app_trigger_logs**](docs/AppsApi.md#app_trigger_logs) | **GET** /apps/{app}/trigger-logs | 获取应用触发日志列表
*Indexea::AppsApi* | [**app_update**](docs/AppsApi.md#app_update) | **PUT** /apps/{app} | 修改应用的基本信息
*Indexea::AppsApi* | [**app_update_access_token**](docs/AppsApi.md#app_update_access_token) | **PUT** /apps/{app}/tokens | 修改 Access Token
*Indexea::AppsApi* | [**app_update_mentor**](docs/AppsApi.md#app_update_mentor) | **PATCH** /apps/{app}/mentors | 修改成员备注和权限
*Indexea::AppsApi* | [**app_update_mentor_options**](docs/AppsApi.md#app_update_mentor_options) | **POST** /apps/{app}/mentors-options | 修改应用成员自身的设置（包括应用名备注，是否接收报告等）
*Indexea::AppsApi* | [**app_update_mentor_report_options**](docs/AppsApi.md#app_update_mentor_report_options) | **PATCH** /apps/{app}/mentors-options | 修改应用成员自身的通知设置
*Indexea::AppsApi* | [**app_update_oauth_app**](docs/AppsApi.md#app_update_oauth_app) | **PATCH** /apps/{app}/oauth | 修改第三方应用信息
*Indexea::AppsApi* | [**app_update_oauth_app_logo**](docs/AppsApi.md#app_update_oauth_app_logo) | **PUT** /apps/{app}/oauth | 修改三方应用图标
*Indexea::AppsApi* | [**app_update_status**](docs/AppsApi.md#app_update_status) | **PATCH** /apps/{app} | 修改应用的状态
*Indexea::FieldsApi* | [**index_fields**](docs/FieldsApi.md#index_fields) | **GET** /indices/{app}/{index}/fields | 获取索引字段映射详情
*Indexea::FieldsApi* | [**index_update_fields**](docs/FieldsApi.md#index_update_fields) | **POST** /indices/{app}/{index}/fields | 更新索引的字段映射
*Indexea::FieldsApi* | [**index_update_html_strip_fields**](docs/FieldsApi.md#index_update_html_strip_fields) | **PATCH** /indices/{app}/{index}/fields | 更新索引的HTML过滤字段列表
*Indexea::FieldsApi* | [**index_values_of_field**](docs/FieldsApi.md#index_values_of_field) | **GET** /indices/{app}/{index}/fields/{field} | 获取索引字段的所有值列表
*Indexea::GlobalApi* | [**json**](docs/GlobalApi.md#json) | **GET** /json | 接口定义(JSON)
*Indexea::GlobalApi* | [**options_get**](docs/GlobalApi.md#options_get) | **GET** /options | 系统全局配置接口
*Indexea::GlobalApi* | [**status_database**](docs/GlobalApi.md#status_database) | **GET** /status/database | 数据库服务状态测试
*Indexea::GlobalApi* | [**status_engine**](docs/GlobalApi.md#status_engine) | **GET** /status/engine | 搜索引擎状态测试
*Indexea::GlobalApi* | [**welcome**](docs/GlobalApi.md#welcome) | **GET** / | 接口欢迎信息
*Indexea::GlobalApi* | [**yaml**](docs/GlobalApi.md#yaml) | **GET** /yaml | 接口定义(YAML)
*Indexea::IndicesApi* | [**index_cleanup**](docs/IndicesApi.md#index_cleanup) | **POST** /indices/{app}/{index}/cleanup | 清空索引记录
*Indexea::IndicesApi* | [**index_copy_to**](docs/IndicesApi.md#index_copy_to) | **POST** /indices/{app}/{index}/copyto | 导出索引数据
*Indexea::IndicesApi* | [**index_create**](docs/IndicesApi.md#index_create) | **POST** /indices/{app} | 创建索引
*Indexea::IndicesApi* | [**index_create_template**](docs/IndicesApi.md#index_create_template) | **POST** /indices/templates | 创建索引模板
*Indexea::IndicesApi* | [**index_delete**](docs/IndicesApi.md#index_delete) | **DELETE** /indices/{app}/{index} | 删除索引
*Indexea::IndicesApi* | [**index_delete_crawler_task**](docs/IndicesApi.md#index_delete_crawler_task) | **DELETE** /indices/{app}/{index}/crawler-settings | 删除索引的数据爬取任务
*Indexea::IndicesApi* | [**index_delete_template**](docs/IndicesApi.md#index_delete_template) | **DELETE** /indices/templates | 删除索引模板
*Indexea::IndicesApi* | [**index_export**](docs/IndicesApi.md#index_export) | **POST** /indices/{app}/{index}/export | 导出索引数据
*Indexea::IndicesApi* | [**index_flush**](docs/IndicesApi.md#index_flush) | **POST** /indices/{app}/{index}/flush | 刷新索引数据，主要用于将内存中的索引数据写入磁盘
*Indexea::IndicesApi* | [**index_flush_settings**](docs/IndicesApi.md#index_flush_settings) | **PUT** /indices/{app}/{index}/settings | 写入设置信息到索引
*Indexea::IndicesApi* | [**index_get**](docs/IndicesApi.md#index_get) | **GET** /indices/{app}/{index} | 获取单个索引详情
*Indexea::IndicesApi* | [**index_get_crawler_logs**](docs/IndicesApi.md#index_get_crawler_logs) | **GET** /indices/{app}/{index}/crawler-logs | 获取索引的爬虫任务的爬取日志
*Indexea::IndicesApi* | [**index_get_crawler_task**](docs/IndicesApi.md#index_get_crawler_task) | **GET** /indices/{app}/{index}/crawler-settings | 获取索引的爬虫任务设定
*Indexea::IndicesApi* | [**index_get_filter_settings**](docs/IndicesApi.md#index_get_filter_settings) | **GET** /indices/{app}/{index}/filter-settings | 获取索引设置信息
*Indexea::IndicesApi* | [**index_get_settings**](docs/IndicesApi.md#index_get_settings) | **GET** /indices/{app}/{index}/settings | 获取索引设置信息
*Indexea::IndicesApi* | [**index_list**](docs/IndicesApi.md#index_list) | **GET** /indices/{app} | 获取应用的索引列表
*Indexea::IndicesApi* | [**index_list_templates**](docs/IndicesApi.md#index_list_templates) | **GET** /indices/templates | 获取所有可用的索引模板
*Indexea::IndicesApi* | [**index_prefetch**](docs/IndicesApi.md#index_prefetch) | **GET** /indices/crawler | 获取目标网站内容预览
*Indexea::IndicesApi* | [**index_rebuild**](docs/IndicesApi.md#index_rebuild) | **POST** /indices/{app}/{index}/rebuild | 重建索引数据
*Indexea::IndicesApi* | [**index_rebuild_task**](docs/IndicesApi.md#index_rebuild_task) | **GET** /indices/{app}/{index}/rebuild | 获取重建索引任务的详情
*Indexea::IndicesApi* | [**index_submit_crawler_task**](docs/IndicesApi.md#index_submit_crawler_task) | **POST** /indices/{app}/{index}/crawler-settings | 提交或者更新索引的数据爬取任务
*Indexea::IndicesApi* | [**index_tasks**](docs/IndicesApi.md#index_tasks) | **GET** /indices/{app}/tasks | 获取该索引在后台的任务列表
*Indexea::IndicesApi* | [**index_update**](docs/IndicesApi.md#index_update) | **PUT** /indices/{app}/{index} | 修改索引
*Indexea::IndicesApi* | [**index_update_settings**](docs/IndicesApi.md#index_update_settings) | **POST** /indices/{app}/{index}/settings | 更新索引设置信息
*Indexea::IndicesApi* | [**index_update_template**](docs/IndicesApi.md#index_update_template) | **PUT** /indices/templates | 修改索引模板
*Indexea::IndicesApi* | [**synonyms_add**](docs/IndicesApi.md#synonyms_add) | **POST** /indices/{app}/{index}/synonyms | 添加同义词
*Indexea::IndicesApi* | [**synonyms_delete**](docs/IndicesApi.md#synonyms_delete) | **DELETE** /indices/{app}/{index}/synonyms | 删除同义词
*Indexea::IndicesApi* | [**synonyms_enable**](docs/IndicesApi.md#synonyms_enable) | **PATCH** /indices/{app}/{index}/synonyms | 启用禁用同义词
*Indexea::IndicesApi* | [**synonyms_flush**](docs/IndicesApi.md#synonyms_flush) | **POST** /indices/{app}/{index}/synonyms-flush | 将同义词更新到搜索引擎的同义词表
*Indexea::IndicesApi* | [**synonyms_import**](docs/IndicesApi.md#synonyms_import) | **POST** /indices/{app}/{index}/synonyms-import | 导入同义词
*Indexea::IndicesApi* | [**synonyms_list**](docs/IndicesApi.md#synonyms_list) | **GET** /indices/{app}/{index}/synonyms | 获取索引的所有同义词
*Indexea::IndicesApi* | [**synonyms_update**](docs/IndicesApi.md#synonyms_update) | **PUT** /indices/{app}/{index}/synonyms | 修改同义词
*Indexea::MessageApi* | [**message_delete**](docs/MessageApi.md#message_delete) | **DELETE** /accounts/message | 删除消息
*Indexea::MessageApi* | [**message_feedback**](docs/MessageApi.md#message_feedback) | **POST** /accounts/feedback | 反馈意见
*Indexea::MessageApi* | [**message_list**](docs/MessageApi.md#message_list) | **GET** /accounts/message | 获取我相关的消息信息，包括未读消息数量、最新消息等
*Indexea::MessageApi* | [**message_read**](docs/MessageApi.md#message_read) | **PATCH** /accounts/message | 标识消息为已读
*Indexea::MessageApi* | [**message_send**](docs/MessageApi.md#message_send) | **POST** /accounts/message | 发送消息
*Indexea::PaymentApi* | [**payment_alipay**](docs/PaymentApi.md#payment_alipay) | **POST** /payment/alipay | 接受支付宝的支付结果
*Indexea::PaymentApi* | [**payment_alipay_return**](docs/PaymentApi.md#payment_alipay_return) | **GET** /payment/alipay | 支付宝平台支付完毕后调整到该接口
*Indexea::PaymentApi* | [**payment_apply_invoice**](docs/PaymentApi.md#payment_apply_invoice) | **POST** /payment/{app}/invoices | 申请发票
*Indexea::PaymentApi* | [**payment_begin_pay**](docs/PaymentApi.md#payment_begin_pay) | **POST** /payment/{app}/orders/{ident} | 支付订单
*Indexea::PaymentApi* | [**payment_buy**](docs/PaymentApi.md#payment_buy) | **PUT** /payment/{app}/orders | 下单购买
*Indexea::PaymentApi* | [**payment_delete_invoice**](docs/PaymentApi.md#payment_delete_invoice) | **DELETE** /payment/{app}/invoices | 删除发票
*Indexea::PaymentApi* | [**payment_delete_order**](docs/PaymentApi.md#payment_delete_order) | **DELETE** /payment/{app}/orders/{ident} | 取消订单
*Indexea::PaymentApi* | [**payment_invoices**](docs/PaymentApi.md#payment_invoices) | **GET** /payment/{app}/invoices | 获取发票列表
*Indexea::PaymentApi* | [**payment_order**](docs/PaymentApi.md#payment_order) | **GET** /payment/{app}/orders/{ident} | 获取订单详情
*Indexea::PaymentApi* | [**payment_orders**](docs/PaymentApi.md#payment_orders) | **POST** /payment/{app}/orders | 订单列表
*Indexea::PaymentApi* | [**payment_orders_without_invoice**](docs/PaymentApi.md#payment_orders_without_invoice) | **GET** /payment/{app}/orders_without_invoice | 获取未曾开票的订单列表
*Indexea::PaymentApi* | [**payment_price**](docs/PaymentApi.md#payment_price) | **GET** /payment/{app}/price | 获取套餐价格
*Indexea::PaymentApi* | [**payment_receipt**](docs/PaymentApi.md#payment_receipt) | **GET** /payment/{app}/orders | 获取订单回执图片
*Indexea::PaymentApi* | [**payment_request_contact**](docs/PaymentApi.md#payment_request_contact) | **POST** /payment/{app}/contact | 联系销售获取私有化报价
*Indexea::PaymentApi* | [**payment_upload_receipt**](docs/PaymentApi.md#payment_upload_receipt) | **PUT** /payment/{app}/orders/{ident} | 上传转账回执
*Indexea::PaymentApi* | [**payment_wepay**](docs/PaymentApi.md#payment_wepay) | **POST** /payment/wepay | 接受微信支付的支付结果
*Indexea::QueriesApi* | [**query_analyze**](docs/QueriesApi.md#query_analyze) | **POST** /queries/{app}/analyze | 分词测试
*Indexea::QueriesApi* | [**query_copy**](docs/QueriesApi.md#query_copy) | **POST** /queries/{app}/copy | 复制指定查询并创建新查询
*Indexea::QueriesApi* | [**query_copy_to_query**](docs/QueriesApi.md#query_copy_to_query) | **PUT** /queries/{app}/copy | 复制查询到已有查询
*Indexea::QueriesApi* | [**query_create**](docs/QueriesApi.md#query_create) | **POST** /queries/{app} | 创建搜索
*Indexea::QueriesApi* | [**query_create_keyword_bindings**](docs/QueriesApi.md#query_create_keyword_bindings) | **POST** /queries/{app}/keyword-bindings | 创建新的关键词文档绑定
*Indexea::QueriesApi* | [**query_create_variable**](docs/QueriesApi.md#query_create_variable) | **POST** /queries/{app}/variables | 创建新的预定义查询变量
*Indexea::QueriesApi* | [**query_delete**](docs/QueriesApi.md#query_delete) | **DELETE** /queries/{app} | 删除搜索
*Indexea::QueriesApi* | [**query_delete_keyword_bindings**](docs/QueriesApi.md#query_delete_keyword_bindings) | **DELETE** /queries/{app}/keyword-bindings | 删除关键词文档绑定
*Indexea::QueriesApi* | [**query_delete_node_positions**](docs/QueriesApi.md#query_delete_node_positions) | **DELETE** /queries/{app}/node-positions | 清除查询条件的节点位置信息
*Indexea::QueriesApi* | [**query_delete_variable**](docs/QueriesApi.md#query_delete_variable) | **DELETE** /queries/{app}/variables | 删除预定义查询变量
*Indexea::QueriesApi* | [**query_fields**](docs/QueriesApi.md#query_fields) | **GET** /queries/{app}/fields | 获取查询关联的所有索引的字段信息
*Indexea::QueriesApi* | [**query_get**](docs/QueriesApi.md#query_get) | **GET** /queries/{app}/{query} | 获取查询的详情
*Indexea::QueriesApi* | [**query_get_node_positions**](docs/QueriesApi.md#query_get_node_positions) | **GET** /queries/{app}/node-positions | 获取查询条件的节点位置信息
*Indexea::QueriesApi* | [**query_get_record**](docs/QueriesApi.md#query_get_record) | **GET** /queries/{app}/record | 获取记录的详情
*Indexea::QueriesApi* | [**query_keyword_bindings**](docs/QueriesApi.md#query_keyword_bindings) | **GET** /queries/{app}/keyword-bindings | 获取查询的关键词文档绑定列表
*Indexea::QueriesApi* | [**query_list**](docs/QueriesApi.md#query_list) | **GET** /queries/{app} | 获取应用下所有索引下的查询列表（按索引进行分组）
*Indexea::QueriesApi* | [**query_profile**](docs/QueriesApi.md#query_profile) | **GET** /queries/{app}/profiler | 获取搜索诊断信息
*Indexea::QueriesApi* | [**query_records_of_keyword_binding**](docs/QueriesApi.md#query_records_of_keyword_binding) | **GET** /queries/{app}/keyword-bindings-records | 获取关键词绑定对应的记录列表
*Indexea::QueriesApi* | [**query_save_intelligent_mappings**](docs/QueriesApi.md#query_save_intelligent_mappings) | **PUT** /queries/{app}/intelligent-mappings | 设置索引智能匹配字段
*Indexea::QueriesApi* | [**query_save_node_positions**](docs/QueriesApi.md#query_save_node_positions) | **PUT** /queries/{app}/node-positions | 保存查询条件的节点位置信息
*Indexea::QueriesApi* | [**query_search**](docs/QueriesApi.md#query_search) | **GET** /queries/{app}/search | 搜索测试
*Indexea::QueriesApi* | [**query_source**](docs/QueriesApi.md#query_source) | **POST** /queries/{app}/{query} | 获取最终查询的源码(JSON)
*Indexea::QueriesApi* | [**query_suggest**](docs/QueriesApi.md#query_suggest) | **GET** /queries/{app}/suggest | 获取搜索建议列表
*Indexea::QueriesApi* | [**query_test_intelligent_mappings**](docs/QueriesApi.md#query_test_intelligent_mappings) | **POST** /queries/{app}/intelligent-mappings | 测试索引智能匹配字段
*Indexea::QueriesApi* | [**query_update**](docs/QueriesApi.md#query_update) | **PUT** /queries/{app} | 修改查询
*Indexea::QueriesApi* | [**query_update_keyword_bindings**](docs/QueriesApi.md#query_update_keyword_bindings) | **PATCH** /queries/{app}/keyword-bindings | 修改关键词文档绑定
*Indexea::QueriesApi* | [**query_update_settings**](docs/QueriesApi.md#query_update_settings) | **POST** /queries/{app}/settings | 更改查询的设置项
*Indexea::QueriesApi* | [**query_update_variable**](docs/QueriesApi.md#query_update_variable) | **PATCH** /queries/{app}/variables | 修改预定义查询变量
*Indexea::QueriesApi* | [**query_validate**](docs/QueriesApi.md#query_validate) | **GET** /queries/{app}/validate | 获取搜索验证结果
*Indexea::QueriesApi* | [**query_validate_aggregation**](docs/QueriesApi.md#query_validate_aggregation) | **POST** /queries/{app}/validate-aggregation | 验证聚合定义是否正确
*Indexea::QueriesApi* | [**query_validate_query**](docs/QueriesApi.md#query_validate_query) | **POST** /queries/{app}/validate-query | 验证聚合定义是否正确
*Indexea::QueriesApi* | [**query_validate_script_field**](docs/QueriesApi.md#query_validate_script_field) | **POST** /queries/{app}/validate-script-field | 验证脚本字段是否正确
*Indexea::QueriesApi* | [**query_validate_script_score**](docs/QueriesApi.md#query_validate_script_score) | **POST** /queries/{app}/validate-script-score | 验证脚本字段是否正确
*Indexea::QueriesApi* | [**query_validate_suggestion**](docs/QueriesApi.md#query_validate_suggestion) | **POST** /queries/{app}/validate-suggest | 验证建议是否正确
*Indexea::QueriesApi* | [**query_variables**](docs/QueriesApi.md#query_variables) | **GET** /queries/{app}/variables | 获取应用的预定义查询变量列表
*Indexea::RecommendApi* | [**recommend_click**](docs/RecommendApi.md#recommend_click) | **POST** /recommend/{ident}/click | 推荐结果点击行为收集
*Indexea::RecommendApi* | [**recommend_create**](docs/RecommendApi.md#recommend_create) | **POST** /recommends/{app} | 创建新的推荐
*Indexea::RecommendApi* | [**recommend_delete**](docs/RecommendApi.md#recommend_delete) | **DELETE** /recommends/{app} | 删除推荐
*Indexea::RecommendApi* | [**recommend_detail**](docs/RecommendApi.md#recommend_detail) | **GET** /recommend/{ident} | 获取推荐的记录列表
*Indexea::RecommendApi* | [**recommend_fetch**](docs/RecommendApi.md#recommend_fetch) | **POST** /recommend/{ident} | 获取推荐的记录列表
*Indexea::RecommendApi* | [**recommend_list**](docs/RecommendApi.md#recommend_list) | **GET** /recommends/{app} | 获取已定义的推荐列表
*Indexea::RecommendApi* | [**recommend_update**](docs/RecommendApi.md#recommend_update) | **PUT** /recommends/{app} | 更新推荐信息
*Indexea::RecordsApi* | [**record_delete**](docs/RecordsApi.md#record_delete) | **DELETE** /records/{app}/{index} | 删除记录数据
*Indexea::RecordsApi* | [**record_delete_by_query**](docs/RecordsApi.md#record_delete_by_query) | **DELETE** /records/{app}/{index}/bulk | 批量删除记录数据(delete_by_query)，该接口传递查询参数获取要删除的记录并逐一删除
*Indexea::RecordsApi* | [**record_get**](docs/RecordsApi.md#record_get) | **GET** /records/{app}/{index} | 获取单条记录详情
*Indexea::RecordsApi* | [**record_list**](docs/RecordsApi.md#record_list) | **POST** /records/{app}/{index} | 获取索引记录列表
*Indexea::RecordsApi* | [**record_push**](docs/RecordsApi.md#record_push) | **PUT** /records/{app}/{index} | 插入或者更新索引数据
*Indexea::RecordsApi* | [**record_update_by_query**](docs/RecordsApi.md#record_update_by_query) | **PATCH** /records/{app}/{index}/bulk | 批量修改记录数据(update_by_query)，该接口传递查询参数获取要更新的记录，并使用 body 中的对象进行记录合并更新
*Indexea::RecordsApi* | [**record_upload**](docs/RecordsApi.md#record_upload) | **POST** /records/{app}/{index}/bulk | 上传记录
*Indexea::RecordsApi* | [**record_upload_old**](docs/RecordsApi.md#record_upload_old) | **POST** /records/{app}/{index}/upload | 上传记录，该接口已经废弃，请使用 /records/{app}/{index}/bulk 接口
*Indexea::SearchApi* | [**search_click**](docs/SearchApi.md#search_click) | **POST** /search/widget/{widget}/click | 搜索结果点击行为收集
*Indexea::SearchApi* | [**search_histories**](docs/SearchApi.md#search_histories) | **GET** /search/widget/{widget}/histories | 获取当前搜索用户的最新搜索记录
*Indexea::SearchApi* | [**search_logs**](docs/SearchApi.md#search_logs) | **GET** /apps/{app}/logs-searchs | 获取搜索日志
*Indexea::SearchApi* | [**search_query_click**](docs/SearchApi.md#search_query_click) | **POST** /search/query/{query}/click | 搜索结果点击行为收集
*Indexea::SearchApi* | [**search_query_histories**](docs/SearchApi.md#search_query_histories) | **GET** /search/query/{query}/histories | 获取当前搜索用户的最新搜索记录
*Indexea::SearchApi* | [**search_query_hot_words**](docs/SearchApi.md#search_query_hot_words) | **GET** /search/query/{query}/hotwords | 获取查询相关热词
*Indexea::SearchApi* | [**search_query_repeat_scroll**](docs/SearchApi.md#search_query_repeat_scroll) | **POST** /search/scroll/{query} | 读取滚动搜索结果
*Indexea::SearchApi* | [**search_query_scroll**](docs/SearchApi.md#search_query_scroll) | **GET** /search/scroll/{query} | 基于查询的滚动搜索
*Indexea::SearchApi* | [**search_query_search**](docs/SearchApi.md#search_query_search) | **GET** /search/query/{query} | 基于查询的公开搜索
*Indexea::SearchApi* | [**search_widget_auto_complete**](docs/SearchApi.md#search_widget_auto_complete) | **GET** /search/widget/{widget}/autocomplete | 基于组件的搜索词自动完成
*Indexea::SearchApi* | [**search_widget_hot_words**](docs/SearchApi.md#search_widget_hot_words) | **GET** /search/widget/{widget}/hotwords | 获取组件搜索的相关热词
*Indexea::SearchApi* | [**search_widget_search**](docs/SearchApi.md#search_widget_search) | **GET** /search/widget/{widget} | 基于组件的公开搜索
*Indexea::StatsApi* | [**stats_recomms**](docs/StatsApi.md#stats_recomms) | **GET** /stats/{app}/recomms | 获取推荐日志的汇总信息
*Indexea::StatsApi* | [**stats_searchs**](docs/StatsApi.md#stats_searchs) | **GET** /stats/{app}/searchs | 获取搜索日志的汇总信息
*Indexea::StatsApi* | [**stats_top_clicks**](docs/StatsApi.md#stats_top_clicks) | **GET** /stats/{app}/top-clicks | 获取点击排行榜
*Indexea::StatsApi* | [**stats_widgets**](docs/StatsApi.md#stats_widgets) | **GET** /stats/{app}/widgets | 获取模板与组件的统计信息
*Indexea::WidgetsApi* | [**widget_copy**](docs/WidgetsApi.md#widget_copy) | **POST** /widget/{app}/copy | 复制指定组件并创建新组件
*Indexea::WidgetsApi* | [**widget_copy_to_widget**](docs/WidgetsApi.md#widget_copy_to_widget) | **PUT** /widget/{app}/copy | 复制组件到已有组件
*Indexea::WidgetsApi* | [**widget_create**](docs/WidgetsApi.md#widget_create) | **POST** /widgets/{app} | 创建组件
*Indexea::WidgetsApi* | [**widget_delete**](docs/WidgetsApi.md#widget_delete) | **DELETE** /widgets/{app}/{widget} | 删除组件
*Indexea::WidgetsApi* | [**widget_delete_logo**](docs/WidgetsApi.md#widget_delete_logo) | **DELETE** /widgets/{app}/{widget}/logo | 删除组件 Logo
*Indexea::WidgetsApi* | [**widget_detail**](docs/WidgetsApi.md#widget_detail) | **GET** /widget/{ident} | 获取UI组件的所有相关信息
*Indexea::WidgetsApi* | [**widget_download**](docs/WidgetsApi.md#widget_download) | **GET** /widgets/{app}/{widget}/download | 下载组件应用源码
*Indexea::WidgetsApi* | [**widget_get**](docs/WidgetsApi.md#widget_get) | **GET** /widgets/{app}/{widget} | 获取组件的详情
*Indexea::WidgetsApi* | [**widget_list**](docs/WidgetsApi.md#widget_list) | **GET** /widgets/{app} | 获取应用的组件列表
*Indexea::WidgetsApi* | [**widget_logo**](docs/WidgetsApi.md#widget_logo) | **POST** /widgets/{app}/{widget}/logo | 设置组件 Logo
*Indexea::WidgetsApi* | [**widget_update**](docs/WidgetsApi.md#widget_update) | **PUT** /widgets/{app}/{widget} | 修改组件
*Indexea::WidgetsApi* | [**widget_update_settings**](docs/WidgetsApi.md#widget_update_settings) | **PATCH** /widgets/{app}/{widget} | 修改组件设置参数


## Documentation for Models

 - [Indexea::AccountBean](docs/AccountBean.md)
 - [Indexea::AnalyzeObject](docs/AnalyzeObject.md)
 - [Indexea::AnalyzeToken](docs/AnalyzeToken.md)
 - [Indexea::AppBean](docs/AppBean.md)
 - [Indexea::AppLogAccount](docs/AppLogAccount.md)
 - [Indexea::AppLogBean](docs/AppLogBean.md)
 - [Indexea::AppLogsBean](docs/AppLogsBean.md)
 - [Indexea::AppMentorBean](docs/AppMentorBean.md)
 - [Indexea::AutoCompleteItem](docs/AutoCompleteItem.md)
 - [Indexea::BlacklistBean](docs/BlacklistBean.md)
 - [Indexea::Bulletin](docs/Bulletin.md)
 - [Indexea::CompanyBean](docs/CompanyBean.md)
 - [Indexea::ContactForm](docs/ContactForm.md)
 - [Indexea::CrawlerLog](docs/CrawlerLog.md)
 - [Indexea::CrawlerLogs](docs/CrawlerLogs.md)
 - [Indexea::CrawlerTask](docs/CrawlerTask.md)
 - [Indexea::GlobalOptionForm](docs/GlobalOptionForm.md)
 - [Indexea::IndexBean](docs/IndexBean.md)
 - [Indexea::IndexFieldBean](docs/IndexFieldBean.md)
 - [Indexea::IndexForm](docs/IndexForm.md)
 - [Indexea::IndexRebuildForm](docs/IndexRebuildForm.md)
 - [Indexea::IndexSettings](docs/IndexSettings.md)
 - [Indexea::IndexStatBean](docs/IndexStatBean.md)
 - [Indexea::IndexTask](docs/IndexTask.md)
 - [Indexea::IndexTemplate](docs/IndexTemplate.md)
 - [Indexea::IndexTemplates](docs/IndexTemplates.md)
 - [Indexea::IntelligentMapping](docs/IntelligentMapping.md)
 - [Indexea::KeywordBindingBean](docs/KeywordBindingBean.md)
 - [Indexea::MentorForm](docs/MentorForm.md)
 - [Indexea::Message](docs/Message.md)
 - [Indexea::Messages](docs/Messages.md)
 - [Indexea::OauthAppBean](docs/OauthAppBean.md)
 - [Indexea::OpenidBean](docs/OpenidBean.md)
 - [Indexea::PayResult](docs/PayResult.md)
 - [Indexea::PaymentInvoice](docs/PaymentInvoice.md)
 - [Indexea::PaymentOrder](docs/PaymentOrder.md)
 - [Indexea::PaymentRecord](docs/PaymentRecord.md)
 - [Indexea::PaymentService](docs/PaymentService.md)
 - [Indexea::QueryActionBean](docs/QueryActionBean.md)
 - [Indexea::QueryBean](docs/QueryBean.md)
 - [Indexea::QueryForm](docs/QueryForm.md)
 - [Indexea::QueryNode](docs/QueryNode.md)
 - [Indexea::QuerySortField](docs/QuerySortField.md)
 - [Indexea::QueryVariableBean](docs/QueryVariableBean.md)
 - [Indexea::RecommendBean](docs/RecommendBean.md)
 - [Indexea::RecordFilter](docs/RecordFilter.md)
 - [Indexea::SearchEstimateResult](docs/SearchEstimateResult.md)
 - [Indexea::SearchWord](docs/SearchWord.md)
 - [Indexea::StatIndexBean](docs/StatIndexBean.md)
 - [Indexea::SynonymsBean](docs/SynonymsBean.md)
 - [Indexea::TokenBean](docs/TokenBean.md)
 - [Indexea::TriggerBean](docs/TriggerBean.md)
 - [Indexea::TriggerLogBean](docs/TriggerLogBean.md)
 - [Indexea::ValueOfField](docs/ValueOfField.md)
 - [Indexea::WidgetBean](docs/WidgetBean.md)
 - [Indexea::WidgetForm](docs/WidgetForm.md)
 - [Indexea::WidgetLogo](docs/WidgetLogo.md)
 - [Indexea::WidgetStatusForm](docs/WidgetStatusForm.md)


## Documentation for Authorization


Authentication schemes defined for the API:
### TokenAuth

- **Type**: Bearer authentication (Random)