rasa-pro 3.8.16__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of rasa-pro might be problematic. Click here for more details.

Files changed (644) hide show
  1. README.md +380 -0
  2. rasa/__init__.py +10 -0
  3. rasa/__main__.py +151 -0
  4. rasa/anonymization/__init__.py +2 -0
  5. rasa/anonymization/anonymisation_rule_yaml_reader.py +91 -0
  6. rasa/anonymization/anonymization_pipeline.py +287 -0
  7. rasa/anonymization/anonymization_rule_executor.py +260 -0
  8. rasa/anonymization/anonymization_rule_orchestrator.py +120 -0
  9. rasa/anonymization/schemas/config.yml +47 -0
  10. rasa/anonymization/utils.py +117 -0
  11. rasa/api.py +146 -0
  12. rasa/cli/__init__.py +5 -0
  13. rasa/cli/arguments/__init__.py +0 -0
  14. rasa/cli/arguments/data.py +81 -0
  15. rasa/cli/arguments/default_arguments.py +165 -0
  16. rasa/cli/arguments/evaluate.py +65 -0
  17. rasa/cli/arguments/export.py +51 -0
  18. rasa/cli/arguments/interactive.py +74 -0
  19. rasa/cli/arguments/run.py +204 -0
  20. rasa/cli/arguments/shell.py +13 -0
  21. rasa/cli/arguments/test.py +211 -0
  22. rasa/cli/arguments/train.py +263 -0
  23. rasa/cli/arguments/visualize.py +34 -0
  24. rasa/cli/arguments/x.py +30 -0
  25. rasa/cli/data.py +292 -0
  26. rasa/cli/e2e_test.py +566 -0
  27. rasa/cli/evaluate.py +222 -0
  28. rasa/cli/export.py +251 -0
  29. rasa/cli/inspect.py +63 -0
  30. rasa/cli/interactive.py +164 -0
  31. rasa/cli/license.py +65 -0
  32. rasa/cli/markers.py +78 -0
  33. rasa/cli/project_templates/__init__.py +0 -0
  34. rasa/cli/project_templates/calm/actions/__init__.py +0 -0
  35. rasa/cli/project_templates/calm/actions/action_template.py +27 -0
  36. rasa/cli/project_templates/calm/actions/add_contact.py +30 -0
  37. rasa/cli/project_templates/calm/actions/db.py +57 -0
  38. rasa/cli/project_templates/calm/actions/list_contacts.py +22 -0
  39. rasa/cli/project_templates/calm/actions/remove_contact.py +35 -0
  40. rasa/cli/project_templates/calm/config.yml +12 -0
  41. rasa/cli/project_templates/calm/credentials.yml +33 -0
  42. rasa/cli/project_templates/calm/data/flows/add_contact.yml +31 -0
  43. rasa/cli/project_templates/calm/data/flows/list_contacts.yml +14 -0
  44. rasa/cli/project_templates/calm/data/flows/remove_contact.yml +29 -0
  45. rasa/cli/project_templates/calm/db/contacts.json +10 -0
  46. rasa/cli/project_templates/calm/domain/add_contact.yml +33 -0
  47. rasa/cli/project_templates/calm/domain/list_contacts.yml +14 -0
  48. rasa/cli/project_templates/calm/domain/remove_contact.yml +31 -0
  49. rasa/cli/project_templates/calm/domain/shared.yml +5 -0
  50. rasa/cli/project_templates/calm/e2e_tests/cancelations/user_cancels_during_a_correction.yml +16 -0
  51. rasa/cli/project_templates/calm/e2e_tests/cancelations/user_changes_mind_on_a_whim.yml +7 -0
  52. rasa/cli/project_templates/calm/e2e_tests/corrections/user_corrects_contact_handle.yml +20 -0
  53. rasa/cli/project_templates/calm/e2e_tests/corrections/user_corrects_contact_name.yml +19 -0
  54. rasa/cli/project_templates/calm/e2e_tests/happy_paths/user_adds_contact_to_their_list.yml +15 -0
  55. rasa/cli/project_templates/calm/e2e_tests/happy_paths/user_lists_contacts.yml +5 -0
  56. rasa/cli/project_templates/calm/e2e_tests/happy_paths/user_removes_contact.yml +11 -0
  57. rasa/cli/project_templates/calm/e2e_tests/happy_paths/user_removes_contact_from_list.yml +12 -0
  58. rasa/cli/project_templates/calm/endpoints.yml +45 -0
  59. rasa/cli/project_templates/default/actions/__init__.py +0 -0
  60. rasa/cli/project_templates/default/actions/actions.py +27 -0
  61. rasa/cli/project_templates/default/config.yml +44 -0
  62. rasa/cli/project_templates/default/credentials.yml +33 -0
  63. rasa/cli/project_templates/default/data/nlu.yml +91 -0
  64. rasa/cli/project_templates/default/data/rules.yml +13 -0
  65. rasa/cli/project_templates/default/data/stories.yml +30 -0
  66. rasa/cli/project_templates/default/domain.yml +34 -0
  67. rasa/cli/project_templates/default/endpoints.yml +42 -0
  68. rasa/cli/project_templates/default/tests/test_stories.yml +91 -0
  69. rasa/cli/project_templates/tutorial/actions.py +22 -0
  70. rasa/cli/project_templates/tutorial/config.yml +11 -0
  71. rasa/cli/project_templates/tutorial/credentials.yml +33 -0
  72. rasa/cli/project_templates/tutorial/data/flows.yml +8 -0
  73. rasa/cli/project_templates/tutorial/domain.yml +17 -0
  74. rasa/cli/project_templates/tutorial/endpoints.yml +45 -0
  75. rasa/cli/run.py +136 -0
  76. rasa/cli/scaffold.py +268 -0
  77. rasa/cli/shell.py +141 -0
  78. rasa/cli/studio/__init__.py +0 -0
  79. rasa/cli/studio/download.py +51 -0
  80. rasa/cli/studio/studio.py +110 -0
  81. rasa/cli/studio/train.py +59 -0
  82. rasa/cli/studio/upload.py +85 -0
  83. rasa/cli/telemetry.py +90 -0
  84. rasa/cli/test.py +280 -0
  85. rasa/cli/train.py +260 -0
  86. rasa/cli/utils.py +453 -0
  87. rasa/cli/visualize.py +40 -0
  88. rasa/cli/x.py +205 -0
  89. rasa/constants.py +37 -0
  90. rasa/core/__init__.py +17 -0
  91. rasa/core/actions/__init__.py +0 -0
  92. rasa/core/actions/action.py +1450 -0
  93. rasa/core/actions/action_clean_stack.py +59 -0
  94. rasa/core/actions/action_run_slot_rejections.py +207 -0
  95. rasa/core/actions/action_trigger_chitchat.py +31 -0
  96. rasa/core/actions/action_trigger_flow.py +109 -0
  97. rasa/core/actions/action_trigger_search.py +31 -0
  98. rasa/core/actions/constants.py +2 -0
  99. rasa/core/actions/forms.py +737 -0
  100. rasa/core/actions/loops.py +111 -0
  101. rasa/core/actions/two_stage_fallback.py +186 -0
  102. rasa/core/agent.py +557 -0
  103. rasa/core/auth_retry_tracker_store.py +122 -0
  104. rasa/core/brokers/__init__.py +0 -0
  105. rasa/core/brokers/broker.py +126 -0
  106. rasa/core/brokers/file.py +58 -0
  107. rasa/core/brokers/kafka.py +322 -0
  108. rasa/core/brokers/pika.py +387 -0
  109. rasa/core/brokers/sql.py +86 -0
  110. rasa/core/channels/__init__.py +55 -0
  111. rasa/core/channels/audiocodes.py +463 -0
  112. rasa/core/channels/botframework.py +339 -0
  113. rasa/core/channels/callback.py +85 -0
  114. rasa/core/channels/channel.py +419 -0
  115. rasa/core/channels/console.py +243 -0
  116. rasa/core/channels/development_inspector.py +93 -0
  117. rasa/core/channels/facebook.py +422 -0
  118. rasa/core/channels/hangouts.py +335 -0
  119. rasa/core/channels/inspector/.eslintrc.cjs +25 -0
  120. rasa/core/channels/inspector/.gitignore +23 -0
  121. rasa/core/channels/inspector/README.md +54 -0
  122. rasa/core/channels/inspector/assets/favicon.ico +0 -0
  123. rasa/core/channels/inspector/assets/rasa-chat.js +2 -0
  124. rasa/core/channels/inspector/custom.d.ts +3 -0
  125. rasa/core/channels/inspector/dist/assets/arc-5623b6dc.js +1 -0
  126. rasa/core/channels/inspector/dist/assets/array-9f3ba611.js +1 -0
  127. rasa/core/channels/inspector/dist/assets/c4Diagram-d0fbc5ce-685c106a.js +10 -0
  128. rasa/core/channels/inspector/dist/assets/classDiagram-936ed81e-8cbed007.js +2 -0
  129. rasa/core/channels/inspector/dist/assets/classDiagram-v2-c3cb15f1-5889cf12.js +2 -0
  130. rasa/core/channels/inspector/dist/assets/createText-62fc7601-24c249d7.js +7 -0
  131. rasa/core/channels/inspector/dist/assets/edges-f2ad444c-7dd06a75.js +4 -0
  132. rasa/core/channels/inspector/dist/assets/erDiagram-9d236eb7-62c1e54c.js +51 -0
  133. rasa/core/channels/inspector/dist/assets/flowDb-1972c806-ce49b86f.js +6 -0
  134. rasa/core/channels/inspector/dist/assets/flowDiagram-7ea5b25a-4067e48f.js +4 -0
  135. rasa/core/channels/inspector/dist/assets/flowDiagram-v2-855bc5b3-85583a23.js +1 -0
  136. rasa/core/channels/inspector/dist/assets/flowchart-elk-definition-abe16c3d-59fe4051.js +139 -0
  137. rasa/core/channels/inspector/dist/assets/ganttDiagram-9b5ea136-47e3a43b.js +266 -0
  138. rasa/core/channels/inspector/dist/assets/gitGraphDiagram-99d0ae7c-5a2ac0d9.js +70 -0
  139. rasa/core/channels/inspector/dist/assets/ibm-plex-mono-v4-latin-regular-128cfa44.ttf +0 -0
  140. rasa/core/channels/inspector/dist/assets/ibm-plex-mono-v4-latin-regular-21dbcb97.woff +0 -0
  141. rasa/core/channels/inspector/dist/assets/ibm-plex-mono-v4-latin-regular-222b5e26.svg +329 -0
  142. rasa/core/channels/inspector/dist/assets/ibm-plex-mono-v4-latin-regular-9ad89b2a.woff2 +0 -0
  143. rasa/core/channels/inspector/dist/assets/index-268a75c0.js +1040 -0
  144. rasa/core/channels/inspector/dist/assets/index-2c4b9a3b-dfb8efc4.js +1 -0
  145. rasa/core/channels/inspector/dist/assets/index-3ee28881.css +1 -0
  146. rasa/core/channels/inspector/dist/assets/infoDiagram-736b4530-b0c470f2.js +7 -0
  147. rasa/core/channels/inspector/dist/assets/init-77b53fdd.js +1 -0
  148. rasa/core/channels/inspector/dist/assets/journeyDiagram-df861f2b-2edb829a.js +139 -0
  149. rasa/core/channels/inspector/dist/assets/lato-v14-latin-700-60c05ee4.woff +0 -0
  150. rasa/core/channels/inspector/dist/assets/lato-v14-latin-700-8335d9b8.svg +438 -0
  151. rasa/core/channels/inspector/dist/assets/lato-v14-latin-700-9cc39c75.ttf +0 -0
  152. rasa/core/channels/inspector/dist/assets/lato-v14-latin-700-ead13ccf.woff2 +0 -0
  153. rasa/core/channels/inspector/dist/assets/lato-v14-latin-regular-16705655.woff2 +0 -0
  154. rasa/core/channels/inspector/dist/assets/lato-v14-latin-regular-5aeb07f9.woff +0 -0
  155. rasa/core/channels/inspector/dist/assets/lato-v14-latin-regular-9c459044.ttf +0 -0
  156. rasa/core/channels/inspector/dist/assets/lato-v14-latin-regular-9e2898a4.svg +435 -0
  157. rasa/core/channels/inspector/dist/assets/layout-b6873d69.js +1 -0
  158. rasa/core/channels/inspector/dist/assets/line-1efc5781.js +1 -0
  159. rasa/core/channels/inspector/dist/assets/linear-661e9b94.js +1 -0
  160. rasa/core/channels/inspector/dist/assets/mindmap-definition-beec6740-2d2e727f.js +109 -0
  161. rasa/core/channels/inspector/dist/assets/ordinal-ba9b4969.js +1 -0
  162. rasa/core/channels/inspector/dist/assets/path-53f90ab3.js +1 -0
  163. rasa/core/channels/inspector/dist/assets/pieDiagram-dbbf0591-9d3ea93d.js +35 -0
  164. rasa/core/channels/inspector/dist/assets/quadrantDiagram-4d7f4fd6-06a178a2.js +7 -0
  165. rasa/core/channels/inspector/dist/assets/requirementDiagram-6fc4c22a-0bfedffc.js +52 -0
  166. rasa/core/channels/inspector/dist/assets/sankeyDiagram-8f13d901-d76d0a04.js +8 -0
  167. rasa/core/channels/inspector/dist/assets/sequenceDiagram-b655622a-37bb4341.js +122 -0
  168. rasa/core/channels/inspector/dist/assets/stateDiagram-59f0c015-f52f7f57.js +1 -0
  169. rasa/core/channels/inspector/dist/assets/stateDiagram-v2-2b26beab-4a986a20.js +1 -0
  170. rasa/core/channels/inspector/dist/assets/styles-080da4f6-7dd9ae12.js +110 -0
  171. rasa/core/channels/inspector/dist/assets/styles-3dcbcfbf-46e1ca14.js +159 -0
  172. rasa/core/channels/inspector/dist/assets/styles-9c745c82-4a97439a.js +207 -0
  173. rasa/core/channels/inspector/dist/assets/svgDrawCommon-4835440b-823917a3.js +1 -0
  174. rasa/core/channels/inspector/dist/assets/timeline-definition-5b62e21b-9ea72896.js +61 -0
  175. rasa/core/channels/inspector/dist/assets/xychartDiagram-2b33534f-b631a8b6.js +7 -0
  176. rasa/core/channels/inspector/dist/index.html +39 -0
  177. rasa/core/channels/inspector/index.html +37 -0
  178. rasa/core/channels/inspector/jest.config.ts +13 -0
  179. rasa/core/channels/inspector/package.json +48 -0
  180. rasa/core/channels/inspector/setupTests.ts +2 -0
  181. rasa/core/channels/inspector/src/App.tsx +170 -0
  182. rasa/core/channels/inspector/src/components/DiagramFlow.tsx +97 -0
  183. rasa/core/channels/inspector/src/components/DialogueInformation.tsx +187 -0
  184. rasa/core/channels/inspector/src/components/DialogueStack.tsx +151 -0
  185. rasa/core/channels/inspector/src/components/ExpandIcon.tsx +16 -0
  186. rasa/core/channels/inspector/src/components/FullscreenButton.tsx +45 -0
  187. rasa/core/channels/inspector/src/components/LoadingSpinner.tsx +19 -0
  188. rasa/core/channels/inspector/src/components/NoActiveFlow.tsx +21 -0
  189. rasa/core/channels/inspector/src/components/RasaLogo.tsx +32 -0
  190. rasa/core/channels/inspector/src/components/SaraDiagrams.tsx +39 -0
  191. rasa/core/channels/inspector/src/components/Slots.tsx +91 -0
  192. rasa/core/channels/inspector/src/components/Welcome.tsx +54 -0
  193. rasa/core/channels/inspector/src/helpers/formatters.test.ts +385 -0
  194. rasa/core/channels/inspector/src/helpers/formatters.ts +239 -0
  195. rasa/core/channels/inspector/src/helpers/utils.ts +42 -0
  196. rasa/core/channels/inspector/src/main.tsx +13 -0
  197. rasa/core/channels/inspector/src/theme/Button/Button.ts +29 -0
  198. rasa/core/channels/inspector/src/theme/Heading/Heading.ts +31 -0
  199. rasa/core/channels/inspector/src/theme/Input/Input.ts +27 -0
  200. rasa/core/channels/inspector/src/theme/Link/Link.ts +10 -0
  201. rasa/core/channels/inspector/src/theme/Modal/Modal.ts +47 -0
  202. rasa/core/channels/inspector/src/theme/Table/Table.tsx +38 -0
  203. rasa/core/channels/inspector/src/theme/Tooltip/Tooltip.ts +12 -0
  204. rasa/core/channels/inspector/src/theme/base/breakpoints.ts +8 -0
  205. rasa/core/channels/inspector/src/theme/base/colors.ts +88 -0
  206. rasa/core/channels/inspector/src/theme/base/fonts/fontFaces.css +29 -0
  207. rasa/core/channels/inspector/src/theme/base/fonts/ibm-plex-mono-v4-latin/ibm-plex-mono-v4-latin-regular.eot +0 -0
  208. rasa/core/channels/inspector/src/theme/base/fonts/ibm-plex-mono-v4-latin/ibm-plex-mono-v4-latin-regular.svg +329 -0
  209. rasa/core/channels/inspector/src/theme/base/fonts/ibm-plex-mono-v4-latin/ibm-plex-mono-v4-latin-regular.ttf +0 -0
  210. rasa/core/channels/inspector/src/theme/base/fonts/ibm-plex-mono-v4-latin/ibm-plex-mono-v4-latin-regular.woff +0 -0
  211. rasa/core/channels/inspector/src/theme/base/fonts/ibm-plex-mono-v4-latin/ibm-plex-mono-v4-latin-regular.woff2 +0 -0
  212. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-700.eot +0 -0
  213. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-700.svg +438 -0
  214. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-700.ttf +0 -0
  215. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-700.woff +0 -0
  216. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-700.woff2 +0 -0
  217. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-regular.eot +0 -0
  218. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-regular.svg +435 -0
  219. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-regular.ttf +0 -0
  220. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-regular.woff +0 -0
  221. rasa/core/channels/inspector/src/theme/base/fonts/lato-v14-latin/lato-v14-latin-regular.woff2 +0 -0
  222. rasa/core/channels/inspector/src/theme/base/radii.ts +9 -0
  223. rasa/core/channels/inspector/src/theme/base/shadows.ts +7 -0
  224. rasa/core/channels/inspector/src/theme/base/sizes.ts +7 -0
  225. rasa/core/channels/inspector/src/theme/base/space.ts +15 -0
  226. rasa/core/channels/inspector/src/theme/base/styles.ts +13 -0
  227. rasa/core/channels/inspector/src/theme/base/typography.ts +24 -0
  228. rasa/core/channels/inspector/src/theme/base/zIndices.ts +19 -0
  229. rasa/core/channels/inspector/src/theme/index.ts +101 -0
  230. rasa/core/channels/inspector/src/types.ts +64 -0
  231. rasa/core/channels/inspector/src/vite-env.d.ts +1 -0
  232. rasa/core/channels/inspector/tests/__mocks__/fileMock.ts +1 -0
  233. rasa/core/channels/inspector/tests/__mocks__/matchMedia.ts +16 -0
  234. rasa/core/channels/inspector/tests/__mocks__/styleMock.ts +1 -0
  235. rasa/core/channels/inspector/tests/renderWithProviders.tsx +14 -0
  236. rasa/core/channels/inspector/tsconfig.json +26 -0
  237. rasa/core/channels/inspector/tsconfig.node.json +10 -0
  238. rasa/core/channels/inspector/vite.config.ts +8 -0
  239. rasa/core/channels/inspector/yarn.lock +6156 -0
  240. rasa/core/channels/mattermost.py +229 -0
  241. rasa/core/channels/rasa_chat.py +126 -0
  242. rasa/core/channels/rest.py +210 -0
  243. rasa/core/channels/rocketchat.py +175 -0
  244. rasa/core/channels/slack.py +620 -0
  245. rasa/core/channels/socketio.py +274 -0
  246. rasa/core/channels/telegram.py +298 -0
  247. rasa/core/channels/twilio.py +169 -0
  248. rasa/core/channels/twilio_voice.py +367 -0
  249. rasa/core/channels/vier_cvg.py +374 -0
  250. rasa/core/channels/webexteams.py +135 -0
  251. rasa/core/concurrent_lock_store.py +210 -0
  252. rasa/core/constants.py +107 -0
  253. rasa/core/evaluation/__init__.py +0 -0
  254. rasa/core/evaluation/marker.py +267 -0
  255. rasa/core/evaluation/marker_base.py +925 -0
  256. rasa/core/evaluation/marker_stats.py +294 -0
  257. rasa/core/evaluation/marker_tracker_loader.py +103 -0
  258. rasa/core/exceptions.py +29 -0
  259. rasa/core/exporter.py +284 -0
  260. rasa/core/featurizers/__init__.py +0 -0
  261. rasa/core/featurizers/precomputation.py +410 -0
  262. rasa/core/featurizers/single_state_featurizer.py +402 -0
  263. rasa/core/featurizers/tracker_featurizers.py +1172 -0
  264. rasa/core/http_interpreter.py +89 -0
  265. rasa/core/information_retrieval/__init__.py +0 -0
  266. rasa/core/information_retrieval/faiss.py +116 -0
  267. rasa/core/information_retrieval/information_retrieval.py +72 -0
  268. rasa/core/information_retrieval/milvus.py +59 -0
  269. rasa/core/information_retrieval/qdrant.py +102 -0
  270. rasa/core/jobs.py +63 -0
  271. rasa/core/lock.py +139 -0
  272. rasa/core/lock_store.py +344 -0
  273. rasa/core/migrate.py +404 -0
  274. rasa/core/nlg/__init__.py +3 -0
  275. rasa/core/nlg/callback.py +147 -0
  276. rasa/core/nlg/contextual_response_rephraser.py +270 -0
  277. rasa/core/nlg/generator.py +230 -0
  278. rasa/core/nlg/interpolator.py +143 -0
  279. rasa/core/nlg/response.py +155 -0
  280. rasa/core/nlg/summarize.py +69 -0
  281. rasa/core/policies/__init__.py +0 -0
  282. rasa/core/policies/ensemble.py +329 -0
  283. rasa/core/policies/enterprise_search_policy.py +717 -0
  284. rasa/core/policies/enterprise_search_prompt_template.jinja2 +62 -0
  285. rasa/core/policies/flow_policy.py +205 -0
  286. rasa/core/policies/flows/__init__.py +0 -0
  287. rasa/core/policies/flows/flow_exceptions.py +44 -0
  288. rasa/core/policies/flows/flow_executor.py +582 -0
  289. rasa/core/policies/flows/flow_step_result.py +43 -0
  290. rasa/core/policies/intentless_policy.py +924 -0
  291. rasa/core/policies/intentless_prompt_template.jinja2 +22 -0
  292. rasa/core/policies/memoization.py +538 -0
  293. rasa/core/policies/policy.py +716 -0
  294. rasa/core/policies/rule_policy.py +1276 -0
  295. rasa/core/policies/ted_policy.py +2146 -0
  296. rasa/core/policies/unexpected_intent_policy.py +1015 -0
  297. rasa/core/processor.py +1331 -0
  298. rasa/core/run.py +315 -0
  299. rasa/core/secrets_manager/__init__.py +0 -0
  300. rasa/core/secrets_manager/constants.py +32 -0
  301. rasa/core/secrets_manager/endpoints.py +391 -0
  302. rasa/core/secrets_manager/factory.py +233 -0
  303. rasa/core/secrets_manager/secret_manager.py +262 -0
  304. rasa/core/secrets_manager/vault.py +576 -0
  305. rasa/core/test.py +1337 -0
  306. rasa/core/tracker_store.py +1664 -0
  307. rasa/core/train.py +107 -0
  308. rasa/core/training/__init__.py +89 -0
  309. rasa/core/training/converters/__init__.py +0 -0
  310. rasa/core/training/converters/responses_prefix_converter.py +119 -0
  311. rasa/core/training/interactive.py +1742 -0
  312. rasa/core/training/story_conflict.py +381 -0
  313. rasa/core/training/training.py +93 -0
  314. rasa/core/utils.py +344 -0
  315. rasa/core/visualize.py +70 -0
  316. rasa/dialogue_understanding/__init__.py +0 -0
  317. rasa/dialogue_understanding/coexistence/__init__.py +0 -0
  318. rasa/dialogue_understanding/coexistence/constants.py +4 -0
  319. rasa/dialogue_understanding/coexistence/intent_based_router.py +189 -0
  320. rasa/dialogue_understanding/coexistence/llm_based_router.py +261 -0
  321. rasa/dialogue_understanding/coexistence/router_template.jinja2 +12 -0
  322. rasa/dialogue_understanding/commands/__init__.py +45 -0
  323. rasa/dialogue_understanding/commands/can_not_handle_command.py +61 -0
  324. rasa/dialogue_understanding/commands/cancel_flow_command.py +116 -0
  325. rasa/dialogue_understanding/commands/chit_chat_answer_command.py +48 -0
  326. rasa/dialogue_understanding/commands/clarify_command.py +77 -0
  327. rasa/dialogue_understanding/commands/command.py +85 -0
  328. rasa/dialogue_understanding/commands/correct_slots_command.py +288 -0
  329. rasa/dialogue_understanding/commands/error_command.py +67 -0
  330. rasa/dialogue_understanding/commands/free_form_answer_command.py +9 -0
  331. rasa/dialogue_understanding/commands/handle_code_change_command.py +64 -0
  332. rasa/dialogue_understanding/commands/human_handoff_command.py +57 -0
  333. rasa/dialogue_understanding/commands/knowledge_answer_command.py +48 -0
  334. rasa/dialogue_understanding/commands/noop_command.py +45 -0
  335. rasa/dialogue_understanding/commands/set_slot_command.py +125 -0
  336. rasa/dialogue_understanding/commands/skip_question_command.py +66 -0
  337. rasa/dialogue_understanding/commands/start_flow_command.py +98 -0
  338. rasa/dialogue_understanding/generator/__init__.py +6 -0
  339. rasa/dialogue_understanding/generator/command_generator.py +257 -0
  340. rasa/dialogue_understanding/generator/command_prompt_template.jinja2 +57 -0
  341. rasa/dialogue_understanding/generator/flow_document_template.jinja2 +4 -0
  342. rasa/dialogue_understanding/generator/flow_retrieval.py +410 -0
  343. rasa/dialogue_understanding/generator/llm_command_generator.py +637 -0
  344. rasa/dialogue_understanding/generator/nlu_command_adapter.py +157 -0
  345. rasa/dialogue_understanding/patterns/__init__.py +0 -0
  346. rasa/dialogue_understanding/patterns/cancel.py +111 -0
  347. rasa/dialogue_understanding/patterns/cannot_handle.py +43 -0
  348. rasa/dialogue_understanding/patterns/chitchat.py +37 -0
  349. rasa/dialogue_understanding/patterns/clarify.py +97 -0
  350. rasa/dialogue_understanding/patterns/code_change.py +41 -0
  351. rasa/dialogue_understanding/patterns/collect_information.py +90 -0
  352. rasa/dialogue_understanding/patterns/completed.py +40 -0
  353. rasa/dialogue_understanding/patterns/continue_interrupted.py +42 -0
  354. rasa/dialogue_understanding/patterns/correction.py +278 -0
  355. rasa/dialogue_understanding/patterns/default_flows_for_patterns.yml +243 -0
  356. rasa/dialogue_understanding/patterns/human_handoff.py +37 -0
  357. rasa/dialogue_understanding/patterns/internal_error.py +47 -0
  358. rasa/dialogue_understanding/patterns/search.py +37 -0
  359. rasa/dialogue_understanding/patterns/skip_question.py +38 -0
  360. rasa/dialogue_understanding/processor/__init__.py +0 -0
  361. rasa/dialogue_understanding/processor/command_processor.py +578 -0
  362. rasa/dialogue_understanding/processor/command_processor_component.py +39 -0
  363. rasa/dialogue_understanding/stack/__init__.py +0 -0
  364. rasa/dialogue_understanding/stack/dialogue_stack.py +178 -0
  365. rasa/dialogue_understanding/stack/frames/__init__.py +19 -0
  366. rasa/dialogue_understanding/stack/frames/chit_chat_frame.py +27 -0
  367. rasa/dialogue_understanding/stack/frames/dialogue_stack_frame.py +137 -0
  368. rasa/dialogue_understanding/stack/frames/flow_stack_frame.py +157 -0
  369. rasa/dialogue_understanding/stack/frames/pattern_frame.py +10 -0
  370. rasa/dialogue_understanding/stack/frames/search_frame.py +27 -0
  371. rasa/dialogue_understanding/stack/utils.py +211 -0
  372. rasa/e2e_test/__init__.py +0 -0
  373. rasa/e2e_test/constants.py +10 -0
  374. rasa/e2e_test/e2e_test_case.py +322 -0
  375. rasa/e2e_test/e2e_test_result.py +34 -0
  376. rasa/e2e_test/e2e_test_runner.py +659 -0
  377. rasa/e2e_test/e2e_test_schema.yml +67 -0
  378. rasa/engine/__init__.py +0 -0
  379. rasa/engine/caching.py +464 -0
  380. rasa/engine/constants.py +17 -0
  381. rasa/engine/exceptions.py +14 -0
  382. rasa/engine/graph.py +625 -0
  383. rasa/engine/loader.py +36 -0
  384. rasa/engine/recipes/__init__.py +0 -0
  385. rasa/engine/recipes/config_files/default_config.yml +44 -0
  386. rasa/engine/recipes/default_components.py +99 -0
  387. rasa/engine/recipes/default_recipe.py +1252 -0
  388. rasa/engine/recipes/graph_recipe.py +79 -0
  389. rasa/engine/recipes/recipe.py +93 -0
  390. rasa/engine/runner/__init__.py +0 -0
  391. rasa/engine/runner/dask.py +256 -0
  392. rasa/engine/runner/interface.py +49 -0
  393. rasa/engine/storage/__init__.py +0 -0
  394. rasa/engine/storage/local_model_storage.py +248 -0
  395. rasa/engine/storage/resource.py +110 -0
  396. rasa/engine/storage/storage.py +203 -0
  397. rasa/engine/training/__init__.py +0 -0
  398. rasa/engine/training/components.py +176 -0
  399. rasa/engine/training/fingerprinting.py +64 -0
  400. rasa/engine/training/graph_trainer.py +256 -0
  401. rasa/engine/training/hooks.py +164 -0
  402. rasa/engine/validation.py +839 -0
  403. rasa/env.py +5 -0
  404. rasa/exceptions.py +69 -0
  405. rasa/graph_components/__init__.py +0 -0
  406. rasa/graph_components/converters/__init__.py +0 -0
  407. rasa/graph_components/converters/nlu_message_converter.py +48 -0
  408. rasa/graph_components/providers/__init__.py +0 -0
  409. rasa/graph_components/providers/domain_for_core_training_provider.py +87 -0
  410. rasa/graph_components/providers/domain_provider.py +71 -0
  411. rasa/graph_components/providers/flows_provider.py +74 -0
  412. rasa/graph_components/providers/forms_provider.py +44 -0
  413. rasa/graph_components/providers/nlu_training_data_provider.py +56 -0
  414. rasa/graph_components/providers/responses_provider.py +44 -0
  415. rasa/graph_components/providers/rule_only_provider.py +49 -0
  416. rasa/graph_components/providers/story_graph_provider.py +43 -0
  417. rasa/graph_components/providers/training_tracker_provider.py +55 -0
  418. rasa/graph_components/validators/__init__.py +0 -0
  419. rasa/graph_components/validators/default_recipe_validator.py +552 -0
  420. rasa/graph_components/validators/finetuning_validator.py +302 -0
  421. rasa/hooks.py +113 -0
  422. rasa/jupyter.py +63 -0
  423. rasa/keys +1 -0
  424. rasa/markers/__init__.py +0 -0
  425. rasa/markers/marker.py +269 -0
  426. rasa/markers/marker_base.py +828 -0
  427. rasa/markers/upload.py +74 -0
  428. rasa/markers/validate.py +21 -0
  429. rasa/model.py +118 -0
  430. rasa/model_testing.py +457 -0
  431. rasa/model_training.py +535 -0
  432. rasa/nlu/__init__.py +7 -0
  433. rasa/nlu/classifiers/__init__.py +3 -0
  434. rasa/nlu/classifiers/classifier.py +5 -0
  435. rasa/nlu/classifiers/diet_classifier.py +1874 -0
  436. rasa/nlu/classifiers/fallback_classifier.py +192 -0
  437. rasa/nlu/classifiers/keyword_intent_classifier.py +188 -0
  438. rasa/nlu/classifiers/llm_intent_classifier.py +519 -0
  439. rasa/nlu/classifiers/logistic_regression_classifier.py +240 -0
  440. rasa/nlu/classifiers/mitie_intent_classifier.py +156 -0
  441. rasa/nlu/classifiers/regex_message_handler.py +56 -0
  442. rasa/nlu/classifiers/sklearn_intent_classifier.py +309 -0
  443. rasa/nlu/constants.py +77 -0
  444. rasa/nlu/convert.py +40 -0
  445. rasa/nlu/emulators/__init__.py +0 -0
  446. rasa/nlu/emulators/dialogflow.py +55 -0
  447. rasa/nlu/emulators/emulator.py +49 -0
  448. rasa/nlu/emulators/luis.py +86 -0
  449. rasa/nlu/emulators/no_emulator.py +10 -0
  450. rasa/nlu/emulators/wit.py +56 -0
  451. rasa/nlu/extractors/__init__.py +0 -0
  452. rasa/nlu/extractors/crf_entity_extractor.py +672 -0
  453. rasa/nlu/extractors/duckling_entity_extractor.py +206 -0
  454. rasa/nlu/extractors/entity_synonyms.py +178 -0
  455. rasa/nlu/extractors/extractor.py +470 -0
  456. rasa/nlu/extractors/mitie_entity_extractor.py +293 -0
  457. rasa/nlu/extractors/regex_entity_extractor.py +220 -0
  458. rasa/nlu/extractors/spacy_entity_extractor.py +95 -0
  459. rasa/nlu/featurizers/__init__.py +0 -0
  460. rasa/nlu/featurizers/dense_featurizer/__init__.py +0 -0
  461. rasa/nlu/featurizers/dense_featurizer/convert_featurizer.py +449 -0
  462. rasa/nlu/featurizers/dense_featurizer/dense_featurizer.py +57 -0
  463. rasa/nlu/featurizers/dense_featurizer/lm_featurizer.py +772 -0
  464. rasa/nlu/featurizers/dense_featurizer/mitie_featurizer.py +170 -0
  465. rasa/nlu/featurizers/dense_featurizer/spacy_featurizer.py +132 -0
  466. rasa/nlu/featurizers/featurizer.py +89 -0
  467. rasa/nlu/featurizers/sparse_featurizer/__init__.py +0 -0
  468. rasa/nlu/featurizers/sparse_featurizer/count_vectors_featurizer.py +840 -0
  469. rasa/nlu/featurizers/sparse_featurizer/lexical_syntactic_featurizer.py +539 -0
  470. rasa/nlu/featurizers/sparse_featurizer/regex_featurizer.py +269 -0
  471. rasa/nlu/featurizers/sparse_featurizer/sparse_featurizer.py +9 -0
  472. rasa/nlu/model.py +24 -0
  473. rasa/nlu/persistor.py +240 -0
  474. rasa/nlu/run.py +27 -0
  475. rasa/nlu/selectors/__init__.py +0 -0
  476. rasa/nlu/selectors/response_selector.py +990 -0
  477. rasa/nlu/test.py +1943 -0
  478. rasa/nlu/tokenizers/__init__.py +0 -0
  479. rasa/nlu/tokenizers/jieba_tokenizer.py +148 -0
  480. rasa/nlu/tokenizers/mitie_tokenizer.py +75 -0
  481. rasa/nlu/tokenizers/spacy_tokenizer.py +72 -0
  482. rasa/nlu/tokenizers/tokenizer.py +239 -0
  483. rasa/nlu/tokenizers/whitespace_tokenizer.py +106 -0
  484. rasa/nlu/utils/__init__.py +35 -0
  485. rasa/nlu/utils/bilou_utils.py +462 -0
  486. rasa/nlu/utils/hugging_face/__init__.py +0 -0
  487. rasa/nlu/utils/hugging_face/registry.py +108 -0
  488. rasa/nlu/utils/hugging_face/transformers_pre_post_processors.py +311 -0
  489. rasa/nlu/utils/mitie_utils.py +113 -0
  490. rasa/nlu/utils/pattern_utils.py +168 -0
  491. rasa/nlu/utils/spacy_utils.py +312 -0
  492. rasa/plugin.py +90 -0
  493. rasa/server.py +1536 -0
  494. rasa/shared/__init__.py +0 -0
  495. rasa/shared/constants.py +181 -0
  496. rasa/shared/core/__init__.py +0 -0
  497. rasa/shared/core/constants.py +168 -0
  498. rasa/shared/core/conversation.py +46 -0
  499. rasa/shared/core/domain.py +2106 -0
  500. rasa/shared/core/events.py +2507 -0
  501. rasa/shared/core/flows/__init__.py +7 -0
  502. rasa/shared/core/flows/flow.py +353 -0
  503. rasa/shared/core/flows/flow_step.py +146 -0
  504. rasa/shared/core/flows/flow_step_links.py +319 -0
  505. rasa/shared/core/flows/flow_step_sequence.py +70 -0
  506. rasa/shared/core/flows/flows_list.py +211 -0
  507. rasa/shared/core/flows/flows_yaml_schema.json +217 -0
  508. rasa/shared/core/flows/nlu_trigger.py +117 -0
  509. rasa/shared/core/flows/steps/__init__.py +24 -0
  510. rasa/shared/core/flows/steps/action.py +51 -0
  511. rasa/shared/core/flows/steps/call.py +64 -0
  512. rasa/shared/core/flows/steps/collect.py +112 -0
  513. rasa/shared/core/flows/steps/constants.py +5 -0
  514. rasa/shared/core/flows/steps/continuation.py +36 -0
  515. rasa/shared/core/flows/steps/end.py +22 -0
  516. rasa/shared/core/flows/steps/internal.py +44 -0
  517. rasa/shared/core/flows/steps/link.py +51 -0
  518. rasa/shared/core/flows/steps/no_operation.py +48 -0
  519. rasa/shared/core/flows/steps/set_slots.py +50 -0
  520. rasa/shared/core/flows/steps/start.py +30 -0
  521. rasa/shared/core/flows/validation.py +527 -0
  522. rasa/shared/core/flows/yaml_flows_io.py +278 -0
  523. rasa/shared/core/generator.py +907 -0
  524. rasa/shared/core/slot_mappings.py +235 -0
  525. rasa/shared/core/slots.py +647 -0
  526. rasa/shared/core/trackers.py +1159 -0
  527. rasa/shared/core/training_data/__init__.py +0 -0
  528. rasa/shared/core/training_data/loading.py +90 -0
  529. rasa/shared/core/training_data/story_reader/__init__.py +0 -0
  530. rasa/shared/core/training_data/story_reader/story_reader.py +129 -0
  531. rasa/shared/core/training_data/story_reader/story_step_builder.py +168 -0
  532. rasa/shared/core/training_data/story_reader/yaml_story_reader.py +888 -0
  533. rasa/shared/core/training_data/story_writer/__init__.py +0 -0
  534. rasa/shared/core/training_data/story_writer/story_writer.py +76 -0
  535. rasa/shared/core/training_data/story_writer/yaml_story_writer.py +442 -0
  536. rasa/shared/core/training_data/structures.py +838 -0
  537. rasa/shared/core/training_data/visualization.html +146 -0
  538. rasa/shared/core/training_data/visualization.py +603 -0
  539. rasa/shared/data.py +192 -0
  540. rasa/shared/engine/__init__.py +0 -0
  541. rasa/shared/engine/caching.py +26 -0
  542. rasa/shared/exceptions.py +129 -0
  543. rasa/shared/importers/__init__.py +0 -0
  544. rasa/shared/importers/importer.py +705 -0
  545. rasa/shared/importers/multi_project.py +203 -0
  546. rasa/shared/importers/rasa.py +100 -0
  547. rasa/shared/importers/utils.py +34 -0
  548. rasa/shared/nlu/__init__.py +0 -0
  549. rasa/shared/nlu/constants.py +45 -0
  550. rasa/shared/nlu/interpreter.py +10 -0
  551. rasa/shared/nlu/training_data/__init__.py +0 -0
  552. rasa/shared/nlu/training_data/entities_parser.py +209 -0
  553. rasa/shared/nlu/training_data/features.py +374 -0
  554. rasa/shared/nlu/training_data/formats/__init__.py +10 -0
  555. rasa/shared/nlu/training_data/formats/dialogflow.py +162 -0
  556. rasa/shared/nlu/training_data/formats/luis.py +87 -0
  557. rasa/shared/nlu/training_data/formats/rasa.py +135 -0
  558. rasa/shared/nlu/training_data/formats/rasa_yaml.py +605 -0
  559. rasa/shared/nlu/training_data/formats/readerwriter.py +245 -0
  560. rasa/shared/nlu/training_data/formats/wit.py +52 -0
  561. rasa/shared/nlu/training_data/loading.py +137 -0
  562. rasa/shared/nlu/training_data/lookup_tables_parser.py +30 -0
  563. rasa/shared/nlu/training_data/message.py +477 -0
  564. rasa/shared/nlu/training_data/schemas/__init__.py +0 -0
  565. rasa/shared/nlu/training_data/schemas/data_schema.py +85 -0
  566. rasa/shared/nlu/training_data/schemas/nlu.yml +53 -0
  567. rasa/shared/nlu/training_data/schemas/responses.yml +70 -0
  568. rasa/shared/nlu/training_data/synonyms_parser.py +42 -0
  569. rasa/shared/nlu/training_data/training_data.py +732 -0
  570. rasa/shared/nlu/training_data/util.py +223 -0
  571. rasa/shared/providers/__init__.py +0 -0
  572. rasa/shared/providers/openai/__init__.py +0 -0
  573. rasa/shared/providers/openai/clients.py +43 -0
  574. rasa/shared/providers/openai/session_handler.py +110 -0
  575. rasa/shared/utils/__init__.py +0 -0
  576. rasa/shared/utils/cli.py +72 -0
  577. rasa/shared/utils/common.py +308 -0
  578. rasa/shared/utils/constants.py +1 -0
  579. rasa/shared/utils/io.py +403 -0
  580. rasa/shared/utils/llm.py +405 -0
  581. rasa/shared/utils/pykwalify_extensions.py +26 -0
  582. rasa/shared/utils/schemas/__init__.py +0 -0
  583. rasa/shared/utils/schemas/config.yml +2 -0
  584. rasa/shared/utils/schemas/domain.yml +142 -0
  585. rasa/shared/utils/schemas/events.py +212 -0
  586. rasa/shared/utils/schemas/model_config.yml +46 -0
  587. rasa/shared/utils/schemas/stories.yml +173 -0
  588. rasa/shared/utils/yaml.py +777 -0
  589. rasa/studio/__init__.py +0 -0
  590. rasa/studio/auth.py +252 -0
  591. rasa/studio/config.py +127 -0
  592. rasa/studio/constants.py +16 -0
  593. rasa/studio/data_handler.py +352 -0
  594. rasa/studio/download.py +350 -0
  595. rasa/studio/train.py +136 -0
  596. rasa/studio/upload.py +408 -0
  597. rasa/telemetry.py +1583 -0
  598. rasa/tracing/__init__.py +0 -0
  599. rasa/tracing/config.py +338 -0
  600. rasa/tracing/constants.py +38 -0
  601. rasa/tracing/instrumentation/__init__.py +0 -0
  602. rasa/tracing/instrumentation/attribute_extractors.py +663 -0
  603. rasa/tracing/instrumentation/instrumentation.py +939 -0
  604. rasa/tracing/instrumentation/intentless_policy_instrumentation.py +142 -0
  605. rasa/tracing/instrumentation/metrics.py +206 -0
  606. rasa/tracing/metric_instrument_provider.py +125 -0
  607. rasa/utils/__init__.py +0 -0
  608. rasa/utils/beta.py +83 -0
  609. rasa/utils/cli.py +27 -0
  610. rasa/utils/common.py +635 -0
  611. rasa/utils/converter.py +53 -0
  612. rasa/utils/endpoints.py +303 -0
  613. rasa/utils/io.py +326 -0
  614. rasa/utils/licensing.py +319 -0
  615. rasa/utils/log_utils.py +174 -0
  616. rasa/utils/mapper.py +210 -0
  617. rasa/utils/ml_utils.py +145 -0
  618. rasa/utils/plotting.py +362 -0
  619. rasa/utils/singleton.py +23 -0
  620. rasa/utils/tensorflow/__init__.py +0 -0
  621. rasa/utils/tensorflow/callback.py +112 -0
  622. rasa/utils/tensorflow/constants.py +116 -0
  623. rasa/utils/tensorflow/crf.py +492 -0
  624. rasa/utils/tensorflow/data_generator.py +440 -0
  625. rasa/utils/tensorflow/environment.py +161 -0
  626. rasa/utils/tensorflow/exceptions.py +5 -0
  627. rasa/utils/tensorflow/layers.py +1565 -0
  628. rasa/utils/tensorflow/layers_utils.py +113 -0
  629. rasa/utils/tensorflow/metrics.py +281 -0
  630. rasa/utils/tensorflow/model_data.py +991 -0
  631. rasa/utils/tensorflow/model_data_utils.py +500 -0
  632. rasa/utils/tensorflow/models.py +936 -0
  633. rasa/utils/tensorflow/rasa_layers.py +1094 -0
  634. rasa/utils/tensorflow/transformer.py +640 -0
  635. rasa/utils/tensorflow/types.py +6 -0
  636. rasa/utils/train_utils.py +572 -0
  637. rasa/utils/yaml.py +54 -0
  638. rasa/validator.py +1035 -0
  639. rasa/version.py +3 -0
  640. rasa_pro-3.8.16.dist-info/METADATA +528 -0
  641. rasa_pro-3.8.16.dist-info/NOTICE +5 -0
  642. rasa_pro-3.8.16.dist-info/RECORD +644 -0
  643. rasa_pro-3.8.16.dist-info/WHEEL +4 -0
  644. rasa_pro-3.8.16.dist-info/entry_points.txt +3 -0
@@ -0,0 +1,925 @@
1
+ from __future__ import annotations
2
+ import os
3
+ from abc import ABC, abstractmethod
4
+ from typing import (
5
+ Dict,
6
+ Iterator,
7
+ Optional,
8
+ Set,
9
+ Text,
10
+ List,
11
+ Tuple,
12
+ Type,
13
+ TypeVar,
14
+ TYPE_CHECKING,
15
+ Union,
16
+ Any,
17
+ AsyncIterator,
18
+ )
19
+
20
+ from pathlib import Path
21
+ from dataclasses import dataclass
22
+
23
+ import rasa.shared.core.constants
24
+ import rasa.shared.nlu.constants
25
+ import rasa.shared.utils.io
26
+ import rasa.shared.utils.common
27
+ from rasa.shared.data import is_likely_yaml_file
28
+ from rasa.shared.exceptions import InvalidConfigException, RasaException
29
+ from rasa.shared.core.events import ActionExecuted, UserUttered, Event
30
+ from rasa import telemetry
31
+ from rasa.shared.core.domain import Domain
32
+ from rasa.shared.core.trackers import DialogueStateTracker
33
+ from rasa.shared.utils.yaml import read_yaml_file
34
+ from rasa.utils.io import WriteRow
35
+ from rasa.shared.constants import DOCS_URL_MARKERS
36
+
37
+ import logging
38
+ import csv
39
+ import os.path
40
+
41
+ if TYPE_CHECKING:
42
+ from rasa.core.evaluation.marker import OrMarker
43
+
44
+ logger = logging.getLogger(__name__)
45
+
46
+
47
+ class MarkerRegistry:
48
+ """Keeps track of tags that can be used to configure markers."""
49
+
50
+ all_tags: Set[Text] = set() # noqa: RUF012
51
+ condition_tag_to_marker_class: Dict[
52
+ Text, Type[ConditionMarker]
53
+ ] = {} # noqa: RUF012
54
+ operator_tag_to_marker_class: Dict[Text, Type[OperatorMarker]] = {} # noqa: RUF012
55
+ marker_class_to_tag: Dict[Type[Marker], Text] = {} # noqa: RUF012
56
+ negated_tag_to_tag: Dict[Text, Text] = {} # noqa: RUF012
57
+ tag_to_negated_tag: Dict[Text, Text] = {} # noqa: RUF012
58
+
59
+ @classmethod
60
+ def register_builtin_markers(cls) -> None:
61
+ """Must import all modules containing markers."""
62
+ import rasa.core.evaluation.marker # noqa
63
+
64
+ @classmethod
65
+ def configurable_marker(cls, marker_class: Type[Marker]) -> Type[Marker]:
66
+ """Decorator used to register a marker that can be used in config files.
67
+
68
+ Args:
69
+ marker_class: the marker class to be made available via config files
70
+ Returns:
71
+ the registered marker class
72
+ """
73
+ if not issubclass(marker_class, Marker):
74
+ raise RuntimeError("Can only register marker classes as configurable.")
75
+
76
+ tag = marker_class.positive_tag()
77
+ negated_tag = marker_class.negated_tag()
78
+ cls._register_tags(tags={tag, negated_tag})
79
+ cls._register_tag_class(marker_class=marker_class, positive_tag=tag)
80
+ cls._register_negation(tag=tag, negated_tag=negated_tag)
81
+ return marker_class
82
+
83
+ @classmethod
84
+ def _register_tags(cls, tags: Set[Optional[Text]]) -> None:
85
+ specified_tags = {tag for tag in tags if tag is not None}
86
+ for tag_ in specified_tags:
87
+ if tag_ in cls.all_tags:
88
+ raise RuntimeError(
89
+ "Expected the tags of all configurable markers to be "
90
+ "identifiable by their tag."
91
+ )
92
+ cls.all_tags.add(tag_)
93
+
94
+ @classmethod
95
+ def _register_negation(cls, tag: Text, negated_tag: Optional[Text]) -> None:
96
+ if negated_tag is not None:
97
+ cls.negated_tag_to_tag[negated_tag] = tag
98
+ cls.tag_to_negated_tag[tag] = negated_tag
99
+
100
+ @classmethod
101
+ def get_non_negated_tag(cls, tag_or_negated_tag: Text) -> Tuple[Text, bool]:
102
+ """Returns the non-negated marker tag, given a (possible) negated marker tag.
103
+
104
+ Args:
105
+ tag_or_negated_tag: the tag for a possibly negated marker
106
+ Returns:
107
+ the tag itself if it was already positive, otherwise the positive version;
108
+ and a boolean that represents whether the given tag was a negative one
109
+ """
110
+ # either the given `marker_name` is already "positive" (e.g. "slot was set")
111
+ # or there is an entry mapping it to it's positive version:
112
+ positive_version = cls.negated_tag_to_tag.get(
113
+ tag_or_negated_tag, tag_or_negated_tag
114
+ )
115
+ is_negation = tag_or_negated_tag != positive_version
116
+ return positive_version, is_negation
117
+
118
+ @classmethod
119
+ def _register_tag_class(
120
+ cls, marker_class: Type[Marker], positive_tag: Text
121
+ ) -> None:
122
+ if issubclass(marker_class, ConditionMarker):
123
+ cls.condition_tag_to_marker_class[positive_tag] = marker_class
124
+ elif issubclass(marker_class, OperatorMarker):
125
+ cls.operator_tag_to_marker_class[positive_tag] = marker_class
126
+ else:
127
+ raise RuntimeError(
128
+ f"Can only register `{OperatorMarker.__name__} or "
129
+ f" {ConditionMarker.__name__} subclasses."
130
+ )
131
+ cls.marker_class_to_tag[marker_class] = positive_tag
132
+
133
+
134
+ class InvalidMarkerConfig(RasaException):
135
+ """Exception that can be raised when the config for a marker is not valid."""
136
+
137
+
138
+ @dataclass
139
+ class EventMetaData:
140
+ """Describes meta data per event in some session."""
141
+
142
+ idx: int
143
+ preceding_user_turns: int
144
+
145
+
146
+ # We evaluate markers separately against every session and extract, for every marker
147
+ # that we want to evaluate, the meta data of the respective relevant events where the
148
+ # marker applies.
149
+ SessionEvaluation = Dict[Text, List[EventMetaData]]
150
+
151
+ T = TypeVar("T")
152
+
153
+
154
+ class Marker(ABC):
155
+ """A marker is a way of describing points in conversations you're interested in.
156
+
157
+ Here, markers are stateful objects because they track the events of a conversation.
158
+ At each point in the conversation, one can observe whether a marker applies or
159
+ does not apply to the conversation so far.
160
+ """
161
+
162
+ # Identifier for an artificial marker that is created when loading markers
163
+ # from a dictionary of configs. For more details, see `from_config_dict`.
164
+ ANY_MARKER = "<any_marker>"
165
+
166
+ def __init__(
167
+ self,
168
+ name: Optional[Text] = None,
169
+ negated: bool = False,
170
+ description: Optional[Text] = None,
171
+ ) -> None:
172
+ """Instantiates a marker.
173
+
174
+ Args:
175
+ name: a custom name that can be used to replace the default string
176
+ conversion of this marker
177
+ negated: whether this marker should be negated (i.e. a negated marker
178
+ applies if and only if the non-negated marker does not apply)
179
+ description: an optional description of the marker. It is not used
180
+ internally but can be used to document the marker.
181
+
182
+ Raises:
183
+ `InvalidMarkerConfig` if the chosen *name* of the marker is the tag of
184
+ a predefined marker.
185
+ """
186
+ if name == Marker.ANY_MARKER or name in MarkerRegistry.all_tags:
187
+ raise InvalidMarkerConfig(
188
+ f"You must not use the special marker name {Marker.ANY_MARKER}. "
189
+ f"This is to avoid confusion when you generate a marker from a "
190
+ f"dictionary of marker configurations, which will lead to all "
191
+ f"markers being combined under one common `ORMarker` named "
192
+ f"{Marker.ANY_MARKER}."
193
+ )
194
+ self.name = name
195
+ self.history: List[bool] = []
196
+ # Note: we allow negation here even though there might not be a negated tag
197
+ # for 2 reasons: testing and the fact that the `MarkerRegistry`+`from_config`
198
+ # won't allow to create a negated marker if there is no negated tag.
199
+ self.negated: bool = negated
200
+ self.description = description
201
+
202
+ def __str__(self) -> Text:
203
+ return self.name or repr(self)
204
+
205
+ def __repr__(self) -> Text:
206
+ return self._to_str_with(self.get_tag())
207
+
208
+ def get_tag(self) -> Text:
209
+ """Returns the tag describing this marker."""
210
+ if self.negated:
211
+ tag = self.negated_tag()
212
+ if tag is None:
213
+ # We allow the instantiation of a negated marker even if there
214
+ # is no negated tag (ie. direct creation of the negated marker from
215
+ # a config is not allowed). To be able to print a tag nonetheless:
216
+ tag = f"not({self.positive_tag()})"
217
+ return tag
218
+ else:
219
+ return self.positive_tag()
220
+
221
+ @staticmethod
222
+ @abstractmethod
223
+ def positive_tag() -> Text:
224
+ """Returns the tag to be used in a config file."""
225
+ ...
226
+
227
+ @staticmethod
228
+ def negated_tag() -> Optional[Text]:
229
+ """Returns the tag to be used in a config file for the negated version.
230
+
231
+ If this maps to `None`, then this indicates that we do not allow a short-cut
232
+ for negating this marker. Hence, there is not a single tag to instantiate
233
+ a negated version of this marker. One must use a "not" in the configuration
234
+ file then.
235
+ """
236
+ return None
237
+
238
+ @abstractmethod
239
+ def _to_str_with(self, tag: Text) -> Text:
240
+ """Returns a string representation using the given tag."""
241
+ ...
242
+
243
+ def track(self, event: Event) -> None:
244
+ """Updates the marker according to the given event.
245
+
246
+ Args:
247
+ event: the next event of the conversation
248
+ """
249
+ result = self._non_negated_version_applies_at(event)
250
+ if self.negated:
251
+ result = not result
252
+ self.history.append(result)
253
+
254
+ @abstractmethod
255
+ def _non_negated_version_applies_at(self, event: Event) -> bool:
256
+ """Checks whether the non-negated version applies at the next given event.
257
+
258
+ This method must *not* update the marker.
259
+
260
+ Args:
261
+ event: the next event of the conversation
262
+ """
263
+ ...
264
+
265
+ def reset(self) -> None:
266
+ """Clears the history of the marker."""
267
+ self.history = []
268
+
269
+ @abstractmethod
270
+ def flatten(self) -> Iterator[Marker]:
271
+ """Returns an iterator over all conditions and operators used in this marker.
272
+
273
+ Returns:
274
+ an iterator over all conditions and operators that are part of this marker
275
+ """
276
+ ...
277
+
278
+ @abstractmethod
279
+ def validate_against_domain(self, domain: Domain) -> bool:
280
+ """Checks that this marker (and its children) refer to entries in the domain.
281
+
282
+ Args:
283
+ domain: The domain to check against
284
+ """
285
+ ...
286
+
287
+ @abstractmethod
288
+ def max_depth(self) -> int:
289
+ """Gets the maximum depth from this point in the marker tree."""
290
+ ...
291
+
292
+ def evaluate_events(self, events: List[Event]) -> List[SessionEvaluation]:
293
+ """Resets the marker, tracks all events, and collects some information.
294
+
295
+ The collected information includes:
296
+ - the timestamp of each event where the marker applied and
297
+ - the number of user turns that preceded that timestamp
298
+
299
+ If this marker is the special `ANY_MARKER` (identified by its name), then
300
+ results will be collected for all (immediate) sub-markers.
301
+
302
+ Args:
303
+ events: a list of events describing a conversation
304
+ Returns:
305
+ a list that contains, for each session contained in the tracker, a
306
+ dictionary mapping that maps marker names to meta data of relevant
307
+ events
308
+ """
309
+ # determine which marker to extract results from
310
+ if isinstance(self, OperatorMarker) and self.name == Marker.ANY_MARKER:
311
+ markers_to_be_evaluated = self.sub_markers
312
+ else:
313
+ markers_to_be_evaluated = [self]
314
+
315
+ # split the events into sessions and evaluate them separately
316
+ sessions_and_start_indices = self._split_sessions(events=events)
317
+
318
+ extracted_markers: List[Dict[Text, List[EventMetaData]]] = []
319
+ for session, start_idx in sessions_and_start_indices:
320
+ # track all events and collect meta data per time step
321
+ meta_data = self._track_all_and_collect_meta_data(
322
+ events=session, event_idx_offset=start_idx
323
+ )
324
+ # for each marker, keep only certain meta data
325
+ extracted: Dict[Text, List[EventMetaData]] = {
326
+ str(marker): [meta_data[idx] for idx in marker.relevant_events()]
327
+ for marker in markers_to_be_evaluated
328
+ }
329
+ extracted_markers.append(extracted)
330
+ return extracted_markers
331
+
332
+ @staticmethod
333
+ def _split_sessions(events: List[Event]) -> List[Tuple[List[Event], int]]:
334
+ """Identifies single sessions in a the given sequence of events.
335
+
336
+ Args:
337
+ events: a sequence of events, e.g. extracted from a tracker store
338
+ Returns:
339
+ a list of sub-sequences of the given events that describe single
340
+ conversations and the respective index that describes where the
341
+ subsequence starts in the original sequence
342
+ """
343
+ session_start_indices = [
344
+ idx
345
+ for idx, event in enumerate(events)
346
+ if isinstance(event, ActionExecuted)
347
+ and event.action_name
348
+ == rasa.shared.core.constants.ACTION_SESSION_START_NAME
349
+ ]
350
+ if len(session_start_indices) == 0:
351
+ return [(events, 0)]
352
+ sessions_and_start_indices: List[Tuple[List[Event], int]] = []
353
+ for session_idx in range(len(session_start_indices) - 1):
354
+ start_idx = session_start_indices[session_idx]
355
+ end_idx = session_start_indices[session_idx + 1]
356
+ session = [events[idx] for idx in range(start_idx, end_idx)]
357
+ sessions_and_start_indices.append((session, start_idx))
358
+ last_session = [
359
+ events[idx] for idx in range(session_start_indices[-1], len(events))
360
+ ]
361
+ sessions_and_start_indices.append((last_session, session_start_indices[-1]))
362
+ return sessions_and_start_indices
363
+
364
+ def _track_all_and_collect_meta_data(
365
+ self, events: List[Event], event_idx_offset: int = 0
366
+ ) -> List[EventMetaData]:
367
+ """Resets the marker, tracks all events, and collects metadata.
368
+
369
+ Args:
370
+ events: all events of a *single* session that should be tracked and
371
+ evaluated
372
+ event_idx_offset: offset that will be used to modify the collected event
373
+ meta data, i.e. all event indices will be shifted by this offset
374
+ Returns:
375
+ metadata for each tracked event with all event indices shifted by the
376
+ given `event_idx_offset`
377
+ """
378
+ self.reset()
379
+ session_meta_data: List[EventMetaData] = []
380
+ num_preceding_user_turns = 0
381
+ for idx, event in enumerate(events):
382
+ is_user_turn = isinstance(event, UserUttered)
383
+ session_meta_data.append(
384
+ EventMetaData(
385
+ idx=idx + event_idx_offset,
386
+ preceding_user_turns=num_preceding_user_turns,
387
+ )
388
+ )
389
+ self.track(event=event)
390
+ num_preceding_user_turns += int(is_user_turn)
391
+ return session_meta_data
392
+
393
+ def relevant_events(self) -> List[int]:
394
+ """Returns the indices of those tracked events that are relevant for evaluation.
395
+
396
+ Note: Overwrite this method if you create a new marker class that should *not*
397
+ contain meta data about each event where the marker applied in the final
398
+ evaluation (see `evaluate_events`).
399
+
400
+ Returns:
401
+ indices of tracked events
402
+ """
403
+ return [idx for (idx, applies) in enumerate(self.history) if applies]
404
+
405
+ @classmethod
406
+ def from_path(cls, path: Union[Path, Text]) -> "OrMarker":
407
+ """Loads markers from one config file or all config files in a directory tree.
408
+
409
+ Each config file should contain a dictionary mapping marker names to the
410
+ respective marker configuration.
411
+ To avoid confusion, the marker names must not coincide with the tag of
412
+ any pre-defined markers. Moreover, marker names must be unique. This means,
413
+ if you you load the markers from multiple files, then you have to make sure
414
+ that the names of the markers defined in these files are unique across all
415
+ loaded files.
416
+
417
+ Note that all loaded markers will be combined into one marker via one
418
+ artificial OR-operator. When evaluating the resulting marker, then the
419
+ artificial OR-operator will be ignored and results will be reported for
420
+ every sub-marker.
421
+
422
+ For more details how a single marker configuration looks like, have a look
423
+ at `Marker.from_config`.
424
+
425
+ Args:
426
+ path: either the path to a single config file or the root of the directory
427
+ tree that contains marker config files
428
+ Returns:
429
+ all configured markers, combined into one marker object
430
+ """
431
+ MarkerRegistry.register_builtin_markers()
432
+ from rasa.core.evaluation.marker import OrMarker
433
+
434
+ # collect all the files from which we want to load configs (i.e. either just
435
+ # the given path if points to a yaml or all yaml-files in the directory tree)
436
+ yaml_files = cls._collect_yaml_files_from_path(path)
437
+
438
+ # collect all the configs from those yaml files (assure it's dictionaries
439
+ # mapping marker names to something) -- keep track of which config came
440
+ # from which file to be able to raise meaningful errors later
441
+ loaded_configs: Dict[Text, Dict] = cls._collect_configs_from_yaml_files(
442
+ yaml_files
443
+ )
444
+
445
+ # create markers from all loaded configurations
446
+ loaded_markers: List[Marker] = []
447
+ for yaml_file, config in loaded_configs.items():
448
+ for marker_name, marker_config in config.items():
449
+ try:
450
+ marker = Marker.from_config(marker_config, name=marker_name)
451
+ except InvalidMarkerConfig as e:
452
+ # we don't re-raise here because the stack trace would only be
453
+ # printed when we run rasa evaluate with --debug flag
454
+ raise InvalidMarkerConfig(
455
+ f"Could not load marker {marker_name} from {yaml_file}. "
456
+ f"Reason: {e!s}. "
457
+ )
458
+ loaded_markers.append(marker)
459
+
460
+ # Reminder: We could also just create a dictionary of markers from this.
461
+ # However, if we want to allow re-using top-level markers (e.g.
462
+ # "custom_marker1 or custom_marker2" and/or optimize the marker evaluation such
463
+ # that e.g. the same condition is not instantiated (and evaluated) twice, then
464
+ # the current approach might be better (e.g. with a dictionary of markers one
465
+ # might expect the markers to be independent objects).
466
+
467
+ # combine the markers
468
+ marker = OrMarker(markers=loaded_markers)
469
+ marker.name = Marker.ANY_MARKER # cannot be set via name parameter
470
+ return marker
471
+
472
+ @staticmethod
473
+ def _collect_yaml_files_from_path(path: Union[Text, Path]) -> List[Text]:
474
+ path = os.path.abspath(path)
475
+ if os.path.isfile(path):
476
+ yaml_files = [
477
+ yaml_file for yaml_file in [path] if is_likely_yaml_file(yaml_file)
478
+ ]
479
+ if not yaml_files:
480
+ raise InvalidMarkerConfig(f"Could not find a yaml file at '{path}'.")
481
+ elif os.path.isdir(path):
482
+ yaml_files = [
483
+ os.path.join(root, file)
484
+ for root, _, files in os.walk(path, followlinks=True)
485
+ for file in files
486
+ if is_likely_yaml_file(file)
487
+ ]
488
+ if not yaml_files:
489
+ raise InvalidMarkerConfig(
490
+ f"Could not find any yaml in the directory tree rooted at '{path}'."
491
+ )
492
+ else:
493
+ raise InvalidMarkerConfig(
494
+ f"The given path ({path}) is neither pointing to a directory "
495
+ f"nor a file. Please specify the location of a yaml file or a "
496
+ f"root directory (all yaml configs found in the directories "
497
+ f"under that root directory will be loaded). "
498
+ f"Refer to the docs for more information: {DOCS_URL_MARKERS} "
499
+ )
500
+ return yaml_files
501
+
502
+ @staticmethod
503
+ def _collect_configs_from_yaml_files(yaml_files: List[Text]) -> Dict[Text, Dict]:
504
+ marker_names: Set[Text] = set()
505
+ loaded_configs: Dict[Text, Dict] = {}
506
+ for yaml_file in yaml_files:
507
+ loaded_config = read_yaml_file(yaml_file)
508
+ if not isinstance(loaded_config, dict):
509
+ raise InvalidMarkerConfig(
510
+ f"Expected the loaded configurations to be a dictionary "
511
+ f"of marker configurations but found a "
512
+ f"{type(loaded_config)} in {yaml_file}. "
513
+ f"Refer to the docs for more information: {DOCS_URL_MARKERS} "
514
+ )
515
+ if set(loaded_config.keys()).intersection(marker_names):
516
+ raise InvalidMarkerConfig(
517
+ f"The names of markers defined in {yaml_file} "
518
+ f"({sorted(loaded_config.keys())}) "
519
+ f"overlap with the names of markers loaded so far "
520
+ f"({sorted(marker_names)}). "
521
+ f"Please adapt your configurations such that your custom "
522
+ f"marker names are unique. "
523
+ f"Refer to the docs for more information: {DOCS_URL_MARKERS} "
524
+ )
525
+ if set(loaded_config.keys()).intersection(MarkerRegistry.all_tags):
526
+ raise InvalidMarkerConfig(
527
+ f"The top level of your marker configuration should consist "
528
+ f"of names for your custom markers. "
529
+ f"If you use a condition or operator name at the top level, "
530
+ f"then that will not be recognised as an actual condition "
531
+ f"or operator and won't be evaluated against any sessions. "
532
+ f"Please remove any of the pre-defined marker tags "
533
+ f"(i.e. {MarkerRegistry.all_tags}) "
534
+ f"from {yaml_file}. "
535
+ f"Refer to the docs for more information: {DOCS_URL_MARKERS} "
536
+ )
537
+ marker_names.update(loaded_config.keys())
538
+ loaded_configs[yaml_file] = loaded_config
539
+ return loaded_configs
540
+
541
+ @staticmethod
542
+ def from_config(config: Any, name: Optional[Text] = None) -> Marker:
543
+ """Creates a marker from the given config.
544
+
545
+ A marker configuration is a dictionary mapping a marker tag (either a
546
+ `positive_tag` or a `negated_tag`) to a sub-configuration.
547
+ How that sub-configuration looks like, depends on whether the tag describes
548
+ an operator (see `OperatorMarker.from_tag_and_sub_config`) or a
549
+ condition (see `ConditionMarker.from_tag_and_sub_config`).
550
+
551
+ Args:
552
+ config: a marker configuration
553
+ name: a custom name that will be used for the top-level marker (if and
554
+ only if there is only one top-level marker)
555
+
556
+ Returns:
557
+ the configured marker
558
+ """
559
+ # Triggers the import of all modules containing marker classes in order to
560
+ # register all configurable markers.
561
+ MarkerRegistry.register_builtin_markers()
562
+
563
+ if not isinstance(config, dict) or len(config) not in [1, 2]:
564
+ raise InvalidMarkerConfig(
565
+ "To configure a marker, please define a dictionary that maps a "
566
+ "single operator tag or a single condition tag to the "
567
+ "corresponding parameter configuration or a list of marker "
568
+ "configurations, respectively. "
569
+ f"Refer to the docs for more information: {DOCS_URL_MARKERS} "
570
+ )
571
+
572
+ description = config.pop("description", None)
573
+ tag = next(iter(config))
574
+ sub_marker_config = config[tag]
575
+
576
+ tag, _ = MarkerRegistry.get_non_negated_tag(tag_or_negated_tag=tag)
577
+ if tag in MarkerRegistry.operator_tag_to_marker_class:
578
+ return OperatorMarker.from_tag_and_sub_config(
579
+ tag=tag,
580
+ sub_config=sub_marker_config,
581
+ name=name,
582
+ description=description,
583
+ )
584
+ elif tag in MarkerRegistry.condition_tag_to_marker_class:
585
+ return ConditionMarker.from_tag_and_sub_config(
586
+ tag=tag,
587
+ sub_config=sub_marker_config,
588
+ name=name,
589
+ description=description,
590
+ )
591
+
592
+ raise InvalidMarkerConfig(
593
+ f"Expected a marker configuration with a key that specifies"
594
+ f" an operator or a condition but found {tag}. "
595
+ f"Available conditions and operators are: "
596
+ f"{sorted(MarkerRegistry.all_tags)}. "
597
+ f"Refer to the docs for more information: {DOCS_URL_MARKERS} "
598
+ )
599
+
600
+ async def evaluate_trackers(
601
+ self,
602
+ trackers: AsyncIterator[Optional[DialogueStateTracker]],
603
+ output_file: Path,
604
+ session_stats_file: Optional[Path] = None,
605
+ overall_stats_file: Optional[Path] = None,
606
+ ) -> None:
607
+ """Collect markers for each dialogue in each tracker loaded.
608
+
609
+ Args:
610
+ trackers: An iterator over the trackers from which we want to extract
611
+ markers.
612
+ output_file: Path to write out the extracted markers.
613
+ session_stats_file: (Optional) Path to write out statistics about the
614
+ extracted markers for each session separately.
615
+ overall_stats_file: (Optional) Path to write out statistics about the
616
+ markers extracted from all session data.
617
+
618
+ Raises:
619
+ `FileExistsError` if any of the specified files already exists
620
+ `NotADirectoryError` if any of the specified files is supposed to be
621
+ contained in a directory that does not exist
622
+ """
623
+ # Check files and folders before doing the costly swipe over the trackers:
624
+ for path in [session_stats_file, overall_stats_file, output_file]:
625
+ if path is not None and path.is_file():
626
+ raise FileExistsError(f"Expected that no file {path} already exists.")
627
+ if path is not None and not path.parent.is_dir():
628
+ raise NotADirectoryError(f"Expected directory {path.parent} to exist.")
629
+
630
+ # Apply marker to each session stored in each tracker and save the results.
631
+ processed_trackers: Dict[Text, List[SessionEvaluation]] = {}
632
+ async for tracker in trackers:
633
+ if tracker:
634
+ tracker_result = self.evaluate_events(tracker.events)
635
+ processed_trackers[tracker.sender_id] = tracker_result
636
+
637
+ processed_trackers_count = len(processed_trackers)
638
+ telemetry.track_markers_extracted(processed_trackers_count)
639
+ Marker._save_results(output_file, processed_trackers)
640
+
641
+ # Compute and write statistics if requested.
642
+ if session_stats_file or overall_stats_file:
643
+ from rasa.core.evaluation.marker_stats import MarkerStatistics
644
+
645
+ stats = MarkerStatistics()
646
+ for sender_id, tracker_result in processed_trackers.items():
647
+ for session_idx, session_result in enumerate(tracker_result):
648
+ stats.process(
649
+ sender_id=sender_id,
650
+ session_idx=session_idx,
651
+ meta_data_on_relevant_events_per_marker=session_result,
652
+ )
653
+
654
+ telemetry.track_markers_stats_computed(processed_trackers_count)
655
+ if overall_stats_file:
656
+ stats.overall_statistic_to_csv(path=overall_stats_file)
657
+ if session_stats_file:
658
+ stats.per_session_statistics_to_csv(path=session_stats_file)
659
+
660
+ @staticmethod
661
+ def _save_results(path: Path, results: Dict[Text, List[SessionEvaluation]]) -> None:
662
+ """Save extracted marker results as CSV to specified path.
663
+
664
+ Args:
665
+ path: Path to write out the extracted markers.
666
+ results: Extracted markers from a selection of trackers.
667
+ """
668
+ with path.open(mode="w") as f:
669
+ table_writer = csv.writer(f)
670
+ table_writer.writerow(
671
+ [
672
+ "sender_id",
673
+ "session_idx",
674
+ "marker",
675
+ "event_idx",
676
+ "num_preceding_user_turns",
677
+ ]
678
+ )
679
+ for sender_id, results_per_session in results.items():
680
+ for session_idx, session_result in enumerate(results_per_session):
681
+ Marker._write_relevant_events(
682
+ table_writer, sender_id, session_idx, session_result
683
+ )
684
+
685
+ @staticmethod
686
+ def _write_relevant_events(
687
+ writer: WriteRow, sender_id: Text, session_idx: int, session: SessionEvaluation
688
+ ) -> None:
689
+ for marker_name, meta_data_per_relevant_event in session.items():
690
+ for event_meta_data in meta_data_per_relevant_event:
691
+ writer.writerow(
692
+ [
693
+ sender_id,
694
+ str(session_idx),
695
+ marker_name,
696
+ str(event_meta_data.idx),
697
+ str(event_meta_data.preceding_user_turns),
698
+ ]
699
+ )
700
+
701
+
702
+ class OperatorMarker(Marker, ABC):
703
+ """Combines several markers into one."""
704
+
705
+ def __init__(
706
+ self,
707
+ markers: List[Marker],
708
+ negated: bool = False,
709
+ name: Optional[Text] = None,
710
+ description: Optional[Text] = None,
711
+ ) -> None:
712
+ """Instantiates a marker.
713
+
714
+ Args:
715
+ markers: the list of markers to combine
716
+ negated: whether this marker should be negated (i.e. a negated marker
717
+ applies if and only if the non-negated marker does not apply)
718
+ name: a custom name that can be used to replace the default string
719
+ conversion of this marker
720
+ description: an optional description of the marker. It is not used
721
+ internally but can be used to document the marker.
722
+
723
+ Raises:
724
+ `InvalidMarkerConfig` if the given number of sub-markers does not match
725
+ the expected number of sub-markers
726
+ """
727
+ super().__init__(name=name, negated=negated, description=description)
728
+ self.sub_markers: List[Marker] = markers
729
+ expected_num = self.expected_number_of_sub_markers()
730
+ if expected_num is not None and len(markers) != expected_num:
731
+ raise InvalidMarkerConfig(
732
+ f"Expected {expected_num} sub-marker(s) to be specified for marker "
733
+ f"'{self}' ({self.get_tag()}) but found {len(markers)}. "
734
+ f"Please adapt your configuration so that there are exactly "
735
+ f"{expected_num} sub-markers. "
736
+ )
737
+ elif len(markers) == 0:
738
+ raise InvalidMarkerConfig(
739
+ f"Expected some sub-markers to be specified for {self} but "
740
+ f"found none. Please adapt your configuration so that there is "
741
+ f"at least one sub-marker. "
742
+ )
743
+
744
+ @staticmethod
745
+ def expected_number_of_sub_markers() -> Optional[int]:
746
+ """Returns the expected number of sub-markers (if there is any)."""
747
+ return None
748
+
749
+ def _to_str_with(self, tag: Text) -> Text:
750
+ marker_str = ", ".join(str(marker) for marker in self.sub_markers)
751
+ return f"{tag}({marker_str})"
752
+
753
+ def track(self, event: Event) -> None:
754
+ """Updates the marker according to the given event.
755
+
756
+ All sub-markers will be updated before the compound marker itself is updated.
757
+
758
+ Args:
759
+ event: the next event of the conversation
760
+ """
761
+ for marker in self.sub_markers:
762
+ marker.track(event)
763
+ super().track(event)
764
+
765
+ def flatten(self) -> Iterator[Marker]:
766
+ """Returns an iterator over all included markers, plus this marker itself.
767
+
768
+ Returns:
769
+ an iterator over all markers that are part of this marker
770
+ """
771
+ for marker in self.sub_markers:
772
+ for sub_marker in marker.flatten():
773
+ yield sub_marker
774
+ yield self
775
+
776
+ def reset(self) -> None:
777
+ """Resets the history of this marker and all its sub-markers."""
778
+ for marker in self.sub_markers:
779
+ marker.reset()
780
+ super().reset()
781
+
782
+ def validate_against_domain(self, domain: Domain) -> bool:
783
+ """Checks that this marker (and its children) refer to entries in the domain.
784
+
785
+ Args:
786
+ domain: The domain to check against
787
+ """
788
+ return all(
789
+ marker.validate_against_domain(domain) for marker in self.sub_markers
790
+ )
791
+
792
+ def max_depth(self) -> int:
793
+ """Gets the maximum depth from this point in the marker tree."""
794
+ return 1 + max(child.max_depth() for child in self.sub_markers)
795
+
796
+ @staticmethod
797
+ def from_tag_and_sub_config(
798
+ tag: Text,
799
+ sub_config: Any,
800
+ name: Optional[Text] = None,
801
+ description: Optional[Text] = None,
802
+ ) -> OperatorMarker:
803
+ """Creates an operator marker from the given config.
804
+
805
+ The configuration must consist of a list of marker configurations.
806
+ See `Marker.from_config` for more details.
807
+
808
+ Args:
809
+ tag: the tag identifying an operator
810
+ sub_config: a list of marker configs
811
+ name: an optional custom name to be attached to the resulting marker
812
+ description: an optional description of the marker
813
+ Returns:
814
+ the configured operator marker
815
+ Raises:
816
+ `InvalidMarkerConfig` if the given config or the tag are not well-defined
817
+ """
818
+ positive_tag, is_negation = MarkerRegistry.get_non_negated_tag(tag)
819
+ operator_class = MarkerRegistry.operator_tag_to_marker_class.get(positive_tag)
820
+ if operator_class is None:
821
+ raise InvalidConfigException(f"Unknown operator '{tag}'.")
822
+
823
+ if not isinstance(sub_config, list):
824
+ raise InvalidMarkerConfig(
825
+ f"Expected a list of sub-marker configurations under {tag}."
826
+ )
827
+ collected_sub_markers: List[Marker] = []
828
+ for sub_marker_config in sub_config:
829
+ try:
830
+ sub_marker = Marker.from_config(sub_marker_config)
831
+ except InvalidMarkerConfig as e:
832
+ # we don't re-raise here because the stack trace would only be
833
+ # printed when we run rasa evaluate with --debug flag
834
+ raise InvalidMarkerConfig(
835
+ f"Could not create sub-marker for operator '{tag}' from "
836
+ f"{sub_marker_config}. Reason: {e!s}"
837
+ )
838
+ collected_sub_markers.append(sub_marker)
839
+ try:
840
+ marker = operator_class(markers=collected_sub_markers, negated=is_negation)
841
+ except InvalidMarkerConfig as e:
842
+ # we don't re-raise here because the stack trace would only be
843
+ # printed when we run rasa evaluate with --debug flag
844
+ raise InvalidMarkerConfig(
845
+ f"Could not create operator '{tag}' with sub-markers "
846
+ f"{collected_sub_markers}. Reason: {e!s}"
847
+ )
848
+ marker.name = name
849
+ marker.description = description
850
+ return marker
851
+
852
+
853
+ class ConditionMarker(Marker, ABC):
854
+ """A marker that does not contain any sub-markers."""
855
+
856
+ def __init__(
857
+ self,
858
+ text: Text,
859
+ negated: bool = False,
860
+ name: Optional[Text] = None,
861
+ description: Optional[Text] = None,
862
+ ) -> None:
863
+ """Instantiates an atomic marker.
864
+
865
+ Args:
866
+ text: some text used to decide whether the marker applies
867
+ negated: whether this marker should be negated (i.e. a negated marker
868
+ applies if and only if the non-negated marker does not apply)
869
+ name: a custom name that can be used to replace the default string
870
+ conversion of this marker
871
+ description: an optional description of the marker. It is not used
872
+ internally but can be used to document the marker.
873
+ """
874
+ super().__init__(name=name, negated=negated)
875
+ self.text = text
876
+ self.description = description
877
+
878
+ def _to_str_with(self, tag: Text) -> Text:
879
+ return f"({tag}: {self.text})"
880
+
881
+ def flatten(self) -> Iterator[ConditionMarker]:
882
+ """Returns an iterator that just returns this `AtomicMarker`.
883
+
884
+ Returns:
885
+ an iterator over all markers that are part of this marker, i.e. this marker
886
+ """
887
+ yield self
888
+
889
+ def max_depth(self) -> int:
890
+ """Gets the maximum depth from this point in the marker tree."""
891
+ return 1
892
+
893
+ @staticmethod
894
+ def from_tag_and_sub_config(
895
+ tag: Text,
896
+ sub_config: Any,
897
+ name: Optional[Text] = None,
898
+ description: Optional[Text] = None,
899
+ ) -> ConditionMarker:
900
+ """Creates an atomic marker from the given config.
901
+
902
+ Args:
903
+ tag: the tag identifying a condition
904
+ sub_config: a single text parameter expected by all condition markers;
905
+ e.g. if the tag is for an `intent_detected` marker then the `config`
906
+ should contain an intent name
907
+ name: a custom name for this marker
908
+ Returns:
909
+ the configured `ConditionMarker`
910
+ Raises:
911
+ `InvalidMarkerConfig` if the given config or the tag are not well-defined
912
+ """
913
+ positive_tag, is_negation = MarkerRegistry.get_non_negated_tag(tag)
914
+ marker_class = MarkerRegistry.condition_tag_to_marker_class.get(positive_tag)
915
+ if marker_class is None:
916
+ raise InvalidConfigException(f"Unknown condition '{tag}'.")
917
+
918
+ if not isinstance(sub_config, str):
919
+ raise InvalidMarkerConfig(
920
+ f"Expected a text parameter to be specified for marker '{tag}'."
921
+ )
922
+ marker = marker_class(sub_config, negated=is_negation)
923
+ marker.name = name
924
+ marker.description = description
925
+ return marker