FormRecognizerClient.GetExtractedKeysWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.CognitiveServices.FormRecognizer

Assembly:

Microsoft.Azure.CognitiveServices.FormRecognizer.dll

Package:

Microsoft.Azure.CognitiveServices.FormRecognizer v0.8.0-preview

Get Keys

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.FormRecognizer.Models.KeysResult>> GetExtractedKeysWithHttpMessagesAsync (Guid id, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetExtractedKeysWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.FormRecognizer.Models.KeysResult>>
override this.GetExtractedKeysWithHttpMessagesAsync : Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.FormRecognizer.Models.KeysResult>>

Public Function GetExtractedKeysWithHttpMessagesAsync (id As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of KeysResult))

Parameters

id

Guid

Model identifier.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<KeysResult>>

Implements

GetExtractedKeysWithHttpMessagesAsync(Guid, Dictionary<String,List<String>>, CancellationToken)

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

Use the API to retrieve the keys that were extracted by the specified model.