Document Classifiers - Get Classifier
Hiermee haalt u gedetailleerde informatie over de documentclassificatie op.
GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-02-29-preview
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
classifier
|
path | True |
string |
Unieke naam van documentclassificatie. Regex-patroon: |
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 |
De aanvraag is voltooid. Kopteksten x-ms-client-request-id: string |
|
Other Status Codes |
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
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier?api-version=2024-02-29-preview
Voorbeeldrespons
{
"classifierId": "myClassifier",
"description": "Classifier 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": {
"azureBlobFileListSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"fileList": "formB.jsonl"
}
}
}
}
Definities
Name | Description |
---|---|
Azure |
Azure Blob Storage inhoud. |
Azure |
Lijst met bestanden in Azure Blob Storage. |
Classifier |
Informatie over het type classificatiedocument. |
Content |
Type inhoudsbron. |
Document |
Informatie over documentclassificatie. |
Error |
Het foutobject. |
Error |
Foutreactieobject. |
Inner |
Een object met specifiekere informatie over de fout. |
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 |
Azure Blob Storage bestandslijst met de trainingsgegevens voor een type classificatiedocument. AzureBlobSource of azureBlobFileListSource moet worden opgegeven. |
|
azureBlobSource |
Azure Blob Storage locatie met de trainingsgegevens voor een type classificatiedocument. AzureBlobSource of azureBlobFileListSource moet worden opgegeven. |
|
sourceKind |
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,
Classifier |
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 |
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 |
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 |
Interne fout. |
|
message |
string |
Een door mensen leesbare weergave van de fout. |
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. |