20
20
21
21
class LuisRecognizer (Recognizer ):
22
22
"""
23
- A LUIS based implementation of <see cref="IRecognizer"/> .
23
+ A LUIS based implementation of :class:`botbuilder.core.Recognizer` .
24
24
"""
25
25
26
26
# The value type for a LUIS trace activity.
@@ -45,7 +45,7 @@ def __init__(
45
45
:type prediction_options: :class:`LuisPredictionOptions`, optional
46
46
:param include_api_results: True to include raw LUIS API response, defaults to False.
47
47
:type include_api_results: bool, optional
48
- :raises TypeError:
48
+ :raises: TypeError
49
49
"""
50
50
51
51
if isinstance (application , LuisApplication ):
@@ -79,10 +79,10 @@ def top_intent(
79
79
:type results: :class:`botbuilder.core.RecognizerResult`
80
80
:param default_intent: Intent name to return should a top intent be found, defaults to None.
81
81
:type default_intent: str, optional
82
- :param min_score: Minimum score needed for an intent to be considered as a top intent. If all intents in
83
- the set are below this threshold then the `defaultIntent` will be returned, defaults to 0.0.
82
+ :param min_score: Minimum score needed for an intent to be considered as a top intent. If all
83
+ intents in the set are below this threshold then the `defaultIntent` is returned, defaults to 0.0.
84
84
:type min_score: float, optional
85
- :raises TypeError:
85
+ :raises: TypeError
86
86
:return: The top scoring intent name.
87
87
:rtype: str
88
88
"""
@@ -108,9 +108,9 @@ async def recognize( # pylint: disable=arguments-differ
108
108
telemetry_metrics : Dict [str , float ] = None ,
109
109
luis_prediction_options : LuisPredictionOptions = None ,
110
110
) -> RecognizerResult :
111
- """Return results of the analysis (Suggested actions and intents).
111
+ """Return results of the analysis (suggested actions and intents).
112
112
113
- :param turn_context: Context object containing information for a single turn of conversation with a user.
113
+ :param turn_context: Context object containing information for a single conversation turn with a user.
114
114
:type turn_context: :class:`botbuilder.core.TurnContext`
115
115
:param telemetry_properties: Additional properties to be logged to telemetry with the LuisResult event, defaults
116
116
to None.
@@ -138,7 +138,7 @@ def on_recognizer_result(
138
138
):
139
139
"""Invoked prior to a LuisResult being logged.
140
140
141
- :param recognizer_result: The Luis Results for the call.
141
+ :param recognizer_result: The LuisResult for the call.
142
142
:type recognizer_result: :class:`botbuilder.core.RecognizerResult`
143
143
:param turn_context: Context object containing information for a single turn of conversation with a user.
144
144
:type turn_context: :class:`botbuilder.core.TurnContext`
@@ -187,11 +187,9 @@ def fill_luis_event_properties(
187
187
:type recognizer_result: :class:`botbuilder.core.RecognizerResult`
188
188
:param turn_context: Context object containing information for a single turn of conversation with a user.
189
189
:type turn_context: :class:`botbuilder.core.TurnContext`
190
- :param telemetry_properties: Additional properties to be logged to telemetry with the LuisResult event,
191
- defaults to None
192
- :param telemetry_properties: :class:`typing.Dict[str, str]`, optional
193
- :return: A dictionary that is sent as "Properties" to :func:`botbuilder.core.BotTelemetryClient.track_event`
194
- method for the BotMessageSend event.
190
+ :param telemetry_properties: Additional properties to be logged to telemetry with the LuisResult event, defaults to None.
191
+ :type telemetry_properties: :class:`typing.Dict[str, str]`, optional
192
+ :return: A dictionary sent as "Properties" to :func:`botbuilder.core.BotTelemetryClient.track_event` for the BotMessageSend event.
195
193
:rtype: `typing.Dict[str, str]`
196
194
"""
197
195
0 commit comments