ContentUnderstandingClient.AnalyzeBinaryAsync 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
| Name | Description |
|---|---|
| AnalyzeBinaryAsync(WaitUntil, String, String, RequestContent, String, String, Nullable<Boolean>, String, Nullable<Guid>, RequestContext) |
Extract content and fields from binary input. |
| AnalyzeBinaryAsync(WaitUntil, AnalyzeBinaryOptions, CancellationToken) |
Extract content and fields from binary input. |
| AnalyzeBinaryAsync(WaitUntil, String, BinaryData, Nullable<ContentRange>, String, Nullable<ProcessingLocation>, CancellationToken) |
Extract content and fields from binary input. |
AnalyzeBinaryAsync(WaitUntil, String, String, RequestContent, String, String, Nullable<Boolean>, String, Nullable<Guid>, RequestContext)
Extract content and fields from binary input.
public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> AnalyzeBinaryAsync(Azure.WaitUntil waitUntil, string analyzerId, string contentType, Azure.Core.RequestContent content, string stringEncoding = default, string processingLocation = default, bool? allowInputTruncation = default, string contentRange = default, Guid? clientRequestId = default, Azure.RequestContext context = default);abstract member AnalyzeBinaryAsync : Azure.WaitUntil * string * string * Azure.Core.RequestContent * string * string * Nullable<bool> * string * Nullable<Guid> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.AnalyzeBinaryAsync : Azure.WaitUntil * string * string * Azure.Core.RequestContent * string * string * Nullable<bool> * string * Nullable<Guid> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>Public Overridable Function AnalyzeBinaryAsync (waitUntil As WaitUntil, analyzerId As String, contentType As String, content As RequestContent, Optional stringEncoding As String = Nothing, Optional processingLocation As String = Nothing, Optional allowInputTruncation As Nullable(Of Boolean) = Nothing, Optional contentRange As String = Nothing, Optional clientRequestId As Nullable(Of Guid) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation.
- analyzerId
- String
The unique identifier of the analyzer.
- contentType
- String
Request content type. Defaults to application/octet-stream if not specified.
- content
- RequestContent
The content to send as the body of the request.
- stringEncoding
- String
The string encoding format for content spans in the response.
- processingLocation
- String
The location where the data may be processed. Defaults to global.
Overrides the analyzer's allowInputTruncation setting for this request. When omitted, the analyzer's configured value applies.
- contentRange
- String
Range of the input to analyze.
An optional, client-generated GUID that uniquely identifies the request.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The Operation<T> representing an asynchronous operation on the service.
Applies to
AnalyzeBinaryAsync(WaitUntil, AnalyzeBinaryOptions, CancellationToken)
Extract content and fields from binary input.
public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.ContentUnderstanding.AnalysisResult>> AnalyzeBinaryAsync(Azure.WaitUntil waitUntil, Azure.AI.ContentUnderstanding.AnalyzeBinaryOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeBinaryAsync : Azure.WaitUntil * Azure.AI.ContentUnderstanding.AnalyzeBinaryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.ContentUnderstanding.AnalysisResult>>
override this.AnalyzeBinaryAsync : Azure.WaitUntil * Azure.AI.ContentUnderstanding.AnalyzeBinaryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.ContentUnderstanding.AnalysisResult>>Public Overridable Function AnalyzeBinaryAsync (waitUntil As WaitUntil, options As AnalyzeBinaryOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of AnalysisResult))Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- options
- AnalyzeBinaryOptions
Additional options for the binary analysis request.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
The Operation<T> with operation ID accessible via the Id property.
Exceptions
options is null.
Applies to
AnalyzeBinaryAsync(WaitUntil, String, BinaryData, Nullable<ContentRange>, String, Nullable<ProcessingLocation>, CancellationToken)
Extract content and fields from binary input.
public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.AI.ContentUnderstanding.AnalysisResult>> AnalyzeBinaryAsync(Azure.WaitUntil waitUntil, string analyzerId, BinaryData binaryInput, Azure.AI.ContentUnderstanding.ContentRange? contentRange = default, string? contentType = default, Azure.AI.ContentUnderstanding.ProcessingLocation? processingLocation = default, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeBinaryAsync : Azure.WaitUntil * string * BinaryData * Nullable<Azure.AI.ContentUnderstanding.ContentRange> * string * Nullable<Azure.AI.ContentUnderstanding.ProcessingLocation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.ContentUnderstanding.AnalysisResult>>
override this.AnalyzeBinaryAsync : Azure.WaitUntil * string * BinaryData * Nullable<Azure.AI.ContentUnderstanding.ContentRange> * string * Nullable<Azure.AI.ContentUnderstanding.ProcessingLocation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.AI.ContentUnderstanding.AnalysisResult>>Public Overridable Function AnalyzeBinaryAsync (waitUntil As WaitUntil, analyzerId As String, binaryInput As BinaryData, Optional contentRange As Nullable(Of ContentRange) = Nothing, Optional contentType As String = Nothing, Optional processingLocation As Nullable(Of ProcessingLocation) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of AnalysisResult))Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- analyzerId
- String
The unique identifier of the analyzer.
- binaryInput
- BinaryData
The binary content of the document to analyze.
- contentRange
- Nullable<ContentRange>
Range of the input to analyze. Use factory methods such as Pages(Int32, Int32), TimeRange(TimeSpan, TimeSpan), or Combine(ContentRange[]) to build the range.
- contentType
- String
Request content type. If not specified, uses binaryInput's MediaType if available, otherwise defaults to "application/octet-stream".
- processingLocation
- Nullable<ProcessingLocation>
The location where the data may be processed. Defaults to global.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
The Operation<T> with operation ID accessible via the Id property.
Exceptions
analyzerId or binaryInput is null.
analyzerId is an empty string, and was expected to be non-empty.
