Document Classifiers - List Classifiers

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

GET {endpoint}/documentintelligence/documentClassifiers?api-version=2024-02-29-preview

Параметры URI

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

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string uuid	Непрозрачный, глобально уникальный, созданный клиентом строковый идентификатор для запроса.

Ответы

Имя	Тип	Описание
200 OK	PagedDocumentClassifierDetails	Запрос выполнен успешно. Headers x-ms-client-request-id: string
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

Примеры

Get Document Classifiers

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 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": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        }
      }
    },
    {
      "classifierId": "classifier2",
      "description": "Classifier2 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-02-29-preview",
      "docTypes": {
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        },
        "formC": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formCDocs/"
          }
        }
      }
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?nextLink=nextLinkData"
}

Определения

Имя	Описание
AzureBlobContentSource	содержимое Хранилище BLOB-объектов Azure.
AzureBlobFileListContentSource	Список файлов в Хранилище BLOB-объектов Azure.
ClassifierDocumentTypeDetails	Сведения о типе документа классификатора.
ContentSourceKind	Тип источника контента.
DocumentClassifierDetails	Сведения о классификаторе документов.
Error	Объект ошибки.
ErrorResponse	Объект ответа об ошибке.
InnerError	Объект , содержащий более конкретные сведения об ошибке.
PagedDocumentClassifierDetails	Коллекция Paged элементов DocumentClassifierDetails
Warning	Объект ошибки.

AzureBlobContentSource

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

Имя	Тип	Описание
containerUrl	string	Хранилище BLOB-объектов Azure URL-адрес контейнера.
prefix	string	Префикс имени BLOB-объекта.

AzureBlobFileListContentSource

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

Имя	Тип	Описание
containerUrl	string	Хранилище BLOB-объектов Azure URL-адрес контейнера.
fileList	string	Путь к JSONL-файлу в контейнере с указанием подмножества документов.

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-адресу.

DocumentClassifierDetails

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

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для создания этого классификатора документов.
baseClassifierId	string	Base classifierId, поверх которого был обучен классификатор.
classifierId	string	Уникальное имя классификатора документов.
createdDateTime	string	Дата и время (UTC) создания классификатора документов.
description	string	Описание классификатора документов.
docTypes	<string,  ClassifierDocumentTypeDetails>	Список типов документов для классификации.
expirationDateTime	string	Дата и время (UTC), когда истечет срок действия классификатора документов.
warnings	Warning[]	Список предупреждений, возникших при сборке классификатора.

Error

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

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

ErrorResponse

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

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

InnerError

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

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

PagedDocumentClassifierDetails

Коллекция Paged элементов DocumentClassifierDetails

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу элементов
value	DocumentClassifierDetails[]	Элементы DocumentClassifierDetails на этой странице

Warning

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

Имя	Тип	Описание
code	string	Один из серверных наборов кодов предупреждений.
message	string	Понятное представление предупреждения.
target	string	Целевой объект ошибки.