7307fde839* feat: add custom connection * Fix custom provider handling for PR #6112 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fix custom provider connection test for PR #6112 --------- Co-authored-by: wasimysaid <wasimysdev@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
123 lines
5.1 KiB
Python
123 lines
5.1 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-only
|
|
# Copyright 2026-present the Unsloth AI Inc. team. All rights reserved. See /studio/LICENSE.AGPL-3.0
|
|
|
|
"""Pydantic schemas for the external LLM providers API."""
|
|
|
|
from typing import Literal, Optional
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
# ── Registry (static provider info) ───────────────────────────────
|
|
|
|
|
|
class ProviderRegistryEntry(BaseModel):
|
|
"""A supported provider type with its default configuration."""
|
|
|
|
provider_type: str = Field(..., description = "Provider identifier (e.g. 'openai', 'mistral')")
|
|
display_name: str = Field(..., description = "Human-readable provider name")
|
|
base_url: str = Field(..., description = "Default API base URL")
|
|
default_models: list[str] = Field(
|
|
default_factory = list, description = "Well-known model IDs for this provider"
|
|
)
|
|
supports_streaming: bool = Field(
|
|
True, description = "Whether this provider supports SSE streaming"
|
|
)
|
|
supports_vision: bool = Field(
|
|
False, description = "Whether this provider supports vision/image input"
|
|
)
|
|
supports_tool_calling: bool = Field(
|
|
False, description = "Whether this provider supports tool/function calling"
|
|
)
|
|
model_list_mode: Literal["remote", "curated"] = Field(
|
|
"remote",
|
|
description = "remote = fetch /models; curated = huge catalogs — UI uses defaults + manual IDs only",
|
|
)
|
|
|
|
|
|
# ── Provider config CRUD ──────────────────────────────────────────
|
|
|
|
|
|
class ProviderCreate(BaseModel):
|
|
"""Request to create a saved provider configuration."""
|
|
|
|
provider_type: str = Field(..., description = "Provider type from the registry")
|
|
display_name: str = Field(..., description = "User-chosen label (e.g. 'My OpenAI Key')")
|
|
base_url: Optional[str] = Field(
|
|
None,
|
|
description = "Custom base URL (overrides registry default). Omit to use the default.",
|
|
)
|
|
|
|
|
|
class ProviderUpdate(BaseModel):
|
|
"""Request to update a saved provider configuration."""
|
|
|
|
display_name: Optional[str] = Field(None, description = "New display name")
|
|
base_url: Optional[str] = Field(None, description = "New base URL")
|
|
is_enabled: Optional[bool] = Field(None, description = "Enable or disable this provider")
|
|
|
|
|
|
class ProviderResponse(BaseModel):
|
|
"""A saved provider configuration (returned by list/get endpoints)."""
|
|
|
|
id: str = Field(..., description = "Unique provider config ID")
|
|
provider_type: str = Field(..., description = "Provider type (e.g. 'openai')")
|
|
display_name: str = Field(..., description = "User-chosen label")
|
|
base_url: str = Field(..., description = "API base URL")
|
|
is_enabled: bool = Field(True, description = "Whether this provider is enabled")
|
|
created_at: str = Field(..., description = "ISO 8601 creation timestamp")
|
|
updated_at: str = Field(..., description = "ISO 8601 last-update timestamp")
|
|
|
|
|
|
# ── Model listing ─────────────────────────────────────────────────
|
|
|
|
|
|
class ProviderModelInfo(BaseModel):
|
|
"""A model available from an external provider."""
|
|
|
|
id: str = Field(..., description = "Model ID as expected by the provider API")
|
|
display_name: str = Field("", description = "Human-readable model name")
|
|
context_length: Optional[int] = Field(None, description = "Maximum context length in tokens")
|
|
owned_by: Optional[str] = Field(None, description = "Model owner/organization")
|
|
|
|
|
|
class ProviderModelsRequest(BaseModel):
|
|
"""Request to list models from an external provider."""
|
|
|
|
provider_type: str = Field(..., description = "Provider type from the registry")
|
|
encrypted_api_key: Optional[str] = Field(
|
|
None,
|
|
description = "RSA-encrypted, base64-encoded API key (optional for local providers)",
|
|
)
|
|
base_url: Optional[str] = Field(
|
|
None, description = "Custom base URL (overrides registry default)"
|
|
)
|
|
|
|
|
|
# ── Connection testing ────────────────────────────────────────────
|
|
|
|
|
|
class ProviderTestRequest(BaseModel):
|
|
"""Request to test connectivity to an external provider."""
|
|
|
|
provider_type: str = Field(..., description = "Provider type from the registry")
|
|
encrypted_api_key: Optional[str] = Field(
|
|
None,
|
|
description = "RSA-encrypted, base64-encoded API key (optional for local providers)",
|
|
)
|
|
base_url: Optional[str] = Field(
|
|
None, description = "Custom base URL (overrides registry default)"
|
|
)
|
|
model_id: Optional[str] = Field(
|
|
None, description = "Model ID for providers that need a chat probe"
|
|
)
|
|
|
|
|
|
class ProviderTestResult(BaseModel):
|
|
"""Result of a provider connectivity test."""
|
|
|
|
success: bool = Field(..., description = "Whether the test succeeded")
|
|
message: str = Field(..., description = "Human-readable result message")
|
|
models_count: Optional[int] = Field(
|
|
None, description = "Number of models found (if test succeeded)"
|
|
)
|