Dela via


Document Classifiers - Get Classifier

Hämtar detaljerad information om dokumentklassificeraren.

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

URI-parametrar

Name I Obligatorisk Typ Description
classifierId
path True

string

Unikt dokumentklassificerarenamn.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

endpoint
path True

string

Slutpunkten för dokumentinformationstjänsten.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string

uuid

En täckande, globalt unik, klientgenererad strängidentifierare för begäran.

Svar

Name Typ Description
200 OK

DocumentClassifierDetails

Begäran har slutförts.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

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

Exempel

Get Document Classifier

Sample Request

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

Sample Response

{
  "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"
      }
    }
  }
}

Definitioner

Name Description
AzureBlobContentSource

Azure Blob Storage innehåll.

AzureBlobFileListContentSource

Fillista i Azure Blob Storage.

ClassifierDocumentTypeDetails

Information om dokumenttyp för klassificerare.

ContentSourceKind

Typ av innehållskälla.

DocumentClassifierDetails

Information om dokumentklassificerare.

Error

Felobjektet.

ErrorResponse

Felsvarsobjekt.

InnerError

Ett objekt som innehåller mer specifik information om felet.

Warning

Felobjektet.

AzureBlobContentSource

Azure Blob Storage innehåll.

Name Typ Description
containerUrl

string

Azure Blob Storage container-URL.

prefix

string

Prefix för blobnamn.

AzureBlobFileListContentSource

Fillista i Azure Blob Storage.

Name Typ Description
containerUrl

string

Azure Blob Storage container-URL.

fileList

string

Sökväg till en JSONL-fil i containern som anger en delmängd av dokument.

ClassifierDocumentTypeDetails

Information om dokumenttyp för klassificerare.

Name Typ Description
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage fillista som anger träningsdata för en dokumenttyp för en klassificerare. Antingen azureBlobSource eller azureBlobFileListSource måste anges.

azureBlobSource

AzureBlobContentSource

Azure Blob Storage plats som innehåller träningsdata för en dokumenttyp för klassificerare. Antingen azureBlobSource eller azureBlobFileListSource måste anges.

sourceKind

ContentSourceKind

Typ av träningsdatakälla.

ContentSourceKind

Typ av innehållskälla.

Name Typ Description
azureBlob

string

Filer i en sökväg i en Azure Blob Storage container.

azureBlobFileList

string

En fillista som anger enskilda filer i en Azure Blob Storage container.

base64

string

Innehåll som representeras via Base64-kodning.

url

string

Innehåll på en specifik URL.

DocumentClassifierDetails

Information om dokumentklassificerare.

Name Typ Description
apiVersion

string

API-version som används för att skapa den här dokumentklassificeraren.

baseClassifierId

string

Base classifierId ovanpå vilket klassificeraren tränades.

classifierId

string

Unikt dokumentklassificerarenamn.

createdDateTime

string

Datum och tid (UTC) när dokumentklassificeraren skapades.

description

string

Beskrivning av dokumentklassificerare.

docTypes

<string,  ClassifierDocumentTypeDetails>

Lista över dokumenttyper att klassificera mot.

expirationDateTime

string

Datum och tid (UTC) när dokumentklassificeraren upphör att gälla.

warnings

Warning[]

Lista över varningar som påträffades när klassificeraren byggdes.

Error

Felobjektet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.

details

Error[]

En matris med information om specifika fel som ledde till det rapporterade felet.

innererror

InnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En mänsklig läsbar representation av felet.

target

string

Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name Typ Description
error

Error

Felinformation.

InnerError

Ett objekt som innehåller mer specifik information om felet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.

innererror

InnerError

Inre fel.

message

string

En mänsklig läsbar representation av felet.

Warning

Felobjektet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning varningskoder.

message

string

En läsbar representation av varningen.

target

string

Målet för felet.