mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-08-15 22:18: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>
82 lines
2.1 KiB
Python
82 lines
2.1 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 Protocol, runtime_checkable
|
|
|
|
from pydantic import BaseModel
|
|
|
|
from llama_stack.providers.datatypes import HealthStatus
|
|
from llama_stack.schema_utils import json_schema_type, webmethod
|
|
|
|
|
|
@json_schema_type
|
|
class RouteInfo(BaseModel):
|
|
"""Information about an API route including its path, method, and implementing providers.
|
|
|
|
:param route: The API endpoint path
|
|
:param method: HTTP method for the route
|
|
:param provider_types: List of provider types that implement this route
|
|
"""
|
|
|
|
route: str
|
|
method: str
|
|
provider_types: list[str]
|
|
|
|
|
|
@json_schema_type
|
|
class HealthInfo(BaseModel):
|
|
"""Health status information for the service.
|
|
|
|
:param status: Current health status of the service
|
|
"""
|
|
|
|
status: HealthStatus
|
|
|
|
|
|
@json_schema_type
|
|
class VersionInfo(BaseModel):
|
|
"""Version information for the service.
|
|
|
|
:param version: Version number of the service
|
|
"""
|
|
|
|
version: str
|
|
|
|
|
|
class ListRoutesResponse(BaseModel):
|
|
"""Response containing a list of all available API routes.
|
|
|
|
:param data: List of available route information objects
|
|
"""
|
|
|
|
data: list[RouteInfo]
|
|
|
|
|
|
@runtime_checkable
|
|
class Inspect(Protocol):
|
|
@webmethod(route="/inspect/routes", method="GET")
|
|
async def list_routes(self) -> ListRoutesResponse:
|
|
"""List all available API routes with their methods and implementing providers.
|
|
|
|
:returns: Response containing information about all available routes.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/health", method="GET")
|
|
async def health(self) -> HealthInfo:
|
|
"""Get the current health status of the service.
|
|
|
|
:returns: Health information indicating if the service is operational.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/version", method="GET")
|
|
async def version(self) -> VersionInfo:
|
|
"""Get the version of the service.
|
|
|
|
:returns: Version information containing the service version number.
|
|
"""
|
|
...
|