FormRecognizerClient class
- Extends
Form |
Inicializuje novou instanci FormRecognizerClient třídy. |
analyze |
Extrahujte páry klíč-hodnota z daného dokumentu. Vstupní dokument musí být jedním z podporovaných typů obsahu – application/pdf, image/jpeg nebo image/png. Ve formátu JSON se vrátí odpověď na úspěch. |
analyze |
|
analyze |
|
batch |
Operace dávkového potvrzení o přečtení. Odpověď obsahuje pole s názvem "Operation-Location", které obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení. |
batch |
|
batch |
|
batch |
Operace potvrzení o přečtení Při použití rozhraní Batch Read Receipt obsahuje odpověď pole s názvem Operation-Location. Pole Operation-Location obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení. |
batch |
|
batch |
|
delete |
Odstranění artefaktů modelu |
delete |
|
delete |
|
get |
Získejte informace o modelu. |
get |
|
get |
|
get |
Získání informací o všech natrénovaných vlastních modelech |
get |
|
get |
|
get |
Načtěte klíče extrahované během trénování zadaného modelu. |
get |
|
get |
|
get |
Toto rozhraní slouží k získání výsledků analýzy operace Potvrzení o přečtení dávky. Adresa URL tohoto rozhraní by se měla načíst z pole Operation-Location vráceného z operace Potvrzení o přečtení dávky. |
get |
|
get |
|
train |
Vytvoření a trénování vlastního modelu Požadavek na trénování musí obsahovat zdrojový parametr, který je buď externě přístupný identifikátor URI kontejneru objektů blob služby Azure Storage (nejlépe identifikátor URI sdíleného přístupového podpisu), nebo platnou cestu ke složce dat v místně připojené jednotce. Pokud jsou zadány místní cesty, musí se řídit formátem cesty Systému Linux/Unix a musí být absolutní kořenovou cestou ke vstupní hodnotě nastavení konfigurace připojení, například pokud je hodnota nastavení konfigurace {Mounts:Input} hodnota /input, bude platná zdrojová cesta /input /contosodataset. Očekává se, že všechna data, která se mají trénovat, budou přímo ve zdrojové složce. Podsložky nejsou podporovány. Modely se trénují pomocí dokumentů, které mají následující typ obsahu – application/pdf, image/jpeg a image/png. Jiný typ obsahu se ignoruje. |
train |
|
train |
send |
Odešlete požadavek HTTP naplněný zadaným objektem OperationSpec. |
send |
Odešle zadaný httpRequest. |
Inicializuje novou instanci FormRecognizerClient třídy.
new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)
Parametry
- credentials
- ServiceClientCredentials
Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné klienta.
- endpoint
-
string
Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).
- options
- ServiceClientOptions
Možnosti parametrů
credentials: ServiceClientCredentials
Hodnota vlastnosti
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
Extrahujte páry klíč-hodnota z daného dokumentu. Vstupní dokument musí být jedním z podporovaných typů obsahu – application/pdf, image/jpeg nebo image/png. Ve formátu JSON se vrátí odpověď na úspěch.
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>
Parametry
- id
-
string
Identifikátor modelu pro analýzu dokumentu.
- formStream
- HttpRequestBody
Soubor pdf dokumentu nebo obrázku (jpg,png) k analýze.
Volitelné parametry
Návraty
Promise<AnalyzeWithCustomModelResponse>
Příslib<Models.AnalyzeWithCustomModelResponse>
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)
Parametry
- id
-
string
Identifikátor modelu pro analýzu dokumentu.
- formStream
- HttpRequestBody
Soubor pdf dokumentu nebo obrázku (jpg,png) k analýze.
Volitelné parametry
- callback
Zpětné volání
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)
Parametry
- id
-
string
Identifikátor modelu pro analýzu dokumentu.
- formStream
- HttpRequestBody
Soubor pdf dokumentu nebo obrázku (jpg,png) k analýze.
- callback
Zpětné volání
Operace dávkového potvrzení o přečtení. Odpověď obsahuje pole s názvem "Operation-Location", které obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení.
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>
Parametry
- url
-
string
Veřejně dostupná adresa URL obrázku
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<BatchReadReceiptResponse>
Příslib<Models.BatchReadReceiptResponse>
function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)
Parametry
- url
-
string
Veřejně dostupná adresa URL obrázku
- options
- RequestOptionsBase
Volitelné parametry
- callback
-
ServiceCallback<void>
Zpětné volání
function batchReadReceipt(url: string, callback: ServiceCallback<void>)
Parametry
- url
-
string
Veřejně dostupná adresa URL obrázku
- callback
-
ServiceCallback<void>
Zpětné volání
Operace potvrzení o přečtení Při použití rozhraní Batch Read Receipt obsahuje odpověď pole s názvem Operation-Location. Pole Operation-Location obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení.
function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>
Parametry
- image
- HttpRequestBody
Stream obrázku.
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<BatchReadReceiptInStreamResponse>
Příslib<Models.BatchReadReceiptInStreamResponse>
function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)
Parametry
- image
- HttpRequestBody
Stream obrázku.
- options
- RequestOptionsBase
Volitelné parametry
- callback
-
ServiceCallback<void>
Zpětné volání
function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)
Parametry
- image
- HttpRequestBody
Stream obrázku.
- callback
-
ServiceCallback<void>
Zpětné volání
Odstranění artefaktů modelu
function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>
Parametry
- id
-
string
Identifikátor modelu, který chcete odstranit.
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<RestResponse>
Příslib<msRest.RestResponse>
function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)
Parametry
- id
-
string
Identifikátor modelu, který chcete odstranit.
- options
- RequestOptionsBase
Volitelné parametry
- callback
-
ServiceCallback<void>
Zpětné volání
function deleteCustomModel(id: string, callback: ServiceCallback<void>)
Parametry
- id
-
string
Identifikátor modelu, který chcete odstranit.
- callback
-
ServiceCallback<void>
Zpětné volání
Získejte informace o modelu.
function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>
Parametry
- id
-
string
Identifikátor modelu.
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<GetCustomModelResponse>
Příslib<Models.GetCustomModelResponse>
function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)
Parametry
- id
-
string
Identifikátor modelu.
- options
- RequestOptionsBase
Volitelné parametry
- callback
Zpětné volání
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)
Parametry
- id
-
string
Identifikátor modelu.
- callback
Zpětné volání
Získání informací o všech natrénovaných vlastních modelech
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>
Parametry
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<GetCustomModelsResponse>
Příslib<Models.GetCustomModelsResponse>
function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)
Parametry
- options
- RequestOptionsBase
Volitelné parametry
- callback
Zpětné volání
function getCustomModels(callback: ServiceCallback<ModelsResult>)
Parametry
- callback
Zpětné volání
Načtěte klíče extrahované během trénování zadaného modelu.
function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>
Parametry
- id
-
string
Identifikátor modelu.
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<GetExtractedKeysResponse>
Příslib<Models.GetExtractedKeysResponse>
function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)
Parametry
- id
-
string
Identifikátor modelu.
- options
- RequestOptionsBase
Volitelné parametry
- callback
Zpětné volání
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)
Parametry
- id
-
string
Identifikátor modelu.
- callback
Zpětné volání
Toto rozhraní slouží k získání výsledků analýzy operace Potvrzení o přečtení dávky. Adresa URL tohoto rozhraní by se měla načíst z pole Operation-Location vráceného z operace Potvrzení o přečtení dávky.
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>
Parametry
- operationId
-
string
ID operace čtení vrácené v odpovědi operace "Dávkové potvrzení o přečtení".
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<GetReadReceiptResultResponse>
Příslib<Models.GetReadReceiptResultResponse>
function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)
Parametry
- operationId
-
string
ID operace čtení vrácené v odpovědi operace "Dávkové potvrzení o přečtení".
- options
- RequestOptionsBase
Volitelné parametry
- callback
Zpětné volání
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)
Parametry
- operationId
-
string
ID operace čtení vrácené v odpovědi operace "Dávkové potvrzení o přečtení".
- callback
Zpětné volání
Vytvoření a trénování vlastního modelu Požadavek na trénování musí obsahovat zdrojový parametr, který je buď externě přístupný identifikátor URI kontejneru objektů blob služby Azure Storage (nejlépe identifikátor URI sdíleného přístupového podpisu), nebo platnou cestu ke složce dat v místně připojené jednotce. Pokud jsou zadány místní cesty, musí se řídit formátem cesty Systému Linux/Unix a musí být absolutní kořenovou cestou ke vstupní hodnotě nastavení konfigurace připojení, například pokud je hodnota nastavení konfigurace {Mounts:Input} hodnota /input, bude platná zdrojová cesta /input /contosodataset. Očekává se, že všechna data, která se mají trénovat, budou přímo ve zdrojové složce. Podsložky nejsou podporovány. Modely se trénují pomocí dokumentů, které mají následující typ obsahu – application/pdf, image/jpeg a image/png. Jiný typ obsahu se ignoruje.
function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>
Parametry
- trainRequest
- TrainRequest
Vyžádání objektu pro trénování
- options
- RequestOptionsBase
Volitelné parametry
Návraty
Promise<TrainCustomModelResponse>
Příslib<Models.TrainCustomModelResponse>
function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)
Parametry
- trainRequest
- TrainRequest
Vyžádání objektu pro trénování
- options
- RequestOptionsBase
Volitelné parametry
- callback
Zpětné volání
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)
Parametry
- trainRequest
- TrainRequest
Vyžádání objektu pro trénování
- callback
Zpětné volání
Odešlete požadavek HTTP naplněný zadaným objektem OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>
Parametry
- operationArguments
- OperationArguments
Argumenty, ze které se vyplní hodnoty šablony požadavku HTTP.
- operationSpec
- OperationSpec
OperationSpec, který se má použít k naplnění httpRequest.
- callback
-
ServiceCallback<any>
Zpětné volání, které se má volat při přijetí odpovědi.
Návraty
Promise<RestResponse>
Odešle zadaný httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
Parametry
- options
Návraty
Promise<HttpOperationResponse>
Zpětná vazba k produktu Azure SDK for JavaScript
Azure SDK for JavaScript je open source projekt. Vyberte odkaz pro poskytnutí zpětné vazby: