ContentUnderstandingClient Class
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.
Partial class for ContentUnderstandingClient to customize generated methods.
public class ContentUnderstandingClienttype ContentUnderstandingClient = classPublic Class ContentUnderstandingClient- Inheritance
-
ContentUnderstandingClient
Constructors
| Name | Description |
|---|---|
| ContentUnderstandingClient() |
Initializes a new instance of ContentUnderstandingClient for mocking. |
| ContentUnderstandingClient(ContentUnderstandingClientSettings) |
Initializes a new instance of ContentUnderstandingClient from a ContentUnderstandingClientSettings. |
| ContentUnderstandingClient(Uri, AzureKeyCredential, ContentUnderstandingClientOptions) |
Initializes a new instance of ContentUnderstandingClient. |
| ContentUnderstandingClient(Uri, AzureKeyCredential) |
Initializes a new instance of ContentUnderstandingClient. |
| ContentUnderstandingClient(Uri, TokenCredential, ContentUnderstandingClientOptions) |
Initializes a new instance of ContentUnderstandingClient. |
| ContentUnderstandingClient(Uri, TokenCredential) |
Initializes a new instance of ContentUnderstandingClient. |
Properties
| Name | Description |
|---|---|
| Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. |
Methods
| Name | Description |
|---|---|
| Analyze(WaitUntil, AnalyzeOptions, CancellationToken) |
Extract content and fields from input. |
| Analyze(WaitUntil, String, IEnumerable<AnalysisInput>, IDictionary<String,String>, Nullable<ProcessingLocation>, CancellationToken) |
Extract content and fields from input. |
| Analyze(WaitUntil, String, RequestContent, String, String, Nullable<Boolean>, Nullable<Guid>, RequestContext) |
Extract content and fields from input. |
| AnalyzeAsync(WaitUntil, AnalyzeOptions, CancellationToken) |
Extract content and fields from input. |
| AnalyzeAsync(WaitUntil, String, IEnumerable<AnalysisInput>, IDictionary<String,String>, Nullable<ProcessingLocation>, CancellationToken) |
Extract content and fields from input. |
| AnalyzeAsync(WaitUntil, String, RequestContent, String, String, Nullable<Boolean>, Nullable<Guid>, RequestContext) |
Extract content and fields from input. |
| AnalyzeBinary(WaitUntil, AnalyzeBinaryOptions, CancellationToken) |
Extract content and fields from binary input. |
| AnalyzeBinary(WaitUntil, String, BinaryData, Nullable<ContentRange>, String, Nullable<ProcessingLocation>, CancellationToken) |
Extract content and fields from binary input. |
| AnalyzeBinary(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. |
| AnalyzeBinaryInline(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. |
| AnalyzeBinaryInline(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. |
| AnalyzeBinaryInline(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. |
| 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.
|
| AnalyzeInline(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. |
| AnalyzeInline(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. |
| AnalyzeInline(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. |
| 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.
|
| CopyAnalyzer(WaitUntil, String, RequestContent, Nullable<Boolean>, RequestContext) |
Create a copy of the source analyzer to the current location. |
| CopyAnalyzer(WaitUntil, String, String, String, String, Nullable<Boolean>, CancellationToken) |
Create a copy of the source analyzer to the current location. |
| CopyAnalyzerAsync(WaitUntil, String, RequestContent, Nullable<Boolean>, RequestContext) |
Create a copy of the source analyzer to the current location. |
| CopyAnalyzerAsync(WaitUntil, String, String, String, String, Nullable<Boolean>, CancellationToken) |
Create a copy of the source analyzer to the current location. |
| CreateAnalyzer(WaitUntil, String, ContentAnalyzer, Nullable<Boolean>, CancellationToken) |
Create a new analyzer asynchronously. |
| CreateAnalyzer(WaitUntil, String, RequestContent, Nullable<Boolean>, RequestContext) |
Create a new analyzer asynchronously. |
| CreateAnalyzerAsync(WaitUntil, String, ContentAnalyzer, Nullable<Boolean>, CancellationToken) |
Create a new analyzer asynchronously. |
| CreateAnalyzerAsync(WaitUntil, String, RequestContent, Nullable<Boolean>, RequestContext) |
Create a new analyzer asynchronously. |
| DeleteAnalyzer(String, CancellationToken) |
Delete analyzer. |
| DeleteAnalyzer(String, RequestContext) |
[Protocol Method] Delete analyzer.
|
| DeleteAnalyzerAsync(String, CancellationToken) |
Delete analyzer. |
| DeleteAnalyzerAsync(String, RequestContext) |
[Protocol Method] Delete analyzer.
|
| DeleteResult(String, CancellationToken) |
Mark the result of an analysis operation for deletion. |
| DeleteResult(String, RequestContext) |
[Protocol Method] Mark the result of an analysis operation for deletion.
|
| DeleteResultAsync(String, CancellationToken) |
Mark the result of an analysis operation for deletion. |
| DeleteResultAsync(String, RequestContext) |
[Protocol Method] Mark the result of an analysis operation for deletion.
|
| GetAnalyzer(String, CancellationToken) |
Get analyzer properties. |
| GetAnalyzer(String, RequestContext) |
[Protocol Method] Get analyzer properties.
|
| GetAnalyzerAsync(String, CancellationToken) |
Get analyzer properties. |
| GetAnalyzerAsync(String, RequestContext) |
[Protocol Method] Get analyzer properties.
|
| GetAnalyzers(CancellationToken) |
List analyzers. |
| GetAnalyzers(RequestContext) |
[Protocol Method] List analyzers.
|
| GetAnalyzersAsync(CancellationToken) |
List analyzers. |
| GetAnalyzersAsync(RequestContext) |
[Protocol Method] List analyzers.
|
| GetDefaults(CancellationToken) |
Return default settings for this Content Understanding resource. |
| GetDefaults(RequestContext) |
[Protocol Method] Return default settings for this Content Understanding resource.
|
| GetDefaultsAsync(CancellationToken) |
Return default settings for this Content Understanding resource. |
| GetDefaultsAsync(RequestContext) |
[Protocol Method] Return default settings for this Content Understanding resource.
|
| GetResultFile(String, String, CancellationToken) |
Get a file associated with the result of an analysis operation. |
| GetResultFile(String, String, RequestContext) |
[Protocol Method] Get a file associated with the result of an analysis operation.
|
| GetResultFileAsync(String, String, CancellationToken) |
Get a file associated with the result of an analysis operation. |
| GetResultFileAsync(String, String, RequestContext) |
[Protocol Method] Get a file associated with the result of an analysis operation.
|
| GrantCopyAuthorization(String, RequestContent, RequestContext) |
[Protocol Method] Get authorization for copying this analyzer to another location.
|
| GrantCopyAuthorization(String, String, String, CancellationToken) |
Get authorization for copying this analyzer to another location. |
| GrantCopyAuthorizationAsync(String, RequestContent, RequestContext) |
[Protocol Method] Get authorization for copying this analyzer to another location.
|
| GrantCopyAuthorizationAsync(String, String, String, CancellationToken) |
Get authorization for copying this analyzer to another location. |
| UpdateAnalyzer(String, ContentAnalyzer, CancellationToken) |
Update analyzer properties. |
| UpdateAnalyzer(String, RequestContent, RequestContext) |
[Protocol Method] Update analyzer properties.
|
| UpdateAnalyzerAsync(String, ContentAnalyzer, CancellationToken) |
Update analyzer properties asynchronously. |
| UpdateAnalyzerAsync(String, RequestContent, RequestContext) |
[Protocol Method] Update analyzer properties.
|
| UpdateDefaults(IDictionary<String,String>, CancellationToken) |
Update default model deployment settings. |
| UpdateDefaults(RequestContent, RequestContext) |
[Protocol Method] Update default settings for this Content Understanding resource.
|
| UpdateDefaultsAsync(IDictionary<String,String>, CancellationToken) |
Update default model deployment settings asynchronously. |
| UpdateDefaultsAsync(RequestContent, RequestContext) |
[Protocol Method] Update default settings for this Content Understanding resource.
|
