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 24, 2024
1 parent 28d0973 commit d1b2822
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions doc/q_list_applications.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# UNDER CONSTRUCTION !
## q_list_applications

An Amazon Q application is a bundle of multiple components working together.
They are detailed on the [Concepts page](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/concepts-terms.html) of the service documentation.

The most important ones are the application itself, its index delivering the RAG features,
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 will call the various required Q APIs to aggregate those objects in a hierarchical
manner representing dependencies among them.

### Usage

Expand Down Expand Up @@ -170,11 +180,4 @@
}
]
```

An Amazon Q application is a bundle of multiple components working together.
They are defined in the service documentation at page.

The most important ones are the application itself, its index delivering the RAG features,
the data source(s) from which the index is built, a retriever retrieving the documents used
for answering the user prompts, the web experience offering a default interactive user interface.
```

0 comments on commit d1b2822

Please sign in to comment.