Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AI Pattern GPT-RAG alert page #397

Merged
merged 5 commits into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/patterns/artificial intelligence/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Running AI workloads on Azure infrastructure involves monitoring each of the com

### AI Specialized Workload Patterns

#### GPT-RAG (coming soon)
#### [GPT-RAG](./rag/)
20 changes: 20 additions & 0 deletions docs/content/patterns/artificial intelligence/rag/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: GPT-RAG
geekdocCollapseSection: true
---

## Overview

The Retrieval-Augmented Generation (RAG) pattern is an industry-standard approach to building applications that use large language models to reason over specific or proprietary data that is not already known to the large language model.

This page provides the alert settings for AI RAG pattern setup. It contains relevant metrics and threshold recommendations for key services involved in a RAG pattern architecture.For a reference architecture design of RAG, see [GPT-RAG](https://github.com/Azure/GPT-RAG).

Below is a basic architecture of RAG implementation

![RAG Basic Architecture](https://github.com/Azure/GPT-RAG/blob/main/media/architecture-GPT-RAG-Basic.png?raw=true)

We may update these settings as we continue to work with a breadth of customers.

## Alerts

{{< ragMetricAlerts >}}
95 changes: 95 additions & 0 deletions docs/layouts/shortcodes/ragMetricAlerts.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<div><table>
<tr>
<th>Alert Name</th>
<th>Component</th>
<th>Metric</th>
<th>Aggregation</th>
<th>Operator</th>
<th>Threshold</th>
<th>Window</th>
<th>Frequency</th>
<th>Severity</th>
<th>Scope</th>
<th>Support for Multiple Resources</th>
<th>Verified</th>
<th>References</th>
</tr>

{{ range $category, $types := $.Site.Data }}
{{ range $type, $rules := $types }}
{{ range $rules.alerts }}
{{ if or (eq .visible true) (eq $.Site.Params.ambaDevMode true) }}
{{ if and (eq .type "Metric") (in .tags "rag") }}
{{ $data := newScratch }}
{{ if isset . "deployments" }}
{{ range where .deployments "type" "Policy" }}
{{ if and (in .tags "rag") }}
{{ $data.Set "name" .name }}
{{ $data.Set "url" (relURL (path.Join "services" $category $type .template)) }}
{{ $data.Set "scope" .properties.scope }}
{{ $data.Set "multiResource" .properties.multiResource }}
{{ end }}
{{ end }}
{{ end }}
<tr>
<td>
<a href='{{ $data.Get "url" }}'>{{ $data.Get "name" }}</a>
</td>
<td>
{{ .properties.metricNamespace }}
</td>
<td>
{{ .properties.metricName }}
</td>
<td>
{{ .properties.timeAggregation }}
</td>
<td>
{{ .properties.operator }}
</td>
<td>
{{ if eq .properties.criterionType "DynamicThresholdCriterion" }}
dynamic
{{ else }}
{{ .properties.threshold }}
{{ end }}
</td>
<td>
{{ .properties.windowSize }}
</td>
<td>
{{ .properties.evaluationFrequency }}
</td>
<td>
{{ .properties.severity }}
</td>
<td>
{{ $data.Get "scope" }}
</td>
<td>
{{ if ($data.Get "multiResource") }}
Yes
{{ else }}
No
{{ end }}
</td>
<td>
{{ if .verified }}
Y
{{ else }}
N
{{ end }}
</td>
<td>
{{ range .references }}
<a href="{{ .url }}" target="_blank">{{ .name }}</a>
{{ end }}
</td>
</tr>
{{ end }}
{{ end }}
{{ end }}
{{ end }}
{{ end }}

</table></div>
Loading