chore: add readme

completions.go

@@ -12,7 +12,7 @@ type CompletionOptions struct {
 	// ID of the model to use.
 	Model Model `json:"model" binding:"required"`
 	// Prompt to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
-	Prompt string `json:"prompt" binding:"required"`
+	Prompt []string `json:"prompt" binding:"required"`
 	// The maximum number of tokens to generate in the completion.
 	// The token count of your prompt plus max_tokens cannot exceed the model's context length.
 	// Most models have a context length of 2048 tokens (except for the newest models, which support 4096).

completions_test.go

@@ -15,7 +15,7 @@ func TestCompletion(t *testing.T) {
 	e := New(os.Getenv("OPENAPI_KEY"))
 	r, err := e.Completion(context.Background(), &CompletionOptions{
 		Model:  ModelTextDavinci001,
-		Prompt: "Write a little bit of Wikipedia. What is that?",
+		Prompt: []string{"Write a little bit of Wikipedia. What is that?"},
 	})
 	if err != nil {
 		log.Fatal(err)

readme.md

@@ -0,0 +1,146 @@
+# Golang OpenAI GPT-3 API Client
+
+An Golang native implementation to easily interacting with OpenAI API.
+
+## Usage
+
+You can use environment variable to store API secret key
+```
+export OPENAPI_KEY=YOUR_KEY
+```
+
+To initialize engine, use this:
+```go
+e := chatgpt.New(os.Getenv("OPENAPI_KEY"))
+```
+
+### Text completion example 
+Given a prompt, the model will return one or more predicted completions.
+
+```go
+e := chatgpt.New(os.Getenv("OPENAPI_KEY"))
+r, err := e.Completion(context.Background(), &chatgpt.CompletionOptions{
+    // Choose model, you can see list of available models in models.go file
+	Model:  chatgpt.ModelTextDavinci001, 
+    // Text to completion
+	Prompt: []string{"Write a little bit of Wikipedia. What is that?"},
+})
+```
+
+You will get the next output:
+```
+{
+  "id": "cmpl-6SrcYDLCVT7xyHKVNuSLNuhRvwOJ1",
+  "object": "text_completion",
+  "created": 1672337322,
+  "model": "text-davinci-001",
+  "choices": [
+    {
+      "text": "\n\nWikipedia is a free online encyclopedia, created and edited by volunteers.",
+      "index": 0,
+      "finish_reason": "stop"
+    }
+  ],
+  "usage": {
+    "prompt_tokens": 11,
+    "completion_tokens": 15,
+    "total_tokens": 26
+  }
+}
+```
+
+To get only the text you should use the next code:
+```go
+fmt.Println(r.Choices[0].Text)
+```
+
+So, the full code will be:
+```go
+package main 
+
+
+import (
+	"context"
+	"encoding/json"
+	"log"
+	"os"
+	"testing"
+
+    "github.com/0x9ef/chatgpt-go"
+) 
+
+func main() {
+    e := chatgpt.New(os.Getenv("OPENAPI_KEY"))
+    r, err := e.Completion(context.Background(), &chatgpt.CompletionOptions{
+        // Choose model, you can see list of available models in models.go file
+        Model:  chatgpt.ModelTextDavinci001, 
+        // Text to completion
+        Prompt: []string{"Write a little bit of Wikipedia. What is that?"}
+    })
+
+	if b, err := json.MarshalIndent(r, "", "  "); err != nil {
+		panic(err)
+	} else {
+		fmt.Println(string(b))
+	}
+
+    // Wikipedia is a free online encyclopedia, created and edited by volunteers.
+    fmt.Println("What is the Wikipedia?", r.Choices[0].Text)
+}
+```
+
+### Models list/retrieve 
+Lists the currently available models, and provides basic information about each one such as the owner and availability.
+
+```go
+e := chatgpt.New(os.Getenv("OPENAPI_KEY"))
+r, err := e.ListModels(context.Background())
+if err != nil {
+	log.Fatal(err)
+}
+```
+
+You will get the next output:
+```json
+{
+  "data": [
+    {
+      "id": "babbage",
+      "object": "model",
+      "owned_by": "openai"
+    },
+    {
+      "id": "ada",
+      "object": "model",
+      "owned_by": "openai"
+    },
+    {
+      "id": "text-davinci-002",
+      "object": "model",
+      "owned_by": "openai"
+    },
+    {
+      "id": "davinci",
+      "object": "model",
+      "owned_by": "openai"
+    },
+    ...
+  ]
+} 
+```
+
+To retrieve information about specified model instead of all models, you can do this:
+
+```go
+e := chatgpt.New(os.Getenv("OPENAPI_KEY"))
+r, err := e.RetrieveModel(context.Background(), &chatgpt.RetrieveModelOptions{
+		ID: chatgpt.ModelDavinci,
+	})
+if err != nil {
+	log.Fatal(err)
+}
+```
+
+## License
+
+[MIT](./LICENSE)