mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-06-28 02:53:30 +00:00
7fb2c1c48d
# What does this PR do? This PR changes our API to follow more idiomatic REST API approaches of having paths being resources and methods indicating the action being performed. Changes made to generator: 1) removed the prefix check of "get" as its not required and is actually needed for other method types too 2) removed _ check on path since variables can have "_" ## Test Plan LLAMA_STACK_BASE_URL=http://localhost:5000 pytest -v tests/client-sdk/agents/test_agents.py
61 lines
1.7 KiB
Python
61 lines
1.7 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, Dict, List, Literal, Optional, Protocol, runtime_checkable
|
|
|
|
from llama_models.schema_utils import json_schema_type, webmethod
|
|
from pydantic import BaseModel
|
|
|
|
from llama_stack.apis.resource import Resource, ResourceType
|
|
from llama_stack.providers.utils.telemetry.trace_protocol import trace_protocol
|
|
|
|
|
|
class CommonShieldFields(BaseModel):
|
|
params: Optional[Dict[str, Any]] = None
|
|
|
|
|
|
@json_schema_type
|
|
class Shield(CommonShieldFields, Resource):
|
|
"""A safety shield resource that can be used to check content"""
|
|
|
|
type: Literal[ResourceType.shield.value] = ResourceType.shield.value
|
|
|
|
@property
|
|
def shield_id(self) -> str:
|
|
return self.identifier
|
|
|
|
@property
|
|
def provider_shield_id(self) -> str:
|
|
return self.provider_resource_id
|
|
|
|
|
|
class ShieldInput(CommonShieldFields):
|
|
shield_id: str
|
|
provider_id: Optional[str] = None
|
|
provider_shield_id: Optional[str] = None
|
|
|
|
|
|
class ListShieldsResponse(BaseModel):
|
|
data: List[Shield]
|
|
|
|
|
|
@runtime_checkable
|
|
@trace_protocol
|
|
class Shields(Protocol):
|
|
@webmethod(route="/shields", method="GET")
|
|
async def list_shields(self) -> ListShieldsResponse: ...
|
|
|
|
@webmethod(route="/shields/{identifier}", method="GET")
|
|
async def get_shield(self, identifier: str) -> Optional[Shield]: ...
|
|
|
|
@webmethod(route="/shields", method="POST")
|
|
async def register_shield(
|
|
self,
|
|
shield_id: str,
|
|
provider_shield_id: Optional[str] = None,
|
|
provider_id: Optional[str] = None,
|
|
params: Optional[Dict[str, Any]] = None,
|
|
) -> Shield: ...
|