forked from MicrosoftDocs/azure-docs-sdk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
azure.ai.formrecognizer.AnalyzeResult.yml
74 lines (72 loc) · 2.54 KB
/
azure.ai.formrecognizer.AnalyzeResult.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
### YamlMime:PythonClass
uid: azure.ai.formrecognizer.AnalyzeResult
name: AnalyzeResult
fullName: azure.ai.formrecognizer.AnalyzeResult
module: azure.ai.formrecognizer
inheritances:
- builtins.object
summary: Document analysis result.
constructor:
syntax: 'AnalyzeResult(**kwargs: Any)'
methods:
- uid: azure.ai.formrecognizer.AnalyzeResult.from_dict
name: from_dict
summary: Converts a dict in the shape of a AnalyzeResult to the model itself.
signature: 'from_dict(data: Dict) -> AnalyzeResult'
parameters:
- name: data
description: A dictionary in the shape of AnalyzeResult.
isRequired: true
types:
- <xref:Dict>
return:
description: AnalyzeResult
types:
- <xref:azure.ai.formrecognizer.AnalyzeResult>
- uid: azure.ai.formrecognizer.AnalyzeResult.to_dict
name: to_dict
summary: Returns a dict representation of AnalyzeResult.
signature: to_dict() -> Dict
attributes:
- uid: azure.ai.formrecognizer.AnalyzeResult.api_version
name: api_version
summary: 'API version used to produce this result. Possible values include:
"2022-08-31".'
signature: 'api_version: str'
- uid: azure.ai.formrecognizer.AnalyzeResult.content
name: content
summary: 'Concatenate string representation of all textual and visual elements
in reading order.'
signature: 'content: str'
- uid: azure.ai.formrecognizer.AnalyzeResult.documents
name: documents
summary: Extracted documents.
signature: 'documents: List[AnalyzedDocument] | None'
- uid: azure.ai.formrecognizer.AnalyzeResult.key_value_pairs
name: key_value_pairs
summary: Extracted key-value pairs.
signature: 'key_value_pairs: List[DocumentKeyValuePair] | None'
- uid: azure.ai.formrecognizer.AnalyzeResult.languages
name: languages
summary: Detected languages in the document.
signature: 'languages: List[DocumentLanguage] | None'
- uid: azure.ai.formrecognizer.AnalyzeResult.model_id
name: model_id
summary: Model ID used to produce this result.
signature: 'model_id: str'
- uid: azure.ai.formrecognizer.AnalyzeResult.pages
name: pages
summary: Analyzed pages.
signature: 'pages: List[DocumentPage]'
- uid: azure.ai.formrecognizer.AnalyzeResult.paragraphs
name: paragraphs
summary: Extracted paragraphs.
signature: 'paragraphs: List[DocumentParagraph] | None'
- uid: azure.ai.formrecognizer.AnalyzeResult.styles
name: styles
summary: Extracted font styles.
signature: 'styles: List[DocumentStyle] | None'
- uid: azure.ai.formrecognizer.AnalyzeResult.tables
name: tables
summary: Extracted tables.
signature: 'tables: List[DocumentTable] | None'