Class: OpenApiOpenAIClient::FineTuningApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_openai/api/fine_tuning_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FineTuningApi

Returns a new instance of FineTuningApi.



19
20
21
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_fine_tuning_job(fine_tuning_job_id, opts = {}) ⇒ FineTuningJob

Immediately cancel a fine-tune job.

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job to cancel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 26

def cancel_fine_tuning_job(fine_tuning_job_id, opts = {})
  data, _status_code, _headers = cancel_fine_tuning_job_with_http_info(fine_tuning_job_id, opts)
  data
end

#cancel_fine_tuning_job_with_http_info(fine_tuning_job_id, opts = {}) ⇒ Array<(FineTuningJob, Integer, Hash)>

Immediately cancel a fine-tune job.

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job to cancel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FineTuningJob, Integer, Hash)>) —

    FineTuningJob data, response status code and response headers



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
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 35

def cancel_fine_tuning_job_with_http_info(fine_tuning_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FineTuningApi.cancel_fine_tuning_job ...'
  end
  # verify the required parameter 'fine_tuning_job_id' is set
  if @api_client.config.client_side_validation && fine_tuning_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'fine_tuning_job_id' when calling FineTuningApi.cancel_fine_tuning_job"
  end
  # resource path
  local_var_path = '/fine_tuning/jobs/{fine_tuning_job_id}/cancel'.sub('{' + 'fine_tuning_job_id' + '}', CGI.escape(fine_tuning_job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FineTuningJob'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"FineTuningApi.cancel_fine_tuning_job",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FineTuningApi#cancel_fine_tuning_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_fine_tuning_job(create_fine_tuning_job_request, opts = {}) ⇒ FineTuningJob

Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about fine-tuning](/docs/guides/fine-tuning)

Parameters:

Returns:



87
88
89
90
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 87

def create_fine_tuning_job(create_fine_tuning_job_request, opts = {})
  data, _status_code, _headers = create_fine_tuning_job_with_http_info(create_fine_tuning_job_request, opts)
  data
end

#create_fine_tuning_job_with_http_info(create_fine_tuning_job_request, opts = {}) ⇒ Array<(FineTuningJob, Integer, Hash)>

Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about fine-tuning](/docs/guides/fine-tuning)

Parameters:

Returns:

  • (Array<(FineTuningJob, Integer, Hash)>) —

    FineTuningJob data, response status code and response headers



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 96

def create_fine_tuning_job_with_http_info(create_fine_tuning_job_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FineTuningApi.create_fine_tuning_job ...'
  end
  # verify the required parameter 'create_fine_tuning_job_request' is set
  if @api_client.config.client_side_validation && create_fine_tuning_job_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_fine_tuning_job_request' when calling FineTuningApi.create_fine_tuning_job"
  end
  # resource path
  local_var_path = '/fine_tuning/jobs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_fine_tuning_job_request)

  # return_type
  return_type = opts[:debug_return_type] || 'FineTuningJob'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"FineTuningApi.create_fine_tuning_job",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FineTuningApi#create_fine_tuning_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_fine_tuning_events(fine_tuning_job_id, opts = {}) ⇒ ListFineTuningJobEventsResponse

Get status updates for a fine-tuning job.

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job to get events for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Identifier for the last event from the previous pagination request.

  • :limit (Integer) —

    Number of events to retrieve. (default to 20)

Returns:



155
156
157
158
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 155

def list_fine_tuning_events(fine_tuning_job_id, opts = {})
  data, _status_code, _headers = list_fine_tuning_events_with_http_info(fine_tuning_job_id, opts)
  data
end

#list_fine_tuning_events_with_http_info(fine_tuning_job_id, opts = {}) ⇒ Array<(ListFineTuningJobEventsResponse, Integer, Hash)>

Get status updates for a fine-tuning job.

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job to get events for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Identifier for the last event from the previous pagination request.

  • :limit (Integer) —

    Number of events to retrieve. (default to 20)

Returns:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 166

def list_fine_tuning_events_with_http_info(fine_tuning_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FineTuningApi.list_fine_tuning_events ...'
  end
  # verify the required parameter 'fine_tuning_job_id' is set
  if @api_client.config.client_side_validation && fine_tuning_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'fine_tuning_job_id' when calling FineTuningApi.list_fine_tuning_events"
  end
  # resource path
  local_var_path = '/fine_tuning/jobs/{fine_tuning_job_id}/events'.sub('{' + 'fine_tuning_job_id' + '}', CGI.escape(fine_tuning_job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListFineTuningJobEventsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"FineTuningApi.list_fine_tuning_events",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FineTuningApi#list_fine_tuning_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_fine_tuning_job_checkpoints(fine_tuning_job_id, opts = {}) ⇒ ListFineTuningJobCheckpointsResponse

List checkpoints for a fine-tuning job.

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job to get checkpoints for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Identifier for the last checkpoint ID from the previous pagination request.

  • :limit (Integer) —

    Number of checkpoints to retrieve. (default to 10)

Returns:



222
223
224
225
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 222

def list_fine_tuning_job_checkpoints(fine_tuning_job_id, opts = {})
  data, _status_code, _headers = list_fine_tuning_job_checkpoints_with_http_info(fine_tuning_job_id, opts)
  data
end

#list_fine_tuning_job_checkpoints_with_http_info(fine_tuning_job_id, opts = {}) ⇒ Array<(ListFineTuningJobCheckpointsResponse, Integer, Hash)>

List checkpoints for a fine-tuning job.

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job to get checkpoints for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Identifier for the last checkpoint ID from the previous pagination request.

  • :limit (Integer) —

    Number of checkpoints to retrieve. (default to 10)

Returns:



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 233

def list_fine_tuning_job_checkpoints_with_http_info(fine_tuning_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FineTuningApi.list_fine_tuning_job_checkpoints ...'
  end
  # verify the required parameter 'fine_tuning_job_id' is set
  if @api_client.config.client_side_validation && fine_tuning_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'fine_tuning_job_id' when calling FineTuningApi.list_fine_tuning_job_checkpoints"
  end
  # resource path
  local_var_path = '/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints'.sub('{' + 'fine_tuning_job_id' + '}', CGI.escape(fine_tuning_job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListFineTuningJobCheckpointsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"FineTuningApi.list_fine_tuning_job_checkpoints",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FineTuningApi#list_fine_tuning_job_checkpoints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_paginated_fine_tuning_jobs(opts = {}) ⇒ ListPaginatedFineTuningJobsResponse

List your organization’s fine-tuning jobs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Identifier for the last job from the previous pagination request.

  • :limit (Integer) —

    Number of fine-tuning jobs to retrieve. (default to 20)

Returns:



288
289
290
291
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 288

def list_paginated_fine_tuning_jobs(opts = {})
  data, _status_code, _headers = list_paginated_fine_tuning_jobs_with_http_info(opts)
  data
end

#list_paginated_fine_tuning_jobs_with_http_info(opts = {}) ⇒ Array<(ListPaginatedFineTuningJobsResponse, Integer, Hash)>

List your organization&#39;s fine-tuning jobs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Identifier for the last job from the previous pagination request.

  • :limit (Integer) —

    Number of fine-tuning jobs to retrieve. (default to 20)

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 298

def list_paginated_fine_tuning_jobs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FineTuningApi.list_paginated_fine_tuning_jobs ...'
  end
  # resource path
  local_var_path = '/fine_tuning/jobs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListPaginatedFineTuningJobsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"FineTuningApi.list_paginated_fine_tuning_jobs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FineTuningApi#list_paginated_fine_tuning_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_fine_tuning_job(fine_tuning_job_id, opts = {}) ⇒ FineTuningJob

Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/fine-tuning)

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



348
349
350
351
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 348

def retrieve_fine_tuning_job(fine_tuning_job_id, opts = {})
  data, _status_code, _headers = retrieve_fine_tuning_job_with_http_info(fine_tuning_job_id, opts)
  data
end

#retrieve_fine_tuning_job_with_http_info(fine_tuning_job_id, opts = {}) ⇒ Array<(FineTuningJob, Integer, Hash)>

Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/fine-tuning)

Parameters:

  • fine_tuning_job_id (String) —

    The ID of the fine-tuning job.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FineTuningJob, Integer, Hash)>) —

    FineTuningJob data, response status code and response headers



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/openapi_openai/api/fine_tuning_api.rb', line 357

def retrieve_fine_tuning_job_with_http_info(fine_tuning_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FineTuningApi.retrieve_fine_tuning_job ...'
  end
  # verify the required parameter 'fine_tuning_job_id' is set
  if @api_client.config.client_side_validation && fine_tuning_job_id.nil?
    fail ArgumentError, "Missing the required parameter 'fine_tuning_job_id' when calling FineTuningApi.retrieve_fine_tuning_job"
  end
  # resource path
  local_var_path = '/fine_tuning/jobs/{fine_tuning_job_id}'.sub('{' + 'fine_tuning_job_id' + '}', CGI.escape(fine_tuning_job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FineTuningJob'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"FineTuningApi.retrieve_fine_tuning_job",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FineTuningApi#retrieve_fine_tuning_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end