Miscellaneous Operations - Get Resource Info

Ссылка

Service:: Azure AI Services

API Version:: 2024-02-29-preview

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	ResourceDetails	Запрос выполнен успешно.
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 Resource Details

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "customDocumentModels": {
    "count": 2,
    "limit": 13
  },
  "customNeuralDocumentModelBuilds": {
    "used": 1,
    "quota": 10,
    "quotaResetDateTime": "2023-03-01T00:00:00Z"
  }
}

Определения

Имя	Описание
CustomDocumentModelsDetails	Сведения о пользовательских моделях документов.
Error	Объект ошибки.
ErrorResponse	Объект ответа об ошибке.
InnerError	Объект , содержащий более конкретные сведения об ошибке.
QuotaDetails	Используемая квота, ограничение и следующий сброс даты и времени.
ResourceDetails	Общие сведения о текущем ресурсе.

CustomDocumentModelsDetails

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

Имя	Тип	Описание
count	integer	Количество пользовательских моделей документов в текущем ресурсе.
limit	integer	Максимальное количество пользовательских моделей документов, поддерживаемых в текущем ресурсе.

Error

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

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

ErrorResponse

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

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

InnerError

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

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

QuotaDetails

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

Имя	Тип	Описание
quota	integer	Ограничение квоты ресурсов.
quotaResetDateTime	string	Дата и время сброса использования квоты ресурсов.
used	integer	Объем используемой квоты ресурсов.

ResourceDetails

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

Имя	Тип	Описание
customDocumentModels	CustomDocumentModelsDetails	Сведения о пользовательских моделях документов.
customNeuralDocumentModelBuilds	QuotaDetails	Используемая квота, ограничение и следующий сброс даты и времени.

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