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

Document Classifiers - List Classifiers

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

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

GET {endpoint}/documentintelligence/documentClassifiers?api-version=2024-11-30

Параметры URI

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

string (uri)

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

string

minLength: 1

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

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

Имя Обязательно Тип Описание
x-ms-client-request-id

string (uuid)

Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Ответы

Имя Тип Описание
200 OK

PagedDocumentClassifierDetails

Запрос выполнен успешно.

Заголовки

x-ms-client-request-id: string
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

Примеры

Get Document Classifiers

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

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

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

Код состояния:
200 
{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "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-11-30",
      "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

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

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

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

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

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

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

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-файлу в контейнере с указанием подмножества документов.

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

DocumentClassifierDetails

Object

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

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

string

Версия API, используемая для создания этого классификатора документов.
baseClassifierId

string

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

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

string

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

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

string (date-time)

Дата и время (UTC) при создании классификатора документов.
description

string

maxLength: 4096

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

<string,  ClassifierDocumentTypeDetails>

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

string (date-time)

Дата и время (UTC) при истечении срока действия классификатора документа.
modifiedDateTime

string (date-time)

Дата и время (UTC) при последнем изменении модели документа.
warnings

DocumentIntelligenceWarning[]

Список предупреждений, возникших при создании классификатора.

DocumentIntelligenceError

Object

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

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

string

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

DocumentIntelligenceError[]

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

DocumentIntelligenceInnerError

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

string

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

string

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

DocumentIntelligenceErrorResponse

Object

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

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

DocumentIntelligenceError

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

DocumentIntelligenceInnerError

Object

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

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

string

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

DocumentIntelligenceInnerError

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

string

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

DocumentIntelligenceWarning

Object

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

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

string

Один из определяемых сервером набор кодов предупреждений.
message

string

Доступное для чтения представление предупреждения.
target

string

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

PagedDocumentClassifierDetails

Object

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

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

string (uri)

Ссылка на следующую страницу элементов
value

DocumentClassifierDetails[]

Элементы DocumentClassifierDetails на этой странице