Update the docs (#151)

docs/_modules/index.html

@@ -59,7 +59,8 @@ <h1>All modules for which code is available</h1>
 <li><a href="skit_pipelines/components/gen_asr_metrics.html">skit_pipelines.components.gen_asr_metrics</a></li>
 <li><a href="skit_pipelines/components/identify_compliance_breaches_llm.html">skit_pipelines.components.identify_compliance_breaches_llm</a></li>
 <ul><li><a href="skit_pipelines/components/identify_compliance_breaches_llm/utils.html">skit_pipelines.components.identify_compliance_breaches_llm.utils</a></li>
-</ul><li><a href="skit_pipelines/components/merge_transcription.html">skit_pipelines.components.merge_transcription</a></li>
+</ul><li><a href="skit_pipelines/components/invalidate_situations_in_db.html">skit_pipelines.components.invalidate_situations_in_db</a></li>
+<li><a href="skit_pipelines/components/merge_transcription.html">skit_pipelines.components.merge_transcription</a></li>
 <li><a href="skit_pipelines/components/modify_entities/duckling_inference.html">skit_pipelines.components.modify_entities.duckling_inference</a></li>
 <li><a href="skit_pipelines/components/modify_entities/modify_predictions.html">skit_pipelines.components.modify_entities.modify_predictions</a></li>
 <li><a href="skit_pipelines/components/modify_tagged_entities.html">skit_pipelines.components.modify_tagged_entities</a></li>
@@ -103,11 +104,14 @@ <h1>All modules for which code is available</h1>
 <li><a href="skit_pipelines/pipelines/fetch_tagged_entity_dataset.html">skit_pipelines.pipelines.fetch_tagged_entity_dataset</a></li>
 <li><a href="skit_pipelines/pipelines/generate_and_tag_conversations.html">skit_pipelines.pipelines.generate_and_tag_conversations</a></li>
 <li><a href="skit_pipelines/pipelines/generate_sample_conversations.html">skit_pipelines.pipelines.generate_sample_conversations</a></li>
+<li><a href="skit_pipelines/pipelines/invalidate_llm_situations_in_db.html">skit_pipelines.pipelines.invalidate_llm_situations_in_db</a></li>
 <li><a href="skit_pipelines/pipelines/publish_compliance_breaches.html">skit_pipelines.pipelines.publish_compliance_breaches</a></li>
 <li><a href="skit_pipelines/pipelines/retrain_slu.html">skit_pipelines.pipelines.retrain_slu</a></li>
 <li><a href="skit_pipelines/pipelines/retrain_slu_old.html">skit_pipelines.pipelines.retrain_slu_old</a></li>
 <li><a href="skit_pipelines/pipelines/tag_calls.html">skit_pipelines.pipelines.tag_calls</a></li>
 <li><a href="skit_pipelines/pipelines/transcription_pipeline.html">skit_pipelines.pipelines.transcription_pipeline</a></li>
+<li><a href="skit_pipelines/types/situation_mapping_info.html">skit_pipelines.types.situation_mapping_info</a></li>
+<li><a href="skit_pipelines/types/tag_calls.html">skit_pipelines.types.tag_calls</a></li>
 <li><a href="skit_pipelines/utils.html">skit_pipelines.utils</a></li>
 <ul><li><a href="skit_pipelines/utils/cookies.html">skit_pipelines.utils.cookies</a></li>
 <li><a href="skit_pipelines/utils/helpers.html">skit_pipelines.utils.helpers</a></li>

docs/_modules/skit_pipelines/api/endpoints.html

@@ -285,8 +285,12 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.tag_calls.html">Upload for annotation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.fetch_tagged_entity_dataset.html">Download tagged entity dataset</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.retrain_slu.html">Retrain SLU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.publish_compliance_breaches.html">Publish Complaince Breaches</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.transcription_pipeline.html">Transcribe Dataset</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.fetch_n_tag_turns_and_calls.html">Random sample and tag turns and calls</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_sample_conversations.html">Generate sample conversations for LLMs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_and_tag_conversations.html">Generate conversations for LLMS and upload it for tagging</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.invalidate_llm_situations_in_db.html">Generate conversations for LLMS and upload it for tagging</a></li>
 </ul>
 
 <div class="relations">
@@ -325,7 +329,7 @@ <h3 id="searchlabel">Quick search</h3>
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
     </div>
 

docs/_modules/skit_pipelines/api/models/custom_models.html

@@ -57,7 +57,7 @@ <h1>Source code for skit_pipelines.api.models.custom_models</h1><div class="high
 
 <div class="viewcode-block" id="get_kf_object_uri"><a class="viewcode-back" href="../../../../skit_pipelines.api.models.html#skit_pipelines.api.models.custom_models.get_kf_object_uri">[docs]</a><span class="k">def</span> <span class="nf">get_kf_object_uri</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span> <span class="n">store</span><span class="o">=</span><span class="s2">&quot;s3&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
     <span class="n">key</span> <span class="o">=</span> <span class="n">obj</span><span class="p">[</span><span class="n">store</span><span class="p">][</span><span class="n">const</span><span class="o">.</span><span class="n">ARTIFACT_URI_KEY</span><span class="p">]</span>
-    <span class="n">bucket</span> <span class="o">=</span> <span class="n">obj</span><span class="p">[</span><span class="n">store</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">const</span><span class="o">.</span><span class="n">OBJECT_BUCKET</span><span class="p">,</span> <span class="n">const</span><span class="o">.</span><span class="n">KUBEFLOW_BUCKET</span><span class="p">)</span>
+    <span class="n">bucket</span> <span class="o">=</span> <span class="n">obj</span><span class="p">[</span><span class="n">store</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">const</span><span class="o">.</span><span class="n">OBJECT_BUCKET</span><span class="p">,</span> <span class="n">const</span><span class="o">.</span><span class="n">KUBEFLOW_SANDBOX_BUCKET</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">store</span> <span class="o">==</span> <span class="s2">&quot;s3&quot;</span><span class="p">:</span>
         <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;s3://</span><span class="si">{</span><span class="n">bucket</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">&quot;</span>
     <span class="k">else</span><span class="p">:</span>
@@ -156,8 +156,11 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.tag_calls.html">Upload for annotation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.fetch_tagged_entity_dataset.html">Download tagged entity dataset</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.retrain_slu.html">Retrain SLU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.publish_compliance_breaches.html">Publish Complaince Breaches</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.transcription_pipeline.html">Transcribe Dataset</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.fetch_n_tag_turns_and_calls.html">Random sample and tag turns and calls</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.generate_sample_conversations.html">Generate sample conversations for LLMs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../skit_pipelines.pipelines.generate_and_tag_conversations.html">Generate conversations for LLMS and upload it for tagging</a></li>
 </ul>
 
 <div class="relations">
@@ -196,7 +199,7 @@ <h3 id="searchlabel">Quick search</h3>
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
     </div>
 

docs/_modules/skit_pipelines/api/slack_bot.html

@@ -336,6 +336,8 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.publish_compliance_breaches.html">Publish Complaince Breaches</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.transcription_pipeline.html">Transcribe Dataset</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.fetch_n_tag_turns_and_calls.html">Random sample and tag turns and calls</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_sample_conversations.html">Generate sample conversations for LLMs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_and_tag_conversations.html">Generate conversations for LLMS and upload it for tagging</a></li>
 </ul>
 
 <div class="relations">

docs/_modules/skit_pipelines/api/validate_input.html

@@ -89,7 +89,24 @@ <h1>Source code for skit_pipelines.api.validate_input</h1><div class="highlight"
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pipeline_name</span> <span class="o">==</span> <span class="s2">&quot;fetch_n_tag_turns_and_calls&quot;</span> <span class="ow">and</span> \
                 <span class="p">(</span><span class="s2">&quot;labelstudio_project_id&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span> <span class="ow">and</span> <span class="s2">&quot;call_project_id&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">):</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;At least one of labelstudio_project_id or call_project_id must be provided.</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
-
+
+    <span class="k">def</span> <span class="nf">_validate_situation_present</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pipeline_name</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;generate_and_tag_conversations&quot;</span><span class="p">,</span> <span class="s2">&quot;generate_sample_conversations&quot;</span><span class="p">]</span>  <span class="ow">and</span> <span class="s2">&quot;situations&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;At least one situation must be provided.</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="nf">_validate_generate_and_tag_conversations_params</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pipeline_name</span> <span class="o">==</span> <span class="s2">&quot;generate_and_tag_conversations&quot;</span><span class="p">:</span>
+            <span class="k">if</span> <span class="s2">&quot;template_id&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Parameter template_id required for generate_and_tag_conversations pipeline</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
+            <span class="k">if</span> <span class="s2">&quot;client_id&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Parameter client_id required for generate_and_tag_conversations pipeline</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
+            <span class="k">if</span> <span class="s2">&quot;labelstudio_project_id&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Parameter labelstudio_project_id required for generate_and_tag_conversations pipeline</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
+            <span class="k">if</span> <span class="s2">&quot;scenario&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;Parameter scenario is mandatory for generate_and_tag_conversations pipeline</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
+            <span class="k">if</span> <span class="s2">&quot;scenario_category&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">payload</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;Parameter scenario_category is mandatory for generate_and_tag_conversations pipeline</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
+
 <div class="viewcode-block" id="ValidateInput.validate_input_params"><a class="viewcode-back" href="../../../skit_pipelines.api.html#skit_pipelines.api.validate_input.ValidateInput.validate_input_params">[docs]</a>    <span class="k">def</span> <span class="nf">validate_input_params</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="c1"># Universal checks</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_validate_start_date</span><span class="p">()</span>
@@ -99,6 +116,9 @@ <h1>Source code for skit_pipelines.api.validate_input</h1><div class="highlight"
         <span class="c1"># Pipeline specific checks</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_validate_repo_for_retrain_slu</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_validate_label_studio_ids_for_fetch_n_tag_turns_calls</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_validate_situation_present</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_validate_generate_and_tag_conversations_params</span><span class="p">()</span>
+
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">errors</span></div></div>
 </pre></div>
 
@@ -129,6 +149,8 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.publish_compliance_breaches.html">Publish Complaince Breaches</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.transcription_pipeline.html">Transcribe Dataset</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.fetch_n_tag_turns_and_calls.html">Random sample and tag turns and calls</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_sample_conversations.html">Generate sample conversations for LLMs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_and_tag_conversations.html">Generate conversations for LLMS and upload it for tagging</a></li>
 </ul>
 
 <div class="relations">

docs/_modules/skit_pipelines/components/evaluate_slu_from_repo.html

@@ -161,6 +161,8 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.publish_compliance_breaches.html">Publish Complaince Breaches</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.transcription_pipeline.html">Transcribe Dataset</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.fetch_n_tag_turns_and_calls.html">Random sample and tag turns and calls</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_sample_conversations.html">Generate sample conversations for LLMs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../skit_pipelines.pipelines.generate_and_tag_conversations.html">Generate conversations for LLMS and upload it for tagging</a></li>
 </ul>
 
 <div class="relations">