vbatts/llama.cpp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

SimpleChat: readme wrt authorization, maybe minimal openai testing

Browse source
This commit is contained in:
HanishKVC 2024-05-29 23:16:25 +05:30
parent 7a0399e582
commit 85fd2d0d84
1 changed files with 28 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

28
examples/server/public_simplechat/readme.md
View file

@ -29,6 +29,9 @@ the chat history before sending to the ai model.
NOTE: Wrt options sent with the request, it mainly sets temperature, max_tokens and optionaly stream for now. NOTE: Wrt options sent with the request, it mainly sets temperature, max_tokens and optionaly stream for now.
However if someone wants they can update the js file or equivalent member in gMe as needed. However if someone wants they can update the js file or equivalent member in gMe as needed.
NOTE: One may be able to use this to chat with openai api web-service /chat/completions endpoint, in a very
limited / minimal way. One will need to set openai url and authorization bearer key in settings ui.
## usage ## usage
@ -155,6 +158,10 @@ It is attached to the document object. Some of these can also be updated using t
modify the existing options value or remove them, for now you can update this global var modify the existing options value or remove them, for now you can update this global var
using browser's development-tools/console. using browser's development-tools/console.
headers - maintains the list of http headers sent when request is made to the server. By default
Content-Type is set to application/json. Additionally Authorization entry is provided, which can
be set if needed using the settings ui.
iRecentUserMsgCnt - a simple minded SlidingWindow to limit context window load at Ai Model end. iRecentUserMsgCnt - a simple minded SlidingWindow to limit context window load at Ai Model end.
This is disabled by default. However if enabled, then in addition to latest system message, only This is disabled by default. However if enabled, then in addition to latest system message, only
the last/latest iRecentUserMsgCnt user messages after the latest system prompt and its responses the last/latest iRecentUserMsgCnt user messages after the latest system prompt and its responses
@ -216,6 +223,27 @@ A end-user can change these behaviour by editing gMe from browser's devel-tool/c
using the providing settings ui. using the providing settings ui.
### OpenAi / Equivalent API WebService
One may be abe to handshake with OpenAI/Equivalent api web service's /chat/completions endpoint
for a minimal chatting experimentation by setting the below.
* the baseUrl in settings ui
* https://api.openai.com/v1 or similar
* Wrt request body - gMe.chatRequestOptions
* model
* any additional fields if required in future
* Wrt request headers - gMe.headers
* Authorization (available through settings ui)
* Bearer THE_OPENAI_API_KEY
* any additional optional header entries like "OpenAI-Organization", "OpenAI-Project" or so
NOTE: Not tested, as there is no free tier api testing available. However logically this might
work.
## At the end ## At the end
Also a thank you to all open source and open model developers, who strive for the common good. Also a thank you to all open source and open model developers, who strive for the common good.