@vtj

---

@vtj / designer / OpenApi

Abstract Class: OpenApi

Defined in: packages/designer/types/framework/openapi.d.ts:114

Constructors

Constructor

new OpenApi(): OpenApi

Returns

OpenApi

Properties

cancelChat()?

abstract optional cancelChat: (chat) => Promise<ResponseWrapper<AIChat>>

Defined in: packages/designer/types/framework/openapi.d.ts:187

取消对话

Parameters

chat

AIChat

Returns

Promise<ResponseWrapper<AIChat>>

---

cancelOrder()?

abstract optional cancelOrder: (id) => Promise<ResponseWrapper<any>>

Defined in: packages/designer/types/framework/openapi.d.ts:219

取消订单

Parameters

id

string

Returns

Promise<ResponseWrapper<any>>

---

chatCompletions()?

abstract optional chatCompletions: (topicId, chatId, callback?, error?) => Promise<() => void>

Defined in: packages/designer/types/framework/openapi.d.ts:207

AI Completions

Parameters

topicId

string

chatId

string

callback?

(data, done?) => void

error?

(err, cancel?) => void

Returns

Promise<() => void>

---

createOrder()?

abstract optional createOrder: () => Promise<ResponseWrapper<any>>

Defined in: packages/designer/types/framework/openapi.d.ts:215

创建订单

Returns

Promise<ResponseWrapper<any>>

---

getChats()?

abstract optional getChats: (topicId) => Promise<ResponseWrapper<AIChat[]>>

Defined in: packages/designer/types/framework/openapi.d.ts:175

获取对话列表

Parameters

topicId

string

Returns

Promise<ResponseWrapper<AIChat[]>>

---

getDictOptions()?

abstract optional getDictOptions: (code) => Promise<DictOption[]>

Defined in: packages/designer/types/framework/openapi.d.ts:142

获取字典项

Parameters

code

string

Returns

Promise<DictOption[]>

---

getHotTopics()?

abstract optional getHotTopics: (platform?) => Promise<ResponseWrapper<AITopic[]>>

Defined in: packages/designer/types/framework/openapi.d.ts:203

获取热门话题

Parameters

platform?

string

Returns

Promise<ResponseWrapper<AITopic[]>>

---

getImage()?

abstract optional getImage: (path?) => string | undefined

Defined in: packages/designer/types/framework/openapi.d.ts:227

获取图片url

Parameters

path?

string

Returns

string | undefined

---

getOrder()?

abstract optional getOrder: (id) => Promise<ResponseWrapper<any>>

Defined in: packages/designer/types/framework/openapi.d.ts:223

订单详情

Parameters

id

string

Returns

Promise<ResponseWrapper<any>>

---

getOssFile()?

abstract optional getOssFile: (path?) => string | undefined

Defined in: packages/designer/types/framework/openapi.d.ts:231

获取文件url

Parameters

path?

string

Returns

string | undefined

---

getSettings()?

abstract optional getSettings: () => Promise<Settings>

Defined in: packages/designer/types/framework/openapi.d.ts:211

获取AI设置

Returns

Promise<Settings>

---

getSkills()?

abstract optional getSkills: (platform, ids) => Promise<ResponseWrapper<string>>

Defined in: packages/designer/types/framework/openapi.d.ts:235

获取技能文档

Parameters

platform

PlatformType

ids

string[]

Returns

Promise<ResponseWrapper<string>>

---

getTemplateById()?

abstract optional getTemplateById: (id) => Promise<TemplateDto>

Defined in: packages/designer/types/framework/openapi.d.ts:130

根据id获取模版

Parameters

id

string

Returns

Promise<TemplateDto>

---

getTemplateDsl()?

abstract optional getTemplateDsl: (id) => Promise<BlockSchema>

Defined in: packages/designer/types/framework/openapi.d.ts:138

获取模版的dsl

Parameters

id

string

Returns

Promise<BlockSchema>

---

getTemplates()?

abstract optional getTemplates: (platform) => Promise<TemplateDto[]>

Defined in: packages/designer/types/framework/openapi.d.ts:126

获取模版列表

Parameters

platform

PlatformType

Returns

Promise<TemplateDto[]>

---

getTopics()?

abstract optional getTopics: (fileId) => Promise<ResponseWrapper<AITopic[]>>

Defined in: packages/designer/types/framework/openapi.d.ts:179

获取话题列表

Parameters

fileId

string

Returns

Promise<ResponseWrapper<AITopic[]>>

---

isLogined()?

abstract optional isLogined: () => Promise<boolean>

Defined in: packages/designer/types/framework/openapi.d.ts:122

判断用户是否登录

Returns

Promise<boolean>

---

loginBySign()?

abstract optional loginBySign: (auth?) => Promise<string[]>

Defined in: packages/designer/types/framework/openapi.d.ts:118

签名登录

Parameters

auth?

string | () => Promise<any>

Returns

Promise<string[]>

---

postChat()?

abstract optional postChat: (dto) => Promise<ResponseWrapper<AIChat>>

Defined in: packages/designer/types/framework/openapi.d.ts:183

发送对话

Parameters

dto

ChatDto

Returns

Promise<ResponseWrapper<AIChat>>

---

postImageTopic()?

abstract optional postImageTopic: (dto) => Promise<ResponseWrapper<{ chat: AIChat; topic: AITopic; }>>

Defined in: packages/designer/types/framework/openapi.d.ts:161

发送图片AI话题

Parameters

dto

TopicDto

Returns

Promise<ResponseWrapper<{ chat: AIChat; topic: AITopic; }>>

---

postJsonTopic()?

abstract optional postJsonTopic: (dto) => Promise<ResponseWrapper<{ chat: AIChat; topic: AITopic; }>>

Defined in: packages/designer/types/framework/openapi.d.ts:168

发送元数据AI话题

Parameters

dto

TopicDto

Returns

Promise<ResponseWrapper<{ chat: AIChat; topic: AITopic; }>>

---

postTopic()?

abstract optional postTopic: (dto) => Promise<ResponseWrapper<{ chat: AIChat; topic: AITopic; }>>

Defined in: packages/designer/types/framework/openapi.d.ts:154

发送AI话题

Parameters

dto

TopicDto

Returns

Promise<ResponseWrapper<{ chat: AIChat; topic: AITopic; }>>

---

publishCloudProject()?

abstract optional publishCloudProject: (dto) => Promise<PublishCloudProjectResult>

Defined in: packages/designer/types/framework/openapi.d.ts:150

将本地项目 DSL 发布到在线开发环境

Parameters

dto

PublishCloudProjectDto

Returns

Promise<PublishCloudProjectResult>

---

publishTemplate()?

abstract optional publishTemplate: (dto) => Promise<boolean>

Defined in: packages/designer/types/framework/openapi.d.ts:146

发布模版

Parameters

dto

PublishTemplateDto

Returns

Promise<boolean>

---

recognitionFile()?

abstract optional recognitionFile: (file) => Promise<ResponseWrapper<{ content: string; fileName: string; originalName: string; title: string; }>>

Defined in: packages/designer/types/framework/openapi.d.ts:236

Parameters

file

File

Returns

Promise<ResponseWrapper<{ content: string; fileName: string; originalName: string; title: string; }>>

---

removeTemplate()?

abstract optional removeTemplate: (id) => Promise<boolean>

Defined in: packages/designer/types/framework/openapi.d.ts:134

删除模版

Parameters

id

string

Returns

Promise<boolean>

---

removeTopic()?

abstract optional removeTopic: (topicId) => Promise<ResponseWrapper<boolean>>

Defined in: packages/designer/types/framework/openapi.d.ts:195

删除话题

Parameters

topicId

string

Returns

Promise<ResponseWrapper<boolean>>

---

saveChat()?

abstract optional saveChat: (chat) => Promise<ResponseWrapper<boolean>>

Defined in: packages/designer/types/framework/openapi.d.ts:191

保存对话

Parameters

chat

AIChat

Returns

Promise<ResponseWrapper<boolean>>

---

saveTrace()?

abstract optional saveTrace: (trace) => Promise<ResponseWrapper<any>>

Defined in: packages/designer/types/framework/openapi.d.ts:199

保存执行轨迹（Agent）

Parameters

trace

any

Returns

Promise<ResponseWrapper<any>>

---

updateTopic()?

abstract optional updateTopic: (topic) => Promise<ResponseWrapper<any>>

Defined in: packages/designer/types/framework/openapi.d.ts:197

更新话题（Agent）

Parameters

topic

any

Returns

Promise<ResponseWrapper<any>>