浏览代码

Document response stream chunk delimiter. (#632)

Document response stream chunk delimiter.
Jay Nakrani 1 年之前
父节点
当前提交
1d0ebe67e8
共有 2 个文件被更改,包括 5 次插入0 次删除
  1. 4 0
      docs/api.md
  2. 1 0
      server/routes.go

+ 4 - 0
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

+ 1 - 0
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)