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 25, 2024
1 parent b2b4461 commit 04c9182
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,15 @@ We will add new scripts based on your demand: feel free to cut a ticket
We currently provide the following utilities:
1. [q_list_applications](doc/q_list_applications.md) to inventory the applications existing in a given AWS account. The returned json structure
details the various components (indices, data source, retrievers, etc.) of those Amazon Q applications.
2. [q_list_documents](doc/q_list_documents.md) to list all the documents of an Amazon Q index and get all their associated metadata,
2. [q_list_data_source_sync_jobs](doc/q_list_data_source_sync_jobs.md) to list the history of index synchronization jobs executed on a given
Q data source. This script adds additional metric like total job duration, document scan rate and average scan duration
per document.
3. [q_list_documents](doc/q_list_documents.md) to list all the documents of an Amazon Q index and get all their associated metadata,
in particular their status. The returned list can be filtered (via inclusion or exclusion) to return
only a fraction of those documents for example based on their indexing status.
3. [q_list_conversations](doc/q_list_conversations.md) to obtain all list of all past conversations between
4[q_list_conversations](doc/q_list_conversations.md) to obtain all list of all past conversations between
a given application and a user as remembered by Amazon Q.
4. [q_chat](doc/q_chat.md) to be able to script conversations with the assistant of Amazon Q.
5[q_chat](doc/q_chat.md) to be able to script conversations with the assistant of Amazon Q.

All those scripts return json structures that can be further processed in [shell pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)) with various utilities
like jq, sed, awk, etc.
Expand Down

0 comments on commit 04c9182

Please sign in to comment.