mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-06-27 18:50:41 +00:00
36d70637b9
# What does this PR do? We still had a few enum declared to behave like string as well as enum. Let's use StrEnum for those. Signed-off-by: Sébastien Han <seb@redhat.com>
139 lines
3.7 KiB
Python
139 lines
3.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 enum import StrEnum
|
|
from typing import Any, Literal, Protocol, runtime_checkable
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
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
|
|
|
|
|
|
class CommonModelFields(BaseModel):
|
|
metadata: dict[str, Any] = Field(
|
|
default_factory=dict,
|
|
description="Any additional metadata for this model",
|
|
)
|
|
|
|
|
|
@json_schema_type
|
|
class ModelType(StrEnum):
|
|
llm = "llm"
|
|
embedding = "embedding"
|
|
|
|
|
|
@json_schema_type
|
|
class Model(CommonModelFields, Resource):
|
|
type: Literal[ResourceType.model] = ResourceType.model
|
|
|
|
@property
|
|
def model_id(self) -> str:
|
|
return self.identifier
|
|
|
|
@property
|
|
def provider_model_id(self) -> str | None:
|
|
return self.provider_resource_id
|
|
|
|
model_config = ConfigDict(protected_namespaces=())
|
|
|
|
model_type: ModelType = Field(default=ModelType.llm)
|
|
|
|
|
|
class ModelInput(CommonModelFields):
|
|
model_id: str
|
|
provider_id: str | None = None
|
|
provider_model_id: str | None = None
|
|
model_type: ModelType | None = ModelType.llm
|
|
model_config = ConfigDict(protected_namespaces=())
|
|
|
|
|
|
class ListModelsResponse(BaseModel):
|
|
data: list[Model]
|
|
|
|
|
|
@json_schema_type
|
|
class OpenAIModel(BaseModel):
|
|
"""A model from OpenAI.
|
|
|
|
:id: The ID of the model
|
|
:object: The object type, which will be "model"
|
|
:created: The Unix timestamp in seconds when the model was created
|
|
:owned_by: The owner of the model
|
|
"""
|
|
|
|
id: str
|
|
object: Literal["model"] = "model"
|
|
created: int
|
|
owned_by: str
|
|
|
|
|
|
class OpenAIListModelsResponse(BaseModel):
|
|
data: list[OpenAIModel]
|
|
|
|
|
|
@runtime_checkable
|
|
@trace_protocol
|
|
class Models(Protocol):
|
|
@webmethod(route="/models", method="GET")
|
|
async def list_models(self) -> ListModelsResponse:
|
|
"""List all models.
|
|
|
|
:returns: A ListModelsResponse.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/openai/v1/models", method="GET")
|
|
async def openai_list_models(self) -> OpenAIListModelsResponse:
|
|
"""List models using the OpenAI API.
|
|
|
|
:returns: A OpenAIListModelsResponse.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/models/{model_id:path}", method="GET")
|
|
async def get_model(
|
|
self,
|
|
model_id: str,
|
|
) -> Model:
|
|
"""Get a model by its identifier.
|
|
|
|
:param model_id: The identifier of the model to get.
|
|
:returns: A Model.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/models", method="POST")
|
|
async def register_model(
|
|
self,
|
|
model_id: str,
|
|
provider_model_id: str | None = None,
|
|
provider_id: str | None = None,
|
|
metadata: dict[str, Any] | None = None,
|
|
model_type: ModelType | None = None,
|
|
) -> Model:
|
|
"""Register a model.
|
|
|
|
:param model_id: The identifier of the model to register.
|
|
:param provider_model_id: The identifier of the model in the provider.
|
|
:param provider_id: The identifier of the provider.
|
|
:param metadata: Any additional metadata for this model.
|
|
:param model_type: The type of model to register.
|
|
:returns: A Model.
|
|
"""
|
|
...
|
|
|
|
@webmethod(route="/models/{model_id:path}", method="DELETE")
|
|
async def unregister_model(
|
|
self,
|
|
model_id: str,
|
|
) -> None:
|
|
"""Unregister a model.
|
|
|
|
:param model_id: The identifier of the model to unregister.
|
|
"""
|
|
...
|