Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
Didier Durand committed Feb 28, 2024
1 parent e084536 commit 46ae373
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/q_chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ message id - as last returned systemMessageId" (see example below) - of last the
assume that you continue this conversation and restore the [LLM context window](https://klu.ai/glossary/context-window)
of this precedent conversation to continue the chat based on this LLM context.

The q_chat script allows you to run conversations with Q. You have to provide a text file with 1 prompt per line.
The [q_chat.py](../src/q_chat.py) script allows you to run conversations with Q. You have to provide a text file with 1 prompt per line.
Prompts that are part of same conversation will be chained by prefix 'c:' at beginning of line. See example in
[sample file](/data/prompt_list.txt)

Expand Down
2 changes: 1 addition & 1 deletion doc/q_list_applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The most important ones are the application itself, its index delivering the RAG
the data source(s) from which the index is built, the retriever retrieving the documents used
for answering the user prompts, the web experience offering a default interactive user interface.

q_list_applications script will call the various required Q SDK APIs to aggregate those objects in a hierarchical
The [q_list_applications.py](/src/q_list_applications.py) script will call the various required Q SDK APIs to aggregate those objects in a hierarchical
manner representing dependencies among them in the returned json. This json is an array comprising one aggregate
of objects per application: see next section.

Expand Down
2 changes: 1 addition & 1 deletion doc/q_list_conversations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Description

q_list_conversations is a script allowing the retrieval in a json structure of the conversations
[q_list_conversations.py](/src/q_list_conversations.py) is a script allowing the retrieval in a json structure of the conversations
that happened between a named user and the Q application. It combines 2 APIs, [boto3("qbusiness").list_conversations()](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/qbusiness/client/list_conversations.html)
and [boto3("qbusiness").list_messages()](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/qbusiness/client/list_messages.html),
to bring together conversation and message details together in one json aggregate.
Expand Down
2 changes: 1 addition & 1 deletion doc/q_list_documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ relevant documents for the user query. b) a generation component (based on LLM(s
the retrieved documents and then generates an answer to the query using a large language model. The documents provided
by the retriever allow the LLM to deliver a more specific answer to the question.

q_list_docs inventories those docs and returns them in JSON structure that can be further processed by piping it into
Script [q_list_documents.py](/src/q_list_documents.py) inventories those docs and returns them in JSON structure that can be further processed by piping it into
other shell utilities like jq, sed, etc.

### Usage
Expand Down

0 comments on commit 46ae373

Please sign in to comment.