|
| 1 | +# Features |
| 2 | + |
| 3 | +- [Completion](#completion) |
| 4 | +- [ChatCompletions](#chatcompletions) |
| 5 | +- [ImageGenerations](#imagegenerations) |
| 6 | +- [Edits](#edits) |
| 7 | + |
| 8 | +## Completion |
| 9 | + |
| 10 | +The completions api can be used for a wide variety of tasks. You input some text as a prompt, and the model will generate a text completion that attempts to match whatever context or pattern you gave it. For example, if you give the API the prompt, "As Descartes said, I think, therefore", it will return the completion " I am" with high probability. |
| 11 | + |
| 12 | +### Swift |
| 13 | + |
| 14 | +```swift |
| 15 | +var yChat: YChat { |
| 16 | + YChatCompanion.shared.create(apiKey: "your-api-key") |
| 17 | +} |
| 18 | + |
| 19 | +do { |
| 20 | + let result = try await chatGpt.completion() |
| 21 | + .setInput(input: "Say this is a test.") |
| 22 | + .setMaxTokens(tokens: 1024) |
| 23 | + .set... // you can set more parameters |
| 24 | + .execute() |
| 25 | +} catch { |
| 26 | + // catch any error that may occurs on api call. |
| 27 | +} |
| 28 | +``` |
| 29 | + |
| 30 | +### Kotlin |
| 31 | + |
| 32 | +```kotlin |
| 33 | +val yChat by lazy { |
| 34 | + YChat.create("your-api-key") |
| 35 | +} |
| 36 | + |
| 37 | +try { |
| 38 | + val result = yChat.completion() |
| 39 | + .setInput("Say this is a test.") |
| 40 | + .setMaxTokens(1024) |
| 41 | + .set... // you can set more parameters |
| 42 | + .execute() |
| 43 | + |
| 44 | +} catch (e: exception) { |
| 45 | + // catch any error that may occurs on api call. |
| 46 | +} |
| 47 | +``` |
| 48 | + |
| 49 | +## ChatCompletions |
| 50 | + |
| 51 | +The chatCompletions api generates a list of chat completions for the given input message. It uses machine learning algorithms to generate responses that match the context or pattern provided in the input message. |
| 52 | + |
| 53 | +### Swift |
| 54 | + |
| 55 | +```swift |
| 56 | +var yChat: YChat { |
| 57 | + YChatCompanion.shared.create(apiKey: "your-api-key") |
| 58 | +} |
| 59 | + |
| 60 | +do { |
| 61 | + let result = try await chatGpt.chatCompletions() |
| 62 | + .setMaxTokens(tokens: 1024) |
| 63 | + .addMessage( |
| 64 | + role: "assistant", |
| 65 | + content: "You are a helpful assistant that only answers questions related to fitness" |
| 66 | + ) |
| 67 | + .set... // you can set more parameters |
| 68 | + .execute(content: "What is the best exercise for building muscle?") |
| 69 | +} catch { |
| 70 | + // catch any error that may occurs on api call. |
| 71 | +} |
| 72 | +``` |
| 73 | + |
| 74 | +### Kotlin |
| 75 | + |
| 76 | +```kotlin |
| 77 | +val yChat by lazy { |
| 78 | + YChat.create("your-api-key") |
| 79 | +} |
| 80 | + |
| 81 | +try { |
| 82 | + val result = yChat.chatCompletions() |
| 83 | + .setMaxTokens(1024) |
| 84 | + .addMessage( |
| 85 | + role = "assistant", |
| 86 | + content = "You are a helpful assistant that only answers questions related to fitness" |
| 87 | + ) |
| 88 | + .set... // you can set more parameters |
| 89 | + .execute("What is the best exercise for building muscle?") |
| 90 | + |
| 91 | +} catch (e: exception) { |
| 92 | + // catch any error that may occurs on api call. |
| 93 | +} |
| 94 | +``` |
| 95 | + |
| 96 | +## ImageGenerations |
| 97 | + |
| 98 | +The image generations api is used to generate images based on a prompt. You input some text as a prompt, and the model will generate one or more images. |
| 99 | + |
| 100 | +### Swift |
| 101 | + |
| 102 | +```swift |
| 103 | +var yChat: YChat { |
| 104 | + YChatCompanion.shared.create(apiKey: "your-api-key") |
| 105 | +} |
| 106 | + |
| 107 | +do { |
| 108 | + let result = try await chatGpt.imageGenerations() |
| 109 | + .setResults(results: 2) |
| 110 | + .setSize(size: "1024x1024") |
| 111 | + .set... // you can set more parameters |
| 112 | + .execute(prompt: "ocean") |
| 113 | +} catch { |
| 114 | + // catch any error that may occurs on api call. |
| 115 | +} |
| 116 | +``` |
| 117 | + |
| 118 | +### Kotlin |
| 119 | + |
| 120 | +```kotlin |
| 121 | +val yChat by lazy { |
| 122 | + YChat.create("your-api-key") |
| 123 | +} |
| 124 | + |
| 125 | +try { |
| 126 | + val result = yChat.imageGenerations() |
| 127 | + .setResults(2) |
| 128 | + .setSize("1024x1024") |
| 129 | + .set... // you can set more parameters |
| 130 | + .execute("ocean") |
| 131 | + |
| 132 | +} catch (e: exception) { |
| 133 | + // catch any error that may occurs on api call. |
| 134 | +} |
| 135 | +``` |
| 136 | + |
| 137 | +## Edits |
| 138 | + |
| 139 | +The edits api is used to edit prompts and re-generate. Given a prompt and an instruction, the model will return an edited version of the prompt. |
| 140 | + |
| 141 | +### Swift |
| 142 | + |
| 143 | +```swift |
| 144 | +var yChat: YChat { |
| 145 | + YChatCompanion.shared.create(apiKey: "your-api-key") |
| 146 | +} |
| 147 | + |
| 148 | +do { |
| 149 | + let result = try await chatGpt.edits() |
| 150 | + .setInput(input: "What day of the wek is it?") |
| 151 | + .setResults(result: 1) |
| 152 | + .set... // you can set more parameters |
| 153 | + .execute(instruction: "Fix the spelling mistakes") |
| 154 | +} catch { |
| 155 | + // catch any error that may occurs on api call. |
| 156 | +} |
| 157 | +``` |
| 158 | + |
| 159 | +### Kotlin |
| 160 | + |
| 161 | +```kotlin |
| 162 | +val yChat by lazy { |
| 163 | + YChat.create("your-api-key") |
| 164 | +} |
| 165 | + |
| 166 | +try { |
| 167 | + val result = yChat.edits() |
| 168 | + .setInput("What day of the wek is it?") |
| 169 | + .setResults(1) |
| 170 | + .set... // you can set more parameters |
| 171 | + .execute("Fix the spelling mistakes") |
| 172 | + |
| 173 | +} catch (e: exception) { |
| 174 | + // catch any error that may occurs on api call. |
| 175 | +} |
| 176 | +``` |
0 commit comments