Delen via

DocumentIntelligenceAdministrationClient Class

DocumentIntelligenceAdministrationClient.

Constructor

DocumentIntelligenceAdministrationClient(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-07-31-preview". 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

authorize_classifier_copy

Generates authorization to copy a document classifier to this location with specified classifierId and optional description.
authorize_model_copy

Generates authorization to copy a document model to this location with specified modelId and optional description.
begin_build_classifier
begin_build_document_model
begin_compose_model
begin_copy_classifier_to

Copies document classifier to the target resource, region, and classifierId.
begin_copy_model_to
close
delete_classifier

Deletes document classifier.
delete_model

Deletes document model.
get_classifier

Gets detailed document classifier information.
get_model

Gets detailed document model information.
get_operation

Gets operation info.
get_resource_info

Return information about the current resource.
list_classifiers

List all document classifiers.
list_models

List all document models.
list_operations

Lists all operations.
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

authorize_classifier_copy

Generates authorization to copy a document classifier to this location with specified classifierId and optional description.

authorize_classifier_copy(authorize_copy_request: AuthorizeClassifierCopyRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> ClassifierCopyAuthorization

Parameters

Name Description
authorize_copy_request
Required
AuthorizeClassifierCopyRequest or <xref:JSON> or IO[bytes]

Authorize copy request parameters. Is one of the following types: AuthorizeClassifierCopyRequest, JSON, IO[bytes] Required.

Returns

Type Description
ClassifierCopyAuthorization

ClassifierCopyAuthorization. The ClassifierCopyAuthorization is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

authorize_model_copy

Generates authorization to copy a document model to this location with specified modelId and optional description.

authorize_model_copy(authorize_copy_request: AuthorizeCopyRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> CopyAuthorization

Parameters

Name Description
authorize_copy_request
Required
AuthorizeCopyRequest or <xref:JSON> or IO[bytes]

Authorize copy request parameters. Is one of the following types: AuthorizeCopyRequest, JSON, IO[bytes] Required.

Returns

Type Description
CopyAuthorization

CopyAuthorization. The CopyAuthorization is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

begin_build_classifier 

begin_build_classifier(build_request: BuildDocumentClassifierRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> LROPoller[DocumentClassifierDetails]

Parameters

Name Description
build_request
Required

begin_build_document_model 

begin_build_document_model(build_request: BuildDocumentModelRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> LROPoller[DocumentModelDetails]

Parameters

Name Description
build_request
Required

begin_compose_model 

begin_compose_model(compose_request: ComposeDocumentModelRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> LROPoller[DocumentModelDetails]

Parameters

Name Description
compose_request
Required

begin_copy_classifier_to

Copies document classifier to the target resource, region, and classifierId.

begin_copy_classifier_to(classifier_id: str, copy_to_request: ClassifierCopyAuthorization | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> LROPoller[DocumentClassifierDetails]

Parameters

Name Description
classifier_id
Required
str

Unique document classifier name. Required.
copy_to_request
Required
ClassifierCopyAuthorization or <xref:JSON> or IO[bytes]

Copy to request parameters. Is one of the following types: ClassifierCopyAuthorization, JSON, IO[bytes] Required.

Returns

Type Description
LROPoller[DocumentClassifierDetails]

An instance of LROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

begin_copy_model_to 

begin_copy_model_to(model_id: str, copy_to_request: CopyAuthorization | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) -> LROPoller[DocumentModelDetails]

Parameters

Name Description
model_id
Required
copy_to_request
Required

close 

close() -> None

delete_classifier

Deletes document classifier.

delete_classifier(classifier_id: str, **kwargs: Any) -> None

Parameters

Name Description
classifier_id
Required
str

Unique document classifier name. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

delete_model

Deletes document model.

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

Parameters

Name Description
model_id
Required
str

Unique document model name. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get_classifier

Gets detailed document classifier information.

get_classifier(classifier_id: str, **kwargs: Any) -> DocumentClassifierDetails

Parameters

Name Description
classifier_id
Required
str

Unique document classifier name. Required.

Returns

Type Description
DocumentClassifierDetails

DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get_model

Gets detailed document model information.

get_model(model_id: str, **kwargs: Any) -> DocumentModelDetails

Parameters

Name Description
model_id
Required
str

Unique document model name. Required.

Returns

Type Description
DocumentModelDetails

DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get_operation

Gets operation info.

get_operation(operation_id: str, **kwargs: Any) -> OperationDetails

Parameters

Name Description
operation_id
Required
str

Operation ID. Required.

Returns

Type Description
OperationDetails

OperationDetails. The OperationDetails is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get_resource_info

Return information about the current resource.

get_resource_info(**kwargs: Any) -> ResourceDetails

Returns

Type Description
ResourceDetails

ResourceDetails. The ResourceDetails is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list_classifiers

List all document classifiers.

list_classifiers(**kwargs: Any) -> Iterable[DocumentClassifierDetails]

Returns

Type Description
ItemPaged[DocumentClassifierDetails]

An iterator like instance of DocumentClassifierDetails

Exceptions

Type Description
HttpResponseError

list_models

List all document models.

list_models(**kwargs: Any) -> Iterable[DocumentModelDetails]

Returns

Type Description
ItemPaged[DocumentModelDetails]

An iterator like instance of DocumentModelDetails

Exceptions

Type Description
HttpResponseError

list_operations

Lists all operations.

list_operations(**kwargs: Any) -> Iterable[OperationDetails]

Returns

Type Description
ItemPaged[OperationDetails]

An iterator like instance of OperationDetails

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.