-
Notifications
You must be signed in to change notification settings - Fork 239
/
azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.yml
136 lines (124 loc) · 4.98 KB
/
azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
### YamlMime:PythonClass
uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult
name: KeyPhraseBatchResult
fullName: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult
module: azure.cognitiveservices.language.textanalytics.models
inheritances:
- msrest.serialization.Model
summary: 'KeyPhraseBatchResult.
Variables are only populated by the server, and will be ignored when
sending a request.'
constructor:
syntax: KeyPhraseBatchResult(**kwargs)
variables:
- description: Response by document
name: documents
types:
- <xref:list>[<xref:azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem>]
- description: Errors and Warnings by document
name: errors
types:
- <xref:list>[<xref:azure.cognitiveservices.language.textanalytics.models.ErrorRecord>]
- description: '=(Optional) if showStats=true was specified in the
request this field will contain information about the request payload.'
name: statistics
types:
- <xref:azure.cognitiveservices.language.textanalytics.models.RequestStatistics>
methods:
- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.as_dict
name: as_dict
summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
\ optionally use a callback as parameter:\n\nKey is the attribute name used in\
\ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
\ in this object.\n\nThe string returned will be used to serialize the key.\n\
If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
\ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
\ pass the kwargs is_xml=True."
signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
**kwargs)
parameters:
- name: key_transformer
description: A key transformer function.
types:
- <xref:function>
- name: keep_readonly
defaultValue: 'True'
return:
description: A dict JSON compatible object
types:
- <xref:dict>
- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.deserialize
name: deserialize
summary: Parse a str using the RestAPI syntax and return a model.
signature: deserialize(data, content_type=None)
parameters:
- name: data
description: A str using RestAPI structure. JSON by default.
isRequired: true
types:
- <xref:str>
- name: content_type
description: JSON by default, set application/xml if XML.
defaultValue: None
types:
- <xref:str>
return:
description: An instance of this model
exceptions:
- type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.enable_additional_properties_sending
name: enable_additional_properties_sending
signature: enable_additional_properties_sending()
- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.from_dict
name: from_dict
summary: 'Parse a dict using given key extractor return a model.
By default consider key
extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
and last_rest_key_case_insensitive_extractor)'
signature: from_dict(data, key_extractors=None, content_type=None)
parameters:
- name: data
description: A dict using RestAPI structure
isRequired: true
types:
- <xref:dict>
- name: content_type
description: JSON by default, set application/xml if XML.
defaultValue: None
types:
- <xref:str>
- name: key_extractors
defaultValue: None
return:
description: An instance of this model
exceptions:
- type: DeserializationError if something went wrong
- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.is_xml_model
name: is_xml_model
signature: is_xml_model()
- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.serialize
name: serialize
summary: 'Return the JSON that would be sent to azure from this model.
This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.
If you want XML serialization, you can pass the kwargs is_xml=True.'
signature: serialize(keep_readonly=False, **kwargs)
parameters:
- name: keep_readonly
description: If you want to serialize the readonly attributes
defaultValue: 'False'
types:
- <xref:bool>
return:
description: A dict JSON compatible object
types:
- <xref:dict>
- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.validate
name: validate
summary: Validate this model recursively and return a list of ValidationError.
signature: validate()
return:
description: A list of validation error
types:
- <xref:list>