Open ai wrapper

docs/advanced-guide/using-openai-api/page.md

@@ -0,0 +1,66 @@
+# Using OpenAI Api
+
+GoFr provides an injectable module that integrates OpenAI's API into the GoFr applications. Since it doesn’t come bundled with the framework, this wrapper can be injected seamlessly to extend Gofr's capabilities, enabling developers to utilize OpenAI's powerful AI models effortlessly while maintaining flexibility and scalability.
+
+GoFr supports any OpenAI API wrapper that implements the following interface. Any other wrapper that implements the interface can be added using `app.AddOpenAI()` method, and user's can use openai across application with `gofr.Context`.
+
+```go
+type OpenAI interface {
+	// implementation of chat endpoint of openai api
+	CreateCompletions(ctx context.Context, r any) (any, error)
+}
+```
+
+### Example
+```go
+package main
+
+import (
+	"gofr.dev/pkg/gofr"
+	"gofr.dev/pkg/gofr/service/openai"
+)
+
+func main() {
+	app := gofr.New()
+
+	config := openai.Config{
+		APIKey: app.Config.Get("OPENAI_API_KEY"),
+		Model:  "gpt-3.5-turbo",
+
+		// optional config parameters
+		// BaseURL: "https://api.custom.com",
+		// Timeout: 10 * time.Second,
+		// MaxIdleConns: 10,
+	}
+
+	openAIClient, err := openai.NewClient(&config)
+	if err != nil {
+		return
+	}
+
+	app.AddOpenAI(openAIClient)
+
+	app.POST("/chat", Chat)
+
+	app.Run()
+}
+
+func Chat(ctx *gofr.Context) (any, error) {
+
+	var req *openai.CreateCompletionsRequest
+
+	if err := ctx.Bind(&req); err != nil {
+		return nil, err
+	}
+
+	println(req)
+
+	resp, err := ctx.Openai.CreateCompletions(ctx, req)
+	if err != nil {
+		return nil, err
+	}
+
+	return resp, nil
+}
+```
+

docs/navigation.js

@@ -146,6 +146,11 @@ export const navigation = [
                 title: 'Serving-Static Files',
                 href: '/docs/advanced-guide/serving-static-files',
                 desc: "Know how GoFr automatically serves static content from a static folder in the application directory."
+            },
+            {
+                title: 'Using OpenAI Api',
+                href: '/docs/advanced-guide/using-openai-api',
+                desc: "Know how to integrate OpenAI api into your applications easily with GoFr's very own OpenAI api wrapper."
             }
         ],
     },

pkg/gofr/container/container.go

@@ -62,6 +62,8 @@ type Container struct {
 	ScyllaDB   ScyllaDB
 	SurrealDB  SurrealDB
 
+	OpenAI OpenAI
+
 	KVStore KVStore
 
 	File file.FileSystem

pkg/gofr/container/mock_container.go

@@ -87,6 +87,9 @@ func NewMockContainer(t *testing.T, options ...options) (*Container, *Mocks) {
 	opentsdbMock := NewMockOpenTSDBProvider(ctrl)
 	container.OpenTSDB = opentsdbMock
 
+	openAIMock := NewMockOpenAIProvider(ctrl)
+	container.OpenAI = openAIMock
+
 	var httpMock *service.MockHTTP
 
 	container.Services = make(map[string]service.HTTP)

pkg/gofr/container/mockcontainer_test.go

@@ -15,26 +15,13 @@ import (
 )
 
 func Test_HttpServiceMock(t *testing.T) {
-	test := struct {
-		desc        string
-		path        string
-		statusCode  int
-		expectedRes string
-	}{
-
-		desc:        "simple service handler",
-		path:        "/fact",
-		expectedRes: `{"data":{"fact":"Cats have 3 eyelids.","length":20}}` + "\n",
-		statusCode:  200,
-	}
-
 	httpservices := []string{"cat-facts", "cat-facts1", "cat-facts2"}
 
 	_, mock := NewMockContainer(t, WithMockHTTPService(httpservices...))
 
 	res := httptest.NewRecorder()
 	res.Body = bytes.NewBufferString(`{"fact":"Cats have 3 eyelids.","length":20}` + "\n")
-	res.Code = test.statusCode
+	res.Code = 200
 	result := res.Result()
 
 	// Setting mock expectations

pkg/gofr/container/services.go

@@ -0,0 +1,28 @@
+package container
+
+import (
+	"context"
+)
+
+// OpenAI is the interface that wraps the basic endpoint of OpenAI API.
+
+type OpenAI interface {
+	// implementation of chat endpoint of OpenAI API
+	CreateCompletions(ctx context.Context, r any) (any, error)
+}
+
+type OpenAIProvider interface {
+	OpenAI
+
+	// UseLogger set the logger for OpenAI client
+	UseLogger(logger any)
+
+	// UseMetrics set the logger for OpenAI client
+	UseMetrics(metrics any)
+
+	// UseTracer set the logger for OpenAI client
+	UseTracer(tracer any)
+
+	// InitMetrics is used to initializes metrics for the client
+	InitMetrics()
+}