Custom Models - Get

참조

서비스:: Azure AI Services

API 버전:: 2.1

사용자 지정 모델에 대한 자세한 정보를 가져옵니다.

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}

선택적 매개 변수:

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}?includeKeys={includeKeys}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string uuid	모델 식별자입니다.
includeKeys	query		boolean	모델 정보에 추출된 키 목록을 포함합니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string

응답

Name	형식	Description
200 OK	Model	Success
Other Status Codes	ErrorResponse	오류에 대한 추가 세부 정보를 포함하는 성공하지 못한 응답과 함께 제공되는 응답 엔터티입니다.

보안

Ocp-Apim-Subscription-Key

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

예제

Get custom model

샘플 요청

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

샘플 응답

상태 코드:: 200

{
  "modelInfo": {
    "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
    "modelName": "my composed model",
    "status": "ready",
    "createdDateTime": "2019-05-01T10:53:21Z",
    "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
    "attributes": {
      "isComposed": true
    }
  },
  "keys": {
    "clusters": {
      "0": [
        "Invoice",
        "123112313"
      ],
      "1": [
        "Please remit payment to:",
        "Microsoft"
      ]
    }
  },
  "trainResult": {
    "trainingDocuments": [],
    "fields": [],
    "averageModelAccuracy": 0,
    "errors": []
  },
  "composedTrainResults": [
    {
      "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    },
    {
      "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    }
  ]
}

정의

Name	Description
Attributes	선택적 모델 특성입니다.
ErrorInformation
ErrorResponse
FormFieldsReport	사용자 지정 모델 학습 필드에 대한 보고서입니다.
KeysResult	사용자 지정 모델에서 추출한 키입니다.
Model	사용자 지정 모델 가져오기 작업에 대한 응답입니다.
ModelInfo	기본 사용자 지정 모델 정보입니다.
ModelStatus	모델의 상태입니다.
TrainingDocumentInfo	사용자 지정 모델 학습 문서에 대한 보고서입니다.
TrainResult	사용자 지정 모델 학습 결과입니다.
TrainStatus	학습 작업의 상태입니다.

Attributes

선택적 모델 특성입니다.

Name	형식	Default value	Description
isComposed	boolean	False	이 모델이 구성되었나요? (기본값: false).

ErrorInformation

Name	형식	Description
code	string
message	string

ErrorResponse

Name	형식	Description
error	ErrorInformation

FormFieldsReport

사용자 지정 모델 학습 필드에 대한 보고서입니다.

Name	형식	Description
accuracy	number	이 필드에 대한 예상 추출 정확도입니다.
fieldName	string	학습 필드 이름입니다.

KeysResult

사용자 지정 모델에서 추출한 키입니다.

Name	형식	Description
clusters	object	clusterId를 키 목록에 매핑하는 개체입니다.

Model

사용자 지정 모델 가져오기 작업에 대한 응답입니다.

Name	형식	Description
composedTrainResults	TrainResult[]	구성된 모델에 대한 학습 결과입니다.
keys	KeysResult	사용자 지정 모델에서 추출한 키입니다.
modelInfo	ModelInfo	기본 사용자 지정 모델 정보입니다.
trainResult	TrainResult	사용자 지정 모델에 대한 학습 결과입니다.

ModelInfo

기본 사용자 지정 모델 정보입니다.

Name	형식	Description
attributes	Attributes	선택적 모델 특성입니다.
createdDateTime	string	모델을 만든 날짜 및 시간(UTC)입니다.
lastUpdatedDateTime	string	상태 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
modelId	string	모델 식별자입니다.
modelName	string	선택적 사용자 정의 모델 이름(최대 길이: 1024)입니다.
status	ModelStatus	모델의 상태입니다.

ModelStatus

모델의 상태입니다.

Name	형식	Description
creating	string
invalid	string
ready	string

TrainingDocumentInfo

사용자 지정 모델 학습 문서에 대한 보고서입니다.

Name	형식	Description
documentName	string	학습 문서 이름입니다.
errors	ErrorInformation[]	오류 목록입니다.
pages	integer	학습된 총 페이지 수입니다.
status	TrainStatus	학습 작업의 상태입니다.

TrainResult

사용자 지정 모델 학습 결과입니다.

Name	형식	Description
averageModelAccuracy	number	평균 정확도.
errors	ErrorInformation[]	학습 작업 중에 반환된 오류입니다.
fields	FormFieldsReport[]	모델을 학습시키는 데 사용되는 필드 목록과 각 모델에서 보고한 학습 작업 오류입니다.
modelId	string	모델 식별자입니다.
trainingDocuments	TrainingDocumentInfo[]	모델을 학습시키는 데 사용되는 문서 목록과 각 문서에 보고된 오류입니다.

TrainStatus

학습 작업의 상태입니다.

Name	형식	Description
failed	string
partiallySucceeded	string
succeeded	string

다음을 통해 공유