Add functions example to README

[seanmccann]

Add the standard weather example for function calling to the README

All Submissions:

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
• Have you added an explanation of what your changes do and why you'd like us to include them?

[frmsaul]

does this work?

[seanmccann]

Yes —

"What is the weather like in San Francisco?" returns:

{"role"=>"assistant", "content"=>nil, "function_call"=>{"name"=>"get_current_weather", "arguments"=>"{\n  \"location\": \"San Francisco, CA\"\n}"}}

"What is the weather like in San Francisco in celsius?" returns:

{"role"=>"assistant", "content"=>nil, "function_call"=>{"name"=>"get_current_weather", "arguments"=>"{\n  \"location\": \"San Francisco, CA\",\n  \"unit\": \"celsius\"\n}"}}

"What is 1+1" returns:

{"role"=>"assistant", "content"=>"1 + 1 is equal to 2."}

[frmsaul]

Hmm, when I run this I just get:

       {"message"=>"Unrecognized request argument supplied: functions", "type"=>"invalid_request_error", "param"=>nil, "code"=>nil}```

[frmsaul]

Ah i get it. You need to use the latest model (for example):

gpt-4-0613

[alexrudall]

Thanks @seanmccann! Works for me 👍

[kris2150]

Doesn't work for me. The error I am getting is

<NoMethodError: undefined method `chat' for #<OpenaiChatgpt::Client:0x0000000120abcbd0 @api_key="XXXXXXXXXX", @adapter=:net_http, @request_timeout=1200, @stubs=nil>>

I have also tried model: "gpt-3.5-turbo-0613",

Here is my function.

# # ChatGPT Functions
begin
  @aiResponse = ChatGPTclient.chat(
    parameters: {
      model: "gpt-3.5-turbo-16k", 
      temperature: 1,
      frequency_penalty: 0,
      messages: [
        { 
            role: "user", 
            content:"
             - Come up with 15 different goals derived from the data attached below with 5 goals  benefits generated by You associated to each goal?"
        },
        { 
            role: "user", 
            content:"#{@selected_text}"
        },
      ],
      functions: [
        {
          name: "get_goals_from_questionnaires",
          description: "15 different goals derived from the data attached below with 5 goals",
          parameters: {
            type: :object,
            properties: {
              goal_name: {
                type: :string,
                description: "Goal Name, e.g Maintain 7 hrs sleep schedule consistently",
              },
              goal_benefits: {
                type: :string,
                description: "Goal Benefits, e.g be more energized through the day, experience better mental clairity",
              },
            },
            required: ["goal_name", "goal_benefits"],
          },
        },
      ],
    }
  )
rescue OpenaiChatgpt::Error => e
  puts e.message
end

message = @aiResponse.dig("choices", 0, "message")

render json:{ aiResponse:  message }