mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-08-15 14:08:00 +00:00
cb7354a9ce
This PR focuses on improving the developer experience by adding comprehensive docstrings to the API data models across the Llama Stack. These docstrings provide detailed explanations for each model and its fields, making the API easier to understand and use. **Key changes:** - **Added Docstrings:** Added reST formatted docstrings to Pydantic models in the `llama_stack/apis/` directory. This includes models for: - Agents (`agents.py`) - Benchmarks (`benchmarks.py`) - Datasets (`datasets.py`) - Inference (`inference.py`) - And many other API modules. - **OpenAPI Spec Update:** Regenerated the OpenAPI specification (`docs/_static/llama-stack-spec.yaml` and `docs/_static/llama-stack-spec.html`) to include the new docstrings. This will be reflected in the API documentation, providing richer information to users. **Impact:** - Developers using the Llama Stack API will have a better understanding of the data structures. - The auto-generated API documentation is now more informative. --------- Co-authored-by: Ashwin Bharambe <ashwin.bharambe@gmail.com>
63 lines
1.9 KiB
Python
63 lines
1.9 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
from typing import Any, Protocol, runtime_checkable
|
|
|
|
from pydantic import BaseModel
|
|
|
|
from llama_stack.providers.datatypes import HealthResponse
|
|
from llama_stack.schema_utils import json_schema_type, webmethod
|
|
|
|
|
|
@json_schema_type
|
|
class ProviderInfo(BaseModel):
|
|
"""Information about a registered provider including its configuration and health status.
|
|
|
|
:param api: The API name this provider implements
|
|
:param provider_id: Unique identifier for the provider
|
|
:param provider_type: The type of provider implementation
|
|
:param config: Configuration parameters for the provider
|
|
:param health: Current health status of the provider
|
|
"""
|
|
|
|
api: str
|
|
provider_id: str
|
|
provider_type: str
|
|
config: dict[str, Any]
|
|
health: HealthResponse
|
|
|
|
|
|
class ListProvidersResponse(BaseModel):
|
|
"""Response containing a list of all available providers.
|
|
|
|
:param data: List of provider information objects
|
|
"""
|
|
|
|
data: list[ProviderInfo]
|
|
|
|
|
|
@runtime_checkable
|
|
class Providers(Protocol):
|
|
"""
|
|
Providers API for inspecting, listing, and modifying providers and their configurations.
|
|
"""
|
|
|
|
@webmethod(route="/providers", method="GET")
|
|
async def list_providers(self) -> ListProvidersResponse:
|
|
"""List all available providers.
|
|
|
|
:returns: A ListProvidersResponse containing information about all providers.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/providers/{provider_id}", method="GET")
|
|
async def inspect_provider(self, provider_id: str) -> ProviderInfo:
|
|
"""Get detailed information about a specific provider.
|
|
|
|
:param provider_id: The ID of the provider to inspect.
|
|
:returns: A ProviderInfo object containing the provider's details.
|
|
"""
|
|
...
|