ParseDocument - 解析文档生成路由规则--智能体身份和权限管理平台-火山引擎

文档中心

立即注册

智能体身份和权限管理平台

权限网关

ParseDocument - 解析文档生成路由规则

解析文档生成路由规则

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ParseDocument	要执行的操作，取值：ParseDocument。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
File	String	否	example	上传的文件（通过 form-data 的 file 字段）
DocType	String	是	OpenApi	文档类型：Swagger, OpenApi, NaturalLanguage @example:OpenApi
DocName	String	否	my-api-spec.yaml	文档名称（可选，默认使用上传文件名） @example:my-api-spec.yaml

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Routes	Array of Object	example	解析出的路由规则列表
FromCache	Boolean	example	是否使用了缓存（如果为 true，表示之前已解析过相同文档）
DocumentId	String	example	文档ID（用于创建路由时关联）

请求示例

POST ?&DocType=OpenApi&DocName=my-api-spec.yaml
{
    "File": ""
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ParseDocument",
        "Region": "cn-north-1",
        "Service": "***",
        "Version": "2025-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Routes": [
            {
                "Path": "/api/v1/search",
                "Method": "POST",
                "ApiSpec": {
                    "ActionType": "READ",
                    "Extractors": [
                        {
                            "Path": "/collection_name",
                            "IsAuth": true,
                            "Source": null,
                            "ResourceType": "Collection"
                        }
                    ],
                    "ActionValue": "search",
                    "IdentifierType": null,
                    "IdentifierValue": "/collection_name",
                    "ResponseFilters": [
                        {
                            "Mode": null,
                            "IsAuth": false,
                            "IdField": "id",
                            "Attributes": [
                                {
                                    "Field": "/id",
                                    "Target": "ResourceId"
                                }
                            ],
                            "FilterPath": "/data/items",
                            "ResourcePath": "/data",
                            "ResourceType": "Collection"
                        }
                    ]
                },
                "RouteName": "SearchVectors",
                "ResourceType": "Vector",
                "PathMatchType": "Exact",
                "PermissionPool": "DefaultPool"
            }
        ],
        "FromCache": true,
        "DocumentId": ""
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	Invalid request parameters: %s.	参数 %s 无效
404	NotFound	Resource not found: %s.	资源 %s 不存在
409	Duplicated	Resource already exists: %s.	资源 %s 已存在
409	StatusConflict	Status conflict: %s.	状态冲突: %s
422	ParseFailed	Failed to parse document: %s.	文档解析失败: %s
429	QuotaExceeded	Quota exceeded: %s.	配额 %s 已达上限
500	InternalError	Internal server error: %s.	内部服务错误: %s
501	NotImplemented	Not implemented: %s.	功能未实现: %s
502	UpstreamUnreachable	Upstream unreachable: %s.	后端服务 %s 不可达

最近更新时间：2025.12.14 13:43:21

这个页面对您有帮助吗？

有用

无用