@indexea/sdk/dist/apis/QueriesApi.d.ts

Indexea JavaScript SDK (indexea.com)

/**
 * Indexea OpenAPI
 * 这是 Indexea 搜索服务平台的 OpenAPI，用于描述平台的所有接口信息，你可以通过这个页面来了解和在线验证平台的所有接口信息。  ### Errors  本 API 使用标准的 HTTP 状态码来指示操作成功或者失败，如果失败将会在 body 中以 JSON 格式提供详细的错误信息，如下所示：  ``` {   \"error\": 404,   \"message\": \"page not found\" } ```
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: indexea.com@gmail.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { AnalyzeObject, AnalyzeToken, IndexFieldBean, IntelligentMapping, KeywordBindingBean, QueryBean, QueryForm, QueryVariableBean } from '../models';
export interface QueryAnalyzeRequest {
    app: string;
    analyzeObject: AnalyzeObject;
    index?: number;
}
export interface QueryBulkUpdateSettingsRequest {
    app: string;
    query: number;
    body: object;
}
export interface QueryCopyRequest {
    app: string;
    query: number;
}
export interface QueryCopyToQueryRequest {
    app: string;
    query: number;
    to: number;
}
export interface QueryCreateRequest {
    app: string;
    queryForm: QueryForm;
}
export interface QueryCreateKeywordBindingsRequest {
    app: string;
    query: number;
    keywordBindingBean: KeywordBindingBean;
}
export interface QueryCreateVariableRequest {
    app: string;
    queryVariableBean: QueryVariableBean;
}
export interface QueryDeleteRequest {
    app: string;
    query: number;
}
export interface QueryDeleteKeywordBindingsRequest {
    app: string;
    query: number;
    id: number;
}
export interface QueryDeleteNodePositionsRequest {
    app: string;
    query: number;
}
export interface QueryDeleteVariableRequest {
    app: string;
    id: number;
}
export interface QueryFieldsRequest {
    app: string;
    query: number;
}
export interface QueryGetRequest {
    app: string;
    query: number;
}
export interface QueryGetNodePositionsRequest {
    app: string;
    query: number;
}
export interface QueryGetRecordRequest {
    app: string;
    query: number;
    id: string;
}
export interface QueryKeywordBindingsRequest {
    app: string;
    query: number;
}
export interface QueryListRequest {
    app: string;
    index?: number;
}
export interface QueryProfileRequest {
    app: string;
    query: number;
    q?: string;
}
export interface QueryRecordsOfKeywordBindingRequest {
    app: string;
    id: number;
}
export interface QuerySaveIntelligentMappingsRequest {
    app: string;
    query: number;
    fields?: Array<string>;
}
export interface QuerySaveNodePositionsRequest {
    app: string;
    query: number;
    body: object;
}
export interface QuerySearchRequest {
    app: string;
    query: number;
    q?: string;
    from?: number;
    size?: number;
    params?: {
        [key: string]: string;
    };
}
export interface QuerySourceRequest {
    app: string;
    query: number;
    q?: string;
}
export interface QuerySuggestRequest {
    app: string;
    query: number;
    q: string;
}
export interface QueryTestIntelligentMappingsRequest {
    app: string;
    query: number;
    q: string;
    fields?: Array<string>;
}
export interface QueryUpdateRequest {
    app: string;
    query: number;
    queryForm: QueryForm;
}
export interface QueryUpdateKeywordBindingsRequest {
    app: string;
    query: number;
    keywordBindingBean: KeywordBindingBean;
}
export interface QueryUpdateSettingsRequest {
    app: string;
    query: number;
    name: string;
    value: string;
    type: QueryUpdateSettingsTypeEnum;
}
export interface QueryUpdateVariableRequest {
    app: string;
    id: number;
    queryVariableBean: QueryVariableBean;
}
export interface QueryValidateRequest {
    app: string;
    query: number;
}
export interface QueryValidateAggregationRequest {
    app: string;
    query: number;
    body: object;
}
export interface QueryValidateQueryRequest {
    app: string;
    query: number;
    body: object;
}
export interface QueryValidateScriptFieldRequest {
    app: string;
    body: object;
    query?: number;
    index?: number;
}
export interface QueryValidateScriptScoreRequest {
    app: string;
    query: number;
    body: object;
}
export interface QueryValidateSuggestionRequest {
    app: string;
    query: number;
    body: object;
}
export interface QueryVariablesRequest {
    app: string;
}
/**
 *
 */
export declare class QueriesApi extends runtime.BaseAPI {
    /**
     * 分词测试
     */
    queryAnalyzeRaw(requestParameters: QueryAnalyzeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AnalyzeToken>>>;
    /**
     * 分词测试
     */
    queryAnalyze(requestParameters: QueryAnalyzeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AnalyzeToken>>;
    /**
     * 批量修改查询的设置项
     */
    queryBulkUpdateSettingsRaw(requestParameters: QueryBulkUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 批量修改查询的设置项
     */
    queryBulkUpdateSettings(requestParameters: QueryBulkUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 复制指定查询并创建新查询
     */
    queryCopyRaw(requestParameters: QueryCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryBean>>;
    /**
     * 复制指定查询并创建新查询
     */
    queryCopy(requestParameters: QueryCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryBean>;
    /**
     * 复制查询到已有查询
     */
    queryCopyToQueryRaw(requestParameters: QueryCopyToQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 复制查询到已有查询
     */
    queryCopyToQuery(requestParameters: QueryCopyToQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 创建搜索
     */
    queryCreateRaw(requestParameters: QueryCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryBean>>;
    /**
     * 创建搜索
     */
    queryCreate(requestParameters: QueryCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryBean>;
    /**
     * 创建新的关键词文档绑定
     */
    queryCreateKeywordBindingsRaw(requestParameters: QueryCreateKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KeywordBindingBean>>;
    /**
     * 创建新的关键词文档绑定
     */
    queryCreateKeywordBindings(requestParameters: QueryCreateKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KeywordBindingBean>;
    /**
     *
     * 创建新的预定义查询变量
     */
    queryCreateVariableRaw(requestParameters: QueryCreateVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryVariableBean>>;
    /**
     *
     * 创建新的预定义查询变量
     */
    queryCreateVariable(requestParameters: QueryCreateVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryVariableBean>;
    /**
     * 删除搜索
     */
    queryDeleteRaw(requestParameters: QueryDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 删除搜索
     */
    queryDelete(requestParameters: QueryDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 删除关键词文档绑定
     */
    queryDeleteKeywordBindingsRaw(requestParameters: QueryDeleteKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 删除关键词文档绑定
     */
    queryDeleteKeywordBindings(requestParameters: QueryDeleteKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 清除查询条件的节点位置信息
     */
    queryDeleteNodePositionsRaw(requestParameters: QueryDeleteNodePositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 清除查询条件的节点位置信息
     */
    queryDeleteNodePositions(requestParameters: QueryDeleteNodePositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     *
     * 删除预定义查询变量
     */
    queryDeleteVariableRaw(requestParameters: QueryDeleteVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     *
     * 删除预定义查询变量
     */
    queryDeleteVariable(requestParameters: QueryDeleteVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 获取查询关联的所有索引的字段信息
     */
    queryFieldsRaw(requestParameters: QueryFieldsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IndexFieldBean>>>;
    /**
     * 获取查询关联的所有索引的字段信息
     */
    queryFields(requestParameters: QueryFieldsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IndexFieldBean>>;
    /**
     * 获取查询的详情
     */
    queryGetRaw(requestParameters: QueryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryBean>>;
    /**
     * 获取查询的详情
     */
    queryGet(requestParameters: QueryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryBean>;
    /**
     * 获取查询条件的节点位置信息
     */
    queryGetNodePositionsRaw(requestParameters: QueryGetNodePositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 获取查询条件的节点位置信息
     */
    queryGetNodePositions(requestParameters: QueryGetNodePositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 获取记录的详情
     */
    queryGetRecordRaw(requestParameters: QueryGetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 获取记录的详情
     */
    queryGetRecord(requestParameters: QueryGetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 获取查询的关键词文档绑定列表
     */
    queryKeywordBindingsRaw(requestParameters: QueryKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<KeywordBindingBean>>>;
    /**
     * 获取查询的关键词文档绑定列表
     */
    queryKeywordBindings(requestParameters: QueryKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<KeywordBindingBean>>;
    /**
     * 获取应用下所有索引下的查询列表（按索引进行分组）
     */
    queryListRaw(requestParameters: QueryListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<QueryBean>>>;
    /**
     * 获取应用下所有索引下的查询列表（按索引进行分组）
     */
    queryList(requestParameters: QueryListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<QueryBean>>;
    /**
     * 获取搜索诊断信息
     */
    queryProfileRaw(requestParameters: QueryProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 获取搜索诊断信息
     */
    queryProfile(requestParameters: QueryProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 获取关键词绑定对应的记录列表
     */
    queryRecordsOfKeywordBindingRaw(requestParameters: QueryRecordsOfKeywordBindingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<object>>>;
    /**
     * 获取关键词绑定对应的记录列表
     */
    queryRecordsOfKeywordBinding(requestParameters: QueryRecordsOfKeywordBindingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>>;
    /**
     * 设置索引智能匹配字段
     */
    querySaveIntelligentMappingsRaw(requestParameters: QuerySaveIntelligentMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 设置索引智能匹配字段
     */
    querySaveIntelligentMappings(requestParameters: QuerySaveIntelligentMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 保存查询条件的节点位置信息
     */
    querySaveNodePositionsRaw(requestParameters: QuerySaveNodePositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 保存查询条件的节点位置信息
     */
    querySaveNodePositions(requestParameters: QuerySaveNodePositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 该接口主要用于定制查询的测试，必须授权才能访问
     * 搜索测试
     */
    querySearchRaw(requestParameters: QuerySearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 该接口主要用于定制查询的测试，必须授权才能访问
     * 搜索测试
     */
    querySearch(requestParameters: QuerySearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 获取最终查询的源码(JSON)
     */
    querySourceRaw(requestParameters: QuerySourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 获取最终查询的源码(JSON)
     */
    querySource(requestParameters: QuerySourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 获取搜索建议列表
     */
    querySuggestRaw(requestParameters: QuerySuggestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<object>>>;
    /**
     * 获取搜索建议列表
     */
    querySuggest(requestParameters: QuerySuggestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>>;
    /**
     * 测试索引智能匹配字段
     */
    queryTestIntelligentMappingsRaw(requestParameters: QueryTestIntelligentMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IntelligentMapping>>>;
    /**
     * 测试索引智能匹配字段
     */
    queryTestIntelligentMappings(requestParameters: QueryTestIntelligentMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IntelligentMapping>>;
    /**
     * 修改查询
     */
    queryUpdateRaw(requestParameters: QueryUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryBean>>;
    /**
     * 修改查询
     */
    queryUpdate(requestParameters: QueryUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryBean>;
    /**
     * 修改关键词文档绑定
     */
    queryUpdateKeywordBindingsRaw(requestParameters: QueryUpdateKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KeywordBindingBean>>;
    /**
     * 修改关键词文档绑定
     */
    queryUpdateKeywordBindings(requestParameters: QueryUpdateKeywordBindingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KeywordBindingBean>;
    /**
     * 更改查询的设置项
     */
    queryUpdateSettingsRaw(requestParameters: QueryUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 更改查询的设置项
     */
    queryUpdateSettings(requestParameters: QueryUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     *
     * 修改预定义查询变量
     */
    queryUpdateVariableRaw(requestParameters: QueryUpdateVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryVariableBean>>;
    /**
     *
     * 修改预定义查询变量
     */
    queryUpdateVariable(requestParameters: QueryUpdateVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryVariableBean>;
    /**
     * 获取搜索验证结果
     */
    queryValidateRaw(requestParameters: QueryValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 获取搜索验证结果
     */
    queryValidate(requestParameters: QueryValidateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 验证聚合定义是否正确
     */
    queryValidateAggregationRaw(requestParameters: QueryValidateAggregationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 验证聚合定义是否正确
     */
    queryValidateAggregation(requestParameters: QueryValidateAggregationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 验证聚合定义是否正确
     */
    queryValidateQueryRaw(requestParameters: QueryValidateQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 验证聚合定义是否正确
     */
    queryValidateQuery(requestParameters: QueryValidateQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 验证脚本字段是否正确
     */
    queryValidateScriptFieldRaw(requestParameters: QueryValidateScriptFieldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 验证脚本字段是否正确
     */
    queryValidateScriptField(requestParameters: QueryValidateScriptFieldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 验证脚本字段是否正确
     */
    queryValidateScriptScoreRaw(requestParameters: QueryValidateScriptScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 验证脚本字段是否正确
     */
    queryValidateScriptScore(requestParameters: QueryValidateScriptScoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 验证建议是否正确
     */
    queryValidateSuggestionRaw(requestParameters: QueryValidateSuggestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 验证建议是否正确
     */
    queryValidateSuggestion(requestParameters: QueryValidateSuggestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     *
     * 获取应用的预定义查询变量列表
     */
    queryVariablesRaw(requestParameters: QueryVariablesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<QueryVariableBean>>>;
    /**
     *
     * 获取应用的预定义查询变量列表
     */
    queryVariables(requestParameters: QueryVariablesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<QueryVariableBean>>;
}
/**
 * @export
 */
export declare const QueryUpdateSettingsTypeEnum: {
    readonly Number: "number";
    readonly Bool: "bool";
    readonly String: "string";
};
export type QueryUpdateSettingsTypeEnum = typeof QueryUpdateSettingsTypeEnum[keyof typeof QueryUpdateSettingsTypeEnum];