-
Notifications
You must be signed in to change notification settings - Fork 255
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #397 from Akiliu0512/amba-ai-tasks-octsprint
Update AI Pattern GPT-RAG alert page
- Loading branch information
Showing
9 changed files
with
475 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
docs/content/patterns/artificial intelligence/rag/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
Oops, something went wrong.