DocumentIntelligenceClient Class

DocumentIntelligenceClient.

Constructor

DocumentIntelligenceClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Parameters

Name	Description
endpoint Required	str The Document Intelligence service endpoint. Required.
credential Required	AzureKeyCredential or TokenCredential Credential needed for the client to connect to Azure. Is either a AzureKeyCredential type or a TokenCredential type. Required.

Keyword-Only Parameters

Name	Description
api_version	str The API version to use for this operation. Default value is "2024-11-30". Note that overriding this default value may result in unsupported behavior.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Methods

begin_analyze_batch_documents	Analyzes batch documents with document model.
begin_analyze_document	Analyzes document with document model.
begin_classify_document	Classifies document with document classifier.
close
delete_analyze_batch_result	Mark the batch document analysis result for deletion.
delete_analyze_result	Mark the result of document analysis for deletion.
get_analyze_batch_result	Gets the result of batch document analysis.
get_analyze_result_figure	Gets the generated cropped image of specified figure from document analysis.
get_analyze_result_pdf	Gets the generated searchable PDF output from document analysis.
list_analyze_batch_results	List batch document analysis results.
send_request	Runs the network request through the client's chained policies. `>>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = client.send_request(request) <HttpResponse: 200 OK>` For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

begin_analyze_batch_documents

Analyzes batch documents with document model.

begin_analyze_batch_documents(model_id: str, body: AnalyzeBatchDocumentsRequest | MutableMapping[str, Any] | IO[bytes], *, pages: str | None = None, locale: str | None = None, string_index_type: str | StringIndexType | None = None, features: List[str | DocumentAnalysisFeature] | None = None, query_fields: List[str] | None = None, output_content_format: str | DocumentContentFormat | None = None, output: List[str | AnalyzeOutputOption] | None = None, **kwargs: Any) -> LROPoller[AnalyzeBatchResult]

Parameters

Name	Description
model_id Required	str Unique document model name. Required.
body Required	AnalyzeBatchDocumentsRequest or <xref:JSON> or IO[bytes] Analyze batch request parameters. Is one of the following types: AnalyzeBatchDocumentsRequest, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name	Description
pages	str 1-based page numbers to analyze. Ex. "1-3,5,7-9". Default value is None. Default value: None
locale	str Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). Default value is None. Default value: None
string_index_type	str or StringIndexType Method used to compute string offset and length. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit". Default value is None. Default value: None
features	list[str or DocumentAnalysisFeature] List of optional analysis features. Default value is None. Default value: None
query_fields	list[str] List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". Default value is None. Default value: None
output_content_format	str or DocumentContentFormat Format of the analyze result top-level content. Known values are: "text" and "markdown". Default value is None. Default value: None
output	list[str or AnalyzeOutputOption] Additional outputs to generate during analysis. Default value is None. Default value: None

Returns

Type	Description
LROPoller[AnalyzeBatchResult]	An instance of LROPoller that returns AnalyzeBatchResult. The AnalyzeBatchResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_analyze_document

Analyzes document with document model.

begin_analyze_document(model_id: str, body: AnalyzeDocumentRequest | MutableMapping[str, Any] | IO[bytes], *, pages: str | None = None, locale: str | None = None, string_index_type: str | StringIndexType | None = None, features: List[str | DocumentAnalysisFeature] | None = None, query_fields: List[str] | None = None, output_content_format: str | DocumentContentFormat | None = None, output: List[str | AnalyzeOutputOption] | None = None, **kwargs: Any) -> AnalyzeDocumentLROPoller[AnalyzeResult]

Parameters

Name	Description
model_id Required	str Unique document model name. Required.
body Required	AnalyzeDocumentRequest or <xref:JSON> or IO[bytes] Analyze request parameters. Is one of the following types: AnalyzeDocumentRequest, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name	Description
pages	str 1-based page numbers to analyze. Ex. "1-3,5,7-9". Default value is None. Default value: None
locale	str Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US"). Default value is None. Default value: None
string_index_type	str or StringIndexType Method used to compute string offset and length. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit". Default value is None. Default value: None
features	list[str or DocumentAnalysisFeature] List of optional analysis features. Default value is None. Default value: None
query_fields	list[str] List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". Default value is None. Default value: None
output_content_format	str or DocumentContentFormat Format of the analyze result top-level content. Known values are: "text" and "markdown". Default value is None. Default value: None
output	list[str or AnalyzeOutputOption] Additional outputs to generate during analysis. Default value is None. Default value: None

Returns

Type	Description
AnalyzeDocumentLROPoller[AnalyzeResult]	An instance of AnalyzeDocumentLROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_classify_document

Classifies document with document classifier.

begin_classify_document(classifier_id: str, body: ClassifyDocumentRequest | MutableMapping[str, Any] | IO[bytes], *, string_index_type: str | StringIndexType | None = None, split: str | SplitMode | None = None, pages: str | None = None, **kwargs: Any) -> LROPoller[AnalyzeResult]

Parameters

Name	Description
classifier_id Required	str Unique document classifier name. Required.
body Required	ClassifyDocumentRequest or <xref:JSON> or IO[bytes] Classify request parameters. Is one of the following types: ClassifyDocumentRequest, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name	Description
string_index_type	str or StringIndexType Method used to compute string offset and length. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit". Default value is None. Default value: None
split	str or SplitMode Document splitting mode. Known values are: "auto", "none", and "perPage". Default value is None. Default value: None
pages	str 1-based page numbers to analyze. Ex. "1-3,5,7-9". Default value is None. Default value: None

Returns

Type	Description
LROPoller[AnalyzeResult]	An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

close

close() -> None

delete_analyze_batch_result

Mark the batch document analysis result for deletion.

delete_analyze_batch_result(model_id: str, result_id: str, **kwargs: Any) -> None

Parameters

Name	Description
model_id Required	str Unique document model name. Required.
result_id Required	str Analyze batch operation result ID. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

delete_analyze_result

Mark the result of document analysis for deletion.

delete_analyze_result(model_id: str, result_id: str, **kwargs: Any) -> None

Parameters

Name	Description
model_id Required	str Unique document model name. Required.
result_id Required	str Analyze operation result ID. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get_analyze_batch_result

Gets the result of batch document analysis.

get_analyze_batch_result(continuation_token: str) -> LROPoller[AnalyzeBatchResult]

Parameters

Name	Description
continuation_token Required	str An opaque continuation token. Required.

Returns

Type	Description
LROPoller[AnalyzeBatchResult]	An instance of LROPoller that returns AnalyzeBatchResult. The AnalyzeBatchResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_analyze_result_figure

Gets the generated cropped image of specified figure from document analysis.

get_analyze_result_figure(model_id: str, result_id: str, figure_id: str, **kwargs: Any) -> Iterator[bytes]

Parameters

Name	Description
model_id Required	str Unique document model name. Required.
result_id Required	str Analyze operation result ID. Required.
figure_id Required	str Figure ID. Required.

Returns

Type	Description
Iterator[bytes]	Iterator[bytes]

Exceptions

Type	Description
HttpResponseError

get_analyze_result_pdf

Gets the generated searchable PDF output from document analysis.

get_analyze_result_pdf(model_id: str, result_id: str, **kwargs: Any) -> Iterator[bytes]

Parameters

Name	Description
model_id Required	str Unique document model name. Required.
result_id Required	str Analyze operation result ID. Required.

Returns

Type	Description
Iterator[bytes]	Iterator[bytes]

Exceptions

Type	Description
HttpResponseError

list_analyze_batch_results

List batch document analysis results.

list_analyze_batch_results(model_id: str, **kwargs: Any) -> Iterable[AnalyzeBatchOperation]

Parameters

Name	Description
model_id Required	str Unique document model name. Required.

Returns

Type	Description
ItemPaged[AnalyzeBatchOperation]	An iterator like instance of AnalyzeBatchOperation

Exceptions

Type	Description
HttpResponseError

send_request

Runs the network request through the client's chained policies.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse

Parameters

Name	Description
request Required	HttpRequest The network request you want to make. Required.

Keyword-Only Parameters

Name	Description
stream	bool Whether the response payload will be streamed. Defaults to False. Default value: False

Returns

Type	Description
HttpResponse	The response of your network call. Does not do error handling on your response.

Share via

DocumentIntelligenceClient Class

Constructor

Parameters

Keyword-Only Parameters

Methods

begin_analyze_batch_documents

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_analyze_document

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_classify_document

Parameters

Keyword-Only Parameters

Returns

Exceptions

close

delete_analyze_batch_result

Parameters

Returns

Exceptions

delete_analyze_result

Parameters

Returns

Exceptions

get_analyze_batch_result

Parameters

Returns

Exceptions

get_analyze_result_figure

Parameters

Returns

Exceptions

get_analyze_result_pdf

Parameters

Returns

Exceptions

list_analyze_batch_results

Parameters

Returns

Exceptions

send_request

Parameters

Keyword-Only Parameters

Returns