FormRecognizerClient class
- Extends
Konstruktorok
Form |
Inicializálja a FormRecognizerClient osztály új példányát. |
Örökölt tulajdonságok
credentials | |
endpoint |
Metódusok
analyze |
Kulcs-érték párok kinyerése 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. |
analyze |
|
analyze |
|
batch |
Kötegelt olvasási visszaigazolási művelet. A válasz tartalmaz egy "Operation-Location" nevű mezőt, amely tartalmazza az "Olvasási visszaigazolás eredményének lekérése" művelethez használni kívánt URL-címet. |
batch |
|
batch |
|
batch |
Olvasási visszaigazolási művelet. Amikor a "Batch Read Receipt" felületet használja, a válasz tartalmaz egy "Operation-Location" nevű mezőt. A "Művelet helye" mező tartalmazza az "Olvasási visszaigazolás eredményének lekérése" művelethez használni kívánt URL-címet. |
batch |
|
batch |
|
delete |
Modellösszetevők törlése. |
delete |
|
delete |
|
get |
Információk lekérése egy modellről. |
get |
|
get |
|
get |
Információk az összes betanított egyéni modellről |
get |
|
get |
|
get |
Kérje le a megadott modell betanítása során kinyert kulcsokat. |
get |
|
get |
|
get |
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. |
get |
|
get |
|
train |
Egyéni modell létrehozása és betanítása. A vonatké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), vagy egy helyileg csatlakoztatott meghajtó adatmappájának érvényes elérési útja. A 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, amely a bemeneti csatlakoztatás konfigurációs beállítási értékére gyökerezik, például ha a(z) "{Mounts:Input}" konfigurációs beállítás értéke "/bemenet", akkor egy érvényes forrásútvonal "/input/contosodataset" lesz. A betanított adatok várhatóan közvetlenül a forrásmappában lesznek. Az almappák nem támogatottak. A modelleket a következő tartalomtípusú dokumentumok használatával tanítjuk be: "application/pdf", "image/jpeg" és "image/png". A rendszer figyelmen kívül hagyja a többi tartalomtípust. |
train |
|
train |
Örökölt metódusok
send |
Küldjön egy HTTP-kérést, amely a megadott OperationSpec használatával van feltöltve. |
send |
Küldje el a megadott httpRequestet. |
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
Előfizetési hitelesítő adatok, 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
a FormRecognizerClientContext.credentialsörökölte
endpoint
Metódus adatai
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
Kulcs-érték párok kinyerése 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
Elemezendő pdf-dokumentum vagy képfájl (jpg,png).
Az opcionális paraméterek
Válaszok
Promise<AnalyzeWithCustomModelResponse>
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
Elemezendő pdf-dokumentum vagy képfájl (jpg,png).
Az opcionális paraméterek
- callback
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
Elemezendő pdf-dokumentum vagy képfájl (jpg,png).
- callback
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 tartalmazza az "Olvasási visszaigazolás eredményének lekérése" művelethez használni kívánt URL-címet.
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>
Paraméterek
- url
-
string
Egy kép nyilvánosan elérhető URL-címe.
- options
- RequestOptionsBase
Az opcionális paraméterek
Válaszok
Promise<BatchReadReceiptResponse>
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
Az opcionális 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ási művelet. Amikor a "Batch Read Receipt" felületet használja, a válasz tartalmaz egy "Operation-Location" nevű mezőt. A "Művelet helye" 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
Az opcionális paraméterek
Válaszok
Promise<BatchReadReceiptInStreamResponse>
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
Az opcionális 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
Az opcionális 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
Az opcionális 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)
Információk lekérése egy modellről.
function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>
Paraméterek
- id
-
string
Modellazonosító.
- options
- RequestOptionsBase
Az opcionális paraméterek
Válaszok
Promise<GetCustomModelResponse>
Promise<Models.GetCustomModelResponse>
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)
Paraméterek
- id
-
string
Modellazonosító.
- options
- RequestOptionsBase
Az opcionális paraméterek
- callback
A visszahívás
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)
Paraméterek
- id
-
string
Modellazonosító.
- callback
A visszahívás
getCustomModels(RequestOptionsBase)
Információk az összes betanított egyéni modellről
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>
Paraméterek
- options
- RequestOptionsBase
Az opcionális paraméterek
Válaszok
Promise<GetCustomModelsResponse>
Promise<Models.GetCustomModelsResponse>
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)
Paraméterek
- options
- RequestOptionsBase
Az opcionális paraméterek
- callback
A visszahívás
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)
Paraméterek
- callback
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
Az opcionális paraméterek
Válaszok
Promise<GetExtractedKeysResponse>
Promise<Models.GetExtractedKeysResponse>
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)
Paraméterek
- id
-
string
Modellazonosító.
- options
- RequestOptionsBase
Az opcionális paraméterek
- callback
A visszahívás
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)
Paraméterek
- id
-
string
Modellazonosító.
- callback
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
Az opcionális paraméterek
Válaszok
Promise<GetReadReceiptResultResponse>
Promise<Models.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
Az opcionális paraméterek
- callback
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
A visszahívás
trainCustomModel(TrainRequest, RequestOptionsBase)
Egyéni modell létrehozása és betanítása. A vonatké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), vagy egy helyileg csatlakoztatott meghajtó adatmappájának érvényes elérési útja. A 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, amely a bemeneti csatlakoztatás konfigurációs beállítási értékére gyökerezik, például ha a(z) "{Mounts:Input}" konfigurációs beállítás értéke "/bemenet", akkor egy érvényes forrásútvonal "/input/contosodataset" lesz. A betanított adatok várhatóan közvetlenül a forrásmappában lesznek. Az almappák nem támogatottak. A modelleket a következő tartalomtípusú dokumentumok használatával tanítjuk be: "application/pdf", "image/jpeg" és "image/png". A rendszer figyelmen kívül hagyja a többi tartalomtípust.
function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>
Paraméterek
- trainRequest
- TrainRequest
Objektum kérése betanításhoz.
- options
- RequestOptionsBase
Az opcionális paraméterek
Válaszok
Promise<TrainCustomModelResponse>
Promise<Models.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
Az opcionális paraméterek
- callback
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
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 használatával 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 hívás visszahívása a válasz érkezésekor.
Válaszok
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
Küldje el a megadott httpRequestet.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
Paraméterek
- options
Válaszok
Promise<HttpOperationResponse>
Azure SDK for JavaScript