Skip to content

Commit

Permalink
chore: fix code samples
Browse files Browse the repository at this point in the history
  • Loading branch information
0x9ef committed Jan 4, 2023
1 parent 8b48694 commit a1494ea
Showing 1 changed file with 44 additions and 44 deletions.
88 changes: 44 additions & 44 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Golang OpenAI API Client

An Golang native implementation to easily interacting with OpenAI API.
https://beta.openai.com/docs/api-reference/

## Usage

You can use environment variable to store API secret key
```
```sh
export OPENAI_KEY=[YOUR_KEY]
```

To initialize engine, use this:
```go
e := openai.New(os.Getenv("OPENAI_KEY"))
```

### Tips

#### Model
Expand All @@ -22,22 +23,22 @@ If you want to use the most powerful model to generate text outputs, ensure that
#### Text edition
You can use the bundle Completion+Edit to regenerate the response based on the last context.
```go
e := openai.New(os.Getenv("OPENAI_KEY"))
ctx := context.Background()
completionResp, err := e.Completion(ctx, &openai.CompletionOptions{
// Choose model, you can see list of available models in models.go file
Model: openai.ModelTextDavinci001,
// Number of completion tokens to generate response. By default - 1024
MaxTokens: 1200,
// Text to completion
Prompt: []string{"Write a little bit of Wikipedia. What is that?"},
})

editResp, err := e.Edit(ctx, &EditOptions{
Model: ModelTextDavinci001,
Input: completionResp.Choices[0],
Instruction: "Please rewrite a bit more and add more information about Wikipedia in different aspects. Please build based on that for 4 topics",
})
e := openai.New(os.Getenv("OPENAI_KEY"))
ctx := context.Background()
completionResp, err := e.Completion(ctx, &openai.CompletionOptions{
// Choose model, you can see list of available models in models.go file
Model: openai.ModelTextDavinci001,
// Number of completion tokens to generate response. By default - 1024
MaxTokens: 1200,
// Text to completion
Prompt: []string{"Write a little bit of Wikipedia. What is that?"},
})

editResp, err := e.Edit(ctx, &EditOptions{
Model: ModelTextDavinci001,
Input: completionResp.Choices[0],
Instruction: "Please rewrite a bit more and add more information about Wikipedia in different aspects. Please build based on that for 4 topics",
})
```

### Text completion example
Expand All @@ -46,15 +47,15 @@ Given a prompt, the model will return one or more predicted completions.
**Note**: the default number of completion tokens is 1024, if you want to increase or decrease this limit, you should change `MaxTokens` parameter.

```go
e := openai.New(os.Getenv("OPENAI_KEY"))
r, err := e.Completion(context.Background(), &openai.CompletionOptions{
// Choose model, you can see list of available models in models.go file
Model: openai.ModelTextDavinci001,
// Number of completion tokens to generate response. By default - 1024
MaxTokens: 1200,
// Text to completion
Prompt: []string{"Write a little bit of Wikipedia. What is that?"},
})
e := openai.New(os.Getenv("OPENAI_KEY"))
r, err := e.Completion(context.Background(), &openai.CompletionOptions{
// Choose model, you can see list of available models in models.go file
Model: openai.ModelTextDavinci001,
// Number of completion tokens to generate response. By default - 1024
MaxTokens: 1200,
// Text to completion
Prompt: []string{"Write a little bit of Wikipedia. What is that?"},
})
```

You will get the next output:
Expand Down Expand Up @@ -95,27 +96,26 @@ import (
"log"
"os"
"testing"

"github.com/0x9ef/openai-go"
)
"github.com/0x9ef/openai-go"
)

func main() {
e := openai.New(os.Getenv("OPENAI_KEY"))
r, err := e.Completion(context.Background(), &openai.CompletionOptions{
// Choose model, you can see list of available models in models.go file
Model: openai.ModelTextDavinci001,
// Text to completion
Prompt: []string{"Write a little bit of Wikipedia. What is that?"}
})
e := openai.New(os.Getenv("OPENAI_KEY"))
r, err := e.Completion(context.Background(), &openai.CompletionOptions{
// Choose model, you can see list of available models in models.go file
Model: openai.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)
// Wikipedia is a free online encyclopedia, created and edited by volunteers.
fmt.Println("What is the Wikipedia?", r.Choices[0].Text)
}
```

Expand Down Expand Up @@ -162,13 +162,13 @@ You will get the next output:
To retrieve information about specified model instead of all models, you can do this:

```go
e := openai.New(os.Getenv("OPENAI_KEY"))
r, err := e.RetrieveModel(context.Background(), &openai.RetrieveModelOptions{
e := openai.New(os.Getenv("OPENAI_KEY"))
r, err := e.RetrieveModel(context.Background(), &openai.RetrieveModelOptions{
ID: openai.ModelDavinci,
})
if err != nil {
log.Fatal(err)
}
if err != nil {
log.Fatal(err)
}
```

## License
Expand Down

0 comments on commit a1494ea

Please sign in to comment.