@indexea/sdk/dist/apis/IndicesApi.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 { CrawlerLogs, CrawlerTask, IndexBean, IndexForm, IndexRebuildForm, IndexSettings, IndexTask, IndexTemplate, IndexTemplates, SynonymsBean } from '../models';
export interface IndexCleanupRequest {
    app: string;
    index: number;
    vcode: string;
}
export interface IndexCopyToRequest {
    app: string;
    index: number;
    name: string;
    fields: boolean;
    queries: boolean;
    records: boolean;
}
export interface IndexCreateRequest {
    app: string;
    indexForm: IndexForm;
}
export interface IndexCreateTemplateRequest {
    indexTemplate: IndexTemplate;
}
export interface IndexDeleteRequest {
    app: string;
    index: number;
    vcode: string;
}
export interface IndexDeleteCrawlerTaskRequest {
    app: string;
    index: number;
}
export interface IndexDeleteTemplateRequest {
    id: number;
}
export interface IndexExportRequest {
    app: string;
    index: number;
    format: IndexExportFormatEnum;
}
export interface IndexFlushRequest {
    app: string;
    index: number;
}
export interface IndexFlushSettingsRequest {
    app: string;
    index: number;
    type: string;
    password: string;
}
export interface IndexGetRequest {
    app: string;
    index: number;
}
export interface IndexGetCrawlerLogsRequest {
    app: string;
    index: number;
    from?: number;
    size?: number;
}
export interface IndexGetCrawlerTaskRequest {
    app: string;
    index: number;
}
export interface IndexGetFilterSettingsRequest {
    app: string;
    index: number;
    type: IndexGetFilterSettingsTypeEnum;
}
export interface IndexGetSettingsRequest {
    app: string;
    index: number;
    type: string;
}
export interface IndexListRequest {
    app: string;
    stat?: boolean;
}
export interface IndexListTemplatesRequest {
    from?: number;
    size?: number;
}
export interface IndexPrefetchRequest {
    type: string;
    url: string;
}
export interface IndexRebuildRequest {
    app: string;
    index: number;
    indexRebuildForm: IndexRebuildForm;
}
export interface IndexRebuildTaskRequest {
    app: string;
    index: number;
    taskId: number;
}
export interface IndexStatLogsRequest {
    app: string;
    index: number;
    interval: IndexStatLogsIntervalEnum;
    startDate?: Date;
    endDate?: Date;
}
export interface IndexSubmitCrawlerTaskRequest {
    app: string;
    index: number;
    crawlerTask: CrawlerTask;
}
export interface IndexTasksRequest {
    app: string;
}
export interface IndexUpdateRequest {
    app: string;
    index: number;
    indexForm: IndexForm;
}
export interface IndexUpdateSettingsRequest {
    app: string;
    index: number;
    type: string;
    body?: string;
}
export interface IndexUpdateTemplateRequest {
    indexTemplate: IndexTemplate;
}
export interface SynonymsAddRequest {
    app: string;
    index: number;
    synonymsBean: SynonymsBean;
}
export interface SynonymsDeleteRequest {
    app: string;
    index: number;
    id: number;
}
export interface SynonymsEnableRequest {
    app: string;
    index: number;
    id: number;
    enable?: boolean;
    all?: boolean;
}
export interface SynonymsFlushRequest {
    app: string;
    index: number;
    password: string;
}
export interface SynonymsImportRequest {
    app: string;
    index: number;
    action: number;
    synonymsBean: Array<SynonymsBean>;
}
export interface SynonymsListRequest {
    app: string;
    index: number;
    type?: number;
    from?: number;
    size?: number;
}
export interface SynonymsUpdateRequest {
    app: string;
    index: number;
    synonymsBean: SynonymsBean;
}
/**
 *
 */
export declare class IndicesApi extends runtime.BaseAPI {
    /**
     * 清空索引记录
     */
    indexCleanupRaw(requestParameters: IndexCleanupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 清空索引记录
     */
    indexCleanup(requestParameters: IndexCleanupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 导出索引数据
     */
    indexCopyToRaw(requestParameters: IndexCopyToRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexBean>>;
    /**
     * 导出索引数据
     */
    indexCopyTo(requestParameters: IndexCopyToRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexBean>;
    /**
     * 创建索引
     */
    indexCreateRaw(requestParameters: IndexCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexBean>>;
    /**
     * 创建索引
     */
    indexCreate(requestParameters: IndexCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexBean>;
    /**
     * 创建索引模板
     */
    indexCreateTemplateRaw(requestParameters: IndexCreateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexTemplate>>;
    /**
     * 创建索引模板
     */
    indexCreateTemplate(requestParameters: IndexCreateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexTemplate>;
    /**
     * 删除索引
     */
    indexDeleteRaw(requestParameters: IndexDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 删除索引
     */
    indexDelete(requestParameters: IndexDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 删除索引的数据爬取任务
     */
    indexDeleteCrawlerTaskRaw(requestParameters: IndexDeleteCrawlerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 删除索引的数据爬取任务
     */
    indexDeleteCrawlerTask(requestParameters: IndexDeleteCrawlerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 删除索引模板
     */
    indexDeleteTemplateRaw(requestParameters: IndexDeleteTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 删除索引模板
     */
    indexDeleteTemplate(requestParameters: IndexDeleteTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 导出索引数据
     */
    indexExportRaw(requestParameters: IndexExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 导出索引数据
     */
    indexExport(requestParameters: IndexExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 刷新索引数据，主要用于将内存中的索引数据写入磁盘
     */
    indexFlushRaw(requestParameters: IndexFlushRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 刷新索引数据，主要用于将内存中的索引数据写入磁盘
     */
    indexFlush(requestParameters: IndexFlushRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 写入设置信息到索引
     */
    indexFlushSettingsRaw(requestParameters: IndexFlushSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 写入设置信息到索引
     */
    indexFlushSettings(requestParameters: IndexFlushSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 获取单个索引详情
     */
    indexGetRaw(requestParameters: IndexGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexBean>>;
    /**
     * 获取单个索引详情
     */
    indexGet(requestParameters: IndexGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexBean>;
    /**
     * 获取索引的爬虫任务的爬取日志
     */
    indexGetCrawlerLogsRaw(requestParameters: IndexGetCrawlerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CrawlerLogs>>;
    /**
     * 获取索引的爬虫任务的爬取日志
     */
    indexGetCrawlerLogs(requestParameters: IndexGetCrawlerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CrawlerLogs>;
    /**
     * 获取索引的爬虫任务设定
     */
    indexGetCrawlerTaskRaw(requestParameters: IndexGetCrawlerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CrawlerTask>>;
    /**
     * 获取索引的爬虫任务设定
     */
    indexGetCrawlerTask(requestParameters: IndexGetCrawlerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CrawlerTask>;
    /**
     * 获取索引设置信息
     */
    indexGetFilterSettingsRaw(requestParameters: IndexGetFilterSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
    /**
     * 获取索引设置信息
     */
    indexGetFilterSettings(requestParameters: IndexGetFilterSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
    /**
     * 获取索引设置信息
     */
    indexGetSettingsRaw(requestParameters: IndexGetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexSettings>>;
    /**
     * 获取索引设置信息
     */
    indexGetSettings(requestParameters: IndexGetSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexSettings>;
    /**
     * 获取应用的索引列表
     */
    indexListRaw(requestParameters: IndexListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IndexBean>>>;
    /**
     * 获取应用的索引列表
     */
    indexList(requestParameters: IndexListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IndexBean>>;
    /**
     * 获取所有可用的索引模板
     */
    indexListTemplatesRaw(requestParameters: IndexListTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexTemplates>>;
    /**
     * 获取所有可用的索引模板
     */
    indexListTemplates(requestParameters?: IndexListTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexTemplates>;
    /**
     * 获取目标网站内容预览
     */
    indexPrefetchRaw(requestParameters: IndexPrefetchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<object>>>;
    /**
     * 获取目标网站内容预览
     */
    indexPrefetch(requestParameters: IndexPrefetchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>>;
    /**
     * 重建索引数据
     */
    indexRebuildRaw(requestParameters: IndexRebuildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexTask>>;
    /**
     * 重建索引数据
     */
    indexRebuild(requestParameters: IndexRebuildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexTask>;
    /**
     * 获取重建索引任务的详情
     */
    indexRebuildTaskRaw(requestParameters: IndexRebuildTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexTask>>;
    /**
     * 获取重建索引任务的详情
     */
    indexRebuildTask(requestParameters: IndexRebuildTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexTask>;
    /**
     * 获取日志索引的统计信息（主要是每日的日志数量）
     */
    indexStatLogsRaw(requestParameters: IndexStatLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<object>>>;
    /**
     * 获取日志索引的统计信息（主要是每日的日志数量）
     */
    indexStatLogs(requestParameters: IndexStatLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>>;
    /**
     * 提交或者更新索引的数据爬取任务
     */
    indexSubmitCrawlerTaskRaw(requestParameters: IndexSubmitCrawlerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CrawlerTask>>;
    /**
     * 提交或者更新索引的数据爬取任务
     */
    indexSubmitCrawlerTask(requestParameters: IndexSubmitCrawlerTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CrawlerTask>;
    /**
     * 获取该索引在后台的任务列表
     */
    indexTasksRaw(requestParameters: IndexTasksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
        [key: string]: IndexTask;
    }>>;
    /**
     * 获取该索引在后台的任务列表
     */
    indexTasks(requestParameters: IndexTasksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
        [key: string]: IndexTask;
    }>;
    /**
     * 修改索引
     */
    indexUpdateRaw(requestParameters: IndexUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexBean>>;
    /**
     * 修改索引
     */
    indexUpdate(requestParameters: IndexUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexBean>;
    /**
     * 更新索引设置信息
     */
    indexUpdateSettingsRaw(requestParameters: IndexUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 更新索引设置信息
     */
    indexUpdateSettings(requestParameters: IndexUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 修改索引模板
     */
    indexUpdateTemplateRaw(requestParameters: IndexUpdateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IndexTemplate>>;
    /**
     * 修改索引模板
     */
    indexUpdateTemplate(requestParameters: IndexUpdateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IndexTemplate>;
    /**
     * 添加同义词
     */
    synonymsAddRaw(requestParameters: SynonymsAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SynonymsBean>>;
    /**
     * 添加同义词
     */
    synonymsAdd(requestParameters: SynonymsAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SynonymsBean>;
    /**
     * 删除同义词
     */
    synonymsDeleteRaw(requestParameters: SynonymsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 删除同义词
     */
    synonymsDelete(requestParameters: SynonymsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 启用禁用同义词
     */
    synonymsEnableRaw(requestParameters: SynonymsEnableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
    /**
     * 启用禁用同义词
     */
    synonymsEnable(requestParameters: SynonymsEnableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
    /**
     * 将同义词更新到搜索引擎的同义词表
     */
    synonymsFlushRaw(requestParameters: SynonymsFlushRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * 将同义词更新到搜索引擎的同义词表
     */
    synonymsFlush(requestParameters: SynonymsFlushRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * 导入同义词
     */
    synonymsImportRaw(requestParameters: SynonymsImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SynonymsBean>>>;
    /**
     * 导入同义词
     */
    synonymsImport(requestParameters: SynonymsImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SynonymsBean>>;
    /**
     * 获取索引的所有同义词
     */
    synonymsListRaw(requestParameters: SynonymsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SynonymsBean>>>;
    /**
     * 获取索引的所有同义词
     */
    synonymsList(requestParameters: SynonymsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SynonymsBean>>;
    /**
     * 修改同义词
     */
    synonymsUpdateRaw(requestParameters: SynonymsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SynonymsBean>>;
    /**
     * 修改同义词
     */
    synonymsUpdate(requestParameters: SynonymsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SynonymsBean>;
}
/**
 * @export
 */
export declare const IndexExportFormatEnum: {
    readonly Json: "json";
    readonly Csv: "csv";
    readonly Excel: "excel";
};
export type IndexExportFormatEnum = typeof IndexExportFormatEnum[keyof typeof IndexExportFormatEnum];
/**
 * @export
 */
export declare const IndexGetFilterSettingsTypeEnum: {
    readonly Stopwords: "stopwords";
    readonly Synonyms: "synonyms";
};
export type IndexGetFilterSettingsTypeEnum = typeof IndexGetFilterSettingsTypeEnum[keyof typeof IndexGetFilterSettingsTypeEnum];
/**
 * @export
 */
export declare const IndexStatLogsIntervalEnum: {
    readonly Day: "day";
    readonly Week: "week";
    readonly Month: "month";
    readonly Quarter: "quarter";
    readonly Year: "year";
};
export type IndexStatLogsIntervalEnum = typeof IndexStatLogsIntervalEnum[keyof typeof IndexStatLogsIntervalEnum];