你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Document Classifiers - Get Classifier
获取详细的文档分类器信息。
GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-02-29-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
classifier
|
path | True |
string |
唯一的文档分类器名称。 Regex pattern: |
endpoint
|
path | True |
string |
文档智能服务终结点。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-request-id |
string uuid |
请求的不透明、全局唯一的客户端生成的字符串标识符。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
请求已成功。 Headers x-ms-client-request-id: string |
|
Other Status Codes |
意外的错误响应。 |
安全性
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token URL:
https://login.microsoftonline.com/common/oauth2/token
Scopes
名称 | 说明 |
---|---|
https://cognitiveservices.azure.com/.default |
示例
Get Document Classifier
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier?api-version=2024-02-29-preview
Sample Response
{
"classifierId": "myClassifier",
"description": "Classifier description",
"createdDateTime": "2022-07-30T00:00:00Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"formA": {
"azureBlobSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"prefix": "formADocs/"
}
},
"formB": {
"azureBlobFileListSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"fileList": "formB.jsonl"
}
}
}
}
定义
名称 | 说明 |
---|---|
Azure |
Azure Blob 存储内容。 |
Azure |
Azure Blob 存储中的文件列表。 |
Classifier |
分类器文档类型信息。 |
Content |
内容源的类型。 |
Document |
文档分类器信息。 |
Error |
错误对象。 |
Error |
错误响应对象。 |
Inner |
包含有关错误的更具体信息的对象。 |
Warning |
错误对象。 |
AzureBlobContentSource
Azure Blob 存储内容。
名称 | 类型 | 说明 |
---|---|---|
containerUrl |
string |
Azure Blob 存储容器 URL。 |
prefix |
string |
Blob 名称前缀。 |
AzureBlobFileListContentSource
Azure Blob 存储中的文件列表。
名称 | 类型 | 说明 |
---|---|---|
containerUrl |
string |
Azure Blob 存储容器 URL。 |
fileList |
string |
指定文档子集的容器中 JSONL 文件的路径。 |
ClassifierDocumentTypeDetails
分类器文档类型信息。
名称 | 类型 | 说明 |
---|---|---|
azureBlobFileListSource |
Azure Blob 存储指定分类器文档类型的训练数据的文件列表。 必须指定 azureBlobSource 或 azureBlobFileListSource。 |
|
azureBlobSource |
Azure Blob 存储包含分类器文档类型的训练数据的位置。 必须指定 azureBlobSource 或 azureBlobFileListSource。 |
|
sourceKind |
训练数据源的类型。 |
ContentSourceKind
内容源的类型。
名称 | 类型 | 说明 |
---|---|---|
azureBlob |
string |
Azure Blob 存储容器内路径中的文件。 |
azureBlobFileList |
string |
指定Azure Blob 存储容器中的单个文件的文件列表。 |
base64 |
string |
通过 Base64 编码表示的内容。 |
url |
string |
特定 URL 处的内容。 |
DocumentClassifierDetails
文档分类器信息。
名称 | 类型 | 说明 |
---|---|---|
apiVersion |
string |
用于创建此文档分类器的 API 版本。 |
baseClassifierId |
string |
对分类器进行训练的基 classifierId。 |
classifierId |
string |
唯一的文档分类器名称。 |
createdDateTime |
string |
创建文档分类器时 (UTC) 日期和时间。 |
description |
string |
文档分类器说明。 |
docTypes |
<string,
Classifier |
要对其分类的文档类型的列表。 |
expirationDateTime |
string |
文档分类器过期 (UTC) 日期和时间。 |
warnings |
Warning[] |
生成分类器时遇到的警告列表。 |
Error
错误对象。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的一组错误代码中的一个。 |
details |
Error[] |
有关导致此项报告错误的特定错误的详细信息数组。 |
innererror |
一个 对象,该对象包含比当前对象更具体的错误信息。 |
|
message |
string |
错误的用户可读表示形式。 |
target |
string |
错误的目标。 |
ErrorResponse
错误响应对象。
名称 | 类型 | 说明 |
---|---|---|
error |
错误信息。 |
InnerError
包含有关错误的更具体信息的对象。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的一组错误代码中的一个。 |
innererror |
内部错误。 |
|
message |
string |
错误的用户可读表示形式。 |
Warning
错误对象。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的警告代码集之一。 |
message |
string |
警告的可读表示形式。 |
target |
string |
错误的目标。 |