diff --git a/docs/index.html b/docs/index.html index b3ca4a2..c76e501 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@
-0.5.3
0.6.0
A blackbox retrieval system that implements a basic chat API.
+The API needs to consume a JSON object that has at least the property
+messages
, which is an array of message objects. Each message object has
+the string property role
, which is either assistant
or user
, and the
+string property content
that contains the message text.
The API produces a JSON object that has at least the property message
,
+which is the response message (thus role
has to be assistant
).
(Object)
+ The configuration for the system
+
+ Name | +Description | +
---|---|
configuration.url string
+ |
+ The URL of the chat endpoint + | +
configuration.request string
+ |
+ The object that is sent to the +endpoint on each query with the messages added + | +
(Logbook)
+ A function that takes log messages
+
+ Retrieves results for the user's query.
+ + + + + + + + + + + + + +SystemResponse
:
+ The system's response with a least the
+
+utterance
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+