|
1 | | -[](https://maven-badges.herokuapp.com/maven-central/co.yml/ychatgpt/) |
| 1 | +[](https://maven-badges.herokuapp.com/maven-central/co.yml/ychat/) |
2 | 2 |  |
3 | | - |
4 | | - |
| 3 | + |
| 4 | + |
5 | 5 |
|
6 | | -# YChatGPT |
| 6 | +# YChat |
7 | 7 |
|
8 | | -YChatGPT is a Kotlin Multiplatform (KMP) project that provides a simple API for integrating the powerful ChatGPT language model developed by OpenAI into mobile applications running on both iOS and Android. The goal of this project is to abstract all the API call logic from ChatGPT, allowing developers to easily leverage the capabilities of the language model in their mobile applications. |
| 8 | +YChat is a Kotlin Multiplatform (KMP) project that provides a simple API for integrating the powerful ChatGPT language model developed by OpenAI into mobile applications running on both iOS and Android. The goal of this project is to abstract all the API call logic from ChatGPT, allowing developers to easily leverage the capabilities of the language model in their mobile applications. |
9 | 9 |
|
10 | | -The repository contains the source code for the YChatGPT library, along with examples and documentation for getting started with the library. The YChatGPT library provides a consistent interface for interacting with ChatGPT, regardless of the platform, and makes it easy to generate human-like text based on a given prompt or context. |
| 10 | +The repository contains the source code for the YChat library, along with examples and documentation for getting started with the library. The YChat library provides a consistent interface for interacting with ChatGPT, regardless of the platform, and makes it easy to generate human-like text based on a given prompt or context. |
11 | 11 |
|
12 | | -The library uses Kotlin Multiplatform to generate artifacts for both iOS and Android, allowing developers to write code once and use it on both platforms. The project is open source and actively maintained, with contributions from the community encouraged. Overall, YChatGPT provides a convenient and powerful way for mobile developers to incorporate the advanced natural language processing capabilities of ChatGPT into their applications. |
| 12 | +The library uses Kotlin Multiplatform to generate artifacts for both iOS and Android, allowing developers to write code once and use it on both platforms. The project is open source and actively maintained, with contributions from the community encouraged. Overall, YChat provides a convenient and powerful way for mobile developers to incorporate the advanced natural language processing capabilities of ChatGPT into their applications. |
13 | 13 |
|
14 | 14 |
|
15 | 15 | ## iOS setup |
16 | 16 |
|
17 | 17 | - Go to your project’s file settings and click "Add Package": |
18 | 18 |
|
19 | | - |
| 19 | + |
20 | 20 |
|
21 | | -- To add a new package, search for https://github.com/yml-org/ychatgpt-sdk.git in the top right corner: |
| 21 | +- To add a new package, search for https://github.com/yml-org/ychat.git in the top right corner: |
22 | 22 |
|
23 | | - |
| 23 | + |
24 | 24 |
|
25 | 25 | Once you have found the package click the "Add Package" button to add it to your project. Now you can start using the SDK in your iOS project! |
26 | 26 |
|
27 | 27 | See the code snippet below on how to initialize and use it: |
28 | 28 |
|
29 | 29 | ```swift |
30 | | -var yChatGpt: YChatGpt { |
31 | | - YChatGptCompanion.shared.create(apiKey: "your-api-key") |
| 30 | +var yChat: YChat { |
| 31 | + YChatCompanion.shared.create(apiKey: "your-api-key") |
32 | 32 | } |
33 | 33 |
|
34 | 34 | do { |
@@ -58,19 +58,19 @@ repositories { |
58 | 58 | Then, simply import the dependency to your common source-set dependencies: |
59 | 59 |
|
60 | 60 | ```kotlin |
61 | | -implementation("co.yml:ychatgpt:1.0.0") |
| 61 | +implementation("co.yml:ychat:1.0.0") |
62 | 62 | ``` |
63 | 63 |
|
64 | 64 | In the snippet below, you can see how to initialize the object and perform a first search: |
65 | 65 |
|
66 | 66 |
|
67 | 67 | ```kotlin |
68 | | -val yChatGpt by lazy { |
69 | | - YChatGpt.create("your-api-key") |
| 68 | +val yChat by lazy { |
| 69 | + YChat.create("your-api-key") |
70 | 70 | } |
71 | 71 |
|
72 | 72 | try { |
73 | | - val result = yChatGpt.completion() |
| 73 | + val result = yChat.completion() |
74 | 74 | .setInput("Say this is a test.") |
75 | 75 | .saveHistory(false) |
76 | 76 | .setMaxTokens(1024) |
|
84 | 84 |
|
85 | 85 | ## 🤝 Contributions |
86 | 86 |
|
87 | | -Feel free to make a suggestion or if you find any error in this project, please open an issue. Make sure to read our [contribution guidelines](https://github.com/yml-org/ychatgpt-sdk/blob/main/CONTRIBUTING.md) before. |
| 87 | +Feel free to make a suggestion or if you find any error in this project, please open an issue. Make sure to read our [contribution guidelines](https://github.com/yml-org/ychat/blob/main/CONTRIBUTING.md) before. |
88 | 88 |
|
89 | 89 | ## License |
90 | 90 |
|
|
0 commit comments