forked from phoenix-oss/llama-stack-mirror
314ee09ae3
llama-models should have extremely minimal cruft. Its sole purpose should be didactic -- show the simplest implementation of the llama models and document the prompt formats, etc. This PR is the complement to https://github.com/meta-llama/llama-models/pull/279 ## Test Plan Ensure all `llama` CLI `model` sub-commands work: ```bash llama model list llama model download --model-id ... llama model prompt-format -m ... ``` Ran tests: ```bash cd tests/client-sdk LLAMA_STACK_CONFIG=fireworks pytest -s -v inference/ LLAMA_STACK_CONFIG=fireworks pytest -s -v vector_io/ LLAMA_STACK_CONFIG=fireworks pytest -s -v agents/ ``` Create a fresh venv `uv venv && source .venv/bin/activate` and run `llama stack build --template fireworks --image-type venv` followed by `llama stack run together --image-type venv` <-- the server runs Also checked that the OpenAPI generator can run and there is no change in the generated files as a result. ```bash cd docs/openapi_generator sh run_openapi_generator.sh ```
155 lines
4.2 KiB
Python
155 lines
4.2 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
|
|
|
|
from pydantic import BaseModel, Field
|
|
from typing_extensions import Protocol, runtime_checkable
|
|
|
|
from llama_stack.apis.common.content_types import URL, InterleavedContent
|
|
from llama_stack.apis.resource import Resource, ResourceType
|
|
from llama_stack.providers.utils.telemetry.trace_protocol import trace_protocol
|
|
from llama_stack.schema_utils import json_schema_type, webmethod
|
|
|
|
from .rag_tool import RAGToolRuntime
|
|
|
|
|
|
@json_schema_type
|
|
class ToolParameter(BaseModel):
|
|
name: str
|
|
parameter_type: str
|
|
description: str
|
|
required: bool = Field(default=True)
|
|
default: Optional[Any] = None
|
|
|
|
|
|
@json_schema_type
|
|
class ToolHost(Enum):
|
|
distribution = "distribution"
|
|
client = "client"
|
|
model_context_protocol = "model_context_protocol"
|
|
|
|
|
|
@json_schema_type
|
|
class Tool(Resource):
|
|
type: Literal[ResourceType.tool.value] = ResourceType.tool.value
|
|
toolgroup_id: str
|
|
tool_host: ToolHost
|
|
description: str
|
|
parameters: List[ToolParameter]
|
|
metadata: Optional[Dict[str, Any]] = None
|
|
|
|
|
|
@json_schema_type
|
|
class ToolDef(BaseModel):
|
|
name: str
|
|
description: Optional[str] = None
|
|
parameters: Optional[List[ToolParameter]] = None
|
|
metadata: Optional[Dict[str, Any]] = None
|
|
|
|
|
|
@json_schema_type
|
|
class ToolGroupInput(BaseModel):
|
|
toolgroup_id: str
|
|
provider_id: str
|
|
args: Optional[Dict[str, Any]] = None
|
|
mcp_endpoint: Optional[URL] = None
|
|
|
|
|
|
@json_schema_type
|
|
class ToolGroup(Resource):
|
|
type: Literal[ResourceType.tool_group.value] = ResourceType.tool_group.value
|
|
mcp_endpoint: Optional[URL] = None
|
|
args: Optional[Dict[str, Any]] = None
|
|
|
|
|
|
@json_schema_type
|
|
class ToolInvocationResult(BaseModel):
|
|
content: InterleavedContent
|
|
error_message: Optional[str] = None
|
|
error_code: Optional[int] = None
|
|
|
|
|
|
class ToolStore(Protocol):
|
|
def get_tool(self, tool_name: str) -> Tool: ...
|
|
def get_tool_group(self, toolgroup_id: str) -> ToolGroup: ...
|
|
|
|
|
|
class ListToolGroupsResponse(BaseModel):
|
|
data: List[ToolGroup]
|
|
|
|
|
|
class ListToolsResponse(BaseModel):
|
|
data: List[Tool]
|
|
|
|
|
|
@runtime_checkable
|
|
@trace_protocol
|
|
class ToolGroups(Protocol):
|
|
@webmethod(route="/toolgroups", method="POST")
|
|
async def register_tool_group(
|
|
self,
|
|
toolgroup_id: str,
|
|
provider_id: str,
|
|
mcp_endpoint: Optional[URL] = None,
|
|
args: Optional[Dict[str, Any]] = None,
|
|
) -> None:
|
|
"""Register a tool group"""
|
|
...
|
|
|
|
@webmethod(route="/toolgroups/{toolgroup_id:path}", method="GET")
|
|
async def get_tool_group(
|
|
self,
|
|
toolgroup_id: str,
|
|
) -> ToolGroup: ...
|
|
|
|
@webmethod(route="/toolgroups", method="GET")
|
|
async def list_tool_groups(self) -> ListToolGroupsResponse:
|
|
"""List tool groups with optional provider"""
|
|
...
|
|
|
|
@webmethod(route="/tools", method="GET")
|
|
async def list_tools(self, toolgroup_id: Optional[str] = None) -> ListToolsResponse:
|
|
"""List tools with optional tool group"""
|
|
...
|
|
|
|
@webmethod(route="/tools/{tool_name:path}", method="GET")
|
|
async def get_tool(
|
|
self,
|
|
tool_name: str,
|
|
) -> Tool: ...
|
|
|
|
@webmethod(route="/toolgroups/{toolgroup_id:path}", method="DELETE")
|
|
async def unregister_toolgroup(
|
|
self,
|
|
toolgroup_id: str,
|
|
) -> None:
|
|
"""Unregister a tool group"""
|
|
...
|
|
|
|
|
|
class SpecialToolGroup(Enum):
|
|
rag_tool = "rag_tool"
|
|
|
|
|
|
@runtime_checkable
|
|
@trace_protocol
|
|
class ToolRuntime(Protocol):
|
|
tool_store: ToolStore
|
|
|
|
rag_tool: RAGToolRuntime
|
|
|
|
# TODO: This needs to be renamed once OPEN API generator name conflict issue is fixed.
|
|
@webmethod(route="/tool-runtime/list-tools", method="GET")
|
|
async def list_runtime_tools(
|
|
self, tool_group_id: Optional[str] = None, mcp_endpoint: Optional[URL] = None
|
|
) -> List[ToolDef]: ...
|
|
|
|
@webmethod(route="/tool-runtime/invoke", method="POST")
|
|
async def invoke_tool(self, tool_name: str, kwargs: Dict[str, Any]) -> ToolInvocationResult:
|
|
"""Run a tool with the given arguments"""
|
|
...
|