Method: OpenApiOpenAIClient::FilesApi#create_file_with_http_info

Defined in:
lib/openapi_openai/api/files_api.rb

#create_file_with_http_info(file, purpose, opts = {}) ⇒ Array<(OpenAIFile, Integer, Hash)>

Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB. The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See the [Assistants Tools guide](/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports &#x60;.jsonl&#x60; files. Please [contact us](help.openai.com/) if you need to increase these storage limits.

Parameters:

  • file (File) —

    The File object (not file name) to be uploaded.

  • purpose (String) —

    The intended purpose of the uploaded file. Use \&quot;fine-tune\&quot; for [Fine-tuning](/docs/api-reference/fine-tuning) and \&quot;assistants\&quot; for [Assistants](/docs/api-reference/assistants) and [Messages](/docs/api-reference/messages). This allows us to validate the format of the uploaded file is correct for fine-tuning.

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

    the optional parameters

Returns:

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

    OpenAIFile data, response status code and response headers



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

def create_file_with_http_info(file, purpose, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.create_file ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling FilesApi.create_file"
  end
  # verify the required parameter 'purpose' is set
  if @api_client.config.client_side_validation && purpose.nil?
    fail ArgumentError, "Missing the required parameter 'purpose' when calling FilesApi.create_file"
  end
  # verify enum value
  allowable_values = ["fine-tune", "assistants"]
  if @api_client.config.client_side_validation && !allowable_values.include?(purpose)
    fail ArgumentError, "invalid value for \"purpose\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/files'

  # 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(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"FilesApi.create_file",
    :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: FilesApi#create_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end