Skip to content

Commit 46ae373

Browse files
author
Didier Durand
committed
doc update
1 parent e084536 commit 46ae373

4 files changed

+4
-4
lines changed

doc/q_chat.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ message id - as last returned systemMessageId" (see example below) - of last the
2222
assume that you continue this conversation and restore the [LLM context window](https://klu.ai/glossary/context-window)
2323
of this precedent conversation to continue the chat based on this LLM context.
2424

25-
The q_chat script allows you to run conversations with Q. You have to provide a text file with 1 prompt per line.
25+
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.
2626
Prompts that are part of same conversation will be chained by prefix 'c:' at beginning of line. See example in
2727
[sample file](/data/prompt_list.txt)
2828

doc/q_list_applications.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The most important ones are the application itself, its index delivering the RAG
1313
the data source(s) from which the index is built, the retriever retrieving the documents used
1414
for answering the user prompts, the web experience offering a default interactive user interface.
1515

16-
q_list_applications script will call the various required Q SDK APIs to aggregate those objects in a hierarchical
16+
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
1717
manner representing dependencies among them in the returned json. This json is an array comprising one aggregate
1818
of objects per application: see next section.
1919

doc/q_list_conversations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
### Description
88

9-
q_list_conversations is a script allowing the retrieval in a json structure of the conversations
9+
[q_list_conversations.py](/src/q_list_conversations.py) is a script allowing the retrieval in a json structure of the conversations
1010
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)
1111
and [boto3("qbusiness").list_messages()](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/qbusiness/client/list_messages.html),
1212
to bring together conversation and message details together in one json aggregate.

doc/q_list_documents.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ relevant documents for the user query. b) a generation component (based on LLM(s
2424
the retrieved documents and then generates an answer to the query using a large language model. The documents provided
2525
by the retriever allow the LLM to deliver a more specific answer to the question.
2626

27-
q_list_docs inventories those docs and returns them in JSON structure that can be further processed by piping it into
27+
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
2828
other shell utilities like jq, sed, etc.
2929

3030
### Usage

0 commit comments

Comments
 (0)