Spaces:
Running
Running
File size: 3,839 Bytes
d631808 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
from __future__ import annotations
import abc
import enum
from collections.abc import AsyncIterator
from typing import TYPE_CHECKING
from openai.types.responses.response_prompt_param import ResponsePromptParam
from ..agent_output import AgentOutputSchemaBase
from ..handoffs import Handoff
from ..items import ModelResponse, TResponseInputItem, TResponseStreamEvent
from ..tool import Tool
if TYPE_CHECKING:
from ..model_settings import ModelSettings
class ModelTracing(enum.Enum):
DISABLED = 0
"""Tracing is disabled entirely."""
ENABLED = 1
"""Tracing is enabled, and all data is included."""
ENABLED_WITHOUT_DATA = 2
"""Tracing is enabled, but inputs/outputs are not included."""
def is_disabled(self) -> bool:
return self == ModelTracing.DISABLED
def include_data(self) -> bool:
return self == ModelTracing.ENABLED
class Model(abc.ABC):
"""The base interface for calling an LLM."""
@abc.abstractmethod
async def get_response(
self,
system_instructions: str | None,
input: str | list[TResponseInputItem],
model_settings: ModelSettings,
tools: list[Tool],
output_schema: AgentOutputSchemaBase | None,
handoffs: list[Handoff],
tracing: ModelTracing,
*,
previous_response_id: str | None,
prompt: ResponsePromptParam | None,
) -> ModelResponse:
"""Get a response from the model.
Args:
system_instructions: The system instructions to use.
input: The input items to the model, in OpenAI Responses format.
model_settings: The model settings to use.
tools: The tools available to the model.
output_schema: The output schema to use.
handoffs: The handoffs available to the model.
tracing: Tracing configuration.
previous_response_id: the ID of the previous response. Generally not used by the model,
except for the OpenAI Responses API.
prompt: The prompt config to use for the model.
Returns:
The full model response.
"""
pass
@abc.abstractmethod
def stream_response(
self,
system_instructions: str | None,
input: str | list[TResponseInputItem],
model_settings: ModelSettings,
tools: list[Tool],
output_schema: AgentOutputSchemaBase | None,
handoffs: list[Handoff],
tracing: ModelTracing,
*,
previous_response_id: str | None,
prompt: ResponsePromptParam | None,
) -> AsyncIterator[TResponseStreamEvent]:
"""Stream a response from the model.
Args:
system_instructions: The system instructions to use.
input: The input items to the model, in OpenAI Responses format.
model_settings: The model settings to use.
tools: The tools available to the model.
output_schema: The output schema to use.
handoffs: The handoffs available to the model.
tracing: Tracing configuration.
previous_response_id: the ID of the previous response. Generally not used by the model,
except for the OpenAI Responses API.
prompt: The prompt config to use for the model.
Returns:
An iterator of response stream events, in OpenAI Responses format.
"""
pass
class ModelProvider(abc.ABC):
"""The base interface for a model provider.
Model provider is responsible for looking up Models by name.
"""
@abc.abstractmethod
def get_model(self, model_name: str | None) -> Model:
"""Get a model by name.
Args:
model_name: The name of the model to get.
Returns:
The model.
"""
|