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>
94 lines
2.8 KiB
Python
94 lines
2.8 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, Literal, Protocol, runtime_checkable
|
|
|
|
from pydantic import BaseModel
|
|
|
|
from llama_stack.apis.resource import Resource, ResourceType
|
|
from llama_stack.apis.version import LLAMA_STACK_API_V1
|
|
from llama_stack.providers.utils.telemetry.trace_protocol import trace_protocol
|
|
from llama_stack.schema_utils import json_schema_type, webmethod
|
|
|
|
|
|
class CommonShieldFields(BaseModel):
|
|
params: dict[str, Any] | None = None
|
|
|
|
|
|
@json_schema_type
|
|
class Shield(CommonShieldFields, Resource):
|
|
"""A safety shield resource that can be used to check content.
|
|
|
|
:param params: (Optional) Configuration parameters for the shield
|
|
:param type: The resource type, always shield
|
|
"""
|
|
|
|
type: Literal[ResourceType.shield] = ResourceType.shield
|
|
|
|
@property
|
|
def shield_id(self) -> str:
|
|
return self.identifier
|
|
|
|
@property
|
|
def provider_shield_id(self) -> str | None:
|
|
return self.provider_resource_id
|
|
|
|
|
|
class ShieldInput(CommonShieldFields):
|
|
shield_id: str
|
|
provider_id: str | None = None
|
|
provider_shield_id: str | None = None
|
|
|
|
|
|
class ListShieldsResponse(BaseModel):
|
|
data: list[Shield]
|
|
|
|
|
|
@runtime_checkable
|
|
@trace_protocol
|
|
class Shields(Protocol):
|
|
@webmethod(route="/shields", method="GET", level=LLAMA_STACK_API_V1)
|
|
async def list_shields(self) -> ListShieldsResponse:
|
|
"""List all shields.
|
|
|
|
:returns: A ListShieldsResponse.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/shields/{identifier:path}", method="GET", level=LLAMA_STACK_API_V1)
|
|
async def get_shield(self, identifier: str) -> Shield:
|
|
"""Get a shield by its identifier.
|
|
|
|
:param identifier: The identifier of the shield to get.
|
|
:returns: A Shield.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/shields", method="POST", level=LLAMA_STACK_API_V1)
|
|
async def register_shield(
|
|
self,
|
|
shield_id: str,
|
|
provider_shield_id: str | None = None,
|
|
provider_id: str | None = None,
|
|
params: dict[str, Any] | None = None,
|
|
) -> Shield:
|
|
"""Register a shield.
|
|
|
|
:param shield_id: The identifier of the shield to register.
|
|
:param provider_shield_id: The identifier of the shield in the provider.
|
|
:param provider_id: The identifier of the provider.
|
|
:param params: The parameters of the shield.
|
|
:returns: A Shield.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/shields/{identifier:path}", method="DELETE", level=LLAMA_STACK_API_V1)
|
|
async def unregister_shield(self, identifier: str) -> None:
|
|
"""Unregister a shield.
|
|
|
|
:param identifier: The identifier of the shield to unregister.
|
|
"""
|
|
...
|