你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
成功部署模型后，可以查询部署，根据分配给部署的模型对文本进行分类。 你可以通过预测 API 或通过客户端库 (Azure SDK) 以编程方式查询部署。
向模型发送文本分类请求（REST API）
首先需要获取资源密钥和终结点：
在 Azure 门户中，转到资源概述页面
在左侧菜单中，选择“密钥和终结点”。 使用端点和密钥来进行 API 请求
提交自定义文本分类任务
使用此 POST 请求启动文本分类任务。
{ENDPOINT}/language/analyze-text/jobs?api-version={API-VERSION}
| 占位符 | 值 | 示例 |
|---|---|---|
{ENDPOINT} |
用于对 API 请求进行身份验证的终结点。 | https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
要调用的 API 版本。 引用的值适用于已发布的最新版本。 有关详细信息， 请参阅模型生命周期。 | 2022-05-01 |
头文件
| 键 | 值 |
|---|---|
| Ocp-Apim-Subscription-Key | 你的密钥，用于提供对此 API 的访问权限。 |
Body
- 多标签分类
- 单标签分类
{
"displayName": "Classifying documents",
"analysisInput": {
"documents": [
{
"id": "1",
"language": "{LANGUAGE-CODE}",
"text": "Text1"
},
{
"id": "2",
"language": "{LANGUAGE-CODE}",
"text": "Text2"
}
]
},
"tasks": [
{
"kind": "CustomMultiLabelClassification",
"taskName": "Multi Label Classification",
"parameters": {
"projectName": "{PROJECT-NAME}",
"deploymentName": "{DEPLOYMENT-NAME}"
}
}
]
}
| 键 | 占位符 | 值 | 示例 |
|---|---|---|---|
displayName |
{JOB-NAME} |
作业名称。 | MyJobName |
documents |
[{}，{}] | 要对其运行任务的文档列表。 | [{},{}] |
id |
{DOC-ID} |
文档名称或 ID。 | doc1 |
language |
{LANGUAGE-CODE} |
指定文档语言代码的字符串。 如果未指定此密钥，该服务将假定在项目创建时选择项目的默认语言。 有关支持语言代码的列表，请参阅语言支持。 | en-us |
text |
{DOC-TEXT} |
要对其运行任务的文档任务。 | Lorem ipsum dolor sit amet |
tasks |
要执行的任务列表。 | [] |
|
taskName |
CustomMultiLabelClassification | 任务名称 | CustomMultiLabelClassification |
parameters |
要传递给任务的参数列表。 | ||
project-name |
{PROJECT-NAME} |
项目名称。 此值区分大小写。 | myProject |
deployment-name |
{DEPLOYMENT-NAME} |
部署的名称。 此值区分大小写。 | prod |
响应
你会收到202状态码响应，表示操作成功。 在响应头中，提取 。
operation-location 的格式如下：
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
可以使用此 URL 查询任务完成状态，并在任务完成时获取结果。
获取任务结果 （Azure SDK）
使用以下 GET 请求查询文本分类任务的状态/结果。
{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
| 占位符 | 值 | 示例 |
|---|---|---|
{ENDPOINT} |
用于对 API 请求进行身份验证的终结点。 | https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
要调用的 API 版本。 引用的值适用于最新发布的 模型版本 。 | 2022-05-01 |
头文件
| 键 | 值 |
|---|---|
| Ocp-Apim-Subscription-Key | 你的密钥，用于提供对此 API 的访问权限。 |
响应正文
响应将是具有以下参数的 JSON 文档。
- 多标签分类
- 单标签分类
{
"createdDateTime": "2021-05-19T14:32:25.578Z",
"displayName": "MyJobName",
"expirationDateTime": "2021-05-19T14:32:25.578Z",
"jobId": "xxxx-xxxxxx-xxxxx-xxxx",
"lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
"status": "succeeded",
"tasks": {
"completed": 1,
"failed": 0,
"inProgress": 0,
"total": 1,
"items": [
{
"kind": "customMultiClassificationTasks",
"taskName": "Classify documents",
"lastUpdateDateTime": "2020-10-01T15:01:03Z",
"status": "succeeded",
"results": {
"documents": [
{
"id": "{DOC-ID}",
"classes": [
{
"category": "Class_1",
"confidenceScore": 0.0551877357
}
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-04-01"
}
}
]
}
}
首先需要获取资源密钥和终结点：
在 Azure 门户中，转到资源概述页面
在左侧菜单中，选择“密钥和终结点”。 终结点和密钥用于 API 请求。
下载并安装所选语言的客户端库包：
语言 包版本 .NET 5.2.0-beta.3 Java 5.2.0-beta.3 JavaScript 6.0.0-beta.1 Python 5.2.0b4 安装客户端库后，请在 GitHub 上使用以下示例开始调用 API。
单标签分类：
多标签分类：
请参阅以下有关客户端和返回对象的参考文档。