Class: LiteLLMClient::EmbeddingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/api/embeddings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmbeddingsApi

Returns a new instance of EmbeddingsApi.



19
20
21
 
# File 'lib/litellm_client/api/embeddings_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/litellm_client/api/embeddings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#embeddings_embeddings_post(opts = {}) ⇒ Object

Embeddings Follows the exact same API spec as ‘OpenAI’s Embeddings API platform.openai.com/docs/api-reference/embeddings` “‘bash curl -X POST localhost:4000/v1/embeddings -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d ’{ "model": "text-embedding-ada-002", "input": "The quick brown fox jumps over the lazy dog" }‘ “`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :model (String)

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 27

def embeddings_embeddings_post(opts = {})
  data, _status_code, _headers = embeddings_embeddings_post_with_http_info(opts)
  data
end

#embeddings_embeddings_post_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Embeddings Follows the exact same API spec as &#x60;OpenAI&#39;s Embeddings API platform.openai.com/docs/api-reference/embeddings&#x60; &#x60;&#x60;&#x60;bash curl -X POST localhost:4000/v1/embeddings -H &quot;Content-Type: application/json&quot; -H &quot;Authorization: Bearer sk-1234&quot; -d &#39;{ &quot;model&quot;: &quot;text-embedding-ada-002&quot;, &quot;input&quot;: &quot;The quick brown fox jumps over the lazy dog&quot; }&#39; &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :model (String)

Returns:

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

    Object 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
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 37

def embeddings_embeddings_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmbeddingsApi.embeddings_embeddings_post ...'
  end
  # resource path
  local_var_path = '/embeddings'

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

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

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

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

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

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

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

#embeddings_engines_model_embeddings_post(model, opts = {}) ⇒ Object

Embeddings Follows the exact same API spec as ‘OpenAI’s Embeddings API platform.openai.com/docs/api-reference/embeddings` “‘bash curl -X POST localhost:4000/v1/embeddings -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d ’{ "model": "text-embedding-ada-002", "input": "The quick brown fox jumps over the lazy dog" }‘ “`

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


87
88
89
90
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 87

def embeddings_engines_model_embeddings_post(model, opts = {})
  data, _status_code, _headers = embeddings_engines_model_embeddings_post_with_http_info(model, opts)
  data
end

#embeddings_engines_model_embeddings_post_with_http_info(model, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Embeddings Follows the exact same API spec as &#x60;OpenAI&#39;s Embeddings API platform.openai.com/docs/api-reference/embeddings&#x60; &#x60;&#x60;&#x60;bash curl -X POST localhost:4000/v1/embeddings -H &quot;Content-Type: application/json&quot; -H &quot;Authorization: Bearer sk-1234&quot; -d &#39;{ &quot;model&quot;: &quot;text-embedding-ada-002&quot;, &quot;input&quot;: &quot;The quick brown fox jumps over the lazy dog&quot; }&#39; &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 97

def embeddings_engines_model_embeddings_post_with_http_info(model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmbeddingsApi.embeddings_engines_model_embeddings_post ...'
  end
  # resource path
  local_var_path = '/engines/{model}/embeddings'.sub('{' + 'model' + '}', CGI.escape(model.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']) unless header_params['Accept']

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

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

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

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

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

#embeddings_openai_deployments_model_embeddings_post(model, opts = {}) ⇒ Object

Embeddings Follows the exact same API spec as ‘OpenAI’s Embeddings API platform.openai.com/docs/api-reference/embeddings` “‘bash curl -X POST localhost:4000/v1/embeddings -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d ’{ "model": "text-embedding-ada-002", "input": "The quick brown fox jumps over the lazy dog" }‘ “`

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


146
147
148
149
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 146

def embeddings_openai_deployments_model_embeddings_post(model, opts = {})
  data, _status_code, _headers = embeddings_openai_deployments_model_embeddings_post_with_http_info(model, opts)
  data
end

#embeddings_openai_deployments_model_embeddings_post_with_http_info(model, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Embeddings Follows the exact same API spec as &#x60;OpenAI&#39;s Embeddings API platform.openai.com/docs/api-reference/embeddings&#x60; &#x60;&#x60;&#x60;bash curl -X POST localhost:4000/v1/embeddings -H &quot;Content-Type: application/json&quot; -H &quot;Authorization: Bearer sk-1234&quot; -d &#39;{ &quot;model&quot;: &quot;text-embedding-ada-002&quot;, &quot;input&quot;: &quot;The quick brown fox jumps over the lazy dog&quot; }&#39; &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



156
157
158
159
160
161
162
163
164
165
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
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 156

def embeddings_openai_deployments_model_embeddings_post_with_http_info(model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmbeddingsApi.embeddings_openai_deployments_model_embeddings_post ...'
  end
  # resource path
  local_var_path = '/openai/deployments/{model}/embeddings'.sub('{' + 'model' + '}', CGI.escape(model.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']) unless header_params['Accept']

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

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

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

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

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

#embeddings_v1_embeddings_post(opts = {}) ⇒ Object

Embeddings Follows the exact same API spec as ‘OpenAI’s Embeddings API platform.openai.com/docs/api-reference/embeddings` “‘bash curl -X POST localhost:4000/v1/embeddings -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d ’{ "model": "text-embedding-ada-002", "input": "The quick brown fox jumps over the lazy dog" }‘ “`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :model (String)

Returns:

  • (Object) 


205
206
207
208
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 205

def embeddings_v1_embeddings_post(opts = {})
  data, _status_code, _headers = embeddings_v1_embeddings_post_with_http_info(opts)
  data
end

#embeddings_v1_embeddings_post_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Embeddings Follows the exact same API spec as &#x60;OpenAI&#39;s Embeddings API platform.openai.com/docs/api-reference/embeddings&#x60; &#x60;&#x60;&#x60;bash curl -X POST localhost:4000/v1/embeddings -H &quot;Content-Type: application/json&quot; -H &quot;Authorization: Bearer sk-1234&quot; -d &#39;{ &quot;model&quot;: &quot;text-embedding-ada-002&quot;, &quot;input&quot;: &quot;The quick brown fox jumps over the lazy dog&quot; }&#39; &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :model (String)

Returns:

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

    Object data, response status code and response headers



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
258
 
# File 'lib/litellm_client/api/embeddings_api.rb', line 215

def embeddings_v1_embeddings_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmbeddingsApi.embeddings_v1_embeddings_post ...'
  end
  # resource path
  local_var_path = '/v1/embeddings'

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

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

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

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

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

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

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