zh:server_docs:robot_ovs:common_qa

QA 问答

概述

  • 此 API 用于管理企业级和设备级 QA 问答；

授权方式

数据维度授权 企业级授权 此 API 为企业级授权，企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。
接口维度授权 默认授权 此 API 为默认授权，您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。

公共请求

公共请求协议

请求域名 https://openapi.orionstar.com

公共请求头

参数 类型 必填 说明
Authorization string 是
  • 访问凭证 access_token
  • 格式：Bearer access_token
  • 示例：Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • 请参考：鉴权方法

公共响应

公共响应体

参数 类型 参数说明
code int 错误代码。200 是成功，非 200 是失败，请参考 错误代码。
msg string 错误描述，当失败的时候会给出具体的错误描述。
data object 业务数据 data 对象，详见下述 响应体 data 对象。

QA 问答 API 列表

HTTP URL 路径 名称
POST /v1/qa/add_corp_qa 添加企业级 QA 问答
POST /v1/qa/modify_corp_qa 修改企业级 QA 问答
POST /v1/qa/delete_corp_qa 删除企业级 QA 问答
GET /v1/qa/corp_qa_list 获取企业级 QA 问答列表
POST /v1/qa/add_robot_qa 添加设备级 QA 问答
POST /v1/qa/modify_robot_qa 修改设备级 QA 问答
POST /v1/qa/delete_robot_qa 删除设备级 QA 问答
GET /v1/qa/robot_qa_list 获取设备级 QA 问答列表

● 添加企业级 QA 问答

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/add_corp_qa
HTTP Method POST
Content-Type application/json; charset=utf-8

请求头

公共请求头请参考 公共请求头

请求体参数

参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
lang string 是 语言。例如 zh_CN / en_US 等。
qa object 是 QA 问答信息对象
qa.question string[] 是 问题，支持多个问题，每个问题不能超过 25 个字
qa.keyword string 否 问题关键字，多个关键字用英文分号分隔，不能超过 25 个字
qa.question string[] 是 文本答案，支持多个答案，每个答案不能超过 500 个字
qa.image_info object[] 否 图片答案，最多支持 10 张图片。
qa.image_info[].src string 是 图片链接 URL
qa.image_info[].width int 是 图片像素宽度
qa.image_info[].height int 是 图片像素高度
qa.video_info object[] 否 视频答案，目前只支持 1 个视频。视频答案和图片答案不能同时存在。
qa.video_info[].src string 是 视频链接 URL
qa.video_info[].backgroundImage string 是 封面图片链接 URL
qa.video_info[].imageWidth int 是 封面图片像素宽度
qa.video_info[].imageHeight int 是 封面图片像素高度

请求体示例

// 文本 QA 问答
{
    "ov_corpid": "test_ov_corpid",
    "lang": "zh_CN",
    "qa": {
        "question": [
            "展示文本",
            "显示文本"
        ],
        "keyword": [
            "关键字1;关键字2"
        ],
        "answer": [
            "这是文本1",
            "这是文本2"
        ]
    }
}
 
// 图片 QA 问答
{
    "ov_corpid": "test_ov_corpid",
    "lang": "zh_CN",
    "qa": {
        "question": [
            "展示图片",
            "显示图片"
        ],
        "keyword": [
            "关键字1;关键字2"
        ],
        "answer": [
            "这是图片"
        ],
        "image_info": [
            {
                "src": "https://test.com/test.png",
                "width": 800,
                "height": 600
            }
        ]
    }
}
 
// 视频 QA 问答
{
    "ov_corpid": "orion.ovs.entprise.8449838034",
    "lang": "zh_CN",
    "qa": {
        "question": [
            "展示视频",
            "显示视频"
        ],
        "keyword": [
            "关键字1;关键字2"
        ],
        "answer": [
            "这是视频"
        ],
        "video_info": [
            {
                "backgroundImage": "https://test.com/test.png",
                "imageWidth": 800,
                "imageHeight": 600,
                "src": "https://test.com/test.mp4"
            }
        ]
    }
}

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/add_corp_qa' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '{"ov_corpid":"test_id","lang":"zh_CN","qa":{"question":["展示文本"],"answer":["这是文本"]}}'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
qapair_id string QA 问答 ID

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "qapair_id": "test_id"
    }
}

● 修改企业级 QA 问答

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/modify_corp_qa
HTTP Method POST
Content-Type application/json; charset=utf-8

请求头

公共请求头请参考 公共请求头

请求体参数

参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
lang string 是 语言。例如 zh_CN / en_US 等。
qapair_id string 是 QA 问答 ID
qa object[] 是 QA 问答信息对象，请参考 添加企业级 QA 问答

请求体示例

{
    "ov_corpid": "test_ov_corpid",
    "lang": "zh_CN",
    "qapair_id": "test_id",
    "qa": {
        // 请参考添加企业级 QA 问答
    }
}

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/modify_corp_qa' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '{"ov_corpid":"test_id","lang":"zh_CN","qapair_id":"test_id","qa":{"question":["展示文本"],"answer":["这是文本"]}}'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
qapair_id string QA 问答 ID

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "qapair_id": "test_id"
    }
}

● 删除企业级 QA 问答

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/delete_corp_qa
HTTP Method POST
Content-Type application/json; charset=utf-8

请求头

公共请求头请参考 公共请求头

请求体参数

参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
lang string 是 语言。例如 zh_CN / en_US 等。
qapair_id string 是 QA 问答 ID

请求体示例

{
    "ov_corpid": "test_ov_corpid",
    "lang": "zh_CN",
    "qapair_id": "test_id"
}

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/delete_corp_qa' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '{"ov_corpid":"test_id","lang":"zh_CN","qapair_id":"test_id"}'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
qapair_id string QA 问答 ID

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "qapair_id": "test_id"
    }
}

● 获取企业级 QA 问答列表

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/corp_qa_list
HTTP Method GET

请求头

公共请求头请参考 公共请求头

请求 URL 参数

说明

  • question、keyword 和 answer 这 3 个搜索条件是或的关系
参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
lang string 是 语言。例如 zh_CN / en_US 等。
question string 否 问题搜索条件
keyword string 否 问题关键字搜索条件
answer string 否 答案搜索条件
page int 否 分页参数。当前是第几页，从 1 开始，默认是 1。
page_rows int 否 分页参数。每页多少条数据，默认是 20。

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/corp_qa_list?ov_corpid=test_id&lang=zh_CN' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
total_count string 总条数
qa_list object[] QA 问答列表
qa_list[].qapair_id string QA 问答 ID
qa_list[].question string[] 问题
qa_list[].keyword string 问题关键字
qa_list[].answer string[] 文本答案
qa_list[].image_info object[] 图片答案，请参考 添加企业级 QA 问答
qa_list[].video_info object[] 视频答案，请参考 添加企业级 QA 问答

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "total_count": "10",
        "qa_list": [
            {
                "qapair_id": "test_id",
                "question": [
                    "展示图片"
                ],
                "keyword": [
                    "关键字"
                ],
                "answer": [
                    "图片答案"
                ],
                "image_info": [
                    {
                        "src": "https://test.com/test.png",
                        "width": 800,
                        "height": 600
                    }
                ],
                // 为了提供示例这里同时给出了图片和视频答案，真实场景不允许同时存在图片和视频答案
                "video_info": [
                    {
                        "backgroundImage": "https://test.com/test.png",
                        "imageWidth": 800,
                        "imageHeight": 600,
                        "src": "https://test.com/test.mp4"
                    }
                ]
            }
        ]
    }
}

● 添加设备级 QA 问答

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/add_robot_qa
HTTP Method POST
Content-Type application/json; charset=utf-8

请求头

公共请求头请参考 公共请求头

请求体参数

参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
robot_sn string[] 是 设备 SN。支持多个设备 SN。
lang string 是 语言。例如 zh_CN / en_US 等。
qa object 是 QA 问答信息对象
qa.question string[] 是 问题，请参考 添加企业级 QA 问答
qa.question string[] 是 文本答案，请参考 添加企业级 QA 问答
qa.image_info object[] 否 图片答案，请参考 添加企业级 QA 问答
qa.video_info object[] 否 视频答案，请参考 添加企业级 QA 问答

请求体示例

// 文本 QA 问答
{
    "ov_corpid": "test_ov_corpid",
    "robot_sn": ["SN1", "SN2"],
    "lang": "zh_CN",
    "qa": {
        // 请参考添加设备级 QA 问答
    }
}

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/add_robot_qa' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '{"ov_corpid":"test_id","robot_sn":["SN1"],"lang":"zh_CN","qa":{"question":["展示文本"],"answer":["这是文本"]}}'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
qapair_id string QA 问答 ID

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "qapair_id": "test_id"
    }
}

● 修改设备级 QA 问答

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/modify_robot_qa
HTTP Method POST
Content-Type application/json; charset=utf-8

请求头

公共请求头请参考 公共请求头

请求体参数

参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
robot_sn string[] 是 设备 SN。支持多个设备 SN。
lang string 是 语言。例如 zh_CN / en_US 等。
qapair_id string 是 QA 问答 ID
qa object[] 是 QA 问答信息对象，请参考 添加设备级 QA 问答

请求体示例

{
    "ov_corpid": "test_ov_corpid",
    "robot_sn": ["SN1", "SN2"],
    "lang": "zh_CN",
    "qapair_id": "test_id",
    "qa": {
        // 请参考添加设备级 QA 问答
    }
}

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/modify_robot_qa' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '{"ov_corpid":"test_id","lang":"zh_CN","robot_sn":["SN1"],"qapair_id":"test_id","qa":{"question":["展示文本"],"answer":["这是文本"]}}'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
qapair_id string QA 问答 ID

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "qapair_id": "test_id"
    }
}

● 删除设备级 QA 问答

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/delete_robot_qa
HTTP Method POST
Content-Type application/json; charset=utf-8

请求头

公共请求头请参考 公共请求头

请求体参数

参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
lang string 是 语言。例如 zh_CN / en_US 等。
qapair_id string 是 QA 问答 ID

请求体示例

{
    "ov_corpid": "test_ov_corpid",
    "lang": "zh_CN",
    "qapair_id": "test_id"
}

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/delete_robot_qa' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --data '{"ov_corpid":"test_id","lang":"zh_CN","qapair_id":"test_id"}'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
qapair_id string QA 问答 ID

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "qapair_id": "test_id"
    }
}

● 获取设备级 QA 问答列表

请求

请求协议

公共请求协议请参考 公共请求协议

HTTP URL 路径 /v1/qa/robot_qa_list
HTTP Method GET

请求头

公共请求头请参考 公共请求头

请求 URL 参数

说明

  • question、keyword 和 answer 这 3 个搜索条件是或的关系
参数 类型 必填 参数说明
ov_corpid string 是 所属企业 id
robot_sn string 是 设备 SN
lang string 是 语言。例如 zh_CN / en_US 等。
question string 否 问题搜索条件
answer string 否 答案搜索条件
page int 否 分页参数。当前是第几页，从 1 开始，默认是 1。
page_rows int 否 分页参数。每页多少条数据，默认是 20。

请求 cURL 示例

curl --location 'https://openapi.orionstar.com/v1/qa/robot_qa_list?ov_corpid=test_id&lang=zh_CN' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'

响应

响应体 data 对象

公共响应体请参考 公共响应

参数 类型 参数说明
total_count string 总条数
qa_list object[] QA 问答列表
qa_list[].qapair_id string QA 问答 ID
qa_list[].question string[] 问题
qa_list[].answer string[] 文本答案
qa_list[].image_info object[] 图片答案，请参考 添加设备级 QA 问答
qa_list[].video_info object[] 视频答案，请参考 添加设备级 QA 问答

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "total_count": "10",
        "qa_list": [
            {
                "qapair_id": "test_id",
                "question": [
                    "展示图片"
                ],
                "answer": [
                    "图片答案"
                ],
                "image_info": [
                    {
                        "src": "https://test.com/test.png",
                        "width": 800,
                        "height": 600
                    }
                ],
                // 为了提供示例这里同时给出了图片和视频答案，真实场景不允许同时存在图片和视频答案
                "video_info": [
                    {
                        "backgroundImage": "https://test.com/test.png",
                        "imageWidth": 800,
                        "imageHeight": 600,
                        "src": "https://test.com/test.mp4"
                    }
                ]
            }
        ]
    }
}
  • 最后更改: 2024-11-01 22:11 +0800