Поделиться через

Document Classifiers - Build Classifier

  • Ссылка
Служба:
Azure AI Services
Версия API:
2024-11-30

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

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (uri)

Конечная точка службы аналитики документов.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

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

Имя Обязательно Тип Описание
classifierId True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Уникальное имя классификатора документов.
docTypes True

<string,  ClassifierDocumentTypeDetails>

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

boolean

Разрешить перезапись существующего классификатора с тем же именем.
baseClassifierId

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Базовый классификаторId поверх которого необходимо обучить классификатор.
description

string

maxLength: 4096

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

Ответы

Имя Тип Описание
202 Accepted

Запрос был принят для обработки, но обработка еще не завершена.

Заголовки

  • Operation-Location: string
  • Retry-After: integer
Other Status Codes

DocumentIntelligenceErrorResponse

Непредвиденное сообщение об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя Описание
https://cognitiveservices.azure.com/.default

Примеры

Build Document Classifier

Образец запроса

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-11-30

{
  "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"
      }
    }
  }
}

Пример ответа

Код состояния:
202 
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Определения

Имя Описание
AzureBlobContentSource

Содержимое хранилища BLOB-объектов Azure.
AzureBlobFileListContentSource

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

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

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

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

Объект ошибки.
DocumentIntelligenceErrorResponse

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

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

AzureBlobContentSource

Object

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

Имя Тип Описание
containerUrl

string (uri)

URL-адрес контейнера хранилища BLOB-объектов Azure.
prefix

string

Префикс имени BLOB-объекта.

AzureBlobFileListContentSource

Object

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

Имя Тип Описание
containerUrl

string (uri)

URL-адрес контейнера хранилища BLOB-объектов Azure.
fileList

string

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

BuildDocumentClassifierRequest

Object

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

Имя Тип Default value Описание
allowOverwrite

boolean

False

Разрешить перезапись существующего классификатора с тем же именем.
baseClassifierId

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Базовый классификаторId поверх которого необходимо обучить классификатор.
classifierId

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Уникальное имя классификатора документов.
description

string

maxLength: 4096

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

<string,  ClassifierDocumentTypeDetails>

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

ClassifierDocumentTypeDetails

Object

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

Имя Тип Описание
azureBlobFileListSource

AzureBlobFileListContentSource

Список файлов хранилища BLOB-объектов Azure, указывающий обучающие данные для типа документа классификатора. Необходимо указать azureBlobSource или azureBlobFileListSource.
azureBlobSource

AzureBlobContentSource

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

ContentSourceKind

Тип источника данных обучения.

ContentSourceKind

Перечисление

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

Значение Описание
azureBlob

Файлы в пути в контейнере хранилища BLOB-объектов Azure.
azureBlobFileList

Список файлов, указывающий отдельные файлы в контейнере хранилища BLOB-объектов Azure.
base64

Содержимое, представленное с помощью кодировки Base64.
url

Содержимое по определенному URL-адресу.

DocumentIntelligenceError

Object

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

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
details

DocumentIntelligenceError[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

DocumentIntelligenceInnerError

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

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

DocumentIntelligenceErrorResponse

Object

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

Имя Тип Описание
error

DocumentIntelligenceError

Сведения об ошибке.

DocumentIntelligenceInnerError

Object

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

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
innererror

DocumentIntelligenceInnerError

Внутренняя ошибка.
message

string

Читаемое пользователем представление ошибки.