(Ruby) OpenAI (ChatGTP) Create Chat Completion

See more OpenAI ChatGPT Examples

Shows how to create a model response for a given chat conversation.

For more information, see https://platform.openai.com/docs/api-reference/chat/create

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl https://api.openai.com/v1/chat/completions \
#   -H "Content-Type: application/json" \
#   -H "Authorization: Bearer $OPENAI_API_KEY" \
#   -d '{
#     "model": "gpt-3.5-turbo",
#     "messages": [{"role": "user", "content": "Hello!"}]
#   }'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "model": "gpt-3.5-turbo",
#   "messages": [
#     {
#       "role": "user",
#       "content": "Hello!"
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("model","gpt-3.5-turbo")
json.UpdateString("messages[0].role","user")
json.UpdateString("messages[0].content","Hello!")

# Adds the "Authorization: Bearer $OPENAI_API_KEY" header.
# This is NOT a real key.  Change the "sk-vi...." to your own key.
http.put_AuthToken("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")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.openai.com/v1/chat/completions","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": "chatcmpl-123",
#   "object": "chat.completion",
#   "created": 1677652288,
#   "choices": [
#     {
#       "index": 0,
#       "message": {
#         "role": "assistant",
#         "content": "\n\nHello there, how may I assist you today?"
#       },
#       "finish_reason": "stop"
#     }
#   ],
#   "usage": {
#     "prompt_tokens": 9,
#     "completion_tokens": 12,
#     "total_tokens": 21
#   }
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

id = jResp.stringOf("id")
v_object = jResp.stringOf("object")
created = jResp.IntOf("created")
Prompt_tokens = jResp.IntOf("usage.prompt_tokens")
Completion_tokens = jResp.IntOf("usage.completion_tokens")
Total_tokens = jResp.IntOf("usage.total_tokens")
i = 0
count_i = jResp.SizeOfArray("choices")
while i < count_i
    jResp.put_I(i)
    index = jResp.IntOf("choices[i].index")
    Role = jResp.stringOf("choices[i].message.role")
    Content = jResp.stringOf("choices[i].message.content")
    finish_reason = jResp.stringOf("choices[i].finish_reason")
    i = i + 1
end