FormRecognizerClient class
- Extends
Costruttori
Form |
Inizializza una nuova istanza della classe FormRecognizerClient. |
Proprietà ereditate
credentials | |
endpoint |
Metodi
analyze |
Estrarre coppie chiave-valore da un determinato documento. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg' o 'image/png'. Viene restituita una risposta di esito positivo in JSON. |
analyze |
|
analyze |
|
batch |
Operazione batch lettura ricevuta. La risposta contiene un campo denominato 'Operation-Location', che contiene l'URL che è necessario usare per l'operazione 'Get Read Receipt Result'. |
batch |
|
batch |
|
batch |
Operazione di lettura ricevuta. Quando si usa l'interfaccia 'Batch Read Receipt', la risposta contiene un campo denominato 'Operation-Location'. Il campo 'Operation-Location' contiene l'URL che è necessario usare per l'operazione 'Get Read Receipt Result'. |
batch |
|
batch |
|
delete |
Eliminare gli artefatti del modello. |
delete |
|
delete |
|
get |
Ottenere informazioni su un modello. |
get |
|
get |
|
get |
Ottenere informazioni su tutti i modelli personalizzati sottoposti a training |
get |
|
get |
|
get |
Recuperare le chiavi estratte durante il training del modello specificato. |
get |
|
get |
|
get |
Questa interfaccia viene usata per ottenere i risultati dell'analisi di un'operazione "Batch Read Receipt". L'URL di questa interfaccia deve essere recuperato dal campo 'Operation-Location' restituito dall'operazione 'Batch Read Receipt'. |
get |
|
get |
|
train |
Creare ed eseguire il training di un modello personalizzato. La richiesta di training deve includere un parametro di origine che sia un URI del contenitore BLOB di Archiviazione di Azure accessibile esternamente (preferibilmente un URI della firma di accesso condiviso) o un percorso valido di una cartella dati in un'unità montata localmente. Quando vengono specificati percorsi locali, devono seguire il formato del percorso Linux/Unix e essere un percorso assoluto rooted al valore dell'impostazione di configurazione del montaggio di input, ad esempio, se il valore dell'impostazione di configurazione '{Mounts:Input}' è '/input', un percorso di origine valido sarà '/input/contosodataset'. Tutti i dati di cui eseguire il training devono trovarsi direttamente nella cartella di origine. Le sottocartelle non sono supportate. I modelli vengono sottoposti a training usando documenti con il tipo di contenuto seguente: 'application/pdf', 'image/jpeg' e 'image/png'". Viene ignorato un altro tipo di contenuto. |
train |
|
train |
Metodi ereditati
send |
Inviare una richiesta HTTP popolata usando operationSpec fornito. |
send |
Inviare l'oggetto httpRequest fornito. |
Dettagli costruttore
FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)
Inizializza una nuova istanza della classe FormRecognizerClient.
new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)
Parametri
- credentials
- ServiceClientCredentials
Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione client.
- endpoint
-
string
Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).
- options
- ServiceClientOptions
Opzioni dei parametri
Dettagli proprietà ereditate
credentials
credentials: ServiceClientCredentials
Valore della proprietà
ereditato daFormRecognizerClientContext.credentials
endpoint
Dettagli metodo
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
Estrarre coppie chiave-valore da un determinato documento. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg' o 'image/png'. Viene restituita una risposta di esito positivo in JSON.
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>
Parametri
- id
-
string
Identificatore del modello con cui analizzare il documento.
- formStream
- HttpRequestBody
File pdf o immagine (jpg,png) da analizzare.
Parametri facoltativi
Restituisce
Promise<AnalyzeWithCustomModelResponse>
Promise<Models.AnalyzeWithCustomModelResponse>
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)
Parametri
- id
-
string
Identificatore del modello con cui analizzare il documento.
- formStream
- HttpRequestBody
File pdf o immagine (jpg,png) da analizzare.
Parametri facoltativi
- callback
Callback
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)
Parametri
- id
-
string
Identificatore del modello con cui analizzare il documento.
- formStream
- HttpRequestBody
File pdf o immagine (jpg,png) da analizzare.
- callback
Callback
batchReadReceipt(string, RequestOptionsBase)
Operazione batch lettura ricevuta. La risposta contiene un campo denominato 'Operation-Location', che contiene l'URL che è necessario usare per l'operazione 'Get Read Receipt Result'.
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>
Parametri
- url
-
string
URL raggiungibile pubblicamente di un'immagine.
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<BatchReadReceiptResponse>
Promise<Models.BatchReadReceiptResponse>
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)
Parametri
- url
-
string
URL raggiungibile pubblicamente di un'immagine.
- options
- RequestOptionsBase
Parametri facoltativi
- callback
-
ServiceCallback<void>
Callback
batchReadReceipt(string, ServiceCallback<void>)
function batchReadReceipt(url: string, callback: ServiceCallback<void>)
Parametri
- url
-
string
URL raggiungibile pubblicamente di un'immagine.
- callback
-
ServiceCallback<void>
Callback
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)
Operazione di lettura ricevuta. Quando si usa l'interfaccia 'Batch Read Receipt', la risposta contiene un campo denominato 'Operation-Location'. Il campo 'Operation-Location' contiene l'URL che è necessario usare per l'operazione 'Get Read Receipt Result'.
function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>
Parametri
- image
- HttpRequestBody
Flusso di immagini.
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<BatchReadReceiptInStreamResponse>
Promise<Models.BatchReadReceiptInStreamResponse>
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)
Parametri
- image
- HttpRequestBody
Flusso di immagini.
- options
- RequestOptionsBase
Parametri facoltativi
- callback
-
ServiceCallback<void>
Callback
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)
Parametri
- image
- HttpRequestBody
Flusso di immagini.
- callback
-
ServiceCallback<void>
Callback
deleteCustomModel(string, RequestOptionsBase)
Eliminare gli artefatti del modello.
function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>
Parametri
- id
-
string
Identificatore del modello da eliminare.
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)
Parametri
- id
-
string
Identificatore del modello da eliminare.
- options
- RequestOptionsBase
Parametri facoltativi
- callback
-
ServiceCallback<void>
Callback
deleteCustomModel(string, ServiceCallback<void>)
function deleteCustomModel(id: string, callback: ServiceCallback<void>)
Parametri
- id
-
string
Identificatore del modello da eliminare.
- callback
-
ServiceCallback<void>
Callback
getCustomModel(string, RequestOptionsBase)
Ottenere informazioni su un modello.
function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>
Parametri
- id
-
string
Identificatore del modello.
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<GetCustomModelResponse>
Promise<Models.GetCustomModelResponse>
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)
Parametri
- id
-
string
Identificatore del modello.
- options
- RequestOptionsBase
Parametri facoltativi
- callback
Callback
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)
Parametri
- id
-
string
Identificatore del modello.
- callback
Callback
getCustomModels(RequestOptionsBase)
Ottenere informazioni su tutti i modelli personalizzati sottoposti a training
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>
Parametri
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<GetCustomModelsResponse>
Promise<Models.GetCustomModelsResponse>
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)
Parametri
- options
- RequestOptionsBase
Parametri facoltativi
- callback
Callback
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)
Parametri
- callback
Callback
getExtractedKeys(string, RequestOptionsBase)
Recuperare le chiavi estratte durante il training del modello specificato.
function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>
Parametri
- id
-
string
Identificatore del modello.
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<GetExtractedKeysResponse>
Promise<Models.GetExtractedKeysResponse>
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)
Parametri
- id
-
string
Identificatore del modello.
- options
- RequestOptionsBase
Parametri facoltativi
- callback
Callback
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)
Parametri
- id
-
string
Identificatore del modello.
- callback
Callback
getReadReceiptResult(string, RequestOptionsBase)
Questa interfaccia viene usata per ottenere i risultati dell'analisi di un'operazione "Batch Read Receipt". L'URL di questa interfaccia deve essere recuperato dal campo 'Operation-Location' restituito dall'operazione 'Batch Read Receipt'.
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>
Parametri
- operationId
-
string
ID dell'operazione di lettura restituita nella risposta di un'operazione 'Batch Read Receipt'.
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<GetReadReceiptResultResponse>
Promise<Models.GetReadReceiptResultResponse>
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)
Parametri
- operationId
-
string
ID dell'operazione di lettura restituita nella risposta di un'operazione 'Batch Read Receipt'.
- options
- RequestOptionsBase
Parametri facoltativi
- callback
Callback
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)
Parametri
- operationId
-
string
ID dell'operazione di lettura restituita nella risposta di un'operazione 'Batch Read Receipt'.
- callback
Callback
trainCustomModel(TrainRequest, RequestOptionsBase)
Creare ed eseguire il training di un modello personalizzato. La richiesta di training deve includere un parametro di origine che sia un URI del contenitore BLOB di Archiviazione di Azure accessibile esternamente (preferibilmente un URI della firma di accesso condiviso) o un percorso valido di una cartella dati in un'unità montata localmente. Quando vengono specificati percorsi locali, devono seguire il formato del percorso Linux/Unix e essere un percorso assoluto rooted al valore dell'impostazione di configurazione del montaggio di input, ad esempio, se il valore dell'impostazione di configurazione '{Mounts:Input}' è '/input', un percorso di origine valido sarà '/input/contosodataset'. Tutti i dati di cui eseguire il training devono trovarsi direttamente nella cartella di origine. Le sottocartelle non sono supportate. I modelli vengono sottoposti a training usando documenti con il tipo di contenuto seguente: 'application/pdf', 'image/jpeg' e 'image/png'". Viene ignorato un altro tipo di contenuto.
function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>
Parametri
- trainRequest
- TrainRequest
Richiedere l'oggetto per il training.
- options
- RequestOptionsBase
Parametri facoltativi
Restituisce
Promise<TrainCustomModelResponse>
Promise<Models.TrainCustomModelResponse>
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)
Parametri
- trainRequest
- TrainRequest
Richiedere l'oggetto per il training.
- options
- RequestOptionsBase
Parametri facoltativi
- callback
Callback
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)
Parametri
- trainRequest
- TrainRequest
Richiedere l'oggetto per il training.
- callback
Callback
Dettagli dei metodi ereditati
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Inviare una richiesta HTTP popolata usando operationSpec fornito.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>
Parametri
- operationArguments
- OperationArguments
Gli argomenti da cui verranno popolati i valori basato su modelli della richiesta HTTP.
- operationSpec
- OperationSpec
OperationSpec da usare per popolare httpRequest.
- callback
-
ServiceCallback<any>
Callback da chiamare quando viene ricevuta la risposta.
Restituisce
Promise<RestResponse>
Ereditato daFormRecognizerClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Inviare l'oggetto httpRequest fornito.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
Parametri
- options
Restituisce
Promise<HttpOperationResponse>
Ereditato daFormRecognizerClientContext.sendRequest
Azure SDK for JavaScript