Document Classifiers - Get Classifier

Service:

Azure AI Services

API-versie:

2024-11-30

Hiermee haalt u gedetailleerde informatie over documentclassificatie op.

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

URI-parameters

Name	In	Vereist	Type	Description
classifierId	path	True	string	Unieke naam van documentclassificatie. Regex-patroon: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Het Eindpunt van de Document Intelligence-service.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	DocumentClassifierDetails	De aanvraag is voltooid. Kopteksten x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Get Document Classifier

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier 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": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Definities

Name	Description
AzureBlobContentSource	Azure Blob Storage-inhoud.
AzureBlobFileListContentSource	Bestandslijst in Azure Blob Storage.
ClassifierDocumentTypeDetails	Informatie over het type classificatiedocument.
ContentSourceKind	Type inhoudsbron.
DocumentClassifierDetails	Informatie over documentclassificatie.
DocumentIntelligenceError	Het foutobject.
DocumentIntelligenceErrorResponse	Foutantwoordobject.
DocumentIntelligenceInnerError	Een object met meer specifieke informatie over de fout.
DocumentIntelligenceWarning	Het foutobject.

AzureBlobContentSource

Azure Blob Storage-inhoud.

Name	Type	Description
containerUrl	string	Url van Azure Blob Storage-container.
prefix	string	Voorvoegsel van blobnaam.

AzureBlobFileListContentSource

Bestandslijst in Azure Blob Storage.

Name	Type	Description
containerUrl	string	Url van Azure Blob Storage-container.
fileList	string	Pad naar een JSONL-bestand in de container die een subset van documenten opgeeft.

ClassifierDocumentTypeDetails

Informatie over het type classificatiedocument.

Name	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lijst met Azure Blob Storage-bestanden waarin de trainingsgegevens voor een classificatiedocumenttype worden opgegeven. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage-locatie met de trainingsgegevens voor een classificatiedocumenttype. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
sourceKind	ContentSourceKind	Type trainingsgegevensbron.

ContentSourceKind

Type inhoudsbron.

Name	Type	Description
azureBlob	string	Bestanden in een pad binnen een Azure Blob Storage-container.
azureBlobFileList	string	Een bestandslijst waarin afzonderlijke bestanden in een Azure Blob Storage-container worden opgegeven.
base64	string	Inhoud die wordt weergegeven via Base64-codering.
url	string	Inhoud op een specifieke URL.

DocumentClassifierDetails

Informatie over documentclassificatie.

Name	Type	Description
apiVersion	string	API-versie die wordt gebruikt om deze documentclassificatie te maken.
baseClassifierId	string	Basisclassificatie-id bovenop waarvan de classificatie is getraind.
classifierId	string	Unieke naam van documentclassificatie.
createdDateTime	string	De datum en tijd (UTC) waarop de documentclassificatie is gemaakt.
description	string	Beschrijving van documentclassificatie.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lijst met documenttypen die moeten worden geclassificeerd op basis van.
expirationDateTime	string	Datum en tijd (UTC) wanneer de documentclassificatie verloopt.
modifiedDateTime	string	De datum en tijd (UTC) waarop het documentmodel voor het laatst is gewijzigd.
warnings	DocumentIntelligenceWarning[]	Lijst met waarschuwingen die zijn aangetroffen tijdens het bouwen van de classificatie.

DocumentIntelligenceError

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	DocumentIntelligenceError[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	DocumentIntelligenceInnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

DocumentIntelligenceErrorResponse

Foutantwoordobject.

Name	Type	Description
error	DocumentIntelligenceError	Foutinformatie.

DocumentIntelligenceInnerError

Een object met meer specifieke informatie over de fout.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	DocumentIntelligenceInnerError	Interne fout.
message	string	Een leesbare weergave van de fout.

DocumentIntelligenceWarning

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set waarschuwingscodes.
message	string	Een leesbare weergave van de waarschuwing.
target	string	Het doel van de fout.