Update documents for ver0.6.0

Author: mochi-neko

Assets/Mochineko/ChatGPT_API.Relent/package.json

@@ -1,11 +1,17 @@
 {
   "name": "com.mochineko.chatgpt-api.relent",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "displayName": "ChatGPT API / Relent",
   "description": "ChatGPT API implementation by Relent.",
   "unity": "2021.3",
   "author": {
     "name": "Mochineko",
     "email": "[email protected]"
+  },
+  "dependencies": {
+    "com.mochineko.chatgpt-api": "https://github.com/mochi-neko/ChatGPT-API-unity.git?path=/Assets/Mochineko/ChatGPT_API#0.6.0",
+    "com.mochineko.relent": "https://github.com/mochi-neko/Relent.git?path=/Assets/Mochineko/Relent#0.2.0",
+    "com.unity.nuget.newtonsoft-json": "3.0.2",
+    "com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask"
   }
 }

Assets/Mochineko/ChatGPT_API/package.json

@@ -1,11 +1,14 @@
 {
   "name": "com.mochineko.chatgpt-api",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "displayName": "ChatGPT API",
   "description": "ChatGPT chat completion API bindings to pure C#.",
   "unity": "2021.3",
   "author": {
     "name": "Mochineko",
     "email": "[email protected]"
+  },
+  "dependencies": {
+    "com.unity.nuget.newtonsoft-json": "3.0.2"
   }
 }

CHANGELOG.md

@@ -11,6 +11,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add [moderation layer](https://platform.openai.com/docs/guides/chat/adding-a-moderation-layer)
 
+## [0.6.0] - 2023-06-14
+
+### Added
+
+- Add 16k context turbo model option.
+- Add function calling support.
+- Add optional `name` property to `Message`.
+- Add verbose log option.
+
+## Changed
+
+- Update chat models at 2023-06-13.
+- Add dependencies to `package.json`.
+
 ## [0.5.0] - 2023-04-08
 
 ### Changed

NOTICE.md

@@ -1,6 +1,6 @@
 # NOTICE
 
-This repository use these 3rd party libraries via UnityPackageManager.
+This repository uses these 3rd party libraries.
 
 ## NewtonSoft Json
 
@@ -41,7 +41,6 @@ Unity Technologies ApS (“Unity”) grants to you a worldwide, non-exclusive, n
 10. Governing Law and Venue. This License is governed by and construed in accordance with the laws of Denmark, except for its conflict of laws rules; the United Nations Convention on Contracts for the International Sale of Goods will not apply. If you reside (or your principal place of business is) within the United States, you and Unity agree to submit to the personal and exclusive jurisdiction of and venue in the state and federal courts located in San Francisco County, California concerning any dispute arising out of this License (“Dispute”). If you reside (or your principal place of business is) outside the United States, you and Unity agree to submit to the personal and exclusive jurisdiction of and venue in the courts located in Copenhagen, Denmark concerning any Dispute.
 ```
 
-
 https://www.newtonsoft.com/json
 
 ```
@@ -67,7 +66,6 @@ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
 
-
 ## Fluent Assertions for Unity
 
 https://github.com/BoundfoxStudios/fluentassertions-unity
@@ -276,7 +274,6 @@ https://github.com/BoundfoxStudios/fluentassertions-unity
    limitations under the License.
 ```
 
-
 ## UniTask
 
 https://github.com/Cysharp/UniTask
@@ -335,7 +332,6 @@ SOFTWARE.
 
 ```
 
-
 ## Relent
 
 https://github.com/mochi-neko/Relent

README.md

@@ -1,27 +1,22 @@
 # ChatGPT-API-unity
 
-Binds [ChatGPT chat completion API](https://platform.openai.com/docs/api-reference/chat/create) to pure C# on Unity.
+A client library of [ChatGPT chat completion API](https://platform.openai.com/docs/api-reference/chat/create) for Unity.
 
-See also [official document](https://platform.openai.com/docs/guides/chat).
+See also official [document](https://platform.openai.com/docs/guides/chat) and [API reference](https://platform.openai.com/docs/api-reference/chat).
 
-## How to import by UnityPackageManager
+## How to import by Unity Package Manager
 
-Add dependencies:
+Add following dependencies to your `/Packages/mainfest.json`.
 
 ```json
 {
   "dependencies": {
-    "com.mochineko.chatgpt-api": "https://github.com/mochi-neko/ChatGPT-API-unity.git?path=/Assets/Mochineko/ChatGPT_API#0.5.0",
-    "com.unity.nuget.newtonsoft-json": "3.0.2",
+    "com.mochineko.chatgpt-api": "https://github.com/mochi-neko/ChatGPT-API-unity.git?path=/Assets/Mochineko/ChatGPT_API#0.6.0",
     ...
   }
 }
 ```
 
-to your `mainfest.json`.
-
-If you have already used Newtonsoft.Json on your project, remove dependency:`"com.unity.nuget.newtonsoft-json": "3.0.2",`.
-
 ## How to use chat completion by ChatGPT API
 
 1. Generate API key on [OpenAI](https://platform.openai.com/account/api-keys). (Take care your API key, this is a secret information then you should not open.)
@@ -142,20 +137,7 @@ namespace Mochineko.ChatGPT_API.Samples
 }
 ```
 
-NOTICE that this sample requres these dependencies:
-
-```json
-{
-  "dependencies": {
-    "com.mochineko.chatgpt-api": "https://github.com/mochi-neko/ChatGPT-API-unity.git?path=/Assets/Mochineko/ChatGPT_API#0.5.0",
-    "com.unity.nuget.newtonsoft-json": "3.0.2",
-    "com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask",
-    ...
-  }
-}
-```
-
-See also [Sample](https://github.com/mochi-neko/ChatGPT-API-unity/blob/main/Assets/Mochineko/ChatGPT_API.Samples/ChatCompletionSample.cs).
+See also [Sample](./Assets/Mochineko/ChatGPT_API.Samples/ChatCompletionSample.cs).
 
 ## How to use chat completion by ChatGPT API more resilient
 
@@ -167,10 +149,7 @@ You can use API with explicit error handling, retry, timeout, bulkhead, and so o
 ```json
 {
   "dependencies": {
-    "com.mochineko.chatgpt-api": "https://github.com/mochi-neko/ChatGPT-API-unity.git?path=/Assets/Mochineko/ChatGPT_API#0.5.0",
-    "com.mochineko.chatgpt-api.relent": "https://github.com/mochi-neko/ChatGPT-API-unity.git?path=/Assets/Mochineko/ChatGPT_API.Relent#0.5.0",
-    "com.unity.nuget.newtonsoft-json": "3.0.2",
-    "com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask",
+    "com.mochineko.chatgpt-api.relent": "https://github.com/mochi-neko/ChatGPT-API-unity.git?path=/Assets/Mochineko/ChatGPT_API.Relent#0.6.0",
     ...
   }
 }
@@ -216,14 +195,23 @@ Presets are available:
 - `FiniteTokenLengthQueueWithFixedPromptsChatMemory`
   - A queue that has max number of token lenght of user/assistant messages and free number of prompts (system messages).
 
+## How to use function calling
+
+1. Define function with JSON schema.
+2. Specify function by request parameters.
+3. Call chat completion API.
+4. Use `result.Choices[0].Message.FunctionCall` 
+
+See `FunctionCalling()` in [test code](./Assets/Mochineko/ChatGPT_API.Tests/ChatCompletionAPIConnectionTest.cs).
+
 ## Changelog
 
-See [CHANGELOG](https://github.com/mochi-neko/ChatGPT-API-unity/blob/main/CHANGELOG.md).
+See [CHANGELOG](./CHANGELOG.md).
 
 ## 3rd Party Notices
 
-See [NOTICE](https://github.com/mochi-neko/ChatGPT-API-unity/blob/main/NOTICE.md).
+See [NOTICE](./NOTICE.md).
 
 ## License
 
-Licensed under the [MIT](https://github.com/mochi-neko/ChatGPT-API-unity/blob/main/LICENSE) license.
+Licensed under the [MIT](./LICENSE) license.