litellm_client 1.0.0

data/docs/ChatCompletionsApi.md

@@ -0,0 +1,299 @@
+# LiteLLMClient::ChatCompletionsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**chat_completion_chat_completions_post**](ChatCompletionsApi.md#chat_completion_chat_completions_post) | **POST** /chat/completions | Chat Completion |
+| [**chat_completion_engines_model_chat_completions_post**](ChatCompletionsApi.md#chat_completion_engines_model_chat_completions_post) | **POST** /engines/{model}/chat/completions | Chat Completion |
+| [**chat_completion_openai_deployments_model_chat_completions_post**](ChatCompletionsApi.md#chat_completion_openai_deployments_model_chat_completions_post) | **POST** /openai/deployments/{model}/chat/completions | Chat Completion |
+| [**chat_completion_v1_chat_completions_post**](ChatCompletionsApi.md#chat_completion_v1_chat_completions_post) | **POST** /v1/chat/completions | Chat Completion |
+
+
+## chat_completion_chat_completions_post
+
+> Object chat_completion_chat_completions_post(opts)
+
+Chat Completion
+
+Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`  ```bash curl -X POST http://localhost:4000/v1/chat/completions  -H \"Content-Type: application/json\"  -H \"Authorization: Bearer sk-1234\"  -d '{     \"model\": \"gpt-4o\",     \"messages\": [         {             \"role\": \"user\",             \"content\": \"Hello!\"         }     ] }' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::ChatCompletionsApi.new
+opts = {
+  model: 'model_example' # String | 
+}
+
+begin
+  # Chat Completion
+  result = api_instance.chat_completion_chat_completions_post(opts)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_chat_completions_post: #{e}"
+end
+```
+
+#### Using the chat_completion_chat_completions_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> chat_completion_chat_completions_post_with_http_info(opts)
+
+```ruby
+begin
+  # Chat Completion
+  data, status_code, headers = api_instance.chat_completion_chat_completions_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_chat_completions_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | **String** |  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## chat_completion_engines_model_chat_completions_post
+
+> Object chat_completion_engines_model_chat_completions_post(model)
+
+Chat Completion
+
+Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`  ```bash curl -X POST http://localhost:4000/v1/chat/completions  -H \"Content-Type: application/json\"  -H \"Authorization: Bearer sk-1234\"  -d '{     \"model\": \"gpt-4o\",     \"messages\": [         {             \"role\": \"user\",             \"content\": \"Hello!\"         }     ] }' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::ChatCompletionsApi.new
+model = 'model_example' # String | 
+
+begin
+  # Chat Completion
+  result = api_instance.chat_completion_engines_model_chat_completions_post(model)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_engines_model_chat_completions_post: #{e}"
+end
+```
+
+#### Using the chat_completion_engines_model_chat_completions_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> chat_completion_engines_model_chat_completions_post_with_http_info(model)
+
+```ruby
+begin
+  # Chat Completion
+  data, status_code, headers = api_instance.chat_completion_engines_model_chat_completions_post_with_http_info(model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_engines_model_chat_completions_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## chat_completion_openai_deployments_model_chat_completions_post
+
+> Object chat_completion_openai_deployments_model_chat_completions_post(model)
+
+Chat Completion
+
+Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`  ```bash curl -X POST http://localhost:4000/v1/chat/completions  -H \"Content-Type: application/json\"  -H \"Authorization: Bearer sk-1234\"  -d '{     \"model\": \"gpt-4o\",     \"messages\": [         {             \"role\": \"user\",             \"content\": \"Hello!\"         }     ] }' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::ChatCompletionsApi.new
+model = 'model_example' # String | 
+
+begin
+  # Chat Completion
+  result = api_instance.chat_completion_openai_deployments_model_chat_completions_post(model)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_openai_deployments_model_chat_completions_post: #{e}"
+end
+```
+
+#### Using the chat_completion_openai_deployments_model_chat_completions_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> chat_completion_openai_deployments_model_chat_completions_post_with_http_info(model)
+
+```ruby
+begin
+  # Chat Completion
+  data, status_code, headers = api_instance.chat_completion_openai_deployments_model_chat_completions_post_with_http_info(model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_openai_deployments_model_chat_completions_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## chat_completion_v1_chat_completions_post
+
+> Object chat_completion_v1_chat_completions_post(opts)
+
+Chat Completion
+
+Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`  ```bash curl -X POST http://localhost:4000/v1/chat/completions  -H \"Content-Type: application/json\"  -H \"Authorization: Bearer sk-1234\"  -d '{     \"model\": \"gpt-4o\",     \"messages\": [         {             \"role\": \"user\",             \"content\": \"Hello!\"         }     ] }' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::ChatCompletionsApi.new
+opts = {
+  model: 'model_example' # String | 
+}
+
+begin
+  # Chat Completion
+  result = api_instance.chat_completion_v1_chat_completions_post(opts)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_v1_chat_completions_post: #{e}"
+end
+```
+
+#### Using the chat_completion_v1_chat_completions_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> chat_completion_v1_chat_completions_post_with_http_info(opts)
+
+```ruby
+begin
+  # Chat Completion
+  data, status_code, headers = api_instance.chat_completion_v1_chat_completions_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling ChatCompletionsApi->chat_completion_v1_chat_completions_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model** | **String** |  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ChoiceLogprobs.md

@@ -0,0 +1,18 @@
+# LiteLLMClient::ChoiceLogprobs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | [**Content**](Content.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChoiceLogprobs.new(
+  content: null
+)
+```
+

data/docs/Choices.md

@@ -0,0 +1,26 @@
+# LiteLLMClient::Choices
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **finish_reason** | **String** |  |  |
+| **index** | **Integer** |  |  |
+| **message** | [**Message**](Message.md) |  |  |
+| **logprobs** | [**Logprobs**](Logprobs.md) |  | [optional] |
+| **provider_specific_fields** | [**ProviderSpecificFields**](ProviderSpecificFields.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::Choices.new(
+  finish_reason: null,
+  index: null,
+  message: null,
+  logprobs: null,
+  provider_specific_fields: null
+)
+```
+

data/docs/Choices1Inner.md

@@ -0,0 +1,26 @@
+# LiteLLMClient::Choices1Inner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **finish_reason** | **String** |  |  |
+| **index** | **Integer** |  |  |
+| **message** | [**Message**](Message.md) |  |  |
+| **logprobs** | [**Logprobs**](Logprobs.md) |  | [optional] |
+| **provider_specific_fields** | [**ProviderSpecificFields**](ProviderSpecificFields.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::Choices1Inner.new(
+  finish_reason: null,
+  index: null,
+  message: null,
+  logprobs: null,
+  provider_specific_fields: null
+)
+```
+