FormRecognizerClient class
- Extends
Konstruktorer
| Form |
Initierar en ny instans av klassen FormRecognizerClient. |
Ärvda egenskaper
| credentials | |
| endpoint |
Metoder
| analyze |
Extrahera nyckel/värde-par från ett visst dokument. Indatadokumentet måste vara av någon av de innehållstyper som stöds – "application/pdf", "image/jpeg" eller "image/png". Ett lyckat svar returneras i JSON. |
| analyze |
|
| analyze |
|
| batch |
Batchläsningskvittoåtgärd. Svaret innehåller ett fält med namnet "Operation-Location", som innehåller den URL som du måste använda för åtgärden "Hämta läskvittoresultat". |
| batch |
|
| batch |
|
| batch |
Läskvittoåtgärd. När du använder gränssnittet "Batch-läskvitto" innehåller svaret ett fält med namnet "Operation-Location". Fältet Operation-Location innehåller den URL som du måste använda för åtgärden "Hämta resultat av läskvitto". |
| batch |
|
| batch |
|
| delete |
Ta bort modellartefakter. |
| delete |
|
| delete |
|
| get |
Hämta information om en modell. |
| get |
|
| get |
|
| get |
Hämta information om alla tränade anpassade modeller |
| get |
|
| get |
|
| get |
Hämta nycklarna som extraherades under träningen av den angivna modellen. |
| get |
|
| get |
|
| get |
Det här gränssnittet används för att hämta analysresultatet för en batchläsningskvittoåtgärd. URL:en till det här gränssnittet ska hämtas från fältet "Åtgärdsplats" som returneras från åtgärden "Batch-läskvitto". |
| get |
|
| get |
|
| train |
Skapa och träna en anpassad modell. Träningsbegäran måste innehålla en källparameter som antingen är en externt tillgänglig Azure Storage-blobcontainer-URI (helst en signatur-Uri för delad åtkomst) eller en giltig sökväg till en datamapp på en lokalt monterad enhet. När lokala sökvägar har angetts måste de följa sökvägsformatet för Linux/Unix och vara en absolut sökväg som är rotad till inställningsvärdet för indatamonteringskonfigurationen, t.ex. om konfigurationsinställningsvärdet {Mounts:Input} är "/input" skulle en giltig källsökväg vara "/input/contosodataset". Alla data som ska tränas förväntas vara direkt under källmappen. Undermappar stöds inte. Modeller tränas med dokument som har följande innehållstyp – "application/pdf", "image/jpeg" och "image/png". Annan typ av innehåll ignoreras. |
| train |
|
| train |
Ärvda metoder
| send |
Skicka en HTTP-begäran som fylls i med hjälp av angiven OperationSpec. |
| send |
Skicka angivet httpRequest. |
Konstruktorinformation
FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)
Initierar en ny instans av klassen FormRecognizerClient.
new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)Parametrar
- credentials
- ServiceClientCredentials
Autentiseringsuppgifter för prenumeration som unikt identifierar klientprenumeration.
- endpoint
-
string
Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
- options
- ServiceClientOptions
Parameteralternativen
Information om ärvda egenskaper
credentials
credentials: ServiceClientCredentialsEgenskapsvärde
endpoint
Metodinformation
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
Extrahera nyckel/värde-par från ett visst dokument. Indatadokumentet måste vara av någon av de innehållstyper som stöds – "application/pdf", "image/jpeg" eller "image/png". Ett lyckat svar returneras i JSON.
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>Parametrar
- id
-
string
Modellidentifierare att analysera dokumentet med.
- formStream
- HttpRequestBody
Ett pdf-dokument eller en bildfil (jpg,png) som ska analyseras.
De valfria parametrarna
Returer
Promise<AnalyzeWithCustomModelResponse>
Promise<Models.AnalyzeWithCustomModelResponse>
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)Parametrar
- id
-
string
Modellidentifierare att analysera dokumentet med.
- formStream
- HttpRequestBody
Ett pdf-dokument eller en bildfil (jpg,png) som ska analyseras.
De valfria parametrarna
- callback
Motringningen
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)Parametrar
- id
-
string
Modellidentifierare att analysera dokumentet med.
- formStream
- HttpRequestBody
Ett pdf-dokument eller en bildfil (jpg,png) som ska analyseras.
- callback
Motringningen
batchReadReceipt(string, RequestOptionsBase)
Batchläsningskvittoåtgärd. Svaret innehåller ett fält med namnet "Operation-Location", som innehåller den URL som du måste använda för åtgärden "Hämta läskvittoresultat".
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>Parametrar
- url
-
string
Offentligt nåbar URL för en bild.
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<BatchReadReceiptResponse>
Promise<Models.BatchReadReceiptResponse>
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parametrar
- url
-
string
Offentligt nåbar URL för en bild.
- options
- RequestOptionsBase
De valfria parametrarna
- callback
-
ServiceCallback<void>
Motringningen
batchReadReceipt(string, ServiceCallback<void>)
function batchReadReceipt(url: string, callback: ServiceCallback<void>)Parametrar
- url
-
string
Offentligt nåbar URL för en bild.
- callback
-
ServiceCallback<void>
Motringningen
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)
Läskvittoåtgärd. När du använder gränssnittet "Batch-läskvitto" innehåller svaret ett fält med namnet "Operation-Location". Fältet Operation-Location innehåller den URL som du måste använda för åtgärden "Hämta resultat av läskvitto".
function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>Parametrar
- image
- HttpRequestBody
En bildström.
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<BatchReadReceiptInStreamResponse>
Promise<Models.BatchReadReceiptInStreamResponse>
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)Parametrar
- image
- HttpRequestBody
En bildström.
- options
- RequestOptionsBase
De valfria parametrarna
- callback
-
ServiceCallback<void>
Motringningen
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)Parametrar
- image
- HttpRequestBody
En bildström.
- callback
-
ServiceCallback<void>
Motringningen
deleteCustomModel(string, RequestOptionsBase)
Ta bort modellartefakter.
function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>Parametrar
- id
-
string
Identifieraren för modellen som ska tas bort.
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parametrar
- id
-
string
Identifieraren för modellen som ska tas bort.
- options
- RequestOptionsBase
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
deleteCustomModel(string, ServiceCallback<void>)
function deleteCustomModel(id: string, callback: ServiceCallback<void>)Parametrar
- id
-
string
Identifieraren för modellen som ska tas bort.
- callback
-
ServiceCallback<void>
Återanropet
getCustomModel(string, RequestOptionsBase)
Hämta information om en modell.
function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>Parametrar
- id
-
string
Modellidentifierare.
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<GetCustomModelResponse>
Promise<Models.GetCustomModelResponse>
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)Parametrar
- id
-
string
Modellidentifierare.
- options
- RequestOptionsBase
De valfria parametrarna
- callback
Återanropet
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)Parametrar
- id
-
string
Modellidentifierare.
- callback
Återanropet
getCustomModels(RequestOptionsBase)
Hämta information om alla tränade anpassade modeller
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>Parametrar
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<GetCustomModelsResponse>
Promise<Models.GetCustomModelsResponse>
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)Parametrar
- options
- RequestOptionsBase
De valfria parametrarna
- callback
Återanropet
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)Parametrar
- callback
Återanropet
getExtractedKeys(string, RequestOptionsBase)
Hämta nycklarna som extraherades under träningen av den angivna modellen.
function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>Parametrar
- id
-
string
Modellidentifierare.
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<GetExtractedKeysResponse>
Promise<Models.GetExtractedKeysResponse>
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)Parametrar
- id
-
string
Modellidentifierare.
- options
- RequestOptionsBase
De valfria parametrarna
- callback
Återanropet
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)Parametrar
- id
-
string
Modellidentifierare.
- callback
Återanropet
getReadReceiptResult(string, RequestOptionsBase)
Det här gränssnittet används för att hämta analysresultatet för en batchläsningskvittoåtgärd. URL:en till det här gränssnittet ska hämtas från fältet "Åtgärdsplats" som returneras från åtgärden "Batch-läskvitto".
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>Parametrar
- operationId
-
string
ID för läsåtgärden som returnerades som svar på en batchläsningskvittoåtgärd.
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<GetReadReceiptResultResponse>
Promise<Models.GetReadReceiptResultResponse>
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)Parametrar
- operationId
-
string
ID för läsåtgärden som returnerades som svar på en batchläsningskvittoåtgärd.
- options
- RequestOptionsBase
De valfria parametrarna
- callback
Återanropet
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)Parametrar
- operationId
-
string
ID för läsåtgärden som returnerades som svar på en batchläsningskvittoåtgärd.
- callback
Återanropet
trainCustomModel(TrainRequest, RequestOptionsBase)
Skapa och träna en anpassad modell. Träningsbegäran måste innehålla en källparameter som antingen är en externt tillgänglig Azure Storage-blobcontainer-URI (helst en signatur-Uri för delad åtkomst) eller en giltig sökväg till en datamapp på en lokalt monterad enhet. När lokala sökvägar har angetts måste de följa sökvägsformatet för Linux/Unix och vara en absolut sökväg som är rotad till inställningsvärdet för indatamonteringskonfigurationen, t.ex. om konfigurationsinställningsvärdet {Mounts:Input} är "/input" skulle en giltig källsökväg vara "/input/contosodataset". Alla data som ska tränas förväntas vara direkt under källmappen. Undermappar stöds inte. Modeller tränas med dokument som har följande innehållstyp – "application/pdf", "image/jpeg" och "image/png". Annan typ av innehåll ignoreras.
function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>Parametrar
- trainRequest
- TrainRequest
Begär objekt för träning.
- options
- RequestOptionsBase
De valfria parametrarna
Returer
Promise<TrainCustomModelResponse>
Promise<Models.TrainCustomModelResponse>
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)Parametrar
- trainRequest
- TrainRequest
Begär objekt för träning.
- options
- RequestOptionsBase
De valfria parametrarna
- callback
Återanropet
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)Parametrar
- trainRequest
- TrainRequest
Begär objekt för träning.
- callback
Återanropet
Ärvd metodinformation
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Skicka en HTTP-begäran som fylls i med hjälp av angiven OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Parametrar
- operationArguments
- OperationArguments
Argumenten som HTTP-begärans mallade värden fylls i från.
- operationSpec
- OperationSpec
Den OperationSpec som ska användas för att fylla i httpRequest.
- callback
-
ServiceCallback<any>
Återanropet att anropa när svaret tas emot.
Returer
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
Skicka angivet httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parametrar
- options
Returer
Promise<HttpOperationResponse>
Azure SDK for JavaScript
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för