venice_client 1.0.20 → 1.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +15 -1
- data/docs/AudioModelPricingInput.md +0 -2
- data/docs/CacheControl.md +20 -0
- data/docs/ChatApi.md +1 -1
- data/docs/ChatCompletionRequest.md +7 -1
- data/docs/ChatCompletionRequestReasoning.md +18 -0
- data/docs/ChatCompletionRequestVeniceParameters.md +3 -1
- data/docs/CompleteVideo200Response.md +18 -0
- data/docs/CompleteVideoRequest.md +20 -0
- data/docs/CreateChatCompletion200Response.md +1 -1
- data/docs/CreateChatCompletion200ResponseVeniceParameters.md +2 -0
- data/docs/GenerateImageRequest.md +9 -3
- data/docs/GetApiKeyRateLimitLogs200ResponseDataInner.md +1 -1
- data/docs/GetApiKeyRateLimits200Response.md +0 -2
- data/docs/GetApiKeyRateLimits200ResponseDataBalances.md +0 -2
- data/docs/GetApiKeyRateLimits200ResponseDataRateLimitsInner.md +1 -1
- data/docs/ImageApi.md +1 -1
- data/docs/ImageModelPricingGeneration.md +0 -2
- data/docs/ImageModelPricingUpscale2x.md +0 -2
- data/docs/ImageModelPricingUpscale4x.md +0 -2
- data/docs/ImageUrl.md +2 -0
- data/docs/LLMModelPricingInput.md +0 -2
- data/docs/LLMModelPricingOutput.md +0 -2
- data/docs/ModelResponseModelSpec.md +2 -0
- data/docs/ModelResponseModelSpecConstraints.md +13 -1
- data/docs/ModelsApi.md +2 -2
- data/docs/QueueVideo200Response.md +20 -0
- data/docs/QueueVideoRequest.md +32 -0
- data/docs/QuoteVideo200Response.md +18 -0
- data/docs/RetrieveVideo200Response.md +22 -0
- data/docs/RetrieveVideoRequest.md +22 -0
- data/docs/SimpleGenerateImageRequest.md +1 -1
- data/docs/Text.md +2 -0
- data/docs/VideoApi.md +295 -0
- data/docs/VideoModelConstraints.md +28 -0
- data/lib/venice_client/api/api_keys_api.rb +1 -1
- data/lib/venice_client/api/audio_api.rb +1 -1
- data/lib/venice_client/api/billing_api.rb +1 -1
- data/lib/venice_client/api/characters_api.rb +1 -1
- data/lib/venice_client/api/chat_api.rb +1 -1
- data/lib/venice_client/api/embeddings_api.rb +1 -1
- data/lib/venice_client/api/image_api.rb +1 -1
- data/lib/venice_client/api/models_api.rb +3 -3
- data/lib/venice_client/api/preview_api.rb +1 -1
- data/lib/venice_client/api/speech_api.rb +1 -1
- data/lib/venice_client/api/video_api.rb +278 -0
- data/lib/venice_client/api_client.rb +1 -1
- data/lib/venice_client/api_error.rb +1 -1
- data/lib/venice_client/configuration.rb +1 -1
- data/lib/venice_client/models/assistant_message.rb +8 -8
- data/lib/venice_client/models/assistant_message_content.rb +1 -1
- data/lib/venice_client/models/audio_model_pricing.rb +1 -1
- data/lib/venice_client/models/audio_model_pricing_input.rb +2 -29
- data/lib/venice_client/models/billing_usage_request.rb +1 -1
- data/lib/venice_client/models/billing_usage_response.rb +1 -1
- data/lib/venice_client/models/cache_control.rb +273 -0
- data/lib/venice_client/models/chat_completion_request.rb +65 -2
- data/lib/venice_client/models/chat_completion_request_messages_inner.rb +2 -2
- data/lib/venice_client/models/chat_completion_request_reasoning.rb +256 -0
- data/lib/venice_client/models/chat_completion_request_response_format.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_stop.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_stream_options.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_tool_choice.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_tool_choice_any_of.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_tool_choice_any_of_function.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_venice_parameters.rb +15 -3
- data/lib/venice_client/models/complete_video200_response.rb +238 -0
- data/lib/venice_client/models/complete_video_request.rb +265 -0
- data/lib/venice_client/models/create_api_key200_response.rb +1 -1
- data/lib/venice_client/models/create_api_key200_response_data.rb +1 -1
- data/lib/venice_client/models/create_api_key_request.rb +1 -1
- data/lib/venice_client/models/create_api_key_request_expires_at.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response.rb +11 -19
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner.rb +7 -7
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs_top_logprobs_inner.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner_message.rb +2 -2
- data/lib/venice_client/models/create_chat_completion200_response_usage.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb +29 -2
- data/lib/venice_client/models/create_chat_completion200_response_venice_parameters_web_search_citations_inner.rb +1 -1
- data/lib/venice_client/models/create_embedding200_response.rb +1 -1
- data/lib/venice_client/models/create_embedding200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/create_embedding200_response_usage.rb +1 -1
- data/lib/venice_client/models/create_embedding_request_schema.rb +1 -1
- data/lib/venice_client/models/create_embedding_request_schema_input.rb +1 -1
- data/lib/venice_client/models/create_embedding_request_schema_model.rb +1 -1
- data/lib/venice_client/models/create_speech_request_schema.rb +1 -1
- data/lib/venice_client/models/delete_api_key200_response.rb +1 -1
- data/lib/venice_client/models/detailed_error.rb +1 -1
- data/lib/venice_client/models/edit_image_request.rb +1 -1
- data/lib/venice_client/models/edit_image_request_image.rb +1 -1
- data/lib/venice_client/models/generate_image200_response.rb +1 -1
- data/lib/venice_client/models/generate_image200_response_timing.rb +1 -1
- data/lib/venice_client/models/generate_image_request.rb +44 -42
- data/lib/venice_client/models/get_api_key_by_id200_response.rb +1 -1
- data/lib/venice_client/models/get_api_key_by_id200_response_data.rb +1 -1
- data/lib/venice_client/models/get_api_key_generate_web3_key200_response.rb +1 -1
- data/lib/venice_client/models/get_api_key_generate_web3_key200_response_data.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limit_logs200_response.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limit_logs200_response_data_inner.rb +2 -2
- data/lib/venice_client/models/get_api_key_rate_limits200_response.rb +2 -12
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_api_tier.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_balances.rb +2 -12
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner_rate_limits_inner.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner_consumption_limits.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner_usage.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner_usage_trailing_seven_days.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response_data_inner_inference_details.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response_pagination.rb +1 -1
- data/lib/venice_client/models/get_character_by_slug200_response.rb +1 -1
- data/lib/venice_client/models/image_model_constraints.rb +1 -1
- data/lib/venice_client/models/image_model_constraints_steps.rb +1 -1
- data/lib/venice_client/models/image_model_pricing.rb +1 -1
- data/lib/venice_client/models/image_model_pricing_generation.rb +2 -29
- data/lib/venice_client/models/image_model_pricing_upscale.rb +1 -1
- data/lib/venice_client/models/image_model_pricing_upscale2x.rb +2 -29
- data/lib/venice_client/models/image_model_pricing_upscale4x.rb +2 -29
- data/lib/venice_client/models/image_styles_get200_response.rb +1 -1
- data/lib/venice_client/models/image_url.rb +12 -3
- data/lib/venice_client/models/image_url_object.rb +1 -1
- data/lib/venice_client/models/json_object.rb +1 -1
- data/lib/venice_client/models/json_schema.rb +1 -1
- data/lib/venice_client/models/list_characters200_response.rb +1 -1
- data/lib/venice_client/models/list_characters200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/list_characters200_response_data_inner_stats.rb +1 -1
- data/lib/venice_client/models/list_model_compatibility_mapping200_response.rb +1 -1
- data/lib/venice_client/models/list_model_traits200_response.rb +1 -1
- data/lib/venice_client/models/list_models200_response.rb +1 -1
- data/lib/venice_client/models/list_models200_response_type.rb +1 -1
- data/lib/venice_client/models/list_models_type_parameter.rb +1 -1
- data/lib/venice_client/models/llm_model_pricing.rb +1 -1
- data/lib/venice_client/models/llm_model_pricing_input.rb +2 -29
- data/lib/venice_client/models/llm_model_pricing_output.rb +2 -29
- data/lib/venice_client/models/model_response.rb +3 -3
- data/lib/venice_client/models/model_response_model_spec.rb +46 -2
- data/lib/venice_client/models/model_response_model_spec_capabilities.rb +3 -3
- data/lib/venice_client/models/model_response_model_spec_constraints.rb +3 -2
- data/lib/venice_client/models/model_response_model_spec_pricing.rb +1 -1
- data/lib/venice_client/models/objects_inner.rb +1 -1
- data/lib/venice_client/models/post_api_key_generate_web3_key_request.rb +1 -1
- data/lib/venice_client/models/queue_video200_response.rb +265 -0
- data/lib/venice_client/models/queue_video_request.rb +438 -0
- data/lib/venice_client/models/quote_video200_response.rb +237 -0
- data/lib/venice_client/models/retrieve_video200_response.rb +316 -0
- data/lib/venice_client/models/retrieve_video_request.rb +277 -0
- data/lib/venice_client/models/simple_generate_image200_response.rb +1 -1
- data/lib/venice_client/models/simple_generate_image200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of.rb +1 -1
- data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of1.rb +1 -1
- data/lib/venice_client/models/simple_generate_image_request.rb +1 -1
- data/lib/venice_client/models/standard_error.rb +1 -1
- data/lib/venice_client/models/system_message.rb +8 -8
- data/lib/venice_client/models/system_message_content.rb +1 -1
- data/lib/venice_client/models/text.rb +12 -3
- data/lib/venice_client/models/text_model_constraints.rb +1 -1
- data/lib/venice_client/models/text_model_constraints_temperature.rb +1 -1
- data/lib/venice_client/models/text_model_constraints_top_p.rb +1 -1
- data/lib/venice_client/models/tool_call.rb +1 -1
- data/lib/venice_client/models/tool_call_function.rb +1 -1
- data/lib/venice_client/models/tool_message.rb +8 -8
- data/lib/venice_client/models/upscale_image_request.rb +1 -1
- data/lib/venice_client/models/upscale_image_request_enhance.rb +1 -1
- data/lib/venice_client/models/user_message.rb +8 -8
- data/lib/venice_client/models/user_message_content.rb +1 -1
- data/lib/venice_client/models/video_model_constraints.rb +404 -0
- data/lib/venice_client/version.rb +2 -2
- data/lib/venice_client.rb +12 -1
- data/spec/api/video_api_spec.rb +83 -0
- data/spec/models/cache_control_spec.rb +46 -0
- data/spec/models/chat_completion_request_reasoning_spec.rb +40 -0
- data/spec/models/complete_video200_response_spec.rb +36 -0
- data/spec/models/complete_video_request_spec.rb +42 -0
- data/spec/models/queue_video200_response_spec.rb +42 -0
- data/spec/models/queue_video_request_spec.rb +86 -0
- data/spec/models/quote_video200_response_spec.rb +36 -0
- data/spec/models/retrieve_video200_response_spec.rb +52 -0
- data/spec/models/retrieve_video_request_spec.rb +48 -0
- data/spec/models/video_model_constraints_spec.rb +70 -0
- data/spec/spec_helper.rb +1 -1
- data/swagger.yaml +587 -76
- data/venice_client.gemspec +1 -1
- metadata +46 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 540b128b8a552ee00cd66c1f4317e0604daddb56e62068f7096b1d97c41114f2
|
|
4
|
+
data.tar.gz: 4e47689acb3ccfa936b1385ced505a811d2a31a461e21ba314d5a5fe4fc9e633
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8687566b61e0d189a08c51b3fac74a0549423d994ab70feff7a07eee7d5e9369c7053836de47dde07b2993eab94a0587925793fe23b903870331c6ffd24a0a31
|
|
7
|
+
data.tar.gz: 2b85e249bf64ade7f73896303070cd993370b68467dc45b9c0f02330954d521ebf4a8d2ab0684e5e27c88cf9651a413be6f6c3efd63c1eefb3788076bfe8f270
|
data/README.md
CHANGED
|
@@ -6,7 +6,7 @@ The Venice.ai API.
|
|
|
6
6
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
|
-
- API version:
|
|
9
|
+
- API version: 20251209.153516
|
|
10
10
|
- Package version: 1.0.0
|
|
11
11
|
- Generator version: 7.14.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
@@ -111,6 +111,10 @@ Class | Method | HTTP request | Description
|
|
|
111
111
|
*VeniceClient::PreviewApi* | [**get_character_by_slug**](docs/PreviewApi.md#get_character_by_slug) | **GET** /characters/{slug} | /api/v1/characters/{slug}
|
|
112
112
|
*VeniceClient::PreviewApi* | [**list_characters**](docs/PreviewApi.md#list_characters) | **GET** /characters | /api/v1/characters
|
|
113
113
|
*VeniceClient::SpeechApi* | [**create_speech**](docs/SpeechApi.md#create_speech) | **POST** /audio/speech | /api/v1/audio/speech
|
|
114
|
+
*VeniceClient::VideoApi* | [**complete_video**](docs/VideoApi.md#complete_video) | **POST** /video/complete | /api/v1/video/complete
|
|
115
|
+
*VeniceClient::VideoApi* | [**queue_video**](docs/VideoApi.md#queue_video) | **POST** /video/queue | /api/v1/video/queue
|
|
116
|
+
*VeniceClient::VideoApi* | [**quote_video**](docs/VideoApi.md#quote_video) | **POST** /video/quote | /api/v1/video/quote
|
|
117
|
+
*VeniceClient::VideoApi* | [**retrieve_video**](docs/VideoApi.md#retrieve_video) | **POST** /video/retrieve | /api/v1/video/retrieve
|
|
114
118
|
|
|
115
119
|
|
|
116
120
|
## Documentation for Models
|
|
@@ -121,8 +125,10 @@ Class | Method | HTTP request | Description
|
|
|
121
125
|
- [VeniceClient::AudioModelPricingInput](docs/AudioModelPricingInput.md)
|
|
122
126
|
- [VeniceClient::BillingUsageRequest](docs/BillingUsageRequest.md)
|
|
123
127
|
- [VeniceClient::BillingUsageResponse](docs/BillingUsageResponse.md)
|
|
128
|
+
- [VeniceClient::CacheControl](docs/CacheControl.md)
|
|
124
129
|
- [VeniceClient::ChatCompletionRequest](docs/ChatCompletionRequest.md)
|
|
125
130
|
- [VeniceClient::ChatCompletionRequestMessagesInner](docs/ChatCompletionRequestMessagesInner.md)
|
|
131
|
+
- [VeniceClient::ChatCompletionRequestReasoning](docs/ChatCompletionRequestReasoning.md)
|
|
126
132
|
- [VeniceClient::ChatCompletionRequestResponseFormat](docs/ChatCompletionRequestResponseFormat.md)
|
|
127
133
|
- [VeniceClient::ChatCompletionRequestStop](docs/ChatCompletionRequestStop.md)
|
|
128
134
|
- [VeniceClient::ChatCompletionRequestStreamOptions](docs/ChatCompletionRequestStreamOptions.md)
|
|
@@ -130,6 +136,8 @@ Class | Method | HTTP request | Description
|
|
|
130
136
|
- [VeniceClient::ChatCompletionRequestToolChoiceAnyOf](docs/ChatCompletionRequestToolChoiceAnyOf.md)
|
|
131
137
|
- [VeniceClient::ChatCompletionRequestToolChoiceAnyOfFunction](docs/ChatCompletionRequestToolChoiceAnyOfFunction.md)
|
|
132
138
|
- [VeniceClient::ChatCompletionRequestVeniceParameters](docs/ChatCompletionRequestVeniceParameters.md)
|
|
139
|
+
- [VeniceClient::CompleteVideo200Response](docs/CompleteVideo200Response.md)
|
|
140
|
+
- [VeniceClient::CompleteVideoRequest](docs/CompleteVideoRequest.md)
|
|
133
141
|
- [VeniceClient::CreateApiKey200Response](docs/CreateApiKey200Response.md)
|
|
134
142
|
- [VeniceClient::CreateApiKey200ResponseData](docs/CreateApiKey200ResponseData.md)
|
|
135
143
|
- [VeniceClient::CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
@@ -208,6 +216,11 @@ Class | Method | HTTP request | Description
|
|
|
208
216
|
- [VeniceClient::ModelResponseModelSpecPricing](docs/ModelResponseModelSpecPricing.md)
|
|
209
217
|
- [VeniceClient::ObjectsInner](docs/ObjectsInner.md)
|
|
210
218
|
- [VeniceClient::PostApiKeyGenerateWeb3KeyRequest](docs/PostApiKeyGenerateWeb3KeyRequest.md)
|
|
219
|
+
- [VeniceClient::QueueVideo200Response](docs/QueueVideo200Response.md)
|
|
220
|
+
- [VeniceClient::QueueVideoRequest](docs/QueueVideoRequest.md)
|
|
221
|
+
- [VeniceClient::QuoteVideo200Response](docs/QuoteVideo200Response.md)
|
|
222
|
+
- [VeniceClient::RetrieveVideo200Response](docs/RetrieveVideo200Response.md)
|
|
223
|
+
- [VeniceClient::RetrieveVideoRequest](docs/RetrieveVideoRequest.md)
|
|
211
224
|
- [VeniceClient::SimpleGenerateImage200Response](docs/SimpleGenerateImage200Response.md)
|
|
212
225
|
- [VeniceClient::SimpleGenerateImage200ResponseDataInner](docs/SimpleGenerateImage200ResponseDataInner.md)
|
|
213
226
|
- [VeniceClient::SimpleGenerateImage200ResponseDataInnerAnyOf](docs/SimpleGenerateImage200ResponseDataInnerAnyOf.md)
|
|
@@ -227,6 +240,7 @@ Class | Method | HTTP request | Description
|
|
|
227
240
|
- [VeniceClient::UpscaleImageRequestEnhance](docs/UpscaleImageRequestEnhance.md)
|
|
228
241
|
- [VeniceClient::UserMessage](docs/UserMessage.md)
|
|
229
242
|
- [VeniceClient::UserMessageContent](docs/UserMessageContent.md)
|
|
243
|
+
- [VeniceClient::VideoModelConstraints](docs/VideoModelConstraints.md)
|
|
230
244
|
|
|
231
245
|
|
|
232
246
|
## Documentation for Authorization
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **usd** | **Float** | USD cost per million input characters | |
|
|
8
|
-
| **vcu** | **Float** | VCU cost per million input characters (deprecated - use Diem instead) | |
|
|
9
8
|
| **diem** | **Float** | Diem cost per million input characters | |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'venice_client'
|
|
|
15
14
|
|
|
16
15
|
instance = VeniceClient::AudioModelPricingInput.new(
|
|
17
16
|
usd: 3.5,
|
|
18
|
-
vcu: 35,
|
|
19
17
|
diem: 35
|
|
20
18
|
)
|
|
21
19
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# VeniceClient::CacheControl
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ttl** | **String** | Optional TTL for extended cache duration. Beta feature requiring special header. | [optional] |
|
|
8
|
+
| **type** | **String** | The type of cache control. Currently only \"ephemeral\" is supported. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'venice_client'
|
|
14
|
+
|
|
15
|
+
instance = VeniceClient::CacheControl.new(
|
|
16
|
+
ttl: 1h,
|
|
17
|
+
type: ephemeral
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/ChatApi.md
CHANGED
|
@@ -29,7 +29,7 @@ end
|
|
|
29
29
|
api_instance = VeniceClient::ChatApi.new
|
|
30
30
|
opts = {
|
|
31
31
|
accept_encoding: 'gzip, br', # String | Supported compression encodings (gzip, br). Only applied when stream is false.
|
|
32
|
-
chat_completion_request: VeniceClient::ChatCompletionRequest.new({messages: [VeniceClient::ChatCompletionRequestMessagesInner.new({content: VeniceClient::SystemMessageContent.new, role: 'system', tool_call_id: 'tool_call_id_example'})], model: '
|
|
32
|
+
chat_completion_request: VeniceClient::ChatCompletionRequest.new({messages: [VeniceClient::ChatCompletionRequestMessagesInner.new({content: VeniceClient::SystemMessageContent.new, role: 'system', tool_call_id: 'tool_call_id_example'})], model: 'zai-org-glm-4.6'}) # ChatCompletionRequest |
|
|
33
33
|
}
|
|
34
34
|
|
|
35
35
|
begin
|
|
@@ -16,7 +16,10 @@
|
|
|
16
16
|
| **model** | **String** | The ID of the model you wish to prompt. May also be a model trait, or a model compatibility mapping. See the models endpoint for a list of models available to you. You can use feature suffixes to enable features from the venice_parameters object. Please see \"Model Feature Suffix\" documentation for more details. | |
|
|
17
17
|
| **n** | **Integer** | How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs. | [optional][default to 1] |
|
|
18
18
|
| **presence_penalty** | **Float** | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. | [optional][default to 0] |
|
|
19
|
+
| **prompt_cache_key** | **String** | When supplied, this field may be used to optimize conversation routing to improve cache performance and thus reduce latency. | [optional] |
|
|
19
20
|
| **repetition_penalty** | **Float** | The parameter for repetition penalty. 1.0 means no penalty. Values > 1.0 discourage repetition. | [optional] |
|
|
21
|
+
| **reasoning** | [**ChatCompletionRequestReasoning**](ChatCompletionRequestReasoning.md) | | [optional] |
|
|
22
|
+
| **reasoning_effort** | **String** | OpenAI-compatible parameter to control reasoning effort level for supported models. Takes precedence over reasoning.effort if both are provided. | [optional] |
|
|
20
23
|
| **seed** | **Integer** | The random seed used to generate the response. This is useful for reproducibility. | [optional] |
|
|
21
24
|
| **stop** | [**ChatCompletionRequestStop**](ChatCompletionRequestStop.md) | | [optional] |
|
|
22
25
|
| **stop_token_ids** | **Array<Float>** | Array of token IDs where the API will stop generating further tokens. | [optional] |
|
|
@@ -47,10 +50,13 @@ instance = VeniceClient::ChatCompletionRequest.new(
|
|
|
47
50
|
messages: null,
|
|
48
51
|
min_p: 0.05,
|
|
49
52
|
min_temp: 0.1,
|
|
50
|
-
model:
|
|
53
|
+
model: zai-org-glm-4.6,
|
|
51
54
|
n: null,
|
|
52
55
|
presence_penalty: null,
|
|
56
|
+
prompt_cache_key: random-string,
|
|
53
57
|
repetition_penalty: 1.2,
|
|
58
|
+
reasoning: null,
|
|
59
|
+
reasoning_effort: medium,
|
|
54
60
|
seed: 42,
|
|
55
61
|
stop: null,
|
|
56
62
|
stop_token_ids: [151643,151645],
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# VeniceClient::ChatCompletionRequestReasoning
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **effort** | **String** | Controls the reasoning effort level for supported models. Higher effort means more thorough reasoning but increased token usage. Defaults to the model configuration if not specified. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'venice_client'
|
|
13
|
+
|
|
14
|
+
instance = VeniceClient::ChatCompletionRequestReasoning.new(
|
|
15
|
+
effort: medium
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
| **strip_thinking_response** | **Boolean** | Strip <think></think> blocks from the response. Applicable only to reasoning / thinking models. Also available to use as a model feature suffix. Defaults to false. | [optional][default to false] |
|
|
9
9
|
| **disable_thinking** | **Boolean** | On supported reasoning models, will disable thinking and strip the <think></think> blocks from the response. Defaults to false. | [optional][default to false] |
|
|
10
10
|
| **enable_web_search** | **String** | Enable web search for this request. Defaults to off. On will force web search on the request. Auto will enable it based on the model's discretion. Citations will be returned either in the first chunk of a streaming result, or in the non streaming response. | [optional][default to 'false'] |
|
|
11
|
-
| **
|
|
11
|
+
| **enable_web_scraping** | **Boolean** | Enable Venice web scraping of URLs in the latest user message using Firecrawl. Off by default. | [optional][default to false] |
|
|
12
|
+
| **enable_web_citations** | **Boolean** | When web search is enabled, this will request that the LLM cite its sources using a ^index^ or ^i,j^ superscript format (e.g., ^1^). Defaults to false. | [optional][default to false] |
|
|
12
13
|
| **include_search_results_in_stream** | **Boolean** | Experimental feature - When set to true, the LLM will include search results in the stream as the first emitted chunk. Defaults to false. | [optional][default to false] |
|
|
13
14
|
| **return_search_results_as_documents** | **Boolean** | When set, search results are also surfaced in an OpenAI-compatible tool call named \"venice_web_search_documents\" to ease LangChain consumption. | [optional] |
|
|
14
15
|
| **include_venice_system_prompt** | **Boolean** | Whether to include the Venice supplied system prompts along side specified system prompts. Defaults to true. | [optional][default to true] |
|
|
@@ -23,6 +24,7 @@ instance = VeniceClient::ChatCompletionRequestVeniceParameters.new(
|
|
|
23
24
|
strip_thinking_response: false,
|
|
24
25
|
disable_thinking: false,
|
|
25
26
|
enable_web_search: false,
|
|
27
|
+
enable_web_scraping: false,
|
|
26
28
|
enable_web_citations: null,
|
|
27
29
|
include_search_results_in_stream: null,
|
|
28
30
|
return_search_results_as_documents: null,
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# VeniceClient::CompleteVideo200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | Indicates whether the video cleanup was successful. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'venice_client'
|
|
13
|
+
|
|
14
|
+
instance = VeniceClient::CompleteVideo200Response.new(
|
|
15
|
+
success: true
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# VeniceClient::CompleteVideoRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **model** | **String** | The ID of the model used for video generation. | |
|
|
8
|
+
| **queue_id** | **String** | The ID of the video generation request. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'venice_client'
|
|
14
|
+
|
|
15
|
+
instance = VeniceClient::CompleteVideoRequest.new(
|
|
16
|
+
model: video-model-123,
|
|
17
|
+
queue_id: 123e4567-e89b-12d3-a456-426614174000
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -22,7 +22,7 @@ instance = VeniceClient::CreateChatCompletion200Response.new(
|
|
|
22
22
|
choices: [{"finish_reason":"stop","index":0,"logprobs":null,"message":{"content":"The sky appears blue because of the way Earth's atmosphere scatters sunlight. When sunlight reaches Earth's atmosphere, it is made up of various colors of the spectrum, but blue light waves are shorter and scatter more easily when they hit the gases and particles in the atmosphere. This scattering occurs in all directions, but from our perspective on the ground, it appears as a blue hue that dominates the sky's color. This phenomenon is known as Rayleigh scattering. During sunrise and sunset, the sunlight has to travel further through the atmosphere, which allows more time for the blue light to scatter away from our direct line of sight, leaving the longer wavelengths, such as red, yellow, and orange, to dominate the sky's color.","reasoning_content":null,"role":"assistant","tool_calls":[]},"stop_reason":null}],
|
|
23
23
|
created: 1677858240,
|
|
24
24
|
id: chatcmpl-abc123,
|
|
25
|
-
model:
|
|
25
|
+
model: zai-org-glm-4.6,
|
|
26
26
|
object: chat.completion,
|
|
27
27
|
prompt_logprobs: null,
|
|
28
28
|
usage: null,
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **enable_web_search** | **String** | Did the request enable web search? | |
|
|
8
8
|
| **enable_web_citations** | **Boolean** | Did the request enable web citations? | |
|
|
9
|
+
| **enable_web_scraping** | **Boolean** | Did the request enable web scraping of URLs via Firecrawl? | |
|
|
9
10
|
| **include_venice_system_prompt** | **Boolean** | Did the request include the Venice system prompt? | |
|
|
10
11
|
| **include_search_results_in_stream** | **Boolean** | Did the request include search results in the stream? | |
|
|
11
12
|
| **return_search_results_as_documents** | **Boolean** | Did the request also return search results as a tool-call documents block? | |
|
|
@@ -22,6 +23,7 @@ require 'venice_client'
|
|
|
22
23
|
instance = VeniceClient::CreateChatCompletion200ResponseVeniceParameters.new(
|
|
23
24
|
enable_web_search: auto,
|
|
24
25
|
enable_web_citations: true,
|
|
26
|
+
enable_web_scraping: false,
|
|
25
27
|
include_venice_system_prompt: true,
|
|
26
28
|
include_search_results_in_stream: false,
|
|
27
29
|
return_search_results_as_documents: true,
|
|
@@ -18,8 +18,11 @@
|
|
|
18
18
|
| **variants** | **Integer** | Number of images to generate (1–4). Only supported when return_binary is false. | [optional] |
|
|
19
19
|
| **safe_mode** | **Boolean** | Whether to use safe mode. If enabled, this will blur images that are classified as having adult content. | [optional][default to true] |
|
|
20
20
|
| **seed** | **Integer** | Random seed for generation. If not provided, a random seed will be used. | [optional][default to 0] |
|
|
21
|
-
| **steps** | **Integer** | Number of inference steps.
|
|
21
|
+
| **steps** | **Integer** | Number of inference steps. This model does not support steps - this field is ignored. | [optional][default to 0] |
|
|
22
22
|
| **style_preset** | **String** | An image style to apply to the image. Visit https://docs.venice.ai/api-reference/endpoint/image/styles for more details. | [optional] |
|
|
23
|
+
| **aspect_ratio** | **String** | Aspect ratio (utilized by certain image models including Nano Banana). Examples: \"1:1\", \"16:9\". | [optional] |
|
|
24
|
+
| **resolution** | **String** | Resolution (utilized by certain image models including Nano Banana). Examples: \"1024x1024\", \"512x512\". | [optional] |
|
|
25
|
+
| **enable_web_search** | **Boolean** | Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image. Only supported by certain models. If web search is used, additional credits are getting charged. | [optional] |
|
|
23
26
|
| **width** | **Integer** | Width of the generated image. Each model has a specific height and width divisor listed in the widthHeightDivisor constraint in the model list endpoint. | [optional][default to 1024] |
|
|
24
27
|
|
|
25
28
|
## Example
|
|
@@ -35,15 +38,18 @@ instance = VeniceClient::GenerateImageRequest.new(
|
|
|
35
38
|
hide_watermark: false,
|
|
36
39
|
inpaint: null,
|
|
37
40
|
lora_strength: 50,
|
|
38
|
-
model:
|
|
41
|
+
model: z-image-turbo,
|
|
39
42
|
negative_prompt: Clouds, Rain, Snow,
|
|
40
43
|
prompt: A beautiful sunset over a mountain range,
|
|
41
44
|
return_binary: false,
|
|
42
45
|
variants: 3,
|
|
43
46
|
safe_mode: false,
|
|
44
47
|
seed: 123456789,
|
|
45
|
-
steps:
|
|
48
|
+
steps: 0,
|
|
46
49
|
style_preset: 3D Model,
|
|
50
|
+
aspect_ratio: 61,
|
|
51
|
+
resolution: 1024x1024,
|
|
52
|
+
enable_web_search: false,
|
|
47
53
|
width: 1024
|
|
48
54
|
)
|
|
49
55
|
```
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **api_key_id** | **String** | The ID of the API key that exceeded the limit. | |
|
|
8
|
-
| **model_id** | **String** | The ID of the model that was used when the rate limit was exceeded. | [default to '
|
|
8
|
+
| **model_id** | **String** | The ID of the model that was used when the rate limit was exceeded. | [default to 'zai-org-glm-4.6'] |
|
|
9
9
|
| **rate_limit_tier** | **String** | The API tier of the rate limit. | |
|
|
10
10
|
| **rate_limit_type** | **String** | The type of rate limit that was exceeded. | |
|
|
11
11
|
| **timestamp** | **String** | The timestamp when the rate limit was exceeded. | |
|
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **warning_message** | **String** | A warning message to disambiguate staked DIEM balance from legacy DIEM (formerly VCU) balance | [optional] |
|
|
8
7
|
| **data** | [**GetApiKeyRateLimits200ResponseData**](GetApiKeyRateLimits200ResponseData.md) | | |
|
|
9
8
|
|
|
10
9
|
## Example
|
|
@@ -13,7 +12,6 @@
|
|
|
13
12
|
require 'venice_client'
|
|
14
13
|
|
|
15
14
|
instance = VeniceClient::GetApiKeyRateLimits200Response.new(
|
|
16
|
-
warning_message: null,
|
|
17
15
|
data: null
|
|
18
16
|
)
|
|
19
17
|
```
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **usd** | **Float** | The USD balance of the key. | [optional] |
|
|
8
|
-
| **vcu** | **Float** | The VCU balance of the key. VCU is being deprecated in favor of Diem. | [optional] |
|
|
9
8
|
| **diem** | **Float** | The Diem balance of the key. | [optional] |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'venice_client'
|
|
|
15
14
|
|
|
16
15
|
instance = VeniceClient::GetApiKeyRateLimits200ResponseDataBalances.new(
|
|
17
16
|
usd: 50.23,
|
|
18
|
-
vcu: 100.023,
|
|
19
17
|
diem: 100.023
|
|
20
18
|
)
|
|
21
19
|
```
|
data/docs/ImageApi.md
CHANGED
|
@@ -104,7 +104,7 @@ end
|
|
|
104
104
|
api_instance = VeniceClient::ImageApi.new
|
|
105
105
|
opts = {
|
|
106
106
|
accept_encoding: 'gzip, br', # String | Supported compression encodings (gzip, br). Only applied when return_binary is false.
|
|
107
|
-
generate_image_request: VeniceClient::GenerateImageRequest.new({model: '
|
|
107
|
+
generate_image_request: VeniceClient::GenerateImageRequest.new({model: 'z-image-turbo', prompt: 'A beautiful sunset over a mountain range'}) # GenerateImageRequest |
|
|
108
108
|
}
|
|
109
109
|
|
|
110
110
|
begin
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **usd** | **Float** | USD cost per image generation | |
|
|
8
|
-
| **vcu** | **Float** | VCU cost per image generation (deprecated - use Diem instead) | |
|
|
9
8
|
| **diem** | **Float** | Diem cost per image generation | |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'venice_client'
|
|
|
15
14
|
|
|
16
15
|
instance = VeniceClient::ImageModelPricingGeneration.new(
|
|
17
16
|
usd: 0.01,
|
|
18
|
-
vcu: 0.1,
|
|
19
17
|
diem: 0.1
|
|
20
18
|
)
|
|
21
19
|
```
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **usd** | **Float** | USD cost for 2x upscale | |
|
|
8
|
-
| **vcu** | **Float** | VCU cost for 2x upscale (deprecated - use Diem instead) | |
|
|
9
8
|
| **diem** | **Float** | Diem cost for 2x upscale | |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'venice_client'
|
|
|
15
14
|
|
|
16
15
|
instance = VeniceClient::ImageModelPricingUpscale2x.new(
|
|
17
16
|
usd: 0.02,
|
|
18
|
-
vcu: 0.2,
|
|
19
17
|
diem: 0.2
|
|
20
18
|
)
|
|
21
19
|
```
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **usd** | **Float** | USD cost for 4x upscale | |
|
|
8
|
-
| **vcu** | **Float** | VCU cost for 4x upscale (deprecated - use Diem instead) | |
|
|
9
8
|
| **diem** | **Float** | Diem cost for 4x upscale | |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'venice_client'
|
|
|
15
14
|
|
|
16
15
|
instance = VeniceClient::ImageModelPricingUpscale4x.new(
|
|
17
16
|
usd: 0.08,
|
|
18
|
-
vcu: 0.8,
|
|
19
17
|
diem: 0.8
|
|
20
18
|
)
|
|
21
19
|
```
|
data/docs/ImageUrl.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cache_control** | [**CacheControl**](CacheControl.md) | | [optional] |
|
|
7
8
|
| **image_url** | [**ImageURLObject**](ImageURLObject.md) | | |
|
|
8
9
|
| **type** | **String** | | |
|
|
9
10
|
|
|
@@ -13,6 +14,7 @@
|
|
|
13
14
|
require 'venice_client'
|
|
14
15
|
|
|
15
16
|
instance = VeniceClient::ImageUrl.new(
|
|
17
|
+
cache_control: null,
|
|
16
18
|
image_url: null,
|
|
17
19
|
type: null
|
|
18
20
|
)
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **usd** | **Float** | USD cost per million input tokens | |
|
|
8
|
-
| **vcu** | **Float** | VCU cost per million input tokens (deprecated - use Diem instead) | |
|
|
9
8
|
| **diem** | **Float** | Diem cost per million input tokens | |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'venice_client'
|
|
|
15
14
|
|
|
16
15
|
instance = VeniceClient::LLMModelPricingInput.new(
|
|
17
16
|
usd: 0.7,
|
|
18
|
-
vcu: 7,
|
|
19
17
|
diem: 7
|
|
20
18
|
)
|
|
21
19
|
```
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **usd** | **Float** | USD cost per million output tokens | |
|
|
8
|
-
| **vcu** | **Float** | VCU cost per million output tokens (deprecated - use Diem instead) | |
|
|
9
8
|
| **diem** | **Float** | Diem cost per million output tokens | |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -15,7 +14,6 @@ require 'venice_client'
|
|
|
15
14
|
|
|
16
15
|
instance = VeniceClient::LLMModelPricingOutput.new(
|
|
17
16
|
usd: 2.8,
|
|
18
|
-
vcu: 28,
|
|
19
17
|
diem: 28
|
|
20
18
|
)
|
|
21
19
|
```
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **available_context_tokens** | **Float** | The context length supported by the model. Only applicable for text models. | [optional] |
|
|
8
8
|
| **beta** | **Boolean** | Is this model in beta? | [optional] |
|
|
9
|
+
| **privacy** | **String** | The privacy mode of the model. Private models have zero data retention. Anonymized models Venice can not guarantee privacy on, but requests are not affiliated with a user | [optional] |
|
|
9
10
|
| **capabilities** | [**ModelResponseModelSpecCapabilities**](ModelResponseModelSpecCapabilities.md) | | [optional] |
|
|
10
11
|
| **constraints** | [**ModelResponseModelSpecConstraints**](ModelResponseModelSpecConstraints.md) | | [optional] |
|
|
11
12
|
| **name** | **String** | The name of the model. | [optional] |
|
|
@@ -23,6 +24,7 @@ require 'venice_client'
|
|
|
23
24
|
instance = VeniceClient::ModelResponseModelSpec.new(
|
|
24
25
|
available_context_tokens: 32768,
|
|
25
26
|
beta: false,
|
|
27
|
+
privacy: private,
|
|
26
28
|
capabilities: null,
|
|
27
29
|
constraints: null,
|
|
28
30
|
name: Venice Uncensored 1.1,
|
|
@@ -9,6 +9,12 @@
|
|
|
9
9
|
| **width_height_divisor** | **Float** | The requested width and height of the image generation must be divisible by this value. | |
|
|
10
10
|
| **temperature** | [**TextModelConstraintsTemperature**](TextModelConstraintsTemperature.md) | | |
|
|
11
11
|
| **top_p** | [**TextModelConstraintsTopP**](TextModelConstraintsTopP.md) | | |
|
|
12
|
+
| **aspect_ratios** | **Array<String>** | The aspect ratios supported by the model. Empty array means the model does not support a defined aspect ratio. | |
|
|
13
|
+
| **resolutions** | **Array<String>** | The resolutions supported by the model. Empty array means the model does not support a defined resolution. | |
|
|
14
|
+
| **durations** | **Array<String>** | The durations supported by the model. Empty array means the model does not support a defined duration. | |
|
|
15
|
+
| **model_type** | **String** | The type of video model. | |
|
|
16
|
+
| **audio** | **Boolean** | Does the model support audio generation? | |
|
|
17
|
+
| **audio_configurable** | **Boolean** | Can audio be enabled or disabled for the video generation? | |
|
|
12
18
|
|
|
13
19
|
## Example
|
|
14
20
|
|
|
@@ -20,7 +26,13 @@ instance = VeniceClient::ModelResponseModelSpecConstraints.new(
|
|
|
20
26
|
steps: null,
|
|
21
27
|
width_height_divisor: 8,
|
|
22
28
|
temperature: null,
|
|
23
|
-
top_p: null
|
|
29
|
+
top_p: null,
|
|
30
|
+
aspect_ratios: [969, 556],
|
|
31
|
+
resolutions: [1080p, 720p, 480p],
|
|
32
|
+
durations: [5s, 10s, 15s, 20s, 30s],
|
|
33
|
+
model_type: image-to-video,
|
|
34
|
+
audio: true,
|
|
35
|
+
audio_configurable: true
|
|
24
36
|
)
|
|
25
37
|
```
|
|
26
38
|
|
data/docs/ModelsApi.md
CHANGED
|
@@ -30,7 +30,7 @@ end
|
|
|
30
30
|
|
|
31
31
|
api_instance = VeniceClient::ModelsApi.new
|
|
32
32
|
opts = {
|
|
33
|
-
type: '
|
|
33
|
+
type: 'asr' # String |
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
begin
|
|
@@ -101,7 +101,7 @@ end
|
|
|
101
101
|
|
|
102
102
|
api_instance = VeniceClient::ModelsApi.new
|
|
103
103
|
opts = {
|
|
104
|
-
type: '
|
|
104
|
+
type: 'asr' # String |
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
begin
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# VeniceClient::QueueVideo200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **model** | **String** | The ID of the model used for video generation. | |
|
|
8
|
+
| **queue_id** | **String** | The ID of the video generation request. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'venice_client'
|
|
14
|
+
|
|
15
|
+
instance = VeniceClient::QueueVideo200Response.new(
|
|
16
|
+
model: video-model-123,
|
|
17
|
+
queue_id: 123e4567-e89b-12d3-a456-426614174000
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# VeniceClient::QueueVideoRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **model** | **String** | The model to use for image generation. | |
|
|
8
|
+
| **prompt** | **String** | The prompt to use for video generation. The maximum length is 2500 characters. | |
|
|
9
|
+
| **negative_prompt** | **String** | The negative prompt to use for video generation. The maximum length is 2500 characters. | [optional][default to 'low resolution, error, worst quality, low quality, defects'] |
|
|
10
|
+
| **duration** | **String** | The duration of the video to generate. | |
|
|
11
|
+
| **aspect_ratio** | **Object** | The aspect ratio of the video to generate. | [optional] |
|
|
12
|
+
| **resolution** | **String** | The resolution of the video to generate. | [optional][default to '720p'] |
|
|
13
|
+
| **audio** | **Object** | For models which support audio generation and configuration, indicates if audio should be generated. Defaults to true. | [optional] |
|
|
14
|
+
| **image_url** | **String** | For image to video models, the reference image to use for video generation. Must be either a URL (starting with \"http://\" or \"https://\") or a data URL (starting with \"data:\"). | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'venice_client'
|
|
20
|
+
|
|
21
|
+
instance = VeniceClient::QueueVideoRequest.new(
|
|
22
|
+
model: wan-2.5-preview-image-to-video,
|
|
23
|
+
prompt: Commerce being conducted in the city of Venice, Italy.,
|
|
24
|
+
negative_prompt: low resolution, error, worst quality, low quality, defects,
|
|
25
|
+
duration: 5s,
|
|
26
|
+
aspect_ratio: 969,
|
|
27
|
+
resolution: 720p,
|
|
28
|
+
audio: true,
|
|
29
|
+
image_url: data:image/png;base64,iVBORw0K...
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# VeniceClient::QuoteVideo200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **quote** | **Float** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'venice_client'
|
|
13
|
+
|
|
14
|
+
instance = VeniceClient::QuoteVideo200Response.new(
|
|
15
|
+
quote: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# VeniceClient::RetrieveVideo200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | The status of the video generation request. | |
|
|
8
|
+
| **average_execution_time** | **Float** | The average execution time of the video generation request in milliseconds. | |
|
|
9
|
+
| **execution_duration** | **Float** | The current duration of the video generation request in milliseconds. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'venice_client'
|
|
15
|
+
|
|
16
|
+
instance = VeniceClient::RetrieveVideo200Response.new(
|
|
17
|
+
status: PROCESSING,
|
|
18
|
+
average_execution_time: 145000,
|
|
19
|
+
execution_duration: 53200
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# VeniceClient::RetrieveVideoRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **model** | **String** | The ID of the model used for video generation. | |
|
|
8
|
+
| **queue_id** | **String** | The ID of the video generation request. | |
|
|
9
|
+
| **delete_media_on_completion** | **Boolean** | If true, the video media will be deleted from storage after the request is completed. If false, you can use the complete endpoint to remove the media once you have successfully downloaded the video. | [optional][default to false] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'venice_client'
|
|
15
|
+
|
|
16
|
+
instance = VeniceClient::RetrieveVideoRequest.new(
|
|
17
|
+
model: video-model-123,
|
|
18
|
+
queue_id: 123e4567-e89b-12d3-a456-426614174000,
|
|
19
|
+
delete_media_on_completion: false
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|