Skip to content
Snippets Groups Projects
Commit 15b1b013 authored by Ludovic Apvrille's avatar Ludovic Apvrille
Browse files

Adding help on mistralAI

parent 289bf87b
No related branches found
No related tags found
No related merge requests found
......@@ -100,6 +100,10 @@ class="sourceCode xml"><code class="sourceCode xml"><span id="cb1-1"><a href="#c
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>&lt;<span class="kw">OPENAIModel</span><span class="ot"> data=</span><span class="st">&quot;gpt-3.5-turbo gpt-4-turbo gpt-4o gpt-4o-mini&quot;</span>/&gt;</span></code></pre></div>
<p>This is required to have a valid openai account and available
tokens.</p>
<p>Similarly, you can use a mistralAI key.</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode xml"><code class="sourceCode xml"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>&lt;<span class="kw">MistralAIKey</span><span class="ot"> data=</span><span class="st">&quot;put your key here&quot;</span>/&gt;</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a>&lt;<span class="kw">MistralAIModel</span><span class="ot"> data=</span><span class="st">&quot;pixtral-12b-2409&quot;</span>/&gt;</span></code></pre></div>
<h2 id="how-to-use-ai">How to use AI?</h2>
<p>First, select what you intend to do at the top of the AI window:</p>
<h3 id="chat">Chat</h3>
......@@ -112,6 +116,17 @@ of requirements. Open a requirement diagram with at least one
requirement, and click on “start”. If the classification proposed by the
AI (see the “Answer text area”) suits you, you can click on “Apply
response” to update the opened requirement diagram.</p>
<h3 id="generate-block-diagrams">Generate block diagrams</h3>
<p>Provide a system specification. The AI will compute a liste of blocks
(including their atributes and signals), and will connect them. Once the
AI has finished computed a block diagram, click on “apply” to get the
block diagram drawn in TTool</p>
<h3 id="generate-state-machine-diagrams">Generate state machine
diagrams</h3>
<p>Provide a system specification, and select in TTool a block diagram.
The AI will compute states machines. Once computed, click on “apply” to
get the state machines drawn in TTool (TTool duplicated the block
diagram to be certain not to erase your former state machines).</p>
<h3 id="aimulet">A(I)MULET</h3>
<p>This option enables to automatically generate AMULET commands for
modifying AVATAR models (AMULET is a language enabling the description
......@@ -126,7 +141,7 @@ opened AVATAR model.</p>
<h3 id="capecs">CAPECs</h3>
<p>To use CAPECs, you may need to position the path to the python
version you wish to use. For instance:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode xml"><code class="sourceCode xml"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>&lt;<span class="kw">PythonPathForCapecs</span><span class="ot"> data=</span><span class="st">&quot;/usr/bin/python3.10&quot;</span> /&gt;</span></code></pre></div>
<div class="sourceCode" id="cb3"><pre
class="sourceCode xml"><code class="sourceCode xml"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a>&lt;<span class="kw">PythonPathForCapecs</span><span class="ot"> data=</span><span class="st">&quot;/usr/bin/python3.10&quot;</span> /&gt;</span></code></pre></div>
</body>
</html>
......@@ -9,6 +9,13 @@ TTool must first be configured before using AI. Add the following information to
```
This is required to have a valid openai account and available tokens.
Similarly, you can use a mistralAI key.
```xml
<MistralAIKey data="put your key here"/>
<MistralAIModel data="pixtral-12b-2409"/>
```
## How to use AI?
First, select what you intend to do at the top of the AI window:
......@@ -21,6 +28,13 @@ Enter your question in the "Question" textarea, and click on "Start"
### Classify requirements
This options intends to automatically identify the "kind" attributes of requirements. Open a requirement diagram with at least one requirement, and click on "start". If the classification proposed by the AI (see the "Answer text area") suits you, you can click on "Apply response" to update the opened requirement diagram.
### Generate block diagrams
Provide a system specification. The AI will compute a liste of blocks (including their atributes and signals), and will connect them. Once the AI has finished computed a block diagram, click on "apply" to get the block diagram drawn in TTool
### Generate state machine diagrams
Provide a system specification, and select in TTool a block diagram. The AI will compute states machines. Once computed, click on "apply" to get the state machines drawn in TTool (TTool duplicated the block diagram to be certain not to erase your former state machines).
### A(I)MULET
This option enables to automatically generate AMULET commands for modifying AVATAR models (AMULET is a language enabling the description of AVATAR
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment