litellm_client 1.0.0

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.
Files changed (913) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +741 -0
  4. data/Rakefile +10 -0
  5. data/docs/AddTeamCallback.md +22 -0
  6. data/docs/Annotations.md +15 -0
  7. data/docs/AnthropicPassThroughApi.md +367 -0
  8. data/docs/ApiBase.md +15 -0
  9. data/docs/ApiKey.md +15 -0
  10. data/docs/ApiVersion.md +15 -0
  11. data/docs/ApplyGuardrailRequest.md +24 -0
  12. data/docs/ApplyGuardrailResponse.md +18 -0
  13. data/docs/AssemblyAIEUPassThroughApi.md +357 -0
  14. data/docs/AssemblyAIPassThroughApi.md +357 -0
  15. data/docs/AssistantsApi.md +1141 -0
  16. data/docs/AudioApi.md +289 -0
  17. data/docs/AuditLogResponse.md +34 -0
  18. data/docs/AuditLoggingApi.md +173 -0
  19. data/docs/AwsAccessKeyId.md +15 -0
  20. data/docs/AwsRegionName.md +15 -0
  21. data/docs/AwsSecretAccessKey.md +15 -0
  22. data/docs/AzurePassThroughApi.md +367 -0
  23. data/docs/BaseModel.md +15 -0
  24. data/docs/BatchApi.md +913 -0
  25. data/docs/BatchSize.md +15 -0
  26. data/docs/BedrockPassThroughApi.md +367 -0
  27. data/docs/BlockKeyRequest.md +18 -0
  28. data/docs/BlockTeamRequest.md +18 -0
  29. data/docs/BlockUsers.md +18 -0
  30. data/docs/BodyTestModelConnectionHealthTestConnectionPost.md +20 -0
  31. data/docs/BreakdownMetrics.md +24 -0
  32. data/docs/BudgetConfig.md +24 -0
  33. data/docs/BudgetDeleteRequest.md +18 -0
  34. data/docs/BudgetDuration.md +15 -0
  35. data/docs/BudgetManagementApi.md +436 -0
  36. data/docs/BudgetNewRequest.md +34 -0
  37. data/docs/BudgetRequest.md +18 -0
  38. data/docs/BudgetSpendTrackingApi.md +694 -0
  39. data/docs/Bytes.md +15 -0
  40. data/docs/CacheControl.md +18 -0
  41. data/docs/CachePingResponse.md +28 -0
  42. data/docs/CachingApi.md +421 -0
  43. data/docs/CallTypes.md +15 -0
  44. data/docs/ChatCompletionAnnotation.md +20 -0
  45. data/docs/ChatCompletionAnnotationURLCitation.md +24 -0
  46. data/docs/ChatCompletionAudioResponse.md +24 -0
  47. data/docs/ChatCompletionCachedContent.md +18 -0
  48. data/docs/ChatCompletionRedactedThinkingBlock.md +22 -0
  49. data/docs/ChatCompletionThinkingBlock.md +24 -0
  50. data/docs/ChatCompletionTokenLogprob.md +24 -0
  51. data/docs/ChatCompletionsApi.md +299 -0
  52. data/docs/ChoiceLogprobs.md +18 -0
  53. data/docs/Choices.md +26 -0
  54. data/docs/Choices1Inner.md +26 -0
  55. data/docs/CoherePassThroughApi.md +367 -0
  56. data/docs/CompletionsApi.md +299 -0
  57. data/docs/ConfigurableClientsideAuthParams.md +15 -0
  58. data/docs/ConfigurableClientsideAuthParamsAnyOfInner.md +18 -0
  59. data/docs/ConfigurableClientsideParamsCustomAuth.md +18 -0
  60. data/docs/Content.md +15 -0
  61. data/docs/Content1.md +15 -0
  62. data/docs/CreateCredentialItem.md +24 -0
  63. data/docs/CreateGuardrailRequest.md +18 -0
  64. data/docs/CreatedAt.md +15 -0
  65. data/docs/CreatedBy.md +15 -0
  66. data/docs/CredentialItem.md +22 -0
  67. data/docs/CredentialManagementApi.md +444 -0
  68. data/docs/CustomLlmProvider.md +15 -0
  69. data/docs/CustomLlmProvider1.md +15 -0
  70. data/docs/CustomerManagementApi.md +508 -0
  71. data/docs/DailySpendData.md +22 -0
  72. data/docs/DailySpendMetadata.md +40 -0
  73. data/docs/DefaultApi.md +811 -0
  74. data/docs/DefaultInternalUserParams.md +24 -0
  75. data/docs/DefaultTeamSSOParams.md +26 -0
  76. data/docs/DefaultTeamSettingsResponse.md +20 -0
  77. data/docs/DeleteCustomerRequest.md +18 -0
  78. data/docs/DeleteOrganizationRequest.md +18 -0
  79. data/docs/DeleteTeamRequest.md +18 -0
  80. data/docs/DeleteUserRequest.md +18 -0
  81. data/docs/Deployment.md +22 -0
  82. data/docs/Description.md +15 -0
  83. data/docs/Destructivehint.md +15 -0
  84. data/docs/EmailEvent.md +15 -0
  85. data/docs/EmailEventSettings.md +20 -0
  86. data/docs/EmailEventSettingsResponse.md +18 -0
  87. data/docs/EmailEventSettingsUpdateRequest.md +18 -0
  88. data/docs/EmailManagementApi.md +217 -0
  89. data/docs/EmbeddingsApi.md +299 -0
  90. data/docs/Endtime.md +15 -0
  91. data/docs/ErrorResponse.md +18 -0
  92. data/docs/Expires.md +15 -0
  93. data/docs/FilesApi.md +1165 -0
  94. data/docs/FineTuningApi.md +607 -0
  95. data/docs/FunctionCall.md +20 -0
  96. data/docs/GenerateKeyRequest.md +74 -0
  97. data/docs/GenerateKeyResponse.md +88 -0
  98. data/docs/GetTeamMemberPermissionsResponse.md +22 -0
  99. data/docs/GoogleAIStudioPassThroughApi.md +332 -0
  100. data/docs/Guardrail.md +28 -0
  101. data/docs/GuardrailInfoLiteLLMParamsResponse.md +24 -0
  102. data/docs/GuardrailInfoResponse.md +30 -0
  103. data/docs/GuardrailsApi.md +791 -0
  104. data/docs/HTTPValidationError.md +18 -0
  105. data/docs/HealthApi.md +820 -0
  106. data/docs/Hyperparameters.md +22 -0
  107. data/docs/IPAddress.md +18 -0
  108. data/docs/Id.md +15 -0
  109. data/docs/Idempotenthint.md +15 -0
  110. data/docs/ImagesApi.md +455 -0
  111. data/docs/InputCostPerPixel.md +15 -0
  112. data/docs/InputCostPerSecond.md +15 -0
  113. data/docs/InputCostPerToken.md +15 -0
  114. data/docs/Integrations.md +15 -0
  115. data/docs/InternalUserManagementApi.md +475 -0
  116. data/docs/InternalUserSettingsResponse.md +20 -0
  117. data/docs/KeyHealthResponse.md +20 -0
  118. data/docs/KeyListResponseObject.md +24 -0
  119. data/docs/KeyListResponseObjectKeysInner.md +134 -0
  120. data/docs/KeyManagementApi.md +780 -0
  121. data/docs/KeyMetadata.md +20 -0
  122. data/docs/KeyMetricWithMetadata.md +20 -0
  123. data/docs/KeyRequest.md +20 -0
  124. data/docs/LakeraCategoryThresholds.md +20 -0
  125. data/docs/LangfusePassThroughApi.md +332 -0
  126. data/docs/LearningRateMultiplier.md +15 -0
  127. data/docs/ListGuardrailsResponse.md +18 -0
  128. data/docs/ListMCPToolsRestAPIResponseObject.md +26 -0
  129. data/docs/ListMCPToolsRestAPIResponseObjectAnnotations.md +26 -0
  130. data/docs/ListMCPToolsRestAPIResponseObjectMcpInfo.md +22 -0
  131. data/docs/LiteLLMBudgetTable.md +32 -0
  132. data/docs/LiteLLMEndUserTable.md +30 -0
  133. data/docs/LiteLLMFineTuningJobCreate.md +32 -0
  134. data/docs/LiteLLMFineTuningJobCreateHyperparameters.md +22 -0
  135. data/docs/LiteLLMMCPServerTable.md +38 -0
  136. data/docs/LiteLLMManagedVectorStore.md +32 -0
  137. data/docs/LiteLLMManagedVectorStoreListResponse.md +26 -0
  138. data/docs/LiteLLMModelTable.md +26 -0
  139. data/docs/LiteLLMObjectPermissionBase.md +20 -0
  140. data/docs/LiteLLMObjectPermissionTable.md +22 -0
  141. data/docs/LiteLLMOrganizationMembershipTable.md +34 -0
  142. data/docs/LiteLLMOrganizationTableUpdate.md +32 -0
  143. data/docs/LiteLLMOrganizationTableWithMembers.md +48 -0
  144. data/docs/LiteLLMParams.md +88 -0
  145. data/docs/LiteLLMSpendLogs.md +54 -0
  146. data/docs/LiteLLMTeamMembership.md +24 -0
  147. data/docs/LiteLLMTeamTable.md +62 -0
  148. data/docs/LiteLLMUserTable.md +56 -0
  149. data/docs/LiteLLMUserTableWithKeyCount.md +58 -0
  150. data/docs/LiteLLMVerificationToken.md +80 -0
  151. data/docs/LitellmCredentialName.md +15 -0
  152. data/docs/LitellmParams.md +92 -0
  153. data/docs/LitellmTraceId.md +15 -0
  154. data/docs/LitellmUserRoles.md +15 -0
  155. data/docs/LlmUtilsApi.md +219 -0
  156. data/docs/LoggingCallbackStatus.md +22 -0
  157. data/docs/Logprobs.md +18 -0
  158. data/docs/MCPInfo.md +22 -0
  159. data/docs/MaxBudget.md +15 -0
  160. data/docs/MaxFileSizeMb.md +15 -0
  161. data/docs/MaxRetries.md +15 -0
  162. data/docs/McpApi.md +519 -0
  163. data/docs/Member.md +22 -0
  164. data/docs/Member1.md +22 -0
  165. data/docs/Member2.md +22 -0
  166. data/docs/MergeReasoningContentInChoices.md +15 -0
  167. data/docs/Message.md +34 -0
  168. data/docs/MessageAudio.md +24 -0
  169. data/docs/MessageFunctionCall.md +20 -0
  170. data/docs/Messages.md +15 -0
  171. data/docs/MetricWithMetadata.md +20 -0
  172. data/docs/MistralPassThroughApi.md +367 -0
  173. data/docs/MockResponse.md +28 -0
  174. data/docs/Mode.md +15 -0
  175. data/docs/Mode1.md +15 -0
  176. data/docs/Model.md +15 -0
  177. data/docs/ModelAliases.md +15 -0
  178. data/docs/ModelInfo.md +15 -0
  179. data/docs/ModelInfoDelete.md +18 -0
  180. data/docs/ModelManagementApi.md +679 -0
  181. data/docs/ModelResponse.md +28 -0
  182. data/docs/ModerationsApi.md +145 -0
  183. data/docs/NEpochs.md +15 -0
  184. data/docs/Name.md +15 -0
  185. data/docs/NewCustomerRequest.md +46 -0
  186. data/docs/NewMCPServerRequest.md +30 -0
  187. data/docs/NewOrganizationRequest.md +42 -0
  188. data/docs/NewOrganizationResponse.md +44 -0
  189. data/docs/NewTeamRequest.md +52 -0
  190. data/docs/NewUserRequest.md +76 -0
  191. data/docs/NewUserResponse.md +96 -0
  192. data/docs/OpenAIPassThroughApi.md +367 -0
  193. data/docs/Openworldhint.md +15 -0
  194. data/docs/OrgMember.md +22 -0
  195. data/docs/Organization.md +15 -0
  196. data/docs/OrganizationAddMemberResponse.md +22 -0
  197. data/docs/OrganizationManagementApi.md +652 -0
  198. data/docs/OrganizationMemberAddRequest.md +22 -0
  199. data/docs/OrganizationMemberDeleteRequest.md +22 -0
  200. data/docs/OrganizationMemberUpdateRequest.md +26 -0
  201. data/docs/OrganizationRequest.md +18 -0
  202. data/docs/OutputCostPerPixel.md +15 -0
  203. data/docs/OutputCostPerSecond.md +15 -0
  204. data/docs/OutputCostPerToken.md +15 -0
  205. data/docs/PaginatedAuditLogResponse.md +26 -0
  206. data/docs/PassThroughApi.md +4562 -0
  207. data/docs/PassThroughEndpointResponse.md +18 -0
  208. data/docs/PassThroughGenericEndpoint.md +22 -0
  209. data/docs/PatchGuardrailLitellmParams.md +20 -0
  210. data/docs/PatchGuardrailRequest.md +22 -0
  211. data/docs/PiiAction.md +15 -0
  212. data/docs/PiiEntityType.md +15 -0
  213. data/docs/ProviderBudgetResponse.md +18 -0
  214. data/docs/ProviderBudgetResponseObject.md +24 -0
  215. data/docs/ProviderSpecificFields.md +15 -0
  216. data/docs/RawRequestTypedDict.md +24 -0
  217. data/docs/Readonlyhint.md +15 -0
  218. data/docs/ReasoningContent.md +15 -0
  219. data/docs/RegenerateKeyRequest.md +76 -0
  220. data/docs/RegionName.md +15 -0
  221. data/docs/RerankApi.md +208 -0
  222. data/docs/Resources.md +15 -0
  223. data/docs/Response.md +15 -0
  224. data/docs/ResponsesApi.md +577 -0
  225. data/docs/Rpm.md +15 -0
  226. data/docs/SCIMGroup.md +28 -0
  227. data/docs/SCIMListResponse.md +26 -0
  228. data/docs/SCIMMember.md +20 -0
  229. data/docs/SCIMPatchOp.md +20 -0
  230. data/docs/SCIMPatchOperation.md +22 -0
  231. data/docs/SCIMUser.md +36 -0
  232. data/docs/SCIMUserEmail.md +22 -0
  233. data/docs/SCIMUserGroup.md +22 -0
  234. data/docs/SCIMUserName.md +28 -0
  235. data/docs/SCIMV2Api.md +889 -0
  236. data/docs/SSOConfig.md +40 -0
  237. data/docs/SSOSettingsApi.md +430 -0
  238. data/docs/SSOSettingsResponse.md +20 -0
  239. data/docs/Seed.md +15 -0
  240. data/docs/Service.md +15 -0
  241. data/docs/SpendAnalyticsPaginatedResponse.md +20 -0
  242. data/docs/SpendCalculateRequest.md +22 -0
  243. data/docs/SpendMetrics.md +34 -0
  244. data/docs/Starttime.md +15 -0
  245. data/docs/StreamTimeout.md +15 -0
  246. data/docs/Suffix.md +15 -0
  247. data/docs/SystemFingerprint.md +15 -0
  248. data/docs/TagConfig.md +30 -0
  249. data/docs/TagDeleteRequest.md +18 -0
  250. data/docs/TagInfoRequest.md +18 -0
  251. data/docs/TagManagementApi.md +450 -0
  252. data/docs/TagNewRequest.md +24 -0
  253. data/docs/TagUpdateRequest.md +24 -0
  254. data/docs/TeamAddMemberResponse.md +66 -0
  255. data/docs/TeamId.md +15 -0
  256. data/docs/TeamListResponse.md +26 -0
  257. data/docs/TeamManagementApi.md +1433 -0
  258. data/docs/TeamMemberAddRequest.md +22 -0
  259. data/docs/TeamMemberDeleteRequest.md +22 -0
  260. data/docs/TeamMemberUpdateRequest.md +26 -0
  261. data/docs/TeamMemberUpdateResponse.md +24 -0
  262. data/docs/TeamModelAddRequest.md +20 -0
  263. data/docs/TeamModelDeleteRequest.md +20 -0
  264. data/docs/TeamPublicModelName.md +15 -0
  265. data/docs/ThinkingBlocks.md +15 -0
  266. data/docs/ThinkingBlocksAnyOfInner.md +26 -0
  267. data/docs/Tier.md +15 -0
  268. data/docs/Timeout.md +15 -0
  269. data/docs/Title.md +15 -0
  270. data/docs/TokenCountRequest.md +22 -0
  271. data/docs/TokenCountResponse.md +24 -0
  272. data/docs/ToolAnnotations.md +26 -0
  273. data/docs/ToolCalls.md +15 -0
  274. data/docs/TopLogprob.md +22 -0
  275. data/docs/Tpm.md +15 -0
  276. data/docs/TransformRequestBody.md +20 -0
  277. data/docs/UiDiscoveryEndpoints.md +20 -0
  278. data/docs/UpdateCustomerRequest.md +30 -0
  279. data/docs/UpdateDeployment.md +22 -0
  280. data/docs/UpdateGuardrailRequest.md +18 -0
  281. data/docs/UpdateKeyRequest.md +74 -0
  282. data/docs/UpdateLiteLLMParams.md +88 -0
  283. data/docs/UpdateMCPServerRequest.md +30 -0
  284. data/docs/UpdateTeamMemberPermissionsRequest.md +20 -0
  285. data/docs/UpdateTeamRequest.md +44 -0
  286. data/docs/UpdateUserRequest.md +66 -0
  287. data/docs/UpdatedAt.md +15 -0
  288. data/docs/UpdatedBy.md +15 -0
  289. data/docs/UseInPassThrough.md +15 -0
  290. data/docs/UseLitellmProxy.md +15 -0
  291. data/docs/UserAPIKeyAuth.md +134 -0
  292. data/docs/UserListResponse.md +26 -0
  293. data/docs/VLLMPassThroughApi.md +367 -0
  294. data/docs/ValidationError.md +22 -0
  295. data/docs/ValidationErrorLocInner.md +15 -0
  296. data/docs/ValidationFile.md +15 -0
  297. data/docs/VectorStoreDeleteRequest.md +18 -0
  298. data/docs/VectorStoreManagementApi.md +227 -0
  299. data/docs/VectorStoreMetadata.md +15 -0
  300. data/docs/VertexAIPassThroughApi.md +692 -0
  301. data/docs/VertexCredentials.md +15 -0
  302. data/docs/VertexLocation.md +15 -0
  303. data/docs/VertexProject.md +15 -0
  304. data/docs/WatsonxRegionName.md +15 -0
  305. data/git_push.sh +57 -0
  306. data/lib/litellm_client/api/anthropic_pass_through_api.rb +337 -0
  307. data/lib/litellm_client/api/assembly_ai_pass_through_api.rb +327 -0
  308. data/lib/litellm_client/api/assembly_aieu_pass_through_api.rb +327 -0
  309. data/lib/litellm_client/api/assistants_api.rb +994 -0
  310. data/lib/litellm_client/api/audio_api.rb +274 -0
  311. data/lib/litellm_client/api/audit_logging_api.rb +187 -0
  312. data/lib/litellm_client/api/azure_pass_through_api.rb +337 -0
  313. data/lib/litellm_client/api/batch_api.rb +792 -0
  314. data/lib/litellm_client/api/bedrock_pass_through_api.rb +337 -0
  315. data/lib/litellm_client/api/budget_management_api.rb +415 -0
  316. data/lib/litellm_client/api/budget_spend_tracking_api.rb +649 -0
  317. data/lib/litellm_client/api/caching_api.rb +364 -0
  318. data/lib/litellm_client/api/chat_completions_api.rb +260 -0
  319. data/lib/litellm_client/api/cohere_pass_through_api.rb +337 -0
  320. data/lib/litellm_client/api/completions_api.rb +260 -0
  321. data/lib/litellm_client/api/credential_management_api.rb +415 -0
  322. data/lib/litellm_client/api/customer_management_api.rb +483 -0
  323. data/lib/litellm_client/api/default_api.rb +728 -0
  324. data/lib/litellm_client/api/email_management_api.rb +204 -0
  325. data/lib/litellm_client/api/embeddings_api.rb +260 -0
  326. data/lib/litellm_client/api/files_api.rb +1064 -0
  327. data/lib/litellm_client/api/fine_tuning_api.rb +570 -0
  328. data/lib/litellm_client/api/google_ai_studio_pass_through_api.rb +337 -0
  329. data/lib/litellm_client/api/guardrails_api.rb +723 -0
  330. data/lib/litellm_client/api/health_api.rb +723 -0
  331. data/lib/litellm_client/api/images_api.rb +419 -0
  332. data/lib/litellm_client/api/internal_user_management_api.rb +472 -0
  333. data/lib/litellm_client/api/key_management_api.rb +735 -0
  334. data/lib/litellm_client/api/langfuse_pass_through_api.rb +337 -0
  335. data/lib/litellm_client/api/llm_utils_api.rb +218 -0
  336. data/lib/litellm_client/api/mcp_api.rb +467 -0
  337. data/lib/litellm_client/api/mistral_pass_through_api.rb +337 -0
  338. data/lib/litellm_client/api/model_management_api.rb +618 -0
  339. data/lib/litellm_client/api/moderations_api.rb +136 -0
  340. data/lib/litellm_client/api/open_ai_pass_through_api.rb +337 -0
  341. data/lib/litellm_client/api/organization_management_api.rb +619 -0
  342. data/lib/litellm_client/api/pass_through_api.rb +4097 -0
  343. data/lib/litellm_client/api/rerank_api.rb +187 -0
  344. data/lib/litellm_client/api/responses_api.rb +514 -0
  345. data/lib/litellm_client/api/scimv2_api.rb +862 -0
  346. data/lib/litellm_client/api/sso_settings_api.rb +397 -0
  347. data/lib/litellm_client/api/tag_management_api.rb +429 -0
  348. data/lib/litellm_client/api/team_management_api.rb +1339 -0
  349. data/lib/litellm_client/api/vector_store_management_api.rb +221 -0
  350. data/lib/litellm_client/api/vertex_ai_pass_through_api.rb +652 -0
  351. data/lib/litellm_client/api/vllm_pass_through_api.rb +337 -0
  352. data/lib/litellm_client/api_client.rb +393 -0
  353. data/lib/litellm_client/api_error.rb +58 -0
  354. data/lib/litellm_client/configuration.rb +308 -0
  355. data/lib/litellm_client/models/add_team_callback.rb +309 -0
  356. data/lib/litellm_client/models/annotations.rb +104 -0
  357. data/lib/litellm_client/models/api_base.rb +104 -0
  358. data/lib/litellm_client/models/api_key.rb +104 -0
  359. data/lib/litellm_client/models/api_version.rb +104 -0
  360. data/lib/litellm_client/models/apply_guardrail_request.rb +285 -0
  361. data/lib/litellm_client/models/apply_guardrail_response.rb +237 -0
  362. data/lib/litellm_client/models/audit_log_response.rb +418 -0
  363. data/lib/litellm_client/models/aws_access_key_id.rb +104 -0
  364. data/lib/litellm_client/models/aws_region_name.rb +104 -0
  365. data/lib/litellm_client/models/aws_secret_access_key.rb +104 -0
  366. data/lib/litellm_client/models/base_model.rb +104 -0
  367. data/lib/litellm_client/models/batch_size.rb +104 -0
  368. data/lib/litellm_client/models/block_key_request.rb +237 -0
  369. data/lib/litellm_client/models/block_team_request.rb +237 -0
  370. data/lib/litellm_client/models/block_users.rb +239 -0
  371. data/lib/litellm_client/models/body_test_model_connection_health_test_connection_post.rb +267 -0
  372. data/lib/litellm_client/models/breakdown_metrics.rb +256 -0
  373. data/lib/litellm_client/models/budget_config.rb +251 -0
  374. data/lib/litellm_client/models/budget_delete_request.rb +237 -0
  375. data/lib/litellm_client/models/budget_duration.rb +104 -0
  376. data/lib/litellm_client/models/budget_new_request.rb +303 -0
  377. data/lib/litellm_client/models/budget_request.rb +239 -0
  378. data/lib/litellm_client/models/bytes.rb +104 -0
  379. data/lib/litellm_client/models/cache_control.rb +104 -0
  380. data/lib/litellm_client/models/cache_ping_response.rb +305 -0
  381. data/lib/litellm_client/models/call_types.rb +102 -0
  382. data/lib/litellm_client/models/chat_completion_annotation.rb +263 -0
  383. data/lib/litellm_client/models/chat_completion_annotation_url_citation.rb +247 -0
  384. data/lib/litellm_client/models/chat_completion_audio_response.rb +315 -0
  385. data/lib/litellm_client/models/chat_completion_cached_content.rb +261 -0
  386. data/lib/litellm_client/models/chat_completion_redacted_thinking_block.rb +280 -0
  387. data/lib/litellm_client/models/chat_completion_thinking_block.rb +289 -0
  388. data/lib/litellm_client/models/chat_completion_token_logprob.rb +300 -0
  389. data/lib/litellm_client/models/choice_logprobs.rb +220 -0
  390. data/lib/litellm_client/models/choices.rb +307 -0
  391. data/lib/litellm_client/models/choices1_inner.rb +104 -0
  392. data/lib/litellm_client/models/configurable_clientside_auth_params.rb +104 -0
  393. data/lib/litellm_client/models/configurable_clientside_auth_params_any_of_inner.rb +104 -0
  394. data/lib/litellm_client/models/configurable_clientside_params_custom_auth.rb +237 -0
  395. data/lib/litellm_client/models/content.rb +104 -0
  396. data/lib/litellm_client/models/content1.rb +104 -0
  397. data/lib/litellm_client/models/create_credential_item.rb +287 -0
  398. data/lib/litellm_client/models/create_guardrail_request.rb +237 -0
  399. data/lib/litellm_client/models/created_at.rb +104 -0
  400. data/lib/litellm_client/models/created_by.rb +104 -0
  401. data/lib/litellm_client/models/credential_item.rb +293 -0
  402. data/lib/litellm_client/models/custom_llm_provider.rb +104 -0
  403. data/lib/litellm_client/models/custom_llm_provider1.rb +104 -0
  404. data/lib/litellm_client/models/daily_spend_data.rb +272 -0
  405. data/lib/litellm_client/models/daily_spend_metadata.rb +343 -0
  406. data/lib/litellm_client/models/default_internal_user_params.rb +288 -0
  407. data/lib/litellm_client/models/default_team_settings_response.rb +268 -0
  408. data/lib/litellm_client/models/default_team_sso_params.rb +264 -0
  409. data/lib/litellm_client/models/delete_customer_request.rb +240 -0
  410. data/lib/litellm_client/models/delete_organization_request.rb +239 -0
  411. data/lib/litellm_client/models/delete_team_request.rb +239 -0
  412. data/lib/litellm_client/models/delete_user_request.rb +239 -0
  413. data/lib/litellm_client/models/deployment.rb +289 -0
  414. data/lib/litellm_client/models/description.rb +104 -0
  415. data/lib/litellm_client/models/destructivehint.rb +104 -0
  416. data/lib/litellm_client/models/email_event.rb +40 -0
  417. data/lib/litellm_client/models/email_event_settings.rb +285 -0
  418. data/lib/litellm_client/models/email_event_settings_response.rb +239 -0
  419. data/lib/litellm_client/models/email_event_settings_update_request.rb +239 -0
  420. data/lib/litellm_client/models/endtime.rb +104 -0
  421. data/lib/litellm_client/models/error_response.rb +239 -0
  422. data/lib/litellm_client/models/expires.rb +104 -0
  423. data/lib/litellm_client/models/function_call.rb +246 -0
  424. data/lib/litellm_client/models/generate_key_request.rb +527 -0
  425. data/lib/litellm_client/models/generate_key_response.rb +613 -0
  426. data/lib/litellm_client/models/get_team_member_permissions_response.rb +278 -0
  427. data/lib/litellm_client/models/guardrail.rb +271 -0
  428. data/lib/litellm_client/models/guardrail_info_lite_llm_params_response.rb +286 -0
  429. data/lib/litellm_client/models/guardrail_info_response.rb +334 -0
  430. data/lib/litellm_client/models/http_validation_error.rb +222 -0
  431. data/lib/litellm_client/models/hyperparameters.rb +241 -0
  432. data/lib/litellm_client/models/id.rb +104 -0
  433. data/lib/litellm_client/models/idempotenthint.rb +104 -0
  434. data/lib/litellm_client/models/input_cost_per_pixel.rb +104 -0
  435. data/lib/litellm_client/models/input_cost_per_second.rb +104 -0
  436. data/lib/litellm_client/models/input_cost_per_token.rb +104 -0
  437. data/lib/litellm_client/models/integrations.rb +104 -0
  438. data/lib/litellm_client/models/internal_user_settings_response.rb +268 -0
  439. data/lib/litellm_client/models/ip_address.rb +237 -0
  440. data/lib/litellm_client/models/key_health_response.rb +264 -0
  441. data/lib/litellm_client/models/key_list_response_object.rb +252 -0
  442. data/lib/litellm_client/models/key_list_response_object_keys_inner.rb +104 -0
  443. data/lib/litellm_client/models/key_metadata.rb +232 -0
  444. data/lib/litellm_client/models/key_metric_with_metadata.rb +247 -0
  445. data/lib/litellm_client/models/key_request.rb +235 -0
  446. data/lib/litellm_client/models/lakera_category_thresholds.rb +229 -0
  447. data/lib/litellm_client/models/learning_rate_multiplier.rb +104 -0
  448. data/lib/litellm_client/models/list_guardrails_response.rb +239 -0
  449. data/lib/litellm_client/models/list_mcp_tools_rest_api_response_object.rb +293 -0
  450. data/lib/litellm_client/models/list_mcp_tools_rest_api_response_object_annotations.rb +104 -0
  451. data/lib/litellm_client/models/list_mcp_tools_rest_api_response_object_mcp_info.rb +104 -0
  452. data/lib/litellm_client/models/lite_llm_budget_table.rb +294 -0
  453. data/lib/litellm_client/models/lite_llm_end_user_table.rb +348 -0
  454. data/lib/litellm_client/models/lite_llm_fine_tuning_job_create.rb +317 -0
  455. data/lib/litellm_client/models/lite_llm_fine_tuning_job_create_hyperparameters.rb +104 -0
  456. data/lib/litellm_client/models/lite_llm_managed_vector_store.rb +290 -0
  457. data/lib/litellm_client/models/lite_llm_managed_vector_store_list_response.rb +296 -0
  458. data/lib/litellm_client/models/lite_llm_model_table.rb +293 -0
  459. data/lib/litellm_client/models/lite_llm_object_permission_base.rb +235 -0
  460. data/lib/litellm_client/models/lite_llm_object_permission_table.rb +262 -0
  461. data/lib/litellm_client/models/lite_llm_organization_membership_table.rb +367 -0
  462. data/lib/litellm_client/models/lite_llm_organization_table_update.rb +296 -0
  463. data/lib/litellm_client/models/lite_llm_organization_table_with_members.rb +477 -0
  464. data/lib/litellm_client/models/lite_llm_params.rb +553 -0
  465. data/lib/litellm_client/models/lite_llm_spend_logs.rb +457 -0
  466. data/lib/litellm_client/models/lite_llm_team_membership.rb +285 -0
  467. data/lib/litellm_client/models/lite_llm_team_table.rb +466 -0
  468. data/lib/litellm_client/models/lite_llm_user_table.rb +438 -0
  469. data/lib/litellm_client/models/lite_llm_user_table_with_key_count.rb +449 -0
  470. data/lib/litellm_client/models/lite_llm_verification_token.rb +546 -0
  471. data/lib/litellm_client/models/lite_llmmcp_server_table.rb +424 -0
  472. data/lib/litellm_client/models/litellm_credential_name.rb +104 -0
  473. data/lib/litellm_client/models/litellm_params.rb +632 -0
  474. data/lib/litellm_client/models/litellm_trace_id.rb +104 -0
  475. data/lib/litellm_client/models/litellm_user_roles.rb +45 -0
  476. data/lib/litellm_client/models/logging_callback_status.rb +275 -0
  477. data/lib/litellm_client/models/logprobs.rb +105 -0
  478. data/lib/litellm_client/models/max_budget.rb +104 -0
  479. data/lib/litellm_client/models/max_file_size_mb.rb +104 -0
  480. data/lib/litellm_client/models/max_retries.rb +104 -0
  481. data/lib/litellm_client/models/mcp_info.rb +240 -0
  482. data/lib/litellm_client/models/member.rb +281 -0
  483. data/lib/litellm_client/models/member1.rb +104 -0
  484. data/lib/litellm_client/models/member2.rb +104 -0
  485. data/lib/litellm_client/models/merge_reasoning_content_in_choices.rb +104 -0
  486. data/lib/litellm_client/models/message.rb +384 -0
  487. data/lib/litellm_client/models/message_audio.rb +104 -0
  488. data/lib/litellm_client/models/message_function_call.rb +104 -0
  489. data/lib/litellm_client/models/messages.rb +105 -0
  490. data/lib/litellm_client/models/metric_with_metadata.rb +248 -0
  491. data/lib/litellm_client/models/mock_response.rb +106 -0
  492. data/lib/litellm_client/models/mode.rb +104 -0
  493. data/lib/litellm_client/models/mode1.rb +105 -0
  494. data/lib/litellm_client/models/model.rb +104 -0
  495. data/lib/litellm_client/models/model_aliases.rb +104 -0
  496. data/lib/litellm_client/models/model_info.rb +104 -0
  497. data/lib/litellm_client/models/model_info_delete.rb +237 -0
  498. data/lib/litellm_client/models/model_response.rb +335 -0
  499. data/lib/litellm_client/models/n_epochs.rb +104 -0
  500. data/lib/litellm_client/models/name.rb +104 -0
  501. data/lib/litellm_client/models/new_customer_request.rb +415 -0
  502. data/lib/litellm_client/models/new_mcp_server_request.rb +357 -0
  503. data/lib/litellm_client/models/new_organization_request.rb +362 -0
  504. data/lib/litellm_client/models/new_organization_response.rb +470 -0
  505. data/lib/litellm_client/models/new_team_request.rb +406 -0
  506. data/lib/litellm_client/models/new_user_request.rb +570 -0
  507. data/lib/litellm_client/models/new_user_response.rb +689 -0
  508. data/lib/litellm_client/models/openworldhint.rb +104 -0
  509. data/lib/litellm_client/models/org_member.rb +281 -0
  510. data/lib/litellm_client/models/organization.rb +104 -0
  511. data/lib/litellm_client/models/organization_add_member_response.rb +293 -0
  512. data/lib/litellm_client/models/organization_member_add_request.rb +273 -0
  513. data/lib/litellm_client/models/organization_member_delete_request.rb +257 -0
  514. data/lib/litellm_client/models/organization_member_update_request.rb +299 -0
  515. data/lib/litellm_client/models/organization_request.rb +239 -0
  516. data/lib/litellm_client/models/output_cost_per_pixel.rb +104 -0
  517. data/lib/litellm_client/models/output_cost_per_second.rb +104 -0
  518. data/lib/litellm_client/models/output_cost_per_token.rb +104 -0
  519. data/lib/litellm_client/models/paginated_audit_log_response.rb +348 -0
  520. data/lib/litellm_client/models/pass_through_endpoint_response.rb +239 -0
  521. data/lib/litellm_client/models/pass_through_generic_endpoint.rb +294 -0
  522. data/lib/litellm_client/models/patch_guardrail_litellm_params.rb +233 -0
  523. data/lib/litellm_client/models/patch_guardrail_request.rb +243 -0
  524. data/lib/litellm_client/models/pii_action.rb +40 -0
  525. data/lib/litellm_client/models/pii_entity_type.rb +77 -0
  526. data/lib/litellm_client/models/provider_budget_response.rb +223 -0
  527. data/lib/litellm_client/models/provider_budget_response_object.rb +256 -0
  528. data/lib/litellm_client/models/provider_specific_fields.rb +104 -0
  529. data/lib/litellm_client/models/raw_request_typed_dict.rb +255 -0
  530. data/lib/litellm_client/models/readonlyhint.rb +104 -0
  531. data/lib/litellm_client/models/reasoning_content.rb +104 -0
  532. data/lib/litellm_client/models/regenerate_key_request.rb +537 -0
  533. data/lib/litellm_client/models/region_name.rb +104 -0
  534. data/lib/litellm_client/models/resources.rb +104 -0
  535. data/lib/litellm_client/models/response.rb +105 -0
  536. data/lib/litellm_client/models/rpm.rb +104 -0
  537. data/lib/litellm_client/models/scim_group.rb +309 -0
  538. data/lib/litellm_client/models/scim_list_response.rb +294 -0
  539. data/lib/litellm_client/models/scim_member.rb +247 -0
  540. data/lib/litellm_client/models/scim_patch_op.rb +250 -0
  541. data/lib/litellm_client/models/scim_patch_operation.rb +257 -0
  542. data/lib/litellm_client/models/scim_user.rb +368 -0
  543. data/lib/litellm_client/models/scim_user_email.rb +257 -0
  544. data/lib/litellm_client/models/scim_user_group.rb +257 -0
  545. data/lib/litellm_client/models/scim_user_name.rb +303 -0
  546. data/lib/litellm_client/models/seed.rb +104 -0
  547. data/lib/litellm_client/models/service.rb +104 -0
  548. data/lib/litellm_client/models/spend_analytics_paginated_response.rb +248 -0
  549. data/lib/litellm_client/models/spend_calculate_request.rb +245 -0
  550. data/lib/litellm_client/models/spend_metrics.rb +310 -0
  551. data/lib/litellm_client/models/sso_config.rb +332 -0
  552. data/lib/litellm_client/models/sso_settings_response.rb +268 -0
  553. data/lib/litellm_client/models/starttime.rb +104 -0
  554. data/lib/litellm_client/models/stream_timeout.rb +105 -0
  555. data/lib/litellm_client/models/suffix.rb +104 -0
  556. data/lib/litellm_client/models/system_fingerprint.rb +104 -0
  557. data/lib/litellm_client/models/tag_config.rb +333 -0
  558. data/lib/litellm_client/models/tag_delete_request.rb +237 -0
  559. data/lib/litellm_client/models/tag_info_request.rb +239 -0
  560. data/lib/litellm_client/models/tag_new_request.rb +271 -0
  561. data/lib/litellm_client/models/tag_update_request.rb +271 -0
  562. data/lib/litellm_client/models/team_add_member_response.rb +522 -0
  563. data/lib/litellm_client/models/team_id.rb +104 -0
  564. data/lib/litellm_client/models/team_list_response.rb +344 -0
  565. data/lib/litellm_client/models/team_member_add_request.rb +273 -0
  566. data/lib/litellm_client/models/team_member_delete_request.rb +257 -0
  567. data/lib/litellm_client/models/team_member_update_request.rb +311 -0
  568. data/lib/litellm_client/models/team_member_update_response.rb +283 -0
  569. data/lib/litellm_client/models/team_model_add_request.rb +266 -0
  570. data/lib/litellm_client/models/team_model_delete_request.rb +266 -0
  571. data/lib/litellm_client/models/team_public_model_name.rb +104 -0
  572. data/lib/litellm_client/models/thinking_blocks.rb +104 -0
  573. data/lib/litellm_client/models/thinking_blocks_any_of_inner.rb +104 -0
  574. data/lib/litellm_client/models/tier.rb +104 -0
  575. data/lib/litellm_client/models/timeout.rb +105 -0
  576. data/lib/litellm_client/models/title.rb +104 -0
  577. data/lib/litellm_client/models/token_count_request.rb +259 -0
  578. data/lib/litellm_client/models/token_count_response.rb +315 -0
  579. data/lib/litellm_client/models/tool_annotations.rb +257 -0
  580. data/lib/litellm_client/models/tool_calls.rb +104 -0
  581. data/lib/litellm_client/models/top_logprob.rb +272 -0
  582. data/lib/litellm_client/models/tpm.rb +104 -0
  583. data/lib/litellm_client/models/transform_request_body.rb +287 -0
  584. data/lib/litellm_client/models/ui_discovery_endpoints.rb +249 -0
  585. data/lib/litellm_client/models/update_customer_request.rb +333 -0
  586. data/lib/litellm_client/models/update_deployment.rb +241 -0
  587. data/lib/litellm_client/models/update_guardrail_request.rb +237 -0
  588. data/lib/litellm_client/models/update_key_request.rb +543 -0
  589. data/lib/litellm_client/models/update_lite_llm_params.rb +535 -0
  590. data/lib/litellm_client/models/update_mcp_server_request.rb +373 -0
  591. data/lib/litellm_client/models/update_team_member_permissions_request.rb +266 -0
  592. data/lib/litellm_client/models/update_team_request.rb +378 -0
  593. data/lib/litellm_client/models/update_user_request.rb +515 -0
  594. data/lib/litellm_client/models/updated_at.rb +104 -0
  595. data/lib/litellm_client/models/updated_by.rb +104 -0
  596. data/lib/litellm_client/models/use_in_pass_through.rb +104 -0
  597. data/lib/litellm_client/models/use_litellm_proxy.rb +104 -0
  598. data/lib/litellm_client/models/user_api_key_auth.rb +861 -0
  599. data/lib/litellm_client/models/user_list_response.rb +344 -0
  600. data/lib/litellm_client/models/validation_error.rb +291 -0
  601. data/lib/litellm_client/models/validation_error_loc_inner.rb +104 -0
  602. data/lib/litellm_client/models/validation_file.rb +104 -0
  603. data/lib/litellm_client/models/vector_store_delete_request.rb +237 -0
  604. data/lib/litellm_client/models/vector_store_metadata.rb +104 -0
  605. data/lib/litellm_client/models/vertex_credentials.rb +105 -0
  606. data/lib/litellm_client/models/vertex_location.rb +104 -0
  607. data/lib/litellm_client/models/vertex_project.rb +104 -0
  608. data/lib/litellm_client/models/watsonx_region_name.rb +104 -0
  609. data/lib/litellm_client/version.rb +15 -0
  610. data/lib/litellm_client.rb +339 -0
  611. data/litellm_client.gemspec +39 -0
  612. data/spec/api/anthropic_pass_through_api_spec.rb +95 -0
  613. data/spec/api/assembly_ai_pass_through_api_spec.rb +90 -0
  614. data/spec/api/assembly_aieu_pass_through_api_spec.rb +90 -0
  615. data/spec/api/assistants_api_spec.rb +221 -0
  616. data/spec/api/audio_api_spec.rb +81 -0
  617. data/spec/api/audit_logging_api_spec.rb +69 -0
  618. data/spec/api/azure_pass_through_api_spec.rb +95 -0
  619. data/spec/api/batch_api_spec.rb +191 -0
  620. data/spec/api/bedrock_pass_through_api_spec.rb +95 -0
  621. data/spec/api/budget_management_api_spec.rb +106 -0
  622. data/spec/api/budget_spend_tracking_api_spec.rb +158 -0
  623. data/spec/api/caching_api_spec.rb +101 -0
  624. data/spec/api/chat_completions_api_spec.rb +83 -0
  625. data/spec/api/cohere_pass_through_api_spec.rb +95 -0
  626. data/spec/api/completions_api_spec.rb +83 -0
  627. data/spec/api/credential_management_api_spec.rb +109 -0
  628. data/spec/api/customer_management_api_spec.rb +118 -0
  629. data/spec/api/default_api_spec.rb +168 -0
  630. data/spec/api/email_management_api_spec.rb +69 -0
  631. data/spec/api/embeddings_api_spec.rb +83 -0
  632. data/spec/api/files_api_spec.rb +242 -0
  633. data/spec/api/fine_tuning_api_spec.rb +139 -0
  634. data/spec/api/google_ai_studio_pass_through_api_spec.rb +95 -0
  635. data/spec/api/guardrails_api_spec.rb +165 -0
  636. data/spec/api/health_api_spec.rb +170 -0
  637. data/spec/api/images_api_spec.rb +110 -0
  638. data/spec/api/internal_user_management_api_spec.rb +121 -0
  639. data/spec/api/key_management_api_spec.rb +173 -0
  640. data/spec/api/langfuse_pass_through_api_spec.rb +95 -0
  641. data/spec/api/llm_utils_api_spec.rb +69 -0
  642. data/spec/api/mcp_api_spec.rb +120 -0
  643. data/spec/api/mistral_pass_through_api_spec.rb +95 -0
  644. data/spec/api/model_management_api_spec.rb +150 -0
  645. data/spec/api/moderations_api_spec.rb +57 -0
  646. data/spec/api/open_ai_pass_through_api_spec.rb +95 -0
  647. data/spec/api/organization_management_api_spec.rb +142 -0
  648. data/spec/api/pass_through_api_spec.rb +805 -0
  649. data/spec/api/rerank_api_spec.rb +65 -0
  650. data/spec/api/responses_api_spec.rb +129 -0
  651. data/spec/api/scimv2_api_spec.rb +187 -0
  652. data/spec/api/sso_settings_api_spec.rb +104 -0
  653. data/spec/api/tag_management_api_spec.rb +112 -0
  654. data/spec/api/team_management_api_spec.rb +283 -0
  655. data/spec/api/vector_store_management_api_spec.rb +72 -0
  656. data/spec/api/vertex_ai_pass_through_api_spec.rb +155 -0
  657. data/spec/api/vllm_pass_through_api_spec.rb +95 -0
  658. data/spec/models/add_team_callback_spec.rb +52 -0
  659. data/spec/models/annotations_spec.rb +21 -0
  660. data/spec/models/api_base_spec.rb +21 -0
  661. data/spec/models/api_key_spec.rb +21 -0
  662. data/spec/models/api_version_spec.rb +21 -0
  663. data/spec/models/apply_guardrail_request_spec.rb +54 -0
  664. data/spec/models/apply_guardrail_response_spec.rb +36 -0
  665. data/spec/models/audit_log_response_spec.rb +84 -0
  666. data/spec/models/aws_access_key_id_spec.rb +21 -0
  667. data/spec/models/aws_region_name_spec.rb +21 -0
  668. data/spec/models/aws_secret_access_key_spec.rb +21 -0
  669. data/spec/models/base_model_spec.rb +21 -0
  670. data/spec/models/batch_size_spec.rb +21 -0
  671. data/spec/models/block_key_request_spec.rb +36 -0
  672. data/spec/models/block_team_request_spec.rb +36 -0
  673. data/spec/models/block_users_spec.rb +36 -0
  674. data/spec/models/body_test_model_connection_health_test_connection_post_spec.rb +46 -0
  675. data/spec/models/breakdown_metrics_spec.rb +54 -0
  676. data/spec/models/budget_config_spec.rb +54 -0
  677. data/spec/models/budget_delete_request_spec.rb +36 -0
  678. data/spec/models/budget_duration_spec.rb +21 -0
  679. data/spec/models/budget_new_request_spec.rb +84 -0
  680. data/spec/models/budget_request_spec.rb +36 -0
  681. data/spec/models/bytes_spec.rb +21 -0
  682. data/spec/models/cache_control_spec.rb +21 -0
  683. data/spec/models/cache_ping_response_spec.rb +66 -0
  684. data/spec/models/call_types_spec.rb +30 -0
  685. data/spec/models/chat_completion_annotation_spec.rb +46 -0
  686. data/spec/models/chat_completion_annotation_url_citation_spec.rb +54 -0
  687. data/spec/models/chat_completion_audio_response_spec.rb +54 -0
  688. data/spec/models/chat_completion_cached_content_spec.rb +40 -0
  689. data/spec/models/chat_completion_redacted_thinking_block_spec.rb +52 -0
  690. data/spec/models/chat_completion_thinking_block_spec.rb +58 -0
  691. data/spec/models/chat_completion_token_logprob_spec.rb +54 -0
  692. data/spec/models/choice_logprobs_spec.rb +36 -0
  693. data/spec/models/choices1_inner_spec.rb +21 -0
  694. data/spec/models/choices_spec.rb +60 -0
  695. data/spec/models/configurable_clientside_auth_params_any_of_inner_spec.rb +21 -0
  696. data/spec/models/configurable_clientside_auth_params_spec.rb +21 -0
  697. data/spec/models/configurable_clientside_params_custom_auth_spec.rb +36 -0
  698. data/spec/models/content1_spec.rb +21 -0
  699. data/spec/models/content_spec.rb +21 -0
  700. data/spec/models/create_credential_item_spec.rb +54 -0
  701. data/spec/models/create_guardrail_request_spec.rb +36 -0
  702. data/spec/models/created_at_spec.rb +21 -0
  703. data/spec/models/created_by_spec.rb +21 -0
  704. data/spec/models/credential_item_spec.rb +48 -0
  705. data/spec/models/custom_llm_provider1_spec.rb +21 -0
  706. data/spec/models/custom_llm_provider_spec.rb +21 -0
  707. data/spec/models/daily_spend_data_spec.rb +48 -0
  708. data/spec/models/daily_spend_metadata_spec.rb +102 -0
  709. data/spec/models/default_internal_user_params_spec.rb +58 -0
  710. data/spec/models/default_team_settings_response_spec.rb +42 -0
  711. data/spec/models/default_team_sso_params_spec.rb +60 -0
  712. data/spec/models/delete_customer_request_spec.rb +36 -0
  713. data/spec/models/delete_organization_request_spec.rb +36 -0
  714. data/spec/models/delete_team_request_spec.rb +36 -0
  715. data/spec/models/delete_user_request_spec.rb +36 -0
  716. data/spec/models/deployment_spec.rb +48 -0
  717. data/spec/models/description_spec.rb +21 -0
  718. data/spec/models/destructivehint_spec.rb +21 -0
  719. data/spec/models/email_event_settings_response_spec.rb +36 -0
  720. data/spec/models/email_event_settings_spec.rb +42 -0
  721. data/spec/models/email_event_settings_update_request_spec.rb +36 -0
  722. data/spec/models/email_event_spec.rb +30 -0
  723. data/spec/models/endtime_spec.rb +21 -0
  724. data/spec/models/error_response_spec.rb +36 -0
  725. data/spec/models/expires_spec.rb +21 -0
  726. data/spec/models/function_call_spec.rb +42 -0
  727. data/spec/models/generate_key_request_spec.rb +204 -0
  728. data/spec/models/generate_key_response_spec.rb +246 -0
  729. data/spec/models/get_team_member_permissions_response_spec.rb +48 -0
  730. data/spec/models/guardrail_info_lite_llm_params_response_spec.rb +54 -0
  731. data/spec/models/guardrail_info_response_spec.rb +76 -0
  732. data/spec/models/guardrail_spec.rb +66 -0
  733. data/spec/models/http_validation_error_spec.rb +36 -0
  734. data/spec/models/hyperparameters_spec.rb +48 -0
  735. data/spec/models/id_spec.rb +21 -0
  736. data/spec/models/idempotenthint_spec.rb +21 -0
  737. data/spec/models/input_cost_per_pixel_spec.rb +21 -0
  738. data/spec/models/input_cost_per_second_spec.rb +21 -0
  739. data/spec/models/input_cost_per_token_spec.rb +21 -0
  740. data/spec/models/integrations_spec.rb +21 -0
  741. data/spec/models/internal_user_settings_response_spec.rb +42 -0
  742. data/spec/models/ip_address_spec.rb +36 -0
  743. data/spec/models/key_health_response_spec.rb +46 -0
  744. data/spec/models/key_list_response_object_keys_inner_spec.rb +21 -0
  745. data/spec/models/key_list_response_object_spec.rb +54 -0
  746. data/spec/models/key_metadata_spec.rb +42 -0
  747. data/spec/models/key_metric_with_metadata_spec.rb +42 -0
  748. data/spec/models/key_request_spec.rb +42 -0
  749. data/spec/models/lakera_category_thresholds_spec.rb +42 -0
  750. data/spec/models/learning_rate_multiplier_spec.rb +21 -0
  751. data/spec/models/list_guardrails_response_spec.rb +36 -0
  752. data/spec/models/list_mcp_tools_rest_api_response_object_annotations_spec.rb +21 -0
  753. data/spec/models/list_mcp_tools_rest_api_response_object_mcp_info_spec.rb +21 -0
  754. data/spec/models/list_mcp_tools_rest_api_response_object_spec.rb +60 -0
  755. data/spec/models/lite_llm_budget_table_spec.rb +78 -0
  756. data/spec/models/lite_llm_end_user_table_spec.rb +76 -0
  757. data/spec/models/lite_llm_fine_tuning_job_create_hyperparameters_spec.rb +21 -0
  758. data/spec/models/lite_llm_fine_tuning_job_create_spec.rb +78 -0
  759. data/spec/models/lite_llm_managed_vector_store_list_response_spec.rb +64 -0
  760. data/spec/models/lite_llm_managed_vector_store_spec.rb +78 -0
  761. data/spec/models/lite_llm_model_table_spec.rb +60 -0
  762. data/spec/models/lite_llm_object_permission_base_spec.rb +42 -0
  763. data/spec/models/lite_llm_object_permission_table_spec.rb +48 -0
  764. data/spec/models/lite_llm_organization_membership_table_spec.rb +84 -0
  765. data/spec/models/lite_llm_organization_table_update_spec.rb +78 -0
  766. data/spec/models/lite_llm_organization_table_with_members_spec.rb +126 -0
  767. data/spec/models/lite_llm_params_spec.rb +246 -0
  768. data/spec/models/lite_llm_spend_logs_spec.rb +144 -0
  769. data/spec/models/lite_llm_team_membership_spec.rb +54 -0
  770. data/spec/models/lite_llm_team_table_spec.rb +168 -0
  771. data/spec/models/lite_llm_user_table_spec.rb +150 -0
  772. data/spec/models/lite_llm_user_table_with_key_count_spec.rb +156 -0
  773. data/spec/models/lite_llm_verification_token_spec.rb +222 -0
  774. data/spec/models/lite_llmmcp_server_table_spec.rb +108 -0
  775. data/spec/models/litellm_credential_name_spec.rb +21 -0
  776. data/spec/models/litellm_params_spec.rb +258 -0
  777. data/spec/models/litellm_trace_id_spec.rb +21 -0
  778. data/spec/models/litellm_user_roles_spec.rb +30 -0
  779. data/spec/models/logging_callback_status_spec.rb +52 -0
  780. data/spec/models/logprobs_spec.rb +21 -0
  781. data/spec/models/max_budget_spec.rb +21 -0
  782. data/spec/models/max_file_size_mb_spec.rb +21 -0
  783. data/spec/models/max_retries_spec.rb +21 -0
  784. data/spec/models/mcp_info_spec.rb +48 -0
  785. data/spec/models/member1_spec.rb +21 -0
  786. data/spec/models/member2_spec.rb +21 -0
  787. data/spec/models/member_spec.rb +52 -0
  788. data/spec/models/merge_reasoning_content_in_choices_spec.rb +21 -0
  789. data/spec/models/message_audio_spec.rb +21 -0
  790. data/spec/models/message_function_call_spec.rb +21 -0
  791. data/spec/models/message_spec.rb +88 -0
  792. data/spec/models/messages_spec.rb +21 -0
  793. data/spec/models/metric_with_metadata_spec.rb +42 -0
  794. data/spec/models/mock_response_spec.rb +21 -0
  795. data/spec/models/mode1_spec.rb +21 -0
  796. data/spec/models/mode_spec.rb +21 -0
  797. data/spec/models/model_aliases_spec.rb +21 -0
  798. data/spec/models/model_info_delete_spec.rb +36 -0
  799. data/spec/models/model_info_spec.rb +21 -0
  800. data/spec/models/model_response_spec.rb +66 -0
  801. data/spec/models/model_spec.rb +21 -0
  802. data/spec/models/n_epochs_spec.rb +21 -0
  803. data/spec/models/name_spec.rb +21 -0
  804. data/spec/models/new_customer_request_spec.rb +124 -0
  805. data/spec/models/new_mcp_server_request_spec.rb +84 -0
  806. data/spec/models/new_organization_request_spec.rb +108 -0
  807. data/spec/models/new_organization_response_spec.rb +114 -0
  808. data/spec/models/new_team_request_spec.rb +138 -0
  809. data/spec/models/new_user_request_spec.rb +214 -0
  810. data/spec/models/new_user_response_spec.rb +274 -0
  811. data/spec/models/openworldhint_spec.rb +21 -0
  812. data/spec/models/org_member_spec.rb +52 -0
  813. data/spec/models/organization_add_member_response_spec.rb +48 -0
  814. data/spec/models/organization_member_add_request_spec.rb +48 -0
  815. data/spec/models/organization_member_delete_request_spec.rb +48 -0
  816. data/spec/models/organization_member_update_request_spec.rb +60 -0
  817. data/spec/models/organization_request_spec.rb +36 -0
  818. data/spec/models/organization_spec.rb +21 -0
  819. data/spec/models/output_cost_per_pixel_spec.rb +21 -0
  820. data/spec/models/output_cost_per_second_spec.rb +21 -0
  821. data/spec/models/output_cost_per_token_spec.rb +21 -0
  822. data/spec/models/paginated_audit_log_response_spec.rb +60 -0
  823. data/spec/models/pass_through_endpoint_response_spec.rb +36 -0
  824. data/spec/models/pass_through_generic_endpoint_spec.rb +48 -0
  825. data/spec/models/patch_guardrail_litellm_params_spec.rb +42 -0
  826. data/spec/models/patch_guardrail_request_spec.rb +48 -0
  827. data/spec/models/pii_action_spec.rb +30 -0
  828. data/spec/models/pii_entity_type_spec.rb +30 -0
  829. data/spec/models/provider_budget_response_object_spec.rb +54 -0
  830. data/spec/models/provider_budget_response_spec.rb +36 -0
  831. data/spec/models/provider_specific_fields_spec.rb +21 -0
  832. data/spec/models/raw_request_typed_dict_spec.rb +54 -0
  833. data/spec/models/readonlyhint_spec.rb +21 -0
  834. data/spec/models/reasoning_content_spec.rb +21 -0
  835. data/spec/models/regenerate_key_request_spec.rb +210 -0
  836. data/spec/models/region_name_spec.rb +21 -0
  837. data/spec/models/resources_spec.rb +21 -0
  838. data/spec/models/response_spec.rb +21 -0
  839. data/spec/models/rpm_spec.rb +21 -0
  840. data/spec/models/scim_group_spec.rb +66 -0
  841. data/spec/models/scim_list_response_spec.rb +60 -0
  842. data/spec/models/scim_member_spec.rb +42 -0
  843. data/spec/models/scim_patch_op_spec.rb +42 -0
  844. data/spec/models/scim_patch_operation_spec.rb +48 -0
  845. data/spec/models/scim_user_email_spec.rb +48 -0
  846. data/spec/models/scim_user_group_spec.rb +48 -0
  847. data/spec/models/scim_user_name_spec.rb +66 -0
  848. data/spec/models/scim_user_spec.rb +90 -0
  849. data/spec/models/seed_spec.rb +21 -0
  850. data/spec/models/service_spec.rb +21 -0
  851. data/spec/models/spend_analytics_paginated_response_spec.rb +42 -0
  852. data/spec/models/spend_calculate_request_spec.rb +48 -0
  853. data/spec/models/spend_metrics_spec.rb +84 -0
  854. data/spec/models/sso_config_spec.rb +102 -0
  855. data/spec/models/sso_settings_response_spec.rb +42 -0
  856. data/spec/models/starttime_spec.rb +21 -0
  857. data/spec/models/stream_timeout_spec.rb +21 -0
  858. data/spec/models/suffix_spec.rb +21 -0
  859. data/spec/models/system_fingerprint_spec.rb +21 -0
  860. data/spec/models/tag_config_spec.rb +72 -0
  861. data/spec/models/tag_delete_request_spec.rb +36 -0
  862. data/spec/models/tag_info_request_spec.rb +36 -0
  863. data/spec/models/tag_new_request_spec.rb +54 -0
  864. data/spec/models/tag_update_request_spec.rb +54 -0
  865. data/spec/models/team_add_member_response_spec.rb +180 -0
  866. data/spec/models/team_id_spec.rb +21 -0
  867. data/spec/models/team_list_response_spec.rb +60 -0
  868. data/spec/models/team_member_add_request_spec.rb +48 -0
  869. data/spec/models/team_member_delete_request_spec.rb +48 -0
  870. data/spec/models/team_member_update_request_spec.rb +64 -0
  871. data/spec/models/team_member_update_response_spec.rb +54 -0
  872. data/spec/models/team_model_add_request_spec.rb +42 -0
  873. data/spec/models/team_model_delete_request_spec.rb +42 -0
  874. data/spec/models/team_public_model_name_spec.rb +21 -0
  875. data/spec/models/thinking_blocks_any_of_inner_spec.rb +21 -0
  876. data/spec/models/thinking_blocks_spec.rb +21 -0
  877. data/spec/models/tier_spec.rb +21 -0
  878. data/spec/models/timeout_spec.rb +21 -0
  879. data/spec/models/title_spec.rb +21 -0
  880. data/spec/models/token_count_request_spec.rb +48 -0
  881. data/spec/models/token_count_response_spec.rb +54 -0
  882. data/spec/models/tool_annotations_spec.rb +60 -0
  883. data/spec/models/tool_calls_spec.rb +21 -0
  884. data/spec/models/top_logprob_spec.rb +48 -0
  885. data/spec/models/tpm_spec.rb +21 -0
  886. data/spec/models/transform_request_body_spec.rb +42 -0
  887. data/spec/models/ui_discovery_endpoints_spec.rb +42 -0
  888. data/spec/models/update_customer_request_spec.rb +76 -0
  889. data/spec/models/update_deployment_spec.rb +48 -0
  890. data/spec/models/update_guardrail_request_spec.rb +36 -0
  891. data/spec/models/update_key_request_spec.rb +204 -0
  892. data/spec/models/update_lite_llm_params_spec.rb +246 -0
  893. data/spec/models/update_mcp_server_request_spec.rb +84 -0
  894. data/spec/models/update_team_member_permissions_request_spec.rb +42 -0
  895. data/spec/models/update_team_request_spec.rb +114 -0
  896. data/spec/models/update_user_request_spec.rb +184 -0
  897. data/spec/models/updated_at_spec.rb +21 -0
  898. data/spec/models/updated_by_spec.rb +21 -0
  899. data/spec/models/use_in_pass_through_spec.rb +21 -0
  900. data/spec/models/use_litellm_proxy_spec.rb +21 -0
  901. data/spec/models/user_api_key_auth_spec.rb +388 -0
  902. data/spec/models/user_list_response_spec.rb +60 -0
  903. data/spec/models/validation_error_loc_inner_spec.rb +21 -0
  904. data/spec/models/validation_error_spec.rb +48 -0
  905. data/spec/models/validation_file_spec.rb +21 -0
  906. data/spec/models/vector_store_delete_request_spec.rb +36 -0
  907. data/spec/models/vector_store_metadata_spec.rb +21 -0
  908. data/spec/models/vertex_credentials_spec.rb +21 -0
  909. data/spec/models/vertex_location_spec.rb +21 -0
  910. data/spec/models/vertex_project_spec.rb +21 -0
  911. data/spec/models/watsonx_region_name_spec.rb +21 -0
  912. data/spec/spec_helper.rb +111 -0
  913. metadata +1298 -0
data/docs/BatchApi.md ADDED
@@ -0,0 +1,913 @@
1
+ # LiteLLMClient::BatchApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**cancel_batch_batches_batch_id_cancel_post**](BatchApi.md#cancel_batch_batches_batch_id_cancel_post) | **POST** /batches/{batch_id}/cancel | Cancel Batch |
8
+ | [**cancel_batch_provider_v1_batches_batch_id_cancel_post**](BatchApi.md#cancel_batch_provider_v1_batches_batch_id_cancel_post) | **POST** /{provider}/v1/batches/{batch_id}/cancel | Cancel Batch |
9
+ | [**cancel_batch_v1_batches_batch_id_cancel_post**](BatchApi.md#cancel_batch_v1_batches_batch_id_cancel_post) | **POST** /v1/batches/{batch_id}/cancel | Cancel Batch |
10
+ | [**create_batch_batches_post**](BatchApi.md#create_batch_batches_post) | **POST** /batches | Create Batch |
11
+ | [**create_batch_provider_v1_batches_post**](BatchApi.md#create_batch_provider_v1_batches_post) | **POST** /{provider}/v1/batches | Create Batch |
12
+ | [**create_batch_v1_batches_post**](BatchApi.md#create_batch_v1_batches_post) | **POST** /v1/batches | Create Batch |
13
+ | [**list_batches_batches_get**](BatchApi.md#list_batches_batches_get) | **GET** /batches | List Batches |
14
+ | [**list_batches_provider_v1_batches_get**](BatchApi.md#list_batches_provider_v1_batches_get) | **GET** /{provider}/v1/batches | List Batches |
15
+ | [**list_batches_v1_batches_get**](BatchApi.md#list_batches_v1_batches_get) | **GET** /v1/batches | List Batches |
16
+ | [**retrieve_batch_batches_batch_id_get**](BatchApi.md#retrieve_batch_batches_batch_id_get) | **GET** /batches/{batch_id} | Retrieve Batch |
17
+ | [**retrieve_batch_provider_v1_batches_batch_id_get**](BatchApi.md#retrieve_batch_provider_v1_batches_batch_id_get) | **GET** /{provider}/v1/batches/{batch_id} | Retrieve Batch |
18
+ | [**retrieve_batch_v1_batches_batch_id_get**](BatchApi.md#retrieve_batch_v1_batches_batch_id_get) | **GET** /v1/batches/{batch_id} | Retrieve Batch |
19
+
20
+
21
+ ## cancel_batch_batches_batch_id_cancel_post
22
+
23
+ > Object cancel_batch_batches_batch_id_cancel_post(batch_id, opts)
24
+
25
+ Cancel Batch
26
+
27
+ Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" -X POST ```
28
+
29
+ ### Examples
30
+
31
+ ```ruby
32
+ require 'time'
33
+ require 'litellm_client'
34
+ # setup authorization
35
+ LiteLLMClient.configure do |config|
36
+ # Configure API key authorization: APIKeyHeader
37
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
38
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
40
+ end
41
+
42
+ api_instance = LiteLLMClient::BatchApi.new
43
+ batch_id = 'batch_id_example' # String |
44
+ opts = {
45
+ provider: 'provider_example' # String |
46
+ }
47
+
48
+ begin
49
+ # Cancel Batch
50
+ result = api_instance.cancel_batch_batches_batch_id_cancel_post(batch_id, opts)
51
+ p result
52
+ rescue LiteLLMClient::ApiError => e
53
+ puts "Error when calling BatchApi->cancel_batch_batches_batch_id_cancel_post: #{e}"
54
+ end
55
+ ```
56
+
57
+ #### Using the cancel_batch_batches_batch_id_cancel_post_with_http_info variant
58
+
59
+ This returns an Array which contains the response data, status code and headers.
60
+
61
+ > <Array(Object, Integer, Hash)> cancel_batch_batches_batch_id_cancel_post_with_http_info(batch_id, opts)
62
+
63
+ ```ruby
64
+ begin
65
+ # Cancel Batch
66
+ data, status_code, headers = api_instance.cancel_batch_batches_batch_id_cancel_post_with_http_info(batch_id, opts)
67
+ p status_code # => 2xx
68
+ p headers # => { ... }
69
+ p data # => Object
70
+ rescue LiteLLMClient::ApiError => e
71
+ puts "Error when calling BatchApi->cancel_batch_batches_batch_id_cancel_post_with_http_info: #{e}"
72
+ end
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+ | Name | Type | Description | Notes |
78
+ | ---- | ---- | ----------- | ----- |
79
+ | **batch_id** | **String** | | |
80
+ | **provider** | **String** | | [optional] |
81
+
82
+ ### Return type
83
+
84
+ **Object**
85
+
86
+ ### Authorization
87
+
88
+ [APIKeyHeader](../README.md#APIKeyHeader)
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: Not defined
93
+ - **Accept**: application/json
94
+
95
+
96
+ ## cancel_batch_provider_v1_batches_batch_id_cancel_post
97
+
98
+ > Object cancel_batch_provider_v1_batches_batch_id_cancel_post(batch_id, provider)
99
+
100
+ Cancel Batch
101
+
102
+ Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" -X POST ```
103
+
104
+ ### Examples
105
+
106
+ ```ruby
107
+ require 'time'
108
+ require 'litellm_client'
109
+ # setup authorization
110
+ LiteLLMClient.configure do |config|
111
+ # Configure API key authorization: APIKeyHeader
112
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
113
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
114
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
115
+ end
116
+
117
+ api_instance = LiteLLMClient::BatchApi.new
118
+ batch_id = 'batch_id_example' # String |
119
+ provider = 'provider_example' # String |
120
+
121
+ begin
122
+ # Cancel Batch
123
+ result = api_instance.cancel_batch_provider_v1_batches_batch_id_cancel_post(batch_id, provider)
124
+ p result
125
+ rescue LiteLLMClient::ApiError => e
126
+ puts "Error when calling BatchApi->cancel_batch_provider_v1_batches_batch_id_cancel_post: #{e}"
127
+ end
128
+ ```
129
+
130
+ #### Using the cancel_batch_provider_v1_batches_batch_id_cancel_post_with_http_info variant
131
+
132
+ This returns an Array which contains the response data, status code and headers.
133
+
134
+ > <Array(Object, Integer, Hash)> cancel_batch_provider_v1_batches_batch_id_cancel_post_with_http_info(batch_id, provider)
135
+
136
+ ```ruby
137
+ begin
138
+ # Cancel Batch
139
+ data, status_code, headers = api_instance.cancel_batch_provider_v1_batches_batch_id_cancel_post_with_http_info(batch_id, provider)
140
+ p status_code # => 2xx
141
+ p headers # => { ... }
142
+ p data # => Object
143
+ rescue LiteLLMClient::ApiError => e
144
+ puts "Error when calling BatchApi->cancel_batch_provider_v1_batches_batch_id_cancel_post_with_http_info: #{e}"
145
+ end
146
+ ```
147
+
148
+ ### Parameters
149
+
150
+ | Name | Type | Description | Notes |
151
+ | ---- | ---- | ----------- | ----- |
152
+ | **batch_id** | **String** | | |
153
+ | **provider** | **String** | | |
154
+
155
+ ### Return type
156
+
157
+ **Object**
158
+
159
+ ### Authorization
160
+
161
+ [APIKeyHeader](../README.md#APIKeyHeader)
162
+
163
+ ### HTTP request headers
164
+
165
+ - **Content-Type**: Not defined
166
+ - **Accept**: application/json
167
+
168
+
169
+ ## cancel_batch_v1_batches_batch_id_cancel_post
170
+
171
+ > Object cancel_batch_v1_batches_batch_id_cancel_post(batch_id, opts)
172
+
173
+ Cancel Batch
174
+
175
+ Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123/cancel -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" -X POST ```
176
+
177
+ ### Examples
178
+
179
+ ```ruby
180
+ require 'time'
181
+ require 'litellm_client'
182
+ # setup authorization
183
+ LiteLLMClient.configure do |config|
184
+ # Configure API key authorization: APIKeyHeader
185
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
186
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
187
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
188
+ end
189
+
190
+ api_instance = LiteLLMClient::BatchApi.new
191
+ batch_id = 'batch_id_example' # String |
192
+ opts = {
193
+ provider: 'provider_example' # String |
194
+ }
195
+
196
+ begin
197
+ # Cancel Batch
198
+ result = api_instance.cancel_batch_v1_batches_batch_id_cancel_post(batch_id, opts)
199
+ p result
200
+ rescue LiteLLMClient::ApiError => e
201
+ puts "Error when calling BatchApi->cancel_batch_v1_batches_batch_id_cancel_post: #{e}"
202
+ end
203
+ ```
204
+
205
+ #### Using the cancel_batch_v1_batches_batch_id_cancel_post_with_http_info variant
206
+
207
+ This returns an Array which contains the response data, status code and headers.
208
+
209
+ > <Array(Object, Integer, Hash)> cancel_batch_v1_batches_batch_id_cancel_post_with_http_info(batch_id, opts)
210
+
211
+ ```ruby
212
+ begin
213
+ # Cancel Batch
214
+ data, status_code, headers = api_instance.cancel_batch_v1_batches_batch_id_cancel_post_with_http_info(batch_id, opts)
215
+ p status_code # => 2xx
216
+ p headers # => { ... }
217
+ p data # => Object
218
+ rescue LiteLLMClient::ApiError => e
219
+ puts "Error when calling BatchApi->cancel_batch_v1_batches_batch_id_cancel_post_with_http_info: #{e}"
220
+ end
221
+ ```
222
+
223
+ ### Parameters
224
+
225
+ | Name | Type | Description | Notes |
226
+ | ---- | ---- | ----------- | ----- |
227
+ | **batch_id** | **String** | | |
228
+ | **provider** | **String** | | [optional] |
229
+
230
+ ### Return type
231
+
232
+ **Object**
233
+
234
+ ### Authorization
235
+
236
+ [APIKeyHeader](../README.md#APIKeyHeader)
237
+
238
+ ### HTTP request headers
239
+
240
+ - **Content-Type**: Not defined
241
+ - **Accept**: application/json
242
+
243
+
244
+ ## create_batch_batches_post
245
+
246
+ > Object create_batch_batches_post(opts)
247
+
248
+ Create Batch
249
+
250
+ Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch Example Curl ``` curl http://localhost:4000/v1/batches -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" -d '{ \"input_file_id\": \"file-abc123\", \"endpoint\": \"/v1/chat/completions\", \"completion_window\": \"24h\" }' ```
251
+
252
+ ### Examples
253
+
254
+ ```ruby
255
+ require 'time'
256
+ require 'litellm_client'
257
+ # setup authorization
258
+ LiteLLMClient.configure do |config|
259
+ # Configure API key authorization: APIKeyHeader
260
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
261
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
262
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
263
+ end
264
+
265
+ api_instance = LiteLLMClient::BatchApi.new
266
+ opts = {
267
+ provider: 'provider_example' # String |
268
+ }
269
+
270
+ begin
271
+ # Create Batch
272
+ result = api_instance.create_batch_batches_post(opts)
273
+ p result
274
+ rescue LiteLLMClient::ApiError => e
275
+ puts "Error when calling BatchApi->create_batch_batches_post: #{e}"
276
+ end
277
+ ```
278
+
279
+ #### Using the create_batch_batches_post_with_http_info variant
280
+
281
+ This returns an Array which contains the response data, status code and headers.
282
+
283
+ > <Array(Object, Integer, Hash)> create_batch_batches_post_with_http_info(opts)
284
+
285
+ ```ruby
286
+ begin
287
+ # Create Batch
288
+ data, status_code, headers = api_instance.create_batch_batches_post_with_http_info(opts)
289
+ p status_code # => 2xx
290
+ p headers # => { ... }
291
+ p data # => Object
292
+ rescue LiteLLMClient::ApiError => e
293
+ puts "Error when calling BatchApi->create_batch_batches_post_with_http_info: #{e}"
294
+ end
295
+ ```
296
+
297
+ ### Parameters
298
+
299
+ | Name | Type | Description | Notes |
300
+ | ---- | ---- | ----------- | ----- |
301
+ | **provider** | **String** | | [optional] |
302
+
303
+ ### Return type
304
+
305
+ **Object**
306
+
307
+ ### Authorization
308
+
309
+ [APIKeyHeader](../README.md#APIKeyHeader)
310
+
311
+ ### HTTP request headers
312
+
313
+ - **Content-Type**: Not defined
314
+ - **Accept**: application/json
315
+
316
+
317
+ ## create_batch_provider_v1_batches_post
318
+
319
+ > Object create_batch_provider_v1_batches_post(provider)
320
+
321
+ Create Batch
322
+
323
+ Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch Example Curl ``` curl http://localhost:4000/v1/batches -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" -d '{ \"input_file_id\": \"file-abc123\", \"endpoint\": \"/v1/chat/completions\", \"completion_window\": \"24h\" }' ```
324
+
325
+ ### Examples
326
+
327
+ ```ruby
328
+ require 'time'
329
+ require 'litellm_client'
330
+ # setup authorization
331
+ LiteLLMClient.configure do |config|
332
+ # Configure API key authorization: APIKeyHeader
333
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
334
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
335
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
336
+ end
337
+
338
+ api_instance = LiteLLMClient::BatchApi.new
339
+ provider = 'provider_example' # String |
340
+
341
+ begin
342
+ # Create Batch
343
+ result = api_instance.create_batch_provider_v1_batches_post(provider)
344
+ p result
345
+ rescue LiteLLMClient::ApiError => e
346
+ puts "Error when calling BatchApi->create_batch_provider_v1_batches_post: #{e}"
347
+ end
348
+ ```
349
+
350
+ #### Using the create_batch_provider_v1_batches_post_with_http_info variant
351
+
352
+ This returns an Array which contains the response data, status code and headers.
353
+
354
+ > <Array(Object, Integer, Hash)> create_batch_provider_v1_batches_post_with_http_info(provider)
355
+
356
+ ```ruby
357
+ begin
358
+ # Create Batch
359
+ data, status_code, headers = api_instance.create_batch_provider_v1_batches_post_with_http_info(provider)
360
+ p status_code # => 2xx
361
+ p headers # => { ... }
362
+ p data # => Object
363
+ rescue LiteLLMClient::ApiError => e
364
+ puts "Error when calling BatchApi->create_batch_provider_v1_batches_post_with_http_info: #{e}"
365
+ end
366
+ ```
367
+
368
+ ### Parameters
369
+
370
+ | Name | Type | Description | Notes |
371
+ | ---- | ---- | ----------- | ----- |
372
+ | **provider** | **String** | | |
373
+
374
+ ### Return type
375
+
376
+ **Object**
377
+
378
+ ### Authorization
379
+
380
+ [APIKeyHeader](../README.md#APIKeyHeader)
381
+
382
+ ### HTTP request headers
383
+
384
+ - **Content-Type**: Not defined
385
+ - **Accept**: application/json
386
+
387
+
388
+ ## create_batch_v1_batches_post
389
+
390
+ > Object create_batch_v1_batches_post(opts)
391
+
392
+ Create Batch
393
+
394
+ Create large batches of API requests for asynchronous processing. This is the equivalent of POST https://api.openai.com/v1/batch Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch Example Curl ``` curl http://localhost:4000/v1/batches -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" -d '{ \"input_file_id\": \"file-abc123\", \"endpoint\": \"/v1/chat/completions\", \"completion_window\": \"24h\" }' ```
395
+
396
+ ### Examples
397
+
398
+ ```ruby
399
+ require 'time'
400
+ require 'litellm_client'
401
+ # setup authorization
402
+ LiteLLMClient.configure do |config|
403
+ # Configure API key authorization: APIKeyHeader
404
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
405
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
406
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
407
+ end
408
+
409
+ api_instance = LiteLLMClient::BatchApi.new
410
+ opts = {
411
+ provider: 'provider_example' # String |
412
+ }
413
+
414
+ begin
415
+ # Create Batch
416
+ result = api_instance.create_batch_v1_batches_post(opts)
417
+ p result
418
+ rescue LiteLLMClient::ApiError => e
419
+ puts "Error when calling BatchApi->create_batch_v1_batches_post: #{e}"
420
+ end
421
+ ```
422
+
423
+ #### Using the create_batch_v1_batches_post_with_http_info variant
424
+
425
+ This returns an Array which contains the response data, status code and headers.
426
+
427
+ > <Array(Object, Integer, Hash)> create_batch_v1_batches_post_with_http_info(opts)
428
+
429
+ ```ruby
430
+ begin
431
+ # Create Batch
432
+ data, status_code, headers = api_instance.create_batch_v1_batches_post_with_http_info(opts)
433
+ p status_code # => 2xx
434
+ p headers # => { ... }
435
+ p data # => Object
436
+ rescue LiteLLMClient::ApiError => e
437
+ puts "Error when calling BatchApi->create_batch_v1_batches_post_with_http_info: #{e}"
438
+ end
439
+ ```
440
+
441
+ ### Parameters
442
+
443
+ | Name | Type | Description | Notes |
444
+ | ---- | ---- | ----------- | ----- |
445
+ | **provider** | **String** | | [optional] |
446
+
447
+ ### Return type
448
+
449
+ **Object**
450
+
451
+ ### Authorization
452
+
453
+ [APIKeyHeader](../README.md#APIKeyHeader)
454
+
455
+ ### HTTP request headers
456
+
457
+ - **Content-Type**: Not defined
458
+ - **Accept**: application/json
459
+
460
+
461
+ ## list_batches_batches_get
462
+
463
+ > Object list_batches_batches_get(opts)
464
+
465
+ List Batches
466
+
467
+ Lists This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list Example Curl ``` curl http://localhost:4000/v1/batches?limit=2 -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" ```
468
+
469
+ ### Examples
470
+
471
+ ```ruby
472
+ require 'time'
473
+ require 'litellm_client'
474
+ # setup authorization
475
+ LiteLLMClient.configure do |config|
476
+ # Configure API key authorization: APIKeyHeader
477
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
478
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
479
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
480
+ end
481
+
482
+ api_instance = LiteLLMClient::BatchApi.new
483
+ opts = {
484
+ provider: 'provider_example', # String |
485
+ limit: 56, # Integer |
486
+ after: 'after_example' # String |
487
+ }
488
+
489
+ begin
490
+ # List Batches
491
+ result = api_instance.list_batches_batches_get(opts)
492
+ p result
493
+ rescue LiteLLMClient::ApiError => e
494
+ puts "Error when calling BatchApi->list_batches_batches_get: #{e}"
495
+ end
496
+ ```
497
+
498
+ #### Using the list_batches_batches_get_with_http_info variant
499
+
500
+ This returns an Array which contains the response data, status code and headers.
501
+
502
+ > <Array(Object, Integer, Hash)> list_batches_batches_get_with_http_info(opts)
503
+
504
+ ```ruby
505
+ begin
506
+ # List Batches
507
+ data, status_code, headers = api_instance.list_batches_batches_get_with_http_info(opts)
508
+ p status_code # => 2xx
509
+ p headers # => { ... }
510
+ p data # => Object
511
+ rescue LiteLLMClient::ApiError => e
512
+ puts "Error when calling BatchApi->list_batches_batches_get_with_http_info: #{e}"
513
+ end
514
+ ```
515
+
516
+ ### Parameters
517
+
518
+ | Name | Type | Description | Notes |
519
+ | ---- | ---- | ----------- | ----- |
520
+ | **provider** | **String** | | [optional] |
521
+ | **limit** | **Integer** | | [optional] |
522
+ | **after** | **String** | | [optional] |
523
+
524
+ ### Return type
525
+
526
+ **Object**
527
+
528
+ ### Authorization
529
+
530
+ [APIKeyHeader](../README.md#APIKeyHeader)
531
+
532
+ ### HTTP request headers
533
+
534
+ - **Content-Type**: Not defined
535
+ - **Accept**: application/json
536
+
537
+
538
+ ## list_batches_provider_v1_batches_get
539
+
540
+ > Object list_batches_provider_v1_batches_get(provider, opts)
541
+
542
+ List Batches
543
+
544
+ Lists This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list Example Curl ``` curl http://localhost:4000/v1/batches?limit=2 -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" ```
545
+
546
+ ### Examples
547
+
548
+ ```ruby
549
+ require 'time'
550
+ require 'litellm_client'
551
+ # setup authorization
552
+ LiteLLMClient.configure do |config|
553
+ # Configure API key authorization: APIKeyHeader
554
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
555
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
556
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
557
+ end
558
+
559
+ api_instance = LiteLLMClient::BatchApi.new
560
+ provider = 'provider_example' # String |
561
+ opts = {
562
+ limit: 56, # Integer |
563
+ after: 'after_example' # String |
564
+ }
565
+
566
+ begin
567
+ # List Batches
568
+ result = api_instance.list_batches_provider_v1_batches_get(provider, opts)
569
+ p result
570
+ rescue LiteLLMClient::ApiError => e
571
+ puts "Error when calling BatchApi->list_batches_provider_v1_batches_get: #{e}"
572
+ end
573
+ ```
574
+
575
+ #### Using the list_batches_provider_v1_batches_get_with_http_info variant
576
+
577
+ This returns an Array which contains the response data, status code and headers.
578
+
579
+ > <Array(Object, Integer, Hash)> list_batches_provider_v1_batches_get_with_http_info(provider, opts)
580
+
581
+ ```ruby
582
+ begin
583
+ # List Batches
584
+ data, status_code, headers = api_instance.list_batches_provider_v1_batches_get_with_http_info(provider, opts)
585
+ p status_code # => 2xx
586
+ p headers # => { ... }
587
+ p data # => Object
588
+ rescue LiteLLMClient::ApiError => e
589
+ puts "Error when calling BatchApi->list_batches_provider_v1_batches_get_with_http_info: #{e}"
590
+ end
591
+ ```
592
+
593
+ ### Parameters
594
+
595
+ | Name | Type | Description | Notes |
596
+ | ---- | ---- | ----------- | ----- |
597
+ | **provider** | **String** | | |
598
+ | **limit** | **Integer** | | [optional] |
599
+ | **after** | **String** | | [optional] |
600
+
601
+ ### Return type
602
+
603
+ **Object**
604
+
605
+ ### Authorization
606
+
607
+ [APIKeyHeader](../README.md#APIKeyHeader)
608
+
609
+ ### HTTP request headers
610
+
611
+ - **Content-Type**: Not defined
612
+ - **Accept**: application/json
613
+
614
+
615
+ ## list_batches_v1_batches_get
616
+
617
+ > Object list_batches_v1_batches_get(opts)
618
+
619
+ List Batches
620
+
621
+ Lists This is the equivalent of GET https://api.openai.com/v1/batches/ Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list Example Curl ``` curl http://localhost:4000/v1/batches?limit=2 -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" ```
622
+
623
+ ### Examples
624
+
625
+ ```ruby
626
+ require 'time'
627
+ require 'litellm_client'
628
+ # setup authorization
629
+ LiteLLMClient.configure do |config|
630
+ # Configure API key authorization: APIKeyHeader
631
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
632
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
633
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
634
+ end
635
+
636
+ api_instance = LiteLLMClient::BatchApi.new
637
+ opts = {
638
+ provider: 'provider_example', # String |
639
+ limit: 56, # Integer |
640
+ after: 'after_example' # String |
641
+ }
642
+
643
+ begin
644
+ # List Batches
645
+ result = api_instance.list_batches_v1_batches_get(opts)
646
+ p result
647
+ rescue LiteLLMClient::ApiError => e
648
+ puts "Error when calling BatchApi->list_batches_v1_batches_get: #{e}"
649
+ end
650
+ ```
651
+
652
+ #### Using the list_batches_v1_batches_get_with_http_info variant
653
+
654
+ This returns an Array which contains the response data, status code and headers.
655
+
656
+ > <Array(Object, Integer, Hash)> list_batches_v1_batches_get_with_http_info(opts)
657
+
658
+ ```ruby
659
+ begin
660
+ # List Batches
661
+ data, status_code, headers = api_instance.list_batches_v1_batches_get_with_http_info(opts)
662
+ p status_code # => 2xx
663
+ p headers # => { ... }
664
+ p data # => Object
665
+ rescue LiteLLMClient::ApiError => e
666
+ puts "Error when calling BatchApi->list_batches_v1_batches_get_with_http_info: #{e}"
667
+ end
668
+ ```
669
+
670
+ ### Parameters
671
+
672
+ | Name | Type | Description | Notes |
673
+ | ---- | ---- | ----------- | ----- |
674
+ | **provider** | **String** | | [optional] |
675
+ | **limit** | **Integer** | | [optional] |
676
+ | **after** | **String** | | [optional] |
677
+
678
+ ### Return type
679
+
680
+ **Object**
681
+
682
+ ### Authorization
683
+
684
+ [APIKeyHeader](../README.md#APIKeyHeader)
685
+
686
+ ### HTTP request headers
687
+
688
+ - **Content-Type**: Not defined
689
+ - **Accept**: application/json
690
+
691
+
692
+ ## retrieve_batch_batches_batch_id_get
693
+
694
+ > Object retrieve_batch_batches_batch_id_get(batch_id, opts)
695
+
696
+ Retrieve Batch
697
+
698
+ Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123 -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" ```
699
+
700
+ ### Examples
701
+
702
+ ```ruby
703
+ require 'time'
704
+ require 'litellm_client'
705
+ # setup authorization
706
+ LiteLLMClient.configure do |config|
707
+ # Configure API key authorization: APIKeyHeader
708
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
709
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
710
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
711
+ end
712
+
713
+ api_instance = LiteLLMClient::BatchApi.new
714
+ batch_id = 'batch_id_example' # String | The ID of the batch to retrieve
715
+ opts = {
716
+ provider: 'provider_example' # String |
717
+ }
718
+
719
+ begin
720
+ # Retrieve Batch
721
+ result = api_instance.retrieve_batch_batches_batch_id_get(batch_id, opts)
722
+ p result
723
+ rescue LiteLLMClient::ApiError => e
724
+ puts "Error when calling BatchApi->retrieve_batch_batches_batch_id_get: #{e}"
725
+ end
726
+ ```
727
+
728
+ #### Using the retrieve_batch_batches_batch_id_get_with_http_info variant
729
+
730
+ This returns an Array which contains the response data, status code and headers.
731
+
732
+ > <Array(Object, Integer, Hash)> retrieve_batch_batches_batch_id_get_with_http_info(batch_id, opts)
733
+
734
+ ```ruby
735
+ begin
736
+ # Retrieve Batch
737
+ data, status_code, headers = api_instance.retrieve_batch_batches_batch_id_get_with_http_info(batch_id, opts)
738
+ p status_code # => 2xx
739
+ p headers # => { ... }
740
+ p data # => Object
741
+ rescue LiteLLMClient::ApiError => e
742
+ puts "Error when calling BatchApi->retrieve_batch_batches_batch_id_get_with_http_info: #{e}"
743
+ end
744
+ ```
745
+
746
+ ### Parameters
747
+
748
+ | Name | Type | Description | Notes |
749
+ | ---- | ---- | ----------- | ----- |
750
+ | **batch_id** | **String** | The ID of the batch to retrieve | |
751
+ | **provider** | **String** | | [optional] |
752
+
753
+ ### Return type
754
+
755
+ **Object**
756
+
757
+ ### Authorization
758
+
759
+ [APIKeyHeader](../README.md#APIKeyHeader)
760
+
761
+ ### HTTP request headers
762
+
763
+ - **Content-Type**: Not defined
764
+ - **Accept**: application/json
765
+
766
+
767
+ ## retrieve_batch_provider_v1_batches_batch_id_get
768
+
769
+ > Object retrieve_batch_provider_v1_batches_batch_id_get(provider, batch_id)
770
+
771
+ Retrieve Batch
772
+
773
+ Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123 -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" ```
774
+
775
+ ### Examples
776
+
777
+ ```ruby
778
+ require 'time'
779
+ require 'litellm_client'
780
+ # setup authorization
781
+ LiteLLMClient.configure do |config|
782
+ # Configure API key authorization: APIKeyHeader
783
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
784
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
785
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
786
+ end
787
+
788
+ api_instance = LiteLLMClient::BatchApi.new
789
+ provider = 'provider_example' # String |
790
+ batch_id = 'batch_id_example' # String | The ID of the batch to retrieve
791
+
792
+ begin
793
+ # Retrieve Batch
794
+ result = api_instance.retrieve_batch_provider_v1_batches_batch_id_get(provider, batch_id)
795
+ p result
796
+ rescue LiteLLMClient::ApiError => e
797
+ puts "Error when calling BatchApi->retrieve_batch_provider_v1_batches_batch_id_get: #{e}"
798
+ end
799
+ ```
800
+
801
+ #### Using the retrieve_batch_provider_v1_batches_batch_id_get_with_http_info variant
802
+
803
+ This returns an Array which contains the response data, status code and headers.
804
+
805
+ > <Array(Object, Integer, Hash)> retrieve_batch_provider_v1_batches_batch_id_get_with_http_info(provider, batch_id)
806
+
807
+ ```ruby
808
+ begin
809
+ # Retrieve Batch
810
+ data, status_code, headers = api_instance.retrieve_batch_provider_v1_batches_batch_id_get_with_http_info(provider, batch_id)
811
+ p status_code # => 2xx
812
+ p headers # => { ... }
813
+ p data # => Object
814
+ rescue LiteLLMClient::ApiError => e
815
+ puts "Error when calling BatchApi->retrieve_batch_provider_v1_batches_batch_id_get_with_http_info: #{e}"
816
+ end
817
+ ```
818
+
819
+ ### Parameters
820
+
821
+ | Name | Type | Description | Notes |
822
+ | ---- | ---- | ----------- | ----- |
823
+ | **provider** | **String** | | |
824
+ | **batch_id** | **String** | The ID of the batch to retrieve | |
825
+
826
+ ### Return type
827
+
828
+ **Object**
829
+
830
+ ### Authorization
831
+
832
+ [APIKeyHeader](../README.md#APIKeyHeader)
833
+
834
+ ### HTTP request headers
835
+
836
+ - **Content-Type**: Not defined
837
+ - **Accept**: application/json
838
+
839
+
840
+ ## retrieve_batch_v1_batches_batch_id_get
841
+
842
+ > Object retrieve_batch_v1_batches_batch_id_get(batch_id, opts)
843
+
844
+ Retrieve Batch
845
+
846
+ Retrieves a batch. This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id} Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve Example Curl ``` curl http://localhost:4000/v1/batches/batch_abc123 -H \"Authorization: Bearer sk-1234\" -H \"Content-Type: application/json\" ```
847
+
848
+ ### Examples
849
+
850
+ ```ruby
851
+ require 'time'
852
+ require 'litellm_client'
853
+ # setup authorization
854
+ LiteLLMClient.configure do |config|
855
+ # Configure API key authorization: APIKeyHeader
856
+ config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
857
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
858
+ # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
859
+ end
860
+
861
+ api_instance = LiteLLMClient::BatchApi.new
862
+ batch_id = 'batch_id_example' # String | The ID of the batch to retrieve
863
+ opts = {
864
+ provider: 'provider_example' # String |
865
+ }
866
+
867
+ begin
868
+ # Retrieve Batch
869
+ result = api_instance.retrieve_batch_v1_batches_batch_id_get(batch_id, opts)
870
+ p result
871
+ rescue LiteLLMClient::ApiError => e
872
+ puts "Error when calling BatchApi->retrieve_batch_v1_batches_batch_id_get: #{e}"
873
+ end
874
+ ```
875
+
876
+ #### Using the retrieve_batch_v1_batches_batch_id_get_with_http_info variant
877
+
878
+ This returns an Array which contains the response data, status code and headers.
879
+
880
+ > <Array(Object, Integer, Hash)> retrieve_batch_v1_batches_batch_id_get_with_http_info(batch_id, opts)
881
+
882
+ ```ruby
883
+ begin
884
+ # Retrieve Batch
885
+ data, status_code, headers = api_instance.retrieve_batch_v1_batches_batch_id_get_with_http_info(batch_id, opts)
886
+ p status_code # => 2xx
887
+ p headers # => { ... }
888
+ p data # => Object
889
+ rescue LiteLLMClient::ApiError => e
890
+ puts "Error when calling BatchApi->retrieve_batch_v1_batches_batch_id_get_with_http_info: #{e}"
891
+ end
892
+ ```
893
+
894
+ ### Parameters
895
+
896
+ | Name | Type | Description | Notes |
897
+ | ---- | ---- | ----------- | ----- |
898
+ | **batch_id** | **String** | The ID of the batch to retrieve | |
899
+ | **provider** | **String** | | [optional] |
900
+
901
+ ### Return type
902
+
903
+ **Object**
904
+
905
+ ### Authorization
906
+
907
+ [APIKeyHeader](../README.md#APIKeyHeader)
908
+
909
+ ### HTTP request headers
910
+
911
+ - **Content-Type**: Not defined
912
+ - **Accept**: application/json
913
+