Improve documentation

ThomasVitale · Jan 22, 2024 · ebd8f43 · ebd8f43
1 parent c930d63
commit ebd8f43
Show file tree

Hide file tree

Showing 14 changed files with 172 additions and 8 deletions.
diff --git a/01-chat-models/chat-models-ollama/README.md b/01-chat-models/chat-models-ollama/README.md
@@ -1,9 +1,25 @@
 # Chat Models: Ollama
 
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
+
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http :8080/ai/chat
 ```
diff --git a/01-chat-models/chat-models-openai/README.md b/01-chat-models/chat-models-openai/README.md
@@ -1,13 +1,19 @@
 # Chat Models: OpenAI
 
+## Running the application
+
+### When using OpenAI
+
 ```shell
 export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
 ```
 
 ```shell
-./gradlew bootTestRun
+./gradlew bootRun
 ```
 
+## Calling the application
+
 ```shell
 http :8080/ai/chat
 ```

diff --git a/02-prompts/prompts-basics-ollama/README.md b/02-prompts/prompts-basics-ollama/README.md
@@ -1,9 +1,25 @@
 # Prompts Basic: Ollama
 
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
+
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http --raw "What is the capital of Italy?" :8080/ai/chat/simple
 ```

diff --git a/02-prompts/prompts-basics-openai/README.md b/02-prompts/prompts-basics-openai/README.md
@@ -1,13 +1,19 @@
 # Prompts Basic: OpenAI
 
+## Running the application
+
+### When using OpenAI
+
 ```shell
 export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
 ```
 
 ```shell
-./gradlew bootTestRun
+./gradlew bootRun
 ```
 
+## Calling the application
+
 ```shell
 http --raw "What is the capital of Italy?" :8080/ai/chat/simple
 ```

diff --git a/02-prompts/prompts-messages-ollama/README.md b/02-prompts/prompts-messages-ollama/README.md
@@ -1,9 +1,25 @@
 # Prompts Messages: Ollama
 
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
+
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http --raw "What is the capital of Italy?" :8080/ai/chat/single
 ```

diff --git a/02-prompts/prompts-messages-openai/README.md b/02-prompts/prompts-messages-openai/README.md
@@ -1,13 +1,19 @@
 # Prompts Messages: OpenAI
 
+## Running the application
+
+### When using OpenAI
+
 ```shell
 export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
 ```
 
 ```shell
-./gradlew bootTestRun
+./gradlew bootRun
 ```
 
+## Calling the application
+
 ```shell
 http --raw "What is the capital of Italy?" :8080/ai/chat/single
 ```

diff --git a/02-prompts/prompts-templates-ollama/README.md b/02-prompts/prompts-templates-ollama/README.md
@@ -1,9 +1,25 @@
 # Prompts Templates: Ollama
 
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
+
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http :8080/ai/chat/user genre="rock" instrument="piano"
 ```

diff --git a/02-prompts/prompts-templates-openai/README.md b/02-prompts/prompts-templates-openai/README.md
@@ -1,13 +1,19 @@
 # Prompts Templates: OpenAI
 
+## Running the application
+
+### When using OpenAI
+
 ```shell
 export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
 ```
 
 ```shell
-./gradlew bootTestRun
+./gradlew bootRun
 ```
 
+## Calling the application
+
 ```shell
 http :8080/ai/chat/user genre="rock" instrument="piano"
 ```

diff --git a/03-output-parsers/output-parsers-ollama/README.md b/03-output-parsers/output-parsers-ollama/README.md
@@ -1,9 +1,25 @@
 # Output Parsers: Ollama
 
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
+
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http :8080/ai/chat/bean genre="rock" instrument="piano"
 ```

diff --git a/03-output-parsers/output-parsers-openai/README.md b/03-output-parsers/output-parsers-openai/README.md
@@ -1,13 +1,19 @@
 # Output Parsers: OpenAI
 
+## Running the application
+
+### When using OpenAI
+
 ```shell
 export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
 ```
 
 ```shell
-./gradlew bootTestRun
+./gradlew bootRun
 ```
 
+## Calling the application
+
 ```shell
 http :8080/ai/chat/bean genre="rock" instrument="piano"
 ```

diff --git a/04-embedding-models/embedding-models-ollama/README.md b/04-embedding-models/embedding-models-ollama/README.md
@@ -1,9 +1,25 @@
 # Embedding Models: Ollama
 
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
+
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http :8080/ai/embed
 ```
diff --git a/04-embedding-models/embedding-models-openai/README.md b/04-embedding-models/embedding-models-openai/README.md
@@ -1,13 +1,19 @@
 # Embedding Models: OpenAI
 
+## Running the application
+
+### When using OpenAI
+
 ```shell
 export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
 ```
 
 ```shell
-./gradlew bootTestRun
+./gradlew bootRun
 ```
 
+## Calling the application
+
 ```shell
 http :8080/ai/embed
 ```
diff --git a/05-document-readers/document-readers-json-ollama/README.md b/05-document-readers/document-readers-json-ollama/README.md
@@ -1,9 +1,25 @@
-# Embedding Models: Ollama
+# JSON Document Readers: Ollama
+
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
 
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http --raw "What bike is good for city commuting?" :8080/ai/doc/chat
 ```
diff --git a/05-document-readers/document-readers-text-ollama/README.md b/05-document-readers/document-readers-text-ollama/README.md
@@ -1,9 +1,25 @@
-# Embedding Models: Ollama
+# Text Document Readers: Ollama
+
+## Running the application
+
+### When using Ollama
+
+```shell
+ollama run llama2
+```
 
 ```shell
 ./gradlew bootTestRun
 ```
 
+### When using Docker/Podman
+
+```shell
+./gradlew bootTestRun
+```
+
+## Calling the application
+
 ```shell
 http --raw "What is Iorek's biggest dream?" :8080/ai/doc/chat
 ```