Module: Intelligence::OpenAi::ChatRequestMethods

Defined in:
lib/intelligence/adapters/open_ai/chat_request_methods.rb

Constant Summary collapse

CHAT_REQUEST_URI = 
"https://api.openai.com/v1/chat/completions"
SUPPORTED_CONTENT_TYPES = 
[ 'image/jpeg', 'image/png' ]

Instance Method Summary collapse

Instance Method Details

#chat_request_body(conversation, options = {}) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/intelligence/adapters/open_ai/chat_request_methods.rb', line 32

def chat_request_body( conversation, options = {} )

  tools = options.delete( :tools ) || []

  options = merge_options( @options, build_options( options ) )
  result = options[ :chat_options ]&.compact || {}
  result[ :messages ] = []

  system_message = to_open_ai_system_message( conversation[ :system_message ] )
  result[ :messages ] << { role: 'system', content: system_message } if system_message

  conversation[ :messages ]&.each do | message |
   
    result_message = { role: message[ :role ] }
    result_message_content = []
    
    message[ :contents ]&.each do | content |
      case content[ :type ]
      when :text
        result_message_content << { type: 'text', text: content[ :text ] }
      when :binary
        content_type = content[ :content_type ]
        bytes = content[ :bytes ]
        if content_type && bytes
          if SUPPORTED_CONTENT_TYPES.include?( content_type )
            result_message_content << {
              type: 'image_url',
              image_url: {
                url: "data:#{content_type};base64,#{Base64.strict_encode64( bytes )}".freeze
              }
            }
          else
            raise UnsupportedContentError.new( 
              :open_ai, 
              "only supports content of type #{SUPPORTED_CONTENT_TYPES.join( ', ' )}"
            ) 
          end
        else 
          raise UnsupportedContentError.new(
            :open_ai, 
            'requires binary content to include content type and ( packed ) bytes'  
          )
        end
      when :file 
        content_type = content[ :content_type ]
        uri = content[ :uri ]
        if content_type && uri  
          if SUPPORTED_CONTENT_TYPES.include?( content_type )
            result_message_content << {
              type: 'image_url',
              image_url: {
                url: uri 
              }
            }
          else 
            raise UnsupportedContentError.new( 
              :open_ai, 
              "only supports content of type #{SUPPORTED_CONTENT_TYPES.join( ', ' )}" 
            ) 
          end 
        else 
          raise UnsupportedContentError.new(
            :open_ai, 
            'requires file content to include content type and uri'  
          )
        end 
      when :tool_call 
        tool_calls = result_message[ :tool_calls ] || [] 
        function = {
          name: content[ :tool_name ]
        }
        function[ :arguments ] = JSON.generate( content[ :tool_parameters ] || {} )
        tool_calls << { id: content[ :tool_call_id ], type: 'function', function: function }
        result_message[ :tool_calls ] = tool_calls
      when :tool_result 
        # open-ai returns tool results as a message with a role of 'tool'
        result[ :messages ] << {
          role: :tool, 
          tool_call_id: content[ :tool_call_id ],
          content: content[ :tool_result ]
        }
      else 
        raise InvalidContentError.new( :open_ai ) 
      end

    end

    result_message[ :content ] = result_message_content
    result[ :messages ] << result_message \
      if result_message[ :content ]&.any? || result_message[ :tool_calls ]&.any? 
    result

  end
 
  tools_attributes = chat_request_tools_attributes( 
    ( result[ :tools ] || [] ).concat( tools ) 
  )
  result[ :tools ] = tools_attributes if tools_attributes && tools_attributes.length > 0
 
  JSON.generate( result )
end

#chat_request_headers(options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/intelligence/adapters/open_ai/chat_request_methods.rb', line 13

def chat_request_headers( options = {} )
  options = merge_options( @options, build_options( options ) )
  result = {}

  key = options[ :key ] 
  organization = options[ :organization ] 
  project = options[ :project ]  

  raise ArgumentError.new( "An OpenAI key is required to build an OpenAI chat request." ) \
    if key.nil?

  result[ 'Content-Type' ] = 'application/json'
  result[ 'Authorization' ] = "Bearer #{key}"
  result[ 'OpenAI-Organization' ] = organization unless organization.nil?
  result[ 'OpenAI-Project' ] = project unless project.nil?

  result 
end

#chat_request_tools_attributes(tools) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/intelligence/adapters/open_ai/chat_request_methods.rb', line 134

def chat_request_tools_attributes( tools ) 
  properties_array_to_object = lambda do | properties |
    return nil unless properties&.any?  
    object = {}
    required = []
    properties.each do | property | 
      name = property.delete( :name ) 
      required << name if property.delete( :required )
      if property[ :properties ]&.any?  
        property_properties, property_required = 
          properties_array_to_object.call( property[ :properties ] ) 
        property[ :properties ] = property_properties 
        property[ :required ] = property_required if property_required.any?
      end 
      object[ name ] = property 
    end 
    [ object, required.compact  ]
  end

  tools&.map do | tool |
    function = { 
      type: 'function',
      function: {
        name: tool[ :name ],
        description: tool[ :description ],
      }
    }

    if tool[ :properties ]&.any? 
      properties_object, properties_required = 
        properties_array_to_object.call( tool[ :properties ] ) 
      function[ :function ][ :parameters ] = {
        type: 'object',
        properties: properties_object 
      }
      function[ :function ][ :parameters ][ :required ] = properties_required \
        if properties_required.any?
    end
    function 
  end
end

#chat_request_uri(options) ⇒ Object 



9
10
11
 
# File 'lib/intelligence/adapters/open_ai/chat_request_methods.rb', line 9

def chat_request_uri( options )
  CHAT_REQUEST_URI
end