Talk with your Enterprise data with Azure OpenAI and Cognitive Search.
+{{< 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="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 %}} diff --git a/content/en/docs/Concepts/_index.md b/content/en/docs/Concepts/_index.md new file mode 100644 index 0000000..c120375 --- /dev/null +++ b/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. diff --git a/content/en/docs/Concepts/azure-apim.md b/content/en/docs/Concepts/azure-apim.md new file mode 100644 index 0000000..9fe7bf6 --- /dev/null +++ b/content/en/docs/Concepts/azure-apim.md @@ -0,0 +1,8 @@ +--- +title: Azure APIM +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: [Examples] +tags: [test, sample, docs] +--- \ No newline at end of file diff --git a/content/en/docs/Concepts/azure-application-insights.md b/content/en/docs/Concepts/azure-application-insights.md new file mode 100644 index 0000000..e5e8a56 --- /dev/null +++ b/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: [Examples] +tags: [test, sample, docs] +--- \ No newline at end of file diff --git a/content/en/docs/Concepts/azure-cognitive-search.md b/content/en/docs/Concepts/azure-cognitive-search.md new file mode 100644 index 0000000..68a81ee --- /dev/null +++ b/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: [Examples] +tags: [test, sample, docs] +--- \ No newline at end of file diff --git a/content/en/docs/Concepts/azure-container-apps.md b/content/en/docs/Concepts/azure-container-apps.md new file mode 100644 index 0000000..c9160fb --- /dev/null +++ b/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: [Examples] +tags: [test, sample, docs] +--- \ No newline at end of file diff --git a/content/en/docs/Concepts/azure-openai.md b/content/en/docs/Concepts/azure-openai.md new file mode 100644 index 0000000..b740065 --- /dev/null +++ b/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: [Examples] +tags: [test, sample, docs] +--- \ No newline at end of file diff --git a/content/en/docs/Concepts/semantic-kernel.md b/content/en/docs/Concepts/semantic-kernel.md new file mode 100644 index 0000000..ae6017f --- /dev/null +++ b/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: [Examples] +tags: [test, sample, docs] +--- \ No newline at end of file diff --git a/content/en/docs/Contribution guidelines/_index.md b/content/en/docs/Contribution guidelines/_index.md new file mode 100644 index 0000000..c7e5e96 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/content/en/docs/Deploy the Architecture/_index.md b/content/en/docs/Deploy the Architecture/_index.md new file mode 100644 index 0000000..a61da31 --- /dev/null +++ b/content/en/docs/Deploy the Architecture/_index.md @@ -0,0 +1,11 @@ +--- +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 %}} + +TODO: Add your content here. \ No newline at end of file diff --git a/content/en/docs/Overview/_index.md b/content/en/docs/Overview/_index.md new file mode 100644 index 0000000..3d75b3a --- /dev/null +++ b/content/en/docs/Overview/_index.md @@ -0,0 +1,22 @@ +--- +title: Overview +description: Here's where your user finds out if your project is for them. +weight: 1 +--- + +{{% pageinfo %}} +This is a placeholder page that shows you how to use this template site. +{{% /pageinfo %}} + +TODO + +Try answering these questions for your user in this page: + +## What is it? + +Introduce your project, including what it does or lets you do, why you would use it, and its primary goal (and how it achieves it). This should be similar to your README description, though you can go into a little more detail here if you want. + +## Where should I go next? + +TODO + diff --git a/content/en/docs/Reference/_index.md b/content/en/docs/Reference/_index.md new file mode 100644 index 0000000..c020a1f --- /dev/null +++ b/content/en/docs/Reference/_index.md @@ -0,0 +1,11 @@ +--- +title: Resources & References +description: Check out other resources and references +weight: 9 +--- + +{{% pageinfo %}} +This is a placeholder page that shows you how to use this template site. +{{% /pageinfo %}} + +TODO: Add your content here. diff --git a/content/en/docs/Supported Scenarios/_index.md b/content/en/docs/Supported Scenarios/_index.md new file mode 100644 index 0000000..dcb52a8 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md new file mode 100644 index 0000000..0890824 --- /dev/null +++ b/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. + diff --git a/content/en/search.md b/content/en/search.md new file mode 100644 index 0000000..394feea --- /dev/null +++ b/content/en/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..ec0974f --- /dev/null +++ b/go.mod @@ -0,0 +1,9 @@ +module github.com/google/docsy-example + +go 1.12 + +require ( + github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 // indirect + github.com/google/docsy v0.7.1 // indirect + github.com/twbs/bootstrap v5.2.3+incompatible // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..e1d4ad4 --- /dev/null +++ b/go.sum @@ -0,0 +1,22 @@ +github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f h1:bvkUptSRPZBr3Kxuk+bnWCEmQ5MtEJX5fjezyV0bC3g= +github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4 h1:xfr9SidRCMEh4A8fdkLhFPcHAVbrdv3Ua0Jp/nSmhhQ= +github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 h1:Uv1z5EqCfmiK4IHUwT0m3h/u/WCk+kpRfxvAZhpC7Gc= +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.5.1 h1:D/ZdFKiE29xM/gwPwQzmkyXhcbQGkReRS6aGrF7lnYk= +github.com/google/docsy v0.5.1/go.mod h1:maoUAQU5H/d+FrZIB4xg1EVWAx7RyFMGSDJyWghm31E= +github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= +github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= +github.com/google/docsy v0.7.0 h1:JaeZ0/KufX/BJ3SyATb/fmZa1DFI7o5d9KU+i6+lLJY= +github.com/google/docsy v0.7.0/go.mod h1:5WhIFchr5BfH6agjcInhpLRz7U7map0bcmKSpcrg6BE= +github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY= +github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc= +github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/google/docsy/dependencies v0.7.0/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o= +github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.2.3+incompatible h1:lOmsJx587qfF7/gE7Vv4FxEofegyJlEACeVV+Mt7cgc= +github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/hugo.toml b/hugo.toml new file mode 100644 index 0000000..6cd14fd --- /dev/null +++ b/hugo.toml @@ -0,0 +1,188 @@ +baseURL = "/" +title = "Activate GenAI with Azure" + +# Language settings +contentDir = "content/en" +defaultContentLanguage = "en" +defaultContentLanguageInSubdir = false +# Useful when translating. +enableMissingTranslationPlaceholders = true + +enableRobotsTXT = true + +# Will give values to .Lastmod etc. +enableGitInfo = true + +# Comment out to enable taxonomies in Docsy +# disableKinds = ["taxonomy", "taxonomyTerm"] + +# You can add your own taxonomies +[taxonomies] +tag = "tags" +category = "categories" + +[params.taxonomy] +# set taxonomyCloud = [] to hide taxonomy clouds +taxonomyCloud = ["tags", "categories"] + +# If used, must have same length as taxonomyCloud +taxonomyCloudTitle = ["Tag Cloud", "Categories"] + +# set taxonomyPageHeader = [] to hide taxonomies on the page headers +taxonomyPageHeader = ["tags", "categories"] + +# Highlighting config +pygmentsCodeFences = true +pygmentsUseClasses = false +# Use the new Chroma Go highlighter in Hugo. +pygmentsUseClassic = false +#pygmentsOptions = "linenos=table" +# See https://help.farbox.com/pygments.html +pygmentsStyle = "tango" + +# Configure how URLs look like per section. +[permalinks] +blog = "/:section/:year/:month/:day/:slug/" + +# Image processing configuration. +[imaging] +resampleFilter = "CatmullRom" +quality = 75 +anchor = "smart" + +[services] +[services.googleAnalytics] +# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. +id = "UA-00000000-0" + +# Language configuration + +[languages] +[languages.en] +languageName ="English" +# Weight used for sorting. +weight = 1 +[languages.en.params] +title = "Activate GenAI with Azure" +description = "Activate GenAI with Azure" + +[markup] + [markup.goldmark] + [markup.goldmark.parser.attribute] + block = true + [markup.goldmark.renderer] + unsafe = true + [markup.highlight] + # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html + style = "tango" + # Uncomment if you want your chosen highlight style used for code blocks without a specified language + # guessSyntax = "true" + +# Everything below this are Site Params + +# Comment out if you don't want the "print entire section" link enabled. +[outputs] +section = ["HTML", "print", "RSS"] + +[params] +copyright = "The Activate GenAI with Azure" +# privacy_policy = "https://github.com/azure/activate-genai/SECURITY.md" + +# First one is picked as the Twitter card image if not set on page. +# images = ["images/project-illustration.png"] + +# Menu title if your navbar has a versions selector to access old versions of your site. +# This menu appears only if you have at least one [params.versions] set. +version_menu = "Releases" + +# Flag used in the "version-banner" partial to decide whether to display a +# banner on every page indicating that this is an archived version of the docs. +# Set this flag to "true" if you want to display the banner. +archived_version = false + +# The version number for the version of the docs represented in this doc set. +# Used in the "version-banner" partial to display a version number for the +# current doc set. +version = "0.0" + +# A link to latest version of the docs. Used in the "version-banner" partial to +# point people to the main doc site. +url_latest_version = "https://example.com" + +# Repository configuration (URLs for in-page links to opening issues and suggesting changes) +github_repo = "https://github.com/azure/activate-genai" +# An optional link to a related project repo. For example, the sibling repository where your product code lives. +github_project_repo = "https://github.com/azure/activate-genai" + +# Specify a value here if your content directory is not in your repo's root directory +# github_subdir = "" + +# Uncomment this if your GitHub repo does not have "main" as the default branch, +# or specify a new value if you want to reference another branch in your GitHub links +github_branch= "main" + +# Google Custom Search Engine ID. Remove or comment out to disable search. +gcs_engine_id = "d72aa9b2712488cc3" + +# Enable Algolia DocSearch +algolia_docsearch = false + +# Enable Lunr.js offline search +offlineSearch = false + +# Enable syntax highlighting and copy buttons on code blocks with Prism +prism_syntax_highlighting = false + +# User interface configuration +[params.ui] +# Set to true to disable breadcrumb navigation. +breadcrumb_disable = false +# Set to true to disable the About link in the site footer +footer_about_disable = false +# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar +navbar_logo = true +# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. +navbar_translucent_over_cover_disable = false +# Enable to show the side bar menu in its compact state. +sidebar_menu_compact = false +# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) +sidebar_search_disable = false + +# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. +# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. +# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, +# add "hide_feedback: true" to the page's front matter. +[params.ui.feedback] +enable = true +# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). +yes = 'Glad to hear it! Please tell us how we can improve.' +no = 'Sorry to hear that. Please tell us how we can improve.' + +# Adds a reading time to the top of each doc. +# If you want this feature, but occasionally need to remove the Reading time from a single page, +# add "hide_readingtime: true" to the page's front matter +[params.ui.readingtime] +enable = false + +[params.links] +# Developer relevant links. These will show up on right side of footer and in the community page if you have one. +[[params.links.developer]] + name = "GitHub" + url = "https://github.com/azure/activate-genai" + icon = "fab fa-github" + desc = "Development takes place here!" + +# hugo module configuration + +[module] + # uncomment line below for temporary local development of module + # replacements = "github.com/google/docsy -> ../../docsy" + [module.hugoVersion] + extended = true + min = "0.110.0" + [[module.imports]] + path = "github.com/google/docsy" + disable = false + [[module.imports]] + path = "github.com/google/docsy/dependencies" + disable = false diff --git a/layouts/404.html b/layouts/404.html new file mode 100644 index 0000000..1a9bd70 --- /dev/null +++ b/layouts/404.html @@ -0,0 +1,7 @@ +{{ define "main" -}} +Oops! This page doesn't exist. Try going back to the home page.
+You can learn how to make a 404 page like this in Custom 404 Pages.
+