community: fix maritalk notebook links and markdown cell type (#11290)

b4bd168c · Rodrigo Nogueira · GitHub · 934d0486 · b4bd168c
Unverified Commit b4bd168c authored 1 year ago by Rodrigo Nogueira Committed by GitHub 1 year ago
--- a/docs/examples/llm/maritalk.ipynb
+++ b/docs/examples/llm/maritalk.ipynb
@@ -10,7 +10,7 @@
    "\n",
    "## Introduction\n",
    "\n",
-    "MariTalk is an assistant developed by the Brazilian company [Maritaca AI](www.maritaca.ai).\n",
+    "MariTalk is an assistant developed by the Brazilian company [Maritaca AI](https://www.maritaca.ai).\n",
    "MariTalk is based on language models that have been specially trained to understand Portuguese well.\n",
    "\n",
    "This notebook demonstrates how to use MariTalk with llama-index through a simple example."
@@ -30,8 +30,8 @@
   "metadata": {},
   "outputs": [],
   "source": [
-    "%pip install llama-index-llms-maritalk\n",
+    "!pip install llama-index\n",
-    "!pip install llama-index"
+    "!pip install llama-index-llms-maritalk"
   ]
  },
  {
@@ -80,10 +80,8 @@
   ]
  },
  {
-   "cell_type": "code",
+   "cell_type": "markdown",
-   "execution_count": null,
   "metadata": {},
-   "outputs": [],
   "source": [
    "### Few-shot examples\n",
    "\n",

 %% Cell type:markdown id: tags:
 <a href="https://colab.research.google.com/github/run-llama/llama_index/blob/main/docs/examples/llm/maritalk.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
 # Maritalk
 ## Introduction
-MariTalk is an assistant developed by the Brazilian company [Maritaca AI](www.maritaca.ai).
+MariTalk is an assistant developed by the Brazilian company [Maritaca AI](https://www.maritaca.ai).
 MariTalk is based on language models that have been specially trained to understand Portuguese well.
 This notebook demonstrates how to use MariTalk with llama-index through a simple example.
 %% Cell type:markdown id: tags:
 ## Installation
 If you're opening this Notebook on colab, you will probably need to install LlamaIndex.
 %% Cell type:code id: tags:
 ``` 
-%pip install llama-index-llms-maritalk
 !pip install llama-index
+!pip install llama-index-llms-maritalk
 ```
 %% Cell type:markdown id: tags:
 ## API Key
 You will need an API key that can be obtained from chat.maritaca.ai ("Chaves da API" section).
 %% Cell type:markdown id: tags:
 ## Usage
 ### Chat
 %% Cell type:code id: tags:
 ``` 
 from llama_index.core.llms import ChatMessage
 from llama_index.llms.maritalk import Maritalk
 # To customize your API key, do this
 # otherwise it will lookup MARITALK_API_KEY from your env variable
 # llm = Maritalk(api_key="<your_maritalk_api_key>")
 llm = Maritalk()
 # Call chat with a list of messages
 messages = [
    ChatMessage(
        role="system",
        content="You are an assistant specialized in suggesting pet names. Given the animal, you must suggest 4 names.",
    ),
    ChatMessage(role="user", content="I have a dog."),
 ]
 response = llm.chat(messages)
 print(response)
 ```
-%% Cell type:code id: tags:
+%% Cell type:markdown id: tags:
-``` 
 ### Few-shot examples
 We recommend using the `llm.complete()` method when using the model with few-shot examples
-```
 %% Cell type:code id: tags:
 ``` 
 prompt = """Classifique a resenha de filme como "positiva" ou "negativa".
 Resenha: Gostei muito do filme, é o melhor do ano!
 Classe: positiva
 Resenha: O filme deixa muito a desejar.
 Classe: negativa
 Resenha: Apesar de longo, valeu o ingresso..
 Classe:"""
 response = llm.complete(prompt, stopping_tokens=["\n"])
 print(response)
 ```