# indexea-go-sdk

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

## Basic Information

- **Project Name**: indexea-go-sdk
- **Description**: Indexea Go 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

# Go API client for indexea

这是 Indexea 搜索服务平台的 OpenAPI，用于描述平台的所有接口信息，你可以通过这个页面来了解和在线验证平台的所有接口信息。

### Errors

本 API 使用标准的 HTTP 状态码来指示操作成功或者失败，如果失败将会在 body 中以 JSON 格式提供详细的错误信息，如下所示：

```
{
  \"error\": 404,
  \"message\": \"page not found\"
}
```


## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://indexea.com/about](https://indexea.com/about)

## Installation

Install the following dependencies:

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```golang
import indexea "github.com/GIT_USER_ID/GIT_REPO_ID"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```golang
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.

```golang
ctx := context.WithValue(context.Background(), indexea.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.

```golang
ctx := context.WithValue(context.Background(), indexea.ContextServerVariables, map[string]string{
	"basePath": "v2",
})
```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.

```golang
ctx := context.WithValue(context.Background(), indexea.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), indexea.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})
```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountAPI* | [**AccountBulletin**](docs/AccountAPI.md#accountbulletin) | **Get** /accounts/bulletin | 获取系统公告
*AccountAPI* | [**AccountDelete**](docs/AccountAPI.md#accountdelete) | **Delete** /account/profile | 注销账号
*AccountAPI* | [**AccountDeleteOpenid**](docs/AccountAPI.md#accountdeleteopenid) | **Delete** /account/openid | 解绑三方账号
*AccountAPI* | [**AccountOpenid**](docs/AccountAPI.md#accountopenid) | **Get** /account/openid | 获取绑定的所有三方账号
*AccountAPI* | [**AccountPasswd**](docs/AccountAPI.md#accountpasswd) | **Post** /account/passwd | 修改账号密码
*AccountAPI* | [**AccountPortrait**](docs/AccountAPI.md#accountportrait) | **Post** /account/portrait | 修改账号头像
*AccountAPI* | [**AccountProfile**](docs/AccountAPI.md#accountprofile) | **Get** /account/profile | 获取登录账号信息
*AccountAPI* | [**AccountResetPwd**](docs/AccountAPI.md#accountresetpwd) | **Post** /account/reset-pwd | 重置账号密码
*AccountAPI* | [**AccountSendVerifyCode**](docs/AccountAPI.md#accountsendverifycode) | **Get** /account/send-verify-code | 发送账号验证码
*AccountAPI* | [**AccountSignin**](docs/AccountAPI.md#accountsignin) | **Post** /account/signin | 登录系统
*AccountAPI* | [**AccountSignout**](docs/AccountAPI.md#accountsignout) | **Post** /account/sign-out | 退出登录状态
*AccountAPI* | [**AccountSignup**](docs/AccountAPI.md#accountsignup) | **Post** /account/signup | 注册新账号
*AccountAPI* | [**AccountUpdate**](docs/AccountAPI.md#accountupdate) | **Post** /account/profile | 修改账号资料
*AccountAPI* | [**AccountUpdateSettings**](docs/AccountAPI.md#accountupdatesettings) | **Post** /account/settings | 修改账号设置
*AppsAPI* | [**AppAddMentor**](docs/AppsAPI.md#appaddmentor) | **Post** /apps/{app}/mentors | 添加应用成员
*AppsAPI* | [**AppBlacklist**](docs/AppsAPI.md#appblacklist) | **Get** /apps/{app}/blacklist | 获取黑名单信息
*AppsAPI* | [**AppCreate**](docs/AppsAPI.md#appcreate) | **Post** /apps | 创建应用
*AppsAPI* | [**AppCreateAccessToken**](docs/AppsAPI.md#appcreateaccesstoken) | **Post** /apps/{app}/tokens | 创建 Access Token
*AppsAPI* | [**AppCreateOauthApp**](docs/AppsAPI.md#appcreateoauthapp) | **Post** /apps/{app}/oauth | 创建第三方应用
*AppsAPI* | [**AppDelete**](docs/AppsAPI.md#appdelete) | **Delete** /apps/{app} | 删除应用
*AppsAPI* | [**AppDeleteAccessToken**](docs/AppsAPI.md#appdeleteaccesstoken) | **Delete** /apps/{app}/tokens | 删除 Access Token
*AppsAPI* | [**AppDeleteMentor**](docs/AppsAPI.md#appdeletementor) | **Delete** /apps/{app}/mentors | 删除应用成员
*AppsAPI* | [**AppDeleteOauthApp**](docs/AppsAPI.md#appdeleteoauthapp) | **Delete** /apps/{app}/oauth | 删除第三方应用
*AppsAPI* | [**AppExcelOfLogs**](docs/AppsAPI.md#appexceloflogs) | **Get** /apps/{app}/logs | 导出应用日志到 Excel
*AppsAPI* | [**AppGet**](docs/AppsAPI.md#appget) | **Get** /apps/{app} | 获取应用详情
*AppsAPI* | [**AppGetCompany**](docs/AppsAPI.md#appgetcompany) | **Post** /apps/{app}/company | 获取应用填写的公司信息
*AppsAPI* | [**AppGetCompanyPic**](docs/AppsAPI.md#appgetcompanypic) | **Get** /apps/{app}/company | 获取公司营业执照或者一般纳税人证明
*AppsAPI* | [**AppList**](docs/AppsAPI.md#applist) | **Get** /apps | 获取应用列表
*AppsAPI* | [**AppListMentors**](docs/AppsAPI.md#applistmentors) | **Get** /apps/{app}/mentors | 获取应用成员列表
*AppsAPI* | [**AppListOauthApps**](docs/AppsAPI.md#applistoauthapps) | **Get** /apps/{app}/oauth | 获取第三方应用列表
*AppsAPI* | [**AppLogs**](docs/AppsAPI.md#applogs) | **Post** /apps/{app}/logs | 获取应用的日志列表
*AppsAPI* | [**AppResetAccessToken**](docs/AppsAPI.md#appresetaccesstoken) | **Patch** /apps/{app}/tokens | 重置 Access Token
*AppsAPI* | [**AppResetOauthAppSecret**](docs/AppsAPI.md#appresetoauthappsecret) | **Post** /apps/{app}/oauth-reset-secret | 重新生成三方应用的密钥
*AppsAPI* | [**AppSaveBlacklist**](docs/AppsAPI.md#appsaveblacklist) | **Put** /apps/{app}/blacklist | 修改应用的黑名单信息
*AppsAPI* | [**AppSaveCompany**](docs/AppsAPI.md#appsavecompany) | **Put** /apps/{app}/company | 修改应用的公司信息
*AppsAPI* | [**AppSearchsEstimate**](docs/AppsAPI.md#appsearchsestimate) | **Get** /apps/{app}/searchs-estimate | 获取搜索流量包使用配额信息
*AppsAPI* | [**AppSetTrigger**](docs/AppsAPI.md#appsettrigger) | **Put** /apps/{app}/trigger | 修改应用的触发器信息
*AppsAPI* | [**AppTokens**](docs/AppsAPI.md#apptokens) | **Get** /apps/{app}/tokens | 获取 Access Token 列表
*AppsAPI* | [**AppTransfer**](docs/AppsAPI.md#apptransfer) | **Post** /apps/{app}/transfer | 转让应用给他人
*AppsAPI* | [**AppTrigger**](docs/AppsAPI.md#apptrigger) | **Get** /apps/{app}/trigger | 获取应用触发器详情
*AppsAPI* | [**AppTriggerLogs**](docs/AppsAPI.md#apptriggerlogs) | **Get** /apps/{app}/trigger-logs | 获取应用触发日志列表
*AppsAPI* | [**AppUpdate**](docs/AppsAPI.md#appupdate) | **Put** /apps/{app} | 修改应用的基本信息
*AppsAPI* | [**AppUpdateAccessToken**](docs/AppsAPI.md#appupdateaccesstoken) | **Put** /apps/{app}/tokens | 修改 Access Token
*AppsAPI* | [**AppUpdateMentor**](docs/AppsAPI.md#appupdatementor) | **Patch** /apps/{app}/mentors | 修改成员备注和权限
*AppsAPI* | [**AppUpdateMentorOptions**](docs/AppsAPI.md#appupdatementoroptions) | **Post** /apps/{app}/mentors-options | 修改应用成员自身的设置（包括应用名备注，是否接收报告等）
*AppsAPI* | [**AppUpdateMentorReportOptions**](docs/AppsAPI.md#appupdatementorreportoptions) | **Patch** /apps/{app}/mentors-options | 修改应用成员自身的通知设置
*AppsAPI* | [**AppUpdateOauthApp**](docs/AppsAPI.md#appupdateoauthapp) | **Patch** /apps/{app}/oauth | 修改第三方应用信息
*AppsAPI* | [**AppUpdateOauthAppLogo**](docs/AppsAPI.md#appupdateoauthapplogo) | **Put** /apps/{app}/oauth | 修改三方应用图标
*AppsAPI* | [**AppUpdateStatus**](docs/AppsAPI.md#appupdatestatus) | **Patch** /apps/{app} | 修改应用的状态
*FieldsAPI* | [**IndexFields**](docs/FieldsAPI.md#indexfields) | **Get** /indices/{app}/{index}/fields | 获取索引字段映射详情
*FieldsAPI* | [**IndexUpdateFields**](docs/FieldsAPI.md#indexupdatefields) | **Post** /indices/{app}/{index}/fields | 更新索引的字段映射
*FieldsAPI* | [**IndexUpdateHtmlStripFields**](docs/FieldsAPI.md#indexupdatehtmlstripfields) | **Patch** /indices/{app}/{index}/fields | 更新索引的HTML过滤字段列表
*FieldsAPI* | [**IndexValuesOfField**](docs/FieldsAPI.md#indexvaluesoffield) | **Get** /indices/{app}/{index}/fields/{field} | 获取索引字段的所有值列表
*GlobalAPI* | [**Json**](docs/GlobalAPI.md#json) | **Get** /json | 接口定义(JSON)
*GlobalAPI* | [**OptionsGet**](docs/GlobalAPI.md#optionsget) | **Get** /options | 系统全局配置接口
*GlobalAPI* | [**StatusDatabase**](docs/GlobalAPI.md#statusdatabase) | **Get** /status/database | 数据库服务状态测试
*GlobalAPI* | [**StatusEngine**](docs/GlobalAPI.md#statusengine) | **Get** /status/engine | 搜索引擎状态测试
*GlobalAPI* | [**Welcome**](docs/GlobalAPI.md#welcome) | **Get** / | 接口欢迎信息
*GlobalAPI* | [**Yaml**](docs/GlobalAPI.md#yaml) | **Get** /yaml | 接口定义(YAML)
*IndicesAPI* | [**IndexCleanup**](docs/IndicesAPI.md#indexcleanup) | **Post** /indices/{app}/{index}/cleanup | 清空索引记录
*IndicesAPI* | [**IndexCopyTo**](docs/IndicesAPI.md#indexcopyto) | **Post** /indices/{app}/{index}/copyto | 导出索引数据
*IndicesAPI* | [**IndexCreate**](docs/IndicesAPI.md#indexcreate) | **Post** /indices/{app} | 创建索引
*IndicesAPI* | [**IndexCreateTemplate**](docs/IndicesAPI.md#indexcreatetemplate) | **Post** /indices/templates | 创建索引模板
*IndicesAPI* | [**IndexDelete**](docs/IndicesAPI.md#indexdelete) | **Delete** /indices/{app}/{index} | 删除索引
*IndicesAPI* | [**IndexDeleteCrawlerTask**](docs/IndicesAPI.md#indexdeletecrawlertask) | **Delete** /indices/{app}/{index}/crawler-settings | 删除索引的数据爬取任务
*IndicesAPI* | [**IndexDeleteTemplate**](docs/IndicesAPI.md#indexdeletetemplate) | **Delete** /indices/templates | 删除索引模板
*IndicesAPI* | [**IndexExport**](docs/IndicesAPI.md#indexexport) | **Post** /indices/{app}/{index}/export | 导出索引数据
*IndicesAPI* | [**IndexFlush**](docs/IndicesAPI.md#indexflush) | **Post** /indices/{app}/{index}/flush | 刷新索引数据，主要用于将内存中的索引数据写入磁盘
*IndicesAPI* | [**IndexFlushSettings**](docs/IndicesAPI.md#indexflushsettings) | **Put** /indices/{app}/{index}/settings | 写入设置信息到索引
*IndicesAPI* | [**IndexGet**](docs/IndicesAPI.md#indexget) | **Get** /indices/{app}/{index} | 获取单个索引详情
*IndicesAPI* | [**IndexGetCrawlerLogs**](docs/IndicesAPI.md#indexgetcrawlerlogs) | **Get** /indices/{app}/{index}/crawler-logs | 获取索引的爬虫任务的爬取日志
*IndicesAPI* | [**IndexGetCrawlerTask**](docs/IndicesAPI.md#indexgetcrawlertask) | **Get** /indices/{app}/{index}/crawler-settings | 获取索引的爬虫任务设定
*IndicesAPI* | [**IndexGetFilterSettings**](docs/IndicesAPI.md#indexgetfiltersettings) | **Get** /indices/{app}/{index}/filter-settings | 获取索引设置信息
*IndicesAPI* | [**IndexGetSettings**](docs/IndicesAPI.md#indexgetsettings) | **Get** /indices/{app}/{index}/settings | 获取索引设置信息
*IndicesAPI* | [**IndexList**](docs/IndicesAPI.md#indexlist) | **Get** /indices/{app} | 获取应用的索引列表
*IndicesAPI* | [**IndexListTemplates**](docs/IndicesAPI.md#indexlisttemplates) | **Get** /indices/templates | 获取所有可用的索引模板
*IndicesAPI* | [**IndexPrefetch**](docs/IndicesAPI.md#indexprefetch) | **Get** /indices/crawler | 获取目标网站内容预览
*IndicesAPI* | [**IndexRebuild**](docs/IndicesAPI.md#indexrebuild) | **Post** /indices/{app}/{index}/rebuild | 重建索引数据
*IndicesAPI* | [**IndexRebuildTask**](docs/IndicesAPI.md#indexrebuildtask) | **Get** /indices/{app}/{index}/rebuild | 获取重建索引任务的详情
*IndicesAPI* | [**IndexSubmitCrawlerTask**](docs/IndicesAPI.md#indexsubmitcrawlertask) | **Post** /indices/{app}/{index}/crawler-settings | 提交或者更新索引的数据爬取任务
*IndicesAPI* | [**IndexTasks**](docs/IndicesAPI.md#indextasks) | **Get** /indices/{app}/tasks | 获取该索引在后台的任务列表
*IndicesAPI* | [**IndexUpdate**](docs/IndicesAPI.md#indexupdate) | **Put** /indices/{app}/{index} | 修改索引
*IndicesAPI* | [**IndexUpdateSettings**](docs/IndicesAPI.md#indexupdatesettings) | **Post** /indices/{app}/{index}/settings | 更新索引设置信息
*IndicesAPI* | [**IndexUpdateTemplate**](docs/IndicesAPI.md#indexupdatetemplate) | **Put** /indices/templates | 修改索引模板
*IndicesAPI* | [**SynonymsAdd**](docs/IndicesAPI.md#synonymsadd) | **Post** /indices/{app}/{index}/synonyms | 添加同义词
*IndicesAPI* | [**SynonymsDelete**](docs/IndicesAPI.md#synonymsdelete) | **Delete** /indices/{app}/{index}/synonyms | 删除同义词
*IndicesAPI* | [**SynonymsEnable**](docs/IndicesAPI.md#synonymsenable) | **Patch** /indices/{app}/{index}/synonyms | 启用禁用同义词
*IndicesAPI* | [**SynonymsFlush**](docs/IndicesAPI.md#synonymsflush) | **Post** /indices/{app}/{index}/synonyms-flush | 将同义词更新到搜索引擎的同义词表
*IndicesAPI* | [**SynonymsImport**](docs/IndicesAPI.md#synonymsimport) | **Post** /indices/{app}/{index}/synonyms-import | 导入同义词
*IndicesAPI* | [**SynonymsList**](docs/IndicesAPI.md#synonymslist) | **Get** /indices/{app}/{index}/synonyms | 获取索引的所有同义词
*IndicesAPI* | [**SynonymsUpdate**](docs/IndicesAPI.md#synonymsupdate) | **Put** /indices/{app}/{index}/synonyms | 修改同义词
*MessageAPI* | [**MessageDelete**](docs/MessageAPI.md#messagedelete) | **Delete** /accounts/message | 删除消息
*MessageAPI* | [**MessageFeedback**](docs/MessageAPI.md#messagefeedback) | **Post** /accounts/feedback | 反馈意见
*MessageAPI* | [**MessageList**](docs/MessageAPI.md#messagelist) | **Get** /accounts/message | 获取我相关的消息信息，包括未读消息数量、最新消息等
*MessageAPI* | [**MessageRead**](docs/MessageAPI.md#messageread) | **Patch** /accounts/message | 标识消息为已读
*MessageAPI* | [**MessageSend**](docs/MessageAPI.md#messagesend) | **Post** /accounts/message | 发送消息
*PaymentAPI* | [**PaymentAlipay**](docs/PaymentAPI.md#paymentalipay) | **Post** /payment/alipay | 接受支付宝的支付结果
*PaymentAPI* | [**PaymentAlipayReturn**](docs/PaymentAPI.md#paymentalipayreturn) | **Get** /payment/alipay | 支付宝平台支付完毕后调整到该接口
*PaymentAPI* | [**PaymentApplyInvoice**](docs/PaymentAPI.md#paymentapplyinvoice) | **Post** /payment/{app}/invoices | 申请发票
*PaymentAPI* | [**PaymentBeginPay**](docs/PaymentAPI.md#paymentbeginpay) | **Post** /payment/{app}/orders/{ident} | 支付订单
*PaymentAPI* | [**PaymentBuy**](docs/PaymentAPI.md#paymentbuy) | **Put** /payment/{app}/orders | 下单购买
*PaymentAPI* | [**PaymentDeleteInvoice**](docs/PaymentAPI.md#paymentdeleteinvoice) | **Delete** /payment/{app}/invoices | 删除发票
*PaymentAPI* | [**PaymentDeleteOrder**](docs/PaymentAPI.md#paymentdeleteorder) | **Delete** /payment/{app}/orders/{ident} | 取消订单
*PaymentAPI* | [**PaymentInvoices**](docs/PaymentAPI.md#paymentinvoices) | **Get** /payment/{app}/invoices | 获取发票列表
*PaymentAPI* | [**PaymentOrder**](docs/PaymentAPI.md#paymentorder) | **Get** /payment/{app}/orders/{ident} | 获取订单详情
*PaymentAPI* | [**PaymentOrders**](docs/PaymentAPI.md#paymentorders) | **Post** /payment/{app}/orders | 订单列表
*PaymentAPI* | [**PaymentOrdersWithoutInvoice**](docs/PaymentAPI.md#paymentorderswithoutinvoice) | **Get** /payment/{app}/orders_without_invoice | 获取未曾开票的订单列表
*PaymentAPI* | [**PaymentPrice**](docs/PaymentAPI.md#paymentprice) | **Get** /payment/{app}/price | 获取套餐价格
*PaymentAPI* | [**PaymentReceipt**](docs/PaymentAPI.md#paymentreceipt) | **Get** /payment/{app}/orders | 获取订单回执图片
*PaymentAPI* | [**PaymentRequestContact**](docs/PaymentAPI.md#paymentrequestcontact) | **Post** /payment/{app}/contact | 联系销售获取私有化报价
*PaymentAPI* | [**PaymentUploadReceipt**](docs/PaymentAPI.md#paymentuploadreceipt) | **Put** /payment/{app}/orders/{ident} | 上传转账回执
*PaymentAPI* | [**PaymentWepay**](docs/PaymentAPI.md#paymentwepay) | **Post** /payment/wepay | 接受微信支付的支付结果
*QueriesAPI* | [**QueryAnalyze**](docs/QueriesAPI.md#queryanalyze) | **Post** /queries/{app}/analyze | 分词测试
*QueriesAPI* | [**QueryCopy**](docs/QueriesAPI.md#querycopy) | **Post** /queries/{app}/copy | 复制指定查询并创建新查询
*QueriesAPI* | [**QueryCopyToQuery**](docs/QueriesAPI.md#querycopytoquery) | **Put** /queries/{app}/copy | 复制查询到已有查询
*QueriesAPI* | [**QueryCreate**](docs/QueriesAPI.md#querycreate) | **Post** /queries/{app} | 创建搜索
*QueriesAPI* | [**QueryCreateKeywordBindings**](docs/QueriesAPI.md#querycreatekeywordbindings) | **Post** /queries/{app}/keyword-bindings | 创建新的关键词文档绑定
*QueriesAPI* | [**QueryCreateVariable**](docs/QueriesAPI.md#querycreatevariable) | **Post** /queries/{app}/variables | 创建新的预定义查询变量
*QueriesAPI* | [**QueryDelete**](docs/QueriesAPI.md#querydelete) | **Delete** /queries/{app} | 删除搜索
*QueriesAPI* | [**QueryDeleteKeywordBindings**](docs/QueriesAPI.md#querydeletekeywordbindings) | **Delete** /queries/{app}/keyword-bindings | 删除关键词文档绑定
*QueriesAPI* | [**QueryDeleteNodePositions**](docs/QueriesAPI.md#querydeletenodepositions) | **Delete** /queries/{app}/node-positions | 清除查询条件的节点位置信息
*QueriesAPI* | [**QueryDeleteVariable**](docs/QueriesAPI.md#querydeletevariable) | **Delete** /queries/{app}/variables | 删除预定义查询变量
*QueriesAPI* | [**QueryFields**](docs/QueriesAPI.md#queryfields) | **Get** /queries/{app}/fields | 获取查询关联的所有索引的字段信息
*QueriesAPI* | [**QueryGet**](docs/QueriesAPI.md#queryget) | **Get** /queries/{app}/{query} | 获取查询的详情
*QueriesAPI* | [**QueryGetNodePositions**](docs/QueriesAPI.md#querygetnodepositions) | **Get** /queries/{app}/node-positions | 获取查询条件的节点位置信息
*QueriesAPI* | [**QueryGetRecord**](docs/QueriesAPI.md#querygetrecord) | **Get** /queries/{app}/record | 获取记录的详情
*QueriesAPI* | [**QueryKeywordBindings**](docs/QueriesAPI.md#querykeywordbindings) | **Get** /queries/{app}/keyword-bindings | 获取查询的关键词文档绑定列表
*QueriesAPI* | [**QueryList**](docs/QueriesAPI.md#querylist) | **Get** /queries/{app} | 获取应用下所有索引下的查询列表（按索引进行分组）
*QueriesAPI* | [**QueryProfile**](docs/QueriesAPI.md#queryprofile) | **Get** /queries/{app}/profiler | 获取搜索诊断信息
*QueriesAPI* | [**QueryRecordsOfKeywordBinding**](docs/QueriesAPI.md#queryrecordsofkeywordbinding) | **Get** /queries/{app}/keyword-bindings-records | 获取关键词绑定对应的记录列表
*QueriesAPI* | [**QuerySaveIntelligentMappings**](docs/QueriesAPI.md#querysaveintelligentmappings) | **Put** /queries/{app}/intelligent-mappings | 设置索引智能匹配字段
*QueriesAPI* | [**QuerySaveNodePositions**](docs/QueriesAPI.md#querysavenodepositions) | **Put** /queries/{app}/node-positions | 保存查询条件的节点位置信息
*QueriesAPI* | [**QuerySearch**](docs/QueriesAPI.md#querysearch) | **Get** /queries/{app}/search | 搜索测试
*QueriesAPI* | [**QuerySource**](docs/QueriesAPI.md#querysource) | **Post** /queries/{app}/{query} | 获取最终查询的源码(JSON)
*QueriesAPI* | [**QuerySuggest**](docs/QueriesAPI.md#querysuggest) | **Get** /queries/{app}/suggest | 获取搜索建议列表
*QueriesAPI* | [**QueryTestIntelligentMappings**](docs/QueriesAPI.md#querytestintelligentmappings) | **Post** /queries/{app}/intelligent-mappings | 测试索引智能匹配字段
*QueriesAPI* | [**QueryUpdate**](docs/QueriesAPI.md#queryupdate) | **Put** /queries/{app} | 修改查询
*QueriesAPI* | [**QueryUpdateKeywordBindings**](docs/QueriesAPI.md#queryupdatekeywordbindings) | **Patch** /queries/{app}/keyword-bindings | 修改关键词文档绑定
*QueriesAPI* | [**QueryUpdateSettings**](docs/QueriesAPI.md#queryupdatesettings) | **Post** /queries/{app}/settings | 更改查询的设置项
*QueriesAPI* | [**QueryUpdateVariable**](docs/QueriesAPI.md#queryupdatevariable) | **Patch** /queries/{app}/variables | 修改预定义查询变量
*QueriesAPI* | [**QueryValidate**](docs/QueriesAPI.md#queryvalidate) | **Get** /queries/{app}/validate | 获取搜索验证结果
*QueriesAPI* | [**QueryValidateAggregation**](docs/QueriesAPI.md#queryvalidateaggregation) | **Post** /queries/{app}/validate-aggregation | 验证聚合定义是否正确
*QueriesAPI* | [**QueryValidateQuery**](docs/QueriesAPI.md#queryvalidatequery) | **Post** /queries/{app}/validate-query | 验证聚合定义是否正确
*QueriesAPI* | [**QueryValidateScriptField**](docs/QueriesAPI.md#queryvalidatescriptfield) | **Post** /queries/{app}/validate-script-field | 验证脚本字段是否正确
*QueriesAPI* | [**QueryValidateScriptScore**](docs/QueriesAPI.md#queryvalidatescriptscore) | **Post** /queries/{app}/validate-script-score | 验证脚本字段是否正确
*QueriesAPI* | [**QueryValidateSuggestion**](docs/QueriesAPI.md#queryvalidatesuggestion) | **Post** /queries/{app}/validate-suggest | 验证建议是否正确
*QueriesAPI* | [**QueryVariables**](docs/QueriesAPI.md#queryvariables) | **Get** /queries/{app}/variables | 获取应用的预定义查询变量列表
*RecommendAPI* | [**RecommendClick**](docs/RecommendAPI.md#recommendclick) | **Post** /recommend/{ident}/click | 推荐结果点击行为收集
*RecommendAPI* | [**RecommendCreate**](docs/RecommendAPI.md#recommendcreate) | **Post** /recommends/{app} | 创建新的推荐
*RecommendAPI* | [**RecommendDelete**](docs/RecommendAPI.md#recommenddelete) | **Delete** /recommends/{app} | 删除推荐
*RecommendAPI* | [**RecommendDetail**](docs/RecommendAPI.md#recommenddetail) | **Get** /recommend/{ident} | 获取推荐的记录列表
*RecommendAPI* | [**RecommendFetch**](docs/RecommendAPI.md#recommendfetch) | **Post** /recommend/{ident} | 获取推荐的记录列表
*RecommendAPI* | [**RecommendList**](docs/RecommendAPI.md#recommendlist) | **Get** /recommends/{app} | 获取已定义的推荐列表
*RecommendAPI* | [**RecommendUpdate**](docs/RecommendAPI.md#recommendupdate) | **Put** /recommends/{app} | 更新推荐信息
*RecordsAPI* | [**RecordDelete**](docs/RecordsAPI.md#recorddelete) | **Delete** /records/{app}/{index} | 删除记录数据
*RecordsAPI* | [**RecordDeleteByQuery**](docs/RecordsAPI.md#recorddeletebyquery) | **Delete** /records/{app}/{index}/bulk | 批量删除记录数据(delete_by_query)，该接口传递查询参数获取要删除的记录并逐一删除
*RecordsAPI* | [**RecordGet**](docs/RecordsAPI.md#recordget) | **Get** /records/{app}/{index} | 获取单条记录详情
*RecordsAPI* | [**RecordList**](docs/RecordsAPI.md#recordlist) | **Post** /records/{app}/{index} | 获取索引记录列表
*RecordsAPI* | [**RecordPush**](docs/RecordsAPI.md#recordpush) | **Put** /records/{app}/{index} | 插入或者更新索引数据
*RecordsAPI* | [**RecordUpdateByQuery**](docs/RecordsAPI.md#recordupdatebyquery) | **Patch** /records/{app}/{index}/bulk | 批量修改记录数据(update_by_query)，该接口传递查询参数获取要更新的记录，并使用 body 中的对象进行记录合并更新
*RecordsAPI* | [**RecordUpload**](docs/RecordsAPI.md#recordupload) | **Post** /records/{app}/{index}/bulk | 上传记录
*RecordsAPI* | [**RecordUploadOld**](docs/RecordsAPI.md#recorduploadold) | **Post** /records/{app}/{index}/upload | 上传记录，该接口已经废弃，请使用 /records/{app}/{index}/bulk 接口
*SearchAPI* | [**SearchClick**](docs/SearchAPI.md#searchclick) | **Post** /search/widget/{widget}/click | 搜索结果点击行为收集
*SearchAPI* | [**SearchHistories**](docs/SearchAPI.md#searchhistories) | **Get** /search/widget/{widget}/histories | 获取当前搜索用户的最新搜索记录
*SearchAPI* | [**SearchLogs**](docs/SearchAPI.md#searchlogs) | **Get** /apps/{app}/logs-searchs | 获取搜索日志
*SearchAPI* | [**SearchQueryClick**](docs/SearchAPI.md#searchqueryclick) | **Post** /search/query/{query}/click | 搜索结果点击行为收集
*SearchAPI* | [**SearchQueryHistories**](docs/SearchAPI.md#searchqueryhistories) | **Get** /search/query/{query}/histories | 获取当前搜索用户的最新搜索记录
*SearchAPI* | [**SearchQueryHotWords**](docs/SearchAPI.md#searchqueryhotwords) | **Get** /search/query/{query}/hotwords | 获取查询相关热词
*SearchAPI* | [**SearchQueryRepeatScroll**](docs/SearchAPI.md#searchqueryrepeatscroll) | **Post** /search/scroll/{query} | 读取滚动搜索结果
*SearchAPI* | [**SearchQueryScroll**](docs/SearchAPI.md#searchqueryscroll) | **Get** /search/scroll/{query} | 基于查询的滚动搜索
*SearchAPI* | [**SearchQuerySearch**](docs/SearchAPI.md#searchquerysearch) | **Get** /search/query/{query} | 基于查询的公开搜索
*SearchAPI* | [**SearchWidgetAutoComplete**](docs/SearchAPI.md#searchwidgetautocomplete) | **Get** /search/widget/{widget}/autocomplete | 基于组件的搜索词自动完成
*SearchAPI* | [**SearchWidgetHotWords**](docs/SearchAPI.md#searchwidgethotwords) | **Get** /search/widget/{widget}/hotwords | 获取组件搜索的相关热词
*SearchAPI* | [**SearchWidgetSearch**](docs/SearchAPI.md#searchwidgetsearch) | **Get** /search/widget/{widget} | 基于组件的公开搜索
*StatsAPI* | [**StatsRecomms**](docs/StatsAPI.md#statsrecomms) | **Get** /stats/{app}/recomms | 获取推荐日志的汇总信息
*StatsAPI* | [**StatsSearchs**](docs/StatsAPI.md#statssearchs) | **Get** /stats/{app}/searchs | 获取搜索日志的汇总信息
*StatsAPI* | [**StatsTopClicks**](docs/StatsAPI.md#statstopclicks) | **Get** /stats/{app}/top-clicks | 获取点击排行榜
*StatsAPI* | [**StatsWidgets**](docs/StatsAPI.md#statswidgets) | **Get** /stats/{app}/widgets | 获取模板与组件的统计信息
*WidgetsAPI* | [**WidgetCopy**](docs/WidgetsAPI.md#widgetcopy) | **Post** /widget/{app}/copy | 复制指定组件并创建新组件
*WidgetsAPI* | [**WidgetCopyToWidget**](docs/WidgetsAPI.md#widgetcopytowidget) | **Put** /widget/{app}/copy | 复制组件到已有组件
*WidgetsAPI* | [**WidgetCreate**](docs/WidgetsAPI.md#widgetcreate) | **Post** /widgets/{app} | 创建组件
*WidgetsAPI* | [**WidgetDelete**](docs/WidgetsAPI.md#widgetdelete) | **Delete** /widgets/{app}/{widget} | 删除组件
*WidgetsAPI* | [**WidgetDeleteLogo**](docs/WidgetsAPI.md#widgetdeletelogo) | **Delete** /widgets/{app}/{widget}/logo | 删除组件 Logo
*WidgetsAPI* | [**WidgetDetail**](docs/WidgetsAPI.md#widgetdetail) | **Get** /widget/{ident} | 获取UI组件的所有相关信息
*WidgetsAPI* | [**WidgetDownload**](docs/WidgetsAPI.md#widgetdownload) | **Get** /widgets/{app}/{widget}/download | 下载组件应用源码
*WidgetsAPI* | [**WidgetGet**](docs/WidgetsAPI.md#widgetget) | **Get** /widgets/{app}/{widget} | 获取组件的详情
*WidgetsAPI* | [**WidgetList**](docs/WidgetsAPI.md#widgetlist) | **Get** /widgets/{app} | 获取应用的组件列表
*WidgetsAPI* | [**WidgetLogo**](docs/WidgetsAPI.md#widgetlogo) | **Post** /widgets/{app}/{widget}/logo | 设置组件 Logo
*WidgetsAPI* | [**WidgetUpdate**](docs/WidgetsAPI.md#widgetupdate) | **Put** /widgets/{app}/{widget} | 修改组件
*WidgetsAPI* | [**WidgetUpdateSettings**](docs/WidgetsAPI.md#widgetupdatesettings) | **Patch** /widgets/{app}/{widget} | 修改组件设置参数


## Documentation For Models

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


## Documentation For Authorization


Authentication schemes defined for the API:
### TokenAuth

- **Type**: HTTP Bearer token authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```


## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`

## Author

indexea.com@gmail.com