DocumentIntelligenceClient.GetAnalyzeBatchResults Method

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

Azure.AI.DocumentIntelligence v1.0.0

Overloads

GetAnalyzeBatchResults(String, RequestContext)	[Protocol Method] List batch document analysis results. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAnalyzeBatchResults(String, CancellationToken) convenience overload with strongly typed models first.
GetAnalyzeBatchResults(String, CancellationToken)	List batch document analysis results.

GetAnalyzeBatchResults(String, RequestContext)

Source:

DocumentIntelligenceClient.cs

[Protocol Method] List batch document analysis results.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetAnalyzeBatchResults(String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Pageable<BinaryData> GetAnalyzeBatchResults (string modelId, Azure.RequestContext context);

abstract member GetAnalyzeBatchResults : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAnalyzeBatchResults : string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetAnalyzeBatchResults (modelId As String, context As RequestContext) As Pageable(Of BinaryData)

Parameters

modelId

String

Unique document model name.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Pageable<BinaryData>

The Pageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

ArgumentNullException

modelId is null.

ArgumentException

modelId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetAnalyzeBatchResults and parse the result.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceClient client = new DocumentIntelligenceClient(endpoint, credential);

foreach (BinaryData item in client.GetAnalyzeBatchResults("prebuilt-invoice", null))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("status").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
}

GetAnalyzeBatchResults(String, CancellationToken)

Source:

DocumentIntelligenceClient.cs

List batch document analysis results.

public virtual Azure.Pageable<Azure.AI.DocumentIntelligence.AnalyzeBatchOperationDetails> GetAnalyzeBatchResults (string modelId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAnalyzeBatchResults : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.AnalyzeBatchOperationDetails>
override this.GetAnalyzeBatchResults : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.DocumentIntelligence.AnalyzeBatchOperationDetails>

Public Overridable Function GetAnalyzeBatchResults (modelId As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of AnalyzeBatchOperationDetails)

Parameters

modelId

String

Unique document model name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<AnalyzeBatchOperationDetails>

Exceptions

ArgumentNullException

modelId is null.

ArgumentException

modelId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetAnalyzeBatchResults.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceClient client = new DocumentIntelligenceClient(endpoint, credential);

foreach (AnalyzeBatchOperationDetails item in client.GetAnalyzeBatchResults("prebuilt-invoice"))
{
}