@gaiot/apis
Version:
aiot apis
131 lines (130 loc) • 7.24 kB
TypeScript
import { AxiosInstance } from 'axios';
import { ApiErrorHandler, BaseApi } from '../base';
import { IKnowledge, IKnowledgeParam, IFileParam, IFile, IUploadParam, IUploadTicket, ISessionParam, ISession, ICommentParam, IChatMessage, IHistory, IApplication, IApplicationParam, IFileNameParam, IResource, IResourceParam, IComposedFile, IAppToken, IEmbeddingData, IAppList, MinioConfig, KnowledgeFileMetadata, KnowledgeFileMetadataParams, IAecModel, IPrompt, ISessionPrompt, IAppGetParam, IPresetApplication, IKnowledgeConfig, IFileData, IFileDataParam, IResourceTokenParam, IResourceToken, IPresetKnowledge, IMetaData, IGeneques, SessionQueryParams, ChatHistoryParams } from './model';
import { PageQueryParams } from '../base/model';
import { IBaseModel } from '../agentcliui/model';
export declare class CVForceApi extends BaseApi {
constructor(axiosInstance?: AxiosInstance, errorHandler?: ApiErrorHandler);
getKnowledge(docId?: string, name?: string): Promise<IKnowledge[]>;
postKnowledge(params: IKnowledgeParam): Promise<string>;
getKnowledgeId(id: string): Promise<IKnowledge>;
patchKnowledgeId(id: string, params: IKnowledgeParam): Promise<string>;
delKnowledgeId(id: string): Promise<{
id: string;
}>;
getKnowledgeIdFile(id: string): Promise<IFile[]>;
getKnowledgeIdFileList(id: string, params: PageQueryParams & {
enabled?: number;
}): Promise<import('../base').Paged<IFile>>;
postKnowledgeIdFile(id: string, params: IFileParam): Promise<{
id: string;
}>;
getUploadTicket(params: IUploadParam): Promise<IUploadTicket>;
delKnowledgeIdFileFid(id: string, fid: string): Promise<{
id: string;
}>;
patchKnowledgeIdFileFid(id: string, fileId: string, params: IFileNameParam): Promise<IFile[]>;
listSessions(appId: string, params?: SessionQueryParams): Promise<ISession[]>;
postSession(appId: string, params: ISessionParam): Promise<ISession>;
getSession(appId: string, id: string): Promise<ISession>;
patchSessionsId(appId: string, id: string, params: ISessionParam): Promise<ISession>;
delSessionsId(appId: string, id: string): Promise<ISession>;
getSessionKnowledgeFile(appId: string, sessionId: string, fileId: string): Promise<KnowledgeFileMetadata>;
postSessionKnowledgeFile(appId: string, sessionId: string, params: KnowledgeFileMetadataParams): Promise<string>;
postComments(params: ICommentParam): Promise<unknown>;
/**
* 查询会话记录
* 规则:
* 1. startTime + pageSize:向后查询
* 2. startTime + pageSize:向前查询
* 3. startTIme + endTime :查询区间(忽略pageSize)
* 4. pageSize 必须是偶数,问答必须一同查询。不严谨,但前端没有办法😭
* 5. 这里的time对应的是对话记录里的messageTime字段,该字段只精确到秒,并不严谨,导致规则4的出现
**/
getChatHistorySessionId(applicationId: string, sessionId: string, params?: ChatHistoryParams): Promise<IChatMessage[]>;
postChatHistorySessionId(sessionId: string, params: {
history: IHistory[];
}): Promise<unknown>;
getApplications(params?: IAppGetParam): Promise<IApplication[]>;
postApplication(params: IApplicationParam): Promise<IApplication>;
getApplicationId(id: string): Promise<IApplication>;
patchApplicationId(id: string, params: IApplicationParam): Promise<IApplication>;
delApplicationId(id: string): Promise<unknown>;
getApplicationIdSessions(id: string): Promise<ISession[]>;
patchFileId(id: string, params: IFileNameParam): Promise<unknown>;
getCvforceResource(params: IResourceParam): Promise<IResource[]>;
postKnowledgeIdComposedFiles(id: string, params: IComposedFile): Promise<unknown>;
getTokensApplicationId(id: string, params: IAppToken): Promise<IEmbeddingData[]>;
getTokens(params: IAppToken): Promise<IAppList[]>;
uploadMinioFile(minioConfig: MinioConfig, file: File): Promise<string>;
uploadFile(path: string, file: File): Promise<string>;
uploadFiles(path: string, files: File[]): Promise<string[]>;
getAecModels(): Promise<IAecModel[]>;
postTextFilter(params: {
text: string;
}): Promise<{
pass: boolean;
}>;
getTenantModel(): Promise<{
defaultModel: string;
}>;
getPrompts(applicationId: string, params?: {
status: number;
}): Promise<IPrompt[]>;
postPrompt(applicationId: string, params: IPrompt): Promise<IPrompt[]>;
patchPromptId(applicationId: string, id: string, params: IPrompt): Promise<IPrompt[]>;
delPromptId(applicationId: string, id: string): Promise<unknown>;
getSessionPrompts(sessionId: string): Promise<ISessionPrompt[]>;
patchSessionPromptId(id: string, sessionId: string, params: ISessionPrompt): Promise<IPrompt[]>;
getApplicationIdSessionIdPromptVariables(appId: string, sessionId: string): Promise<ISessionPrompt[]>;
patchApplicationIdSessionpromptVariablesId(appId: string, sid: string, id: string, params: Partial<ISessionPrompt>): Promise<IPrompt[]>;
getPresetApplication(params: {
name?: string;
type?: number;
}): Promise<IPresetApplication[]>;
postKnowledgeConfig(params: IKnowledgeConfig): Promise<IPrompt[]>;
getKnowledgeConfig(id: string): Promise<IKnowledgeConfig>;
patchKnowledgeConfig(id: string, params: IKnowledgeConfig): Promise<IKnowledgeConfig>;
getKnowledgeIdFileId(id: string, fid: string): Promise<IFile>;
getKnowledgeIdFileIdData(id: string, fid: string, params: PageQueryParams & {
key?: string;
value?: string;
enabled?: number;
}): Promise<import('../base').Paged<IFileData>>;
postKnowledgeIdFileIdData(id: string, fid: string, params: IFileDataParam[]): Promise<{
id: string;
}>;
patchKnowledgeIdFileIdData(id: string, fid: string, did: string, params: IFileDataParam[]): Promise<{
id: string;
}>;
delKnowledgeIdFileIdDataDid(id: string, fid: string, did: string): Promise<{
id: string;
}>;
getPresetKnowledge(params: {
name: string;
}): Promise<IPresetKnowledge[]>;
patchSessionsIdContext(sid: string): Promise<unknown>;
postResourceToken(params: IResourceTokenParam): Promise<IResourceToken>;
getApplicationIdSession(id: string): Promise<ISession[]>;
patchApplicationIdSessionsIdContext(id: string, sid: string): Promise<unknown>;
postApplicationIdSessions(appId: string, params: {
name: string;
}): Promise<ISession>;
getApplicationIdChatHistorySessionId(id: string, sessionId: string): Promise<IChatMessage[]>;
postApplicationIdChatHistorySessionIdComments(id: string, sid: string, params: ICommentParam): Promise<unknown>;
getApplicationIdPrompts(id: string, params?: {
status: number;
}): Promise<IPrompt[]>;
postKnowledgeSourceFile(id: string, fid: string, params: {
name: string;
url: string;
}): Promise<unknown>;
getMetadata(params?: {
type: string;
}): Promise<IMetaData[]>;
postGeneques(params: {
content: string;
}): Promise<IGeneques>;
getBaseModel(serviceId: string): Promise<IBaseModel>;
}
export * from './model';