From c78d8c5150c3de38d86d21a5f44c0d5e7309c39e Mon Sep 17 00:00:00 2001 From: Suzin You <7042047+suzinyou@users.noreply.github.com> Date: Tue, 30 Jul 2024 12:22:19 +0530 Subject: [PATCH 1/2] update docs to add link to redoc --- core_backend/app/__init__.py | 2 ++ docs/components/qa-service/index.md | 9 +++------ docs/usage.md | 14 +++++++------- mkdocs.yml | 2 +- 4 files changed, 13 insertions(+), 14 deletions(-) diff --git a/core_backend/app/__init__.py b/core_backend/app/__init__.py index 2b7740af3..670d94282 100644 --- a/core_backend/app/__init__.py +++ b/core_backend/app/__init__.py @@ -28,6 +28,8 @@ ๐Ÿ”‘ Get your API key | ๐Ÿ“– Docs | +โ˜๏ธ APIs | +๐Ÿงช Test APIs | If you have the [application running](../../deployment/quick-setup.md), you can access -the SwaggerUI at +the SwaggerUI at `https://[DOMAIN]/api/docs` and Redoc at `https://[DOMAIN]/api/redoc` - https://[DOMAIN]/api/docs - -or if you are using the [dev](../../develop/setup.md) setup: - - http://localhost:8000/docs +or if you are using the [dev](../../develop/setup.md) setup, +`http://localhost:8000/docs` and `http://localhost:8000/redoc`. ## Upcoming diff --git a/docs/usage.md b/docs/usage.md index 3762a3904..8a1a1b2fe 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -10,7 +10,7 @@ To get answers from your database of contents, you can use the `/search` endpoin - Search results: Finds the most similar content in the database using cosine distance between embeddings. - (Optionally) LLM generated response: Crafts a custom response using LLM chat using the most similar content. -You can also add your contents programatically using API endpoints. See [docs](https://docs.ask-a-question.com/) or SwaggerUI at `https:///api/docs` or `https:///docs` for more details and other API endpoints. +You can also add your contents programatically using API endpoints. See our [API docs](https://app.ask-a-question.com/api/redoc) for more details and other API endpoints. ### :question: Embeddings search @@ -44,14 +44,14 @@ curl -X 'POST' \ ## Admin app -You can access the admin console at +You can access the admin app of AAQ's cloud version [here](https://app.ask-a-question.com). You can +also [self-host your own AAQ admin app](http://localhost:8080/deployment/quick-setup/). -``` -https://[DOMAIN]/ -``` - -On the [Admin app]("./content/admin-app.md"), you can: +On the admin app, you can: - :books: Manage content for more details - :test_tube: Use the playground to test the Question-Answering service - :bar_chart: View dashboards + +See more detailed documentation of the admin app +[here](http://localhost:8080/components/admin-app/). diff --git a/mkdocs.yml b/mkdocs.yml index 2105dfea2..a01a29d88 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -70,7 +70,7 @@ nav: - Contact us: - Team: contact_us.md - - API docs โ†—๏ธŽ: https://app.ask-a-question.com/api/docs + - API docs โ†—๏ธŽ: https://app.ask-a-question.com/api/redoc # Themes and extensions theme: From 17ec4d784630b1b2616cb92e5822e3ff3e4b96e2 Mon Sep 17 00:00:00 2001 From: Suzin You <7042047+suzinyou@users.noreply.github.com> Date: Tue, 30 Jul 2024 12:43:30 +0530 Subject: [PATCH 2/2] point to redoc in usage --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d1843a43..5929a02db 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ To get answers from your database of contents, you can use the `/search` endpoin - Search results: Finds the most similar content in the database using cosine distance between embeddings. - (Optionally) LLM generated response: Crafts a custom response using LLM chat using the most similar content. -See [docs](https://docs.ask-a-question.com/) or [API docs](https://app.ask-a-question.com/api/docs) for more details and other API endpoints. +See [docs](https://docs.ask-a-question.com/) or [API docs](https://app.ask-a-question.com/api/redoc) for more details and other API endpoints. ### :question: Simple content search