ContentUnderstandingClient.AnalyzeInlineAsync 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 |
|---|---|
| AnalyzeInlineAsync(AnalyzeOptions, CancellationToken) |
Extract content and fields from input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation. |
| AnalyzeInlineAsync(String, IEnumerable<AnalysisInput>, IDictionary<String,String>, Nullable<ProcessingLocation>, CancellationToken) |
Extract content and fields from input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation. |
| AnalyzeInlineAsync(String, RequestContent, String, String, Nullable<Boolean>, Nullable<Guid>, RequestContext) |
[Protocol Method] Extract content and fields from input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation — no polling or separate result retrieval is needed. Intended for lightweight analysis scenarios (e.g., document analyzers without field extraction, small page counts). The result is not persisted on the server. See service documentation for current constraints.
|
AnalyzeInlineAsync(AnalyzeOptions, CancellationToken)
Extract content and fields from 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>> AnalyzeInlineAsync(Azure.AI.ContentUnderstanding.AnalyzeOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeInlineAsync : Azure.AI.ContentUnderstanding.AnalyzeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>
override this.AnalyzeInlineAsync : Azure.AI.ContentUnderstanding.AnalyzeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>Public Overridable Function AnalyzeInlineAsync (options As AnalyzeOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalysisResult))Parameters
- options
- AnalyzeOptions
Options for the 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
AnalyzeInlineAsync(String, IEnumerable<AnalysisInput>, IDictionary<String,String>, Nullable<ProcessingLocation>, CancellationToken)
Extract content and fields from 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>> AnalyzeInlineAsync(string analyzerId, System.Collections.Generic.IEnumerable<Azure.AI.ContentUnderstanding.AnalysisInput> inputs, System.Collections.Generic.IDictionary<string,string>? modelDeployments = default, Azure.AI.ContentUnderstanding.ProcessingLocation? processingLocation = default, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeInlineAsync : string * seq<Azure.AI.ContentUnderstanding.AnalysisInput> * System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.AI.ContentUnderstanding.ProcessingLocation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>
override this.AnalyzeInlineAsync : string * seq<Azure.AI.ContentUnderstanding.AnalysisInput> * System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.AI.ContentUnderstanding.ProcessingLocation> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentUnderstanding.AnalysisResult>>Public Overridable Function AnalyzeInlineAsync (analyzerId As String, inputs As IEnumerable(Of AnalysisInput), Optional modelDeployments As IDictionary(Of String, 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.
- inputs
- IEnumerable<AnalysisInput>
Inputs to analyze.
- modelDeployments
- IDictionary<String,String>
Override default mapping of model names to deployments. Ex. { "gpt-5.2": "myGpt52Deployment", "text-embedding-3-large": "myTextEmbedding3LargeDeployment" }.
- 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 inputs 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
AnalyzeInlineAsync(String, RequestContent, String, String, Nullable<Boolean>, Nullable<Guid>, RequestContext)
[Protocol Method] Extract content and fields from input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation — no polling or separate result retrieval is needed. Intended for lightweight analysis scenarios (e.g., document analyzers without field extraction, small page counts). The result is not persisted on the server. See service documentation for current constraints.
- 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> AnalyzeInlineAsync(string analyzerId, Azure.Core.RequestContent content, string stringEncoding = default, string processingLocation = default, bool? allowInputTruncation = default, Guid? clientRequestId = default, Azure.RequestContext context = default);abstract member AnalyzeInlineAsync : string * Azure.Core.RequestContent * string * string * Nullable<bool> * Nullable<Guid> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AnalyzeInlineAsync : string * Azure.Core.RequestContent * string * string * Nullable<bool> * Nullable<Guid> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function AnalyzeInlineAsync (analyzerId As String, content As RequestContent, Optional stringEncoding As String = Nothing, Optional processingLocation As String = Nothing, Optional allowInputTruncation As Nullable(Of Boolean) = 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.
- 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.
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 or content is null.
analyzerId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
