Miscellaneous Operations - Get Document Classifier Build Operation

Service:

Azure AI Services

API-versie:

2024-07-31-preview

Hiermee haalt u bewerkingsgegevens op.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&api-version=2024-07-31-preview

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	Het Eindpunt van de Document Intelligence-service.
operationId	path	True	string	Bewerkings-id
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	DocumentClassifierBuildOperationDetails	De aanvraag is voltooid. Kopteksten 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
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 Operation - Document Classifier Build

Voorbeeldaanvraag

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierBuildOperation&api-version=2024-07-31-preview

Voorbeeldrespons

Statuscode:

200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentClassifierBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier",
  "result": {
    "classifierId": "myClassifier",
    "description": "Classifier description",
    "createdDateTime": "2022-07-30T00:00:00Z",
    "expirationDateTime": "2023-01-01T00:00:00Z",
    "apiVersion": "2024-07-31-preview",
    "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.
DocumentClassifierBuildOperationDetails	Bewerkingsantwoordobject ophalen.
DocumentClassifierDetails	Informatie over documentclassificatie.
Error	Het foutobject.
ErrorResponse	Foutantwoordobject.
InnerError	Een object met meer specifieke informatie over de fout.
OperationKind	Type bewerking.
OperationStatus	Bewerkingsstatus.
Warning	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.

DocumentClassifierBuildOperationDetails

Bewerkingsantwoordobject ophalen.

Name	Type	Description
apiVersion	string	API-versie die wordt gebruikt om deze bewerking te maken.
createdDateTime	string	De datum en tijd (UTC) waarop de bewerking is gemaakt.
error	Error	Er is een fout opgetreden.
kind	string: documentClassifierBuild	Type bewerking.
lastUpdatedDateTime	string	Datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id
percentCompleted	integer	Voortgang van de bewerking (0-100).
resourceLocation	string	URL van de resource waarop deze bewerking is gericht.
result	DocumentClassifierDetails	Bewerkingsresultaat bij succes.
status	OperationStatus	Bewerkingsstatus. notStarted, running, completed of failed
tags	object	Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

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.
warnings	Warning[]	Lijst met waarschuwingen die zijn aangetroffen 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 hebben geleid tot deze gemelde fout.
innererror	InnerError	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.

ErrorResponse

Foutantwoordobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met meer specifieke 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 leesbare weergave van de fout.

OperationKind

Type bewerking.

Name	Type	Description
documentClassifierBuild	string	Bouw een nieuw aangepast classificatiemodel.
documentClassifierCopyTo	string	Kopieer een bestaande documentclassificatie naar mogelijk een andere resource, regio of abonnement.
documentModelBuild	string	Een nieuw aangepast documentmodel maken.
documentModelCompose	string	Een nieuw aangepast documentmodel opstellen op basis van bestaande modellen.
documentModelCopyTo	string	Kopieer een bestaand documentmodel naar mogelijk een andere resource, regio of abonnement.

OperationStatus

Bewerkingsstatus.

Name	Type	Description
canceled	string	De bewerking is geannuleerd.
completed	string	De bewerking is voltooid.
failed	string	De bewerking is mislukt.
notStarted	string	De bewerking is nog niet gestart.
running	string	De bewerking wordt uitgevoerd.
succeeded	string	De bewerking is voltooid.

Warning

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.