@@ -275,23 +275,8 @@ CountVectorsFeaturizer
275
275
Intent Classifiers
276
276
------------------
277
277
278
- KeywordIntentClassifier
279
- ~~~~~~~~~~~~~~~~~~~~~~~
280
278
281
- :Short: Simple keyword matching intent classifier. Not intended to be used.
282
- :Outputs: ``intent ``
283
- :Requires: nothing
284
- :Output-Example:
285
-
286
- .. code-block :: json
287
-
288
- {
289
- "intent" : {"name" : " greet" , "confidence" : 0.98343 }
290
- }
291
279
292
- :Description:
293
- This classifier is mostly used as a placeholder. It is able to recognize `hello ` and
294
- `goodbye ` intents by searching for these keywords in the passed messages.
295
280
296
281
MitieIntentClassifier
297
282
~~~~~~~~~~~~~~~~~~~~~
@@ -485,6 +470,41 @@ EmbeddingIntentClassifier
485
470
See `starspace paper <https://arxiv.org/abs/1709.03856 >`_ for details.
486
471
487
472
473
+ .. _keyword_intent_classifier :
474
+
475
+ KeywordIntentClassifier
476
+ ~~~~~~~~~~~~~~~~~~~~~~~
477
+
478
+ :Short: Simple keyword matching intent classifier, intended for small, short-term projects.
479
+ :Outputs: ``intent ``
480
+ :Requires: nothing
481
+
482
+ :Output-Example:
483
+
484
+ .. code-block :: json
485
+
486
+ {
487
+ "intent" : {"name" : " greet" , "confidence" : 1.0 }
488
+ }
489
+
490
+ :Description:
491
+ This classifier works by searching a message for keywords.
492
+ The matching is case sensitive by default and searches only for exact matches of the keyword-string in the user message.
493
+ The keywords for an intent are the examples of that intent in the NLU training data.
494
+ This means the entire example is the keyword, not the individual words in the example.
495
+
496
+ .. note :: This classifier is intended only for small projects or to get started. If
497
+ you have few NLU training data you can use one of our pipelines
498
+ :ref: `choosing-a-pipeline `.
499
+
500
+ :Configuration:
501
+
502
+ .. code-block :: yaml
503
+
504
+ pipeline :
505
+ - name : " KeywordIntentClassifier"
506
+ case_sensitive : True
507
+
488
508
Selectors
489
509
----------
490
510
@@ -496,6 +516,7 @@ Response Selector
496
516
:Short: Response Selector
497
517
:Outputs: A dictionary with key as ``direct_response_intent `` and value containing ``response `` and ``ranking ``
498
518
:Requires: A featurizer
519
+
499
520
:Output-Example:
500
521
501
522
.. code-block :: json
0 commit comments