FormRecognizerClient class

Extends

Konstruktorok

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializálja a FormRecognizerClient osztály új példányát.

Örökölt tulajdonságok

credentials
endpoint

Metódusok

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Kulcs-érték párok kinyerása egy adott dokumentumból. A bemeneti dokumentumnak a támogatott tartalomtípusok egyikének kell lennie : "application/pdf", "image/jpeg" vagy "image/png". A JSON sikeres választ ad vissza.

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

Kötegelt olvasási visszaigazolási művelet. A válasz tartalmaz egy "Operation-Location" nevű mezőt, amely az "Olvasási visszaigazolás eredményének lekérése" művelethez használni kívánt URL-címet tartalmazza.

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

Olvasási visszaigazolás művelet. Ha a "Batch Read Receipt" felületet használja, a válasz tartalmaz egy "Operation-Location" nevű mezőt. Az "Operation-Location" mező tartalmazza az "Olvasási visszaigazolás eredményének lekérése" művelethez használni kívánt URL-címet.

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

Modellösszetevők törlése.

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

Modell adatainak lekérése.

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

Információk lekérése az összes betanított egyéni modellről

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

Kérje le a megadott modell betanítása során kinyert kulcsokat.

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

Ez az interfész egy "Batch Read Receipt" művelet elemzési eredményeinek lekérésére szolgál. A felület URL-címét a "Batch Read Receipt" műveletből visszaadott "Operation-Location" mezőből kell lekérni.

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

Egyéni modell létrehozása és betanítása. A betanításai kérelemnek tartalmaznia kell egy forrásparamétert, amely egy külsőleg elérhető Azure Storage-blobtároló URI-ja (lehetőleg közös hozzáférésű jogosultságkód URI-ja), vagy egy helyileg csatlakoztatott meghajtó adatmappájának érvényes elérési útja. Helyi elérési utak megadásakor a Linux/Unix elérési út formátumát kell követniük, és abszolút elérési útnak kell lenniük a bemeneti csatlakoztatás konfigurációs beállítási értékéhez gyökerező abszolút elérési útként, például ha a(z) {Mounts:Input} konfigurációs beállítás értéke "/input", akkor az érvényes forrásútvonal a következő: "/input/contosodataset". Az összes betanított adatnak közvetlenül a forrásmappában kell lennie. Az almappák nem támogatottak. A modellek betanítása a következő tartalomtípusú dokumentumok használatával történik: "application/pdf", "image/jpeg" és "image/png". A rendszer figyelmen kívül hagyja az egyéb típusú tartalmakat.

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

Örökölt metódusok

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Küldjön egy HTTP-kérést, amely a megadott OperationSpec paranccsal van feltöltve.

sendRequest(RequestPrepareOptions | WebResourceLike)

Küldje el a megadott httpRequest parancsot.

Konstruktor adatai

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializálja a FormRecognizerClient osztály új példányát.

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

Paraméterek

credentials
ServiceClientCredentials

Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják az ügyfél-előfizetést.

endpoint

string

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com).

options
ServiceClientOptions

A paraméter beállításai

Örökölt tulajdonság részletei

credentials

credentials: ServiceClientCredentials

Tulajdonság értéke

Örökölt: FormRecognizerClientContext.credentials

endpoint

endpoint: string

Tulajdonság értéke

string

Örökölt: FormRecognizerClientContext.endpoint

Metódus adatai

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Kulcs-érték párok kinyerása egy adott dokumentumból. A bemeneti dokumentumnak a támogatott tartalomtípusok egyikének kell lennie : "application/pdf", "image/jpeg" vagy "image/png". A JSON sikeres választ ad vissza.

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

Paraméterek

id

string

Modellazonosító a dokumentum elemzéséhez.

formStream
HttpRequestBody

Elemezni kívánt PDF-dokumentum vagy képfájl (jpg,png).

options
FormRecognizerClientAnalyzeWithCustomModelOptionalParams

A választható paraméterek

Válaszok

Promise<Models.AnalyzeWithCustomModelResponse>

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

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

Paraméterek

id

string

Modellazonosító a dokumentum elemzéséhez.

formStream
HttpRequestBody

Elemezni kívánt PDF-dokumentum vagy képfájl (jpg,png).

options
FormRecognizerClientAnalyzeWithCustomModelOptionalParams

A választható paraméterek

callback

ServiceCallback<AnalyzeResult>

A visszahívás

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Paraméterek

id

string

Modellazonosító a dokumentum elemzéséhez.

formStream
HttpRequestBody

Elemezni kívánt PDF-dokumentum vagy képfájl (jpg,png).

callback

ServiceCallback<AnalyzeResult>

A visszahívás

batchReadReceipt(string, RequestOptionsBase)

Kötegelt olvasási visszaigazolási művelet. A válasz tartalmaz egy "Operation-Location" nevű mezőt, amely az "Olvasási visszaigazolás eredményének lekérése" művelethez használni kívánt URL-címet tartalmazza.

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

Paraméterek

url

string

Egy kép nyilvánosan elérhető URL-címe.

options
RequestOptionsBase

A választható paraméterek

Válaszok

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Paraméterek

url

string

Egy kép nyilvánosan elérhető URL-címe.

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<void>

A visszahívás

batchReadReceipt(string, ServiceCallback<void>)

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

Paraméterek

url

string

Egy kép nyilvánosan elérhető URL-címe.

callback

ServiceCallback<void>

A visszahívás

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Olvasási visszaigazolás művelet. Ha a "Batch Read Receipt" felületet használja, a válasz tartalmaz egy "Operation-Location" nevű mezőt. Az "Operation-Location" mező tartalmazza az "Olvasási visszaigazolás eredményének lekérése" művelethez használni kívánt URL-címet.

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

Paraméterek

image
HttpRequestBody

Képstream.

options
RequestOptionsBase

A választható paraméterek

Válaszok

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Paraméterek

image
HttpRequestBody

Képstream.

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<void>

A visszahívás

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Paraméterek

image
HttpRequestBody

Képstream.

callback

ServiceCallback<void>

A visszahívás

deleteCustomModel(string, RequestOptionsBase)

Modellösszetevők törlése.

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

Paraméterek

id

string

A törölni kívánt modell azonosítója.

options
RequestOptionsBase

A választható paraméterek

Válaszok

Promise<RestResponse>

Ígéret<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Paraméterek

id

string

A törölni kívánt modell azonosítója.

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<void>

A visszahívás

deleteCustomModel(string, ServiceCallback<void>)

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

Paraméterek

id

string

A törölni kívánt modell azonosítója.

callback

ServiceCallback<void>

A visszahívás

getCustomModel(string, RequestOptionsBase)

Modell adatainak lekérése.

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

Paraméterek

id

string

Modellazonosító.

options
RequestOptionsBase

A választható paraméterek

Válaszok

Ígéretmodellek.GetCustomModelResponse<>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Paraméterek

id

string

Modellazonosító.

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<ModelResult>

A visszahívás

getCustomModel(string, ServiceCallback<ModelResult>)

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

Paraméterek

id

string

Modellazonosító.

callback

ServiceCallback<ModelResult>

A visszahívás

getCustomModels(RequestOptionsBase)

Információk lekérése az összes betanított egyéni modellről

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

Paraméterek

options
RequestOptionsBase

A választható paraméterek

Válaszok

Ígéretmodellek.GetCustomModelsResponse<>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Paraméterek

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<ModelsResult>

A visszahívás

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Paraméterek

callback

ServiceCallback<ModelsResult>

A visszahívás

getExtractedKeys(string, RequestOptionsBase)

Kérje le a megadott modell betanítása során kinyert kulcsokat.

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

Paraméterek

id

string

Modellazonosító.

options
RequestOptionsBase

A választható paraméterek

Válaszok

Ígéretmodellek.GetExtractedKeysResponse<>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Paraméterek

id

string

Modellazonosító.

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<KeysResult>

A visszahívás

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Paraméterek

id

string

Modellazonosító.

callback

ServiceCallback<KeysResult>

A visszahívás

getReadReceiptResult(string, RequestOptionsBase)

Ez az interfész egy "Batch Read Receipt" művelet elemzési eredményeinek lekérésére szolgál. A felület URL-címét a "Batch Read Receipt" műveletből visszaadott "Operation-Location" mezőből kell lekérni.

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

Paraméterek

operationId

string

A "Batch Read Receipt" művelet válaszában visszaadott olvasási művelet azonosítója.

options
RequestOptionsBase

A választható paraméterek

Válaszok

Ígéretmodellek.GetReadReceiptResultResponse<>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Paraméterek

operationId

string

A "Batch Read Receipt" művelet válaszában visszaadott olvasási művelet azonosítója.

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<ReadReceiptResult>

A visszahívás

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Paraméterek

operationId

string

A "Batch Read Receipt" művelet válaszában visszaadott olvasási művelet azonosítója.

callback

ServiceCallback<ReadReceiptResult>

A visszahívás

trainCustomModel(TrainRequest, RequestOptionsBase)

Egyéni modell létrehozása és betanítása. A betanításai kérelemnek tartalmaznia kell egy forrásparamétert, amely egy külsőleg elérhető Azure Storage-blobtároló URI-ja (lehetőleg közös hozzáférésű jogosultságkód URI-ja), vagy egy helyileg csatlakoztatott meghajtó adatmappájának érvényes elérési útja. Helyi elérési utak megadásakor a Linux/Unix elérési út formátumát kell követniük, és abszolút elérési útnak kell lenniük a bemeneti csatlakoztatás konfigurációs beállítási értékéhez gyökerező abszolút elérési útként, például ha a(z) {Mounts:Input} konfigurációs beállítás értéke "/input", akkor az érvényes forrásútvonal a következő: "/input/contosodataset". Az összes betanított adatnak közvetlenül a forrásmappában kell lennie. Az almappák nem támogatottak. A modellek betanítása a következő tartalomtípusú dokumentumok használatával történik: "application/pdf", "image/jpeg" és "image/png". A rendszer figyelmen kívül hagyja az egyéb típusú tartalmakat.

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

Paraméterek

trainRequest
TrainRequest

Objektum kérése betanításhoz.

options
RequestOptionsBase

A választható paraméterek

Válaszok

Ígéretmodellek.TrainCustomModelResponse<>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Paraméterek

trainRequest
TrainRequest

Objektum kérése betanításhoz.

options
RequestOptionsBase

A választható paraméterek

callback

ServiceCallback<TrainResult>

A visszahívás

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Paraméterek

trainRequest
TrainRequest

Objektum kérése betanításhoz.

callback

ServiceCallback<TrainResult>

A visszahívás

Örökölt metódus részletei

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Küldjön egy HTTP-kérést, amely a megadott OperationSpec paranccsal van feltöltve.

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

Paraméterek

operationArguments
OperationArguments

Azok az argumentumok, amelyekből a HTTP-kérelem sablonértékei ki lesznek töltve.

operationSpec
OperationSpec

A httpRequest feltöltéséhez használandó OperationSpec.

callback

ServiceCallback<any>

A visszahívás a válasz érkezésekor.

Válaszok

Promise<RestResponse>

Örökölt: FormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Küldje el a megadott httpRequest parancsot.

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

Paraméterek

Válaszok

Örökölt: FormRecognizerClientContext.sendRequest