本产品（
大模型服务平台百炼/2023-12-29）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
数据中心
| API | 标题 | API概述 |
|---|---|---|
| AddFile | 添加文档 | 该接口用于将已经成功上传的文档添加到百炼系统中，添加成功之后，系统会自动启动文件的解析。文件解析有排队机制，如果队列较长，文件可能需要等待一段时间才能解析完成。 |
| ApplyFileUploadLease | 申请文档上传租约 | 该接口用于支持百炼数据中心-数据管理模块文档上传操作，用于申请一个文件上传租约（返回一个http链接），并将文件上传到百炼指定的存储空间内。 |
| DescribeFile | 查询文档状态 | 获取已经添加到百炼中的文件描述信息，包括文件解析状态等。 |
知识索引
| API | 标题 | API概述 |
|---|---|---|
| GetIndexJobStatus | 查询索引创建任务状态 | 此接口用于查询索引创建作业任务的当前状态。用户可以通过提交的作业任务ID检查索引操作的进度，包括是否完成、执行中、或遇到错误。 |
| CreateIndex | 创建索引 | 该接口将已经文档解析之后的数据按照设置的索引创建流程添加到百炼系统中，形成索引信息，后续可以提供查询索引的能力。 |
| SubmitIndexJob | 提交索引创建任务 | 此接口用于提交一个索引作业任务，它将创建索引相关的处理作业添加到百炼系统中。执行成功后，数据将被索引，并可用于快速检索。该接口不会立即完成，而是会进入一个作业队列进行排队执行，需要执行查询索引作业状态接口来获取作业执行的状态 |
| Retrieve | 检索知识索引 | 此接口用于通过关键字检索知识库中的索引信息。它允许用户传递搜索配置，并获取匹配的索引数据列表。检索结果可帮助用户评估索引的质量和相关性。 |