LICENSE committed

.github/workflows/gh-pages.yml

@@ -0,0 +1,86 @@
+name: github pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.119.0
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+                        ${{ runner.os }}-node-
+
+      - name: Install dependencies
+        run: |
+          npm install -D autoprefixer
+          npm install -D postcss-cli
+          npm install -D postcss
+          npm install
+
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v1
+
+      - name: Build with Hugo
+        run: hugo --gc --minify --cleanDestinationDir --baseURL https://azure.github.io/activate-genai/
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -1,7 +1,5 @@
-_site/
-.sass-cache/
-.jekyll-cache/
-.jekyll-metadata
-# Ignore folders generated by Bundler
-.bundle/
-vendor/
+/public
+resources/
+node_modules/
+package-lock.json
+.hugo_build.lock

LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

assets/scss/_variables_project.scss

@@ -0,0 +1,6 @@
+/*
+
+Add styles or override variables from the theme here.
+
+*/
+

config.yaml

@@ -0,0 +1,15 @@
+# THIS IS A TEST CONFIG ONLY!
+# FOR THE CONFIGURATION OF YOUR SITE USE hugo.yaml.
+#
+# As of Docsy 0.7.0, Hugo 0.110.0 or later must be used.
+#
+# The sole purpose of this config file is to detect Hugo-module builds that use
+# an older version of Hugo.
+#
+# DO NOT add any config parameters to this file. You can safely delete this file
+# if your project is using the required Hugo version.
+
+module:
+  hugoVersion:
+    extended: true
+    min: 0.110.0

content/en/_index.md

@@ -0,0 +1,40 @@
+---
+title: Activate GenAI with Azure
+---
+
+{{< blocks/cover title="Activate GenAI with Azure!" image_anchor="top" height="full" >}}
+<a class="btn btn-lg btn-primary me-3 mb-4" href="/activate-genai/docs/">
+  Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
+</a>
+<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/azure/activate-genai">
+  Download <i class="fab fa-github ms-2 "></i>
+</a>
+<p class="lead mt-5">Talk with your Enterprise data with Azure OpenAI and Cognitive Search.</p>
+{{< blocks/link-down color="info" >}}
+{{< /blocks/cover >}}
+
+
+{{% blocks/lead color="primary" %}}
+
+This delivery guide will help you build a ChatGPT-like experiences over your Enterprise data using the Retrieval Augmented Generation pattern. 
+
+Under the hood the solution uses Azure OpenAI Service to access the ChatGPT model (gpt-35-turbo), and Azure Cognitive Search for data indexing and retrieval.
+
+{{% /blocks/lead %}}
+
+
+{{% blocks/section color="dark" type="row" %}}
+
+{{% blocks/feature icon="fab fa-github" title="Read the Docs!" url="https://azure.github.io/activate-genai/" %}}
+Read the delivery guide and learn how to deploy the solution.
+{{% /blocks/feature %}}
+
+{{% blocks/feature icon="fab fa-github" title="Deploy the Solution!" url="https://github.com/azure/activate-genai/" %}}
+Use `terraform` to deploy the complete solution.
+{{% /blocks/feature %}}
+
+{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/azure/activate-genai" %}}
+We do a [Pull Request](https://github.com/azure/activate-genai/pulls) contributions workflow on **GitHub**. New users are always welcome!
+{{% /blocks/feature %}}
+
+{{% /blocks/section %}}

content/en/docs/Concepts/_index.md

@@ -0,0 +1,12 @@
+---
+title: Concepts
+weight: 4
+description: >
+  Understand the core components of the soltion: Azure Open AI, Azure Cognitive Search, Azure APIM and more.
+---
+
+{{% pageinfo %}}
+This is a placeholder page that shows you how to use this template site.
+{{% /pageinfo %}}
+
+TODO: Add your content here.

content/en/docs/Concepts/azure-apim.md

@@ -0,0 +1,10 @@
+---
+title: Azure APIM 
+date: 2023-06-10
+description: >
+  Use Azure APIM to monitor and load balance 2 or more Azure OpenAI instances.
+categories: [Azure]
+tags: [docs, apim]
+---
+
+Azure API Management is a platform-as-a-service that provides a hybrid, multicloud management platform for APIs across all environments [1](https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts).. It supports the complete API lifecycle and helps customers manage APIs as first-class assets throughout their lifecycle [1](https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts).

content/en/docs/Concepts/azure-application-insights.md

@@ -0,0 +1,8 @@
+---
+title: Azure Application Insights
+date: 2023-06-10
+description: >
+  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
+categories: [Azure]
+tags: [docs, application-insights]
+---

content/en/docs/Concepts/azure-cognitive-search.md

@@ -0,0 +1,8 @@
+---
+title: Azure Cognitive Search
+date: 2023-06-10
+description: >
+  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
+categories: [Azure]
+tags: [docs, cognitive-search]
+---

content/en/docs/Concepts/azure-container-apps.md

@@ -0,0 +1,8 @@
+---
+title: Azure Container Apps
+date: 2023-06-10
+description: >
+  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
+categories: [Azure]
+tags: [docs, container-apps]
+---

content/en/docs/Concepts/azure-openai.md

@@ -0,0 +1,8 @@
+---
+title: Azure OpenAI
+date: 2023-06-10
+description: >
+  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
+categories: [Azure]
+tags: [docs, openai]
+---

content/en/docs/Concepts/semantic-kernel.md

@@ -0,0 +1,8 @@
+---
+title: Semantic Kernel
+date: 2023-06-10
+description: >
+  A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
+categories: [SDK]
+tags: [docs, tools]
+---

content/en/docs/Contribution guidelines/_index.md

@@ -0,0 +1,11 @@
+---
+title: Contribution Guidelines
+weight: 10
+description: How to contribute to the project
+---
+
+{{% pageinfo %}}
+TODO
+{{% /pageinfo %}}
+
+TODO

content/en/docs/Deploy the Architecture/_index.md

@@ -0,0 +1,16 @@
+---
+title: Deploy the Architecture
+weight: 3
+description: This guide provides details and instructions to help you deploy the Activate GenAI with Azure Accelerator for your customer.
+---
+
+{{% pageinfo %}}
+Deploy the Architecture
+{{% /pageinfo %}}
+
+Run the following command to deploy the **Activate GenAI with Azure** Accelerator:
+
+```bash
+cd infra
+terraform apply
+```

content/en/docs/Overview/_index.md

@@ -0,0 +1,45 @@
+---
+title: Overview
+description: Activate GenAI with Azure — A smart and scalable document retrieval solution"
+weight: 1
+---
+
+{{% pageinfo %}}
+Work in progress...
+{{% /pageinfo %}}
+
+## Description
+**Activate GenAI with Azure** is a new delivery that leverages the power of artificial intelligence and cloud computing to provide a smart and scalable document retrieval solution. The solution uses Azure OpenAI, Cognitive Search, Container Apps, Application Insights, and Azure API Management to create a chat interface that can answer user queries with relevant documents, suggested follow-up questions, and citations. The solution also allows users to upload custom data files and perform vector search using semantic or hybrid methods. Additionally, the solution supports extensibility through plugins, charge back functionality, security features such as authentication and authorization, monitoring capabilities, and scalability options.
+
+## Pre-requisites
+To use this solution, you will need the following:
+- An Azure subscription
+- A User, Service Principal or Managed Identity with the following permissions:
+  - Contributor role on the Azure subscription
+- Azure CLI v2.253.0 or later
+- Terraform v1.6.0 or later
+
+## Objectives
+By the end of this delivery, you will be able to:
+- Configure and deploy the **Activate GenAI with Azure** solution
+- Use the chat interface to query documents and get relevant results
+- Upload custom data files and perform vector search
+- Extend the solution with plugins
+- Manage the charge back functionality
+- Secure and monitor the solution
+- Scale and integrate the solution with other services
+
+## Delivery Guidance
+This delivery consists of the following steps:
+- Step 1: Create and configure the Azure resources
+- Step 2: Deploy the **Activate GenAI with Azure** solution to the Azure Container App service
+- Step 3: Test and use the chat interface to query documents
+- Step 4: Upload custom data files and perform vector search
+- Step 5: Extend the solution with plugins
+- Step 6: Manage the charge back functionality
+- Step 7: Secure and monitor the solution
+- Step 8: Scale and integrate the solution with other services
+
+## Closing
+**Activate GenAI with Azure** is a powerful and innovative solution that can help you improve your document retrieval efficiency, enhance your user experience, increase your productivity, share your knowledge, scale and integrate your solution, gain data insights and analytics, and comply with security standards. We hope you enjoy using this solution and benefit from its features.
+

content/en/docs/Reference/_index.md

@@ -0,0 +1,26 @@
+---
+title: Resources & References
+description: Check out other resources and references
+weight: 9
+---
+
+## Sample Repos:
+
+* [Chat Copilot Sample Application](https://github.com/microsoft/chat-copilot)
+* [ChatGPT + Enterprise data with Azure OpenAI and Cognitive Search](https://github.com/Azure-Samples/azure-search-openai-demo)
+* [Azure OpenAI Embeddings QnA](https://github.com/ruoccofabrizio/azure-open-ai-embeddings-qna)
+
+## Azure APIM & Azure OpenAI
+
+* [Load Balancing in Azure OpenAI Service](https://journeyofthegeek.com/2023/05/31/load-balancing-in-azure-openai-service/)
+* [Granular Chargebacks in Azure OpenAI Service](https://journeyofthegeek.com/2023/05/18/granular-chargebacks-in-azure-openai-service/)
+* [Enterprise Azure OpenA](https://github.com/Azure-Samples/openai-python-enterprise-logging)
+
+## Azure Services
+
+* [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service)
+* [Azure Cognitive Search](https://learn.microsoft.com/en-us/azure/search/search-what-is-azure-search)
+* [Azure Container Apps](https://learn.microsoft.com/en-us/azure/container-apps/overview)
+* [Azure API Management](https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts)
+* [Azure Application Insights](hhttps://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview?tabs=net)
+* [Azure Active Directory](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/whatis)

content/en/docs/Supported Scenarios/_index.md

@@ -0,0 +1,11 @@
+---
+title: Supported Scenarios
+weight: 2
+description: Understand the supported Scenarios.
+---
+
+{{% pageinfo %}}
+Supported Scenarios
+{{% /pageinfo %}}
+
+TODO: Add your content here.

content/en/docs/_index.md

@@ -0,0 +1,13 @@
+---
+title: Activate GenAI with Azure
+linkTitle: Documentation
+menu: {main: {weight: 20}}
+weight: 20
+---
+
+{{% pageinfo %}}
+**Activate GenAI with Azure!** — Talk with your Enterprise data with Azure OpenAI and Cognitive Search.
+{{% /pageinfo %}}
+
+This delivery guide will help you build a ChatGPT-like experiences over your Enterprise data using the Retrieval Augmented Generation pattern. Under the hood the solution uses Azure OpenAI Service to access the ChatGPT model (gpt-35-turbo), and Azure Cognitive Search for data indexing and retrieval.
+

content/en/search.md

@@ -0,0 +1,4 @@
+---
+title: Search Results
+layout: search
+---