Docs update (#34)

openshieldai · Jul 25, 2024 · 1b1ed4b · 1b1ed4b
2 parents 3f07bab + ac8837d
commit 1b1ed4b
Show file tree

Hide file tree

Showing 7 changed files with 274 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,10 @@ AI models a new attack vector for hackers. They can use AI models to generate ma
 ## Solution
 OpenShield a transparent proxy that sits between your AI model and the client. It provides rate limiting, content filtering, and keyword filtering for AI models.
 
+![Input flow](https://github.com/openshieldai/openshield/docs/assets/input.svg)
+
+![Output flow](https://github.com/openshieldai/openshield/docs/assets/output.svg)
+
 You can chain multiple AI models together to create a pipeline before hitting the foundation model.
 
 ## Features

diff --git a/docs/assets/input.svg b/docs/assets/input.svg
diff --git a/docs/assets/output.svg b/docs/assets/output.svg
diff --git a/integrations/huggingface/index.js b/integrations/huggingface/index.js
diff --git a/integrations/openmeter/package.json b/integrations/openmeter/package.json
diff --git a/integrations/openmeter/src/index.ts b/integrations/openmeter/src/index.ts
diff --git a/server/server.go b/server/server.go
@@ -3,14 +3,15 @@ package server
 import (
 	"context"
 	"fmt"
-	"github.com/gofiber/fiber/v2/middleware/limiter"
-	"github.com/openshieldai/openshield/lib/openai"
-	"golang.org/x/sync/errgroup"
 	"os"
 	"os/signal"
 	"syscall"
 	"time"
 
+	"github.com/gofiber/fiber/v2/middleware/limiter"
+	"github.com/openshieldai/openshield/lib/openai"
+	"golang.org/x/sync/errgroup"
+
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/logger"
 	"github.com/gofiber/fiber/v2/middleware/requestid"