API参考:组织
组织管理和用户管理端点的API参考。
AI端点会异步运行AI提示词,并允许您轮询结果。
端点: POST /v1/tenant/{tenantId}/ai/{promptType}
**身份验证:**租户范围API密钥·write权限范围
参数:
| 名称 | 类型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | path | 是 | 格式:uuid |
| promptType | processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit | path | 是 | 允许的值:processAnalysis、processQuestion、aiSummary、processDocumentation、processRaci、processMetaEdit |
请求正文:
{
"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 | 是 | 允许的值:success、error、generating |
| result | object | object | object | object | object | object | 否 | 特定于提示词的结果载荷(status为success时提供) |
| error | string | 否 | status为error时的错误消息 |
错误:
使用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 | 是 | 允许的值:processAnalysis、processQuestion、aiSummary、processDocumentation、processRaci、processMetaEdit |
请求正文:
{
"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 | 是 | 允许的值:success、error、generating |
| result | object | object | object | object | object | object | 否 | 特定于提示词的结果载荷(status为success时提供) |
| error | string | 否 | status为error时的错误消息 |
错误: