litellm_client 1.0.0

data/docs/Bytes.md

@@ -0,0 +1,15 @@
+# LiteLLMClient::Bytes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::Bytes.new()
+```
+

data/docs/CacheControl.md

@@ -0,0 +1,18 @@
+# LiteLLMClient::CacheControl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::CacheControl.new(
+  type: null
+)
+```
+

data/docs/CachePingResponse.md

@@ -0,0 +1,28 @@
+# LiteLLMClient::CachePingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **cache_type** | **String** |  |  |
+| **ping_response** | **Boolean** |  | [optional] |
+| **set_cache_response** | **String** |  | [optional] |
+| **litellm_cache_params** | **String** |  | [optional] |
+| **health_check_cache_params** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::CachePingResponse.new(
+  status: null,
+  cache_type: null,
+  ping_response: null,
+  set_cache_response: null,
+  litellm_cache_params: null,
+  health_check_cache_params: null
+)
+```
+

data/docs/CachingApi.md

@@ -0,0 +1,421 @@
+# LiteLLMClient::CachingApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cache_delete_cache_delete_post**](CachingApi.md#cache_delete_cache_delete_post) | **POST** /cache/delete | Cache Delete |
+| [**cache_delete_cache_delete_post_0**](CachingApi.md#cache_delete_cache_delete_post_0) | **POST** /cache/delete | Cache Delete |
+| [**cache_flushall_cache_flushall_post**](CachingApi.md#cache_flushall_cache_flushall_post) | **POST** /cache/flushall | Cache Flushall |
+| [**cache_flushall_cache_flushall_post_0**](CachingApi.md#cache_flushall_cache_flushall_post_0) | **POST** /cache/flushall | Cache Flushall |
+| [**cache_ping_cache_ping_get**](CachingApi.md#cache_ping_cache_ping_get) | **GET** /cache/ping | Cache Ping |
+| [**cache_redis_info_cache_redis_info_get**](CachingApi.md#cache_redis_info_cache_redis_info_get) | **GET** /cache/redis/info | Cache Redis Info |
+
+
+## cache_delete_cache_delete_post
+
+> Object cache_delete_cache_delete_post
+
+Cache Delete
+
+Endpoint for deleting a key from the cache. All responses from litellm proxy have `x-litellm-cache-key` in the headers  Parameters: - **keys**: *Optional[List[str]]* - A list of keys to delete from the cache. Example {\"keys\": [\"key1\", \"key2\"]}  ```shell curl -X POST \"http://0.0.0.0:4000/cache/delete\"     -H \"Authorization: Bearer sk-1234\"     -d '{\"keys\": [\"key1\", \"key2\"]}' ```
+
+### 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::CachingApi.new
+
+begin
+  # Cache Delete
+  result = api_instance.cache_delete_cache_delete_post
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_delete_cache_delete_post: #{e}"
+end
+```
+
+#### Using the cache_delete_cache_delete_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> cache_delete_cache_delete_post_with_http_info
+
+```ruby
+begin
+  # Cache Delete
+  data, status_code, headers = api_instance.cache_delete_cache_delete_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_delete_cache_delete_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cache_delete_cache_delete_post_0
+
+> Object cache_delete_cache_delete_post_0
+
+Cache Delete
+
+Endpoint for deleting a key from the cache. All responses from litellm proxy have `x-litellm-cache-key` in the headers  Parameters: - **keys**: *Optional[List[str]]* - A list of keys to delete from the cache. Example {\"keys\": [\"key1\", \"key2\"]}  ```shell curl -X POST \"http://0.0.0.0:4000/cache/delete\"     -H \"Authorization: Bearer sk-1234\"     -d '{\"keys\": [\"key1\", \"key2\"]}' ```
+
+### 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::CachingApi.new
+
+begin
+  # Cache Delete
+  result = api_instance.cache_delete_cache_delete_post_0
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_delete_cache_delete_post_0: #{e}"
+end
+```
+
+#### Using the cache_delete_cache_delete_post_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> cache_delete_cache_delete_post_0_with_http_info
+
+```ruby
+begin
+  # Cache Delete
+  data, status_code, headers = api_instance.cache_delete_cache_delete_post_0_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_delete_cache_delete_post_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cache_flushall_cache_flushall_post
+
+> Object cache_flushall_cache_flushall_post
+
+Cache Flushall
+
+A function to flush all items from the cache. (All items will be deleted from the cache with this) Raises HTTPException if the cache is not initialized or if the cache type does not support flushing. Returns a dictionary with the status of the operation.  Usage: ``` curl -X POST http://0.0.0.0:4000/cache/flushall -H \"Authorization: Bearer sk-1234\" ```
+
+### 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::CachingApi.new
+
+begin
+  # Cache Flushall
+  result = api_instance.cache_flushall_cache_flushall_post
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_flushall_cache_flushall_post: #{e}"
+end
+```
+
+#### Using the cache_flushall_cache_flushall_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> cache_flushall_cache_flushall_post_with_http_info
+
+```ruby
+begin
+  # Cache Flushall
+  data, status_code, headers = api_instance.cache_flushall_cache_flushall_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_flushall_cache_flushall_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cache_flushall_cache_flushall_post_0
+
+> Object cache_flushall_cache_flushall_post_0
+
+Cache Flushall
+
+A function to flush all items from the cache. (All items will be deleted from the cache with this) Raises HTTPException if the cache is not initialized or if the cache type does not support flushing. Returns a dictionary with the status of the operation.  Usage: ``` curl -X POST http://0.0.0.0:4000/cache/flushall -H \"Authorization: Bearer sk-1234\" ```
+
+### 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::CachingApi.new
+
+begin
+  # Cache Flushall
+  result = api_instance.cache_flushall_cache_flushall_post_0
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_flushall_cache_flushall_post_0: #{e}"
+end
+```
+
+#### Using the cache_flushall_cache_flushall_post_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> cache_flushall_cache_flushall_post_0_with_http_info
+
+```ruby
+begin
+  # Cache Flushall
+  data, status_code, headers = api_instance.cache_flushall_cache_flushall_post_0_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_flushall_cache_flushall_post_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cache_ping_cache_ping_get
+
+> <CachePingResponse> cache_ping_cache_ping_get
+
+Cache Ping
+
+Endpoint for checking if cache can be pinged
+
+### 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::CachingApi.new
+
+begin
+  # Cache Ping
+  result = api_instance.cache_ping_cache_ping_get
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_ping_cache_ping_get: #{e}"
+end
+```
+
+#### Using the cache_ping_cache_ping_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CachePingResponse>, Integer, Hash)> cache_ping_cache_ping_get_with_http_info
+
+```ruby
+begin
+  # Cache Ping
+  data, status_code, headers = api_instance.cache_ping_cache_ping_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CachePingResponse>
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_ping_cache_ping_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CachePingResponse**](CachePingResponse.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cache_redis_info_cache_redis_info_get
+
+> Object cache_redis_info_cache_redis_info_get
+
+Cache Redis Info
+
+Endpoint for getting /redis/info
+
+### 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::CachingApi.new
+
+begin
+  # Cache Redis Info
+  result = api_instance.cache_redis_info_cache_redis_info_get
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_redis_info_cache_redis_info_get: #{e}"
+end
+```
+
+#### Using the cache_redis_info_cache_redis_info_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> cache_redis_info_cache_redis_info_get_with_http_info
+
+```ruby
+begin
+  # Cache Redis Info
+  data, status_code, headers = api_instance.cache_redis_info_cache_redis_info_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CachingApi->cache_redis_info_cache_redis_info_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CallTypes.md

@@ -0,0 +1,15 @@
+# LiteLLMClient::CallTypes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::CallTypes.new()
+```
+

data/docs/ChatCompletionAnnotation.md

@@ -0,0 +1,20 @@
+# LiteLLMClient::ChatCompletionAnnotation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **url_citation** | [**ChatCompletionAnnotationURLCitation**](ChatCompletionAnnotationURLCitation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChatCompletionAnnotation.new(
+  type: null,
+  url_citation: null
+)
+```
+

data/docs/ChatCompletionAnnotationURLCitation.md

@@ -0,0 +1,24 @@
+# LiteLLMClient::ChatCompletionAnnotationURLCitation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_index** | **Integer** |  | [optional] |
+| **start_index** | **Integer** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChatCompletionAnnotationURLCitation.new(
+  end_index: null,
+  start_index: null,
+  title: null,
+  url: null
+)
+```
+

data/docs/ChatCompletionAudioResponse.md

@@ -0,0 +1,24 @@
+# LiteLLMClient::ChatCompletionAudioResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **data** | **String** |  |  |
+| **expires_at** | **Integer** |  |  |
+| **transcript** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChatCompletionAudioResponse.new(
+  id: null,
+  data: null,
+  expires_at: null,
+  transcript: null
+)
+```
+

data/docs/ChatCompletionCachedContent.md

@@ -0,0 +1,18 @@
+# LiteLLMClient::ChatCompletionCachedContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChatCompletionCachedContent.new(
+  type: null
+)
+```
+

data/docs/ChatCompletionRedactedThinkingBlock.md

@@ -0,0 +1,22 @@
+# LiteLLMClient::ChatCompletionRedactedThinkingBlock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **data** | **String** |  | [optional] |
+| **cache_control** | [**CacheControl**](CacheControl.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChatCompletionRedactedThinkingBlock.new(
+  type: null,
+  data: null,
+  cache_control: null
+)
+```
+

data/docs/ChatCompletionThinkingBlock.md

@@ -0,0 +1,24 @@
+# LiteLLMClient::ChatCompletionThinkingBlock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **thinking** | **String** |  | [optional] |
+| **signature** | **String** |  | [optional] |
+| **cache_control** | [**CacheControl**](CacheControl.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChatCompletionThinkingBlock.new(
+  type: null,
+  thinking: null,
+  signature: null,
+  cache_control: null
+)
+```
+

data/docs/ChatCompletionTokenLogprob.md

@@ -0,0 +1,24 @@
+# LiteLLMClient::ChatCompletionTokenLogprob
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  |  |
+| **bytes** | [**Bytes**](Bytes.md) |  | [optional] |
+| **logprob** | **Float** |  |  |
+| **top_logprobs** | [**Array<TopLogprob>**](TopLogprob.md) |  |  |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::ChatCompletionTokenLogprob.new(
+  token: null,
+  bytes: null,
+  logprob: null,
+  top_logprobs: null
+)
+```
+