Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Создает пользовательский классификатор документов.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Конечная точка службы аналитики документов.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
classifierId	True	string	Уникальное имя классификатора документов.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Список типов документов для классификации.
baseClassifierId		string	Базовый classifierId, поверх которого необходимо обучить классификатор.
description		string	Описание классификатора документов.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос был принят для обработки, но обработка еще не завершена. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

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

Примеры

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

Определения

Имя	Описание
AzureBlobContentSource	Хранилище BLOB-объектов Azure содержимого.
AzureBlobFileListContentSource	Список файлов в Хранилище BLOB-объектов Azure.
BuildDocumentClassifierRequest	Текст запроса для создания нового пользовательского классификатора документов.
ClassifierDocumentTypeDetails	Сведения о типе документа классификатора.
ContentSourceKind	Тип источника контента.
Error	Объект error.
ErrorResponse	Объект ответа об ошибке.
InnerError	Объект , содержащий более конкретные сведения об ошибке.

AzureBlobContentSource

Хранилище BLOB-объектов Azure содержимого.

Имя	Тип	Описание
containerUrl	string	ХРАНИЛИЩЕ BLOB-ОБЪЕКТОВ AZURE URL-адрес контейнера.
prefix	string	Префикс имени BLOB-объекта.

AzureBlobFileListContentSource

Список файлов в Хранилище BLOB-объектов Azure.

Имя	Тип	Описание
containerUrl	string	ХРАНИЛИЩЕ BLOB-ОБЪЕКТОВ AZURE URL-адрес контейнера.
fileList	string	Путь к JSONL-файлу в контейнере с указанием подмножества документов.

BuildDocumentClassifierRequest

Текст запроса для создания нового пользовательского классификатора документов.

Имя	Тип	Описание
baseClassifierId	string	Базовый classifierId, поверх которого необходимо обучить классификатор.
classifierId	string	Уникальное имя классификатора документов.
description	string	Описание классификатора документов.
docTypes	<string,  ClassifierDocumentTypeDetails>	Список типов документов для классификации.

ClassifierDocumentTypeDetails

Сведения о типе документа классификатора.

Имя	Тип	Описание
azureBlobFileListSource	AzureBlobFileListContentSource	Хранилище BLOB-объектов Azure список файлов, указывающий обучающие данные для типа документа-классификатора. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Хранилище BLOB-объектов Azure расположение, содержащее обучающие данные для типа документа классификатора. Необходимо указать azureBlobSource или azureBlobFileListSource.
sourceKind	ContentSourceKind	Тип источника данных для обучения.

ContentSourceKind

Тип источника контента.

Имя	Тип	Описание
azureBlob	string	Файлы в пути в контейнере Хранилище BLOB-объектов Azure.
azureBlobFileList	string	Список файлов, указывающий отдельные файлы в контейнере Хранилище BLOB-объектов Azure.
base64	string	Содержимое, представленное в кодировке Base64.
url	string	Содержимое по определенному URL-адресу.

Error

Объект error.

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Удобочитаемое представление ошибки.
target	string	Цель ошибки.

ErrorResponse

Объект ответа об ошибке.

Имя	Тип	Описание
error	Error	Сведения об ошибке.

InnerError

Объект , содержащий более конкретные сведения об ошибке.

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
innererror	InnerError	Внутренняя ошибка.
message	string	Удобочитаемое представление ошибки.