本页内容

API参考:AI

AI端点会异步运行AI提示词,并允许您轮询结果。

启动直接AI提示词(异步;使用相同正文轮询POST …/ai/{promptType}/status)

端点: POST /v1/tenant/{tenantId}/ai/{promptType}

**身份验证:**租户范围API密钥·write权限范围

参数:

名称 类型 位置 必填 描述
tenantId string path 格式:uuid
promptType processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit path 允许的值:processAnalysisprocessQuestionaiSummaryprocessDocumentationprocessRaciprocessMetaEdit

请求正文:

{
	"prompt": "string",
	"summaryVariant": "string"
}
字段 类型 必填 描述
prompt string 自然语言提示词
最大长度:10000
summaryVariant string

响应(200):

AI结果(状态:success|generating|error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}
字段 类型 必填 描述
status success | error | generating 允许的值:successerrorgenerating
result object | object | object | object | object | object 特定于提示词的结果载荷(status为success时提供)
error string status为error时的错误消息

错误:

  • 401缺少、无效、已禁用或已过期的API密钥
  • 429已达到使用限制

轮询正在生成的AI结果(发送与启动该任务的POST请求完全相同的正文)

使用POST进行轮询是有意设计的:生成任务由prompt、promptType和summaryVariant共同确定,因此轮询时重复发送正文,而不是通过运行ID定位任务。

端点: POST /v1/tenant/{tenantId}/ai/{promptType}/status

**身份验证:**租户范围API密钥·write权限范围

参数:

名称 类型 位置 必填 描述
tenantId string path 格式:uuid
promptType processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit path 允许的值:processAnalysisprocessQuestionaiSummaryprocessDocumentationprocessRaciprocessMetaEdit

请求正文:

{
	"prompt": "string",
	"summaryVariant": "string"
}
字段 类型 必填 描述
prompt string 自然语言提示词
最大长度:10000
summaryVariant string

响应(200):

AI结果(状态:success|generating|error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}
字段 类型 必填 描述
status success | error | generating 允许的值:successerrorgenerating
result object | object | object | object | object | object 特定于提示词的结果载荷(status为success时提供)
error string status为error时的错误消息

错误:

  • 401缺少、无效、已禁用或已过期的API密钥
  • 429已达到使用限制