/
azure.ai.formrecognizer.OperationSummary.yml
93 lines (83 loc) · 3.21 KB
/
azure.ai.formrecognizer.OperationSummary.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
### YamlMime:PythonClass
uid: azure.ai.formrecognizer.OperationSummary
name: OperationSummary
fullName: azure.ai.formrecognizer.OperationSummary
module: azure.ai.formrecognizer
inheritances:
- builtins.object
summary: 'Model operation information, including the kind and status of the operation,
when it was
created, and more.
Note that operation information only persists for 24 hours. If the operation was
successful,
the model can be accessed using the <xref:azure.ai.formrecognizer.get_document_model>,
<xref:azure.ai.formrecognizer.list_document_models>,
<xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers>
APIs.
To find out why an operation failed, use <xref:azure.ai.formrecognizer.get_operation>
and provide the *operation_id*.
*New in version 2023-07-31:* The *documentClassifierBuild* kind.'
constructor:
syntax: 'OperationSummary(**kwargs: Any)'
methods:
- uid: azure.ai.formrecognizer.OperationSummary.from_dict
name: from_dict
summary: Converts a dict in the shape of a OperationSummary to the model itself.
signature: 'from_dict(data: Dict) -> OperationSummary'
parameters:
- name: data
description: A dictionary in the shape of OperationSummary.
isRequired: true
types:
- <xref:dict>
return:
description: OperationSummary
types:
- <xref:azure.ai.formrecognizer.OperationSummary>
- uid: azure.ai.formrecognizer.OperationSummary.to_dict
name: to_dict
summary: Returns a dict representation of OperationSummary.
signature: to_dict() -> Dict
return:
description: dict
types:
- <xref:dict>
attributes:
- uid: azure.ai.formrecognizer.OperationSummary.api_version
name: api_version
summary: API version used to create this operation.
signature: 'api_version: str | None'
- uid: azure.ai.formrecognizer.OperationSummary.created_on
name: created_on
summary: Date and time (UTC) when the operation was created.
signature: 'created_on: datetime'
- uid: azure.ai.formrecognizer.OperationSummary.kind
name: kind
summary: '"documentModelBuild",
"documentModelCompose", "documentModelCopyTo", "documentClassifierBuild".'
signature: 'kind: str'
- uid: azure.ai.formrecognizer.OperationSummary.last_updated_on
name: last_updated_on
summary: Date and time (UTC) when the operation was last updated.
signature: 'last_updated_on: datetime'
- uid: azure.ai.formrecognizer.OperationSummary.operation_id
name: operation_id
summary: Operation ID.
signature: 'operation_id: str'
- uid: azure.ai.formrecognizer.OperationSummary.percent_completed
name: percent_completed
summary: Operation progress (0-100).
signature: 'percent_completed: int | None'
- uid: azure.ai.formrecognizer.OperationSummary.resource_location
name: resource_location
summary: URL of the resource targeted by this operation.
signature: 'resource_location: str'
- uid: azure.ai.formrecognizer.OperationSummary.status
name: status
summary: '"notStarted", "running",
"failed", "succeeded", "canceled".'
signature: 'status: str'
- uid: azure.ai.formrecognizer.OperationSummary.tags
name: tags
summary: List of user defined key-value tag attributes associated with the model.
signature: 'tags: Dict[str, str] | None'