-
Notifications
You must be signed in to change notification settings - Fork 240
/
azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.yml
141 lines (110 loc) · 5.34 KB
/
azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.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
137
138
139
140
141
### YamlMime:PythonClass
uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction
name: AnalyzeHealthcareEntitiesAction
fullName: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction
module: azure.ai.textanalytics
inheritances:
- azure.ai.textanalytics._dict_mixin.DictMixin
summary: 'AnalyzeHealthcareEntitiesAction encapsulates the parameters for starting
a long-running
healthcare entities analysis operation.
If you just want to analyze healthcare entities in a list of documents, and not
perform multiple
long running actions on the input of documents, call method *begin_analyze_healthcare_entities*
instead
of interfacing with this model.
*New in version 2022-05-01:* The *AnalyzeHealthcareEntitiesAction* model.'
constructor:
syntax: 'AnalyzeHealthcareEntitiesAction(*, model_version: str | None = None, string_index_type:
str | None = None, disable_service_logs: bool | None = None, **kwargs: Any)'
keywordOnlyParameters:
- name: model_version
description: 'The model version to use for the analysis, e.g. "latest".
If a model version is not specified, the API will default to the latest, non-preview
version.
See here for more info: [https://aka.ms/text-analytics-model-versioning](https://aka.ms/text-analytics-model-versioning)'
types:
- <xref:typing.Optional>[<xref:str>]
- name: string_index_type
description: 'Specifies the method used to interpret string offsets.
*UnicodeCodePoint*, the Python encoding, is the default. To override the Python
default,
you can also pass in *Utf16CodeUnit* or *TextElement_v8*. For additional information
see [https://aka.ms/text-analytics-offsets](https://aka.ms/text-analytics-offsets)'
types:
- <xref:typing.Optional>[<xref:str>]
- name: disable_service_logs
description: 'If set to true, you opt-out of having your text input
logged on the service side for troubleshooting. By default, the Language service
logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing
you with
the service''s natural language processing functions. Setting this parameter
to true,
disables input logging and may limit our ability to remediate issues that occur.
Please see
Cognitive Services Compliance and Privacy notes at [https://aka.ms/cs-compliance](https://aka.ms/cs-compliance)
for
additional details, and Microsoft Responsible AI principles at
[https://www.microsoft.com/ai/responsible-ai](https://www.microsoft.com/ai/responsible-ai).'
types:
- <xref:typing.Optional>[<xref:bool>]
methods:
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.get
name: get
signature: 'get(key: str, default: Any | None = None) -> Any'
parameters:
- name: key
isRequired: true
- name: default
defaultValue: None
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.has_key
name: has_key
signature: 'has_key(k: str) -> bool'
parameters:
- name: k
isRequired: true
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.items
name: items
signature: items() -> Iterable[Tuple[str, Any]]
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.keys
name: keys
signature: keys() -> Iterable[str]
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.update
name: update
signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.values
name: values
signature: values() -> Iterable[Any]
attributes:
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.disable_service_logs
name: disable_service_logs
summary: 'If set to true, you opt-out of having your text input
logged on the service side for troubleshooting. By default, the Language service
logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing
you with
the service''s natural language processing functions. Setting this parameter to
true,
disables input logging and may limit our ability to remediate issues that occur.
Please see
Cognitive Services Compliance and Privacy notes at [https://aka.ms/cs-compliance](https://aka.ms/cs-compliance)
for
additional details, and Microsoft Responsible AI principles at
[https://www.microsoft.com/ai/responsible-ai](https://www.microsoft.com/ai/responsible-ai).'
signature: 'disable_service_logs: bool | None = None'
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.model_version
name: model_version
summary: 'The model version to use for the analysis, e.g. "latest".
If a model version is not specified, the API will default to the latest, non-preview
version.
See here for more info: [https://aka.ms/text-analytics-model-versioning](https://aka.ms/text-analytics-model-versioning)'
signature: 'model_version: str | None = None'
- uid: azure.ai.textanalytics.AnalyzeHealthcareEntitiesAction.string_index_type
name: string_index_type
summary: 'Specifies the method used to interpret string offsets.
*UnicodeCodePoint*, the Python encoding, is the default. To override the Python
default,
you can also pass in *Utf16CodeUnit* or *TextElement_v8*. For additional information
see [https://aka.ms/text-analytics-offsets](https://aka.ms/text-analytics-offsets)'
signature: 'string_index_type: str | None = None'