API概览
本文介绍MaaS支持的API，分别为模型API（文本生成、图片生成、视频生成等）和管控面API（自定义接入点、MaaS调用统计等）。
文本生成
| API | 说明 |
|---|---|
| 介绍Chat API的调用规范，对输入输出参数进行了详细说明及展示了调用示例。 | |
| 通过兼容 OpenAI 格式的Chat API 调用模型，对输入输出参数进行了详细说明及展示了调用示例。 | |
| 通过兼容 Anthropic 格式的 Chat API 调用模型，对输入输出参数进行了详细说明及展示了调用示例。 | |
| 介绍Chat API的调用规范（适用部分旧模型），对输入输出参数进行了详细说明及展示了调用示例。该接口不再演进，建议优先使用MaaS标准API V2接口。 |
文本向量化
| API | 说明 |
|---|---|
| 通过文本向量化API调用模型，将文本数据转换为数值向量，以便于在机器学习和自然语言处理任务中使用。 |
重排序
| API | 说明 |
|---|---|
| 通过重排序API调用模型，可以根据用户提供的文本信息以及文本数据项进行重新排序，以提升用户体验。 |
视频生成
| 模型系列 | API | 说明 |
|---|---|---|
| 通义万相 | 创建视频生成任务API用于根据用户的输入信息，如文本提示词、图片等，结合指定的模型及视频处理参数，生成相应的视频片段。其业务逻辑是将用户输入的各种参数传递给后端模型进行处理，最终输出生成的视频链接。支持文生视频和图生视频。 适用平台模型（通义万相系列）。 | |
| 根据创建视频生成任务接口生成的任务ID查询视频生成任务的详细信息和状态。 | ||
| 生数 | 根据用户输入提示词文本，生成视频。 适用生数模型。 | |
| 根据用户输入图像和提示词文本，生成视频。适用生数模型。 | ||
| 根据用户传入的首尾帧图像和文本提示词，生成视频。适用生数模型。 | ||
| 根据用户输入的参考图像和文本提示词，生成视频。适用生数模型。 | ||
| 根据创建视频生成任务接口生成的任务ID查询视频生成任务的详细信息和状态。 | ||
| 爱诗 | 根据用户输入提示词文本，生成视频。适用爱诗模型。 | |
| 根据用户输入图像和提示词文本，生成视频。适用爱诗模型。 | ||
| 根据用户传入的首尾帧图像和文本提示词，生成视频。适用爱诗模型。 | ||
| 根据用户输入的参考图像和文本提示词，生成视频。适用爱诗模型。 | ||
| 根据创建视频生成任务接口生成的任务ID查询视频生成任务的详细信息和状态。 |
自定义接入点
| API | 说明 |
|---|---|
| 用于创建独立的调用入口，允许用户设置限流规则，并基于自定义接入点名称实现费用的精准统计，帮助用户高效管理推理服务资源，优化使用成本。 | |
| 用于编辑指定接入点的流控、内容安全护栏开关、接入点名称、接入点描述。 | |
| 用于查询用户接入点列表。 | |
| 用于根据传入的custom_endpoint_id，删除指定的接入点。 | |
| 用于根据传入的project-id和custom_endpoint_id，启用或停用接入点。 |
查询AI开发平台ModelArts-在线服务
| API | 说明 |
|---|---|
| 用于获取AI开发平台ModelArts-在线服务的Region信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时，获取请求中的region参数。 | |
| 用于获取AI开发平台ModelArts-在线服务的WorkSpace信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时，查询infer_service_id。 | |
| 用于获取AI开发平台ModelArts-在线服务的WorkSpace信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时，获取推理服务信息。 | |
| 用于获取MaaS-在线推理的内容安全护栏免责声明。当创建自定义接入点的“moderation”参数选择“false”时，必须签订最新版本的免责声明。 |
MaaS调用统计
| API | 说明 |
|---|---|
| 用于查询在线推理服务调用的汇总数据，包括：总调用次数、总调用失败次数、总调用Tokens数、输入Tokens数、输出总Tokens数等。仅保存30天内的统计数据。 | |
| 用于获取用户已开通的预置服务、已创建的自定义接入点两种类型服务，并展示每个服务的调用次数、调用失败率、调用总Tokens数、输入Tokens数、输出Tokens数、端到端时延等指标信息。仅保存30天内的统计数据。 | |
| 用于获取服务的指标明细数据。查看该服务的调用次数、调用失败率、调用tokens量、输入Tokens大小、输出Tokens大小、端到端时延、TPM、RPM、QPS、平均生成时长等指标时间变化趋势。仅保存30天内的统计数据。 | |
| 用于获取服务的错误明细数据，查看调用失败的相关信息，如错误码、发生次数、错误信息等。仅保存30天内的统计数据。 | |
| 用于获取服务ID对应的服务名称。 | |
| 用于获取IP地址。 | |
| 用于查询MaaS在线推理模块我的服务类型资源监控指标信息。仅保存30天内的统计数据。 | |
| 用于查询服务的所有版本及其相应的监控指标数据。仅保存30天内的统计数据。 | |
| 用于获取服务模型类型对应支持的指标列表。 | |
| 用于展现服务的错误码统计时间分布信息。仅保存30天内的统计数据。 |
