diff --git a/.release-please-manifest.json b/.release-please-manifest.json index b56c3d0b..e8285b71 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.4" + ".": "0.1.0-alpha.5" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 91523e16..3a087b17 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 34 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sgp%2Fagentex-sdk-021b55c88964b7a5bfc9d692d32a52c6b0150445656d2407c4cb8e9dd1e5f100.yml -openapi_spec_hash: ed92c0d5d6bed9cb5617f8a776ac42c9 -config_hash: 7661726e3cccf9f6349179841153601d +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sgp%2Fagentex-sdk-1d08fb2290b5310c91801d7575d356628d372fd5434e15d3b9cead48eadb893f.yml +openapi_spec_hash: c07c588fb8429fbf024189df62f20fa4 +config_hash: 2e4b423af3db79ebd8170c401ea9093a diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f014202..14160687 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # Changelog +## 0.1.0-alpha.5 (2025-07-23) + +Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/scaleapi/agentex-python/compare/v0.1.0-alpha.4...v0.1.0-alpha.5) + +### Features + +* **api:** deprecate name subresource ([14881c0](https://github.com/scaleapi/agentex-python/commit/14881c0ff2922e0a622975a0f5b314de99d7aabb)) +* **api:** manual updates ([d999a43](https://github.com/scaleapi/agentex-python/commit/d999a438c409f04b7e36b5df2d9b080d1d1b0e4a)) +* **api:** manual updates ([a885d8d](https://github.com/scaleapi/agentex-python/commit/a885d8dbabfe2cc2a556ef02e75e5502fd799c46)) + + +### Bug Fixes + +* **api:** build errors ([7bde6b7](https://github.com/scaleapi/agentex-python/commit/7bde6b727d6d16ebd6805ef843596fc3224445a6)) +* **parsing:** parse extra field types ([d40e6e0](https://github.com/scaleapi/agentex-python/commit/d40e6e0d6911be0bc9bfc419e02bd7c1d5ad5be4)) + ## 0.1.0-alpha.4 (2025-07-22) Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/scaleapi/agentex-python/compare/v0.1.0-alpha.3...v0.1.0-alpha.4) diff --git a/README.md b/README.md index 2bdbb592..588fc8cc 100644 --- a/README.md +++ b/README.md @@ -28,17 +28,16 @@ pip install git+ssh://git@github.com/scaleapi/agentex-python.git The full API of this library can be found in [api.md](api.md). ```python +import os from agentex import Agentex client = Agentex( + api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted # defaults to "production". environment="development", ) -agent = client.agents.retrieve( - "agent_id", -) -print(agent.id) +tasks = client.tasks.list() ``` While you can provide an `api_key` keyword argument, @@ -51,20 +50,19 @@ so that your API Key is not stored in source control. Simply import `AsyncAgentex` instead of `Agentex` and use `await` with each API call: ```python +import os import asyncio from agentex import AsyncAgentex client = AsyncAgentex( + api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted # defaults to "production". environment="development", ) async def main() -> None: - agent = await client.agents.retrieve( - "agent_id", - ) - print(agent.id) + tasks = await client.tasks.list() asyncio.run(main()) @@ -93,12 +91,10 @@ from agentex import AsyncAgentex async def main() -> None: async with AsyncAgentex( + api_key="My API Key", http_client=DefaultAioHttpClient(), ) as client: - agent = await client.agents.retrieve( - "agent_id", - ) - print(agent.id) + tasks = await client.tasks.list() asyncio.run(main()) @@ -129,9 +125,7 @@ from agentex import Agentex client = Agentex() try: - client.agents.retrieve( - "agent_id", - ) + client.tasks.list() except agentex.APIConnectionError as e: print("The server could not be reached") print(e.__cause__) # an underlying Exception, likely raised within httpx. @@ -174,9 +168,7 @@ client = Agentex( ) # Or, configure per-request: -client.with_options(max_retries=5).agents.retrieve( - "agent_id", -) +client.with_options(max_retries=5).tasks.list() ``` ### Timeouts @@ -199,9 +191,7 @@ client = Agentex( ) # Override per-request: -client.with_options(timeout=5.0).agents.retrieve( - "agent_id", -) +client.with_options(timeout=5.0).tasks.list() ``` On timeout, an `APITimeoutError` is thrown. @@ -242,13 +232,11 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to from agentex import Agentex client = Agentex() -response = client.agents.with_raw_response.retrieve( - "agent_id", -) +response = client.tasks.with_raw_response.list() print(response.headers.get('X-My-Header')) -agent = response.parse() # get the object that `agents.retrieve()` would have returned -print(agent.id) +task = response.parse() # get the object that `tasks.list()` would have returned +print(task) ``` These methods return an [`APIResponse`](https://github.com/scaleapi/agentex-python/tree/main/src/agentex/_response.py) object. @@ -262,9 +250,7 @@ The above interface eagerly reads the full response body when you make the reque To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods. ```python -with client.agents.with_streaming_response.retrieve( - "agent_id", -) as response: +with client.tasks.with_streaming_response.list() as response: print(response.headers.get("X-My-Header")) for line in response.iter_lines(): diff --git a/api.md b/api.md index 8c2841ca..f0754dd0 100644 --- a/api.md +++ b/api.md @@ -1,9 +1,30 @@ +# Shared Types + +```python +from agentex.types import TaskMessageUpdate +``` + # Agents Types: ```python -from agentex.types import AcpType, Agent, AgentRpcRequest, AgentListResponse +from agentex.types import ( + AcpType, + Agent, + AgentRpcParams, + AgentRpcRequest, + AgentRpcResponse, + AgentRpcResult, + DataDelta, + TaskMessageContent, + TaskMessageDelta, + TaskMessageUpdate, + TextDelta, + ToolRequestDelta, + ToolResponseDelta, + AgentListResponse, +) ``` Methods: @@ -13,8 +34,8 @@ Methods: - client.agents.delete(agent_id) -> Agent - client.agents.delete_by_name(agent_name) -> Agent - client.agents.retrieve_by_name(agent_name) -> Agent -- client.agents.rpc(agent_id, \*\*params) -> object -- client.agents.rpc_by_name(agent_name, \*\*params) -> object +- client.agents.rpc(agent_id, \*\*params) -> AgentRpcResponse +- client.agents.rpc_by_name(agent_name, \*\*params) -> AgentRpcResponse # Tasks @@ -43,7 +64,6 @@ from agentex.types import ( DataContent, MessageAuthor, MessageStyle, - StreamingStatus, TaskMessage, TextContent, ToolRequestContent, diff --git a/pyproject.toml b/pyproject.toml index 8e69b5ed..168acc46 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "agentex" -version = "0.1.0-alpha.4" +version = "0.1.0-alpha.5" description = "The official Python library for the agentex API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/agentex/_models.py b/src/agentex/_models.py index ffcbf67b..b8387ce9 100644 --- a/src/agentex/_models.py +++ b/src/agentex/_models.py @@ -208,14 +208,18 @@ def construct( # pyright: ignore[reportIncompatibleMethodOverride] else: fields_values[name] = field_get_default(field) + extra_field_type = _get_extra_fields_type(__cls) + _extra = {} for key, value in values.items(): if key not in model_fields: + parsed = construct_type(value=value, type_=extra_field_type) if extra_field_type is not None else value + if PYDANTIC_V2: - _extra[key] = value + _extra[key] = parsed else: _fields_set.add(key) - fields_values[key] = value + fields_values[key] = parsed object.__setattr__(m, "__dict__", fields_values) @@ -370,6 +374,23 @@ def _construct_field(value: object, field: FieldInfo, key: str) -> object: return construct_type(value=value, type_=type_, metadata=getattr(field, "metadata", None)) +def _get_extra_fields_type(cls: type[pydantic.BaseModel]) -> type | None: + if not PYDANTIC_V2: + # TODO + return None + + schema = cls.__pydantic_core_schema__ + if schema["type"] == "model": + fields = schema["schema"] + if fields["type"] == "model-fields": + extras = fields.get("extras_schema") + if extras and "cls" in extras: + # mypy can't narrow the type + return extras["cls"] # type: ignore[no-any-return] + + return None + + def is_basemodel(type_: type) -> bool: """Returns whether or not the given type is either a `BaseModel` or a union of `BaseModel`""" if is_union(type_): diff --git a/src/agentex/_version.py b/src/agentex/_version.py index 756d68b8..6c4f3e31 100644 --- a/src/agentex/_version.py +++ b/src/agentex/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "agentex" -__version__ = "0.1.0-alpha.4" # x-release-please-version +__version__ = "0.1.0-alpha.5" # x-release-please-version diff --git a/src/agentex/resources/agents.py b/src/agentex/resources/agents.py index 9c2e4bd5..8b329be8 100644 --- a/src/agentex/resources/agents.py +++ b/src/agentex/resources/agents.py @@ -7,7 +7,7 @@ import httpx -from ..types import agent_rpc_params, agent_list_params, agent_rpc_by_name_params +from ..types import AgentRpcParams, agent_rpc_params, agent_list_params, agent_rpc_by_name_params from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven from .._utils import maybe_transform, async_maybe_transform from .._compat import cached_property @@ -20,6 +20,8 @@ ) from ..types.agent import Agent from .._base_client import make_request_options +from ..types.agent_rpc_params import AgentRpcParams +from ..types.agent_rpc_response import AgentRpcResponse from ..types.agent_list_response import AgentListResponse __all__ = ["AgentsResource", "AsyncAgentsResource"] @@ -219,7 +221,7 @@ def rpc( agent_id: str, *, method: Literal["event/send", "task/create", "message/send", "task/cancel"], - params: agent_rpc_params.Params, + params: AgentRpcParams, id: Union[int, str, None] | NotGiven = NOT_GIVEN, jsonrpc: Literal["2.0"] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -228,11 +230,13 @@ def rpc( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, - ) -> object: + ) -> AgentRpcResponse: """ Handle JSON-RPC requests for an agent by its unique ID. Args: + params: The parameters for the agent RPC request + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -257,7 +261,7 @@ def rpc( options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=object, + cast_to=AgentRpcResponse, ) def rpc_by_name( @@ -265,7 +269,7 @@ def rpc_by_name( agent_name: str, *, method: Literal["event/send", "task/create", "message/send", "task/cancel"], - params: agent_rpc_by_name_params.Params, + params: AgentRpcParams, id: Union[int, str, None] | NotGiven = NOT_GIVEN, jsonrpc: Literal["2.0"] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -274,11 +278,13 @@ def rpc_by_name( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, - ) -> object: + ) -> AgentRpcResponse: """ Handle JSON-RPC requests for an agent by its unique name. Args: + params: The parameters for the agent RPC request + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -303,7 +309,7 @@ def rpc_by_name( options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=object, + cast_to=AgentRpcResponse, ) @@ -501,7 +507,7 @@ async def rpc( agent_id: str, *, method: Literal["event/send", "task/create", "message/send", "task/cancel"], - params: agent_rpc_params.Params, + params: AgentRpcParams, id: Union[int, str, None] | NotGiven = NOT_GIVEN, jsonrpc: Literal["2.0"] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -510,11 +516,13 @@ async def rpc( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, - ) -> object: + ) -> AgentRpcResponse: """ Handle JSON-RPC requests for an agent by its unique ID. Args: + params: The parameters for the agent RPC request + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -539,7 +547,7 @@ async def rpc( options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=object, + cast_to=AgentRpcResponse, ) async def rpc_by_name( @@ -547,7 +555,7 @@ async def rpc_by_name( agent_name: str, *, method: Literal["event/send", "task/create", "message/send", "task/cancel"], - params: agent_rpc_by_name_params.Params, + params: AgentRpcParams, id: Union[int, str, None] | NotGiven = NOT_GIVEN, jsonrpc: Literal["2.0"] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -556,11 +564,13 @@ async def rpc_by_name( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, - ) -> object: + ) -> AgentRpcResponse: """ Handle JSON-RPC requests for an agent by its unique name. Args: + params: The parameters for the agent RPC request + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -585,7 +595,7 @@ async def rpc_by_name( options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=object, + cast_to=AgentRpcResponse, ) diff --git a/src/agentex/resources/messages/batch.py b/src/agentex/resources/messages/batch.py index 478c2df5..58412663 100644 --- a/src/agentex/resources/messages/batch.py +++ b/src/agentex/resources/messages/batch.py @@ -18,6 +18,7 @@ ) from ..._base_client import make_request_options from ...types.messages import batch_create_params, batch_update_params +from ...types.task_message_content_param import TaskMessageContentParam from ...types.messages.batch_create_response import BatchCreateResponse from ...types.messages.batch_update_response import BatchUpdateResponse @@ -47,7 +48,7 @@ def with_streaming_response(self) -> BatchResourceWithStreamingResponse: def create( self, *, - contents: Iterable[batch_create_params.Content], + contents: Iterable[TaskMessageContentParam], task_id: str, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. @@ -87,7 +88,7 @@ def update( self, *, task_id: str, - updates: Dict[str, batch_update_params.Updates], + updates: Dict[str, TaskMessageContentParam], # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -146,7 +147,7 @@ def with_streaming_response(self) -> AsyncBatchResourceWithStreamingResponse: async def create( self, *, - contents: Iterable[batch_create_params.Content], + contents: Iterable[TaskMessageContentParam], task_id: str, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. @@ -186,7 +187,7 @@ async def update( self, *, task_id: str, - updates: Dict[str, batch_update_params.Updates], + updates: Dict[str, TaskMessageContentParam], # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, diff --git a/src/agentex/resources/messages/messages.py b/src/agentex/resources/messages/messages.py index 7745cf76..b7f78c94 100644 --- a/src/agentex/resources/messages/messages.py +++ b/src/agentex/resources/messages/messages.py @@ -3,6 +3,7 @@ from __future__ import annotations from typing import Optional +from typing_extensions import Literal import httpx @@ -14,7 +15,7 @@ BatchResourceWithStreamingResponse, AsyncBatchResourceWithStreamingResponse, ) -from ...types import StreamingStatus, message_list_params, message_create_params, message_update_params +from ...types import message_list_params, message_create_params, message_update_params from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven from ..._utils import maybe_transform, async_maybe_transform from ..._compat import cached_property @@ -27,8 +28,8 @@ ) from ..._base_client import make_request_options from ...types.task_message import TaskMessage -from ...types.streaming_status import StreamingStatus from ...types.message_list_response import MessageListResponse +from ...types.task_message_content_param import TaskMessageContentParam __all__ = ["MessagesResource", "AsyncMessagesResource"] @@ -60,9 +61,9 @@ def with_streaming_response(self) -> MessagesResourceWithStreamingResponse: def create( self, *, - content: message_create_params.Content, + content: TaskMessageContentParam, task_id: str, - streaming_status: Optional[StreamingStatus] | NotGiven = NOT_GIVEN, + streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -135,9 +136,9 @@ def update( self, message_id: str, *, - content: message_update_params.Content, + content: TaskMessageContentParam, task_id: str, - streaming_status: Optional[StreamingStatus] | NotGiven = NOT_GIVEN, + streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -245,9 +246,9 @@ def with_streaming_response(self) -> AsyncMessagesResourceWithStreamingResponse: async def create( self, *, - content: message_create_params.Content, + content: TaskMessageContentParam, task_id: str, - streaming_status: Optional[StreamingStatus] | NotGiven = NOT_GIVEN, + streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -320,9 +321,9 @@ async def update( self, message_id: str, *, - content: message_update_params.Content, + content: TaskMessageContentParam, task_id: str, - streaming_status: Optional[StreamingStatus] | NotGiven = NOT_GIVEN, + streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, diff --git a/src/agentex/types/__init__.py b/src/agentex/types/__init__.py index a5e72143..f021a20d 100644 --- a/src/agentex/types/__init__.py +++ b/src/agentex/types/__init__.py @@ -7,32 +7,40 @@ from .agent import Agent as Agent from .event import Event as Event from .state import State as State +from .shared import TaskMessageUpdate as TaskMessageUpdate from .acp_type import AcpType as AcpType +from .data_delta import DataDelta as DataDelta +from .text_delta import TextDelta as TextDelta from .data_content import DataContent as DataContent from .task_message import TaskMessage as TaskMessage from .text_content import TextContent as TextContent from .message_style import MessageStyle as MessageStyle from .message_author import MessageAuthor as MessageAuthor from .agent_rpc_params import AgentRpcParams as AgentRpcParams +from .agent_rpc_result import AgentRpcResult as AgentRpcResult from .span_list_params import SpanListParams as SpanListParams -from .streaming_status import StreamingStatus as StreamingStatus from .agent_list_params import AgentListParams as AgentListParams from .event_list_params import EventListParams as EventListParams from .state_list_params import StateListParams as StateListParams +from .agent_rpc_response import AgentRpcResponse as AgentRpcResponse from .agent_task_tracker import AgentTaskTracker as AgentTaskTracker from .data_content_param import DataContentParam as DataContentParam from .span_create_params import SpanCreateParams as SpanCreateParams from .span_list_response import SpanListResponse as SpanListResponse from .span_update_params import SpanUpdateParams as SpanUpdateParams from .task_list_response import TaskListResponse as TaskListResponse +from .task_message_delta import TaskMessageDelta as TaskMessageDelta from .text_content_param import TextContentParam as TextContentParam +from .tool_request_delta import ToolRequestDelta as ToolRequestDelta from .agent_list_response import AgentListResponse as AgentListResponse from .event_list_response import EventListResponse as EventListResponse from .message_list_params import MessageListParams as MessageListParams from .state_create_params import StateCreateParams as StateCreateParams from .state_list_response import StateListResponse as StateListResponse from .state_update_params import StateUpdateParams as StateUpdateParams +from .tool_response_delta import ToolResponseDelta as ToolResponseDelta from .tracker_list_params import TrackerListParams as TrackerListParams +from .task_message_content import TaskMessageContent as TaskMessageContent from .tool_request_content import ToolRequestContent as ToolRequestContent from .message_create_params import MessageCreateParams as MessageCreateParams from .message_list_response import MessageListResponse as MessageListResponse @@ -41,5 +49,6 @@ from .tracker_list_response import TrackerListResponse as TrackerListResponse from .tracker_update_params import TrackerUpdateParams as TrackerUpdateParams from .agent_rpc_by_name_params import AgentRpcByNameParams as AgentRpcByNameParams +from .task_message_content_param import TaskMessageContentParam as TaskMessageContentParam from .tool_request_content_param import ToolRequestContentParam as ToolRequestContentParam from .tool_response_content_param import ToolResponseContentParam as ToolResponseContentParam diff --git a/src/agentex/types/agent_rpc_by_name_params.py b/src/agentex/types/agent_rpc_by_name_params.py index 5014a076..5be189d7 100644 --- a/src/agentex/types/agent_rpc_by_name_params.py +++ b/src/agentex/types/agent_rpc_by_name_params.py @@ -2,84 +2,20 @@ from __future__ import annotations -from typing import Dict, Union, Optional -from typing_extensions import Literal, Required, TypeAlias, TypedDict +from typing import Union +from typing_extensions import Literal, Required, TypedDict -from .data_content_param import DataContentParam -from .text_content_param import TextContentParam -from .tool_request_content_param import ToolRequestContentParam -from .tool_response_content_param import ToolResponseContentParam +from .agent_rpc_params import AgentRpcParams -__all__ = [ - "AgentRpcByNameParams", - "Params", - "ParamsCreateTaskRequest", - "ParamsCancelTaskRequest", - "ParamsSendMessageRequest", - "ParamsSendMessageRequestContent", - "ParamsSendEventRequest", - "ParamsSendEventRequestContent", -] +__all__ = ["AgentRpcByNameParams"] class AgentRpcByNameParams(TypedDict, total=False): method: Required[Literal["event/send", "task/create", "message/send", "task/cancel"]] - params: Required[Params] + params: Required[AgentRpcParams] + """The parameters for the agent RPC request""" id: Union[int, str, None] jsonrpc: Literal["2.0"] - - -class ParamsCreateTaskRequest(TypedDict, total=False): - name: Optional[str] - """The name of the task to create""" - - params: Optional[Dict[str, object]] - """The parameters for the task""" - - -class ParamsCancelTaskRequest(TypedDict, total=False): - task_id: Optional[str] - """The ID of the task to cancel. Either this or task_name must be provided.""" - - task_name: Optional[str] - """The name of the task to cancel. Either this or task_id must be provided.""" - - -ParamsSendMessageRequestContent: TypeAlias = Union[ - TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam -] - - -class ParamsSendMessageRequest(TypedDict, total=False): - content: Required[ParamsSendMessageRequestContent] - """The message that was sent to the agent""" - - stream: bool - """Whether to stream the response message back to the client""" - - task_id: Optional[str] - """The ID of the task that the message was sent to""" - - -ParamsSendEventRequestContent: TypeAlias = Union[ - TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam -] - - -class ParamsSendEventRequest(TypedDict, total=False): - content: Optional[ParamsSendEventRequestContent] - """The content to send to the event""" - - task_id: Optional[str] - """The ID of the task that the event was sent to""" - - task_name: Optional[str] - """The name of the task that the event was sent to""" - - -Params: TypeAlias = Union[ - ParamsCreateTaskRequest, ParamsCancelTaskRequest, ParamsSendMessageRequest, ParamsSendEventRequest -] diff --git a/src/agentex/types/agent_rpc_params.py b/src/agentex/types/agent_rpc_params.py index 2c79a7a9..5082b18c 100644 --- a/src/agentex/types/agent_rpc_params.py +++ b/src/agentex/types/agent_rpc_params.py @@ -3,36 +3,14 @@ from __future__ import annotations from typing import Dict, Union, Optional -from typing_extensions import Literal, Required, TypeAlias, TypedDict +from typing_extensions import Required, TypeAlias, TypedDict -from .data_content_param import DataContentParam -from .text_content_param import TextContentParam -from .tool_request_content_param import ToolRequestContentParam -from .tool_response_content_param import ToolResponseContentParam +from .task_message_content_param import TaskMessageContentParam -__all__ = [ - "AgentRpcParams", - "Params", - "ParamsCreateTaskRequest", - "ParamsCancelTaskRequest", - "ParamsSendMessageRequest", - "ParamsSendMessageRequestContent", - "ParamsSendEventRequest", - "ParamsSendEventRequestContent", -] +__all__ = ["AgentRpcParams", "CreateTaskRequest", "CancelTaskRequest", "SendMessageRequest", "SendEventRequest"] -class AgentRpcParams(TypedDict, total=False): - method: Required[Literal["event/send", "task/create", "message/send", "task/cancel"]] - - params: Required[Params] - - id: Union[int, str, None] - - jsonrpc: Literal["2.0"] - - -class ParamsCreateTaskRequest(TypedDict, total=False): +class CreateTaskRequest(TypedDict, total=False): name: Optional[str] """The name of the task to create""" @@ -40,7 +18,7 @@ class ParamsCreateTaskRequest(TypedDict, total=False): """The parameters for the task""" -class ParamsCancelTaskRequest(TypedDict, total=False): +class CancelTaskRequest(TypedDict, total=False): task_id: Optional[str] """The ID of the task to cancel. Either this or task_name must be provided.""" @@ -48,13 +26,8 @@ class ParamsCancelTaskRequest(TypedDict, total=False): """The name of the task to cancel. Either this or task_id must be provided.""" -ParamsSendMessageRequestContent: TypeAlias = Union[ - TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam -] - - -class ParamsSendMessageRequest(TypedDict, total=False): - content: Required[ParamsSendMessageRequestContent] +class SendMessageRequest(TypedDict, total=False): + content: Required[TaskMessageContentParam] """The message that was sent to the agent""" stream: bool @@ -64,13 +37,8 @@ class ParamsSendMessageRequest(TypedDict, total=False): """The ID of the task that the message was sent to""" -ParamsSendEventRequestContent: TypeAlias = Union[ - TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam -] - - -class ParamsSendEventRequest(TypedDict, total=False): - content: Optional[ParamsSendEventRequestContent] +class SendEventRequest(TypedDict, total=False): + content: Optional[TaskMessageContentParam] """The content to send to the event""" task_id: Optional[str] @@ -80,6 +48,4 @@ class ParamsSendEventRequest(TypedDict, total=False): """The name of the task that the event was sent to""" -Params: TypeAlias = Union[ - ParamsCreateTaskRequest, ParamsCancelTaskRequest, ParamsSendMessageRequest, ParamsSendEventRequest -] +AgentRpcParams: TypeAlias = Union[CreateTaskRequest, CancelTaskRequest, SendMessageRequest, SendEventRequest] diff --git a/src/agentex/types/agent_rpc_params1.py b/src/agentex/types/agent_rpc_params1.py new file mode 100644 index 00000000..3eae8b68 --- /dev/null +++ b/src/agentex/types/agent_rpc_params1.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal, Required, TypedDict + +from . import agent_rpc_params + +__all__ = ["AgentRpcParams"] + + +class AgentRpcParams(TypedDict, total=False): + method: Required[Literal["event/send", "task/create", "message/send", "task/cancel"]] + + params: Required[agent_rpc_params.AgentRpcParams] + """The parameters for the agent RPC request""" + + id: Union[int, str, None] + + jsonrpc: Literal["2.0"] diff --git a/src/agentex/types/agent_rpc_response.py b/src/agentex/types/agent_rpc_response.py new file mode 100644 index 00000000..e9995e80 --- /dev/null +++ b/src/agentex/types/agent_rpc_response.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Union, Optional +from typing_extensions import Literal + +from .._models import BaseModel +from .agent_rpc_result import AgentRpcResult + +__all__ = ["AgentRpcResponse"] + + +class AgentRpcResponse(BaseModel): + result: Optional[AgentRpcResult] = None + """The result of the agent RPC request""" + + id: Union[int, str, None] = None + + error: Optional[object] = None + + jsonrpc: Optional[Literal["2.0"]] = None diff --git a/src/agentex/types/agent_rpc_result.py b/src/agentex/types/agent_rpc_result.py new file mode 100644 index 00000000..63e30a5d --- /dev/null +++ b/src/agentex/types/agent_rpc_result.py @@ -0,0 +1,90 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Union, Optional +from typing_extensions import Literal, TypeAlias + +from .task import Task +from .event import Event +from .._models import BaseModel +from .task_message import TaskMessage +from .task_message_delta import TaskMessageDelta +from .task_message_content import TaskMessageContent + +__all__ = [ + "AgentRpcResult", + "StreamTaskMessageStart", + "StreamTaskMessageDelta", + "StreamTaskMessageFull", + "StreamTaskMessageDone", +] + + +class StreamTaskMessageStart(BaseModel): + content: TaskMessageContent + + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["start"]] = None + + +class StreamTaskMessageDelta(BaseModel): + delta: Optional[TaskMessageDelta] = None + """Delta for text updates""" + + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["delta"]] = None + + +class StreamTaskMessageFull(BaseModel): + content: TaskMessageContent + + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["full"]] = None + + +class StreamTaskMessageDone(BaseModel): + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["done"]] = None + + +AgentRpcResult: TypeAlias = Union[ + List[TaskMessage], + StreamTaskMessageStart, + StreamTaskMessageDelta, + StreamTaskMessageFull, + StreamTaskMessageDone, + Task, + Event, + None, +] diff --git a/src/agentex/types/data_delta.py b/src/agentex/types/data_delta.py new file mode 100644 index 00000000..e30c12e7 --- /dev/null +++ b/src/agentex/types/data_delta.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from .._models import BaseModel + +__all__ = ["DataDelta"] + + +class DataDelta(BaseModel): + data_delta: Optional[str] = None + + type: Optional[Literal["data"]] = None diff --git a/src/agentex/types/event.py b/src/agentex/types/event.py index 3f1e5997..9a544cb6 100644 --- a/src/agentex/types/event.py +++ b/src/agentex/types/event.py @@ -1,21 +1,12 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Union, Optional +from typing import Optional from datetime import datetime -from typing_extensions import Annotated, TypeAlias -from .._utils import PropertyInfo from .._models import BaseModel -from .data_content import DataContent -from .text_content import TextContent -from .tool_request_content import ToolRequestContent -from .tool_response_content import ToolResponseContent +from .task_message_content import TaskMessageContent -__all__ = ["Event", "Content"] - -Content: TypeAlias = Annotated[ - Union[TextContent, DataContent, ToolRequestContent, ToolResponseContent, None], PropertyInfo(discriminator="type") -] +__all__ = ["Event"] class Event(BaseModel): @@ -31,7 +22,7 @@ class Event(BaseModel): task_id: str """The UUID of the task that the event belongs to""" - content: Optional[Content] = None + content: Optional[TaskMessageContent] = None """The content of the event""" created_at: Optional[datetime] = None diff --git a/src/agentex/types/message_create_params.py b/src/agentex/types/message_create_params.py index 06ec3727..787715ec 100644 --- a/src/agentex/types/message_create_params.py +++ b/src/agentex/types/message_create_params.py @@ -2,24 +2,17 @@ from __future__ import annotations -from typing import Union, Optional -from typing_extensions import Required, TypeAlias, TypedDict +from typing import Optional +from typing_extensions import Literal, Required, TypedDict -from .streaming_status import StreamingStatus -from .data_content_param import DataContentParam -from .text_content_param import TextContentParam -from .tool_request_content_param import ToolRequestContentParam -from .tool_response_content_param import ToolResponseContentParam +from .task_message_content_param import TaskMessageContentParam -__all__ = ["MessageCreateParams", "Content"] +__all__ = ["MessageCreateParams"] class MessageCreateParams(TypedDict, total=False): - content: Required[Content] + content: Required[TaskMessageContentParam] task_id: Required[str] - streaming_status: Optional[StreamingStatus] - - -Content: TypeAlias = Union[TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam] + streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]] diff --git a/src/agentex/types/message_update_params.py b/src/agentex/types/message_update_params.py index bc5305b8..ea3dbaf8 100644 --- a/src/agentex/types/message_update_params.py +++ b/src/agentex/types/message_update_params.py @@ -2,24 +2,17 @@ from __future__ import annotations -from typing import Union, Optional -from typing_extensions import Required, TypeAlias, TypedDict +from typing import Optional +from typing_extensions import Literal, Required, TypedDict -from .streaming_status import StreamingStatus -from .data_content_param import DataContentParam -from .text_content_param import TextContentParam -from .tool_request_content_param import ToolRequestContentParam -from .tool_response_content_param import ToolResponseContentParam +from .task_message_content_param import TaskMessageContentParam -__all__ = ["MessageUpdateParams", "Content"] +__all__ = ["MessageUpdateParams"] class MessageUpdateParams(TypedDict, total=False): - content: Required[Content] + content: Required[TaskMessageContentParam] task_id: Required[str] - streaming_status: Optional[StreamingStatus] - - -Content: TypeAlias = Union[TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam] + streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]] diff --git a/src/agentex/types/messages/batch_create_params.py b/src/agentex/types/messages/batch_create_params.py index c09c69a9..0a0153ae 100644 --- a/src/agentex/types/messages/batch_create_params.py +++ b/src/agentex/types/messages/batch_create_params.py @@ -2,21 +2,15 @@ from __future__ import annotations -from typing import Union, Iterable -from typing_extensions import Required, TypeAlias, TypedDict +from typing import Iterable +from typing_extensions import Required, TypedDict -from ..data_content_param import DataContentParam -from ..text_content_param import TextContentParam -from ..tool_request_content_param import ToolRequestContentParam -from ..tool_response_content_param import ToolResponseContentParam +from ..task_message_content_param import TaskMessageContentParam -__all__ = ["BatchCreateParams", "Content"] +__all__ = ["BatchCreateParams"] class BatchCreateParams(TypedDict, total=False): - contents: Required[Iterable[Content]] + contents: Required[Iterable[TaskMessageContentParam]] task_id: Required[str] - - -Content: TypeAlias = Union[TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam] diff --git a/src/agentex/types/messages/batch_update_params.py b/src/agentex/types/messages/batch_update_params.py index 68f24f8d..c25e46f6 100644 --- a/src/agentex/types/messages/batch_update_params.py +++ b/src/agentex/types/messages/batch_update_params.py @@ -2,21 +2,15 @@ from __future__ import annotations -from typing import Dict, Union -from typing_extensions import Required, TypeAlias, TypedDict +from typing import Dict +from typing_extensions import Required, TypedDict -from ..data_content_param import DataContentParam -from ..text_content_param import TextContentParam -from ..tool_request_content_param import ToolRequestContentParam -from ..tool_response_content_param import ToolResponseContentParam +from ..task_message_content_param import TaskMessageContentParam -__all__ = ["BatchUpdateParams", "Updates"] +__all__ = ["BatchUpdateParams"] class BatchUpdateParams(TypedDict, total=False): task_id: Required[str] - updates: Required[Dict[str, Updates]] - - -Updates: TypeAlias = Union[TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam] + updates: Required[Dict[str, TaskMessageContentParam]] diff --git a/src/agentex/types/shared/__init__.py b/src/agentex/types/shared/__init__.py new file mode 100644 index 00000000..7b5a4954 --- /dev/null +++ b/src/agentex/types/shared/__init__.py @@ -0,0 +1,3 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .task_message_update import TaskMessageUpdate as TaskMessageUpdate diff --git a/src/agentex/types/shared/task_message_update.py b/src/agentex/types/shared/task_message_update.py new file mode 100644 index 00000000..cc01b598 --- /dev/null +++ b/src/agentex/types/shared/task_message_update.py @@ -0,0 +1,83 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Union, Optional +from typing_extensions import Literal, Annotated, TypeAlias + +from ..._utils import PropertyInfo +from ..._models import BaseModel +from ..task_message import TaskMessage +from ..task_message_delta import TaskMessageDelta +from ..task_message_content import TaskMessageContent + +__all__ = [ + "TaskMessageUpdate", + "StreamTaskMessageStart", + "StreamTaskMessageDelta", + "StreamTaskMessageFull", + "StreamTaskMessageDone", +] + + +class StreamTaskMessageStart(BaseModel): + content: TaskMessageContent + + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["start"]] = None + + +class StreamTaskMessageDelta(BaseModel): + delta: Optional[TaskMessageDelta] = None + """Delta for text updates""" + + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["delta"]] = None + + +class StreamTaskMessageFull(BaseModel): + content: TaskMessageContent + + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["full"]] = None + + +class StreamTaskMessageDone(BaseModel): + index: Optional[int] = None + + parent_task_message: Optional[TaskMessage] = None + """Represents a message in the agent system. + + This entity is used to store messages in MongoDB, with each message associated + with a specific task. + """ + + type: Optional[Literal["done"]] = None + + +TaskMessageUpdate: TypeAlias = Annotated[ + Union[StreamTaskMessageStart, StreamTaskMessageDelta, StreamTaskMessageFull, StreamTaskMessageDone], + PropertyInfo(discriminator="type"), +] diff --git a/src/agentex/types/streaming_status.py b/src/agentex/types/streaming_status.py deleted file mode 100644 index 196d7881..00000000 --- a/src/agentex/types/streaming_status.py +++ /dev/null @@ -1,7 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from typing_extensions import Literal, TypeAlias - -__all__ = ["StreamingStatus"] - -StreamingStatus: TypeAlias = Literal["IN_PROGRESS", "DONE"] diff --git a/src/agentex/types/task_message.py b/src/agentex/types/task_message.py index 686ade7d..b5938cc8 100644 --- a/src/agentex/types/task_message.py +++ b/src/agentex/types/task_message.py @@ -1,36 +1,33 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import Union, Optional +from typing import Optional from datetime import datetime -from typing_extensions import Annotated, TypeAlias +from typing_extensions import Literal -from .._utils import PropertyInfo from .._models import BaseModel -from .data_content import DataContent -from .text_content import TextContent -from .streaming_status import StreamingStatus -from .tool_request_content import ToolRequestContent -from .tool_response_content import ToolResponseContent +from .task_message_content import TaskMessageContent -__all__ = ["TaskMessage", "Content"] - -Content: TypeAlias = Annotated[ - Union[TextContent, DataContent, ToolRequestContent, ToolResponseContent], PropertyInfo(discriminator="type") -] +__all__ = ["TaskMessage"] class TaskMessage(BaseModel): - id: str - """The task message's unique id""" + content: TaskMessageContent + """The content of the message. - content: Content - - created_at: datetime - """The timestamp when the message was created""" + This content is not OpenAI compatible. These are messages that are meant to be + displayed to the user. + """ task_id: str + """ID of the task this message belongs to""" + + id: Optional[str] = None + """The task message's unique id""" + + created_at: Optional[datetime] = None + """The timestamp when the message was created""" - streaming_status: Optional[StreamingStatus] = None + streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]] = None updated_at: Optional[datetime] = None """The timestamp when the message was last updated""" diff --git a/src/agentex/types/task_message_content.py b/src/agentex/types/task_message_content.py new file mode 100644 index 00000000..126992b4 --- /dev/null +++ b/src/agentex/types/task_message_content.py @@ -0,0 +1,16 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Union +from typing_extensions import Annotated, TypeAlias + +from .._utils import PropertyInfo +from .data_content import DataContent +from .text_content import TextContent +from .tool_request_content import ToolRequestContent +from .tool_response_content import ToolResponseContent + +__all__ = ["TaskMessageContent"] + +TaskMessageContent: TypeAlias = Annotated[ + Union[TextContent, DataContent, ToolRequestContent, ToolResponseContent], PropertyInfo(discriminator="type") +] diff --git a/src/agentex/types/task_message_content_param.py b/src/agentex/types/task_message_content_param.py new file mode 100644 index 00000000..6991c64e --- /dev/null +++ b/src/agentex/types/task_message_content_param.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import TypeAlias + +from .data_content_param import DataContentParam +from .text_content_param import TextContentParam +from .tool_request_content_param import ToolRequestContentParam +from .tool_response_content_param import ToolResponseContentParam + +__all__ = ["TaskMessageContentParam"] + +TaskMessageContentParam: TypeAlias = Union[ + TextContentParam, DataContentParam, ToolRequestContentParam, ToolResponseContentParam +] diff --git a/src/agentex/types/task_message_delta.py b/src/agentex/types/task_message_delta.py new file mode 100644 index 00000000..5a477e5a --- /dev/null +++ b/src/agentex/types/task_message_delta.py @@ -0,0 +1,16 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Union +from typing_extensions import Annotated, TypeAlias + +from .._utils import PropertyInfo +from .data_delta import DataDelta +from .text_delta import TextDelta +from .tool_request_delta import ToolRequestDelta +from .tool_response_delta import ToolResponseDelta + +__all__ = ["TaskMessageDelta"] + +TaskMessageDelta: TypeAlias = Annotated[ + Union[TextDelta, DataDelta, ToolRequestDelta, ToolResponseDelta], PropertyInfo(discriminator="type") +] diff --git a/src/agentex/types/text_delta.py b/src/agentex/types/text_delta.py new file mode 100644 index 00000000..29a60cfd --- /dev/null +++ b/src/agentex/types/text_delta.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from .._models import BaseModel + +__all__ = ["TextDelta"] + + +class TextDelta(BaseModel): + text_delta: Optional[str] = None + + type: Optional[Literal["text"]] = None diff --git a/src/agentex/types/tool_request_delta.py b/src/agentex/types/tool_request_delta.py new file mode 100644 index 00000000..7877dfdd --- /dev/null +++ b/src/agentex/types/tool_request_delta.py @@ -0,0 +1,18 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from .._models import BaseModel + +__all__ = ["ToolRequestDelta"] + + +class ToolRequestDelta(BaseModel): + name: str + + tool_call_id: str + + arguments_delta: Optional[str] = None + + type: Optional[Literal["tool_request"]] = None diff --git a/src/agentex/types/tool_response_delta.py b/src/agentex/types/tool_response_delta.py new file mode 100644 index 00000000..383770db --- /dev/null +++ b/src/agentex/types/tool_response_delta.py @@ -0,0 +1,18 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from .._models import BaseModel + +__all__ = ["ToolResponseDelta"] + + +class ToolResponseDelta(BaseModel): + name: str + + tool_call_id: str + + content_delta: Optional[str] = None + + type: Optional[Literal["tool_response"]] = None diff --git a/tests/api_resources/test_agents.py b/tests/api_resources/test_agents.py index b2819f31..7cb79375 100644 --- a/tests/api_resources/test_agents.py +++ b/tests/api_resources/test_agents.py @@ -9,7 +9,11 @@ from agentex import Agentex, AsyncAgentex from tests.utils import assert_matches_type -from agentex.types import Agent, AgentListResponse +from agentex.types import ( + Agent, + AgentRpcResponse, + AgentListResponse, +) base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") @@ -229,7 +233,7 @@ def test_method_rpc(self, client: Agentex) -> None: method="event/send", params={}, ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -244,7 +248,7 @@ def test_method_rpc_with_all_params(self, client: Agentex) -> None: id=0, jsonrpc="2.0", ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -258,7 +262,7 @@ def test_raw_response_rpc(self, client: Agentex) -> None: assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -272,7 +276,7 @@ def test_streaming_response_rpc(self, client: Agentex) -> None: assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) assert cast(Any, response.is_closed) is True @@ -294,7 +298,7 @@ def test_method_rpc_by_name(self, client: Agentex) -> None: method="event/send", params={}, ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -309,7 +313,7 @@ def test_method_rpc_by_name_with_all_params(self, client: Agentex) -> None: id=0, jsonrpc="2.0", ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -323,7 +327,7 @@ def test_raw_response_rpc_by_name(self, client: Agentex) -> None: assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -337,7 +341,7 @@ def test_streaming_response_rpc_by_name(self, client: Agentex) -> None: assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) assert cast(Any, response.is_closed) is True @@ -569,7 +573,7 @@ async def test_method_rpc(self, async_client: AsyncAgentex) -> None: method="event/send", params={}, ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -584,7 +588,7 @@ async def test_method_rpc_with_all_params(self, async_client: AsyncAgentex) -> N id=0, jsonrpc="2.0", ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -598,7 +602,7 @@ async def test_raw_response_rpc(self, async_client: AsyncAgentex) -> None: assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = await response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -612,7 +616,7 @@ async def test_streaming_response_rpc(self, async_client: AsyncAgentex) -> None: assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = await response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) assert cast(Any, response.is_closed) is True @@ -634,7 +638,7 @@ async def test_method_rpc_by_name(self, async_client: AsyncAgentex) -> None: method="event/send", params={}, ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -649,7 +653,7 @@ async def test_method_rpc_by_name_with_all_params(self, async_client: AsyncAgent id=0, jsonrpc="2.0", ) - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -663,7 +667,7 @@ async def test_raw_response_rpc_by_name(self, async_client: AsyncAgentex) -> Non assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = await response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) @pytest.mark.skip() @parametrize @@ -677,7 +681,7 @@ async def test_streaming_response_rpc_by_name(self, async_client: AsyncAgentex) assert response.http_request.headers.get("X-Stainless-Lang") == "python" agent = await response.parse() - assert_matches_type(object, agent, path=["response"]) + assert_matches_type(AgentRpcResponse, agent, path=["response"]) assert cast(Any, response.is_closed) is True diff --git a/tests/conftest.py b/tests/conftest.py index b6e6697e..d08e65cf 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -45,6 +45,8 @@ def pytest_collection_modifyitems(items: list[pytest.Function]) -> None: base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") +api_key = "My API Key" + @pytest.fixture(scope="session") def client(request: FixtureRequest) -> Iterator[Agentex]: @@ -52,7 +54,7 @@ def client(request: FixtureRequest) -> Iterator[Agentex]: if not isinstance(strict, bool): raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}") - with Agentex(base_url=base_url, _strict_response_validation=strict) as client: + with Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client: yield client @@ -76,5 +78,7 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncAgentex]: else: raise TypeError(f"Unexpected fixture parameter type {type(param)}, expected bool or dict") - async with AsyncAgentex(base_url=base_url, _strict_response_validation=strict, http_client=http_client) as client: + async with AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=strict, http_client=http_client + ) as client: yield client diff --git a/tests/test_client.py b/tests/test_client.py index 2fe22ed9..da5399da 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -37,6 +37,7 @@ from .utils import update_env base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") +api_key = "My API Key" def _get_params(client: BaseClient[Any, Any]) -> dict[str, str]: @@ -58,7 +59,7 @@ def _get_open_connections(client: Agentex | AsyncAgentex) -> int: class TestAgentex: - client = Agentex(base_url=base_url, _strict_response_validation=True) + client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) @pytest.mark.respx(base_url=base_url) def test_raw_response(self, respx_mock: MockRouter) -> None: @@ -84,6 +85,10 @@ def test_copy(self) -> None: copied = self.client.copy() assert id(copied) != id(self.client) + copied = self.client.copy(api_key="another My API Key") + assert copied.api_key == "another My API Key" + assert self.client.api_key == "My API Key" + def test_copy_default_options(self) -> None: # options that have a default are overridden correctly copied = self.client.copy(max_retries=7) @@ -101,7 +106,9 @@ def test_copy_default_options(self) -> None: assert isinstance(self.client.timeout, httpx.Timeout) def test_copy_default_headers(self) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True, default_headers={"X-Foo": "bar"}) + client = Agentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_headers={"X-Foo": "bar"} + ) assert client.default_headers["X-Foo"] == "bar" # does not override the already given value when not specified @@ -133,7 +140,9 @@ def test_copy_default_headers(self) -> None: client.copy(set_default_headers={}, default_headers={"X-Foo": "Bar"}) def test_copy_default_query(self) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True, default_query={"foo": "bar"}) + client = Agentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_query={"foo": "bar"} + ) assert _get_params(client)["foo"] == "bar" # does not override the already given value when not specified @@ -257,7 +266,7 @@ def test_request_timeout(self) -> None: assert timeout == httpx.Timeout(100.0) def test_client_timeout_option(self) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True, timeout=httpx.Timeout(0)) + client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True, timeout=httpx.Timeout(0)) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -266,7 +275,9 @@ def test_client_timeout_option(self) -> None: def test_http_client_timeout_option(self) -> None: # custom timeout given to the httpx client should be used with httpx.Client(timeout=None) as http_client: - client = Agentex(base_url=base_url, _strict_response_validation=True, http_client=http_client) + client = Agentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, http_client=http_client + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -274,7 +285,9 @@ def test_http_client_timeout_option(self) -> None: # no timeout given to the httpx client should not use the httpx default with httpx.Client() as http_client: - client = Agentex(base_url=base_url, _strict_response_validation=True, http_client=http_client) + client = Agentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, http_client=http_client + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -282,7 +295,9 @@ def test_http_client_timeout_option(self) -> None: # explicitly passing the default timeout currently results in it being ignored with httpx.Client(timeout=HTTPX_DEFAULT_TIMEOUT) as http_client: - client = Agentex(base_url=base_url, _strict_response_validation=True, http_client=http_client) + client = Agentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, http_client=http_client + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -291,16 +306,24 @@ def test_http_client_timeout_option(self) -> None: async def test_invalid_http_client(self) -> None: with pytest.raises(TypeError, match="Invalid `http_client` arg"): async with httpx.AsyncClient() as http_client: - Agentex(base_url=base_url, _strict_response_validation=True, http_client=cast(Any, http_client)) + Agentex( + base_url=base_url, + api_key=api_key, + _strict_response_validation=True, + http_client=cast(Any, http_client), + ) def test_default_headers_option(self) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True, default_headers={"X-Foo": "bar"}) + client = Agentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_headers={"X-Foo": "bar"} + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) assert request.headers.get("x-foo") == "bar" assert request.headers.get("x-stainless-lang") == "python" client2 = Agentex( base_url=base_url, + api_key=api_key, _strict_response_validation=True, default_headers={ "X-Foo": "stainless", @@ -311,8 +334,20 @@ def test_default_headers_option(self) -> None: assert request.headers.get("x-foo") == "stainless" assert request.headers.get("x-stainless-lang") == "my-overriding-header" + def test_validate_headers(self) -> None: + client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("Authorization") == f"Bearer {api_key}" + + with update_env(**{"AGENTEX_SDK_API_KEY": Omit()}): + client2 = Agentex(base_url=base_url, api_key=None, _strict_response_validation=True) + + client2._build_request(FinalRequestOptions(method="get", url="/foo")) + def test_default_query_option(self) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True, default_query={"query_param": "bar"}) + client = Agentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_query={"query_param": "bar"} + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) url = httpx.URL(request.url) assert dict(url.params) == {"query_param": "bar"} @@ -511,7 +546,7 @@ class Model(BaseModel): assert response.foo == 2 def test_base_url_setter(self) -> None: - client = Agentex(base_url="https://example.com/from_init", _strict_response_validation=True) + client = Agentex(base_url="https://example.com/from_init", api_key=api_key, _strict_response_validation=True) assert client.base_url == "https://example.com/from_init/" client.base_url = "https://example.com/from_setter" # type: ignore[assignment] @@ -520,23 +555,24 @@ def test_base_url_setter(self) -> None: def test_base_url_env(self) -> None: with update_env(AGENTEX_BASE_URL="http://localhost:5000/from/env"): - client = Agentex(_strict_response_validation=True) + client = Agentex(api_key=api_key, _strict_response_validation=True) assert client.base_url == "http://localhost:5000/from/env/" # explicit environment arg requires explicitness with update_env(AGENTEX_BASE_URL="http://localhost:5000/from/env"): with pytest.raises(ValueError, match=r"you must pass base_url=None"): - Agentex(_strict_response_validation=True, environment="production") + Agentex(api_key=api_key, _strict_response_validation=True, environment="production") - client = Agentex(base_url=None, _strict_response_validation=True, environment="production") + client = Agentex(base_url=None, api_key=api_key, _strict_response_validation=True, environment="production") assert str(client.base_url).startswith("http://localhost:5003") @pytest.mark.parametrize( "client", [ - Agentex(base_url="http://localhost:5000/custom/path/", _strict_response_validation=True), + Agentex(base_url="http://localhost:5000/custom/path/", api_key=api_key, _strict_response_validation=True), Agentex( base_url="http://localhost:5000/custom/path/", + api_key=api_key, _strict_response_validation=True, http_client=httpx.Client(), ), @@ -556,9 +592,10 @@ def test_base_url_trailing_slash(self, client: Agentex) -> None: @pytest.mark.parametrize( "client", [ - Agentex(base_url="http://localhost:5000/custom/path/", _strict_response_validation=True), + Agentex(base_url="http://localhost:5000/custom/path/", api_key=api_key, _strict_response_validation=True), Agentex( base_url="http://localhost:5000/custom/path/", + api_key=api_key, _strict_response_validation=True, http_client=httpx.Client(), ), @@ -578,9 +615,10 @@ def test_base_url_no_trailing_slash(self, client: Agentex) -> None: @pytest.mark.parametrize( "client", [ - Agentex(base_url="http://localhost:5000/custom/path/", _strict_response_validation=True), + Agentex(base_url="http://localhost:5000/custom/path/", api_key=api_key, _strict_response_validation=True), Agentex( base_url="http://localhost:5000/custom/path/", + api_key=api_key, _strict_response_validation=True, http_client=httpx.Client(), ), @@ -598,7 +636,7 @@ def test_absolute_request_url(self, client: Agentex) -> None: assert request.url == "https://myapi.com/foo" def test_copied_client_does_not_close_http(self) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True) + client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) assert not client.is_closed() copied = client.copy() @@ -609,7 +647,7 @@ def test_copied_client_does_not_close_http(self) -> None: assert not client.is_closed() def test_client_context_manager(self) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True) + client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) with client as c2: assert c2 is client assert not c2.is_closed() @@ -630,7 +668,7 @@ class Model(BaseModel): def test_client_max_retries_validation(self) -> None: with pytest.raises(TypeError, match=r"max_retries cannot be None"): - Agentex(base_url=base_url, _strict_response_validation=True, max_retries=cast(Any, None)) + Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True, max_retries=cast(Any, None)) @pytest.mark.respx(base_url=base_url) def test_received_text_for_expected_json(self, respx_mock: MockRouter) -> None: @@ -639,12 +677,12 @@ class Model(BaseModel): respx_mock.get("/foo").mock(return_value=httpx.Response(200, text="my-custom-format")) - strict_client = Agentex(base_url=base_url, _strict_response_validation=True) + strict_client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) with pytest.raises(APIResponseValidationError): strict_client.get("/foo", cast_to=Model) - client = Agentex(base_url=base_url, _strict_response_validation=False) + client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=False) response = client.get("/foo", cast_to=Model) assert isinstance(response, str) # type: ignore[unreachable] @@ -672,7 +710,7 @@ class Model(BaseModel): ) @mock.patch("time.time", mock.MagicMock(return_value=1696004797)) def test_parse_retry_after_header(self, remaining_retries: int, retry_after: str, timeout: float) -> None: - client = Agentex(base_url=base_url, _strict_response_validation=True) + client = Agentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) headers = httpx.Headers({"retry-after": retry_after}) options = FinalRequestOptions(method="get", url="/foo", max_retries=3) @@ -682,20 +720,20 @@ def test_parse_retry_after_header(self, remaining_retries: int, retry_after: str @mock.patch("agentex._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) @pytest.mark.respx(base_url=base_url) def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter, client: Agentex) -> None: - respx_mock.get("/agents/agent_id").mock(side_effect=httpx.TimeoutException("Test timeout error")) + respx_mock.get("/tasks").mock(side_effect=httpx.TimeoutException("Test timeout error")) with pytest.raises(APITimeoutError): - client.agents.with_streaming_response.retrieve("agent_id").__enter__() + client.tasks.with_streaming_response.list().__enter__() assert _get_open_connections(self.client) == 0 @mock.patch("agentex._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) @pytest.mark.respx(base_url=base_url) def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter, client: Agentex) -> None: - respx_mock.get("/agents/agent_id").mock(return_value=httpx.Response(500)) + respx_mock.get("/tasks").mock(return_value=httpx.Response(500)) with pytest.raises(APIStatusError): - client.agents.with_streaming_response.retrieve("agent_id").__enter__() + client.tasks.with_streaming_response.list().__enter__() assert _get_open_connections(self.client) == 0 @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) @@ -722,9 +760,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response: return httpx.Response(500) return httpx.Response(200) - respx_mock.get("/agents/agent_id").mock(side_effect=retry_handler) + respx_mock.get("/tasks").mock(side_effect=retry_handler) - response = client.agents.with_raw_response.retrieve("agent_id") + response = client.tasks.with_raw_response.list() assert response.retries_taken == failures_before_success assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success @@ -746,11 +784,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response: return httpx.Response(500) return httpx.Response(200) - respx_mock.get("/agents/agent_id").mock(side_effect=retry_handler) + respx_mock.get("/tasks").mock(side_effect=retry_handler) - response = client.agents.with_raw_response.retrieve( - "agent_id", extra_headers={"x-stainless-retry-count": Omit()} - ) + response = client.tasks.with_raw_response.list(extra_headers={"x-stainless-retry-count": Omit()}) assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0 @@ -771,9 +807,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response: return httpx.Response(500) return httpx.Response(200) - respx_mock.get("/agents/agent_id").mock(side_effect=retry_handler) + respx_mock.get("/tasks").mock(side_effect=retry_handler) - response = client.agents.with_raw_response.retrieve("agent_id", extra_headers={"x-stainless-retry-count": "42"}) + response = client.tasks.with_raw_response.list(extra_headers={"x-stainless-retry-count": "42"}) assert response.http_request.headers.get("x-stainless-retry-count") == "42" @@ -828,7 +864,7 @@ def test_follow_redirects_disabled(self, respx_mock: MockRouter) -> None: class TestAsyncAgentex: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True) + client = AsyncAgentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) @pytest.mark.respx(base_url=base_url) @pytest.mark.asyncio @@ -856,6 +892,10 @@ def test_copy(self) -> None: copied = self.client.copy() assert id(copied) != id(self.client) + copied = self.client.copy(api_key="another My API Key") + assert copied.api_key == "another My API Key" + assert self.client.api_key == "My API Key" + def test_copy_default_options(self) -> None: # options that have a default are overridden correctly copied = self.client.copy(max_retries=7) @@ -873,7 +913,9 @@ def test_copy_default_options(self) -> None: assert isinstance(self.client.timeout, httpx.Timeout) def test_copy_default_headers(self) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, default_headers={"X-Foo": "bar"}) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_headers={"X-Foo": "bar"} + ) assert client.default_headers["X-Foo"] == "bar" # does not override the already given value when not specified @@ -905,7 +947,9 @@ def test_copy_default_headers(self) -> None: client.copy(set_default_headers={}, default_headers={"X-Foo": "Bar"}) def test_copy_default_query(self) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, default_query={"foo": "bar"}) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_query={"foo": "bar"} + ) assert _get_params(client)["foo"] == "bar" # does not override the already given value when not specified @@ -1029,7 +1073,9 @@ async def test_request_timeout(self) -> None: assert timeout == httpx.Timeout(100.0) async def test_client_timeout_option(self) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, timeout=httpx.Timeout(0)) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, timeout=httpx.Timeout(0) + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -1038,7 +1084,9 @@ async def test_client_timeout_option(self) -> None: async def test_http_client_timeout_option(self) -> None: # custom timeout given to the httpx client should be used async with httpx.AsyncClient(timeout=None) as http_client: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, http_client=http_client) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, http_client=http_client + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -1046,7 +1094,9 @@ async def test_http_client_timeout_option(self) -> None: # no timeout given to the httpx client should not use the httpx default async with httpx.AsyncClient() as http_client: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, http_client=http_client) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, http_client=http_client + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -1054,7 +1104,9 @@ async def test_http_client_timeout_option(self) -> None: # explicitly passing the default timeout currently results in it being ignored async with httpx.AsyncClient(timeout=HTTPX_DEFAULT_TIMEOUT) as http_client: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, http_client=http_client) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, http_client=http_client + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) timeout = httpx.Timeout(**request.extensions["timeout"]) # type: ignore @@ -1063,16 +1115,24 @@ async def test_http_client_timeout_option(self) -> None: def test_invalid_http_client(self) -> None: with pytest.raises(TypeError, match="Invalid `http_client` arg"): with httpx.Client() as http_client: - AsyncAgentex(base_url=base_url, _strict_response_validation=True, http_client=cast(Any, http_client)) + AsyncAgentex( + base_url=base_url, + api_key=api_key, + _strict_response_validation=True, + http_client=cast(Any, http_client), + ) def test_default_headers_option(self) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, default_headers={"X-Foo": "bar"}) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_headers={"X-Foo": "bar"} + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) assert request.headers.get("x-foo") == "bar" assert request.headers.get("x-stainless-lang") == "python" client2 = AsyncAgentex( base_url=base_url, + api_key=api_key, _strict_response_validation=True, default_headers={ "X-Foo": "stainless", @@ -1083,8 +1143,20 @@ def test_default_headers_option(self) -> None: assert request.headers.get("x-foo") == "stainless" assert request.headers.get("x-stainless-lang") == "my-overriding-header" + def test_validate_headers(self) -> None: + client = AsyncAgentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) + request = client._build_request(FinalRequestOptions(method="get", url="/foo")) + assert request.headers.get("Authorization") == f"Bearer {api_key}" + + with update_env(**{"AGENTEX_SDK_API_KEY": Omit()}): + client2 = AsyncAgentex(base_url=base_url, api_key=None, _strict_response_validation=True) + + client2._build_request(FinalRequestOptions(method="get", url="/foo")) + def test_default_query_option(self) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True, default_query={"query_param": "bar"}) + client = AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, default_query={"query_param": "bar"} + ) request = client._build_request(FinalRequestOptions(method="get", url="/foo")) url = httpx.URL(request.url) assert dict(url.params) == {"query_param": "bar"} @@ -1283,7 +1355,9 @@ class Model(BaseModel): assert response.foo == 2 def test_base_url_setter(self) -> None: - client = AsyncAgentex(base_url="https://example.com/from_init", _strict_response_validation=True) + client = AsyncAgentex( + base_url="https://example.com/from_init", api_key=api_key, _strict_response_validation=True + ) assert client.base_url == "https://example.com/from_init/" client.base_url = "https://example.com/from_setter" # type: ignore[assignment] @@ -1292,23 +1366,28 @@ def test_base_url_setter(self) -> None: def test_base_url_env(self) -> None: with update_env(AGENTEX_BASE_URL="http://localhost:5000/from/env"): - client = AsyncAgentex(_strict_response_validation=True) + client = AsyncAgentex(api_key=api_key, _strict_response_validation=True) assert client.base_url == "http://localhost:5000/from/env/" # explicit environment arg requires explicitness with update_env(AGENTEX_BASE_URL="http://localhost:5000/from/env"): with pytest.raises(ValueError, match=r"you must pass base_url=None"): - AsyncAgentex(_strict_response_validation=True, environment="production") + AsyncAgentex(api_key=api_key, _strict_response_validation=True, environment="production") - client = AsyncAgentex(base_url=None, _strict_response_validation=True, environment="production") + client = AsyncAgentex( + base_url=None, api_key=api_key, _strict_response_validation=True, environment="production" + ) assert str(client.base_url).startswith("http://localhost:5003") @pytest.mark.parametrize( "client", [ - AsyncAgentex(base_url="http://localhost:5000/custom/path/", _strict_response_validation=True), + AsyncAgentex( + base_url="http://localhost:5000/custom/path/", api_key=api_key, _strict_response_validation=True + ), AsyncAgentex( base_url="http://localhost:5000/custom/path/", + api_key=api_key, _strict_response_validation=True, http_client=httpx.AsyncClient(), ), @@ -1328,9 +1407,12 @@ def test_base_url_trailing_slash(self, client: AsyncAgentex) -> None: @pytest.mark.parametrize( "client", [ - AsyncAgentex(base_url="http://localhost:5000/custom/path/", _strict_response_validation=True), + AsyncAgentex( + base_url="http://localhost:5000/custom/path/", api_key=api_key, _strict_response_validation=True + ), AsyncAgentex( base_url="http://localhost:5000/custom/path/", + api_key=api_key, _strict_response_validation=True, http_client=httpx.AsyncClient(), ), @@ -1350,9 +1432,12 @@ def test_base_url_no_trailing_slash(self, client: AsyncAgentex) -> None: @pytest.mark.parametrize( "client", [ - AsyncAgentex(base_url="http://localhost:5000/custom/path/", _strict_response_validation=True), + AsyncAgentex( + base_url="http://localhost:5000/custom/path/", api_key=api_key, _strict_response_validation=True + ), AsyncAgentex( base_url="http://localhost:5000/custom/path/", + api_key=api_key, _strict_response_validation=True, http_client=httpx.AsyncClient(), ), @@ -1370,7 +1455,7 @@ def test_absolute_request_url(self, client: AsyncAgentex) -> None: assert request.url == "https://myapi.com/foo" async def test_copied_client_does_not_close_http(self) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True) + client = AsyncAgentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) assert not client.is_closed() copied = client.copy() @@ -1382,7 +1467,7 @@ async def test_copied_client_does_not_close_http(self) -> None: assert not client.is_closed() async def test_client_context_manager(self) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True) + client = AsyncAgentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) async with client as c2: assert c2 is client assert not c2.is_closed() @@ -1404,7 +1489,9 @@ class Model(BaseModel): async def test_client_max_retries_validation(self) -> None: with pytest.raises(TypeError, match=r"max_retries cannot be None"): - AsyncAgentex(base_url=base_url, _strict_response_validation=True, max_retries=cast(Any, None)) + AsyncAgentex( + base_url=base_url, api_key=api_key, _strict_response_validation=True, max_retries=cast(Any, None) + ) @pytest.mark.respx(base_url=base_url) @pytest.mark.asyncio @@ -1414,12 +1501,12 @@ class Model(BaseModel): respx_mock.get("/foo").mock(return_value=httpx.Response(200, text="my-custom-format")) - strict_client = AsyncAgentex(base_url=base_url, _strict_response_validation=True) + strict_client = AsyncAgentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) with pytest.raises(APIResponseValidationError): await strict_client.get("/foo", cast_to=Model) - client = AsyncAgentex(base_url=base_url, _strict_response_validation=False) + client = AsyncAgentex(base_url=base_url, api_key=api_key, _strict_response_validation=False) response = await client.get("/foo", cast_to=Model) assert isinstance(response, str) # type: ignore[unreachable] @@ -1448,7 +1535,7 @@ class Model(BaseModel): @mock.patch("time.time", mock.MagicMock(return_value=1696004797)) @pytest.mark.asyncio async def test_parse_retry_after_header(self, remaining_retries: int, retry_after: str, timeout: float) -> None: - client = AsyncAgentex(base_url=base_url, _strict_response_validation=True) + client = AsyncAgentex(base_url=base_url, api_key=api_key, _strict_response_validation=True) headers = httpx.Headers({"retry-after": retry_after}) options = FinalRequestOptions(method="get", url="/foo", max_retries=3) @@ -1460,20 +1547,20 @@ async def test_parse_retry_after_header(self, remaining_retries: int, retry_afte async def test_retrying_timeout_errors_doesnt_leak( self, respx_mock: MockRouter, async_client: AsyncAgentex ) -> None: - respx_mock.get("/agents/agent_id").mock(side_effect=httpx.TimeoutException("Test timeout error")) + respx_mock.get("/tasks").mock(side_effect=httpx.TimeoutException("Test timeout error")) with pytest.raises(APITimeoutError): - await async_client.agents.with_streaming_response.retrieve("agent_id").__aenter__() + await async_client.tasks.with_streaming_response.list().__aenter__() assert _get_open_connections(self.client) == 0 @mock.patch("agentex._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout) @pytest.mark.respx(base_url=base_url) async def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter, async_client: AsyncAgentex) -> None: - respx_mock.get("/agents/agent_id").mock(return_value=httpx.Response(500)) + respx_mock.get("/tasks").mock(return_value=httpx.Response(500)) with pytest.raises(APIStatusError): - await async_client.agents.with_streaming_response.retrieve("agent_id").__aenter__() + await async_client.tasks.with_streaming_response.list().__aenter__() assert _get_open_connections(self.client) == 0 @pytest.mark.parametrize("failures_before_success", [0, 2, 4]) @@ -1501,9 +1588,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response: return httpx.Response(500) return httpx.Response(200) - respx_mock.get("/agents/agent_id").mock(side_effect=retry_handler) + respx_mock.get("/tasks").mock(side_effect=retry_handler) - response = await client.agents.with_raw_response.retrieve("agent_id") + response = await client.tasks.with_raw_response.list() assert response.retries_taken == failures_before_success assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success @@ -1526,11 +1613,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response: return httpx.Response(500) return httpx.Response(200) - respx_mock.get("/agents/agent_id").mock(side_effect=retry_handler) + respx_mock.get("/tasks").mock(side_effect=retry_handler) - response = await client.agents.with_raw_response.retrieve( - "agent_id", extra_headers={"x-stainless-retry-count": Omit()} - ) + response = await client.tasks.with_raw_response.list(extra_headers={"x-stainless-retry-count": Omit()}) assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0 @@ -1552,11 +1637,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response: return httpx.Response(500) return httpx.Response(200) - respx_mock.get("/agents/agent_id").mock(side_effect=retry_handler) + respx_mock.get("/tasks").mock(side_effect=retry_handler) - response = await client.agents.with_raw_response.retrieve( - "agent_id", extra_headers={"x-stainless-retry-count": "42"} - ) + response = await client.tasks.with_raw_response.list(extra_headers={"x-stainless-retry-count": "42"}) assert response.http_request.headers.get("x-stainless-retry-count") == "42" diff --git a/tests/test_models.py b/tests/test_models.py index a8867d60..14d98180 100644 --- a/tests/test_models.py +++ b/tests/test_models.py @@ -1,5 +1,5 @@ import json -from typing import Any, Dict, List, Union, Optional, cast +from typing import TYPE_CHECKING, Any, Dict, List, Union, Optional, cast from datetime import datetime, timezone from typing_extensions import Literal, Annotated, TypeAliasType @@ -934,3 +934,30 @@ class Type2(BaseModel): ) assert isinstance(model, Type1) assert isinstance(model.value, InnerType2) + + +@pytest.mark.skipif(not PYDANTIC_V2, reason="this is only supported in pydantic v2 for now") +def test_extra_properties() -> None: + class Item(BaseModel): + prop: int + + class Model(BaseModel): + __pydantic_extra__: Dict[str, Item] = Field(init=False) # pyright: ignore[reportIncompatibleVariableOverride] + + other: str + + if TYPE_CHECKING: + + def __getattr__(self, attr: str) -> Item: ... + + model = construct_type( + type_=Model, + value={ + "a": {"prop": 1}, + "other": "foo", + }, + ) + assert isinstance(model, Model) + assert model.a.prop == 1 + assert isinstance(model.a, Item) + assert model.other == "foo"