speechAnalysis/docs/swagger.json

{
    "swagger": "2.0",
    "info": {
        "contact": {}
    },
    "paths": {
        "/api-sa/v1/audio/batchDelete": {
            "delete": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "批量删除音频",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.BatchProcessAudio"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/batchProcess": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "批量处理音频",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.BatchProcessAudio"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/delete": {
            "delete": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "删除音频",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.ProcessAudio"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/follow": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "关注/取消关注",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.FollowReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/util.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "$ref": "#/definitions/response.FollowResp"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/info": {
            "get": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "音频详情，含解析结果",
                "parameters": [
                    {
                        "type": "integer",
                        "name": "id",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/util.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "$ref": "#/definitions/models.Audio"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/list": {
            "get": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "音频分析检索",
                "parameters": [
                    {
                        "type": "string",
                        "description": "司机号",
                        "name": "driverNumber",
                        "in": "query"
                    },
                    {
                        "type": "string",
                        "description": "关键字",
                        "name": "keyword",
                        "in": "query"
                    },
                    {
                        "type": "string",
                        "description": "机车号",
                        "name": "locomotiveNumber",
                        "in": "query"
                    },
                    {
                        "type": "integer",
                        "description": "页码",
                        "name": "page",
                        "in": "query"
                    },
                    {
                        "type": "integer",
                        "description": "每页大小",
                        "name": "pageSize",
                        "in": "query"
                    },
                    {
                        "type": "string",
                        "description": "车站号",
                        "name": "stationNumber",
                        "in": "query"
                    },
                    {
                        "type": "string",
                        "description": "车次",
                        "name": "trainNumber",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/util.ResponseList"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/definitions/models.Audio"
                                            }
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/process": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "处理音频",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.ProcessAudio"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/trainInfoList": {
            "get": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "获取火车信息",
                "parameters": [
                    {
                        "enum": [
                            1,
                            2,
                            3
                        ],
                        "type": "integer",
                        "x-enum-comments": {
                            "ClassLocomotive": "机车",
                            "ClassStation": "车站",
                            "ClassTrain": "车次"
                        },
                        "x-enum-varnames": [
                            "ClassLocomotive",
                            "ClassTrain",
                            "ClassStation"
                        ],
                        "description": "信息分类 1机车2车次3车站",
                        "name": "class",
                        "in": "query"
                    },
                    {
                        "type": "integer",
                        "description": "页码",
                        "name": "page",
                        "in": "query"
                    },
                    {
                        "type": "integer",
                        "description": "每页大小",
                        "name": "pageSize",
                        "in": "query"
                    },
                    {
                        "type": "integer",
                        "description": "上级id",
                        "name": "parentID",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/util.ResponseList"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/definitions/models.TrainInfo"
                                            }
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/api-sa/v1/audio/upload": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "音频"
                ],
                "summary": "上传音频",
                "parameters": [
                    {
                        "type": "file",
                        "description": "音频文件",
                        "name": "file",
                        "in": "formData",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-sa/v1/text/add": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "文字库"
                ],
                "summary": "新增文字",
                "parameters": [
                    {
                        "description": "参数",
                        "name": "object",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.AddTextReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "$ref": "#/definitions/util.Response"
                        }
                    }
                }
            }
        },
        "/api-sa/v1/text/list": {
            "get": {
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "文字库"
                ],
                "summary": "文字库列表",
                "parameters": [
                    {
                        "type": "string",
                        "description": "关键字",
                        "name": "keyword",
                        "in": "query"
                    },
                    {
                        "type": "integer",
                        "description": "页码",
                        "name": "page",
                        "in": "query"
                    },
                    {
                        "type": "integer",
                        "description": "每页大小",
                        "name": "pageSize",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/util.ResponseList"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/definitions/models.Word"
                                            }
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "constvar.AudioStatus": {
            "type": "integer",
            "enum": [
                0,
                1,
                2,
                3,
                4
            ],
            "x-enum-comments": {
                "AudioStatusFailed": "处理失败",
                "AudioStatusFinish": "处理完成",
                "AudioStatusProcessing": "处理中",
                "AudioStatusUploadOk": "上传成功 待处理",
                "AudioStatusUploading": "上传中"
            },
            "x-enum-varnames": [
                "AudioStatusUploading",
                "AudioStatusUploadOk",
                "AudioStatusProcessing",
                "AudioStatusFinish",
                "AudioStatusFailed"
            ]
        },
        "constvar.BoolType": {
            "type": "integer",
            "enum": [
                1,
                2
            ],
            "x-enum-comments": {
                "BoolTypeFalse": "false",
                "BoolTypeTrue": "true"
            },
            "x-enum-varnames": [
                "BoolTypeTrue",
                "BoolTypeFalse"
            ]
        },
        "constvar.Class": {
            "type": "integer",
            "enum": [
                1,
                2,
                3
            ],
            "x-enum-comments": {
                "ClassLocomotive": "机车",
                "ClassStation": "车站",
                "ClassTrain": "车次"
            },
            "x-enum-varnames": [
                "ClassLocomotive",
                "ClassTrain",
                "ClassStation"
            ]
        },
        "gorm.DeletedAt": {
            "type": "object",
            "properties": {
                "time": {
                    "type": "string"
                },
                "valid": {
                    "description": "Valid is true if Time is not NULL",
                    "type": "boolean"
                }
            }
        },
        "models.Audio": {
            "type": "object",
            "properties": {
                "audioStatus": {
                    "description": "音频状态",
                    "allOf": [
                        {
                            "$ref": "#/definitions/constvar.AudioStatus"
                        }
                    ]
                },
                "audioText": {
                    "description": "解析出的文本",
                    "type": "string"
                },
                "createdAt": {
                    "type": "string"
                },
                "deletedAt": {
                    "$ref": "#/definitions/gorm.DeletedAt"
                },
                "driverNumber": {
                    "description": "司机号",
                    "type": "string"
                },
                "id": {
                    "type": "integer"
                },
                "isFollowed": {
                    "description": "是否关注 1关注 2未关注",
                    "allOf": [
                        {
                            "$ref": "#/definitions/constvar.BoolType"
                        }
                    ]
                },
                "locomotiveNumber": {
                    "description": "机车号",
                    "type": "string"
                },
                "name": {
                    "description": "音频名称",
                    "type": "string"
                },
                "occurrenceTime": {
                    "type": "string"
                },
                "score": {
                    "description": "置信度",
                    "type": "number"
                },
                "size": {
                    "description": "音频大小",
                    "type": "integer"
                },
                "station": {
                    "description": "车站",
                    "type": "string"
                },
                "trainNumber": {
                    "description": "车次",
                    "type": "string"
                },
                "updatedAt": {
                    "type": "string"
                },
                "words": {
                    "description": "匹配到的文字数组",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            }
        },
        "models.TrainInfo": {
            "type": "object",
            "properties": {
                "class": {
                    "description": "分类  1 机车 2车次 3 车站",
                    "allOf": [
                        {
                            "$ref": "#/definitions/constvar.Class"
                        }
                    ]
                },
                "createdAt": {
                    "type": "string"
                },
                "deletedAt": {
                    "$ref": "#/definitions/gorm.DeletedAt"
                },
                "id": {
                    "type": "integer"
                },
                "name": {
                    "description": "名称",
                    "type": "string"
                },
                "parentID": {
                    "description": "上级id",
                    "type": "integer"
                },
                "updatedAt": {
                    "type": "string"
                }
            }
        },
        "models.Word": {
            "type": "object",
            "properties": {
                "content": {
                    "description": "文字",
                    "type": "string"
                },
                "createdAt": {
                    "type": "string"
                },
                "deletedAt": {
                    "$ref": "#/definitions/gorm.DeletedAt"
                },
                "id": {
                    "type": "integer"
                },
                "locomotiveNumber": {
                    "description": "机车号",
                    "type": "string"
                },
                "updatedAt": {
                    "type": "string"
                }
            }
        },
        "request.AddTextReq": {
            "type": "object",
            "required": [
                "content",
                "locomotiveNumber"
            ],
            "properties": {
                "content": {
                    "description": "音频名称",
                    "type": "string"
                },
                "locomotiveNumber": {
                    "description": "机车号",
                    "type": "string"
                }
            }
        },
        "request.BatchProcessAudio": {
            "type": "object",
            "required": [
                "ids"
            ],
            "properties": {
                "ids": {
                    "type": "array",
                    "items": {
                        "type": "integer"
                    }
                }
            }
        },
        "request.FollowReq": {
            "type": "object",
            "required": [
                "id"
            ],
            "properties": {
                "id": {
                    "type": "integer"
                }
            }
        },
        "request.ProcessAudio": {
            "type": "object",
            "required": [
                "id"
            ],
            "properties": {
                "id": {
                    "type": "integer"
                }
            }
        },
        "response.FollowResp": {
            "type": "object",
            "properties": {
                "followStatus": {
                    "description": "1 已关注 2未关注",
                    "allOf": [
                        {
                            "$ref": "#/definitions/constvar.BoolType"
                        }
                    ]
                }
            }
        },
        "util.Response": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "integer"
                },
                "data": {},
                "msg": {
                    "type": "string"
                }
            }
        },
        "util.ResponseList": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "integer"
                },
                "data": {},
                "msg": {
                    "type": "string"
                },
                "page": {
                    "type": "integer"
                },
                "pageSize": {
                    "type": "integer"
                },
                "total": {
                    "type": "integer"
                }
            }
        }
    }
}