FormRecognizerClient class
- Extends
Конструкторы
| Form |
Инициализирует новый экземпляр класса FormRecognizerClient. |
Унаследованные свойства
| credentials | |
| endpoint |
Методы
| analyze |
Извлечение пар "ключ-значение" из заданного документа. Входной документ должен иметь один из поддерживаемых типов содержимого: application/pdf, image/jpeg или image/png. Успешный ответ будет возвращен в формате JSON. |
| analyze |
|
| analyze |
|
| batch |
Операция пакетного чтения квитанции. Ответ содержит поле "Operation-Location", содержащее URL-адрес, который необходимо использовать для операции "Получение результата уведомления о прочтении". |
| batch |
|
| batch |
|
| batch |
Операция чтения квитанции. При использовании интерфейса "Уведомление о пакетном чтении" ответ содержит поле "Operation-Location". Поле Operation-Location содержит URL-адрес, который необходимо использовать для операции "Получение результата уведомления о прочтении". |
| batch |
|
| batch |
|
| delete |
Удаление артефактов модели. |
| delete |
|
| delete |
|
| get |
Получение информации о модели. |
| get |
|
| get |
|
| get |
Получение сведений обо всех обученных пользовательских моделях |
| get |
|
| get |
|
| get |
Получение ключей, извлеченных во время обучения указанной модели. |
| get |
|
| get |
|
| get |
Этот интерфейс используется для получения результатов анализа операции "Уведомление о пакетном чтении". URL-адрес этого интерфейса должен быть получен из поля "Расположение операции", возвращаемого при выполнении операции "Уведомление о пакетном чтении". |
| get |
|
| get |
|
| train |
Создание и обучение пользовательской модели. Запрос на обучение должен включать параметр источника, который является либо URI контейнера BLOB-объектов доступной извне службы хранилища Azure (предпочтительно URI SAS), либо допустимым путем к папке данных на диске с локальным подключением. Если указаны локальные пути, они должны соответствовать формату пути Linux/UNIX и представлять собой абсолютный путь к значению параметра конфигурации входного подключения. Например, если для параметра конфигурации {Mounts:Input} задано значение /input, допустимый путь к источнику — /input/contosodataset. Ожидается, что все обученные данные будут находиться непосредственно в исходной папке. Вложенные папки не поддерживаются. Модели обучаются с помощью документов, которые имеют следующий тип контента: application/pdf, image/jpeg и image/png». Другие типы содержимого игнорируются. |
| train |
|
| train |
Наследуемые методы
| send |
Отправьте HTTP-запрос, который заполняется с помощью предоставленного operationSpec. |
| send |
Отправьте предоставленный запрос 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Значение свойства
Наследуется отFormRecognizerClientContext.credentials
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<AnalyzeWithCustomModelResponse>
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
Обратный вызов
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)Параметры
- id
-
string
Идентификатор модели для анализа документа.
- formStream
- HttpRequestBody
PDF-документ или файл изображения (JPG,PNG) для анализа.
- callback
Обратный вызов
batchReadReceipt(string, RequestOptionsBase)
Операция пакетного чтения квитанции. Ответ содержит поле "Operation-Location", содержащее URL-адрес, который необходимо использовать для операции "Получение результата уведомления о прочтении".
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>Параметры
- url
-
string
Общедоступный URL-адрес изображения.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<BatchReadReceiptResponse>
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)
Операция чтения квитанции. При использовании интерфейса "Уведомление о пакетном чтении" ответ содержит поле "Operation-Location". Поле Operation-Location содержит URL-адрес, который необходимо использовать для операции "Получение результата уведомления о прочтении".
function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>Параметры
- image
- HttpRequestBody
Поток изображений.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<BatchReadReceiptInStreamResponse>
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<GetCustomModelResponse>
Promise<Models.GetCustomModelResponse>
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)Параметры
- id
-
string
Идентификатор модели.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)Параметры
- id
-
string
Идентификатор модели.
- callback
Обратный вызов
getCustomModels(RequestOptionsBase)
Получение сведений обо всех обученных пользовательских моделях
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>Параметры
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<GetCustomModelsResponse>
Promise<Models.GetCustomModelsResponse>
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)Параметры
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)Параметры
- callback
Обратный вызов
getExtractedKeys(string, RequestOptionsBase)
Получение ключей, извлеченных во время обучения указанной модели.
function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>Параметры
- id
-
string
Идентификатор модели.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<GetExtractedKeysResponse>
Promise<Models.GetExtractedKeysResponse>
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)Параметры
- id
-
string
Идентификатор модели.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)Параметры
- id
-
string
Идентификатор модели.
- callback
Обратный вызов
getReadReceiptResult(string, RequestOptionsBase)
Этот интерфейс используется для получения результатов анализа операции "Уведомление о пакетном чтении". URL-адрес этого интерфейса должен быть получен из поля "Расположение операции", возвращаемого при выполнении операции "Уведомление о пакетном чтении".
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>Параметры
- operationId
-
string
Идентификатор операции чтения, возвращенный в ответе на операцию пакетного чтения.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<GetReadReceiptResultResponse>
Promise<Models.GetReadReceiptResultResponse>
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)Параметры
- operationId
-
string
Идентификатор операции чтения, возвращенный в ответе на операцию пакетного чтения.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)Параметры
- operationId
-
string
Идентификатор операции чтения, возвращенный в ответе на операцию пакетного чтения.
- callback
Обратный вызов
trainCustomModel(TrainRequest, RequestOptionsBase)
Создание и обучение пользовательской модели. Запрос на обучение должен включать параметр источника, который является либо URI контейнера BLOB-объектов доступной извне службы хранилища Azure (предпочтительно URI SAS), либо допустимым путем к папке данных на диске с локальным подключением. Если указаны локальные пути, они должны соответствовать формату пути 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>
Promise<Models.TrainCustomModelResponse>
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)Параметры
- trainRequest
- TrainRequest
Запрос объекта для обучения.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)Параметры
- trainRequest
- TrainRequest
Запрос объекта для обучения.
- callback
Обратный вызов
Сведения о наследуемом методе
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Отправьте HTTP-запрос, который заполняется с помощью предоставленного operationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Параметры
- operationArguments
- OperationArguments
Аргументы, из которые будут заполнены значения шаблона HTTP-запроса.
- operationSpec
- OperationSpec
Параметр OperationSpec, используемый для заполнения httpRequest.
- callback
-
ServiceCallback<any>
Обратный вызов при получении ответа.
Возвращаемое значение
Promise<RestResponse>
Наследуется отFormRecognizerClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Отправьте предоставленный запрос httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Параметры
- options
Возвращаемое значение
Promise<HttpOperationResponse>
Наследуется отFormRecognizerClientContext.sendRequest
Azure SDK for JavaScript
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по