add stream docs to ChatRequest

CJCrafter · CJCrafter · commit 5d8cdc3a418f · 2023-03-24T13:47:37.000-04:00
diff --git a/src/main/kotlin/com/cjcrafter/openai/chat/ChatRequest.kt b/src/main/kotlin/com/cjcrafter/openai/chat/ChatRequest.kt
@@ -20,7 +20,9 @@ import com.google.gson.annotations.SerializedName
  * calls. You can easily store your [ChatRequest] as a string or as a json file
  * using google's GSON library to serialize the object as a JSON string.
  *
- * You should not set [stream]. TODO update docs after adding stream support
+ * You should not set [stream]. The stream option is handled using [ChatBot.streamResponse].
+ * This allows developers to get tokens in real time instead of all at once
+ * and after a long delay.
  *
  * @property model            The model used to generate the text. Recommended: `"gpt-3.5-turbo"` (without quotes).
  * @property messages         A mutable list of previous messages from the conversation.

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@ import com.google.gson.annotations.SerializedName`
`20`	`20`	`* calls. You can easily store your [ChatRequest] as a string or as a json file`
`21`	`21`	`* using google's GSON library to serialize the object as a JSON string.`
`22`	`22`	`*`
`23`		`- * You should not set [stream]. TODO update docs after adding stream support`
	`23`	`+ * You should not set [stream]. The stream option is handled using [ChatBot.streamResponse].`
	`24`	`+ * This allows developers to get tokens in real time instead of all at once`
	`25`	`+ * and after a long delay.`
`24`	`26`	`*`
`25`	`27`	* @property model The model used to generate the text. Recommended: `"gpt-3.5-turbo"` (without quotes).
`26`	`28`	`* @property messages A mutable list of previous messages from the conversation.`