From 1bfef6cbf1b851066a58e2f8cb8144ee647fe05c Mon Sep 17 00:00:00 2001
From: sa_ddam213 <sa_ddam213@live.com>
Date: Tue, 14 Nov 2023 21:54:22 +1300
Subject: [PATCH] Update README

---
 LLamaStack.Core/README.md   | 3 +++
 LLamaStack.WebApi/README.md | 8 ++++++++
 2 files changed, 11 insertions(+)

diff --git a/LLamaStack.Core/README.md b/LLamaStack.Core/README.md
index 3f2bebf..c386038 100644
--- a/LLamaStack.Core/README.md
+++ b/LLamaStack.Core/README.md
@@ -109,7 +109,10 @@ await foreach (var token in inferTokens)
    Console.Write(token.Logit);
    Console.Write(token.Probability);
    Console.Write(token.Content);
+   Console.Write(token.IsChild);
 }
+//Note: If a character has more than one token the first will contain the entire content
+//the others are marked as IsChild and will only contain the Id, Logit and Probability
 
 
 // InferTextAsync, returns IAsyncEnumerable<string> for streaming output of tokens
diff --git a/LLamaStack.WebApi/README.md b/LLamaStack.WebApi/README.md
index b1d2397..d4a9efe 100644
--- a/LLamaStack.WebApi/README.md
+++ b/LLamaStack.WebApi/README.md
@@ -190,6 +190,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 0,
             "probability": 0,
             "content": null,
+            "isChild": false,
             "type": "Begin",
             "elapsed": 0
         },
@@ -198,6 +199,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 27.43893,
             "probability": 0.5839324,
             "content": " An",
+            "isChild": false,
             "type": "Content",
             "elapsed": 1292
         },
@@ -206,6 +208,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 31.901243,
             "probability": 0.9997987,
             "content": " apple",
+            "isChild": false,
             "type": "Content",
             "elapsed": 1414
         },
@@ -214,6 +217,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 32.91171,
             "probability": 0.99989986,
             "content": " is",
+            "isChild": false,
             "type": "Content",
             "elapsed": 1672
         },
@@ -259,6 +263,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 0,
             "probability": 0,
             "content": null,
+            "isChild": false,
             "type": "Begin",
             "elapsed": 0
         },
@@ -267,6 +272,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 27.43893,
             "probability": 0.5839324,
             "content": " An",
+            "isChild": false,
             "type": "Content",
             "elapsed": 1292
         },
@@ -275,6 +281,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 31.901243,
             "probability": 0.9997987,
             "content": " apple",
+            "isChild": false,
             "type": "Content",
             "elapsed": 1414
         },
@@ -283,6 +290,7 @@ The `ModelSessionController` is a controller designed to handle various `ModelSe
             "logit": 32.91171,
             "probability": 0.99989986,
             "content": " is",
+            "isChild": false,
             "type": "Content",
             "elapsed": 1672
         },