mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-11 19:56:03 +00:00
feat: Add support for dynamically managing provider connections
This commit is contained in:
parent
63422e5b36
commit
d11edf6fee
9 changed files with 3176 additions and 8 deletions
|
|
@ -8,6 +8,7 @@ from typing import Any, Protocol, runtime_checkable
|
|||
|
||||
from pydantic import BaseModel
|
||||
|
||||
from llama_stack.apis.providers.connection import ProviderConnectionInfo
|
||||
from llama_stack.apis.version import LLAMA_STACK_API_V1
|
||||
from llama_stack.providers.datatypes import HealthResponse
|
||||
from llama_stack.schema_utils import json_schema_type, webmethod
|
||||
|
|
@ -40,6 +41,85 @@ class ListProvidersResponse(BaseModel):
|
|||
data: list[ProviderInfo]
|
||||
|
||||
|
||||
# ===== Dynamic Provider Management API Models =====
|
||||
|
||||
|
||||
@json_schema_type
|
||||
class RegisterProviderRequest(BaseModel):
|
||||
"""Request to register a new dynamic provider.
|
||||
|
||||
:param provider_id: Unique identifier for the provider instance
|
||||
:param api: API namespace (e.g., 'inference', 'vector_io', 'safety')
|
||||
:param provider_type: Provider type identifier (e.g., 'remote::openai', 'inline::faiss')
|
||||
:param config: Provider-specific configuration (API keys, endpoints, etc.)
|
||||
:param attributes: Optional key-value attributes for ABAC access control
|
||||
"""
|
||||
|
||||
provider_id: str
|
||||
api: str
|
||||
provider_type: str
|
||||
config: dict[str, Any]
|
||||
attributes: dict[str, list[str]] | None = None
|
||||
|
||||
|
||||
@json_schema_type
|
||||
class RegisterProviderResponse(BaseModel):
|
||||
"""Response after registering a provider.
|
||||
|
||||
:param provider: Information about the registered provider
|
||||
"""
|
||||
|
||||
provider: ProviderConnectionInfo
|
||||
|
||||
|
||||
@json_schema_type
|
||||
class UpdateProviderRequest(BaseModel):
|
||||
"""Request to update an existing provider's configuration.
|
||||
|
||||
:param config: New configuration parameters (will be merged with existing)
|
||||
:param attributes: Optional updated attributes for access control
|
||||
"""
|
||||
|
||||
config: dict[str, Any] | None = None
|
||||
attributes: dict[str, list[str]] | None = None
|
||||
|
||||
|
||||
@json_schema_type
|
||||
class UpdateProviderResponse(BaseModel):
|
||||
"""Response after updating a provider.
|
||||
|
||||
:param provider: Updated provider information
|
||||
"""
|
||||
|
||||
provider: ProviderConnectionInfo
|
||||
|
||||
|
||||
@json_schema_type
|
||||
class UnregisterProviderResponse(BaseModel):
|
||||
"""Response after unregistering a provider.
|
||||
|
||||
:param success: Whether the operation succeeded
|
||||
:param message: Optional status message
|
||||
"""
|
||||
|
||||
success: bool
|
||||
message: str | None = None
|
||||
|
||||
|
||||
@json_schema_type
|
||||
class TestProviderConnectionResponse(BaseModel):
|
||||
"""Response from testing a provider connection.
|
||||
|
||||
:param success: Whether the connection test succeeded
|
||||
:param health: Health status from the provider
|
||||
:param error_message: Error message if test failed
|
||||
"""
|
||||
|
||||
success: bool
|
||||
health: HealthResponse | None = None
|
||||
error_message: str | None = None
|
||||
|
||||
|
||||
@runtime_checkable
|
||||
class Providers(Protocol):
|
||||
"""Providers
|
||||
|
|
@ -67,3 +147,71 @@ class Providers(Protocol):
|
|||
:returns: A ProviderInfo object containing the provider's details.
|
||||
"""
|
||||
...
|
||||
|
||||
# ===== Dynamic Provider Management Methods =====
|
||||
|
||||
@webmethod(route="/admin/providers", method="POST", level=LLAMA_STACK_API_V1)
|
||||
async def register_provider(
|
||||
self,
|
||||
provider_id: str,
|
||||
api: str,
|
||||
provider_type: str,
|
||||
config: dict[str, Any],
|
||||
attributes: dict[str, list[str]] | None = None,
|
||||
) -> RegisterProviderResponse:
|
||||
"""Register a new dynamic provider.
|
||||
|
||||
Register a new provider instance at runtime. The provider will be validated,
|
||||
instantiated, and persisted to the kvstore. Requires appropriate ABAC permissions.
|
||||
|
||||
:param provider_id: Unique identifier for this provider instance.
|
||||
:param api: API namespace this provider implements.
|
||||
:param provider_type: Provider type (e.g., 'remote::openai').
|
||||
:param config: Provider configuration (API keys, endpoints, etc.).
|
||||
:param attributes: Optional attributes for ABAC access control.
|
||||
:returns: RegisterProviderResponse with the registered provider info.
|
||||
"""
|
||||
...
|
||||
|
||||
@webmethod(route="/admin/providers/{provider_id}", method="PUT", level=LLAMA_STACK_API_V1)
|
||||
async def update_provider(
|
||||
self,
|
||||
provider_id: str,
|
||||
config: dict[str, Any] | None = None,
|
||||
attributes: dict[str, list[str]] | None = None,
|
||||
) -> UpdateProviderResponse:
|
||||
"""Update an existing provider's configuration.
|
||||
|
||||
Update the configuration and/or attributes of a dynamic provider. The provider
|
||||
will be re-instantiated with the new configuration (hot-reload). Static providers
|
||||
from run.yaml cannot be updated.
|
||||
|
||||
:param provider_id: ID of the provider to update
|
||||
:param config: New configuration parameters (merged with existing)
|
||||
:param attributes: New attributes for access control
|
||||
:returns: UpdateProviderResponse with updated provider info
|
||||
"""
|
||||
...
|
||||
|
||||
@webmethod(route="/admin/providers/{provider_id}", method="DELETE", level=LLAMA_STACK_API_V1)
|
||||
async def unregister_provider(self, provider_id: str) -> None:
|
||||
"""Unregister a dynamic provider.
|
||||
|
||||
Remove a dynamic provider, shutting down its instance and removing it from
|
||||
the kvstore. Static providers from run.yaml cannot be unregistered.
|
||||
|
||||
:param provider_id: ID of the provider to unregister.
|
||||
"""
|
||||
...
|
||||
|
||||
@webmethod(route="/providers/{provider_id}/test", method="POST", level=LLAMA_STACK_API_V1)
|
||||
async def test_provider_connection(self, provider_id: str) -> TestProviderConnectionResponse:
|
||||
"""Test a provider connection.
|
||||
|
||||
Execute a health check on a provider to verify it is reachable and functioning.
|
||||
Works for both static and dynamic providers.
|
||||
|
||||
:param provider_id: ID of the provider to test.
|
||||
:returns: TestProviderConnectionResponse with health status.
|
||||
"""
|
||||
...
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue