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