Document Classifiers - List Classifiers

Service:

Azure AI Services

API Version:

2024-02-29-preview

Alle documentclassificaties weergeven.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	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	PagedDocumentClassifierDetails	De aanvraag is voltooid. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

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

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

Voorbeelden

Get Document Classifiers

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-02-29-preview",
      "docTypes": {
        "formA": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formADocs/"
          }
        },
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        }
      }
    },
    {
      "classifierId": "classifier2",
      "description": "Classifier2 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-02-29-preview",
      "docTypes": {
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        },
        "formC": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formCDocs/"
          }
        }
      }
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?nextLink=nextLinkData"
}

Definities

Name	Description
AzureBlobContentSource	Azure Blob Storage inhoud.
AzureBlobFileListContentSource	Lijst met bestanden in Azure Blob Storage.
ClassifierDocumentTypeDetails	Informatie over het type classificatiedocument.
ContentSourceKind	Type inhoudsbron.
DocumentClassifierDetails	Informatie over documentclassificatie.
Error	Het foutobject.
ErrorResponse	Foutreactieobject.
InnerError	Een object met specifiekere informatie over de fout.
PagedDocumentClassifierDetails	Gepaginade verzameling DocumentClassifierDetails-items
Warning	Het foutobject.

AzureBlobContentSource

Azure Blob Storage inhoud.

Name	Type	Description
containerUrl	string	Azure Blob Storage container-URL.
prefix	string	Blobnaamvoorvoegsel.

AzureBlobFileListContentSource

Lijst met bestanden in Azure Blob Storage.

Name	Type	Description
containerUrl	string	Azure Blob Storage container-URL.
fileList	string	Pad naar een JSONL-bestand in de container waarin een subset van documenten wordt opgegeven.

ClassifierDocumentTypeDetails

Informatie over het type classificatiedocument.

Name	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage bestandslijst met de trainingsgegevens voor een type classificatiedocument. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage locatie met de trainingsgegevens voor een type classificatiedocument. 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 met afzonderlijke bestanden in een Azure Blob Storage container.
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 waarop 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.
expirationDateTime	string	De datum en tijd (UTC) waarop de documentclassificatie verloopt.
warnings	Warning[]	Lijst met waarschuwingen die zijn opgetreden tijdens het bouwen van de classificatie.

Error

Het foutobject.

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

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutgegevens.

InnerError

Een object met specifiekere informatie over de fout.

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

PagedDocumentClassifierDetails

Gepaginade verzameling DocumentClassifierDetails-items

Name	Type	Description
nextLink	string	De koppeling naar de volgende pagina met items
value	DocumentClassifierDetails[]	De DocumentClassifierDetails-items op deze pagina

Warning

Het foutobject.

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