llama-stack-api 0.4.4__py3-none-any.whl → 0.5.0rc1__py3-none-any.whl

llama_stack_api/agents.py

@@ -1,173 +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 collections.abc import AsyncIterator
-from enum import StrEnum
-from typing import Annotated, Protocol, runtime_checkable
-
-from pydantic import BaseModel
-
-from llama_stack_api.common.responses import Order
-from llama_stack_api.schema_utils import ExtraBodyField, json_schema_type, webmethod
-from llama_stack_api.version import LLAMA_STACK_API_V1
-
-from .openai_responses import (
-    ListOpenAIResponseInputItem,
-    ListOpenAIResponseObject,
-    OpenAIDeleteResponseObject,
-    OpenAIResponseInput,
-    OpenAIResponseInputTool,
-    OpenAIResponseInputToolChoice,
-    OpenAIResponseObject,
-    OpenAIResponseObjectStream,
-    OpenAIResponsePrompt,
-    OpenAIResponseText,
-)
-
-
-@json_schema_type
-class ResponseGuardrailSpec(BaseModel):
-    """Specification for a guardrail to apply during response generation.
-
-    :param type: The type/identifier of the guardrail.
-    """
-
-    type: str
-    # TODO: more fields to be added for guardrail configuration
-
-
-ResponseGuardrail = str | ResponseGuardrailSpec
-
-
-class ResponseItemInclude(StrEnum):
-    """
-    Specify additional output data to include in the model response.
-    """
-
-    web_search_call_action_sources = "web_search_call.action.sources"
-    code_interpreter_call_outputs = "code_interpreter_call.outputs"
-    computer_call_output_output_image_url = "computer_call_output.output.image_url"
-    file_search_call_results = "file_search_call.results"
-    message_input_image_image_url = "message.input_image.image_url"
-    message_output_text_logprobs = "message.output_text.logprobs"
-    reasoning_encrypted_content = "reasoning.encrypted_content"
-
-
-@runtime_checkable
-class Agents(Protocol):
-    """Agents
-
-    APIs for creating and interacting with agentic systems."""
-
-    # We situate the OpenAI Responses API in the Agents API just like we did things
-    # for Inference. The Responses API, in its intent, serves the same purpose as
-    # the Agents API above -- it is essentially a lightweight "agentic loop" with
-    # integrated tool calling.
-    #
-    # Both of these APIs are inherently stateful.
-
-    @webmethod(route="/responses/{response_id}", method="GET", level=LLAMA_STACK_API_V1)
-    async def get_openai_response(
-        self,
-        response_id: str,
-    ) -> OpenAIResponseObject:
-        """Get a model response.
-
-        :param response_id: The ID of the OpenAI response to retrieve.
-        :returns: An OpenAIResponseObject.
-        """
-        ...
-
-    @webmethod(route="/responses", method="POST", level=LLAMA_STACK_API_V1)
-    async def create_openai_response(
-        self,
-        input: str | list[OpenAIResponseInput],
-        model: str,
-        prompt: OpenAIResponsePrompt | None = None,
-        instructions: str | None = None,
-        parallel_tool_calls: bool | None = True,
-        previous_response_id: str | None = None,
-        conversation: str | None = None,
-        store: bool | None = True,
-        stream: bool | None = False,
-        temperature: float | None = None,
-        text: OpenAIResponseText | None = None,
-        tool_choice: OpenAIResponseInputToolChoice | None = None,
-        tools: list[OpenAIResponseInputTool] | None = None,
-        include: list[ResponseItemInclude] | None = None,
-        max_infer_iters: int | None = 10,  # this is an extension to the OpenAI API
-        guardrails: Annotated[
-            list[ResponseGuardrail] | None,
-            ExtraBodyField(
-                "List of guardrails to apply during response generation. Guardrails provide safety and content moderation."
-            ),
-        ] = None,
-        max_tool_calls: int | None = None,
-        metadata: dict[str, str] | None = None,
-    ) -> OpenAIResponseObject | AsyncIterator[OpenAIResponseObjectStream]:
-        """Create a model response.
-
-        :param input: Input message(s) to create the response.
-        :param model: The underlying LLM used for completions.
-        :param prompt: (Optional) Prompt object with ID, version, and variables.
-        :param previous_response_id: (Optional) if specified, the new response will be a continuation of the previous response. This can be used to easily fork-off new responses from existing responses.
-        :param conversation: (Optional) The ID of a conversation to add the response to. Must begin with 'conv_'. Input and output messages will be automatically added to the conversation.
-        :param include: (Optional) Additional fields to include in the response.
-        :param guardrails: (Optional) List of guardrails to apply during response generation. Can be guardrail IDs (strings) or guardrail specifications.
-        :param max_tool_calls: (Optional) Max number of total calls to built-in tools that can be processed in a response.
-        :param metadata: (Optional) Dictionary of metadata key-value pairs to attach to the response.
-        :returns: An OpenAIResponseObject.
-        """
-        ...
-
-    @webmethod(route="/responses", method="GET", level=LLAMA_STACK_API_V1)
-    async def list_openai_responses(
-        self,
-        after: str | None = None,
-        limit: int | None = 50,
-        model: str | None = None,
-        order: Order | None = Order.desc,
-    ) -> ListOpenAIResponseObject:
-        """List all responses.
-
-        :param after: The ID of the last response to return.
-        :param limit: The number of responses to return.
-        :param model: The model to filter responses by.
-        :param order: The order to sort responses by when sorted by created_at ('asc' or 'desc').
-        :returns: A ListOpenAIResponseObject.
-        """
-        ...
-
-    @webmethod(route="/responses/{response_id}/input_items", method="GET", level=LLAMA_STACK_API_V1)
-    async def list_openai_response_input_items(
-        self,
-        response_id: str,
-        after: str | None = None,
-        before: str | None = None,
-        include: list[str] | None = None,
-        limit: int | None = 20,
-        order: Order | None = Order.desc,
-    ) -> ListOpenAIResponseInputItem:
-        """List input items.
-
-        :param response_id: The ID of the response to retrieve input items for.
-        :param after: An item ID to list items after, used for pagination.
-        :param before: An item ID to list items before, used for pagination.
-        :param include: Additional fields to include in the response.
-        :param limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
-        :param order: The order to return the input items in. Default is desc.
-        :returns: An ListOpenAIResponseInputItem.
-        """
-        ...
-
-    @webmethod(route="/responses/{response_id}", method="DELETE", level=LLAMA_STACK_API_V1)
-    async def delete_openai_response(self, response_id: str) -> OpenAIDeleteResponseObject:
-        """Delete a response.
-
-        :param response_id: The ID of the OpenAI response to delete.
-        :returns: An OpenAIDeleteResponseObject
-        """
-        ...

llama_stack_api/connectors.py

@@ -1,146 +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 StrEnum
-from typing import Literal, Protocol
-
-from pydantic import BaseModel, Field
-from typing_extensions import runtime_checkable
-
-from llama_stack_api.resource import Resource, ResourceType
-from llama_stack_api.schema_utils import json_schema_type, webmethod
-from llama_stack_api.tools import ToolDef
-from llama_stack_api.version import LLAMA_STACK_API_V1ALPHA
-
-
-@json_schema_type
-class ConnectorType(StrEnum):
-    """Type of connector."""
-
-    MCP = "mcp"
-
-
-class CommonConnectorFields(BaseModel):
-    """Common fields for all connectors.
-
-    :param connector_type: Type of connector
-    :param connector_id: Identifier for the connector
-    :param url: URL of the connector
-    :param server_label: (Optional) Label of the server
-    """
-
-    connector_type: ConnectorType = Field(default=ConnectorType.MCP)
-    connector_id: str = Field(..., description="Identifier for the connector")
-    url: str = Field(..., description="URL of the connector")
-    server_label: str | None = Field(default=None, description="Label of the server")
-
-
-@json_schema_type
-class Connector(CommonConnectorFields, Resource):
-    """A connector resource representing a connector registered in Llama Stack.
-
-    :param type: Type of resource, always 'connector' for connectors
-    :param server_name: (Optional) Name of the server
-    :param server_description: (Optional) Description of the server
-    """
-
-    model_config = {"populate_by_name": True}
-    type: Literal[ResourceType.connector] = ResourceType.connector
-    server_name: str | None = Field(default=None, description="Name of the server")
-    server_description: str | None = Field(default=None, description="Description of the server")
-
-
-@json_schema_type
-class ConnectorInput(CommonConnectorFields):
-    """Input for creating a connector
-
-    :param type: Type of resource, always 'connector' for connectors
-    """
-
-    type: Literal[ResourceType.connector] = ResourceType.connector
-
-
-@json_schema_type
-class ListConnectorsResponse(BaseModel):
-    """Response containing a list of connectors.
-
-    :param data: List of connectors
-    """
-
-    data: list[Connector]
-
-
-@json_schema_type
-class ListToolsResponse(BaseModel):
-    """Response containing a list of tools.
-
-    :param data: List of tools
-    """
-
-    data: list[ToolDef]
-
-
-@runtime_checkable
-class Connectors(Protocol):
-    # NOTE: Route order matters! More specific routes must come before less specific ones.
-    # Routes with {param:path} are greedy and will match everything including slashes.
-
-    @webmethod(route="/connectors", method="GET", level=LLAMA_STACK_API_V1ALPHA)
-    async def list_connectors(
-        self,
-    ) -> ListConnectorsResponse:
-        """List all configured connectors.
-
-        :returns: A ListConnectorsResponse.
-        """
-        ...
-
-    @webmethod(route="/connectors/{connector_id}/tools/{tool_name}", method="GET", level=LLAMA_STACK_API_V1ALPHA)
-    async def get_connector_tool(
-        self,
-        connector_id: str,
-        tool_name: str,
-        authorization: str | None = None,
-    ) -> ToolDef:
-        """Get a tool definition by its name from a connector.
-
-        :param connector_id: The ID of the connector to get the tool from.
-        :param tool_name: The name of the tool to get.
-        :param authorization: (Optional) OAuth access token for authenticating with the MCP server.
-
-        :returns: A ToolDef.
-        """
-        ...
-
-    @webmethod(route="/connectors/{connector_id}/tools", method="GET", level=LLAMA_STACK_API_V1ALPHA)
-    async def list_connector_tools(
-        self,
-        connector_id: str,
-        authorization: str | None = None,
-    ) -> ListToolsResponse:
-        """List tools available from a connector.
-
-        :param connector_id: The ID of the connector to list tools for.
-        :param authorization: (Optional) OAuth access token for authenticating with the MCP server.
-
-        :returns: A ListToolsResponse.
-        """
-        ...
-
-    @webmethod(route="/connectors/{connector_id}", method="GET", level=LLAMA_STACK_API_V1ALPHA)
-    async def get_connector(
-        self,
-        connector_id: str,
-        authorization: str | None = None,
-    ) -> Connector:
-        """Get a connector by its ID.
-
-        :param connector_id: The ID of the connector to get.
-        :param authorization: (Optional) OAuth access token for authenticating with the MCP server.
-
-        :returns: A Connector.
-        """
-        ...

llama_stack_api/conversations.py

@@ -1,270 +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 StrEnum
-from typing import Annotated, Literal, Protocol, runtime_checkable
-
-from pydantic import BaseModel, Field
-
-from llama_stack_api.openai_responses import (
-    OpenAIResponseInputFunctionToolCallOutput,
-    OpenAIResponseMCPApprovalRequest,
-    OpenAIResponseMCPApprovalResponse,
-    OpenAIResponseMessage,
-    OpenAIResponseOutputMessageFileSearchToolCall,
-    OpenAIResponseOutputMessageFunctionToolCall,
-    OpenAIResponseOutputMessageMCPCall,
-    OpenAIResponseOutputMessageMCPListTools,
-    OpenAIResponseOutputMessageWebSearchToolCall,
-)
-from llama_stack_api.schema_utils import json_schema_type, register_schema, webmethod
-from llama_stack_api.version import LLAMA_STACK_API_V1
-
-Metadata = dict[str, str]
-
-
-@json_schema_type
-class Conversation(BaseModel):
-    """OpenAI-compatible conversation object."""
-
-    id: str = Field(..., description="The unique ID of the conversation.")
-    object: Literal["conversation"] = Field(
-        default="conversation", description="The object type, which is always conversation."
-    )
-    created_at: int = Field(
-        ..., description="The time at which the conversation was created, measured in seconds since the Unix epoch."
-    )
-    metadata: Metadata | None = Field(
-        default=None,
-        description="Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.",
-    )
-    items: list[dict] | None = Field(
-        default=None,
-        description="Initial items to include in the conversation context. You may add up to 20 items at a time.",
-    )
-
-
-@json_schema_type
-class ConversationMessage(BaseModel):
-    """OpenAI-compatible message item for conversations."""
-
-    id: str = Field(..., description="unique identifier for this message")
-    content: list[dict] = Field(..., description="message content")
-    role: str = Field(..., description="message role")
-    status: str = Field(..., description="message status")
-    type: Literal["message"] = "message"
-    object: Literal["message"] = "message"
-
-
-ConversationItem = Annotated[
-    OpenAIResponseMessage
-    | OpenAIResponseOutputMessageWebSearchToolCall
-    | OpenAIResponseOutputMessageFileSearchToolCall
-    | OpenAIResponseOutputMessageFunctionToolCall
-    | OpenAIResponseInputFunctionToolCallOutput
-    | OpenAIResponseMCPApprovalRequest
-    | OpenAIResponseMCPApprovalResponse
-    | OpenAIResponseOutputMessageMCPCall
-    | OpenAIResponseOutputMessageMCPListTools
-    | OpenAIResponseOutputMessageMCPCall
-    | OpenAIResponseOutputMessageMCPListTools,
-    Field(discriminator="type"),
-]
-register_schema(ConversationItem, name="ConversationItem")
-
-# Using OpenAI types directly caused issues but some notes for reference:
-# Note that ConversationItem is a Annotated Union of the types below:
-# from openai.types.responses import *
-# from openai.types.responses.response_item import *
-# from openai.types.conversations import ConversationItem
-# f = [
-#     ResponseFunctionToolCallItem,
-#     ResponseFunctionToolCallOutputItem,
-#     ResponseFileSearchToolCall,
-#     ResponseFunctionWebSearch,
-#     ImageGenerationCall,
-#     ResponseComputerToolCall,
-#     ResponseComputerToolCallOutputItem,
-#     ResponseReasoningItem,
-#     ResponseCodeInterpreterToolCall,
-#     LocalShellCall,
-#     LocalShellCallOutput,
-#     McpListTools,
-#     McpApprovalRequest,
-#     McpApprovalResponse,
-#     McpCall,
-#     ResponseCustomToolCall,
-#     ResponseCustomToolCallOutput
-# ]
-
-
-@json_schema_type
-class ConversationDeletedResource(BaseModel):
-    """Response for deleted conversation."""
-
-    id: str = Field(..., description="The deleted conversation identifier")
-    object: str = Field(default="conversation.deleted", description="Object type")
-    deleted: bool = Field(default=True, description="Whether the object was deleted")
-
-
-@json_schema_type
-class ConversationItemCreateRequest(BaseModel):
-    """Request body for creating conversation items."""
-
-    items: list[ConversationItem] = Field(
-        ...,
-        description="Items to include in the conversation context. You may add up to 20 items at a time.",
-        max_length=20,
-    )
-
-
-class ConversationItemInclude(StrEnum):
-    """
-    Specify additional output data to include in the model response.
-    """
-
-    web_search_call_action_sources = "web_search_call.action.sources"
-    code_interpreter_call_outputs = "code_interpreter_call.outputs"
-    computer_call_output_output_image_url = "computer_call_output.output.image_url"
-    file_search_call_results = "file_search_call.results"
-    message_input_image_image_url = "message.input_image.image_url"
-    message_output_text_logprobs = "message.output_text.logprobs"
-    reasoning_encrypted_content = "reasoning.encrypted_content"
-
-
-@json_schema_type
-class ConversationItemList(BaseModel):
-    """List of conversation items with pagination."""
-
-    object: str = Field(default="list", description="Object type")
-    data: list[ConversationItem] = Field(..., description="List of conversation items")
-    first_id: str | None = Field(default=None, description="The ID of the first item in the list")
-    last_id: str | None = Field(default=None, description="The ID of the last item in the list")
-    has_more: bool = Field(default=False, description="Whether there are more items available")
-
-
-@json_schema_type
-class ConversationItemDeletedResource(BaseModel):
-    """Response for deleted conversation item."""
-
-    id: str = Field(..., description="The deleted item identifier")
-    object: str = Field(default="conversation.item.deleted", description="Object type")
-    deleted: bool = Field(default=True, description="Whether the object was deleted")
-
-
-@runtime_checkable
-class Conversations(Protocol):
-    """Conversations
-
-    Protocol for conversation management operations."""
-
-    @webmethod(route="/conversations", method="POST", level=LLAMA_STACK_API_V1)
-    async def create_conversation(
-        self, items: list[ConversationItem] | None = None, metadata: Metadata | None = None
-    ) -> Conversation:
-        """Create a conversation.
-
-        Create a conversation.
-
-        :param items: Initial items to include in the conversation context.
-        :param metadata: Set of key-value pairs that can be attached to an object.
-        :returns: The created conversation object.
-        """
-        ...
-
-    @webmethod(route="/conversations/{conversation_id}", method="GET", level=LLAMA_STACK_API_V1)
-    async def get_conversation(self, conversation_id: str) -> Conversation:
-        """Retrieve a conversation.
-
-        Get a conversation with the given ID.
-
-        :param conversation_id: The conversation identifier.
-        :returns: The conversation object.
-        """
-        ...
-
-    @webmethod(route="/conversations/{conversation_id}", method="POST", level=LLAMA_STACK_API_V1)
-    async def update_conversation(self, conversation_id: str, metadata: Metadata) -> Conversation:
-        """Update a conversation.
-
-        Update a conversation's metadata with the given ID.
-
-        :param conversation_id: The conversation identifier.
-        :param metadata: Set of key-value pairs that can be attached to an object.
-        :returns: The updated conversation object.
-        """
-        ...
-
-    @webmethod(route="/conversations/{conversation_id}", method="DELETE", level=LLAMA_STACK_API_V1)
-    async def openai_delete_conversation(self, conversation_id: str) -> ConversationDeletedResource:
-        """Delete a conversation.
-
-        Delete a conversation with the given ID.
-
-        :param conversation_id: The conversation identifier.
-        :returns: The deleted conversation resource.
-        """
-        ...
-
-    @webmethod(route="/conversations/{conversation_id}/items", method="POST", level=LLAMA_STACK_API_V1)
-    async def add_items(self, conversation_id: str, items: list[ConversationItem]) -> ConversationItemList:
-        """Create items.
-
-        Create items in the conversation.
-
-        :param conversation_id: The conversation identifier.
-        :param items: Items to include in the conversation context.
-        :returns: List of created items.
-        """
-        ...
-
-    @webmethod(route="/conversations/{conversation_id}/items/{item_id}", method="GET", level=LLAMA_STACK_API_V1)
-    async def retrieve(self, conversation_id: str, item_id: str) -> ConversationItem:
-        """Retrieve an item.
-
-        Retrieve a conversation item.
-
-        :param conversation_id: The conversation identifier.
-        :param item_id: The item identifier.
-        :returns: The conversation item.
-        """
-        ...
-
-    @webmethod(route="/conversations/{conversation_id}/items", method="GET", level=LLAMA_STACK_API_V1)
-    async def list_items(
-        self,
-        conversation_id: str,
-        after: str | None = None,
-        include: list[ConversationItemInclude] | None = None,
-        limit: int | None = None,
-        order: Literal["asc", "desc"] | None = None,
-    ) -> ConversationItemList:
-        """List items.
-
-        List items in the conversation.
-
-        :param conversation_id: The conversation identifier.
-        :param after: An item ID to list items after, used in pagination.
-        :param include: Specify additional output data to include in the response.
-        :param limit: A limit on the number of objects to be returned (1-100, default 20).
-        :param order: The order to return items in (asc or desc, default desc).
-        :returns: List of conversation items.
-        """
-        ...
-
-    @webmethod(route="/conversations/{conversation_id}/items/{item_id}", method="DELETE", level=LLAMA_STACK_API_V1)
-    async def openai_delete_conversation_item(
-        self, conversation_id: str, item_id: str
-    ) -> ConversationItemDeletedResource:
-        """Delete an item.
-
-        Delete a conversation item.
-
-        :param conversation_id: The conversation identifier.
-        :param item_id: The item identifier.
-        :returns: The deleted item resource.
-        """
-        ...

llama_stack_api/datasetio.py

@@ -1,55 +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, Protocol, runtime_checkable
-
-from llama_stack_api.common.responses import PaginatedResponse
-from llama_stack_api.datasets import Dataset
-from llama_stack_api.schema_utils import webmethod
-from llama_stack_api.version import LLAMA_STACK_API_V1BETA
-
-
-class DatasetStore(Protocol):
-    def get_dataset(self, dataset_id: str) -> Dataset: ...
-
-
-@runtime_checkable
-class DatasetIO(Protocol):
-    # keeping for aligning with inference/safety, but this is not used
-    dataset_store: DatasetStore
-
-    @webmethod(route="/datasetio/iterrows/{dataset_id:path}", method="GET", level=LLAMA_STACK_API_V1BETA)
-    async def iterrows(
-        self,
-        dataset_id: str,
-        start_index: int | None = None,
-        limit: int | None = None,
-    ) -> PaginatedResponse:
-        """Get a paginated list of rows from a dataset.
-
-        Uses offset-based pagination where:
-        - start_index: The starting index (0-based). If None, starts from beginning.
-        - limit: Number of items to return. If None or -1, returns all items.
-
-        The response includes:
-        - data: List of items for the current page.
-        - has_more: Whether there are more items available after this set.
-
-        :param dataset_id: The ID of the dataset to get the rows from.
-        :param start_index: Index into dataset for the first row to get. Get all rows if None.
-        :param limit: The number of rows to get.
-        :returns: A PaginatedResponse.
-        """
-        ...
-
-    @webmethod(route="/datasetio/append-rows/{dataset_id:path}", method="POST", level=LLAMA_STACK_API_V1BETA)
-    async def append_rows(self, dataset_id: str, rows: list[dict[str, Any]]) -> None:
-        """Append rows to a dataset.
-
-        :param dataset_id: The ID of the dataset to append the rows to.
-        :param rows: The rows to append to the dataset.
-        """
-        ...