ContentUnderstandingClient.AnalyzeBinaryInlineAsync 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 |
|---|---|
| AnalyzeBinaryInlineAsync(AnalyzeBinaryOptions, CancellationToken) |
Extract content and fields from binary input using an options bag. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation. |
| AnalyzeBinaryInlineAsync(String, BinaryData, Nullable<ContentRange>, String, Nullable<ProcessingLocation>, CancellationToken) |
Extract content and fields from binary input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation. |
| AnalyzeBinaryInlineAsync(String, RequestContent, String, String, String, Nullable<Boolean>, String, Nullable<Guid>, RequestContext) |
[Protocol Method] Extract content and fields from binary input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation.
|
AnalyzeBinaryInlineAsync(AnalyzeBinaryOptions, CancellationToken)
Extract content and fields from binary input using an options bag. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>> AnalyzeBinaryInlineAsync(Azure.AI.ContentUnderstanding.AnalyzeBinaryOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeBinaryInlineAsync : Azure.AI.ContentUnderstanding.AnalyzeBinaryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>
override this.AnalyzeBinaryInlineAsync : Azure.AI.ContentUnderstanding.AnalyzeBinaryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>Public Overridable Function AnalyzeBinaryInlineAsync (options As AnalyzeBinaryOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalysisResult))Parameters
- options
- AnalyzeBinaryOptions
Additional options for the binary analysis request.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
options is null.
Service returned a non-success status code, or the inline operation status was not Succeeded.
Remarks
Available only when the client is configured for service API version 2026-06-01-preview.
Applies to
AnalyzeBinaryInlineAsync(String, BinaryData, Nullable<ContentRange>, String, Nullable<ProcessingLocation>, CancellationToken)
Extract content and fields from binary input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>> AnalyzeBinaryInlineAsync(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 AnalyzeBinaryInlineAsync : string * BinaryData * Nullable<Azure.AI.ContentUnderstanding.ContentRange> * string * Nullable<Azure.AI.ContentUnderstanding.ProcessingLocation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>
override this.AnalyzeBinaryInlineAsync : string * BinaryData * Nullable<Azure.AI.ContentUnderstanding.ContentRange> * string * Nullable<Azure.AI.ContentUnderstanding.ProcessingLocation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>Public Overridable Function AnalyzeBinaryInlineAsync (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 Response(Of AnalysisResult))Parameters
- 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
Exceptions
analyzerId or binaryInput is null.
analyzerId is an empty string, and was expected to be non-empty.
Service returned a non-success status code, or the inline operation status was not Succeeded.
Remarks
Available only when the client is configured for service API version 2026-06-01-preview.
Applies to
AnalyzeBinaryInlineAsync(String, RequestContent, String, String, String, Nullable<Boolean>, String, Nullable<Guid>, RequestContext)
[Protocol Method] Extract content and fields from binary input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response> AnalyzeBinaryInlineAsync(string analyzerId, Azure.Core.RequestContent content, string contentType, string stringEncoding = default, string processingLocation = default, bool? allowInputTruncation = default, string contentRange = default, Guid? clientRequestId = default, Azure.RequestContext context = default);abstract member AnalyzeBinaryInlineAsync : string * Azure.Core.RequestContent * string * string * string * Nullable<bool> * string * Nullable<Guid> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AnalyzeBinaryInlineAsync : string * Azure.Core.RequestContent * string * string * string * Nullable<bool> * string * Nullable<Guid> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function AnalyzeBinaryInlineAsync (analyzerId As String, content As RequestContent, contentType As String, 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 Response)Parameters
- analyzerId
- String
The unique identifier of the analyzer.
- content
- RequestContent
The content to send as the body of the request.
- contentType
- String
Request content type.
- stringEncoding
- String
The string encoding format for content spans in the response.
Possible values are 'codePoint', 'utf16', and utf8. Default is codePoint.
- 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 (ex. 1-3,5,9-). Document content uses 1-based page numbers, while audio visual content uses integer milliseconds.
An opaque, globally-unique, client-generated string identifier for the request.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
analyzerId, content or contentType is null.
analyzerId or contentType is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Remarks
Available only when the client is configured for service API version 2026-06-01-preview.
