Added project files.

Author: Uralstech

.github/workflows/upm-subtree-split.yml

@@ -19,4 +19,4 @@ jobs:
 
     - uses: RageAgainstThePixel/upm-subtree-split@v1.1
       with:
-        package-root: "**/Packages/com.uralstech.package-name"
+        package-root: "**/Packages/com.uralstech.uai.abstraction"

Documentation/DocSource/QuickStart.md

@@ -4,4 +4,103 @@ Please note that the code provided in this page is *purely* for learning purpose
 
 ## Breaking Changes Notice
 
-If you've just updated the package, it is recommended to check the [*changelogs*](https://github.com/Uralstech/PackageName/releases) for information on breaking changes.
+If you've just updated the package, it is recommended to check the [*changelogs*](https://github.com/Uralstech/UAI.Abstraction/releases) for information on breaking changes.
+
+## Setup
+
+This plugin only provides abstraction for the chat completion APIs provided by *other* third party libraries. The plugin itself does not contain the code to interact with
+the Gemini or GPT APIs. The Gemini client relies on [*UGemini*](https://uralstech.github.io/UGemini/), and the OpenAI client relies on
+[*com.openai.unity*](https://rageagainstthepixel.github.io/OpenAI-DotNet/).
+
+Authentication is also handled by the third party libraries. See [*UGemini: Setup*](https://uralstech.github.io/UGemini/DocSource/QuickStart.html#setup) and
+[*com.openai.unity: Authentication*](https://rageagainstthepixel.github.io/OpenAI-DotNet/README.html#authentication)
+
+Now you can create an instance of the desired API client. For Gemini:
+
+```csharp
+using Uralstech.UAI.Abstraction;
+using Uralstech.UAI.Abstraction.Providers.Gemini;
+
+IModelClient client = new GeminiModelClient();
+```
+
+For OpenAI:
+
+```csharp
+using Uralstech.UAI.Abstraction;
+using Uralstech.UAI.Abstraction.Providers.OAI;
+
+IModelClient client = new OAIModelClient();
+```
+
+## Chat
+
+You can chat with the model using [`IModelClient.Chat`](~/api/Uralstech.UAI.Abstraction.IModelClient.yml#Uralstech_UAI_Abstraction_IModelClient_Chat_System_Collections_Generic_IReadOnlyList_Uralstech_UAI_Abstraction_Message__System_String_System_Boolean_System_Threading_CancellationToken_).
+
+```csharp
+using Uralstech.UAI.Abstraction.Chat;
+
+ChatInferenceResult result = await client.Chat(new Message[]
+{
+    new Message(Role.System, "You are a helpful, friendly assistant."),
+    new Message(Role.User, "What is the capital of India?")
+});
+
+Debug.Log("Response: " + result.Messages[^1].Content);
+```
+
+The method returns a [`ChatInferenceResult`](~/api/Uralstech.UAI.Abstraction.Chat.ChatInferenceResult.yml)
+object with the generated messages, including function calls and responses. The model's plain-text response
+will likely be the last message in the array.
+
+If you don't provide a model to use, it uses the model defined in the client's
+[`DefaultModelId`](~/api/Uralstech.UAI.Abstraction.IModelClient.yml#Uralstech_UAI_Abstraction_IModelClient_DefaultModelId).
+You can change this by either changing the default model, or by providing the model ID in the method's `model` parameter.
+
+For clients that support the feature, you can also turn of the safety filters of the model by setting `tryRemoveFilters` to `true`.
+
+## Function Calling
+
+You can define functions using the [`Function`](~/api/Uralstech.UAI.Abstraction.Tools.Function.yml) class.
+They can then be passed into a [variant of the `Chat` function](~/api/Uralstech.UAI.Abstraction.IModelClient.yml#Uralstech_UAI_Abstraction_IModelClient_Chat_System_Collections_Generic_IReadOnlyList_Uralstech_UAI_Abstraction_Message__System_Collections_Generic_IReadOnlyList_Uralstech_UAI_Abstraction_Tools_Function__System_String_System_Int32_System_Boolean_System_Threading_CancellationToken_)
+to be called by the model.
+
+```csharp
+using Uralstech.UAI.Abstraction.Tools;
+
+ChatInferenceResult result = await client.Chat(new Message[]
+{
+    new Message(Role.System, "You are a helpful, friendly assistant."),
+    new Message(Role.User, "Can you print \"Hello, World\" to the console?")
+},
+new Function[]
+{
+    new Function(
+        nameof(PrintToConsole),
+        "Prints text to the console.",
+        new Parameter[]
+        {
+            new Parameter()
+            {
+                Name = "text",
+                Description = "The text to print.",
+                Type = ParameterType.String,
+            }
+        },
+        PrintToConsole
+    )
+});
+
+Debug.Log("Response: " + result.Messages[^1].Content);
+
+async Awaitable<JObject> PrintToConsole(JToken input)
+{
+    await Awaitable.MainThreadAsync(); // Just to make this a valid Awaitable.
+
+    Debug.Log(input["query"].ToObject<string>());
+    return new JObject()
+    {
+        ["status"] = "Printed text to console."
+    };
+}
+```

Documentation/docfx.json

@@ -3,15 +3,18 @@
     {
       "src": [
         {
-          "src": "../PackageName",
+          "src": "../UAI.Abstraction",
           "files": [
-            "Packages/com.uralstech.package-name/Runtime/**/*.cs"
+            "Packages/com.uralstech.uai.abstraction/Runtime/**/*.cs"
           ]
         }
       ],
+      "properties": {
+        "DefineConstants": "COM_URALSTECH_UGEMINI;COM_OPENAI_UNITY"
+      },
       "dest": "api",
       "filter": "filterConfig.yml",
-      "includePrivateMembers": true,
+      "includePrivateMembers": false,
       "allowCompilationErrors": true
     }
   ],
@@ -39,9 +42,9 @@
       "modern"
     ],
     "globalMetadata": {
-      "_appName": "PackageName",
-      "_appTitle": "PackageName",
-      "_appFooter": "(C) 2024 URAV ADVANCED LEARNING SYSTEMS PRIVATE LIMITED, licensed under the <a href=\"https://github.com/Uralstech/PackageName/blob/master/LICENSE\">Apache License, Version 2.0</a>.",
+      "_appName": "UAI.Abstraction",
+      "_appTitle": "UAI.Abstraction",
+      "_appFooter": "(C) 2024 URAV ADVANCED LEARNING SYSTEMS PRIVATE LIMITED, licensed under the <a href=\"https://github.com/Uralstech/UAI.Abstraction/blob/master/LICENSE\">Apache License, Version 2.0</a>.",
       "_enableSearch": true
     },
     "fileMetadata": {
@@ -59,7 +62,7 @@
       }
     },
     "sitemap": {
-      "baseUrl": "https://uralstech.github.io/PackageName",
+      "baseUrl": "https://uralstech.github.io/UAI.Abstraction",
       "priority": 1.0,
       "changefreq": "monthly"
     }

Documentation/index.md

@@ -2,16 +2,16 @@
 _layout: landing
 ---
 
-# PackageName
+# UAI.Abstraction
 
-PackageDesc
+Contains abstraction for common AI APIs so that different LLM providers like Gemini and OpenAI can be used through a unified interface. Currently supports the Google Gemini and OpenAI GPT APIs.
 
-[![openupm](https://img.shields.io/npm/v/com.uralstech.package-name?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.uralstech.package-name/)
-[![openupm](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fcom.uralstech.package-name)](https://openupm.com/packages/com.uralstech.package-name/)
+[![openupm](https://img.shields.io/npm/v/com.uralstech.uai.abstraction?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.uralstech.uai.abstraction/)
+[![openupm](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fcom.uralstech.uai.abstraction)](https://openupm.com/packages/com.uralstech.uai.abstraction/)
 
 ## Installation
 
-This *should* work on any reasonably modern Unity version. Built and tested in Unity 6.0.
+Requires Unity 6.0 because of the plugin's usage of [*Awaitable*](https://docs.unity3d.com/6000.0/Documentation/ScriptReference/Awaitable.html). Built and tested in Unity 6.0.
 
 # [OpenUPM](#tab/openupm)
 
@@ -24,19 +24,19 @@ This *should* work on any reasonably modern Unity version. Built and tested in U
         - `com.uralstech`
 4. Open the Unity Package Manager window (`Window` -> `Package Manager`)
 5. Change the registry from `Unity` to `My Registries`
-6. Add the `PackageName` package
+6. Add the `UAI.Abstraction` package
 
 # [Unity Package Manager](#tab/upm)
 
 1. Open the Unity Package Manager window (`Window` -> `Package Manager`)
 2. Select the `+` icon and `Add package from git URL...`
 3. Paste the UPM branch URL and press enter:
-    - `https://github.com/Uralstech/PackageName.git#upm`
+    - `https://github.com/Uralstech/UAI.Abstraction.git#upm`
 
 # [GitHub Clone](#tab/github)
 
 1. Clone or download the repository from the desired branch (master, preview/unstable)
-2. Drag the package folder `PackageName/PackageName/Packages/com.uralstech.package-name` into your Unity project's `Packages` folder
+2. Drag the package folder `UAI.Abstraction/UAI.Abstraction/Packages/com.uralstech.uai.abstraction` into your Unity project's `Packages` folder
 
 ---
 
@@ -46,4 +46,4 @@ Do not use preview versions (i.e. versions that end with "-preview") for product
 
 ## Documentation
 
-See <https://uralstech.github.io/PackageName/DocSource/QuickStart.html> or `APIReferenceManual.pdf` and `Documentation.pdf` in the package documentation for the reference manual and tutorial.
+See <https://uralstech.github.io/UAI.Abstraction/DocSource/QuickStart.html> or `APIReferenceManual.pdf` and `Documentation.pdf` in the package documentation for the reference manual and tutorial.

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (C) 2024 URAV ADVANCED LEARNING SYSTEMS PRIVATE LIMITED
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.