Miscellaneous - Get Resource Info

Referens

Tjänst:: Azure AI Services

API-version:: 2023-07-31

Returnera information om den aktuella resursen.

GET {endpoint}/formrecognizer/info?api-version=2023-07-31

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Begärd API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Svar

Name	Typ	Description
200 OK	ResourceDetails	OK.
Other Status Codes	ErrorResponse	Fel påträffades.

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Typ: apiKey
I: header

Exempel

Get Resource Details

Exempelbegäran

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/info?api-version=2023-07-31

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
CustomDocumentModelsDetails	Information om anpassade dokumentmodeller.
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
InnerError	Detaljerat fel.
QuotaDetails	Använd kvot, begränsa och nästa återställningsdatum/tid.
ResourceDetails	Allmän information om den aktuella resursen.

CustomDocumentModelsDetails

Information om anpassade dokumentmodeller.

Name	Typ	Description
count	integer	Antal anpassade dokumentmodeller i den aktuella resursen.
limit	integer	Maximalt antal anpassade dokumentmodeller som stöds i den aktuella resursen.

Error

Felinformation.

Name	Typ	Description
code	string	Felkod.
details	Error[]	Lista över detaljerade fel.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Detaljerat fel.

Name	Typ	Description
code	string	Felkod.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.

QuotaDetails

Använd kvot, begränsa och nästa återställningsdatum/tid.

Name	Typ	Description
quota	integer	Resurskvotgräns.
quotaResetDateTime	string	Datum/tid då resurskvotanvändningen återställs.
used	integer	Mängden resurskvot som används.

ResourceDetails

Allmän information om den aktuella resursen.

Name	Typ	Description
customDocumentModels	CustomDocumentModelsDetails	Information om anpassade dokumentmodeller.
customNeuralDocumentModelBuilds	QuotaDetails	Använd kvot, begränsa och nästa återställningsdatum/tid.

Dela via