文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 智能质检/ 句子管理接口 (sentencemanagement)/ 查询句子
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询句子

场景描述

查询句子的接口，入参包含句子的唯一标识为查询句子的详情，否则查询句子列表。

接口方法

POST

接口URI

https://域名/apiaccess/CCSQM/rest/ccisqm/v1/sentencemanage/querySentence，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

string

False

固定填 application/json; charset=UTF-8。

2

x-app-key

string

False

appKey标识

3

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

4

x-UserId

string

False

操作员标识

可在登录后，进入员工管理页面，查看接口返回的userId
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1.1

category_id

string

False

句子分类的唯一标识，传入句子分类标识只查询该分类下的句子

1.2

page

number

True

分页信息查询条件，查询目标页码

1.3

limit

number

True

分页信息查询条件，每页数量

  • 取值范围：5， 10， 20， 50， 100

1.4

keyword

string

False

查询关键字

1.5

sentence_id

string

False

句子的唯一标识，当传入了句子标识，只查询返回该句子的详情

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1.1

data

array[object]

False

返回的句子数据集合对象

1.1.1

category_id

string

False

句子分类的唯一标识

1.1.2

sentence_id

string

True

句子的唯一标识

1.1.3

sentence_name

string

False

句子名称

1.1.4

tags

array[object]

False

句子所使用的语义与关键词

1.1.4.1

tag_id

string

False

标签的唯一标识

1.1.4.2

tag_name

string

False

标签名称

1.1.4.3

tag_type

string

False

标签的类型：keyword-关键词，dialogue_act-语义，regular_exp-正则表达式

1.2

paging

object

False

分页信息对象

1.2.1

current

number

False

页码

1.2.2

limit

number

False

每页数量

1.2.3

total

number

False

查询结果总数

1.3

category_id

string

False

分类的唯一标识

1.4

sentence_id

string

False

句子的唯一标识

1.5

sentence_name

string

False

句子名称

1.6

tagDataList

array[object]

False

语义与关键字列表

1.6.1

tag_type

string

False

标签类型

1.6.2

pos_sentences

array[object]

False

正向语义，关键字和正则表达式

1.6.2.1

id

string

False

语料的唯一标识

1.6.2.2

name

string

False

语料内容

1.6.3

neg_sentences

array[object]

False

反向语义，与pos_sentences在同一个标签对象中不能同时存在

1.6.3.1

id

string

False

语料的唯一标识

1.6.3.2

name

string

False

语料内容
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景1：查询句子列表

    请求头:

    x-app-key:************************************  
X-UserID:1611917095665261978  
Authorization:Bearer ********************************

    请求参数:

    {
    "category_id": "1070149256381206528",
    "keyword": "句子",
    "page": 1,
    "limit": 10
}

    响应参数:

    {
  "paging": {
    "total": 4
  },
  "data": [
    {
      "category_id": "1070149256381206528",
      "sentence_id": "10870",
      "sentence_name": "句子名称78",
      "tags": null
    },
    {
      "category_id": "1070149256381206528",
      "sentence_id": "10877",
      "sentence_name": "句子名称25",
      "tags": null
    },
    {
      "category_id": "1070149256381206528",
      "sentence_id": "10884",
      "sentence_name": "句子名称39",
      "tags": null
    },
    {
      "category_id": "1070149256381206528",
      "sentence_id": "10891",
      "sentence_name": "句子名称85",
      "tags": null
    }
  ]
}
    • 场景2：通过句子id查询句子详情

      请求头:

      x-app-key:************************************  
X-UserID:1611917095665261978  
Authorization:Bearer ********************************

      请求参数:

      {
    "sentence_id": "10891"
}

      响应参数:

      {
  "category_id": "1070149256381206528",
  "sentence_id": "10891",
  "tagDataList": [
    {
      "tag_type": "dialogue_act",
      "pos_sentences": [
        {
          "name": "同义语料18",
          "id": "10169"
        }
      ],
      "neg_sentences": [
        {
          "name": "反义语料14",
          "id": "10047"
        }
      ]
    },
    {
      "tag_type": "keyword",
      "pos_sentences": [
        {
          "name": "正则表达式2221",
          "id": "10109"
        },
        {
          "name": "关键字22223",
          "id": "10108"
        },
        {
          "name": "关键字11164",
          "id": "10107"
        }
      ]
    }
  ],
  "sentence_name": "句子名称85"
}

相关文档