diff --git a/README.md b/README.md index 9f73006..1223343 100644 --- a/README.md +++ b/README.md @@ -12,72 +12,6 @@ This repository is for a workshop using Azure OpenAI Service. -## Prerequisites +## Docs -To run all the projects in this repository, you need the followings. - -- [Python 3.10+](https://www.python.org/downloads/) -- [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/ai-services/openai-service) -- [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db/) -- [Azure AI Search](https://azure.microsoft.com/en-us/products/ai-services/ai-search) -- [Azure AI Document Intelligence](https://azure.microsoft.com/en-us/products/ai-services/ai-document-intelligence) - -Here are the preferred tools for development. - -- [Poetry](https://python-poetry.org/docs/#installation) -- [GNU Make](https://www.gnu.org/software/make/) - -## Projects - -| Project | Description | Image | -| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [1_call_azure_openai_chat](./apps/1_call_azure_openai_chat/README.md) | Call Azure OpenAI Service API from Python | No Image | -| [2_streamlit_chat](./apps/2_streamlit_chat/README.md) | Create an Azure OpenAI Chat app using Streamlit | ![2_streamlit_chat](./docs/images/2_streamlit_chat.chat_page.png) | -| [3_call_azure_cosmos_db](./apps/3_call_azure_cosmos_db/README.md) | Call Azure Cosmos DB from Python | No Image | -| [4_streamlit_chat_history](./apps/4_streamlit_chat_history/README.md) | Add feature to store chat history using Azure Cosmos DB | ![4_streamlit_chat_history](./docs/images/4_streamlit_chat_history.chat_page.png) | -| [5_streamlit_query_chat_history](./apps/5_streamlit_query_chat_history/README.md) | Search Chat History | ![5_streamlit_query_chat_history](./docs/images/5_streamlit_query_chat_history.main.png) | -| [6_call_azure_ai_search](./apps/6_call_azure_ai_search/README.md) | Call Azure AI Search from Python | No Image | -| [7_streamlit_chat_rag](./apps/7_streamlit_chat_rag/README.md) | Add RAG feature to Streamlit chat app | ![7_streamlit_chat_rag](./docs/images/7_streamlit_chat_rag.main.png) | -| [8_streamlit_azure_openai_batch](./apps/8_streamlit_azure_openai_batch/README.md) | Call Azure OpenAI Batch API with Streamlit | ![8_streamlit_azure_openai_batch](./docs/images/8_streamlit_azure_openai_batch.main.png) | -| [9_streamlit_azure_document_intelligence](./apps/9_streamlit_azure_document_intelligence/README.md) | Call Azure AI Document Intelligence API with Streamlit | ![9_streamlit_azure_document_intelligence](./docs/images/9_streamlit_azure_document_intelligence.main.png) | -| [10_streamlit_batch_transcription](./apps/10_streamlit_batch_transcription/README.md) | Call Batch Transcription API with Streamlit | ![10_streamlit_batch_transcription](./docs/images/10_streamlit_batch_transcription.main.png) | -| [11_promptflow](./apps/11_promptflow/README.md) | Get started with Prompt flow | No Image | -| [12_langgraph_agent](./apps/12_langgraph_agent/README.md) | Create agents with LangGraph | No Image | -| [99_streamlit_examples](./apps/99_streamlit_examples/README.md) | Code samples for Streamlit | ![99_streamlit_examples](./docs/images/99_streamlit_examples.explaindata.png) | - -## How to run - -Referring to the [.env.template](.env.template) file, create a `.env` file in the same directory and set the required credentials. - -### Local environment - -```shell -# Create a virtual environment -$ python -m venv .venv - -# Activate the virtual environment -$ source .venv/bin/activate - -# Install dependencies -$ pip install -r requirements.txt - -# Run the script (e.g. run 2_streamlit_chat) -$ python -m streamlit run apps/2_streamlit_chat/main.py -``` - -### Docker container - -```shell -# Set Docker image name -## GitHub Container Registry -$ IMAGE=ghcr.io/ks6088ts-labs/workshop-azure-openai:latest -## Docker Hub -$ IMAGE=ks6088ts/workshop-azure-openai:latest - -# run 2_streamlit_chat -$ docker run --rm \ - -p 8501:8501 \ - -v ${PWD}/.env:/app/.env \ - ${IMAGE} \ - python -m streamlit run ./apps/2_streamlit_chat/main.py -``` +Go to [https://ks6088ts-labs.github.io/workshop-azure-openai/](https://ks6088ts-labs.github.io/workshop-azure-openai/) diff --git a/docs/index.md b/docs/index.md index 000ea34..1dadb56 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,73 @@ -# Welcome to MkDocs +# workshop-azure-openai -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +This repository is for a workshop using Azure OpenAI Service. -## Commands +## Prerequisites -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +To run all the projects in this repository, you need the followings. -## Project layout +- [Python 3.10+](https://www.python.org/downloads/) +- [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/ai-services/openai-service) +- [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db/) +- [Azure AI Search](https://azure.microsoft.com/en-us/products/ai-services/ai-search) +- [Azure AI Document Intelligence](https://azure.microsoft.com/en-us/products/ai-services/ai-document-intelligence) - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +Here are the preferred tools for development. + +- [Poetry](https://python-poetry.org/docs/#installation) +- [GNU Make](https://www.gnu.org/software/make/) + +## Projects + +| Project | Description | Image | +| ---------------------------------------------------------------------------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [1_call_azure_openai_chat](apps/1_call_azure_openai_chat) | Call Azure OpenAI Service API from Python | No Image | +| [2_streamlit_chat](/apps/2_streamlit_chat) | Create an Azure OpenAI Chat app using Streamlit | ![2_streamlit_chat](./images/2_streamlit_chat.chat_page.png) | +| [3_call_azure_cosmos_db](/apps/3_call_azure_cosmos_db) | Call Azure Cosmos DB from Python | No Image | +| [4_streamlit_chat_history](/apps/4_streamlit_chat_history) | Add feature to store chat history using Azure Cosmos DB | ![4_streamlit_chat_history](./images/4_streamlit_chat_history.chat_page.png) | +| [5_streamlit_query_chat_history](/apps/5_streamlit_query_chat_history) | Search Chat History | ![5_streamlit_query_chat_history](./images/5_streamlit_query_chat_history.main.png) | +| [6_call_azure_ai_search](/apps/6_call_azure_ai_search) | Call Azure AI Search from Python | No Image | +| [7_streamlit_chat_rag](/apps/7_streamlit_chat_rag) | Add RAG feature to Streamlit chat app | ![7_streamlit_chat_rag](./images/7_streamlit_chat_rag.main.png) | +| [8_streamlit_azure_openai_batch](/apps/8_streamlit_azure_openai_batch) | Call Azure OpenAI Batch API with Streamlit | ![8_streamlit_azure_openai_batch](./images/8_streamlit_azure_openai_batch.main.png) | +| [9_streamlit_azure_document_intelligence](/apps/9_streamlit_azure_document_intelligence) | Call Azure AI Document Intelligence API with Streamlit | ![9_streamlit_azure_document_intelligence](./images/9_streamlit_azure_document_intelligence.main.png) | +| [10_streamlit_batch_transcription](/apps/10_streamlit_batch_transcription) | Call Batch Transcription API with Streamlit | ![10_streamlit_batch_transcription](./images/10_streamlit_batch_transcription.main.png) | +| [11_promptflow](/apps/11_promptflow) | Get started with Prompt flow | No Image | +| [12_langgraph_agent](/apps/12_langgraph_agent) | Create agents with LangGraph | No Image | +| [99_streamlit_examples](/apps/99_streamlit_examples) | Code samples for Streamlit | ![99_streamlit_examples](./images/99_streamlit_examples.explaindata.png) | + +## How to run + +Referring to the [.env.template](.env.template) file, create a `.env` file in the same directory and set the required credentials. + +### Local environment + +```shell +# Create a virtual environment +$ python -m venv .venv + +# Activate the virtual environment +$ source .venv/bin/activate + +# Install dependencies +$ pip install -r requirements.txt + +# Run the script (e.g. run 2_streamlit_chat) +$ python -m streamlit run apps/2_streamlit_chat/main.py +``` + +### Docker container + +```shell +# Set Docker image name +## GitHub Container Registry +$ IMAGE=ghcr.io/ks6088ts-labs/workshop-azure-openai:latest +## Docker Hub +$ IMAGE=ks6088ts/workshop-azure-openai:latest + +# run 2_streamlit_chat +$ docker run --rm \ + -p 8501:8501 \ + -v ${PWD}/.env:/app/.env \ + ${IMAGE} \ + python -m streamlit run /apps/2_streamlit_chat/main.py +```