DocumentIntelligenceClient Class

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

Azure.AI.DocumentIntelligence v1.0.0-beta.3

Source:

DocumentIntelligenceClient.cs

The DocumentIntelligence service client.

public class DocumentIntelligenceClient

type DocumentIntelligenceClient = class

Public Class DocumentIntelligenceClient

Inheritance

Object

DocumentIntelligenceClient

Constructors

DocumentIntelligenceClient()	Initializes a new instance of DocumentIntelligenceClient for mocking.
DocumentIntelligenceClient(Uri, AzureKeyCredential, DocumentIntelligenceClientOptions)	Initializes a new instance of DocumentIntelligenceClient.
DocumentIntelligenceClient(Uri, AzureKeyCredential)	Initializes a new instance of DocumentIntelligenceClient.
DocumentIntelligenceClient(Uri, TokenCredential, DocumentIntelligenceClientOptions)	Initializes a new instance of DocumentIntelligenceClient.
DocumentIntelligenceClient(Uri, TokenCredential)	Initializes a new instance of DocumentIntelligenceClient.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AnalyzeBatchDocuments(WaitUntil, String, AnalyzeBatchDocumentsContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken)	Analyzes batch documents with document model.
AnalyzeBatchDocuments(WaitUntil, String, RequestContent, String, String, String, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, String, IEnumerable<AnalyzeOutputOption>, RequestContext)	[Protocol Method] Analyzes batch documents with document model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AnalyzeBatchDocuments(WaitUntil, String, AnalyzeBatchDocumentsContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken) convenience overload with strongly typed models first.
AnalyzeBatchDocumentsAsync(WaitUntil, String, AnalyzeBatchDocumentsContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken)	Analyzes batch documents with document model.
AnalyzeBatchDocumentsAsync(WaitUntil, String, RequestContent, String, String, String, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, String, IEnumerable<AnalyzeOutputOption>, RequestContext)	[Protocol Method] Analyzes batch documents with document model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AnalyzeBatchDocumentsAsync(WaitUntil, String, AnalyzeBatchDocumentsContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken) convenience overload with strongly typed models first.
AnalyzeDocument(WaitUntil, String, AnalyzeDocumentContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken)	Analyzes document with document model.
AnalyzeDocument(WaitUntil, String, RequestContent, String, String, String, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, String, IEnumerable<AnalyzeOutputOption>, RequestContext)	[Protocol Method] Analyzes document with document model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AnalyzeDocument(WaitUntil, String, AnalyzeDocumentContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken) convenience overload with strongly typed models first.
AnalyzeDocumentAsync(WaitUntil, String, AnalyzeDocumentContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken)	Analyzes document with document model.
AnalyzeDocumentAsync(WaitUntil, String, RequestContent, String, String, String, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, String, IEnumerable<AnalyzeOutputOption>, RequestContext)	[Protocol Method] Analyzes document with document model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AnalyzeDocumentAsync(WaitUntil, String, AnalyzeDocumentContent, String, String, Nullable<StringIndexType>, IEnumerable<DocumentAnalysisFeature>, IEnumerable<String>, Nullable<ContentFormat>, IEnumerable<AnalyzeOutputOption>, CancellationToken) convenience overload with strongly typed models first.
ClassifyDocument(WaitUntil, String, ClassifyDocumentContent, Nullable<StringIndexType>, Nullable<SplitMode>, String, CancellationToken)	Classifies document with document classifier.
ClassifyDocument(WaitUntil, String, RequestContent, String, String, String, RequestContext)	[Protocol Method] Classifies document with document classifier. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler ClassifyDocument(WaitUntil, String, ClassifyDocumentContent, Nullable<StringIndexType>, Nullable<SplitMode>, String, CancellationToken) convenience overload with strongly typed models first.
ClassifyDocumentAsync(WaitUntil, String, ClassifyDocumentContent, Nullable<StringIndexType>, Nullable<SplitMode>, String, CancellationToken)	Classifies document with document classifier.
ClassifyDocumentAsync(WaitUntil, String, RequestContent, String, String, String, RequestContext)	[Protocol Method] Classifies document with document classifier. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler ClassifyDocumentAsync(WaitUntil, String, ClassifyDocumentContent, Nullable<StringIndexType>, Nullable<SplitMode>, String, CancellationToken) convenience overload with strongly typed models first.
GetAnalyzeResultFigure(String, Guid, String, CancellationToken)	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. 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.
GetAnalyzeResultFigureAsync(String, Guid, String, CancellationToken)	Gets the generated cropped image of specified figure from document analysis.
GetAnalyzeResultFigureAsync(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 GetAnalyzeResultFigureAsync(String, Guid, String, CancellationToken) convenience overload with strongly typed models first.
GetAnalyzeResultPdf(String, Guid, CancellationToken)	Gets the generated searchable PDF output from document analysis.
GetAnalyzeResultPdf(String, Guid, RequestContext)	[Protocol Method] Gets the generated searchable PDF output from document analysis. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAnalyzeResultPdf(String, Guid, CancellationToken) convenience overload with strongly typed models first.
GetAnalyzeResultPdfAsync(String, Guid, CancellationToken)	Gets the generated searchable PDF output from document analysis.
GetAnalyzeResultPdfAsync(String, Guid, RequestContext)	[Protocol Method] Gets the generated searchable PDF output from document analysis. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAnalyzeResultPdfAsync(String, Guid, CancellationToken) convenience overload with strongly typed models first.