wechat-api/desc/wechat/agent.api

import "../base.api"

type (
    // The data of agent information | Agent信息
    AgentInfo {
        BaseIDInfo

        // name | 角色名称 
        Name  *string `json:"name,optional"`

        // role | 角色设定 
        Role  *string `json:"role,optional"`

        // status | 状态 1-正常 2-禁用 
        Status  *int `json:"status,optional"`

        // background | 背景介绍 
        Background  *string `json:"background,optional"`

        // examples | 对话案例 
        Examples  *string `json:"examples,optional"`
    }

    // The response data of agent list | Agent列表数据
    AgentListResp {
        BaseDataInfo

        // Agent list data | Agent列表数据
        Data AgentListInfo `json:"data"`
    }

    // Agent list data | Agent列表数据
    AgentListInfo {
        BaseListInfo

        // The API list data | Agent列表数据
        Data  []AgentInfo  `json:"data"`
    }

    // Get agent list request params | Agent列表请求参数
    AgentListReq {
        PageInfo

        // name | 角色名称 
        Name  *string `json:"name,optional"`

        // role | 角色设定 
        Role  *string `json:"role,optional"`

        // background | 背景介绍 
        Background  *string `json:"background,optional"`

		// status | 状态 1-可用 2-不可用
		Status  *int `json:"status,optional"`
    }

    // Agent information response | Agent信息返回体
    AgentInfoResp {
        BaseDataInfo

        // Agent information | Agent数据
        Data AgentInfo `json:"data"`
    }
)

@server(
    jwt: Auth
    group: agent
    middleware: Authority
)

service Wechat {
    // Create agent information | 创建Agent
    @handler createAgent
    post /agent/create (AgentInfo) returns (BaseMsgResp)

    // Update agent information | 更新Agent
    @handler updateAgent
    post /agent/update (AgentInfo) returns (BaseMsgResp)

    // Delete agent information | 删除Agent信息
    @handler deleteAgent
    post /agent/delete (IDsReq) returns (BaseMsgResp)

    // Get agent list | 获取Agent列表
    @handler getAgentList
    post /agent/list (AgentListReq) returns (AgentListResp)

    // Get agent by ID | 通过ID获取Agent
    @handler getAgentById
    post /agent (IDReq) returns (AgentInfoResp)
}