mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-06-28 02:53:30 +00:00
09269e2a44
# What does this PR do? This is a follow-up to #425. That PR allows for specifying models in the registry, but each entry needs to look like: ```yaml - identifier: ... provider_id: ... provider_resource_identifier: ... ``` This is headache-inducing. The current PR makes this situation better by adopting the shape of our APIs. Namely, we need the user to only specify `model-id`. The rest should be optional and figured out by the Stack. You can always override it. Here's what example `ollama` "full stack" registry looks like (we still need to kill or simplify shield_type crap): ```yaml models: - model_id: Llama3.2-3B-Instruct - model_id: Llama-Guard-3-1B shields: - shield_id: llama_guard shield_type: llama_guard ``` ## Test Plan See test plan for #425. Re-ran it.
66 lines
1.9 KiB
Python
66 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 enum import Enum
|
|
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
|
|
|
|
|
|
@json_schema_type
|
|
class ShieldType(Enum):
|
|
generic_content_shield = "generic_content_shield"
|
|
llama_guard = "llama_guard"
|
|
code_scanner = "code_scanner"
|
|
prompt_guard = "prompt_guard"
|
|
|
|
|
|
class CommonShieldFields(BaseModel):
|
|
shield_type: ShieldType
|
|
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
|
|
|
|
|
|
@runtime_checkable
|
|
class Shields(Protocol):
|
|
@webmethod(route="/shields/list", method="GET")
|
|
async def list_shields(self) -> List[Shield]: ...
|
|
|
|
@webmethod(route="/shields/get", method="GET")
|
|
async def get_shield(self, identifier: str) -> Optional[Shield]: ...
|
|
|
|
@webmethod(route="/shields/register", method="POST")
|
|
async def register_shield(
|
|
self,
|
|
shield_id: str,
|
|
shield_type: ShieldType,
|
|
provider_shield_id: Optional[str] = None,
|
|
provider_id: Optional[str] = None,
|
|
params: Optional[Dict[str, Any]] = None,
|
|
) -> Shield: ...
|