1. 根据关键词查询构件

根据关键词查询模型中相关度最高的构件。


请求方式:GET

请求地址:/api/{databaseKey}/queries/keywords?modelKey={xxx}&share={yyy}&keywords={aa}&attributes={dd}&pageNumber={bb}&pageSize={cc}

1.1. 请求参数

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea 操作的通关令牌

PathParas:

参数名 类型 示例 是否必填 参数含义
databaseKey string test 数据库key,必传

SearchParas:

参数名 类型 示例 是否必填 参数含义
modelKey string NULL 模型key
share string NULL 分享key(可选)
keywords string NULL 关键词
pageNumber string NULL 分页返回的页码,从0开始
pageSize string NULL 分页返回每页最大条目,取值1~100
attributes string NULL 返回属性列表,如不指定则返回全部

Body

application/json:

NULL

1.2. 参数说明

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

1.3. 正确返回

1.模型索引已创建
{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "content": [
            {
                "name": "斜檩条:斜檩条-1m:2824483",
                "type": "IfcBuildingElementProxy",
                "key": "M1577178468831_03xNH48oj7Wv6Pwjg1c_RA"
            },
            {
                "name": "斜檩条:斜檩条:2745945",
                "type": "IfcBuildingElementProxy",
                "key": "M1577178468831_3gTr6XEtj3kO57N2kFyI$W"
            }
        ],
        "first": false,
        "last": false,
        "number": 2, //页码
        "numberOfElements": 2, //当页数量
        "size": 2, //每页最大数量
        "totalElements": 27, //总数
        "totalPages": 14 //总页数
    }
}

2.模型索引尚未创建
{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": "模型索引尚未创建,请稍后再试"
}

3.模型索引创建中
{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": "模型索引创建中,请稍后再试"
}

4.模型索引上次创建失败
{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": "模型索引上次创建失败,正在重新提取"
}

1.4. 状态码

状态码 code message data 原因
400 BIZ_EXCEPTION (xxx)关键词查询脚本返回为空 NULL 当查询的关键词数据为空时
400 BIZ_EXCEPTION (xxx)关键词查询脚本执行异常,状态码(code) NULL 当关键词查询脚本异常时

1.5. 备注

暂无备注

1.6. 注意事项

1)在模型场景创建成功后,自动调用异步方法提取模型关键词。

2)如果模型索引尚未创建,则提示模型索引尚未创建,同时异步任务调用模型索引算法创建模型索引

3)如果模型索引在创建中,则提示模型索引创建中

4)如果模型索引上次创建失败,则提示模型索引上次创建失败,正在重新提取,同时异步任务调用模型索引算法创建模型索引

5)如果模型索引已创建,则调用关键词查询算法查询并按相关度高低返回关键词相关的构件列表

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2021 all right reserved,powered by Gitbook该文件修订时间: 2021-09-24 13:48:02

results matching ""

    No results matching ""