Initial commit

llama_toolchain/safety/api/__init__.py

@@ -0,0 +1,5 @@
+# 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.

llama_toolchain/safety/api/config.py

@@ -0,0 +1,25 @@
+# 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 List, Optional
+
+from pydantic import BaseModel
+
+
+class LlamaGuardShieldConfig(BaseModel):
+    model_dir: str
+    excluded_categories: List[str]
+    disable_input_check: bool = False
+    disable_output_check: bool = False
+
+
+class PromptGuardShieldConfig(BaseModel):
+    model_dir: str
+
+
+class SafetyConfig(BaseModel):
+    llama_guard_shield: Optional[LlamaGuardShieldConfig] = None
+    prompt_guard_shield: Optional[PromptGuardShieldConfig] = None

llama_toolchain/safety/api/datatypes.py

@@ -0,0 +1,60 @@
+# 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 Dict, Optional, Union
+
+from llama_models.llama3_1.api.datatypes import ToolParamDefinition
+
+from pydantic import BaseModel
+
+from strong_typing.schema import json_schema_type
+
+from llama_toolchain.common.deployment_types import RestAPIExecutionConfig
+
+
+@json_schema_type
+class BuiltinShield(Enum):
+    llama_guard = "llama_guard"
+    code_scanner_guard = "code_scanner_guard"
+    third_party_shield = "third_party_shield"
+    injection_shield = "injection_shield"
+    jailbreak_shield = "jailbreak_shield"
+
+
+ShieldType = Union[BuiltinShield, str]
+
+
+@json_schema_type
+class OnViolationAction(Enum):
+    IGNORE = 0
+    WARN = 1
+    RAISE = 2
+
+
+@json_schema_type
+class ShieldDefinition(BaseModel):
+    shield_type: ShieldType
+    description: Optional[str] = None
+    parameters: Optional[Dict[str, ToolParamDefinition]] = None
+    on_violation_action: OnViolationAction = OnViolationAction.RAISE
+    execution_config: Optional[RestAPIExecutionConfig] = None
+
+
+@json_schema_type
+class ShieldCall(BaseModel):
+    call_id: str
+    shield_type: ShieldType
+    arguments: Dict[str, str]
+
+
+@json_schema_type
+class ShieldResponse(BaseModel):
+    shield_type: ShieldType
+    # TODO(ashwin): clean this up
+    is_violation: bool
+    violation_type: Optional[str] = None
+    violation_return_message: Optional[str] = None