Skip to content

Commit 30d1582

Browse files
committed
refactor: add JavaDoc for imageGenerations()
1 parent ccff2bb commit 30d1582

File tree

1 file changed

+13
-0
lines changed
  • ychat/src/commonMain/kotlin/co/yml/ychat

1 file changed

+13
-0
lines changed

ychat/src/commonMain/kotlin/co/yml/ychat/YChat.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,19 @@ interface YChat {
7878
*/
7979
fun chatCompletions(): ChatCompletions
8080

81+
/**
82+
* The image generations api is used to generate images based on a prompt. You input some text as a
83+
* prompt, and the model will generate one or more images.
84+
*
85+
* You can configure the parameters of the completion before executing it. Example:
86+
* ```
87+
* val result = YChat.create(apiKey).imageGenerations()
88+
* .setResults(2)
89+
* .setSize(1024x1024)
90+
* .set...
91+
* .execute("/image ocean")
92+
* ```
93+
*/
8194
fun imageGenerations(): ImageGenerations
8295

8396
/**

0 commit comments

Comments
 (0)