DocumentModelDetails Class
Document model information. Includes the doc types that the model can analyze.
New in version 2023-07-31: The expires_on property.
- Inheritance
-
azure.ai.formrecognizer._models.DocumentModelSummaryDocumentModelDetails
Constructor
DocumentModelDetails(**kwargs: Any)
Methods
from_dict |
Converts a dict in the shape of a DocumentModelDetails to the model itself. |
to_dict |
Returns a dict representation of DocumentModelDetails. |
from_dict
Converts a dict in the shape of a DocumentModelDetails to the model itself.
from_dict(data: Dict[str, Any]) -> DocumentModelDetails
Parameters
Name | Description |
---|---|
data
Required
|
A dictionary in the shape of DocumentModelDetails. |
Returns
Type | Description |
---|---|
DocumentModelDetails |
to_dict
Returns a dict representation of DocumentModelDetails.
to_dict() -> Dict[str, Any]
Returns
Type | Description |
---|---|
Dict[str, Any] |
Attributes
api_version
API version used to create this model.
api_version: str | None
created_on
Date and time (UTC) when the model was created.
created_on: datetime
description
A description for the model.
description: str | None
doc_types
Supported document types, including the fields for each document and their types.
doc_types: Dict[str, DocumentTypeDetails] | None
expires_on
Date and time (UTC) when the document model will expire.
expires_on: datetime | None
model_id
Unique model id.
model_id: str
tags
List of user defined key-value tag attributes associated with the model.
tags: Dict[str, str] | None
Azure SDK for Python