Update 2024-11-28_ai-server.md

Author: mythz

MyApp/_posts/2024-11-28_ai-server.md

@@ -196,8 +196,108 @@ The current release of AI Server supports a number of different modalities, incl
   - **Trim Video** - Trim a video to a specific length
 
 ### Managed File Storage
+
 - Blob Storage - isolated and restricted by API Key
 
+## AI Server API Examples
+
+To simplify integrations with AI Server each API Request can be called with 3 different call styles to better
+support different use-cases and integration patterns.
+
+### Synchronous Open AI Chat Example
+
+The **Synchronous API** is the simplest API ideal for small workloads where the Response is returned in the same Request:
+
+```csharp
+var client = new JsonApiClient(baseUrl);
+client.BearerToken = apiKey;
+
+var api = await client.ApiAsync(new OpenAiChatCompletion {
+    Model = "mixtral:8x22b",
+    Messages = [
+        new() {
+            Role = "user",
+            Content = "What's the capital of France?"
+        }
+    ],
+    MaxTokens = 50
+});
+
+var answer = api.Response.Choices[0].Message;
+```
+
+### Queued Open AI Chat Example
+
+The **Queued API** immediately Returns a reference to the queued job executing the AI Request:
+
+```csharp
+var api = await client.ApiAsync(new QueueOpenAiChatCompletion
+{
+    Request = new()
+    {
+        Model = "gpt-4-turbo",
+        Messages = new List<OpenAiMessage>
+        {
+            new() { Role = "system", Content = "You are a helpful AI assistant." },
+            new() { Role = "user", Content = "How do LLMs work?" }
+        },
+        MaxTokens = 50
+    }
+});
+
+var uniqueRefId = api.Response.RefId;
+var jobId = api.Response.Id;
+```
+
+Which can be used to poll for the API Response of any Job by calling `GetJobStatus`
+and then when `Completed` can call `GetOpenAiChat` to get the `OpenAiChatResponse`:
+
+```csharp
+var apiStatus = await client.ApiAsync(new GetJobStatus
+{
+    JobId = jobId,
+    RefId = uniqueRefId,
+});
+
+if (apiStatus.Response.JobState == BackgroundJobState.Completed)
+{
+    var api = await client.ApiAsync(new GetOpenAiChat
+    {
+        Id = jobId,
+        RefId = uniqueRefId,
+    });
+}
+```
+
+### Open AI Chat with Callback Example
+
+The Queued API also accepts a **Reply to Web Callback** for a more reliable push-based App integration
+where responses are posted back to a custom URL Endpoint:
+
+```csharp
+var api = await client.ApiAsync(new QueueOpenAiChatCompletion
+{
+    //...
+    ReplyTo = "https://example.org/api/OpenAiChatResponseCallback?MyId=1"
+});
+```
+
+Your callback can add any additional metadata on the callback to assist your App in correlating the response with the
+initiating request which just needs to contain the properties of the `OpenAiChatResponse` you're interested in
+along with any metadata added to the callback URL, e.g:
+
+```csharp
+public class OpenAiChatResponseCallback : OpenAiChatResponse, IReturnVoid
+{
+    public int MyId { get; set; }
+}
+
+public object Any(OpenAiChatResponseCallback request)
+{
+    // Handle OpenAiChatResponse callabck
+}
+```
+
 ## Feedback
 
 Feel free to reach us at [ServiceStack/Discuss](https://github.com/ServiceStack/Discuss/discussions)