模型接口

ModelTracing

基础: Enum

源代码在 src/agents/models/interface.py

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

禁用 类属性 实例属性

DISABLED = 0

完全禁用追踪。

启用 类属性 实例属性

ENABLED = 1

启用追踪，并包含所有数据。

启用但不包含数据 类属性 实例属性

ENABLED_WITHOUT_DATA = 2

启用追踪，但不包含输入/输出。

模型

基础: ABC

调用 LLM 的基本接口。

源代码在 src/agents/models/interface.py

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,
        conversation_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.
            conversation_id: The ID of the stored conversation, if any.
            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,
        conversation_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.
            conversation_id: The ID of the stored conversation, if any.
            prompt: The prompt config to use for the model.

        Returns:
            An iterator of response stream events, in OpenAI Responses format.
        """
        pass

获取响应 抽象方法 异步

get_response(
    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,
    conversation_id: str | None,
    prompt: ResponsePromptParam | None,
) -> ModelResponse

从模型获取响应。

参数

名称	类型	描述	默认
系统指令	str | None	要使用的系统指令。	required
input	字符串 | 列表[TResponseInputItem]	以 OpenAI Responses 格式呈现的模型输入项。	required
模型设置	ModelSettings	要使用的模型设置。	required
工具	列表[工具]	模型可用的工具。	required
输出模式	AgentOutputSchemaBase | None	要使用的输出模式。	required
handoffs	列表[Handoff]	模型可用的交接。	required
追踪	ModelTracing	追踪配置。	required
先前的响应 ID	str | None	先前的响应的 ID。通常情况下，模型不使用它，除非是 OpenAI Responses API。	required
会话 ID	str | None	存储会话的 ID（如果有）。	required
prompt	ResponsePromptParam | None	要用于模型的提示配置。	required

返回值

类型	描述
ModelResponse	完整的模型响应。

源代码在 src/agents/models/interface.py

@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,
    conversation_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.
        conversation_id: The ID of the stored conversation, if any.
        prompt: The prompt config to use for the model.

    Returns:
        The full model response.
    """
    pass

流式响应 抽象方法

stream_response(
    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,
    conversation_id: str | None,
    prompt: ResponsePromptParam | None,
) -> AsyncIterator[TResponseStreamEvent]

从模型流式传输响应。

参数

名称	类型	描述	默认
系统指令	str | None	要使用的系统指令。	required
input	字符串 | 列表[TResponseInputItem]	以 OpenAI Responses 格式呈现的模型输入项。	required
模型设置	ModelSettings	要使用的模型设置。	required
工具	列表[工具]	模型可用的工具。	required
输出模式	AgentOutputSchemaBase | None	要使用的输出模式。	required
handoffs	列表[Handoff]	模型可用的交接。	required
追踪	ModelTracing	追踪配置。	required
先前的响应 ID	str | None	先前的响应的 ID。通常情况下，模型不使用它，除非是 OpenAI Responses API。	required
会话 ID	str | None	存储会话的 ID（如果有）。	required
prompt	ResponsePromptParam | None	要用于模型的提示配置。	required

返回值

类型	描述
AsyncIterator[TResponseStreamEvent]	以 OpenAI Responses 格式呈现的响应流事件的迭代器。

源代码在 src/agents/models/interface.py

@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,
    conversation_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.
        conversation_id: The ID of the stored conversation, if any.
        prompt: The prompt config to use for the model.

    Returns:
        An iterator of response stream events, in OpenAI Responses format.
    """
    pass

ModelProvider

基础: ABC

The base interface for a model provider.

模型提供者负责按名称查找模型。

源代码在 src/agents/models/interface.py

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.
        """

获取模型 抽象方法

get_model(model_name: str | None) -> Model

按名称获取模型。

参数

名称	类型	描述	默认
模型名称	str | None	The name of the model to get.	required

返回值

类型	描述
模型	模型。

源代码在 src/agents/models/interface.py

@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.
    """