Skip to content

Commit a52fade

Browse files
committed
SimpleChatTC:DataStore: update readme
1 parent eafbcb4 commit a52fade

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

tools/server/public_simplechat/readme.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,8 @@ remember to
102102
* the white list of allowed.domains
103103
* the shared bearer token between server and client ui
104104

105-
* other builtin tool / function calls like calcultor, javascript runner, DataStore dont require simpleproxy.py
105+
* other builtin tool / function calls like calculator, javascript runner, DataStore dont require the
106+
simpleproxy.py helper.
106107

107108

108109

@@ -390,6 +391,15 @@ needed to help generate better responses. this can also be used for
390391
* searching for specific topics and summarising the results
391392
* or so
392393

394+
* save collated data or generated analysis or more to the provided data store and retrieve
395+
them later to augment the analysis / generation then. Also could be used to summarise chat
396+
session till a given point and inturn save the summary into data store and later retrieve
397+
the summary and continue the chat session using the summary and thus with a reduced context
398+
window to worry about.
399+
400+
* use your imagination and ai models capabilities as you see fit, without restrictions from
401+
others.
402+
393403
The tool calling feature has been tested with Gemma3N, Granite4 and GptOss.
394404

395405
ALERT: The simple minded way in which this is implemented, it provides some minimal safety
@@ -410,7 +420,7 @@ The following tools/functions are currently provided by default
410420
* run_javascript_function_code - which can be used to run some javascript code in the browser
411421
context.
412422

413-
* data_store_get/set - allows for a basic data store to be used.
423+
* data_store_get/set/delete/list - allows for a basic data store to be used.
414424

415425
Currently the ai generated code / expression is run through a simple minded eval inside a web worker
416426
mechanism. Use of WebWorker helps avoid exposing browser global scope to the generated code directly.
@@ -456,7 +466,7 @@ The bundled simple proxy
456466
a non-browser entity.
457467

458468
In future it can be further extended to help with other relatively simple yet useful tool calls like
459-
data / documents_store [wip], fetch_rss and so.
469+
fetch_rss and so.
460470

461471
* for now fetch_rss can be indirectly achieved using fetch_web_url_raw.
462472

@@ -482,8 +492,8 @@ Update the tc_switch to include a object entry for the tool, which inturn includ
482492
It should pass these along to the tools web worker, if used.
483493
* the result key (was used previously, may use in future, but for now left as is)
484494

485-
Look into tooljs.mjs for javascript and inturn web worker based tool calls and toolweb.mjs
486-
for the simpleproxy.py based tool calls.
495+
Look into tooljs.mjs and tooldb.mjs for javascript and inturn web worker based tool calls and
496+
toolweb.mjs for the simpleproxy.py based tool calls.
487497

488498
#### OLD: Mapping tool calls and responses to normal assistant - user chat flow
489499

@@ -537,9 +547,9 @@ The default Chat UI theme/look changed to help differentiate between different m
537547
history as well as the parts of each message in a slightly better manner. Change the theme slightly
538548
between normal and print views (beyond previous infinite height) for better printed chat history.
539549

540-
Initial skeletons of a builtin data store related tool calls, built on browser's indexedDB, without
541-
needing any proxy / additional helper to handle the store. One could use the ai assistant to store
542-
ones (ie end users) own data or data of ai model.
550+
A builtin data store related tool calls, inturn built on browser's indexedDB, without needing any
551+
proxy / additional helper to handle the store. One could use the ai assistant to store ones (ie end
552+
users) own data or data of ai model.
543553

544554
#### ToDo
545555

@@ -549,7 +559,8 @@ Trap error responses.
549559

550560
Handle multimodal handshaking with ai models.
551561

552-
Add fetch_rss and documents|data_store [wip] tool calling, through the simpleproxy.py if and where needed.
562+
Add fetch_rss and may be different document formats processing related tool calling, in turn through
563+
the simpleproxy.py if and where needed.
553564

554565
Save used config entries along with the auto saved chat sessions and inturn give option to reload the
555566
same when saved chat is loaded.

0 commit comments

Comments
 (0)