azure.ai.documentintelligence package¶
- class azure.ai.documentintelligence.DocumentIntelligenceAdministrationClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)[source]¶
DocumentIntelligenceAdministrationClient.
- Parameters:
endpoint (str) – The Document Intelligence service endpoint. Required.
credential (AzureKeyCredential or TokenCredential) – Credential needed for the client to connect to Azure. Is either a AzureKeyCredential type or a TokenCredential type. Required.
- Keyword Arguments:
- authorize_model_copy(authorize_copy_request: AuthorizeCopyRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) CopyAuthorization ¶
Generates authorization to copy a document model to this location with specified modelId and optional description.
- Parameters:
authorize_copy_request (AuthorizeCopyRequest or JSON or IO[bytes]) – Authorize copy request parameters. Is one of the following types: AuthorizeCopyRequest, JSON, IO[bytes] Required.
- Returns:
CopyAuthorization. The CopyAuthorization is compatible with MutableMapping
- Return type:
- Raises:
Example
# JSON input template you can fill out and use as your body input. authorize_copy_request = { "modelId": "str", # Unique document model name. Required. "description": "str", # Optional. Document model description. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # response body for status code(s): 200 response == { "accessToken": "str", # Token used to authorize the request. Required. "expirationDateTime": "2020-02-20 00:00:00", # Date/time when the access token expires. Required. "targetModelId": "str", # Identifier of the target document model. Required. "targetModelLocation": "str", # URL of the copied document model in the target account. Required. "targetResourceId": "str", # ID of the target Azure resource where the document model should be copied to. Required. "targetResourceRegion": "str" # Location of the target Azure resource where the document model should be copied to. Required. }
- begin_build_classifier(build_request: BuildDocumentClassifierRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) LROPoller[DocumentClassifierDetails] ¶
Builds a custom document classifier.
- Parameters:
build_request (BuildDocumentClassifierRequest or JSON or IO[bytes]) – Build request parameters. Is one of the following types: BuildDocumentClassifierRequest, JSON, IO[bytes] Required.
- Returns:
An instance of LROPoller that returns DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# JSON input template you can fill out and use as your body input. build_request = { "classifierId": "str", # Unique document classifier name. Required. "docTypes": { "str": { "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "sourceKind": "str" # Optional. Type of training data source. Known values are: "url", "base64", "azureBlob", and "azureBlobFileList". } }, "baseClassifierId": "str", # Optional. Base classifierId on top of which to train the classifier. "description": "str" # Optional. Document classifier description. } # response body for status code(s): 202 response == { "apiVersion": "str", # API version used to create this document classifier. Required. "classifierId": "str", # Unique document classifier name. Required. "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document classifier was created. Required. "docTypes": { "str": { "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "sourceKind": "str" # Optional. Type of training data source. Known values are: "url", "base64", "azureBlob", and "azureBlobFileList". } }, "baseClassifierId": "str", # Optional. Base classifierId on top of which the classifier was trained. "description": "str", # Optional. Document classifier description. "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document classifier will expire. "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- begin_build_document_model(build_request: BuildDocumentModelRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) LROPoller[DocumentModelDetails] ¶
Builds a custom document analysis model.
- Parameters:
build_request (BuildDocumentModelRequest or JSON or IO[bytes]) – Build request parameters. Is one of the following types: BuildDocumentModelRequest, JSON, IO[bytes] Required.
- Returns:
An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# JSON input template you can fill out and use as your body input. build_request = { "buildMode": "str", # Custom document model build mode. Required. Known values are: "template" and "neural". "modelId": "str", # Unique document model name. Required. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "description": "str", # Optional. Document model description. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # response body for status code(s): 202 response == { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- begin_compose_model(compose_request: ComposeDocumentModelRequest | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) LROPoller[DocumentModelDetails] ¶
Creates a new document model from document types of existing document models.
- Parameters:
compose_request (ComposeDocumentModelRequest or JSON or IO[bytes]) – Compose request parameters. Is one of the following types: ComposeDocumentModelRequest, JSON, IO[bytes] Required.
- Returns:
An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# JSON input template you can fill out and use as your body input. compose_request = { "componentModels": [ { "modelId": "str" # Unique document model name. Required. } ], "modelId": "str", # Unique document model name. Required. "description": "str", # Optional. Document model description. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # response body for status code(s): 202 response == { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- begin_copy_model_to(model_id: str, copy_to_request: CopyAuthorization | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) LROPoller[DocumentModelDetails] ¶
Copies document model to the target resource, region, and modelId.
- Parameters:
model_id (str) – Unique document model name. Required.
copy_to_request (CopyAuthorization or JSON or IO[bytes]) – Copy to request parameters. Is one of the following types: CopyAuthorization, JSON, IO[bytes] Required.
- Returns:
An instance of LROPoller that returns DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# JSON input template you can fill out and use as your body input. copy_to_request = { "accessToken": "str", # Token used to authorize the request. Required. "expirationDateTime": "2020-02-20 00:00:00", # Date/time when the access token expires. Required. "targetModelId": "str", # Identifier of the target document model. Required. "targetModelLocation": "str", # URL of the copied document model in the target account. Required. "targetResourceId": "str", # ID of the target Azure resource where the document model should be copied to. Required. "targetResourceRegion": "str" # Location of the target Azure resource where the document model should be copied to. Required. } # response body for status code(s): 202 response == { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- delete_classifier(classifier_id: str, **kwargs: Any) None ¶
Deletes document classifier.
- Parameters:
classifier_id (str) – Unique document classifier name. Required.
- Returns:
None
- Return type:
None
- Raises:
- delete_model(model_id: str, **kwargs: Any) None ¶
Deletes document model.
- Parameters:
model_id (str) – Unique document model name. Required.
- Returns:
None
- Return type:
None
- Raises:
- get_classifier(classifier_id: str, **kwargs: Any) DocumentClassifierDetails ¶
Gets detailed document classifier information.
- Parameters:
classifier_id (str) – Unique document classifier name. Required.
- Returns:
DocumentClassifierDetails. The DocumentClassifierDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# response body for status code(s): 200 response == { "apiVersion": "str", # API version used to create this document classifier. Required. "classifierId": "str", # Unique document classifier name. Required. "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document classifier was created. Required. "docTypes": { "str": { "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "sourceKind": "str" # Optional. Type of training data source. Known values are: "url", "base64", "azureBlob", and "azureBlobFileList". } }, "baseClassifierId": "str", # Optional. Base classifierId on top of which the classifier was trained. "description": "str", # Optional. Document classifier description. "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document classifier will expire. "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- get_model(model_id: str, **kwargs: Any) DocumentModelDetails ¶
Gets detailed document model information.
- Parameters:
model_id (str) – Unique document model name. Required.
- Returns:
DocumentModelDetails. The DocumentModelDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# response body for status code(s): 200 response == { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- get_operation(operation_id: str, **kwargs: Any) OperationDetails ¶
Gets operation info.
- Parameters:
operation_id (str) – Operation ID. Required.
- Returns:
OperationDetails. The OperationDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# The response is polymorphic. The following are possible polymorphic responses based off discriminator "kind": # JSON input template for discriminator value "documentClassifierBuild": operation_details = { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the operation was created. Required. "kind": "documentClassifierBuild", "lastUpdatedDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the status was last updated. Required. "operationId": "str", # Operation ID. Required. "resourceLocation": "str", # URL of the resource targeted by this operation. Required. "status": "str", # Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "completed", and "canceled". "apiVersion": "str", # Optional. API version used to create this operation. "error": { "code": "str", # One of a server-defined set of error codes. Required. "message": "str", # A human-readable representation of the error. Required. "details": [ ... ], "innererror": { "code": "str", # Optional. One of a server-defined set of error codes. "innererror": ..., "message": "str" # Optional. A human-readable representation of the error. }, "target": "str" # Optional. The target of the error. }, "percentCompleted": 0, # Optional. Operation progress (0-100). "result": { "apiVersion": "str", # API version used to create this document classifier. Required. "classifierId": "str", # Unique document classifier name. Required. "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document classifier was created. Required. "docTypes": { "str": { "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "sourceKind": "str" # Optional. Type of training data source. Known values are: "url", "base64", "azureBlob", and "azureBlobFileList". } }, "baseClassifierId": "str", # Optional. Base classifierId on top of which the classifier was trained. "description": "str", # Optional. Document classifier description. "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document classifier will expire. "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }, "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # JSON input template for discriminator value "documentModelCompose": operation_details = { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the operation was created. Required. "kind": "documentModelCompose", "lastUpdatedDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the status was last updated. Required. "operationId": "str", # Operation ID. Required. "resourceLocation": "str", # URL of the resource targeted by this operation. Required. "status": "str", # Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "completed", and "canceled". "apiVersion": "str", # Optional. API version used to create this operation. "error": { "code": "str", # One of a server-defined set of error codes. Required. "message": "str", # A human-readable representation of the error. Required. "details": [ ... ], "innererror": { "code": "str", # Optional. One of a server-defined set of error codes. "innererror": ..., "message": "str" # Optional. A human-readable representation of the error. }, "target": "str" # Optional. The target of the error. }, "percentCompleted": 0, # Optional. Operation progress (0-100). "result": { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }, "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # JSON input template for discriminator value "documentModelCopyTo": operation_details = { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the operation was created. Required. "kind": "documentModelCopyTo", "lastUpdatedDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the status was last updated. Required. "operationId": "str", # Operation ID. Required. "resourceLocation": "str", # URL of the resource targeted by this operation. Required. "status": "str", # Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "completed", and "canceled". "apiVersion": "str", # Optional. API version used to create this operation. "error": { "code": "str", # One of a server-defined set of error codes. Required. "message": "str", # A human-readable representation of the error. Required. "details": [ ... ], "innererror": { "code": "str", # Optional. One of a server-defined set of error codes. "innererror": ..., "message": "str" # Optional. A human-readable representation of the error. }, "target": "str" # Optional. The target of the error. }, "percentCompleted": 0, # Optional. Operation progress (0-100). "result": { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }, "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # response body for status code(s): 200 response == operation_details
- get_resource_info(**kwargs: Any) ResourceDetails ¶
Return information about the current resource.
- Returns:
ResourceDetails. The ResourceDetails is compatible with MutableMapping
- Return type:
- Raises:
Example
# response body for status code(s): 200 response == { "customDocumentModels": { "count": 0, # Number of custom document models in the current resource. Required. "limit": 0 # Maximum number of custom document models supported in the current resource. Required. }, "customNeuralDocumentModelBuilds": { "quota": 0, # Resource quota limit. Required. "quotaResetDateTime": "2020-02-20 00:00:00", # Date/time when the resource quota usage will be reset. Required. "used": 0 # Amount of the resource quota used. Required. } }
- list_classifiers(**kwargs: Any) Iterable[DocumentClassifierDetails] ¶
List all document classifiers.
- Returns:
An iterator like instance of DocumentClassifierDetails
- Return type:
- Raises:
Example
# response body for status code(s): 200 response == { "apiVersion": "str", # API version used to create this document classifier. Required. "classifierId": "str", # Unique document classifier name. Required. "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document classifier was created. Required. "docTypes": { "str": { "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "sourceKind": "str" # Optional. Type of training data source. Known values are: "url", "base64", "azureBlob", and "azureBlobFileList". } }, "baseClassifierId": "str", # Optional. Base classifierId on top of which the classifier was trained. "description": "str", # Optional. Document classifier description. "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document classifier will expire. "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- list_models(**kwargs: Any) Iterable[DocumentModelDetails] ¶
List all document models.
- Returns:
An iterator like instance of DocumentModelDetails
- Return type:
- Raises:
Example
# response body for status code(s): 200 response == { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }
- list_operations(**kwargs: Any) Iterable[OperationDetails] ¶
Lists all operations.
- Returns:
An iterator like instance of OperationDetails
- Return type:
- Raises:
Example
# The response is polymorphic. The following are possible polymorphic responses based off discriminator "kind": # JSON input template for discriminator value "documentClassifierBuild": operation_details = { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the operation was created. Required. "kind": "documentClassifierBuild", "lastUpdatedDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the status was last updated. Required. "operationId": "str", # Operation ID. Required. "resourceLocation": "str", # URL of the resource targeted by this operation. Required. "status": "str", # Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "completed", and "canceled". "apiVersion": "str", # Optional. API version used to create this operation. "error": { "code": "str", # One of a server-defined set of error codes. Required. "message": "str", # A human-readable representation of the error. Required. "details": [ ... ], "innererror": { "code": "str", # Optional. One of a server-defined set of error codes. "innererror": ..., "message": "str" # Optional. A human-readable representation of the error. }, "target": "str" # Optional. The target of the error. }, "percentCompleted": 0, # Optional. Operation progress (0-100). "result": { "apiVersion": "str", # API version used to create this document classifier. Required. "classifierId": "str", # Unique document classifier name. Required. "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document classifier was created. Required. "docTypes": { "str": { "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "sourceKind": "str" # Optional. Type of training data source. Known values are: "url", "base64", "azureBlob", and "azureBlobFileList". } }, "baseClassifierId": "str", # Optional. Base classifierId on top of which the classifier was trained. "description": "str", # Optional. Document classifier description. "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document classifier will expire. "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }, "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # JSON input template for discriminator value "documentModelCompose": operation_details = { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the operation was created. Required. "kind": "documentModelCompose", "lastUpdatedDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the status was last updated. Required. "operationId": "str", # Operation ID. Required. "resourceLocation": "str", # URL of the resource targeted by this operation. Required. "status": "str", # Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "completed", and "canceled". "apiVersion": "str", # Optional. API version used to create this operation. "error": { "code": "str", # One of a server-defined set of error codes. Required. "message": "str", # A human-readable representation of the error. Required. "details": [ ... ], "innererror": { "code": "str", # Optional. One of a server-defined set of error codes. "innererror": ..., "message": "str" # Optional. A human-readable representation of the error. }, "target": "str" # Optional. The target of the error. }, "percentCompleted": 0, # Optional. Operation progress (0-100). "result": { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }, "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # JSON input template for discriminator value "documentModelCopyTo": operation_details = { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the operation was created. Required. "kind": "documentModelCopyTo", "lastUpdatedDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the status was last updated. Required. "operationId": "str", # Operation ID. Required. "resourceLocation": "str", # URL of the resource targeted by this operation. Required. "status": "str", # Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "completed", and "canceled". "apiVersion": "str", # Optional. API version used to create this operation. "error": { "code": "str", # One of a server-defined set of error codes. Required. "message": "str", # A human-readable representation of the error. Required. "details": [ ... ], "innererror": { "code": "str", # Optional. One of a server-defined set of error codes. "innererror": ..., "message": "str" # Optional. A human-readable representation of the error. }, "target": "str" # Optional. The target of the error. }, "percentCompleted": 0, # Optional. Operation progress (0-100). "result": { "createdDateTime": "2020-02-20 00:00:00", # Date and time (UTC) when the document model was created. Required. "modelId": "str", # Unique document model name. Required. "apiVersion": "str", # Optional. API version used to create this document model. "azureBlobFileListSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "fileList": "str" # Path to a JSONL file within the container specifying a subset of documents. Required. }, "azureBlobSource": { "containerUrl": "str", # Azure Blob Storage container URL. Required. "prefix": "str" # Optional. Blob name prefix. }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "docTypes": { "str": { "fieldSchema": { "str": { "type": "str", # Semantic data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "description": "str", # Optional. Field description. "example": "str", # Optional. Example field content. "items": ..., "properties": { "str": ... } } }, "buildMode": "str", # Optional. Custom document model build mode. Known values are: "template" and "neural". "description": "str", # Optional. Document model description. "fieldConfidence": { "str": 0.0 # Optional. Estimated confidence for each field. } } }, "expirationDateTime": "2020-02-20 00:00:00", # Optional. Date and time (UTC) when the document model will expire. "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. }, "warnings": [ { "code": "str", # One of a server-defined set of warning codes. Required. "message": "str", # A human-readable representation of the warning. Required. "target": "str" # Optional. The target of the error. } ] }, "tags": { "str": "str" # Optional. List of key-value tag attributes associated with the document model. } } # response body for status code(s): 200 response == operation_details
- send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) HttpResponse [source]¶
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
- Parameters:
request (HttpRequest) – The network request you want to make. Required.
- Keyword Arguments:
stream (bool) – Whether the response payload will be streamed. Defaults to False.
- Returns:
The response of your network call. Does not do error handling on your response.
- Return type:
- class azure.ai.documentintelligence.DocumentIntelligenceClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)[source]¶
DocumentIntelligenceClient.
- Parameters:
endpoint (str) – The Document Intelligence service endpoint. Required.
credential (AzureKeyCredential or TokenCredential) – Credential needed for the client to connect to Azure. Is either a AzureKeyCredential type or a TokenCredential type. Required.
- Keyword Arguments:
- begin_analyze_document(model_id: str, analyze_request: AnalyzeDocumentRequest | MutableMapping[str, Any] | IO[bytes] | None = None, *, 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 | ContentFormat | None = None, **kwargs: Any) LROPoller[AnalyzeResult] ¶
Analyzes document with document model.
- Parameters:
model_id (str) – Unique document model name. Required.
analyze_request (AnalyzeDocumentRequest or JSON or IO[bytes]) – Analyze request parameters. Is one of the following types: AnalyzeDocumentRequest, JSON, IO[bytes] Default value is None.
- Keyword Arguments:
pages (str) – List of 1-based page numbers to analyze. Ex. “1-3,5,7-9”. Default value is 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.
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.
features (list[str or DocumentAnalysisFeature]) – List of optional analysis features. Default value is None.
query_fields (list[str]) – List of additional fields to extract. Ex. “NumberOfGuests,StoreNumber”. Default value is None.
output_content_format (str or ContentFormat) – Format of the analyze result top-level content. Known values are: “text” and “markdown”. Default value is None.
- Returns:
An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping
- Return type:
- Raises:
Example
# JSON input template you can fill out and use as your body input. analyze_request = { "base64Source": bytes("bytes", encoding="utf-8"), # Optional. Base64 encoding of the document to analyze. Either urlSource or base64Source must be specified. "urlSource": "str" # Optional. Document URL to analyze. Either urlSource or base64Source must be specified. } # response body for status code(s): 202 response == { "apiVersion": "str", # API version used to produce this result. Required. "content": "str", # Concatenate string representation of all textual and visual elements in reading order. Required. "modelId": "str", # Document model ID used to produce this result. Required. "pages": [ { "pageNumber": 0, # 1-based page number in the input document. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "angle": 0.0, # Optional. The general orientation of the content in clockwise direction, measured in degrees between (-180, 180]. "barcodes": [ { "confidence": 0.0, # Confidence of correctly extracting the barcode. Required. "kind": "str", # Barcode kind. Required. Known values are: "QRCode", "PDF417", "UPCA", "UPCE", "Code39", "Code128", "EAN8", "EAN13", "DataBar", "Code93", "Codabar", "DataBarExpanded", "ITF", "MicroQRCode", "Aztec", "DataMatrix", and "MaxiCode". "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "value": "str", # Barcode value. Required. "polygon": [ 0.0 # Optional. Bounding polygon of the barcode, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "formulas": [ { "confidence": 0.0, # Confidence of correctly extracting the formula. Required. "kind": "str", # Formula kind. Required. Known values are: "inline" and "display". "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "value": "str", # LaTex expression describing the formula. Required. "polygon": [ 0.0 # Optional. Bounding polygon of the formula, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "height": 0.0, # Optional. The height of the image/PDF in pixels/inches, respectively. "lines": [ { "content": "str", # Concatenated content of the contained elements in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "polygon": [ 0.0 # Optional. Bounding polygon of the line, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "selectionMarks": [ { "confidence": 0.0, # Confidence of correctly extracting the selection mark. Required. "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "state": "str", # State of the selection mark. Required. Known values are: "selected" and "unselected". "polygon": [ 0.0 # Optional. Bounding polygon of the selection mark, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "unit": "str", # Optional. The unit used by the width, height, and polygon properties. For images, the unit is "pixel". For PDF, the unit is "inch". Known values are: "pixel" and "inch". "width": 0.0, # Optional. The width of the image/PDF in pixels/inches, respectively. "words": [ { "confidence": 0.0, # Confidence of correctly extracting the word. Required. "content": "str", # Text content of the word. Required. "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "polygon": [ 0.0 # Optional. Bounding polygon of the word, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ] } ], "stringIndexType": "str", # Method used to compute string offset and length. Required. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit". "contentFormat": "str", # Optional. Format of the analyze result top-level content. Known values are: "text" and "markdown". "documents": [ { "confidence": 0.0, # Confidence of correctly extracting the document. Required. "docType": "str", # Document type. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "fields": { "str": { "type": "str", # Data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "confidence": 0.0, # Optional. Confidence of correctly extracting the field. "content": "str", # Optional. Field content. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "valueAddress": { "city": "str", # Optional. Name of city, town, village, etc. "cityDistrict": "str", # Optional. Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London. "countryRegion": "str", # Optional. Country/region. "house": "str", # Optional. Build name, such as World Trade Center. "houseNumber": "str", # Optional. House or building number. "level": "str", # Optional. Floor number, such as 3F. "poBox": "str", # Optional. Post office box number. "postalCode": "str", # Optional. Postal code used for mail sorting. "road": "str", # Optional. Street name. "state": "str", # Optional. First-level administrative division. "stateDistrict": "str", # Optional. Second-level administrative division used in certain locales. "streetAddress": "str", # Optional. Street-level address, excluding city, state, countryRegion, and postalCode. "suburb": "str", # Optional. Unofficial neighborhood name, like Chinatown. "unit": "str" # Optional. Apartment or office number. }, "valueArray": [ ... ], "valueBoolean": bool, # Optional. Boolean value. "valueCountryRegion": "str", # Optional. 3-letter country code value (ISO 3166-1 alpha-3). "valueCurrency": { "amount": 0.0, # Currency amount. Required. "currencyCode": "str", # Optional. Resolved currency code (ISO 4217), if any. "currencySymbol": "str" # Optional. Currency symbol label, if any. }, "valueDate": "2020-02-20", # Optional. Date value in YYYY-MM-DD format (ISO 8601). "valueInteger": 0, # Optional. Integer value. "valueNumber": 0.0, # Optional. Floating point value. "valueObject": { "str": ... }, "valuePhoneNumber": "str", # Optional. Phone number value in E.164 format (ex. +19876543210). "valueSelectionGroup": [ "str" # Optional. Selection group value. ], "valueSelectionMark": "str", # Optional. Selection mark value. Known values are: "selected" and "unselected". "valueSignature": "str", # Optional. Presence of signature. Known values are: "signed" and "unsigned". "valueString": "str", # Optional. String value. "valueTime": "12:30:00" # Optional. Time value in hh:mm:ss format (ISO 8601). } } } ], "figures": [ { "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "caption": { "content": "str", # Content of the caption. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the caption. ] }, "elements": [ "str" # Optional. Child elements of the figure, excluding any caption or footnotes. ], "footnotes": [ { "content": "str", # Content of the footnote. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the footnote. ] } ] } ], "keyValuePairs": [ { "confidence": 0.0, # Confidence of correctly extracting the key-value pair. Required. "key": { "content": "str", # Concatenated content of the key-value element in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ] }, "value": { "content": "str", # Concatenated content of the key-value element in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ] } } ], "languages": [ { "confidence": 0.0, # Confidence of correctly identifying the language. Required. "locale": "str", # Detected language. Value may an ISO 639-1 language code (ex. "en", "fr") or BCP 47 language tag (ex. "zh-Hans"). Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ] } ], "lists": [ { "items": [ { "content": "str", # Content of the list item. Required. "level": 0, # Level of the list item (1-indexed). Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the list item. ] } ], "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ] } ], "paragraphs": [ { "content": "str", # Concatenated content of the paragraph in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "role": "str" # Optional. Semantic role of the paragraph. Known values are: "pageHeader", "pageFooter", "pageNumber", "title", "sectionHeading", "footnote", and "formulaBlock". } ], "sections": [ { "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "elements": [ "str" # Optional. Child elements of the section. ] } ], "styles": [ { "confidence": 0.0, # Confidence of correctly identifying the style. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "backgroundColor": "str", # Optional. Background color in #rrggbb hexadecimal format.. "color": "str", # Optional. Foreground color in #rrggbb hexadecimal format. "fontStyle": "str", # Optional. Font style. Known values are: "normal" and "italic". "fontWeight": "str", # Optional. Font weight. Known values are: "normal" and "bold". "isHandwritten": bool, # Optional. Is content handwritten?. "similarFontFamily": "str" # Optional. Visually most similar font from among the set of supported font families, with fallback fonts following CSS convention (ex. 'Arial, sans-serif'). } ], "tables": [ { "cells": [ { "columnIndex": 0, # Column index of the cell. Required. "content": "str", # Concatenated content of the table cell in reading order. Required. "rowIndex": 0, # Row index of the cell. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "columnSpan": 0, # Optional. Number of columns spanned by this cell. "elements": [ "str" # Optional. Child elements of the table cell. ], "kind": "str", # Optional. Table cell kind. Known values are: "content", "rowHeader", "columnHeader", "stubHead", and "description". "rowSpan": 0 # Optional. Number of rows spanned by this cell. } ], "columnCount": 0, # Number of columns in the table. Required. "rowCount": 0, # Number of rows in the table. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "caption": { "content": "str", # Content of the caption. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the caption. ] }, "footnotes": [ { "content": "str", # Content of the footnote. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the footnote. ] } ] } ] }
- begin_classify_document(classifier_id: str, classify_request: ClassifyDocumentRequest | MutableMapping[str, Any] | IO[bytes], *, string_index_type: str | StringIndexType | None = None, split: str | SplitMode | None = None, **kwargs: Any) LROPoller[AnalyzeResult] ¶
Classifies document with document classifier.
- Parameters:
classifier_id (str) – Unique document classifier name. Required.
classify_request (ClassifyDocumentRequest or JSON or IO[bytes]) – Classify request parameters. Is one of the following types: ClassifyDocumentRequest, JSON, IO[bytes] Required.
- Keyword Arguments:
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.
split (str or SplitMode) – Document splitting mode. Known values are: “auto”, “none”, and “perPage”. Default value is None.
- Returns:
An instance of LROPoller that returns AnalyzeResult. The AnalyzeResult is compatible with MutableMapping
- Return type:
- Raises:
Example
# JSON input template you can fill out and use as your body input. classify_request = { "base64Source": bytes("bytes", encoding="utf-8"), # Optional. Base64 encoding of the document to classify. Either urlSource or base64Source must be specified. "urlSource": "str" # Optional. Document URL to classify. Either urlSource or base64Source must be specified. } # response body for status code(s): 202 response == { "apiVersion": "str", # API version used to produce this result. Required. "content": "str", # Concatenate string representation of all textual and visual elements in reading order. Required. "modelId": "str", # Document model ID used to produce this result. Required. "pages": [ { "pageNumber": 0, # 1-based page number in the input document. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "angle": 0.0, # Optional. The general orientation of the content in clockwise direction, measured in degrees between (-180, 180]. "barcodes": [ { "confidence": 0.0, # Confidence of correctly extracting the barcode. Required. "kind": "str", # Barcode kind. Required. Known values are: "QRCode", "PDF417", "UPCA", "UPCE", "Code39", "Code128", "EAN8", "EAN13", "DataBar", "Code93", "Codabar", "DataBarExpanded", "ITF", "MicroQRCode", "Aztec", "DataMatrix", and "MaxiCode". "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "value": "str", # Barcode value. Required. "polygon": [ 0.0 # Optional. Bounding polygon of the barcode, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "formulas": [ { "confidence": 0.0, # Confidence of correctly extracting the formula. Required. "kind": "str", # Formula kind. Required. Known values are: "inline" and "display". "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "value": "str", # LaTex expression describing the formula. Required. "polygon": [ 0.0 # Optional. Bounding polygon of the formula, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "height": 0.0, # Optional. The height of the image/PDF in pixels/inches, respectively. "lines": [ { "content": "str", # Concatenated content of the contained elements in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "polygon": [ 0.0 # Optional. Bounding polygon of the line, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "selectionMarks": [ { "confidence": 0.0, # Confidence of correctly extracting the selection mark. Required. "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "state": "str", # State of the selection mark. Required. Known values are: "selected" and "unselected". "polygon": [ 0.0 # Optional. Bounding polygon of the selection mark, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ], "unit": "str", # Optional. The unit used by the width, height, and polygon properties. For images, the unit is "pixel". For PDF, the unit is "inch". Known values are: "pixel" and "inch". "width": 0.0, # Optional. The width of the image/PDF in pixels/inches, respectively. "words": [ { "confidence": 0.0, # Confidence of correctly extracting the word. Required. "content": "str", # Text content of the word. Required. "span": { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. }, "polygon": [ 0.0 # Optional. Bounding polygon of the word, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. ] } ] } ], "stringIndexType": "str", # Method used to compute string offset and length. Required. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit". "contentFormat": "str", # Optional. Format of the analyze result top-level content. Known values are: "text" and "markdown". "documents": [ { "confidence": 0.0, # Confidence of correctly extracting the document. Required. "docType": "str", # Document type. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "fields": { "str": { "type": "str", # Data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup". "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "confidence": 0.0, # Optional. Confidence of correctly extracting the field. "content": "str", # Optional. Field content. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "valueAddress": { "city": "str", # Optional. Name of city, town, village, etc. "cityDistrict": "str", # Optional. Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London. "countryRegion": "str", # Optional. Country/region. "house": "str", # Optional. Build name, such as World Trade Center. "houseNumber": "str", # Optional. House or building number. "level": "str", # Optional. Floor number, such as 3F. "poBox": "str", # Optional. Post office box number. "postalCode": "str", # Optional. Postal code used for mail sorting. "road": "str", # Optional. Street name. "state": "str", # Optional. First-level administrative division. "stateDistrict": "str", # Optional. Second-level administrative division used in certain locales. "streetAddress": "str", # Optional. Street-level address, excluding city, state, countryRegion, and postalCode. "suburb": "str", # Optional. Unofficial neighborhood name, like Chinatown. "unit": "str" # Optional. Apartment or office number. }, "valueArray": [ ... ], "valueBoolean": bool, # Optional. Boolean value. "valueCountryRegion": "str", # Optional. 3-letter country code value (ISO 3166-1 alpha-3). "valueCurrency": { "amount": 0.0, # Currency amount. Required. "currencyCode": "str", # Optional. Resolved currency code (ISO 4217), if any. "currencySymbol": "str" # Optional. Currency symbol label, if any. }, "valueDate": "2020-02-20", # Optional. Date value in YYYY-MM-DD format (ISO 8601). "valueInteger": 0, # Optional. Integer value. "valueNumber": 0.0, # Optional. Floating point value. "valueObject": { "str": ... }, "valuePhoneNumber": "str", # Optional. Phone number value in E.164 format (ex. +19876543210). "valueSelectionGroup": [ "str" # Optional. Selection group value. ], "valueSelectionMark": "str", # Optional. Selection mark value. Known values are: "selected" and "unselected". "valueSignature": "str", # Optional. Presence of signature. Known values are: "signed" and "unsigned". "valueString": "str", # Optional. String value. "valueTime": "12:30:00" # Optional. Time value in hh:mm:ss format (ISO 8601). } } } ], "figures": [ { "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "caption": { "content": "str", # Content of the caption. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the caption. ] }, "elements": [ "str" # Optional. Child elements of the figure, excluding any caption or footnotes. ], "footnotes": [ { "content": "str", # Content of the footnote. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the footnote. ] } ] } ], "keyValuePairs": [ { "confidence": 0.0, # Confidence of correctly extracting the key-value pair. Required. "key": { "content": "str", # Concatenated content of the key-value element in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ] }, "value": { "content": "str", # Concatenated content of the key-value element in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ] } } ], "languages": [ { "confidence": 0.0, # Confidence of correctly identifying the language. Required. "locale": "str", # Detected language. Value may an ISO 639-1 language code (ex. "en", "fr") or BCP 47 language tag (ex. "zh-Hans"). Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ] } ], "lists": [ { "items": [ { "content": "str", # Content of the list item. Required. "level": 0, # Level of the list item (1-indexed). Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the list item. ] } ], "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ] } ], "paragraphs": [ { "content": "str", # Concatenated content of the paragraph in reading order. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "role": "str" # Optional. Semantic role of the paragraph. Known values are: "pageHeader", "pageFooter", "pageNumber", "title", "sectionHeading", "footnote", and "formulaBlock". } ], "sections": [ { "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "elements": [ "str" # Optional. Child elements of the section. ] } ], "styles": [ { "confidence": 0.0, # Confidence of correctly identifying the style. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "backgroundColor": "str", # Optional. Background color in #rrggbb hexadecimal format.. "color": "str", # Optional. Foreground color in #rrggbb hexadecimal format. "fontStyle": "str", # Optional. Font style. Known values are: "normal" and "italic". "fontWeight": "str", # Optional. Font weight. Known values are: "normal" and "bold". "isHandwritten": bool, # Optional. Is content handwritten?. "similarFontFamily": "str" # Optional. Visually most similar font from among the set of supported font families, with fallback fonts following CSS convention (ex. 'Arial, sans-serif'). } ], "tables": [ { "cells": [ { "columnIndex": 0, # Column index of the cell. Required. "content": "str", # Concatenated content of the table cell in reading order. Required. "rowIndex": 0, # Row index of the cell. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "columnSpan": 0, # Optional. Number of columns spanned by this cell. "elements": [ "str" # Optional. Child elements of the table cell. ], "kind": "str", # Optional. Table cell kind. Known values are: "content", "rowHeader", "columnHeader", "stubHead", and "description". "rowSpan": 0 # Optional. Number of rows spanned by this cell. } ], "columnCount": 0, # Number of columns in the table. Required. "rowCount": 0, # Number of rows in the table. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "caption": { "content": "str", # Content of the caption. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the caption. ] }, "footnotes": [ { "content": "str", # Content of the footnote. Required. "spans": [ { "length": 0, # Number of characters in the content represented by the span. Required. "offset": 0 # Zero-based index of the content represented by the span. Required. } ], "boundingRegions": [ { "pageNumber": 0, # 1-based page number of page containing the bounding region. Required. "polygon": [ 0.0 # Bounding polygon on the page, or the entire page if not specified. Coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation. Required. ] } ], "elements": [ "str" # Optional. Child elements of the footnote. ] } ] } ] }
- send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) HttpResponse [source]¶
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
- Parameters:
request (HttpRequest) – The network request you want to make. Required.
- Keyword Arguments:
stream (bool) – Whether the response payload will be streamed. Defaults to False.
- Returns:
The response of your network call. Does not do error handling on your response.
- Return type:
Subpackages¶
- azure.ai.documentintelligence.aio package
DocumentIntelligenceAdministrationClient
DocumentIntelligenceAdministrationClient.authorize_model_copy()
DocumentIntelligenceAdministrationClient.begin_build_classifier()
DocumentIntelligenceAdministrationClient.begin_build_document_model()
DocumentIntelligenceAdministrationClient.begin_compose_model()
DocumentIntelligenceAdministrationClient.begin_copy_model_to()
DocumentIntelligenceAdministrationClient.close()
DocumentIntelligenceAdministrationClient.delete_classifier()
DocumentIntelligenceAdministrationClient.delete_model()
DocumentIntelligenceAdministrationClient.get_classifier()
DocumentIntelligenceAdministrationClient.get_model()
DocumentIntelligenceAdministrationClient.get_operation()
DocumentIntelligenceAdministrationClient.get_resource_info()
DocumentIntelligenceAdministrationClient.list_classifiers()
DocumentIntelligenceAdministrationClient.list_models()
DocumentIntelligenceAdministrationClient.list_operations()
DocumentIntelligenceAdministrationClient.send_request()
DocumentIntelligenceClient
- azure.ai.documentintelligence.models package
AddressValue
AddressValue.as_dict()
AddressValue.clear()
AddressValue.copy()
AddressValue.get()
AddressValue.items()
AddressValue.keys()
AddressValue.pop()
AddressValue.popitem()
AddressValue.setdefault()
AddressValue.update()
AddressValue.values()
AddressValue.city
AddressValue.city_district
AddressValue.country_region
AddressValue.house
AddressValue.house_number
AddressValue.level
AddressValue.po_box
AddressValue.postal_code
AddressValue.road
AddressValue.state
AddressValue.state_district
AddressValue.street_address
AddressValue.suburb
AddressValue.unit
AnalyzeDocumentRequest
AnalyzeDocumentRequest.as_dict()
AnalyzeDocumentRequest.clear()
AnalyzeDocumentRequest.copy()
AnalyzeDocumentRequest.get()
AnalyzeDocumentRequest.items()
AnalyzeDocumentRequest.keys()
AnalyzeDocumentRequest.pop()
AnalyzeDocumentRequest.popitem()
AnalyzeDocumentRequest.setdefault()
AnalyzeDocumentRequest.update()
AnalyzeDocumentRequest.values()
AnalyzeDocumentRequest.bytes_source
AnalyzeDocumentRequest.url_source
AnalyzeResult
AnalyzeResult.as_dict()
AnalyzeResult.clear()
AnalyzeResult.copy()
AnalyzeResult.get()
AnalyzeResult.items()
AnalyzeResult.keys()
AnalyzeResult.pop()
AnalyzeResult.popitem()
AnalyzeResult.setdefault()
AnalyzeResult.update()
AnalyzeResult.values()
AnalyzeResult.api_version
AnalyzeResult.content
AnalyzeResult.content_format
AnalyzeResult.documents
AnalyzeResult.figures
AnalyzeResult.key_value_pairs
AnalyzeResult.languages
AnalyzeResult.lists
AnalyzeResult.model_id
AnalyzeResult.pages
AnalyzeResult.paragraphs
AnalyzeResult.sections
AnalyzeResult.string_index_type
AnalyzeResult.styles
AnalyzeResult.tables
AnalyzeResultOperation
AnalyzeResultOperation.as_dict()
AnalyzeResultOperation.clear()
AnalyzeResultOperation.copy()
AnalyzeResultOperation.get()
AnalyzeResultOperation.items()
AnalyzeResultOperation.keys()
AnalyzeResultOperation.pop()
AnalyzeResultOperation.popitem()
AnalyzeResultOperation.setdefault()
AnalyzeResultOperation.update()
AnalyzeResultOperation.values()
AnalyzeResultOperation.analyze_result
AnalyzeResultOperation.created_date_time
AnalyzeResultOperation.error
AnalyzeResultOperation.last_updated_date_time
AnalyzeResultOperation.status
AuthorizeCopyRequest
AuthorizeCopyRequest.as_dict()
AuthorizeCopyRequest.clear()
AuthorizeCopyRequest.copy()
AuthorizeCopyRequest.get()
AuthorizeCopyRequest.items()
AuthorizeCopyRequest.keys()
AuthorizeCopyRequest.pop()
AuthorizeCopyRequest.popitem()
AuthorizeCopyRequest.setdefault()
AuthorizeCopyRequest.update()
AuthorizeCopyRequest.values()
AuthorizeCopyRequest.description
AuthorizeCopyRequest.model_id
AuthorizeCopyRequest.tags
AzureBlobContentSource
AzureBlobContentSource.as_dict()
AzureBlobContentSource.clear()
AzureBlobContentSource.copy()
AzureBlobContentSource.get()
AzureBlobContentSource.items()
AzureBlobContentSource.keys()
AzureBlobContentSource.pop()
AzureBlobContentSource.popitem()
AzureBlobContentSource.setdefault()
AzureBlobContentSource.update()
AzureBlobContentSource.values()
AzureBlobContentSource.container_url
AzureBlobContentSource.prefix
AzureBlobFileListContentSource
AzureBlobFileListContentSource.as_dict()
AzureBlobFileListContentSource.clear()
AzureBlobFileListContentSource.copy()
AzureBlobFileListContentSource.get()
AzureBlobFileListContentSource.items()
AzureBlobFileListContentSource.keys()
AzureBlobFileListContentSource.pop()
AzureBlobFileListContentSource.popitem()
AzureBlobFileListContentSource.setdefault()
AzureBlobFileListContentSource.update()
AzureBlobFileListContentSource.values()
AzureBlobFileListContentSource.container_url
AzureBlobFileListContentSource.file_list
BoundingRegion
BoundingRegion.as_dict()
BoundingRegion.clear()
BoundingRegion.copy()
BoundingRegion.get()
BoundingRegion.items()
BoundingRegion.keys()
BoundingRegion.pop()
BoundingRegion.popitem()
BoundingRegion.setdefault()
BoundingRegion.update()
BoundingRegion.values()
BoundingRegion.page_number
BoundingRegion.polygon
BuildDocumentClassifierRequest
BuildDocumentClassifierRequest.as_dict()
BuildDocumentClassifierRequest.clear()
BuildDocumentClassifierRequest.copy()
BuildDocumentClassifierRequest.get()
BuildDocumentClassifierRequest.items()
BuildDocumentClassifierRequest.keys()
BuildDocumentClassifierRequest.pop()
BuildDocumentClassifierRequest.popitem()
BuildDocumentClassifierRequest.setdefault()
BuildDocumentClassifierRequest.update()
BuildDocumentClassifierRequest.values()
BuildDocumentClassifierRequest.base_classifier_id
BuildDocumentClassifierRequest.classifier_id
BuildDocumentClassifierRequest.description
BuildDocumentClassifierRequest.doc_types
BuildDocumentModelRequest
BuildDocumentModelRequest.as_dict()
BuildDocumentModelRequest.clear()
BuildDocumentModelRequest.copy()
BuildDocumentModelRequest.get()
BuildDocumentModelRequest.items()
BuildDocumentModelRequest.keys()
BuildDocumentModelRequest.pop()
BuildDocumentModelRequest.popitem()
BuildDocumentModelRequest.setdefault()
BuildDocumentModelRequest.update()
BuildDocumentModelRequest.values()
BuildDocumentModelRequest.azure_blob_file_list_source
BuildDocumentModelRequest.azure_blob_source
BuildDocumentModelRequest.build_mode
BuildDocumentModelRequest.description
BuildDocumentModelRequest.model_id
BuildDocumentModelRequest.tags
ClassifierDocumentTypeDetails
ClassifierDocumentTypeDetails.as_dict()
ClassifierDocumentTypeDetails.clear()
ClassifierDocumentTypeDetails.copy()
ClassifierDocumentTypeDetails.get()
ClassifierDocumentTypeDetails.items()
ClassifierDocumentTypeDetails.keys()
ClassifierDocumentTypeDetails.pop()
ClassifierDocumentTypeDetails.popitem()
ClassifierDocumentTypeDetails.setdefault()
ClassifierDocumentTypeDetails.update()
ClassifierDocumentTypeDetails.values()
ClassifierDocumentTypeDetails.azure_blob_file_list_source
ClassifierDocumentTypeDetails.azure_blob_source
ClassifierDocumentTypeDetails.source_kind
ClassifyDocumentRequest
ClassifyDocumentRequest.as_dict()
ClassifyDocumentRequest.clear()
ClassifyDocumentRequest.copy()
ClassifyDocumentRequest.get()
ClassifyDocumentRequest.items()
ClassifyDocumentRequest.keys()
ClassifyDocumentRequest.pop()
ClassifyDocumentRequest.popitem()
ClassifyDocumentRequest.setdefault()
ClassifyDocumentRequest.update()
ClassifyDocumentRequest.values()
ClassifyDocumentRequest.bytes_source
ClassifyDocumentRequest.url_source
ComponentDocumentModelDetails
ComponentDocumentModelDetails.as_dict()
ComponentDocumentModelDetails.clear()
ComponentDocumentModelDetails.copy()
ComponentDocumentModelDetails.get()
ComponentDocumentModelDetails.items()
ComponentDocumentModelDetails.keys()
ComponentDocumentModelDetails.pop()
ComponentDocumentModelDetails.popitem()
ComponentDocumentModelDetails.setdefault()
ComponentDocumentModelDetails.update()
ComponentDocumentModelDetails.values()
ComponentDocumentModelDetails.model_id
ComposeDocumentModelRequest
ComposeDocumentModelRequest.as_dict()
ComposeDocumentModelRequest.clear()
ComposeDocumentModelRequest.copy()
ComposeDocumentModelRequest.get()
ComposeDocumentModelRequest.items()
ComposeDocumentModelRequest.keys()
ComposeDocumentModelRequest.pop()
ComposeDocumentModelRequest.popitem()
ComposeDocumentModelRequest.setdefault()
ComposeDocumentModelRequest.update()
ComposeDocumentModelRequest.values()
ComposeDocumentModelRequest.component_models
ComposeDocumentModelRequest.description
ComposeDocumentModelRequest.model_id
ComposeDocumentModelRequest.tags
ContentFormat
ContentFormat.capitalize()
ContentFormat.casefold()
ContentFormat.center()
ContentFormat.count()
ContentFormat.encode()
ContentFormat.endswith()
ContentFormat.expandtabs()
ContentFormat.find()
ContentFormat.format()
ContentFormat.format_map()
ContentFormat.index()
ContentFormat.isalnum()
ContentFormat.isalpha()
ContentFormat.isascii()
ContentFormat.isdecimal()
ContentFormat.isdigit()
ContentFormat.isidentifier()
ContentFormat.islower()
ContentFormat.isnumeric()
ContentFormat.isprintable()
ContentFormat.isspace()
ContentFormat.istitle()
ContentFormat.isupper()
ContentFormat.join()
ContentFormat.ljust()
ContentFormat.lower()
ContentFormat.lstrip()
ContentFormat.maketrans()
ContentFormat.partition()
ContentFormat.removeprefix()
ContentFormat.removesuffix()
ContentFormat.replace()
ContentFormat.rfind()
ContentFormat.rindex()
ContentFormat.rjust()
ContentFormat.rpartition()
ContentFormat.rsplit()
ContentFormat.rstrip()
ContentFormat.split()
ContentFormat.splitlines()
ContentFormat.startswith()
ContentFormat.strip()
ContentFormat.swapcase()
ContentFormat.title()
ContentFormat.translate()
ContentFormat.upper()
ContentFormat.zfill()
ContentFormat.MARKDOWN
ContentFormat.TEXT
ContentSourceKind
ContentSourceKind.capitalize()
ContentSourceKind.casefold()
ContentSourceKind.center()
ContentSourceKind.count()
ContentSourceKind.encode()
ContentSourceKind.endswith()
ContentSourceKind.expandtabs()
ContentSourceKind.find()
ContentSourceKind.format()
ContentSourceKind.format_map()
ContentSourceKind.index()
ContentSourceKind.isalnum()
ContentSourceKind.isalpha()
ContentSourceKind.isascii()
ContentSourceKind.isdecimal()
ContentSourceKind.isdigit()
ContentSourceKind.isidentifier()
ContentSourceKind.islower()
ContentSourceKind.isnumeric()
ContentSourceKind.isprintable()
ContentSourceKind.isspace()
ContentSourceKind.istitle()
ContentSourceKind.isupper()
ContentSourceKind.join()
ContentSourceKind.ljust()
ContentSourceKind.lower()
ContentSourceKind.lstrip()
ContentSourceKind.maketrans()
ContentSourceKind.partition()
ContentSourceKind.removeprefix()
ContentSourceKind.removesuffix()
ContentSourceKind.replace()
ContentSourceKind.rfind()
ContentSourceKind.rindex()
ContentSourceKind.rjust()
ContentSourceKind.rpartition()
ContentSourceKind.rsplit()
ContentSourceKind.rstrip()
ContentSourceKind.split()
ContentSourceKind.splitlines()
ContentSourceKind.startswith()
ContentSourceKind.strip()
ContentSourceKind.swapcase()
ContentSourceKind.title()
ContentSourceKind.translate()
ContentSourceKind.upper()
ContentSourceKind.zfill()
ContentSourceKind.AZURE_BLOB
ContentSourceKind.AZURE_BLOB_FILE_LIST
ContentSourceKind.BASE64
ContentSourceKind.URL
CopyAuthorization
CopyAuthorization.as_dict()
CopyAuthorization.clear()
CopyAuthorization.copy()
CopyAuthorization.get()
CopyAuthorization.items()
CopyAuthorization.keys()
CopyAuthorization.pop()
CopyAuthorization.popitem()
CopyAuthorization.setdefault()
CopyAuthorization.update()
CopyAuthorization.values()
CopyAuthorization.access_token
CopyAuthorization.expiration_date_time
CopyAuthorization.target_model_id
CopyAuthorization.target_model_location
CopyAuthorization.target_resource_id
CopyAuthorization.target_resource_region
CurrencyValue
CurrencyValue.as_dict()
CurrencyValue.clear()
CurrencyValue.copy()
CurrencyValue.get()
CurrencyValue.items()
CurrencyValue.keys()
CurrencyValue.pop()
CurrencyValue.popitem()
CurrencyValue.setdefault()
CurrencyValue.update()
CurrencyValue.values()
CurrencyValue.amount
CurrencyValue.currency_code
CurrencyValue.currency_symbol
CustomDocumentModelsDetails
CustomDocumentModelsDetails.as_dict()
CustomDocumentModelsDetails.clear()
CustomDocumentModelsDetails.copy()
CustomDocumentModelsDetails.get()
CustomDocumentModelsDetails.items()
CustomDocumentModelsDetails.keys()
CustomDocumentModelsDetails.pop()
CustomDocumentModelsDetails.popitem()
CustomDocumentModelsDetails.setdefault()
CustomDocumentModelsDetails.update()
CustomDocumentModelsDetails.values()
CustomDocumentModelsDetails.count
CustomDocumentModelsDetails.limit
Document
DocumentAnalysisFeature
DocumentAnalysisFeature.capitalize()
DocumentAnalysisFeature.casefold()
DocumentAnalysisFeature.center()
DocumentAnalysisFeature.count()
DocumentAnalysisFeature.encode()
DocumentAnalysisFeature.endswith()
DocumentAnalysisFeature.expandtabs()
DocumentAnalysisFeature.find()
DocumentAnalysisFeature.format()
DocumentAnalysisFeature.format_map()
DocumentAnalysisFeature.index()
DocumentAnalysisFeature.isalnum()
DocumentAnalysisFeature.isalpha()
DocumentAnalysisFeature.isascii()
DocumentAnalysisFeature.isdecimal()
DocumentAnalysisFeature.isdigit()
DocumentAnalysisFeature.isidentifier()
DocumentAnalysisFeature.islower()
DocumentAnalysisFeature.isnumeric()
DocumentAnalysisFeature.isprintable()
DocumentAnalysisFeature.isspace()
DocumentAnalysisFeature.istitle()
DocumentAnalysisFeature.isupper()
DocumentAnalysisFeature.join()
DocumentAnalysisFeature.ljust()
DocumentAnalysisFeature.lower()
DocumentAnalysisFeature.lstrip()
DocumentAnalysisFeature.maketrans()
DocumentAnalysisFeature.partition()
DocumentAnalysisFeature.removeprefix()
DocumentAnalysisFeature.removesuffix()
DocumentAnalysisFeature.replace()
DocumentAnalysisFeature.rfind()
DocumentAnalysisFeature.rindex()
DocumentAnalysisFeature.rjust()
DocumentAnalysisFeature.rpartition()
DocumentAnalysisFeature.rsplit()
DocumentAnalysisFeature.rstrip()
DocumentAnalysisFeature.split()
DocumentAnalysisFeature.splitlines()
DocumentAnalysisFeature.startswith()
DocumentAnalysisFeature.strip()
DocumentAnalysisFeature.swapcase()
DocumentAnalysisFeature.title()
DocumentAnalysisFeature.translate()
DocumentAnalysisFeature.upper()
DocumentAnalysisFeature.zfill()
DocumentAnalysisFeature.BARCODES
DocumentAnalysisFeature.FORMULAS
DocumentAnalysisFeature.KEY_VALUE_PAIRS
DocumentAnalysisFeature.LANGUAGES
DocumentAnalysisFeature.OCR_HIGH_RESOLUTION
DocumentAnalysisFeature.QUERY_FIELDS
DocumentAnalysisFeature.STYLE_FONT
DocumentBarcode
DocumentBarcode.as_dict()
DocumentBarcode.clear()
DocumentBarcode.copy()
DocumentBarcode.get()
DocumentBarcode.items()
DocumentBarcode.keys()
DocumentBarcode.pop()
DocumentBarcode.popitem()
DocumentBarcode.setdefault()
DocumentBarcode.update()
DocumentBarcode.values()
DocumentBarcode.confidence
DocumentBarcode.kind
DocumentBarcode.polygon
DocumentBarcode.span
DocumentBarcode.value
DocumentBarcodeKind
DocumentBarcodeKind.capitalize()
DocumentBarcodeKind.casefold()
DocumentBarcodeKind.center()
DocumentBarcodeKind.count()
DocumentBarcodeKind.encode()
DocumentBarcodeKind.endswith()
DocumentBarcodeKind.expandtabs()
DocumentBarcodeKind.find()
DocumentBarcodeKind.format()
DocumentBarcodeKind.format_map()
DocumentBarcodeKind.index()
DocumentBarcodeKind.isalnum()
DocumentBarcodeKind.isalpha()
DocumentBarcodeKind.isascii()
DocumentBarcodeKind.isdecimal()
DocumentBarcodeKind.isdigit()
DocumentBarcodeKind.isidentifier()
DocumentBarcodeKind.islower()
DocumentBarcodeKind.isnumeric()
DocumentBarcodeKind.isprintable()
DocumentBarcodeKind.isspace()
DocumentBarcodeKind.istitle()
DocumentBarcodeKind.isupper()
DocumentBarcodeKind.join()
DocumentBarcodeKind.ljust()
DocumentBarcodeKind.lower()
DocumentBarcodeKind.lstrip()
DocumentBarcodeKind.maketrans()
DocumentBarcodeKind.partition()
DocumentBarcodeKind.removeprefix()
DocumentBarcodeKind.removesuffix()
DocumentBarcodeKind.replace()
DocumentBarcodeKind.rfind()
DocumentBarcodeKind.rindex()
DocumentBarcodeKind.rjust()
DocumentBarcodeKind.rpartition()
DocumentBarcodeKind.rsplit()
DocumentBarcodeKind.rstrip()
DocumentBarcodeKind.split()
DocumentBarcodeKind.splitlines()
DocumentBarcodeKind.startswith()
DocumentBarcodeKind.strip()
DocumentBarcodeKind.swapcase()
DocumentBarcodeKind.title()
DocumentBarcodeKind.translate()
DocumentBarcodeKind.upper()
DocumentBarcodeKind.zfill()
DocumentBarcodeKind.AZTEC
DocumentBarcodeKind.CODABAR
DocumentBarcodeKind.CODE128
DocumentBarcodeKind.CODE39
DocumentBarcodeKind.CODE93
DocumentBarcodeKind.DATA_BAR
DocumentBarcodeKind.DATA_BAR_EXPANDED
DocumentBarcodeKind.DATA_MATRIX
DocumentBarcodeKind.EAN13
DocumentBarcodeKind.EAN8
DocumentBarcodeKind.ITF
DocumentBarcodeKind.MAXI_CODE
DocumentBarcodeKind.MICRO_Q_R_CODE
DocumentBarcodeKind.PDF417
DocumentBarcodeKind.Q_R_CODE
DocumentBarcodeKind.UPCA
DocumentBarcodeKind.UPCE
DocumentBuildMode
DocumentBuildMode.capitalize()
DocumentBuildMode.casefold()
DocumentBuildMode.center()
DocumentBuildMode.count()
DocumentBuildMode.encode()
DocumentBuildMode.endswith()
DocumentBuildMode.expandtabs()
DocumentBuildMode.find()
DocumentBuildMode.format()
DocumentBuildMode.format_map()
DocumentBuildMode.index()
DocumentBuildMode.isalnum()
DocumentBuildMode.isalpha()
DocumentBuildMode.isascii()
DocumentBuildMode.isdecimal()
DocumentBuildMode.isdigit()
DocumentBuildMode.isidentifier()
DocumentBuildMode.islower()
DocumentBuildMode.isnumeric()
DocumentBuildMode.isprintable()
DocumentBuildMode.isspace()
DocumentBuildMode.istitle()
DocumentBuildMode.isupper()
DocumentBuildMode.join()
DocumentBuildMode.ljust()
DocumentBuildMode.lower()
DocumentBuildMode.lstrip()
DocumentBuildMode.maketrans()
DocumentBuildMode.partition()
DocumentBuildMode.removeprefix()
DocumentBuildMode.removesuffix()
DocumentBuildMode.replace()
DocumentBuildMode.rfind()
DocumentBuildMode.rindex()
DocumentBuildMode.rjust()
DocumentBuildMode.rpartition()
DocumentBuildMode.rsplit()
DocumentBuildMode.rstrip()
DocumentBuildMode.split()
DocumentBuildMode.splitlines()
DocumentBuildMode.startswith()
DocumentBuildMode.strip()
DocumentBuildMode.swapcase()
DocumentBuildMode.title()
DocumentBuildMode.translate()
DocumentBuildMode.upper()
DocumentBuildMode.zfill()
DocumentBuildMode.NEURAL
DocumentBuildMode.TEMPLATE
DocumentCaption
DocumentCaption.as_dict()
DocumentCaption.clear()
DocumentCaption.copy()
DocumentCaption.get()
DocumentCaption.items()
DocumentCaption.keys()
DocumentCaption.pop()
DocumentCaption.popitem()
DocumentCaption.setdefault()
DocumentCaption.update()
DocumentCaption.values()
DocumentCaption.bounding_regions
DocumentCaption.content
DocumentCaption.elements
DocumentCaption.spans
DocumentClassifierBuildOperationDetails
DocumentClassifierBuildOperationDetails.as_dict()
DocumentClassifierBuildOperationDetails.clear()
DocumentClassifierBuildOperationDetails.copy()
DocumentClassifierBuildOperationDetails.get()
DocumentClassifierBuildOperationDetails.items()
DocumentClassifierBuildOperationDetails.keys()
DocumentClassifierBuildOperationDetails.pop()
DocumentClassifierBuildOperationDetails.popitem()
DocumentClassifierBuildOperationDetails.setdefault()
DocumentClassifierBuildOperationDetails.update()
DocumentClassifierBuildOperationDetails.values()
DocumentClassifierBuildOperationDetails.api_version
DocumentClassifierBuildOperationDetails.created_date_time
DocumentClassifierBuildOperationDetails.error
DocumentClassifierBuildOperationDetails.kind
DocumentClassifierBuildOperationDetails.last_updated_date_time
DocumentClassifierBuildOperationDetails.operation_id
DocumentClassifierBuildOperationDetails.percent_completed
DocumentClassifierBuildOperationDetails.resource_location
DocumentClassifierBuildOperationDetails.result
DocumentClassifierBuildOperationDetails.status
DocumentClassifierBuildOperationDetails.tags
DocumentClassifierDetails
DocumentClassifierDetails.as_dict()
DocumentClassifierDetails.clear()
DocumentClassifierDetails.copy()
DocumentClassifierDetails.get()
DocumentClassifierDetails.items()
DocumentClassifierDetails.keys()
DocumentClassifierDetails.pop()
DocumentClassifierDetails.popitem()
DocumentClassifierDetails.setdefault()
DocumentClassifierDetails.update()
DocumentClassifierDetails.values()
DocumentClassifierDetails.api_version
DocumentClassifierDetails.base_classifier_id
DocumentClassifierDetails.classifier_id
DocumentClassifierDetails.created_date_time
DocumentClassifierDetails.description
DocumentClassifierDetails.doc_types
DocumentClassifierDetails.expiration_date_time
DocumentClassifierDetails.warnings
DocumentField
DocumentField.as_dict()
DocumentField.clear()
DocumentField.copy()
DocumentField.get()
DocumentField.items()
DocumentField.keys()
DocumentField.pop()
DocumentField.popitem()
DocumentField.setdefault()
DocumentField.update()
DocumentField.values()
DocumentField.bounding_regions
DocumentField.confidence
DocumentField.content
DocumentField.spans
DocumentField.type
DocumentField.value_address
DocumentField.value_array
DocumentField.value_boolean
DocumentField.value_country_region
DocumentField.value_currency
DocumentField.value_date
DocumentField.value_integer
DocumentField.value_number
DocumentField.value_object
DocumentField.value_phone_number
DocumentField.value_selection_group
DocumentField.value_selection_mark
DocumentField.value_signature
DocumentField.value_string
DocumentField.value_time
DocumentFieldSchema
DocumentFieldSchema.as_dict()
DocumentFieldSchema.clear()
DocumentFieldSchema.copy()
DocumentFieldSchema.get()
DocumentFieldSchema.items()
DocumentFieldSchema.keys()
DocumentFieldSchema.pop()
DocumentFieldSchema.popitem()
DocumentFieldSchema.setdefault()
DocumentFieldSchema.update()
DocumentFieldSchema.values()
DocumentFieldSchema.description
DocumentFieldSchema.example
DocumentFieldSchema.items_property
DocumentFieldSchema.properties
DocumentFieldSchema.type
DocumentFieldType
DocumentFieldType.capitalize()
DocumentFieldType.casefold()
DocumentFieldType.center()
DocumentFieldType.count()
DocumentFieldType.encode()
DocumentFieldType.endswith()
DocumentFieldType.expandtabs()
DocumentFieldType.find()
DocumentFieldType.format()
DocumentFieldType.format_map()
DocumentFieldType.index()
DocumentFieldType.isalnum()
DocumentFieldType.isalpha()
DocumentFieldType.isascii()
DocumentFieldType.isdecimal()
DocumentFieldType.isdigit()
DocumentFieldType.isidentifier()
DocumentFieldType.islower()
DocumentFieldType.isnumeric()
DocumentFieldType.isprintable()
DocumentFieldType.isspace()
DocumentFieldType.istitle()
DocumentFieldType.isupper()
DocumentFieldType.join()
DocumentFieldType.ljust()
DocumentFieldType.lower()
DocumentFieldType.lstrip()
DocumentFieldType.maketrans()
DocumentFieldType.partition()
DocumentFieldType.removeprefix()
DocumentFieldType.removesuffix()
DocumentFieldType.replace()
DocumentFieldType.rfind()
DocumentFieldType.rindex()
DocumentFieldType.rjust()
DocumentFieldType.rpartition()
DocumentFieldType.rsplit()
DocumentFieldType.rstrip()
DocumentFieldType.split()
DocumentFieldType.splitlines()
DocumentFieldType.startswith()
DocumentFieldType.strip()
DocumentFieldType.swapcase()
DocumentFieldType.title()
DocumentFieldType.translate()
DocumentFieldType.upper()
DocumentFieldType.zfill()
DocumentFieldType.ADDRESS
DocumentFieldType.ARRAY
DocumentFieldType.BOOLEAN
DocumentFieldType.COUNTRY_REGION
DocumentFieldType.CURRENCY
DocumentFieldType.DATE
DocumentFieldType.INTEGER
DocumentFieldType.NUMBER
DocumentFieldType.OBJECT
DocumentFieldType.PHONE_NUMBER
DocumentFieldType.SELECTION_GROUP
DocumentFieldType.SELECTION_MARK
DocumentFieldType.SIGNATURE
DocumentFieldType.STRING
DocumentFieldType.TIME
DocumentFigure
DocumentFigure.as_dict()
DocumentFigure.clear()
DocumentFigure.copy()
DocumentFigure.get()
DocumentFigure.items()
DocumentFigure.keys()
DocumentFigure.pop()
DocumentFigure.popitem()
DocumentFigure.setdefault()
DocumentFigure.update()
DocumentFigure.values()
DocumentFigure.bounding_regions
DocumentFigure.caption
DocumentFigure.elements
DocumentFigure.footnotes
DocumentFigure.spans
DocumentFootnote
DocumentFootnote.as_dict()
DocumentFootnote.clear()
DocumentFootnote.copy()
DocumentFootnote.get()
DocumentFootnote.items()
DocumentFootnote.keys()
DocumentFootnote.pop()
DocumentFootnote.popitem()
DocumentFootnote.setdefault()
DocumentFootnote.update()
DocumentFootnote.values()
DocumentFootnote.bounding_regions
DocumentFootnote.content
DocumentFootnote.elements
DocumentFootnote.spans
DocumentFormula
DocumentFormula.as_dict()
DocumentFormula.clear()
DocumentFormula.copy()
DocumentFormula.get()
DocumentFormula.items()
DocumentFormula.keys()
DocumentFormula.pop()
DocumentFormula.popitem()
DocumentFormula.setdefault()
DocumentFormula.update()
DocumentFormula.values()
DocumentFormula.confidence
DocumentFormula.kind
DocumentFormula.polygon
DocumentFormula.span
DocumentFormula.value
DocumentFormulaKind
DocumentFormulaKind.capitalize()
DocumentFormulaKind.casefold()
DocumentFormulaKind.center()
DocumentFormulaKind.count()
DocumentFormulaKind.encode()
DocumentFormulaKind.endswith()
DocumentFormulaKind.expandtabs()
DocumentFormulaKind.find()
DocumentFormulaKind.format()
DocumentFormulaKind.format_map()
DocumentFormulaKind.index()
DocumentFormulaKind.isalnum()
DocumentFormulaKind.isalpha()
DocumentFormulaKind.isascii()
DocumentFormulaKind.isdecimal()
DocumentFormulaKind.isdigit()
DocumentFormulaKind.isidentifier()
DocumentFormulaKind.islower()
DocumentFormulaKind.isnumeric()
DocumentFormulaKind.isprintable()
DocumentFormulaKind.isspace()
DocumentFormulaKind.istitle()
DocumentFormulaKind.isupper()
DocumentFormulaKind.join()
DocumentFormulaKind.ljust()
DocumentFormulaKind.lower()
DocumentFormulaKind.lstrip()
DocumentFormulaKind.maketrans()
DocumentFormulaKind.partition()
DocumentFormulaKind.removeprefix()
DocumentFormulaKind.removesuffix()
DocumentFormulaKind.replace()
DocumentFormulaKind.rfind()
DocumentFormulaKind.rindex()
DocumentFormulaKind.rjust()
DocumentFormulaKind.rpartition()
DocumentFormulaKind.rsplit()
DocumentFormulaKind.rstrip()
DocumentFormulaKind.split()
DocumentFormulaKind.splitlines()
DocumentFormulaKind.startswith()
DocumentFormulaKind.strip()
DocumentFormulaKind.swapcase()
DocumentFormulaKind.title()
DocumentFormulaKind.translate()
DocumentFormulaKind.upper()
DocumentFormulaKind.zfill()
DocumentFormulaKind.DISPLAY
DocumentFormulaKind.INLINE
DocumentKeyValueElement
DocumentKeyValueElement.as_dict()
DocumentKeyValueElement.clear()
DocumentKeyValueElement.copy()
DocumentKeyValueElement.get()
DocumentKeyValueElement.items()
DocumentKeyValueElement.keys()
DocumentKeyValueElement.pop()
DocumentKeyValueElement.popitem()
DocumentKeyValueElement.setdefault()
DocumentKeyValueElement.update()
DocumentKeyValueElement.values()
DocumentKeyValueElement.bounding_regions
DocumentKeyValueElement.content
DocumentKeyValueElement.spans
DocumentKeyValuePair
DocumentKeyValuePair.as_dict()
DocumentKeyValuePair.clear()
DocumentKeyValuePair.copy()
DocumentKeyValuePair.get()
DocumentKeyValuePair.items()
DocumentKeyValuePair.keys()
DocumentKeyValuePair.pop()
DocumentKeyValuePair.popitem()
DocumentKeyValuePair.setdefault()
DocumentKeyValuePair.update()
DocumentKeyValuePair.values()
DocumentKeyValuePair.confidence
DocumentKeyValuePair.key
DocumentKeyValuePair.value
DocumentLanguage
DocumentLanguage.as_dict()
DocumentLanguage.clear()
DocumentLanguage.copy()
DocumentLanguage.get()
DocumentLanguage.items()
DocumentLanguage.keys()
DocumentLanguage.pop()
DocumentLanguage.popitem()
DocumentLanguage.setdefault()
DocumentLanguage.update()
DocumentLanguage.values()
DocumentLanguage.confidence
DocumentLanguage.locale
DocumentLanguage.spans
DocumentLine
DocumentList
DocumentListItem
DocumentListItem.as_dict()
DocumentListItem.clear()
DocumentListItem.copy()
DocumentListItem.get()
DocumentListItem.items()
DocumentListItem.keys()
DocumentListItem.pop()
DocumentListItem.popitem()
DocumentListItem.setdefault()
DocumentListItem.update()
DocumentListItem.values()
DocumentListItem.bounding_regions
DocumentListItem.content
DocumentListItem.elements
DocumentListItem.level
DocumentListItem.spans
DocumentModelBuildOperationDetails
DocumentModelBuildOperationDetails.as_dict()
DocumentModelBuildOperationDetails.clear()
DocumentModelBuildOperationDetails.copy()
DocumentModelBuildOperationDetails.get()
DocumentModelBuildOperationDetails.items()
DocumentModelBuildOperationDetails.keys()
DocumentModelBuildOperationDetails.pop()
DocumentModelBuildOperationDetails.popitem()
DocumentModelBuildOperationDetails.setdefault()
DocumentModelBuildOperationDetails.update()
DocumentModelBuildOperationDetails.values()
DocumentModelBuildOperationDetails.api_version
DocumentModelBuildOperationDetails.created_date_time
DocumentModelBuildOperationDetails.error
DocumentModelBuildOperationDetails.kind
DocumentModelBuildOperationDetails.last_updated_date_time
DocumentModelBuildOperationDetails.operation_id
DocumentModelBuildOperationDetails.percent_completed
DocumentModelBuildOperationDetails.resource_location
DocumentModelBuildOperationDetails.result
DocumentModelBuildOperationDetails.status
DocumentModelBuildOperationDetails.tags
DocumentModelComposeOperationDetails
DocumentModelComposeOperationDetails.as_dict()
DocumentModelComposeOperationDetails.clear()
DocumentModelComposeOperationDetails.copy()
DocumentModelComposeOperationDetails.get()
DocumentModelComposeOperationDetails.items()
DocumentModelComposeOperationDetails.keys()
DocumentModelComposeOperationDetails.pop()
DocumentModelComposeOperationDetails.popitem()
DocumentModelComposeOperationDetails.setdefault()
DocumentModelComposeOperationDetails.update()
DocumentModelComposeOperationDetails.values()
DocumentModelComposeOperationDetails.api_version
DocumentModelComposeOperationDetails.created_date_time
DocumentModelComposeOperationDetails.error
DocumentModelComposeOperationDetails.kind
DocumentModelComposeOperationDetails.last_updated_date_time
DocumentModelComposeOperationDetails.operation_id
DocumentModelComposeOperationDetails.percent_completed
DocumentModelComposeOperationDetails.resource_location
DocumentModelComposeOperationDetails.result
DocumentModelComposeOperationDetails.status
DocumentModelComposeOperationDetails.tags
DocumentModelCopyToOperationDetails
DocumentModelCopyToOperationDetails.as_dict()
DocumentModelCopyToOperationDetails.clear()
DocumentModelCopyToOperationDetails.copy()
DocumentModelCopyToOperationDetails.get()
DocumentModelCopyToOperationDetails.items()
DocumentModelCopyToOperationDetails.keys()
DocumentModelCopyToOperationDetails.pop()
DocumentModelCopyToOperationDetails.popitem()
DocumentModelCopyToOperationDetails.setdefault()
DocumentModelCopyToOperationDetails.update()
DocumentModelCopyToOperationDetails.values()
DocumentModelCopyToOperationDetails.api_version
DocumentModelCopyToOperationDetails.created_date_time
DocumentModelCopyToOperationDetails.error
DocumentModelCopyToOperationDetails.kind
DocumentModelCopyToOperationDetails.last_updated_date_time
DocumentModelCopyToOperationDetails.operation_id
DocumentModelCopyToOperationDetails.percent_completed
DocumentModelCopyToOperationDetails.resource_location
DocumentModelCopyToOperationDetails.result
DocumentModelCopyToOperationDetails.status
DocumentModelCopyToOperationDetails.tags
DocumentModelDetails
DocumentModelDetails.as_dict()
DocumentModelDetails.clear()
DocumentModelDetails.copy()
DocumentModelDetails.get()
DocumentModelDetails.items()
DocumentModelDetails.keys()
DocumentModelDetails.pop()
DocumentModelDetails.popitem()
DocumentModelDetails.setdefault()
DocumentModelDetails.update()
DocumentModelDetails.values()
DocumentModelDetails.api_version
DocumentModelDetails.azure_blob_file_list_source
DocumentModelDetails.azure_blob_source
DocumentModelDetails.build_mode
DocumentModelDetails.created_date_time
DocumentModelDetails.description
DocumentModelDetails.doc_types
DocumentModelDetails.expiration_date_time
DocumentModelDetails.model_id
DocumentModelDetails.tags
DocumentModelDetails.warnings
DocumentPage
DocumentPage.as_dict()
DocumentPage.clear()
DocumentPage.copy()
DocumentPage.get()
DocumentPage.items()
DocumentPage.keys()
DocumentPage.pop()
DocumentPage.popitem()
DocumentPage.setdefault()
DocumentPage.update()
DocumentPage.values()
DocumentPage.angle
DocumentPage.barcodes
DocumentPage.formulas
DocumentPage.height
DocumentPage.lines
DocumentPage.page_number
DocumentPage.selection_marks
DocumentPage.spans
DocumentPage.unit
DocumentPage.width
DocumentPage.words
DocumentParagraph
DocumentParagraph.as_dict()
DocumentParagraph.clear()
DocumentParagraph.copy()
DocumentParagraph.get()
DocumentParagraph.items()
DocumentParagraph.keys()
DocumentParagraph.pop()
DocumentParagraph.popitem()
DocumentParagraph.setdefault()
DocumentParagraph.update()
DocumentParagraph.values()
DocumentParagraph.bounding_regions
DocumentParagraph.content
DocumentParagraph.role
DocumentParagraph.spans
DocumentSection
DocumentSection.as_dict()
DocumentSection.clear()
DocumentSection.copy()
DocumentSection.get()
DocumentSection.items()
DocumentSection.keys()
DocumentSection.pop()
DocumentSection.popitem()
DocumentSection.setdefault()
DocumentSection.update()
DocumentSection.values()
DocumentSection.elements
DocumentSection.spans
DocumentSelectionMark
DocumentSelectionMark.as_dict()
DocumentSelectionMark.clear()
DocumentSelectionMark.copy()
DocumentSelectionMark.get()
DocumentSelectionMark.items()
DocumentSelectionMark.keys()
DocumentSelectionMark.pop()
DocumentSelectionMark.popitem()
DocumentSelectionMark.setdefault()
DocumentSelectionMark.update()
DocumentSelectionMark.values()
DocumentSelectionMark.confidence
DocumentSelectionMark.polygon
DocumentSelectionMark.span
DocumentSelectionMark.state
DocumentSelectionMarkState
DocumentSelectionMarkState.capitalize()
DocumentSelectionMarkState.casefold()
DocumentSelectionMarkState.center()
DocumentSelectionMarkState.count()
DocumentSelectionMarkState.encode()
DocumentSelectionMarkState.endswith()
DocumentSelectionMarkState.expandtabs()
DocumentSelectionMarkState.find()
DocumentSelectionMarkState.format()
DocumentSelectionMarkState.format_map()
DocumentSelectionMarkState.index()
DocumentSelectionMarkState.isalnum()
DocumentSelectionMarkState.isalpha()
DocumentSelectionMarkState.isascii()
DocumentSelectionMarkState.isdecimal()
DocumentSelectionMarkState.isdigit()
DocumentSelectionMarkState.isidentifier()
DocumentSelectionMarkState.islower()
DocumentSelectionMarkState.isnumeric()
DocumentSelectionMarkState.isprintable()
DocumentSelectionMarkState.isspace()
DocumentSelectionMarkState.istitle()
DocumentSelectionMarkState.isupper()
DocumentSelectionMarkState.join()
DocumentSelectionMarkState.ljust()
DocumentSelectionMarkState.lower()
DocumentSelectionMarkState.lstrip()
DocumentSelectionMarkState.maketrans()
DocumentSelectionMarkState.partition()
DocumentSelectionMarkState.removeprefix()
DocumentSelectionMarkState.removesuffix()
DocumentSelectionMarkState.replace()
DocumentSelectionMarkState.rfind()
DocumentSelectionMarkState.rindex()
DocumentSelectionMarkState.rjust()
DocumentSelectionMarkState.rpartition()
DocumentSelectionMarkState.rsplit()
DocumentSelectionMarkState.rstrip()
DocumentSelectionMarkState.split()
DocumentSelectionMarkState.splitlines()
DocumentSelectionMarkState.startswith()
DocumentSelectionMarkState.strip()
DocumentSelectionMarkState.swapcase()
DocumentSelectionMarkState.title()
DocumentSelectionMarkState.translate()
DocumentSelectionMarkState.upper()
DocumentSelectionMarkState.zfill()
DocumentSelectionMarkState.SELECTED
DocumentSelectionMarkState.UNSELECTED
DocumentSignatureType
DocumentSignatureType.capitalize()
DocumentSignatureType.casefold()
DocumentSignatureType.center()
DocumentSignatureType.count()
DocumentSignatureType.encode()
DocumentSignatureType.endswith()
DocumentSignatureType.expandtabs()
DocumentSignatureType.find()
DocumentSignatureType.format()
DocumentSignatureType.format_map()
DocumentSignatureType.index()
DocumentSignatureType.isalnum()
DocumentSignatureType.isalpha()
DocumentSignatureType.isascii()
DocumentSignatureType.isdecimal()
DocumentSignatureType.isdigit()
DocumentSignatureType.isidentifier()
DocumentSignatureType.islower()
DocumentSignatureType.isnumeric()
DocumentSignatureType.isprintable()
DocumentSignatureType.isspace()
DocumentSignatureType.istitle()
DocumentSignatureType.isupper()
DocumentSignatureType.join()
DocumentSignatureType.ljust()
DocumentSignatureType.lower()
DocumentSignatureType.lstrip()
DocumentSignatureType.maketrans()
DocumentSignatureType.partition()
DocumentSignatureType.removeprefix()
DocumentSignatureType.removesuffix()
DocumentSignatureType.replace()
DocumentSignatureType.rfind()
DocumentSignatureType.rindex()
DocumentSignatureType.rjust()
DocumentSignatureType.rpartition()
DocumentSignatureType.rsplit()
DocumentSignatureType.rstrip()
DocumentSignatureType.split()
DocumentSignatureType.splitlines()
DocumentSignatureType.startswith()
DocumentSignatureType.strip()
DocumentSignatureType.swapcase()
DocumentSignatureType.title()
DocumentSignatureType.translate()
DocumentSignatureType.upper()
DocumentSignatureType.zfill()
DocumentSignatureType.SIGNED
DocumentSignatureType.UNSIGNED
DocumentSpan
DocumentStyle
DocumentStyle.as_dict()
DocumentStyle.clear()
DocumentStyle.copy()
DocumentStyle.get()
DocumentStyle.items()
DocumentStyle.keys()
DocumentStyle.pop()
DocumentStyle.popitem()
DocumentStyle.setdefault()
DocumentStyle.update()
DocumentStyle.values()
DocumentStyle.background_color
DocumentStyle.color
DocumentStyle.confidence
DocumentStyle.font_style
DocumentStyle.font_weight
DocumentStyle.is_handwritten
DocumentStyle.similar_font_family
DocumentStyle.spans
DocumentTable
DocumentTable.as_dict()
DocumentTable.clear()
DocumentTable.copy()
DocumentTable.get()
DocumentTable.items()
DocumentTable.keys()
DocumentTable.pop()
DocumentTable.popitem()
DocumentTable.setdefault()
DocumentTable.update()
DocumentTable.values()
DocumentTable.bounding_regions
DocumentTable.caption
DocumentTable.cells
DocumentTable.column_count
DocumentTable.footnotes
DocumentTable.row_count
DocumentTable.spans
DocumentTableCell
DocumentTableCell.as_dict()
DocumentTableCell.clear()
DocumentTableCell.copy()
DocumentTableCell.get()
DocumentTableCell.items()
DocumentTableCell.keys()
DocumentTableCell.pop()
DocumentTableCell.popitem()
DocumentTableCell.setdefault()
DocumentTableCell.update()
DocumentTableCell.values()
DocumentTableCell.bounding_regions
DocumentTableCell.column_index
DocumentTableCell.column_span
DocumentTableCell.content
DocumentTableCell.elements
DocumentTableCell.kind
DocumentTableCell.row_index
DocumentTableCell.row_span
DocumentTableCell.spans
DocumentTableCellKind
DocumentTableCellKind.capitalize()
DocumentTableCellKind.casefold()
DocumentTableCellKind.center()
DocumentTableCellKind.count()
DocumentTableCellKind.encode()
DocumentTableCellKind.endswith()
DocumentTableCellKind.expandtabs()
DocumentTableCellKind.find()
DocumentTableCellKind.format()
DocumentTableCellKind.format_map()
DocumentTableCellKind.index()
DocumentTableCellKind.isalnum()
DocumentTableCellKind.isalpha()
DocumentTableCellKind.isascii()
DocumentTableCellKind.isdecimal()
DocumentTableCellKind.isdigit()
DocumentTableCellKind.isidentifier()
DocumentTableCellKind.islower()
DocumentTableCellKind.isnumeric()
DocumentTableCellKind.isprintable()
DocumentTableCellKind.isspace()
DocumentTableCellKind.istitle()
DocumentTableCellKind.isupper()
DocumentTableCellKind.join()
DocumentTableCellKind.ljust()
DocumentTableCellKind.lower()
DocumentTableCellKind.lstrip()
DocumentTableCellKind.maketrans()
DocumentTableCellKind.partition()
DocumentTableCellKind.removeprefix()
DocumentTableCellKind.removesuffix()
DocumentTableCellKind.replace()
DocumentTableCellKind.rfind()
DocumentTableCellKind.rindex()
DocumentTableCellKind.rjust()
DocumentTableCellKind.rpartition()
DocumentTableCellKind.rsplit()
DocumentTableCellKind.rstrip()
DocumentTableCellKind.split()
DocumentTableCellKind.splitlines()
DocumentTableCellKind.startswith()
DocumentTableCellKind.strip()
DocumentTableCellKind.swapcase()
DocumentTableCellKind.title()
DocumentTableCellKind.translate()
DocumentTableCellKind.upper()
DocumentTableCellKind.zfill()
DocumentTableCellKind.COLUMN_HEADER
DocumentTableCellKind.CONTENT
DocumentTableCellKind.DESCRIPTION
DocumentTableCellKind.ROW_HEADER
DocumentTableCellKind.STUB_HEAD
DocumentTypeDetails
DocumentTypeDetails.as_dict()
DocumentTypeDetails.clear()
DocumentTypeDetails.copy()
DocumentTypeDetails.get()
DocumentTypeDetails.items()
DocumentTypeDetails.keys()
DocumentTypeDetails.pop()
DocumentTypeDetails.popitem()
DocumentTypeDetails.setdefault()
DocumentTypeDetails.update()
DocumentTypeDetails.values()
DocumentTypeDetails.build_mode
DocumentTypeDetails.description
DocumentTypeDetails.field_confidence
DocumentTypeDetails.field_schema
DocumentWord
DocumentWord.as_dict()
DocumentWord.clear()
DocumentWord.copy()
DocumentWord.get()
DocumentWord.items()
DocumentWord.keys()
DocumentWord.pop()
DocumentWord.popitem()
DocumentWord.setdefault()
DocumentWord.update()
DocumentWord.values()
DocumentWord.confidence
DocumentWord.content
DocumentWord.polygon
DocumentWord.span
Error
ErrorResponse
FontStyle
FontStyle.capitalize()
FontStyle.casefold()
FontStyle.center()
FontStyle.count()
FontStyle.encode()
FontStyle.endswith()
FontStyle.expandtabs()
FontStyle.find()
FontStyle.format()
FontStyle.format_map()
FontStyle.index()
FontStyle.isalnum()
FontStyle.isalpha()
FontStyle.isascii()
FontStyle.isdecimal()
FontStyle.isdigit()
FontStyle.isidentifier()
FontStyle.islower()
FontStyle.isnumeric()
FontStyle.isprintable()
FontStyle.isspace()
FontStyle.istitle()
FontStyle.isupper()
FontStyle.join()
FontStyle.ljust()
FontStyle.lower()
FontStyle.lstrip()
FontStyle.maketrans()
FontStyle.partition()
FontStyle.removeprefix()
FontStyle.removesuffix()
FontStyle.replace()
FontStyle.rfind()
FontStyle.rindex()
FontStyle.rjust()
FontStyle.rpartition()
FontStyle.rsplit()
FontStyle.rstrip()
FontStyle.split()
FontStyle.splitlines()
FontStyle.startswith()
FontStyle.strip()
FontStyle.swapcase()
FontStyle.title()
FontStyle.translate()
FontStyle.upper()
FontStyle.zfill()
FontStyle.ITALIC
FontStyle.NORMAL
FontWeight
FontWeight.capitalize()
FontWeight.casefold()
FontWeight.center()
FontWeight.count()
FontWeight.encode()
FontWeight.endswith()
FontWeight.expandtabs()
FontWeight.find()
FontWeight.format()
FontWeight.format_map()
FontWeight.index()
FontWeight.isalnum()
FontWeight.isalpha()
FontWeight.isascii()
FontWeight.isdecimal()
FontWeight.isdigit()
FontWeight.isidentifier()
FontWeight.islower()
FontWeight.isnumeric()
FontWeight.isprintable()
FontWeight.isspace()
FontWeight.istitle()
FontWeight.isupper()
FontWeight.join()
FontWeight.ljust()
FontWeight.lower()
FontWeight.lstrip()
FontWeight.maketrans()
FontWeight.partition()
FontWeight.removeprefix()
FontWeight.removesuffix()
FontWeight.replace()
FontWeight.rfind()
FontWeight.rindex()
FontWeight.rjust()
FontWeight.rpartition()
FontWeight.rsplit()
FontWeight.rstrip()
FontWeight.split()
FontWeight.splitlines()
FontWeight.startswith()
FontWeight.strip()
FontWeight.swapcase()
FontWeight.title()
FontWeight.translate()
FontWeight.upper()
FontWeight.zfill()
FontWeight.BOLD
FontWeight.NORMAL
InnerError
LengthUnit
LengthUnit.capitalize()
LengthUnit.casefold()
LengthUnit.center()
LengthUnit.count()
LengthUnit.encode()
LengthUnit.endswith()
LengthUnit.expandtabs()
LengthUnit.find()
LengthUnit.format()
LengthUnit.format_map()
LengthUnit.index()
LengthUnit.isalnum()
LengthUnit.isalpha()
LengthUnit.isascii()
LengthUnit.isdecimal()
LengthUnit.isdigit()
LengthUnit.isidentifier()
LengthUnit.islower()
LengthUnit.isnumeric()
LengthUnit.isprintable()
LengthUnit.isspace()
LengthUnit.istitle()
LengthUnit.isupper()
LengthUnit.join()
LengthUnit.ljust()
LengthUnit.lower()
LengthUnit.lstrip()
LengthUnit.maketrans()
LengthUnit.partition()
LengthUnit.removeprefix()
LengthUnit.removesuffix()
LengthUnit.replace()
LengthUnit.rfind()
LengthUnit.rindex()
LengthUnit.rjust()
LengthUnit.rpartition()
LengthUnit.rsplit()
LengthUnit.rstrip()
LengthUnit.split()
LengthUnit.splitlines()
LengthUnit.startswith()
LengthUnit.strip()
LengthUnit.swapcase()
LengthUnit.title()
LengthUnit.translate()
LengthUnit.upper()
LengthUnit.zfill()
LengthUnit.INCH
LengthUnit.PIXEL
OperationDetails
OperationDetails.as_dict()
OperationDetails.clear()
OperationDetails.copy()
OperationDetails.get()
OperationDetails.items()
OperationDetails.keys()
OperationDetails.pop()
OperationDetails.popitem()
OperationDetails.setdefault()
OperationDetails.update()
OperationDetails.values()
OperationDetails.api_version
OperationDetails.created_date_time
OperationDetails.error
OperationDetails.kind
OperationDetails.last_updated_date_time
OperationDetails.operation_id
OperationDetails.percent_completed
OperationDetails.resource_location
OperationDetails.status
OperationDetails.tags
OperationKind
OperationKind.capitalize()
OperationKind.casefold()
OperationKind.center()
OperationKind.count()
OperationKind.encode()
OperationKind.endswith()
OperationKind.expandtabs()
OperationKind.find()
OperationKind.format()
OperationKind.format_map()
OperationKind.index()
OperationKind.isalnum()
OperationKind.isalpha()
OperationKind.isascii()
OperationKind.isdecimal()
OperationKind.isdigit()
OperationKind.isidentifier()
OperationKind.islower()
OperationKind.isnumeric()
OperationKind.isprintable()
OperationKind.isspace()
OperationKind.istitle()
OperationKind.isupper()
OperationKind.join()
OperationKind.ljust()
OperationKind.lower()
OperationKind.lstrip()
OperationKind.maketrans()
OperationKind.partition()
OperationKind.removeprefix()
OperationKind.removesuffix()
OperationKind.replace()
OperationKind.rfind()
OperationKind.rindex()
OperationKind.rjust()
OperationKind.rpartition()
OperationKind.rsplit()
OperationKind.rstrip()
OperationKind.split()
OperationKind.splitlines()
OperationKind.startswith()
OperationKind.strip()
OperationKind.swapcase()
OperationKind.title()
OperationKind.translate()
OperationKind.upper()
OperationKind.zfill()
OperationKind.DOCUMENT_CLASSIFIER_BUILD
OperationKind.DOCUMENT_MODEL_BUILD
OperationKind.DOCUMENT_MODEL_COMPOSE
OperationKind.DOCUMENT_MODEL_COPY_TO
OperationStatus
OperationStatus.capitalize()
OperationStatus.casefold()
OperationStatus.center()
OperationStatus.count()
OperationStatus.encode()
OperationStatus.endswith()
OperationStatus.expandtabs()
OperationStatus.find()
OperationStatus.format()
OperationStatus.format_map()
OperationStatus.index()
OperationStatus.isalnum()
OperationStatus.isalpha()
OperationStatus.isascii()
OperationStatus.isdecimal()
OperationStatus.isdigit()
OperationStatus.isidentifier()
OperationStatus.islower()
OperationStatus.isnumeric()
OperationStatus.isprintable()
OperationStatus.isspace()
OperationStatus.istitle()
OperationStatus.isupper()
OperationStatus.join()
OperationStatus.ljust()
OperationStatus.lower()
OperationStatus.lstrip()
OperationStatus.maketrans()
OperationStatus.partition()
OperationStatus.removeprefix()
OperationStatus.removesuffix()
OperationStatus.replace()
OperationStatus.rfind()
OperationStatus.rindex()
OperationStatus.rjust()
OperationStatus.rpartition()
OperationStatus.rsplit()
OperationStatus.rstrip()
OperationStatus.split()
OperationStatus.splitlines()
OperationStatus.startswith()
OperationStatus.strip()
OperationStatus.swapcase()
OperationStatus.title()
OperationStatus.translate()
OperationStatus.upper()
OperationStatus.zfill()
OperationStatus.CANCELED
OperationStatus.COMPLETED
OperationStatus.FAILED
OperationStatus.NOT_STARTED
OperationStatus.RUNNING
OperationStatus.SUCCEEDED
ParagraphRole
ParagraphRole.capitalize()
ParagraphRole.casefold()
ParagraphRole.center()
ParagraphRole.count()
ParagraphRole.encode()
ParagraphRole.endswith()
ParagraphRole.expandtabs()
ParagraphRole.find()
ParagraphRole.format()
ParagraphRole.format_map()
ParagraphRole.index()
ParagraphRole.isalnum()
ParagraphRole.isalpha()
ParagraphRole.isascii()
ParagraphRole.isdecimal()
ParagraphRole.isdigit()
ParagraphRole.isidentifier()
ParagraphRole.islower()
ParagraphRole.isnumeric()
ParagraphRole.isprintable()
ParagraphRole.isspace()
ParagraphRole.istitle()
ParagraphRole.isupper()
ParagraphRole.join()
ParagraphRole.ljust()
ParagraphRole.lower()
ParagraphRole.lstrip()
ParagraphRole.maketrans()
ParagraphRole.partition()
ParagraphRole.removeprefix()
ParagraphRole.removesuffix()
ParagraphRole.replace()
ParagraphRole.rfind()
ParagraphRole.rindex()
ParagraphRole.rjust()
ParagraphRole.rpartition()
ParagraphRole.rsplit()
ParagraphRole.rstrip()
ParagraphRole.split()
ParagraphRole.splitlines()
ParagraphRole.startswith()
ParagraphRole.strip()
ParagraphRole.swapcase()
ParagraphRole.title()
ParagraphRole.translate()
ParagraphRole.upper()
ParagraphRole.zfill()
ParagraphRole.FOOTNOTE
ParagraphRole.FORMULA_BLOCK
ParagraphRole.PAGE_FOOTER
ParagraphRole.PAGE_HEADER
ParagraphRole.PAGE_NUMBER
ParagraphRole.SECTION_HEADING
ParagraphRole.TITLE
QuotaDetails
QuotaDetails.as_dict()
QuotaDetails.clear()
QuotaDetails.copy()
QuotaDetails.get()
QuotaDetails.items()
QuotaDetails.keys()
QuotaDetails.pop()
QuotaDetails.popitem()
QuotaDetails.setdefault()
QuotaDetails.update()
QuotaDetails.values()
QuotaDetails.quota
QuotaDetails.quota_reset_date_time
QuotaDetails.used
ResourceDetails
ResourceDetails.as_dict()
ResourceDetails.clear()
ResourceDetails.copy()
ResourceDetails.get()
ResourceDetails.items()
ResourceDetails.keys()
ResourceDetails.pop()
ResourceDetails.popitem()
ResourceDetails.setdefault()
ResourceDetails.update()
ResourceDetails.values()
ResourceDetails.custom_document_models
ResourceDetails.custom_neural_document_model_builds
SplitMode
SplitMode.capitalize()
SplitMode.casefold()
SplitMode.center()
SplitMode.count()
SplitMode.encode()
SplitMode.endswith()
SplitMode.expandtabs()
SplitMode.find()
SplitMode.format()
SplitMode.format_map()
SplitMode.index()
SplitMode.isalnum()
SplitMode.isalpha()
SplitMode.isascii()
SplitMode.isdecimal()
SplitMode.isdigit()
SplitMode.isidentifier()
SplitMode.islower()
SplitMode.isnumeric()
SplitMode.isprintable()
SplitMode.isspace()
SplitMode.istitle()
SplitMode.isupper()
SplitMode.join()
SplitMode.ljust()
SplitMode.lower()
SplitMode.lstrip()
SplitMode.maketrans()
SplitMode.partition()
SplitMode.removeprefix()
SplitMode.removesuffix()
SplitMode.replace()
SplitMode.rfind()
SplitMode.rindex()
SplitMode.rjust()
SplitMode.rpartition()
SplitMode.rsplit()
SplitMode.rstrip()
SplitMode.split()
SplitMode.splitlines()
SplitMode.startswith()
SplitMode.strip()
SplitMode.swapcase()
SplitMode.title()
SplitMode.translate()
SplitMode.upper()
SplitMode.zfill()
SplitMode.AUTO
SplitMode.NONE
SplitMode.PER_PAGE
StringIndexType
StringIndexType.capitalize()
StringIndexType.casefold()
StringIndexType.center()
StringIndexType.count()
StringIndexType.encode()
StringIndexType.endswith()
StringIndexType.expandtabs()
StringIndexType.find()
StringIndexType.format()
StringIndexType.format_map()
StringIndexType.index()
StringIndexType.isalnum()
StringIndexType.isalpha()
StringIndexType.isascii()
StringIndexType.isdecimal()
StringIndexType.isdigit()
StringIndexType.isidentifier()
StringIndexType.islower()
StringIndexType.isnumeric()
StringIndexType.isprintable()
StringIndexType.isspace()
StringIndexType.istitle()
StringIndexType.isupper()
StringIndexType.join()
StringIndexType.ljust()
StringIndexType.lower()
StringIndexType.lstrip()
StringIndexType.maketrans()
StringIndexType.partition()
StringIndexType.removeprefix()
StringIndexType.removesuffix()
StringIndexType.replace()
StringIndexType.rfind()
StringIndexType.rindex()
StringIndexType.rjust()
StringIndexType.rpartition()
StringIndexType.rsplit()
StringIndexType.rstrip()
StringIndexType.split()
StringIndexType.splitlines()
StringIndexType.startswith()
StringIndexType.strip()
StringIndexType.swapcase()
StringIndexType.title()
StringIndexType.translate()
StringIndexType.upper()
StringIndexType.zfill()
StringIndexType.TEXT_ELEMENTS
StringIndexType.UNICODE_CODE_POINT
StringIndexType.UTF16_CODE_UNIT
Warning