DocumentIntelligenceClient.GetAnalyzeResultFigure 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
| GetAnalyzeResultFigure(String, String, String, CancellationToken) |
Gets the generated cropped image of specified figure from document analysis. |
| GetAnalyzeResultFigure(String, String, String, RequestContext) |
[Protocol Method] 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.
|
| GetAnalyzeResultFigure(String, Guid, String, CancellationToken) |
Gets the generated cropped image of specified figure from document analysis. |
GetAnalyzeResultFigure(String, String, String, CancellationToken)
Gets the generated cropped image of specified figure from document analysis.
public virtual Azure.Response<BinaryData> GetAnalyzeResultFigure (string modelId, string resultId, string figureId, System.Threading.CancellationToken cancellationToken = default);abstract member GetAnalyzeResultFigure : string * string * string * System.Threading.CancellationToken -> Azure.Response<BinaryData>
override this.GetAnalyzeResultFigure : string * string * string * System.Threading.CancellationToken -> Azure.Response<BinaryData>Public Overridable Function GetAnalyzeResultFigure (modelId As String, resultId As String, figureId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BinaryData)Parameters
- modelId
- String
Unique document model name.
- resultId
- String
Analyze operation result ID.
- figureId
- String
Figure ID.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
modelId or figureId is null.
modelId or figureId is an empty string, and was expected to be non-empty.
Applies to
GetAnalyzeResultFigure(String, String, 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, String, String, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response GetAnalyzeResultFigure (string modelId, string resultId, string figureId, Azure.RequestContext context);abstract member GetAnalyzeResultFigure : string * string * string * Azure.RequestContext -> Azure.Response
override this.GetAnalyzeResultFigure : string * string * string * Azure.RequestContext -> Azure.ResponsePublic Overridable Function GetAnalyzeResultFigure (modelId As String, resultId As String, figureId As String, context As RequestContext) As ResponseParameters
- modelId
- String
Unique document model name.
- resultId
- String
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
The response returned from the service.
Exceptions
modelId or figureId is null.
modelId or figureId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
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.ResponsePublic Overridable Function GetAnalyzeResultFigure (modelId As String, resultId As Guid, figureId As String, context As RequestContext) As ResponseParameters
- 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
The response returned from the service.
Exceptions
modelId or figureId is null.
modelId or figureId 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 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());
Applies to
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
Exceptions
modelId or figureId is null.
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>");
