llama-stack 0.3.5__py3-none-any.whl → 0.4.0__py3-none-any.whl

llama_stack/apis/batches/__init__.py

@@ -1,9 +0,0 @@
-# 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 .batches import Batches, BatchObject, ListBatchesResponse
-
-__all__ = ["Batches", "BatchObject", "ListBatchesResponse"]

llama_stack/apis/batches/batches.py

@@ -1,100 +0,0 @@
-# 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 Literal, Protocol, runtime_checkable
-
-from pydantic import BaseModel, Field
-
-from llama_stack.apis.version import LLAMA_STACK_API_V1
-from llama_stack.schema_utils import json_schema_type, webmethod
-
-try:
-    from openai.types import Batch as BatchObject
-except ImportError as e:
-    raise ImportError("OpenAI package is required for batches API. Please install it with: pip install openai") from e
-
-
-@json_schema_type
-class ListBatchesResponse(BaseModel):
-    """Response containing a list of batch objects."""
-
-    object: Literal["list"] = "list"
-    data: list[BatchObject] = Field(..., description="List of batch objects")
-    first_id: str | None = Field(default=None, description="ID of the first batch in the list")
-    last_id: str | None = Field(default=None, description="ID of the last batch in the list")
-    has_more: bool = Field(default=False, description="Whether there are more batches available")
-
-
-@runtime_checkable
-class Batches(Protocol):
-    """
-    The Batches API enables efficient processing of multiple requests in a single operation,
-    particularly useful for processing large datasets, batch evaluation workflows, and
-    cost-effective inference at scale.
-
-    The API is designed to allow use of openai client libraries for seamless integration.
-
-    This API provides the following extensions:
-     - idempotent batch creation
-
-    Note: This API is currently under active development and may undergo changes.
-    """
-
-    @webmethod(route="/openai/v1/batches", method="POST", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/batches", method="POST", level=LLAMA_STACK_API_V1)
-    async def create_batch(
-        self,
-        input_file_id: str,
-        endpoint: str,
-        completion_window: Literal["24h"],
-        metadata: dict[str, str] | None = None,
-        idempotency_key: str | None = None,
-    ) -> BatchObject:
-        """Create a new batch for processing multiple API requests.
-
-        :param input_file_id: The ID of an uploaded file containing requests for the batch.
-        :param endpoint: The endpoint to be used for all requests in the batch.
-        :param completion_window: The time window within which the batch should be processed.
-        :param metadata: Optional metadata for the batch.
-        :param idempotency_key: Optional idempotency key. When provided, enables idempotent behavior.
-        :returns: The created batch object.
-        """
-        ...
-
-    @webmethod(route="/openai/v1/batches/{batch_id}", method="GET", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/batches/{batch_id}", method="GET", level=LLAMA_STACK_API_V1)
-    async def retrieve_batch(self, batch_id: str) -> BatchObject:
-        """Retrieve information about a specific batch.
-
-        :param batch_id: The ID of the batch to retrieve.
-        :returns: The batch object.
-        """
-        ...
-
-    @webmethod(route="/openai/v1/batches/{batch_id}/cancel", method="POST", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/batches/{batch_id}/cancel", method="POST", level=LLAMA_STACK_API_V1)
-    async def cancel_batch(self, batch_id: str) -> BatchObject:
-        """Cancel a batch that is in progress.
-
-        :param batch_id: The ID of the batch to cancel.
-        :returns: The updated batch object.
-        """
-        ...
-
-    @webmethod(route="/openai/v1/batches", method="GET", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/batches", method="GET", level=LLAMA_STACK_API_V1)
-    async def list_batches(
-        self,
-        after: str | None = None,
-        limit: int = 20,
-    ) -> ListBatchesResponse:
-        """List all batches for the current user.
-
-        :param after: A cursor for pagination; returns batches after this batch ID.
-        :param limit: Number of batches to return (default 20, max 100).
-        :returns: A list of batch objects.
-        """
-        ...

llama_stack/apis/benchmarks/__init__.py

@@ -1,7 +0,0 @@
-# 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 .benchmarks import *

llama_stack/apis/benchmarks/benchmarks.py

@@ -1,108 +0,0 @@
-# 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, Literal, Protocol, runtime_checkable
-
-from pydantic import BaseModel, Field
-
-from llama_stack.apis.resource import Resource, ResourceType
-from llama_stack.apis.version import LLAMA_STACK_API_V1, LLAMA_STACK_API_V1ALPHA
-from llama_stack.schema_utils import json_schema_type, webmethod
-
-
-class CommonBenchmarkFields(BaseModel):
-    dataset_id: str
-    scoring_functions: list[str]
-    metadata: dict[str, Any] = Field(
-        default_factory=dict,
-        description="Metadata for this evaluation task",
-    )
-
-
-@json_schema_type
-class Benchmark(CommonBenchmarkFields, Resource):
-    """A benchmark resource for evaluating model performance.
-
-    :param dataset_id: Identifier of the dataset to use for the benchmark evaluation
-    :param scoring_functions: List of scoring function identifiers to apply during evaluation
-    :param metadata: Metadata for this evaluation task
-    :param type: The resource type, always benchmark
-    """
-
-    type: Literal[ResourceType.benchmark] = ResourceType.benchmark
-
-    @property
-    def benchmark_id(self) -> str:
-        return self.identifier
-
-    @property
-    def provider_benchmark_id(self) -> str | None:
-        return self.provider_resource_id
-
-
-class BenchmarkInput(CommonBenchmarkFields, BaseModel):
-    benchmark_id: str
-    provider_id: str | None = None
-    provider_benchmark_id: str | None = None
-
-
-class ListBenchmarksResponse(BaseModel):
-    data: list[Benchmark]
-
-
-@runtime_checkable
-class Benchmarks(Protocol):
-    @webmethod(route="/eval/benchmarks", method="GET", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/eval/benchmarks", method="GET", level=LLAMA_STACK_API_V1ALPHA)
-    async def list_benchmarks(self) -> ListBenchmarksResponse:
-        """List all benchmarks.
-
-        :returns: A ListBenchmarksResponse.
-        """
-        ...
-
-    @webmethod(route="/eval/benchmarks/{benchmark_id}", method="GET", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/eval/benchmarks/{benchmark_id}", method="GET", level=LLAMA_STACK_API_V1ALPHA)
-    async def get_benchmark(
-        self,
-        benchmark_id: str,
-    ) -> Benchmark:
-        """Get a benchmark by its ID.
-
-        :param benchmark_id: The ID of the benchmark to get.
-        :returns: A Benchmark.
-        """
-        ...
-
-    @webmethod(route="/eval/benchmarks", method="POST", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/eval/benchmarks", method="POST", level=LLAMA_STACK_API_V1ALPHA)
-    async def register_benchmark(
-        self,
-        benchmark_id: str,
-        dataset_id: str,
-        scoring_functions: list[str],
-        provider_benchmark_id: str | None = None,
-        provider_id: str | None = None,
-        metadata: dict[str, Any] | None = None,
-    ) -> None:
-        """Register a benchmark.
-
-        :param benchmark_id: The ID of the benchmark to register.
-        :param dataset_id: The ID of the dataset to use for the benchmark.
-        :param scoring_functions: The scoring functions to use for the benchmark.
-        :param provider_benchmark_id: The ID of the provider benchmark to use for the benchmark.
-        :param provider_id: The ID of the provider to use for the benchmark.
-        :param metadata: The metadata to use for the benchmark.
-        """
-        ...
-
-    @webmethod(route="/eval/benchmarks/{benchmark_id}", method="DELETE", level=LLAMA_STACK_API_V1, deprecated=True)
-    @webmethod(route="/eval/benchmarks/{benchmark_id}", method="DELETE", level=LLAMA_STACK_API_V1ALPHA)
-    async def unregister_benchmark(self, benchmark_id: str) -> None:
-        """Unregister a benchmark.
-
-        :param benchmark_id: The ID of the benchmark to unregister.
-        """
-        ...

llama_stack/apis/common/responses.py

@@ -1,36 +0,0 @@
-# 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
-
-from pydantic import BaseModel
-
-from llama_stack.schema_utils import json_schema_type
-
-
-class Order(Enum):
-    """Sort order for paginated responses.
-    :cvar asc: Ascending order
-    :cvar desc: Descending order
-    """
-
-    asc = "asc"
-    desc = "desc"
-
-
-@json_schema_type
-class PaginatedResponse(BaseModel):
-    """A generic paginated response that follows a simple format.
-
-    :param data: The list of items for the current page
-    :param has_more: Whether there are more items available after this set
-    :param url: The URL for accessing this list
-    """
-
-    data: list[dict[str, Any]]
-    has_more: bool
-    url: str | None = None

llama_stack/apis/conversations/__init__.py

@@ -1,31 +0,0 @@
-# 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 .conversations import (
-    Conversation,
-    ConversationCreateRequest,
-    ConversationDeletedResource,
-    ConversationItem,
-    ConversationItemCreateRequest,
-    ConversationItemDeletedResource,
-    ConversationItemList,
-    Conversations,
-    ConversationUpdateRequest,
-    Metadata,
-)
-
-__all__ = [
-    "Conversation",
-    "ConversationCreateRequest",
-    "ConversationDeletedResource",
-    "ConversationItem",
-    "ConversationItemCreateRequest",
-    "ConversationItemDeletedResource",
-    "ConversationItemList",
-    "Conversations",
-    "ConversationUpdateRequest",
-    "Metadata",
-]

llama_stack/apis/datasets/datasets.py

@@ -1,251 +0,0 @@
-# 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, StrEnum
-from typing import Annotated, Any, Literal, Protocol
-
-from pydantic import BaseModel, Field
-
-from llama_stack.apis.resource import Resource, ResourceType
-from llama_stack.apis.version import LLAMA_STACK_API_V1, LLAMA_STACK_API_V1BETA
-from llama_stack.schema_utils import json_schema_type, register_schema, webmethod
-
-
-class DatasetPurpose(StrEnum):
-    """
-    Purpose of the dataset. Each purpose has a required input data schema.
-
-    :cvar post-training/messages: The dataset contains messages used for post-training.
-        {
-            "messages": [
-                {"role": "user", "content": "Hello, world!"},
-                {"role": "assistant", "content": "Hello, world!"},
-            ]
-        }
-    :cvar eval/question-answer: The dataset contains a question column and an answer column.
-        {
-            "question": "What is the capital of France?",
-            "answer": "Paris"
-        }
-    :cvar eval/messages-answer: The dataset contains a messages column with list of messages and an answer column.
-        {
-            "messages": [
-                {"role": "user", "content": "Hello, my name is John Doe."},
-                {"role": "assistant", "content": "Hello, John Doe. How can I help you today?"},
-                {"role": "user", "content": "What's my name?"},
-            ],
-            "answer": "John Doe"
-        }
-    """
-
-    post_training_messages = "post-training/messages"
-    eval_question_answer = "eval/question-answer"
-    eval_messages_answer = "eval/messages-answer"
-
-    # TODO: add more schemas here
-
-
-class DatasetType(Enum):
-    """
-    Type of the dataset source.
-    :cvar uri: The dataset can be obtained from a URI.
-    :cvar rows: The dataset is stored in rows.
-    """
-
-    uri = "uri"
-    rows = "rows"
-
-
-@json_schema_type
-class URIDataSource(BaseModel):
-    """A dataset that can be obtained from a URI.
-    :param uri: The dataset can be obtained from a URI. E.g.
-        - "https://mywebsite.com/mydata.jsonl"
-        - "lsfs://mydata.jsonl"
-        - "data:csv;base64,{base64_content}"
-    """
-
-    type: Literal["uri"] = "uri"
-    uri: str
-
-
-@json_schema_type
-class RowsDataSource(BaseModel):
-    """A dataset stored in rows.
-    :param rows: The dataset is stored in rows. E.g.
-        - [
-            {"messages": [{"role": "user", "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}
-        ]
-    """
-
-    type: Literal["rows"] = "rows"
-    rows: list[dict[str, Any]]
-
-
-DataSource = Annotated[
-    URIDataSource | RowsDataSource,
-    Field(discriminator="type"),
-]
-register_schema(DataSource, name="DataSource")
-
-
-class CommonDatasetFields(BaseModel):
-    """
-    Common fields for a dataset.
-
-    :param purpose: Purpose of the dataset indicating its intended use
-    :param source: Data source configuration for the dataset
-    :param metadata: Additional metadata for the dataset
-    """
-
-    purpose: DatasetPurpose
-    source: DataSource
-    metadata: dict[str, Any] = Field(
-        default_factory=dict,
-        description="Any additional metadata for this dataset",
-    )
-
-
-@json_schema_type
-class Dataset(CommonDatasetFields, Resource):
-    """Dataset resource for storing and accessing training or evaluation data.
-
-    :param type: Type of resource, always 'dataset' for datasets
-    """
-
-    type: Literal[ResourceType.dataset] = ResourceType.dataset
-
-    @property
-    def dataset_id(self) -> str:
-        return self.identifier
-
-    @property
-    def provider_dataset_id(self) -> str | None:
-        return self.provider_resource_id
-
-
-class DatasetInput(CommonDatasetFields, BaseModel):
-    """Input parameters for dataset operations.
-
-    :param dataset_id: Unique identifier for the dataset
-    """
-
-    dataset_id: str
-
-
-class ListDatasetsResponse(BaseModel):
-    """Response from listing datasets.
-
-    :param data: List of datasets
-    """
-
-    data: list[Dataset]
-
-
-class Datasets(Protocol):
-    @webmethod(route="/datasets", method="POST", deprecated=True, level=LLAMA_STACK_API_V1)
-    @webmethod(route="/datasets", method="POST", level=LLAMA_STACK_API_V1BETA)
-    async def register_dataset(
-        self,
-        purpose: DatasetPurpose,
-        source: DataSource,
-        metadata: dict[str, Any] | None = None,
-        dataset_id: str | None = None,
-    ) -> Dataset:
-        """
-        Register a new dataset.
-
-        :param purpose: The purpose of the dataset.
-        One of:
-            - "post-training/messages": The dataset contains a messages column with list of messages for post-training.
-                {
-                    "messages": [
-                        {"role": "user", "content": "Hello, world!"},
-                        {"role": "assistant", "content": "Hello, world!"},
-                    ]
-                }
-            - "eval/question-answer": The dataset contains a question column and an answer column for evaluation.
-                {
-                    "question": "What is the capital of France?",
-                    "answer": "Paris"
-                }
-            - "eval/messages-answer": The dataset contains a messages column with list of messages and an answer column for evaluation.
-                {
-                    "messages": [
-                        {"role": "user", "content": "Hello, my name is John Doe."},
-                        {"role": "assistant", "content": "Hello, John Doe. How can I help you today?"},
-                        {"role": "user", "content": "What's my name?"},
-                    ],
-                    "answer": "John Doe"
-                }
-        :param source: The data source of the dataset. Ensure that the data source schema is compatible with the purpose of the dataset. Examples:
-           - {
-               "type": "uri",
-               "uri": "https://mywebsite.com/mydata.jsonl"
-           }
-           - {
-               "type": "uri",
-               "uri": "lsfs://mydata.jsonl"
-           }
-           - {
-               "type": "uri",
-               "uri": "data:csv;base64,{base64_content}"
-           }
-           - {
-               "type": "uri",
-               "uri": "huggingface://llamastack/simpleqa?split=train"
-           }
-           - {
-               "type": "rows",
-               "rows": [
-                   {
-                       "messages": [
-                           {"role": "user", "content": "Hello, world!"},
-                           {"role": "assistant", "content": "Hello, world!"},
-                       ]
-                   }
-               ]
-           }
-        :param metadata: The metadata for the dataset.
-           - E.g. {"description": "My dataset"}.
-        :param dataset_id: The ID of the dataset. If not provided, an ID will be generated.
-        :returns: A Dataset.
-        """
-        ...
-
-    @webmethod(route="/datasets/{dataset_id:path}", method="GET", deprecated=True, level=LLAMA_STACK_API_V1)
-    @webmethod(route="/datasets/{dataset_id:path}", method="GET", level=LLAMA_STACK_API_V1BETA)
-    async def get_dataset(
-        self,
-        dataset_id: str,
-    ) -> Dataset:
-        """Get a dataset by its ID.
-
-        :param dataset_id: The ID of the dataset to get.
-        :returns: A Dataset.
-        """
-        ...
-
-    @webmethod(route="/datasets", method="GET", deprecated=True, level=LLAMA_STACK_API_V1)
-    @webmethod(route="/datasets", method="GET", level=LLAMA_STACK_API_V1BETA)
-    async def list_datasets(self) -> ListDatasetsResponse:
-        """List all datasets.
-
-        :returns: A ListDatasetsResponse.
-        """
-        ...
-
-    @webmethod(route="/datasets/{dataset_id:path}", method="DELETE", deprecated=True, level=LLAMA_STACK_API_V1)
-    @webmethod(route="/datasets/{dataset_id:path}", method="DELETE", level=LLAMA_STACK_API_V1BETA)
-    async def unregister_dataset(
-        self,
-        dataset_id: str,
-    ) -> None:
-        """Unregister a dataset by its ID.
-
-        :param dataset_id: The ID of the dataset to unregister.
-        """
-        ...