Update README.md

README.md

@@ -12,7 +12,39 @@ Benchmark Results:
 SciPhi-AI is available via a free hosted API, though the exposed model can vary. Currently, SciPhi-Self-RAG-Mistral-7B-32k is available. More details can be found in the docs [here](https://sciphi.readthedocs.io/en/latest/setup/quickstart.html).
 
 
+## Recommended Chat Formatting
 
+```python
+
+
+def get_chat_completion(
+    self, conversation: list[dict], generation_config: GenerationConfig
+) -> str:
+    self._check_stop_token(generation_config.stop_token)
+    prompt = ""
+    added_system_prompt = False
+    for message in conversation:
+        if message["role"] == "system":
+            prompt += f"### System:\n{SciPhiLLMInterface.ALPACA_CHAT_SYSTEM_PROMPT}. Further, the assistant is given the following additional instructions - {message['content']}\n\n"
+            added_system_prompt = True
+        elif message["role"] == "user":
+            last_user_message = message["content"]
+            prompt += f"### Instruction:\n{last_user_message}\n\n"
+        elif message["role"] == "assistant":
+            prompt += f"### Response:\n{message['content']}\n\n"
+
+    if not added_system_prompt:
+        prompt = f"### System:\n{SciPhiLLMInterface.ALPACA_CHAT_SYSTEM_PROMPT}.\n\n{prompt}"
+
+    context = self.rag_interface.get_contexts([last_user_message])[0]
+    prompt += f"### Response:\n{SciPhiFormatter.RETRIEVAL_TOKEN} {SciPhiFormatter.INIT_PARAGRAPH_TOKEN}{context}{SciPhiFormatter.END_PARAGRAPH_TOKEN}"
+    latest_completion = self.model.get_instruct_completion(
+        prompt, generation_config
+    ).strip()
+
+    return SciPhiFormatter.remove_cruft(latest_completion)
+
+```
 ## Model Architecture
 
 Base Model: Mistral-7B-v0.1