FormRecognizerClient class

Пакет:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Конструкторы

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Инициализирует новый экземпляр класса FormRecognizerClient.

Унаследованные свойства

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)	Операция получения пакетной службы чтения. Ответ содержит поле с именем Operation-Location, которое содержит URL-адрес, который необходимо использовать для операции получения результата получения получения результатов получения квитанций.
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Операция чтения квитанций. При использовании интерфейса "Получение пакетной службы" ответ содержит поле с именем 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)	Этот интерфейс используется для получения результатов анализа операции "Пакетное чтение квитанции". URL-адрес этого интерфейса должен быть получен из поля Operation-Location, возвращаемого из операции "Получение пакетной службы".
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Создание и обучение пользовательской модели. Запрос на обучение должен включать исходный параметр, который является либо URI контейнера BLOB-объектов хранилища Azure (предпочтительнее URI подписанного URL-адреса), либо допустимый путь к папке данных на локально подключенном диске. Если указаны локальные пути, они должны соответствовать формату пути 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>)	Отправьте HTTP-запрос, заполненный с помощью предоставленной операцииSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Отправьте предоставленный httpRequest.

Сведения о конструкторе

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Инициализирует новый экземпляр класса FormRecognizerClient.

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

Значение свойства

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) для анализа.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Необязательные параметры

Возвращаемое значение

Promise<AnalyzeWithCustomModelResponse>

Обещание<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) для анализа.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Необязательные параметры

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)

Операция получения пакетной службы чтения. Ответ содержит поле с именем Operation-Location, которое содержит URL-адрес, который необходимо использовать для операции получения результата получения получения результатов получения квитанций.

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

Параметры

url

string

Общедоступный URL-адрес изображения.

options

RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<BatchReadReceiptResponse>

Обещание<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)

Операция чтения квитанций. При использовании интерфейса "Получение пакетной службы" ответ содержит поле с именем Operation-Location. Поле Operation-Location содержит URL-адрес, который необходимо использовать для операции получения результата получения получения результатов получения квитанций.

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

Параметры

image

HttpRequestBody

Поток изображения.

options

RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<BatchReadReceiptInStreamResponse>

Обещание<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>

Обещание<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<GetCustomModelResponse>

Обещание<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<GetCustomModelsResponse>

Обещание<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<GetExtractedKeysResponse>

Обещание<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)

Этот интерфейс используется для получения результатов анализа операции "Пакетное чтение квитанции". URL-адрес этого интерфейса должен быть получен из поля Operation-Location, возвращаемого из операции "Получение пакетной службы".

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

Параметры

operationId

string

Идентификатор операции чтения, возвращаемой в ответ на операцию "Получение пакетного чтения".

options

RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<GetReadReceiptResultResponse>

Обещание<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Параметры

operationId

string

Идентификатор операции чтения, возвращаемой в ответ на операцию "Получение пакетного чтения".

options

RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<ReadReceiptResult>

Обратный вызов

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Параметры

operationId

string

Идентификатор операции чтения, возвращаемой в ответ на операцию "Получение пакетного чтения".

callback

ServiceCallback<ReadReceiptResult>

Обратный вызов

trainCustomModel(TrainRequest, RequestOptionsBase)

Создание и обучение пользовательской модели. Запрос на обучение должен включать исходный параметр, который является либо URI контейнера BLOB-объектов хранилища Azure (предпочтительнее URI подписанного URL-адреса), либо допустимый путь к папке данных на локально подключенном диске. Если указаны локальные пути, они должны соответствовать формату пути 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<TrainCustomModelResponse>

Обещание<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>)

Отправьте HTTP-запрос, заполненный с помощью предоставленной операцииSpec.

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

Параметры

operationArguments

OperationArguments

Аргументы, из которыми будут заполнены шаблонные значения HTTP-запроса.

operationSpec

OperationSpec

ОперацияSpec, используемая для заполнения httpRequest.

callback

ServiceCallback<any>

Обратный вызов при получении ответа.

Возвращаемое значение

Promise<RestResponse>

наследуется отFormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Отправьте предоставленный httpRequest.

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

Параметры

options

RequestPrepareOptions | WebResourceLike

Возвращаемое значение

Promise<HttpOperationResponse>

наследуется отFormRecognizerClientContext.sendRequest