DocumentIntelligenceClient.GetAnalyzeResultFigure Method

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

Azure.AI.DocumentIntelligence v1.0.0-beta.3

Overloads

GetAnalyzeResultFigure(String, Guid, String, RequestContext)	[Protocol Method] Gets the generated cropped image of specified figure from document analysis. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAnalyzeResultFigure(String, Guid, String, CancellationToken) convenience overload with strongly typed models first.
GetAnalyzeResultFigure(String, Guid, String, CancellationToken)	Gets the generated cropped image of specified figure from document analysis.

GetAnalyzeResultFigure(String, Guid, String, RequestContext)

[Protocol Method] Gets the generated cropped image of specified figure from document analysis.

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

public virtual Azure.Response GetAnalyzeResultFigure (string modelId, Guid resultId, string figureId, Azure.RequestContext context);

abstract member GetAnalyzeResultFigure : string * Guid * string * Azure.RequestContext -> Azure.Response
override this.GetAnalyzeResultFigure : string * Guid * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetAnalyzeResultFigure (modelId As String, resultId As Guid, figureId As String, context As RequestContext) As Response

Parameters

modelId

String

Unique document model name.

resultId

Guid

Analyze operation result ID.

figureId

String

Figure ID.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

modelId or figureId is null.

ArgumentException

modelId or figureId 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 GetAnalyzeResultFigure 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 = client.GetAnalyzeResultFigure("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), "<figureId>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

This sample shows how to call GetAnalyzeResultFigure 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 = client.GetAnalyzeResultFigure("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), "<figureId>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

GetAnalyzeResultFigure(String, Guid, String, CancellationToken)

Gets the generated cropped image of specified figure from document analysis.

public virtual Azure.Response<BinaryData> GetAnalyzeResultFigure (string modelId, Guid resultId, string figureId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAnalyzeResultFigure : string * Guid * string * System.Threading.CancellationToken -> Azure.Response<BinaryData>
override this.GetAnalyzeResultFigure : string * Guid * string * System.Threading.CancellationToken -> Azure.Response<BinaryData>

Public Overridable Function GetAnalyzeResultFigure (modelId As String, resultId As Guid, figureId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BinaryData)

Parameters

modelId

String

Unique document model name.

resultId

Guid

Analyze operation result ID.

figureId

String

Figure ID.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<BinaryData>

Exceptions

ArgumentNullException

modelId or figureId is null.

ArgumentException

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

Examples

This sample shows how to call GetAnalyzeResultFigure.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
DocumentIntelligenceClient client = new DocumentIntelligenceClient(endpoint, credential);

Response<BinaryData> response = client.GetAnalyzeResultFigure("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), "<figureId>");

This sample shows how to call GetAnalyzeResultFigure 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 = client.GetAnalyzeResultFigure("<modelId>", Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), "<figureId>");