Class: AzureOpenaiClient::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/azure_openai_client/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/azure_openai_client/api/default_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/azure_openai_client/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#chat_completions_create(deployment_id, api_version, chat_completions_create_request, opts = {}) ⇒ ChatCompletionsCreate200Response

Creates a completion for the chat message

Parameters:

  • deployment_id (String)
  • api_version (String)
  • chat_completions_create_request (ChatCompletionsCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/azure_openai_client/api/default_api.rb', line 28

def chat_completions_create(deployment_id, api_version, chat_completions_create_request, opts = {})
  data, _status_code, _headers = chat_completions_create_with_http_info(deployment_id, api_version, chat_completions_create_request, opts)
  data
end

#chat_completions_create_with_http_info(deployment_id, api_version, chat_completions_create_request, opts = {}) ⇒ Array<(ChatCompletionsCreate200Response, Integer, Hash)>

Creates a completion for the chat message

Parameters:

  • deployment_id (String)
  • api_version (String)
  • chat_completions_create_request (ChatCompletionsCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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/azure_openai_client/api/default_api.rb', line 39

def chat_completions_create_with_http_info(deployment_id, api_version, chat_completions_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.chat_completions_create ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DefaultApi.chat_completions_create"
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling DefaultApi.chat_completions_create"
  end
  # verify the required parameter 'chat_completions_create_request' is set
  if @api_client.config.client_side_validation && chat_completions_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'chat_completions_create_request' when calling DefaultApi.chat_completions_create"
  end
  # resource path
  local_var_path = '/deployments/{deployment-id}/chat/completions'.sub('{' + 'deployment-id' + '}', CGI.escape(deployment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'api-version'] = api_version

  # 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(chat_completions_create_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'bearer']

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

#completions_create(deployment_id, api_version, completions_create_request, opts = {}) ⇒ CompletionsCreate200Response

Creates a completion for the provided prompt, parameters and chosen model.

Parameters:

  • deployment_id (String)
  • api_version (String)
  • completions_create_request (CompletionsCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



107
108
109
110
 
# File 'lib/azure_openai_client/api/default_api.rb', line 107

def completions_create(deployment_id, api_version, completions_create_request, opts = {})
  data, _status_code, _headers = completions_create_with_http_info(deployment_id, api_version, completions_create_request, opts)
  data
end

#completions_create_with_http_info(deployment_id, api_version, completions_create_request, opts = {}) ⇒ Array<(CompletionsCreate200Response, Integer, Hash)>

Creates a completion for the provided prompt, parameters and chosen model.

Parameters:

  • deployment_id (String)
  • api_version (String)
  • completions_create_request (CompletionsCreateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
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
175
176
177
178
 
# File 'lib/azure_openai_client/api/default_api.rb', line 118

def completions_create_with_http_info(deployment_id, api_version, completions_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.completions_create ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DefaultApi.completions_create"
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling DefaultApi.completions_create"
  end
  # verify the required parameter 'completions_create_request' is set
  if @api_client.config.client_side_validation && completions_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'completions_create_request' when calling DefaultApi.completions_create"
  end
  # resource path
  local_var_path = '/deployments/{deployment-id}/completions'.sub('{' + 'deployment-id' + '}', CGI.escape(deployment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'api-version'] = api_version

  # 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(completions_create_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'bearer']

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

#embeddings_create(deployment_id, api_version, request_body, opts = {}) ⇒ EmbeddingsCreate200Response

Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.

Parameters:

  • deployment_id (String) —

    The deployment id of the model which was deployed.

  • api_version (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



186
187
188
189
 
# File 'lib/azure_openai_client/api/default_api.rb', line 186

def embeddings_create(deployment_id, api_version, request_body, opts = {})
  data, _status_code, _headers = embeddings_create_with_http_info(deployment_id, api_version, request_body, opts)
  data
end

#embeddings_create_with_http_info(deployment_id, api_version, request_body, opts = {}) ⇒ Array<(EmbeddingsCreate200Response, Integer, Hash)>

Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.

Parameters:

  • deployment_id (String) —

    The deployment id of the model which was deployed.

  • api_version (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    EmbeddingsCreate200Response data, response status code and response headers



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
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
 
# File 'lib/azure_openai_client/api/default_api.rb', line 197

def embeddings_create_with_http_info(deployment_id, api_version, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.embeddings_create ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DefaultApi.embeddings_create"
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling DefaultApi.embeddings_create"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling DefaultApi.embeddings_create"
  end
  # resource path
  local_var_path = '/deployments/{deployment-id}/embeddings'.sub('{' + 'deployment-id' + '}', CGI.escape(deployment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'api-version'] = api_version

  # 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(request_body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'bearer']

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