Document Classifiers - List Classifiers

서비스:

Azure AI Services

API 버전:

2024-11-30

모든 문서 분류자를 나열합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string uri	문서 인텔리전스 서비스 엔드포인트입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string uuid	요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

응답

Name	형식	Description
200 OK	PagedDocumentClassifierDetails	요청이 성공했습니다. 헤더 x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	예기치 않은 오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

형식: apiKey
In(다음 안에): header

OAuth2Auth

형식: oauth2
Flow: accessCode
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL: https://login.microsoftonline.com/common/oauth2/token

범위

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

예제

Get Document Classifiers

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 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": {
          "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-11-30",
      "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"
}

정의

Name	Description
AzureBlobContentSource	Azure Blob Storage 콘텐츠.
AzureBlobFileListContentSource	Azure Blob Storage의 파일 목록입니다.
ClassifierDocumentTypeDetails	분류자 문서 형식 정보입니다.
ContentSourceKind	콘텐츠 원본의 형식입니다.
DocumentClassifierDetails	문서 분류자 정보입니다.
DocumentIntelligenceError	오류 개체입니다.
DocumentIntelligenceErrorResponse	오류 응답 개체입니다.
DocumentIntelligenceInnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다.
DocumentIntelligenceWarning	오류 개체입니다.
PagedDocumentClassifierDetails	DocumentClassifierDetails 항목의 페이징된 컬렉션

AzureBlobContentSource

Azure Blob Storage 콘텐츠.

Name	형식	Description
containerUrl	string	Azure Blob Storage 컨테이너 URL입니다.
prefix	string	Blob 이름 접두사입니다.

AzureBlobFileListContentSource

Azure Blob Storage의 파일 목록입니다.

Name	형식	Description
containerUrl	string	Azure Blob Storage 컨테이너 URL입니다.
fileList	string	문서의 하위 집합을 지정하는 컨테이너 내의 JSONL 파일 경로입니다.

ClassifierDocumentTypeDetails

분류자 문서 형식 정보입니다.

Name	형식	Description
azureBlobFileListSource	AzureBlobFileListContentSource	분류자 문서 형식에 대한 학습 데이터를 지정하는 Azure Blob Storage 파일 목록입니다. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
azureBlobSource	AzureBlobContentSource	분류자 문서 형식에 대한 학습 데이터를 포함하는 Azure Blob Storage 위치입니다. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
sourceKind	ContentSourceKind	학습 데이터 원본의 유형입니다.

ContentSourceKind

콘텐츠 원본의 형식입니다.

Name	형식	Description
azureBlob	string	Azure Blob Storage 컨테이너 내의 경로에 있는 파일입니다.
azureBlobFileList	string	Azure Blob Storage 컨테이너의 개별 파일을 지정하는 파일 목록입니다.
base64	string	Base64 인코딩을 통해 표시되는 콘텐츠입니다.
url	string	특정 URL의 콘텐츠입니다.

DocumentClassifierDetails

문서 분류자 정보입니다.

Name	형식	Description
apiVersion	string	이 문서 분류자를 만드는 데 사용되는 API 버전입니다.
baseClassifierId	string	분류자를 학습시킨 기준 classifierId입니다.
classifierId	string	고유한 문서 분류자 이름입니다.
createdDateTime	string	문서 분류자를 만든 날짜 및 시간(UTC)입니다.
description	string	문서 분류자 설명입니다.
docTypes	<string,  ClassifierDocumentTypeDetails>	분류할 문서 형식 목록입니다.
expirationDateTime	string	문서 분류자의 만료 날짜 및 시간(UTC)입니다.
modifiedDateTime	string	문서 모델이 마지막으로 수정된 날짜 및 시간(UTC)입니다.
warnings	DocumentIntelligenceWarning[]	분류자를 빌드하는 동안 발생한 경고 목록입니다.

DocumentIntelligenceError

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	DocumentIntelligenceError[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	DocumentIntelligenceInnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

DocumentIntelligenceErrorResponse

오류 응답 개체입니다.

Name	형식	Description
error	DocumentIntelligenceError	오류 정보입니다.

DocumentIntelligenceInnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror	DocumentIntelligenceInnerError	내부 오류입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

DocumentIntelligenceWarning

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 경고 코드 집합 중 하나입니다.
message	string	사람이 읽을 수 있는 경고 표현입니다.
target	string	오류의 대상입니다.

PagedDocumentClassifierDetails

DocumentClassifierDetails 항목의 페이징된 컬렉션

Name	형식	Description
nextLink	string	항목의 다음 페이지에 대한 링크
value	DocumentClassifierDetails[]	이 페이지의 DocumentClassifierDetails 항목