mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 12:07:34 +00:00
c88c4ff2c6
# What does this PR do? Rather than have a single `LLAMA_STACK_VERSION`, we need to have a `_V1`, `_V1ALPHA`, and `_V1BETA` constant. This also necessitated addition of `level` to the `WebMethod` so that routing can be handeled properly. For backwards compat, the `v1` routes are being kept around and marked as `deprecated`. When used, the server will log a deprecation warning. Deprecation log: <img width="1224" height="134" alt="Screenshot 2025-09-25 at 2 43 36 PM" src="https://github.com/user-attachments/assets/0cc7c245-dafc-48f0-be99-269fb9a686f9" /> move: 1. post_training to `v1alpha` as it is under heavy development and not near its final state 2. eval: job scheduling is not implemented. Relies heavily on the datasetio API which is under development missing implementations of specific routes indicating the structure of those routes might change. Additionally eval depends on the `inference` API which is going to be deprecated, eval will likely need a major API surface change to conform to using completions properly implements leveling in #3317 note: integration tests will fail until the SDK is regenerated with v1alpha/inference as opposed to v1/inference ## Test Plan existing tests should pass with newly generated schema. Conformance will also pass as these routes are not the ones we currently test for stability Signed-off-by: Charlie Doern <cdoern@redhat.com>
81 lines
2.9 KiB
Python
81 lines
2.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 collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import Any, TypeVar
|
|
|
|
from .strong_typing.schema import json_schema_type, register_schema # noqa: F401
|
|
|
|
|
|
@dataclass
|
|
class WebMethod:
|
|
level: str | None = None
|
|
route: str | None = None
|
|
public: bool = False
|
|
request_examples: list[Any] | None = None
|
|
response_examples: list[Any] | None = None
|
|
method: str | None = None
|
|
raw_bytes_request_body: bool | None = False
|
|
# A descriptive name of the corresponding span created by tracing
|
|
descriptive_name: str | None = None
|
|
experimental: bool | None = False
|
|
required_scope: str | None = None
|
|
deprecated: bool | None = False
|
|
|
|
|
|
T = TypeVar("T", bound=Callable[..., Any])
|
|
|
|
|
|
def webmethod(
|
|
route: str | None = None,
|
|
method: str | None = None,
|
|
level: str | None = None,
|
|
public: bool | None = False,
|
|
request_examples: list[Any] | None = None,
|
|
response_examples: list[Any] | None = None,
|
|
raw_bytes_request_body: bool | None = False,
|
|
descriptive_name: str | None = None,
|
|
experimental: bool | None = False,
|
|
required_scope: str | None = None,
|
|
deprecated: bool | None = False,
|
|
) -> Callable[[T], T]:
|
|
"""
|
|
Decorator that supplies additional metadata to an endpoint operation function.
|
|
|
|
:param route: The URL path pattern associated with this operation which path parameters are substituted into.
|
|
:param public: True if the operation can be invoked without prior authentication.
|
|
:param request_examples: Sample requests that the operation might take. Pass a list of objects, not JSON.
|
|
:param response_examples: Sample responses that the operation might produce. Pass a list of objects, not JSON.
|
|
:param experimental: True if the operation is experimental and subject to change.
|
|
:param required_scope: Required scope for this endpoint (e.g., 'monitoring.viewer').
|
|
"""
|
|
|
|
def wrap(func: T) -> T:
|
|
webmethod_obj = WebMethod(
|
|
route=route,
|
|
method=method,
|
|
level=level,
|
|
public=public or False,
|
|
request_examples=request_examples,
|
|
response_examples=response_examples,
|
|
raw_bytes_request_body=raw_bytes_request_body,
|
|
descriptive_name=descriptive_name,
|
|
experimental=experimental,
|
|
required_scope=required_scope,
|
|
deprecated=deprecated,
|
|
)
|
|
|
|
# Store all webmethods in a list to support multiple decorators
|
|
if not hasattr(func, "__webmethods__"):
|
|
func.__webmethods__ = [] # type: ignore
|
|
func.__webmethods__.append(webmethod_obj) # type: ignore
|
|
|
|
# Keep the last one as __webmethod__ for backwards compatibility
|
|
func.__webmethod__ = webmethod_obj # type: ignore
|
|
return func
|
|
|
|
return wrap
|