다음을 통해 공유


FormRecognizerClient class

Extends

생성자

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

FormRecognizerClient 클래스의 새 instance 초기화합니다.

상속된 속성

credentials
endpoint

메서드

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

지정된 문서에서 키-값 쌍을 추출합니다. 입력 문서는 'application/pdf', 'image/jpeg' 또는 'image/png'와 같이 지원되는 콘텐츠 형식 중 하나여야 합니다. 성공 응답이 JSON으로 반환됩니다.

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)

일괄 처리 읽기 확인 작업입니다. 응답에는 '읽기 확인 결과 가져오기' 작업에 사용해야 하는 URL이 포함된 'Operation-Location'이라는 필드가 포함되어 있습니다.

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

확인 작업을 읽습니다. 'Batch 읽기 확인' 인터페이스를 사용하는 경우 응답에는 'Operation-Location'이라는 필드가 포함됩니다. 'Operation-Location' 필드에는 '읽음 확인 결과 가져오기' 작업에 사용해야 하는 URL이 포함되어 있습니다.

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)

모델 아티팩트를 삭제합니다.

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)

모델 관련 정보를 가져옵니다.

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)

학습된 모든 사용자 지정 모델에 대한 정보 가져오기

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)

지정된 모델을 학습하는 동안 추출된 키를 검색합니다.

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)

이 인터페이스는 'Batch 읽기 영수증' 작업의 분석 결과를 가져오는 데 사용됩니다. 이 인터페이스의 URL은 'Batch 읽기 확인' 작업에서 반환된 'Operation-Location' 필드에서 검색해야 합니다.

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)

사용자 지정 모델을 만들고 학습합니다. 학습 요청은 외부에서 액세스할 수 있는 Azure Storage Blob 컨테이너 URI(공유 액세스 서명 URI)이거나 로컬 탑재된 드라이브의 데이터 폴더에 대한 유효한 경로인 원본 매개 변수를 포함해야 합니다. 로컬 경로가 지정된 경우 Linux/Unix 경로 형식을 따라야 하며, 입력 탑재 구성 설정값의 루트로 지정된 절대 경로여야 합니다(예: '{Mounts:Input}' 구성 설정값이 '/input'인 경우 유효한 원본 경로는 '/input/contosodataset'). 학습할 모든 데이터는 원본 폴더 바로 아래에 있어야 합니다. 하위 폴더는 지원되지 않습니다. 모델은 'application/pdf', 'image/jpeg' 및 'image/png' 콘텐츠 형식의 문서를 사용하여 학습됩니다." 다른 형식의 콘텐츠는 무시됩니다.

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

상속된 메서드

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

제공된 OperationSpec을 사용하여 채워진 HTTP 요청을 보냅니다.

sendRequest(RequestPrepareOptions | WebResourceLike)

제공된 httpRequest를 보냅니다.

생성자 세부 정보

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

FormRecognizerClient 클래스의 새 instance 초기화합니다.

new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)

매개 변수

credentials
ServiceClientCredentials

클라이언트 구독을 고유하게 식별하는 구독 자격 증명입니다.

endpoint

string

지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus2.api.cognitive.microsoft.com).

options
ServiceClientOptions

매개 변수 옵션

상속된 속성 세부 정보

credentials

credentials: ServiceClientCredentials

속성 값

FormRecognizerClientContext.credentials에서 상속됨

endpoint

endpoint: string

속성 값

string

FormRecognizerClientContext.endpoint에서 상속됨

메서드 세부 정보

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

지정된 문서에서 키-값 쌍을 추출합니다. 입력 문서는 'application/pdf', 'image/jpeg' 또는 'image/png'와 같이 지원되는 콘텐츠 형식 중 하나여야 합니다. 성공 응답이 JSON으로 반환됩니다.

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>

매개 변수

id

string

문서를 분석할 모델 식별자입니다.

formStream
HttpRequestBody

분석할 pdf 문서 또는 이미지(jpg,png) 파일입니다.

반환

Promise<Models.AnalyzeWithCustomModelResponse>

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)

매개 변수

id

string

문서를 분석할 모델 식별자입니다.

formStream
HttpRequestBody

분석할 pdf 문서 또는 이미지(jpg,png) 파일입니다.

callback

ServiceCallback<AnalyzeResult>

콜백

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)

매개 변수

id

string

문서를 분석할 모델 식별자입니다.

formStream
HttpRequestBody

분석할 pdf 문서 또는 이미지(jpg,png) 파일입니다.

callback

ServiceCallback<AnalyzeResult>

콜백

batchReadReceipt(string, RequestOptionsBase)

일괄 처리 읽기 확인 작업입니다. 응답에는 '읽기 확인 결과 가져오기' 작업에 사용해야 하는 URL이 포함된 'Operation-Location'이라는 필드가 포함되어 있습니다.

function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>

매개 변수

url

string

이미지의 공개적으로 연결할 수 있는 URL입니다.

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

매개 변수

url

string

이미지의 공개적으로 연결할 수 있는 URL입니다.

options
RequestOptionsBase

선택적 매개 변수

callback

ServiceCallback<void>

콜백

batchReadReceipt(string, ServiceCallback<void>)

function batchReadReceipt(url: string, callback: ServiceCallback<void>)

매개 변수

url

string

이미지의 공개적으로 연결할 수 있는 URL입니다.

callback

ServiceCallback<void>

콜백

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

확인 작업을 읽습니다. 'Batch 읽기 확인' 인터페이스를 사용하는 경우 응답에는 'Operation-Location'이라는 필드가 포함됩니다. 'Operation-Location' 필드에는 '읽음 확인 결과 가져오기' 작업에 사용해야 하는 URL이 포함되어 있습니다.

function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>

매개 변수

image
HttpRequestBody

이미지 스트림입니다.

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)

매개 변수

image
HttpRequestBody

이미지 스트림입니다.

options
RequestOptionsBase

선택적 매개 변수

callback

ServiceCallback<void>

콜백

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)

매개 변수

image
HttpRequestBody

이미지 스트림입니다.

callback

ServiceCallback<void>

콜백

deleteCustomModel(string, RequestOptionsBase)

모델 아티팩트를 삭제합니다.

function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>

매개 변수

id

string

삭제할 모델의 식별자입니다.

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

매개 변수

id

string

삭제할 모델의 식별자입니다.

options
RequestOptionsBase

선택적 매개 변수

callback

ServiceCallback<void>

콜백

deleteCustomModel(string, ServiceCallback<void>)

function deleteCustomModel(id: string, callback: ServiceCallback<void>)

매개 변수

id

string

삭제할 모델의 식별자입니다.

callback

ServiceCallback<void>

콜백

getCustomModel(string, RequestOptionsBase)

모델 관련 정보를 가져옵니다.

function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>

매개 변수

id

string

모델 식별자입니다.

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)

매개 변수

id

string

모델 식별자입니다.

options
RequestOptionsBase

선택적 매개 변수

callback

ServiceCallback<ModelResult>

콜백

getCustomModel(string, ServiceCallback<ModelResult>)

function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)

매개 변수

id

string

모델 식별자입니다.

callback

ServiceCallback<ModelResult>

콜백

getCustomModels(RequestOptionsBase)

학습된 모든 사용자 지정 모델에 대한 정보 가져오기

function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>

매개 변수

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)

매개 변수

options
RequestOptionsBase

선택적 매개 변수

callback

ServiceCallback<ModelsResult>

콜백

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

매개 변수

callback

ServiceCallback<ModelsResult>

콜백

getExtractedKeys(string, RequestOptionsBase)

지정된 모델을 학습하는 동안 추출된 키를 검색합니다.

function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>

매개 변수

id

string

모델 식별자입니다.

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)

매개 변수

id

string

모델 식별자입니다.

options
RequestOptionsBase

선택적 매개 변수

callback

ServiceCallback<KeysResult>

콜백

getExtractedKeys(string, ServiceCallback<KeysResult>)

function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)

매개 변수

id

string

모델 식별자입니다.

callback

ServiceCallback<KeysResult>

콜백

getReadReceiptResult(string, RequestOptionsBase)

이 인터페이스는 'Batch 읽기 영수증' 작업의 분석 결과를 가져오는 데 사용됩니다. 이 인터페이스의 URL은 'Batch 읽기 확인' 작업에서 반환된 'Operation-Location' 필드에서 검색해야 합니다.

function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>

매개 변수

operationId

string

'Batch 읽기 확인' 작업의 응답에서 반환된 읽기 작업의 ID입니다.

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)

매개 변수

operationId

string

'Batch 읽기 확인' 작업의 응답에서 반환된 읽기 작업의 ID입니다.

options
RequestOptionsBase

선택적 매개 변수

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)

매개 변수

operationId

string

'Batch 읽기 확인' 작업의 응답에서 반환된 읽기 작업의 ID입니다.

trainCustomModel(TrainRequest, RequestOptionsBase)

사용자 지정 모델을 만들고 학습합니다. 학습 요청은 외부에서 액세스할 수 있는 Azure Storage Blob 컨테이너 URI(공유 액세스 서명 URI)이거나 로컬 탑재된 드라이브의 데이터 폴더에 대한 유효한 경로인 원본 매개 변수를 포함해야 합니다. 로컬 경로가 지정된 경우 Linux/Unix 경로 형식을 따라야 하며, 입력 탑재 구성 설정값의 루트로 지정된 절대 경로여야 합니다(예: '{Mounts:Input}' 구성 설정값이 '/input'인 경우 유효한 원본 경로는 '/input/contosodataset'). 학습할 모든 데이터는 원본 폴더 바로 아래에 있어야 합니다. 하위 폴더는 지원되지 않습니다. 모델은 'application/pdf', 'image/jpeg' 및 'image/png' 콘텐츠 형식의 문서를 사용하여 학습됩니다." 다른 형식의 콘텐츠는 무시됩니다.

function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>

매개 변수

trainRequest
TrainRequest

학습을 위한 요청 개체입니다.

options
RequestOptionsBase

선택적 매개 변수

반환

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)

매개 변수

trainRequest
TrainRequest

학습을 위한 요청 개체입니다.

options
RequestOptionsBase

선택적 매개 변수

callback

ServiceCallback<TrainResult>

콜백

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)

매개 변수

trainRequest
TrainRequest

학습을 위한 요청 개체입니다.

callback

ServiceCallback<TrainResult>

콜백

상속된 메서드 세부 정보

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

제공된 OperationSpec을 사용하여 채워진 HTTP 요청을 보냅니다.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

매개 변수

operationArguments
OperationArguments

HTTP 요청의 템플릿 값이 채워지는 인수입니다.

operationSpec
OperationSpec

httpRequest를 채우는 데 사용할 OperationSpec입니다.

callback

ServiceCallback<any>

응답을 받을 때 호출할 콜백입니다.

반환

Promise<RestResponse>

FormRecognizerClientContext.sendOperationRequest에서 상속됨

sendRequest(RequestPrepareOptions | WebResourceLike)

제공된 httpRequest를 보냅니다.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

매개 변수

반환

FormRecognizerClientContext.sendRequest에서 상속됨