Skip to content

Commit 88df324

Browse files
ks6088tsks6088ts
committed
update site_url
1 parent 299d1dc commit 88df324

File tree

2 files changed

+70
-80
lines changed

2 files changed

+70
-80
lines changed

‎README.md‎

Lines changed: 2 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -12,72 +12,6 @@
1212

1313
This repository is for a workshop using Azure OpenAI Service.
1414

15-
## Prerequisites
15+
## Docs
1616

17-
To run all the projects in this repository, you need the followings.
18-
19-
- [Python 3.10+](https://www.python.org/downloads/)
20-
- [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/ai-services/openai-service)
21-
- [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db/)
22-
- [Azure AI Search](https://azure.microsoft.com/en-us/products/ai-services/ai-search)
23-
- [Azure AI Document Intelligence](https://azure.microsoft.com/en-us/products/ai-services/ai-document-intelligence)
24-
25-
Here are the preferred tools for development.
26-
27-
- [Poetry](https://python-poetry.org/docs/#installation)
28-
- [GNU Make](https://www.gnu.org/software/make/)
29-
30-
## Projects
31-
32-
| Project | Description | Image |
33-
| --------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
34-
| [1_call_azure_openai_chat](./apps/1_call_azure_openai_chat/README.md) | Call Azure OpenAI Service API from Python | No Image |
35-
| [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) |
36-
| [3_call_azure_cosmos_db](./apps/3_call_azure_cosmos_db/README.md) | Call Azure Cosmos DB from Python | No Image |
37-
| [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) |
38-
| [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) |
39-
| [6_call_azure_ai_search](./apps/6_call_azure_ai_search/README.md) | Call Azure AI Search from Python | No Image |
40-
| [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) |
41-
| [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) |
42-
| [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) |
43-
| [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) |
44-
| [11_promptflow](./apps/11_promptflow/README.md) | Get started with Prompt flow | No Image |
45-
| [12_langgraph_agent](./apps/12_langgraph_agent/README.md) | Create agents with LangGraph | No Image |
46-
| [99_streamlit_examples](./apps/99_streamlit_examples/README.md) | Code samples for Streamlit | ![99_streamlit_examples](./docs/images/99_streamlit_examples.explaindata.png) |
47-
48-
## How to run
49-
50-
Referring to the [.env.template](.env.template) file, create a `.env` file in the same directory and set the required credentials.
51-
52-
### Local environment
53-
54-
```shell
55-
# Create a virtual environment
56-
$ python -m venv .venv
57-
58-
# Activate the virtual environment
59-
$ source .venv/bin/activate
60-
61-
# Install dependencies
62-
$ pip install -r requirements.txt
63-
64-
# Run the script (e.g. run 2_streamlit_chat)
65-
$ python -m streamlit run apps/2_streamlit_chat/main.py
66-
```
67-
68-
### Docker container
69-
70-
```shell
71-
# Set Docker image name
72-
## GitHub Container Registry
73-
$ IMAGE=ghcr.io/ks6088ts-labs/workshop-azure-openai:latest
74-
## Docker Hub
75-
$ IMAGE=ks6088ts/workshop-azure-openai:latest
76-
77-
# run 2_streamlit_chat
78-
$ docker run --rm \
79-
-p 8501:8501 \
80-
-v ${PWD}/.env:/app/.env \
81-
${IMAGE} \
82-
python -m streamlit run ./apps/2_streamlit_chat/main.py
83-
```
17+
Go to [https://ks6088ts-labs.github.io/workshop-azure-openai/](https://ks6088ts-labs.github.io/workshop-azure-openai/)

‎docs/index.md‎

Lines changed: 68 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,73 @@
1-
# Welcome to MkDocs
1+
# workshop-azure-openai
22

3-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
3+
This repository is for a workshop using Azure OpenAI Service.
44

5-
## Commands
5+
## Prerequisites
66

7-
* `mkdocs new [dir-name]` - Create a new project.
8-
* `mkdocs serve` - Start the live-reloading docs server.
9-
* `mkdocs build` - Build the documentation site.
10-
* `mkdocs -h` - Print help message and exit.
7+
To run all the projects in this repository, you need the followings.
118

12-
## Project layout
9+
- [Python 3.10+](https://www.python.org/downloads/)
10+
- [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/ai-services/openai-service)
11+
- [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db/)
12+
- [Azure AI Search](https://azure.microsoft.com/en-us/products/ai-services/ai-search)
13+
- [Azure AI Document Intelligence](https://azure.microsoft.com/en-us/products/ai-services/ai-document-intelligence)
1314

14-
mkdocs.yml # The configuration file.
15-
docs/
16-
index.md # The documentation homepage.
17-
... # Other markdown pages, images and other files.
15+
Here are the preferred tools for development.
16+
17+
- [Poetry](https://python-poetry.org/docs/#installation)
18+
- [GNU Make](https://www.gnu.org/software/make/)
19+
20+
## Projects
21+
22+
| Project | Description | Image |
23+
| --------------------------------------------------------------------------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
24+
| [1_call_azure_openai_chat](apps/1_call_azure_openai_chat) | Call Azure OpenAI Service API from Python | No Image |
25+
| [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) |
26+
| [3_call_azure_cosmos_db](apps/3_call_azure_cosmos_db) | Call Azure Cosmos DB from Python | No Image |
27+
| [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) |
28+
| [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) |
29+
| [6_call_azure_ai_search](apps/6_call_azure_ai_search) | Call Azure AI Search from Python | No Image |
30+
| [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) |
31+
| [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) |
32+
| [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) |
33+
| [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) |
34+
| [11_promptflow](apps/11_promptflow) | Get started with Prompt flow | No Image |
35+
| [12_langgraph_agent](apps/12_langgraph_agent) | Create agents with LangGraph | No Image |
36+
| [99_streamlit_examples](apps/99_streamlit_examples) | Code samples for Streamlit | ![99_streamlit_examples](./images/99_streamlit_examples.explaindata.png) |
37+
38+
## How to run
39+
40+
Referring to the [.env.template](.env.template) file, create a `.env` file in the same directory and set the required credentials.
41+
42+
### Local environment
43+
44+
```shell
45+
# Create a virtual environment
46+
$ python -m venv .venv
47+
48+
# Activate the virtual environment
49+
$ source .venv/bin/activate
50+
51+
# Install dependencies
52+
$ pip install -r requirements.txt
53+
54+
# Run the script (e.g. run 2_streamlit_chat)
55+
$ python -m streamlit run apps/2_streamlit_chat/main.py
56+
```
57+
58+
### Docker container
59+
60+
```shell
61+
# Set Docker image name
62+
## GitHub Container Registry
63+
$ IMAGE=ghcr.io/ks6088ts-labs/workshop-azure-openai:latest
64+
## Docker Hub
65+
$ IMAGE=ks6088ts/workshop-azure-openai:latest
66+
67+
# run 2_streamlit_chat
68+
$ docker run --rm \
69+
-p 8501:8501 \
70+
-v ${PWD}/.env:/app/.env \
71+
${IMAGE} \
72+
python -m streamlit run /apps/2_streamlit_chat/main.py
73+
```

0 commit comments

Comments
 (0)