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

Miscellaneous Operations - Get Resource Details

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

Возвращает сведения о текущем ресурсе.

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

Параметры URI

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

string (uri)

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

string

minLength: 1

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

Ответы

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

DocumentIntelligenceResourceDetails

Запрос выполнен успешно.
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 Resource Details

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

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

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

Код состояния:
200 
{
  "customDocumentModels": {
    "count": 2,
    "limit": 13
  }
}

Определения

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

Сведения о пользовательских моделях документов.
DocumentIntelligenceError

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

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

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

Общие сведения о текущем ресурсе.

CustomDocumentModelsDetails

Object

Сведения о пользовательских моделях документов.

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

integer (int32)

Количество пользовательских моделей документов в текущем ресурсе.
limit

integer (int32)

Максимальное количество пользовательских моделей документов, поддерживаемых в текущем ресурсе.

DocumentIntelligenceError

Object

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

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

string

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

DocumentIntelligenceError[]

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

DocumentIntelligenceInnerError

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

string

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

string

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

DocumentIntelligenceErrorResponse

Object

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

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

DocumentIntelligenceError

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

DocumentIntelligenceInnerError

Object

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

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

string

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

DocumentIntelligenceInnerError

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

string

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

DocumentIntelligenceResourceDetails

Object

Общие сведения о текущем ресурсе.

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

CustomDocumentModelsDetails

Сведения о пользовательских моделях документов.