Merge pull request #2 from rory-linehan/0.3.0

0.3.0

CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.3.0
+
+* adding completions
+
 ### 0.2.0
 
 * engine endpoints deprecated in favor of models

Project.toml

@@ -1,7 +1,7 @@
 name = "OpenAI"
 uuid = "e9f21f70-7185-4079-aca2-91159181367c"
 authors = ["Rory Linehan <[email protected]>"]
-version = "0.2.0"
+version = "0.3.0"
 
 [deps]
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"

README.md

@@ -10,6 +10,6 @@ Provides a wrapper to the OpenAI API.
 
 See tests for example usage.
 
-## Feature Requests
+## Feature requests
 
 Feel free to open a PR, or file an issue if that's out of reach!

src/OpenAI.jl

@@ -40,10 +40,10 @@ https://beta.openai.com/docs/api-reference/models/retrieve
 
 # Arguments:
 - `api_key::String`: OpenAI API key
-- `engine_id::String`: Engine id
+- `model_id::String`: Model id
 """
-function retrieve_model(api_key::String, engine_id::String)
-  url = BASE_URL_v1*"/models/"*engine_id
+function retrieve_model(api_key::String, model_id::String)
+  url = BASE_URL_v1*"/models/"*model_id
   request_headers = Dict(
     "Authorization" => "Bearer "*api_key,
     "Content-Type" => "application/json",
@@ -57,8 +57,36 @@ function retrieve_model(api_key::String, engine_id::String)
   return OpenAIResponse(response.status, JSON.parse(String(response.body)))
 end
 
+"""
+Create completion
+
+https://beta.openai.com/docs/api-reference/completions
+
+# Arguments:
+- `api_key::String`: OpenAI API key
+- `model_id::String`: Model id
+"""
+function create_completion(api_key::String, model_id::String; kwargs...)
+  url = BASE_URL_v1*"/completions"
+  request_headers = Dict(
+    "Authorization" => "Bearer "*api_key,
+    "Content-Type" => "application/json",
+  )
+  params = Dict(kwargs)
+  params[:model] = model_id
+  response = HTTP.request(
+    "POST",
+    url,
+    request_headers,
+    JSON.json(params);
+    retry = false
+  )
+  return OpenAIResponse(response.status, JSON.parse(String(response.body)))
+end
+
 export OpenAIResponse
 export list_models
 export retrieve_model
+export create_completion
 
 end # module

test/completion.jl

@@ -0,0 +1,16 @@
+@testset "completion" begin
+  api_key = "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"
+  r = list_models(api_key)
+  if !=(r.status, 200)
+    @test false
+  end
+  r = create_completion(
+    api_key, 
+    r.response["data"][begin]["id"];
+    prompt = "Say this is a test"
+  )
+  println(r.response["choices"][begin]["text"])
+  if !=(r.status, 200)
+    @test false
+  end
+end

test/models.jl

@@ -1,13 +1,13 @@
 @testset "models" begin
-    api_key = "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"
-    r = list_models(api_key)
-    println(r)
-    if !=(r.status, 200)
-      @test false
-    end
-    r = retrieve_model(api_key, r.response["data"][begin]["id"])
-    println(r)
-    if !=(r.status, 200)
-      @test false
-    end
-  end
+  api_key = "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"
+  r = list_models(api_key)
+  println(r)
+  if !=(r.status, 200)
+    @test false
+  end
+  r = retrieve_model(api_key, r.response["data"][begin]["id"])
+  println(r)
+  if !=(r.status, 200)
+    @test false
+  end
+end

test/runtests.jl

@@ -6,4 +6,7 @@ using Test
   @testset "models" begin
     include("models.jl")
   end
+  @testset "completion" begin
+    include("completion.jl")
+  end
 end