Document response stream chunk delimiter. (#632)

Document response stream chunk delimiter.
ollama · Sep 30, 2023 · 1d0ebe6 · 1d0ebe6
1 parent a1b2d95
commit 1d0ebe6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -23,6 +23,10 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a
 
 All durations are returned in nanoseconds.
 
+### Streaming responses
+
+Certain endpoints stream responses as JSON objects delineated with the newline (`\n`) character.
+
 ## Generate a completion
 
 ```shell

diff --git a/server/routes.go b/server/routes.go
@@ -610,6 +610,7 @@ func streamResponse(c *gin.Context, ch chan any) {
 			return false
 		}
 
+		// Delineate chunks with new-line delimiter
 		bts = append(bts, '\n')
 		if _, err := w.Write(bts); err != nil {
 			log.Printf("streamResponse: w.Write failed with %s", err)