DocumentIntelligenceClient.GetAnalyzeResultPdfAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetAnalyzeResultPdfAsync(String, String, CancellationToken) |
Gets the generated searchable PDF output from document analysis. |
| GetAnalyzeResultPdfAsync(String, Guid, RequestContext) |
[Protocol Method] Gets the generated searchable PDF output from document analysis.
|
| GetAnalyzeResultPdfAsync(String, Guid, CancellationToken) |
Gets the generated searchable PDF output from document analysis. |
| GetAnalyzeResultPdfAsync(String, String, RequestContext) |
[Protocol Method] Gets the generated searchable PDF output from document analysis.
|
GetAnalyzeResultPdfAsync(String, String, CancellationToken)
Gets the generated searchable PDF output from document analysis.
public virtual System.Threading.Tasks.Task<Azure.Response<BinaryData>> GetAnalyzeResultPdfAsync (string modelId, string resultId, System.Threading.CancellationToken cancellationToken = default);abstract member GetAnalyzeResultPdfAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>
override this.GetAnalyzeResultPdfAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>Public Overridable Function GetAnalyzeResultPdfAsync (modelId As String, resultId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BinaryData))Parameters
- modelId
- String
Unique document model name.
- resultId
- String
Analyze operation result ID.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
modelId is null.
modelId is an empty string, and was expected to be non-empty.
Applies to
GetAnalyzeResultPdfAsync(String, Guid, RequestContext)
[Protocol Method] Gets the generated searchable PDF output from document analysis.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetAnalyzeResultPdfAsync(String, Guid, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetAnalyzeResultPdfAsync (string modelId, Guid resultId, Azure.RequestContext context);abstract member GetAnalyzeResultPdfAsync : string * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetAnalyzeResultPdfAsync : string * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetAnalyzeResultPdfAsync (modelId As String, resultId As Guid, context As RequestContext) As Task(Of Response)Parameters
- modelId
- String
Unique document model name.
- resultId
- Guid
Analyze operation result ID.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
modelId is null.
modelId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call GetAnalyzeResultPdfAsync and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceClient client = new DocumentIntelligenceClient(endpoint, credential);
Response response = await client.GetAnalyzeResultPdfAsync("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
This sample shows how to call GetAnalyzeResultPdfAsync with all parameters and parse the result.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceClient client = new DocumentIntelligenceClient(endpoint, credential);
Response response = await client.GetAnalyzeResultPdfAsync("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
Applies to
GetAnalyzeResultPdfAsync(String, Guid, CancellationToken)
Gets the generated searchable PDF output from document analysis.
public virtual System.Threading.Tasks.Task<Azure.Response<BinaryData>> GetAnalyzeResultPdfAsync (string modelId, Guid resultId, System.Threading.CancellationToken cancellationToken = default);abstract member GetAnalyzeResultPdfAsync : string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>
override this.GetAnalyzeResultPdfAsync : string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<BinaryData>>Public Overridable Function GetAnalyzeResultPdfAsync (modelId As String, resultId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BinaryData))Parameters
- modelId
- String
Unique document model name.
- resultId
- Guid
Analyze operation result ID.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
modelId is null.
modelId is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call GetAnalyzeResultPdfAsync.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceClient client = new DocumentIntelligenceClient(endpoint, credential);
Response<BinaryData> response = await client.GetAnalyzeResultPdfAsync("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"));
This sample shows how to call GetAnalyzeResultPdfAsync with all parameters.
Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceClient client = new DocumentIntelligenceClient(endpoint, credential);
Response<BinaryData> response = await client.GetAnalyzeResultPdfAsync("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"));
Applies to
GetAnalyzeResultPdfAsync(String, String, RequestContext)
[Protocol Method] Gets the generated searchable PDF output from document analysis.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetAnalyzeResultPdfAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetAnalyzeResultPdfAsync (string modelId, string resultId, Azure.RequestContext context);abstract member GetAnalyzeResultPdfAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetAnalyzeResultPdfAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetAnalyzeResultPdfAsync (modelId As String, resultId As String, context As RequestContext) As Task(Of Response)Parameters
- modelId
- String
Unique document model name.
- resultId
- String
Analyze operation result ID.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
modelId is null.
modelId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
