多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
## 授权机制 [授权机制](授权机制) ## 实体类接口 #### 获取实体类列表 **Request** ``` GET /agents/{agentId}/entityTypes ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | **Url parameters** | Parameters | | | -------- | -------- | | page | 页码,从0开始,default: 0 | | size | 每页记录数, default: 20 | **Request body** ``` EMPTY ``` **Response body** ```json { "content": [ object(EntityType) ], "pagination": { "totalElements": number, "page": number, "size": number } } ``` > resource <a href = "#EntityType">EntityType</a> #### 获取实体类信息 **Request** ``` GET /agents/{agentId}/entityTypes/{entityTypeId} ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | **Request body** ``` EMPTY ``` **Response body** > object(<a href="#EntityType">EntityType</a>) #### 创建实体类 **Request** ``` POST /agents/{agentId}/entityTypes ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | **Request body** > object(<a href="#EntityTypeInput">EntityTypeInput</a>) **Response body** > object(<a href="#EntityType">EntityType</a>) #### 修改实体类信息 **Request** ``` POST /agents/{agentId}/entityTypes/{entityTypeId} ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | **Request body** > object(<a href="#EntityTypeInput">EntityTypeInput</a>) **Response body** > object(<a href="#EntityType">EntityType</a>) #### 删除实体类 **Request** ``` DELETE /agents/{agentId}/entityTypes/{entityTypeId} ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | **Request body** ``` EMPTY ``` **Response body** ``` EMPTY ``` ## 实体接口 #### 获取实体列表 **Request** ``` GET /agents/{agentId}/entityTypes/{entityTypeId}/entities ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | **Url parameters** | Parameters | | | -------- | -------- | | page | 页码,从0开始,default: 0 | | size | 每页记录数, default: 20 | **Request body** ``` EMPTY ``` **Response body** ```json { "content": [ object(Entity) ] "pagination": { "totalElements": number, "page": number, "size": number } } ``` > resource <a href = "#Entity">Entity</a> #### 获取实体信息 **Request** ``` GET /agents/{agentId}/entityTypes/{entityTypeId}/entities/{entityId} ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | | entityId | Entity ID | **Request body** ``` EMPTY ``` **Response body** > object(<a href="#Entity">Entity</a>) #### 创建实体 **Request** ``` POST /agents/{agentId}/entityTypes/{entityTypeId}/entities ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | **Request body** > object(<a href="EntityInput">EntityInput</a>) **Response body** > object(<a href="#Entity">Entity</a>) #### 修改实体信息 **Request** ``` POST /agents/{agentId}/entityTypes/{entityTypeId}/entities/{entityId} ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | | entityId | Entity ID | **Request body** > object(<a href="EntityInput">EntityInput</a>) **Response body** > object(<a href="#Entity">Entity</a>) #### 删除实体 **Request** ``` DELETE /agents/{agentId}/entityTypes/{entityTypeId}/entities/{entityId} ``` **Path parameters** | Parameters | | | -------- | -------- | | agentId | Agent ID | | entityTypeId | Entity Type ID | | entityId | Entity ID | **Request body** ``` EMPTY ``` **Response body** ``` EMPTY ``` ## Resource ### <a name="EntityType">EntityType</a> ```json { "id": string, "name": string, "entities": {"href": "/agents/{agentId}/entityTypes/{entityTypeId}/entities"} } ``` ### <a name="EntityTypeInput">EntityTypeInput</a> ```json { "name": string } ``` ### <a name="Entity">Entity</a> ```json { "id": string, "name": string, "alternateName": [string] } ``` ### <a name="EntityInput">EntityInput</a> ```json { "name": string, "alternateName": [string] } ```