diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/models/join_operator.py b/libraries/botbuilder-ai/botbuilder/ai/qna/models/join_operator.py index a454afa81..67b7ba1bd 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/models/join_operator.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/models/join_operator.py @@ -8,7 +8,7 @@ class JoinOperator(str, Enum): """ Join Operator for Strict Filters. - remarks: + remarks -------- For example, when using multiple filters in a query, if you want results that have metadata that matches all filters, then use `AND` operator. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/models/qna_response_context.py b/libraries/botbuilder-ai/botbuilder/ai/qna/models/qna_response_context.py index bf68bb213..643180779 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/models/qna_response_context.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/models/qna_response_context.py @@ -17,7 +17,7 @@ class QnAResponseContext(Model): def __init__(self, **kwargs): """ - Parameters: + Parameters ----------- is_context_only: Whether this prompt is context only. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/models/qnamaker_trace_info.py b/libraries/botbuilder-ai/botbuilder/ai/qna/models/qnamaker_trace_info.py index 16bcc7f8e..1d15a93ed 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/models/qnamaker_trace_info.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/models/qnamaker_trace_info.py @@ -27,7 +27,7 @@ def __init__( ranker_type: str = RankerTypes.DEFAULT, ): """ - Parameters: + Parameters ----------- message: Message which instigated the query to QnA Maker. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/models/query_results.py b/libraries/botbuilder-ai/botbuilder/ai/qna/models/query_results.py index 450f47067..46d2cfa93 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/models/query_results.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/models/query_results.py @@ -18,7 +18,7 @@ def __init__( self, answers: List[QueryResult], active_learning_enabled: bool = None, **kwargs ): """ - Parameters: + Parameters ----------- answers: The answers for a user query. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/qnamaker_options.py b/libraries/botbuilder-ai/botbuilder/ai/qna/qnamaker_options.py index af4a4ad1c..72dfe4e9d 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/qnamaker_options.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/qnamaker_options.py @@ -10,7 +10,7 @@ class QnAMakerOptions: """ Defines options used to configure a `QnAMaker` instance. - remarks: + remarks -------- All parameters are optional. """ @@ -28,7 +28,7 @@ def __init__( strict_filters_join_operator: str = JoinOperator.AND, ): """ - Parameters: + Parameters ----------- score_threshold (float): The minimum score threshold, used to filter returned results. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/active_learning_utils.py b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/active_learning_utils.py index 5a63666a8..3b549ce1c 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/active_learning_utils.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/active_learning_utils.py @@ -22,7 +22,7 @@ def get_low_score_variation( """ Returns a list of QnA search results, which have low score variation. - Parameters: + Parameters ----------- qna_serach_results: A list of QnA QueryResults returned from the QnA GenerateAnswer API call. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/generate_answer_utils.py b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/generate_answer_utils.py index 1f335f9e6..2a8209ec5 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/generate_answer_utils.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/generate_answer_utils.py @@ -41,7 +41,7 @@ def __init__( http_client: ClientSession, ): """ - Parameters: + Parameters ----------- telemetry_client: Telemetry client. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/http_request_utils.py b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/http_request_utils.py index baca83ae0..8251471c7 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/http_request_utils.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/http_request_utils.py @@ -16,7 +16,7 @@ class HttpRequestUtils: """HTTP request utils class. - Parameters: + Parameters ----------- http_client: Client to make HTTP requests with. Default client used in the SDK is `aiohttp.ClientSession`. @@ -35,7 +35,7 @@ async def execute_http_request( """ Execute HTTP request. - Parameters: + Parameters ----------- request_url: HTTP request URL. diff --git a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/train_utils.py b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/train_utils.py index b47eca8f9..c803d79eb 100644 --- a/libraries/botbuilder-ai/botbuilder/ai/qna/utils/train_utils.py +++ b/libraries/botbuilder-ai/botbuilder/ai/qna/utils/train_utils.py @@ -17,7 +17,7 @@ def __init__(self, endpoint: QnAMakerEndpoint, http_client: ClientSession): """ Initializes a new instance for active learning train utils. - Parameters: + Parameters ----------- endpoint: QnA Maker Endpoint of the knowledge base to query. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_factory.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_factory.py index 52bf778b3..0e5edd8e1 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_factory.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_factory.py @@ -26,7 +26,7 @@ def for_channel( Creates a message activity that includes a list of choices formatted based on the capabilities of a given channel. - Parameters: + Parameters ---------- channel_id: A channel ID. choices: List of choices to render @@ -81,7 +81,7 @@ def inline( """ Creates a message activity that includes a list of choices formatted as an inline list. - Parameters: + Parameters ---------- choices: The list of choices to render. text: (Optional) The text of the message to send. @@ -140,7 +140,7 @@ def list_style( """ Creates a message activity that includes a list of choices formatted as a numbered or bulleted list. - Parameters: + Parameters ---------- choices: The list of choices to render. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_recognizers.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_recognizers.py index ec4b226b7..4bdec08c3 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_recognizers.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/choice_recognizers.py @@ -34,7 +34,7 @@ def recognize_choices( - By 1's based ordinal position. - By 1's based index position. - Parameters: + Parameters ----------- utterance: The input. @@ -43,7 +43,7 @@ def recognize_choices( options: (Optional) Options to control the recognition strategy. - Returns: + Returns -------- A list of found choices, sorted by most relevant first. """ diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_choices_options.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_choices_options.py index 4d7c15471..750ab79c6 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_choices_options.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_choices_options.py @@ -16,7 +16,7 @@ def __init__( **kwargs, ): """ - Parameters: + Parameters ----------- no_value: (Optional) If `True`, the choices `value` field will NOT be search over. Defaults to `False`. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_values_options.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_values_options.py index 62ac0acfa..5af0614db 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_values_options.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/find_values_options.py @@ -17,7 +17,7 @@ def __init__( tokenizer: Callable[[str, str], List[Token]] = None, ): """ - Parameters: + Parameters ---------- allow_partial_matches: (Optional) If `True`, then only some of the tokens in a value need to exist to diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_choice.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_choice.py index b32fd09a3..c179eab4c 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_choice.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_choice.py @@ -7,7 +7,7 @@ class FoundChoice: def __init__(self, value: str, index: int, score: float, synonym: str = None): """ - Parameters: + Parameters ---------- value: The value of the choice that was matched. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_value.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_value.py index d25b19052..48e236dc8 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_value.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/found_value.py @@ -7,7 +7,7 @@ class FoundValue: def __init__(self, value: str, index: int, score: float): """ - Parameters: + Parameters ---------- value: The value that was matched. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/model_result.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/model_result.py index d2ec65a1e..b3dbe5beb 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/model_result.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/model_result.py @@ -9,7 +9,7 @@ def __init__( self, text: str, start: int, end: int, type_name: str, resolution: object ): """ - Parameters: + Parameters ---------- text: Substring of the utterance that was recognized. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/sorted_value.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/sorted_value.py index 6a4a2123f..f03c38aef 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/sorted_value.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/sorted_value.py @@ -7,7 +7,7 @@ class SortedValue: def __init__(self, value: str, index: int): """ - Parameters: + Parameters ----------- value: The value that will be sorted. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/token.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/token.py index 63418b322..1b7e028f2 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/token.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/token.py @@ -7,7 +7,7 @@ class Token: def __init__(self, start: int, end: int, text: str, normalized: str): """ - Parameters: + Parameters ---------- start: The index of the first character of the token within the outer input string. diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/tokenizer.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/tokenizer.py index 80d805f14..59e796c84 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/tokenizer.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/choices/tokenizer.py @@ -75,7 +75,7 @@ def _is_breaking_char(code_point) -> bool: @staticmethod def _is_between(value: int, from_val: int, to_val: int) -> bool: """ - Parameters: + Parameters ----------- value: number value