Document Models - List Models

Szolgáltatás:

Azure AI Services

API-verzió:

2022-08-31

Az összes dokumentummodell listázása

GET {endpoint}/formrecognizer/documentModels?api-version=2022-08-31

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

Válaszok

Name	Típus	Description
200 OK	GetDocumentModelsResponse	OK gombra.
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

Példák

GetDocumentModels

Mintakérelem

HTTP

GET {endpoint}/formrecognizer/documentModels?api-version=2022-08-31

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "modelId": "prebuilt-layout",
      "createdDateTime": "2021-07-30T00:00:00Z",
      "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.",
      "apiVersion": "2022-08-31"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "description": "{modelDescription}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

Definíciók

Name	Description
ApiVersion	API-verzió.
DocumentModelSummary	Dokumentummodell összegzése.
Error	Hibainformáció.
ErrorResponse	Hibaválasz-objektum.
GetDocumentModelsResponse	Dokumentummodellek válaszobjektumának listázása.
InnerError	Részletes hiba.

ApiVersion

API-verzió.

Name	Típus	Description
2022-08-31	string

DocumentModelSummary

Dokumentummodell összegzése.

Name	Típus	Description
apiVersion	string	A dokumentummodell létrehozásához használt API-verzió.
createdDateTime	string	A dokumentummodell létrehozásának dátuma és időpontja (UTC).
description	string	Dokumentummodell leírása.
modelId	string	Egyedi dokumentummodell neve.
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

Error

Hibainformáció.

Name	Típus	Description
code	string	Hibakód.
details	Error[]	Részletes hibák listája.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibainformáció.

GetDocumentModelsResponse

Dokumentummodellek válaszobjektumának listázása.

Name	Típus	Description
nextLink	string	Hivatkozás a dokumentummodellek következő oldalára.
value	DocumentModelSummary[]	Dokumentummodellek listája.

InnerError

Részletes hiba.

Name	Típus	Description
code	string	Hibakód.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.