8000 Update luis_recognizer.py · itsmokha/botbuilder-python@3519739 · GitHub
[go: up one dir, main page]

Skip to content

Commit 3519739

Browse files
author
Emily Olshefski
committed
Update luis_recognizer.py
1 parent c44e273 commit 3519739

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

libraries/botbuilder-ai/botbuilder/ai/luis/luis_recognizer.py

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
class LuisRecognizer(Recognizer):
2222
"""
23-
A LUIS based implementation of <see cref="IRecognizer"/>.
23+
A LUIS based implementation of :class:`botbuilder.core.Recognizer`.
2424
"""
2525

2626
# The value type for a LUIS trace activity.
@@ -45,7 +45,7 @@ def __init__(
4545
:type prediction_options: :class:`LuisPredictionOptions`, optional
4646
:param include_api_results: True to include raw LUIS API response, defaults to False.
4747
:type include_api_results: bool, optional
48-
:raises TypeError:
48+
:raises: TypeError
4949
"""
5050

5151
if isinstance(application, LuisApplication):
@@ -79,10 +79,10 @@ def top_intent(
7979
:type results: :class:`botbuilder.core.RecognizerResult`
8080
:param default_intent: Intent name to return should a top intent be found, defaults to None.
8181
: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.
8484
:type min_score: float, optional
85-
:raises TypeError:
85+
:raises: TypeError
8686
:return: The top scoring intent name.
8787
:rtype: str
8888
"""
@@ -108,9 +108,9 @@ async def recognize( # pylint: disable=arguments-differ
108108
telemetry_metrics: Dict[str, float] = None,
109109
luis_prediction_options: LuisPredictionOptions = None,
110110
) -> RecognizerResult:
111-
"""Return results of the analysis (Suggested actions and intents).
111+
"""Return results of the analysis (suggested actions and intents).
112112
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.
114114
:type turn_context: :class:`botbuilder.core.TurnContext`
115115
:param telemetry_properties: Additional properties to be logged to telemetry with the LuisResult event, defaults
116116
to None.
@@ -138,7 +138,7 @@ def on_recognizer_result(
138138
):
139139
"""Invoked prior to a LuisResult being logged.
140140
141-
:param recognizer_result: The Luis Results for the call.
141+
:param recognizer_result: The LuisResult for the call.
142142
:type recognizer_result: :class:`botbuilder.core.RecognizerResult`
143143
:param turn_context: Context object containing information for a single turn of conversation with a user.
144144
:type turn_context: :class:`botbuilder.core.TurnContext`
@@ -187,11 +187,9 @@ def fill_luis_event_properties(
187187
:type recognizer_result: :class:`botbuilder.core.RecognizerResult`
188188
:param turn_context: Context object containing information for a single turn of conversation with a user.
189189
: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.
195193
:rtype: `typing.Dict[str, str]`
196194
"""
197195

0 commit comments

Comments
 (0)
0