Skip to content

Commit 2cc2d99

Browse files
chore(docs): add missing descriptions
1 parent f22f581 commit 2cc2d99

File tree

5 files changed

+40
-0
lines changed

5 files changed

+40
-0
lines changed

src/oz_agent_sdk/_client.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ def __init__(
9494

9595
@cached_property
9696
def agent(self) -> AgentResource:
97+
"""Operations for running and managing cloud agents"""
9798
from .resources.agent import AgentResource
9899

99100
return AgentResource(self)
@@ -268,6 +269,7 @@ def __init__(
268269

269270
@cached_property
270271
def agent(self) -> AsyncAgentResource:
272+
"""Operations for running and managing cloud agents"""
271273
from .resources.agent import AsyncAgentResource
272274

273275
return AsyncAgentResource(self)
@@ -393,6 +395,7 @@ def __init__(self, client: OzAPI) -> None:
393395

394396
@cached_property
395397
def agent(self) -> agent.AgentResourceWithRawResponse:
398+
"""Operations for running and managing cloud agents"""
396399
from .resources.agent import AgentResourceWithRawResponse
397400

398401
return AgentResourceWithRawResponse(self._client.agent)
@@ -406,6 +409,7 @@ def __init__(self, client: AsyncOzAPI) -> None:
406409

407410
@cached_property
408411
def agent(self) -> agent.AsyncAgentResourceWithRawResponse:
412+
"""Operations for running and managing cloud agents"""
409413
from .resources.agent import AsyncAgentResourceWithRawResponse
410414

411415
return AsyncAgentResourceWithRawResponse(self._client.agent)
@@ -419,6 +423,7 @@ def __init__(self, client: OzAPI) -> None:
419423

420424
@cached_property
421425
def agent(self) -> agent.AgentResourceWithStreamingResponse:
426+
"""Operations for running and managing cloud agents"""
422427
from .resources.agent import AgentResourceWithStreamingResponse
423428

424429
return AgentResourceWithStreamingResponse(self._client.agent)
@@ -432,6 +437,7 @@ def __init__(self, client: AsyncOzAPI) -> None:
432437

433438
@cached_property
434439
def agent(self) -> agent.AsyncAgentResourceWithStreamingResponse:
440+
"""Operations for running and managing cloud agents"""
435441
from .resources.agent import AsyncAgentResourceWithStreamingResponse
436442

437443
return AsyncAgentResourceWithStreamingResponse(self._client.agent)

src/oz_agent_sdk/resources/agent/agent.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,21 @@
5252

5353

5454
class AgentResource(SyncAPIResource):
55+
"""Operations for running and managing cloud agents"""
56+
5557
@cached_property
5658
def runs(self) -> RunsResource:
59+
"""Operations for running and managing cloud agents"""
5760
return RunsResource(self._client)
5861

5962
@cached_property
6063
def schedules(self) -> SchedulesResource:
64+
"""Operations for creating and managing scheduled agents"""
6165
return SchedulesResource(self._client)
6266

6367
@cached_property
6468
def sessions(self) -> SessionsResource:
69+
"""Operations for running and managing cloud agents"""
6570
return SessionsResource(self._client)
6671

6772
@cached_property
@@ -251,16 +256,21 @@ def run(
251256

252257

253258
class AsyncAgentResource(AsyncAPIResource):
259+
"""Operations for running and managing cloud agents"""
260+
254261
@cached_property
255262
def runs(self) -> AsyncRunsResource:
263+
"""Operations for running and managing cloud agents"""
256264
return AsyncRunsResource(self._client)
257265

258266
@cached_property
259267
def schedules(self) -> AsyncSchedulesResource:
268+
"""Operations for creating and managing scheduled agents"""
260269
return AsyncSchedulesResource(self._client)
261270

262271
@cached_property
263272
def sessions(self) -> AsyncSessionsResource:
273+
"""Operations for running and managing cloud agents"""
264274
return AsyncSessionsResource(self._client)
265275

266276
@cached_property
@@ -465,14 +475,17 @@ def __init__(self, agent: AgentResource) -> None:
465475

466476
@cached_property
467477
def runs(self) -> RunsResourceWithRawResponse:
478+
"""Operations for running and managing cloud agents"""
468479
return RunsResourceWithRawResponse(self._agent.runs)
469480

470481
@cached_property
471482
def schedules(self) -> SchedulesResourceWithRawResponse:
483+
"""Operations for creating and managing scheduled agents"""
472484
return SchedulesResourceWithRawResponse(self._agent.schedules)
473485

474486
@cached_property
475487
def sessions(self) -> SessionsResourceWithRawResponse:
488+
"""Operations for running and managing cloud agents"""
476489
return SessionsResourceWithRawResponse(self._agent.sessions)
477490

478491

@@ -492,14 +505,17 @@ def __init__(self, agent: AsyncAgentResource) -> None:
492505

493506
@cached_property
494507
def runs(self) -> AsyncRunsResourceWithRawResponse:
508+
"""Operations for running and managing cloud agents"""
495509
return AsyncRunsResourceWithRawResponse(self._agent.runs)
496510

497511
@cached_property
498512
def schedules(self) -> AsyncSchedulesResourceWithRawResponse:
513+
"""Operations for creating and managing scheduled agents"""
499514
return AsyncSchedulesResourceWithRawResponse(self._agent.schedules)
500515

501516
@cached_property
502517
def sessions(self) -> AsyncSessionsResourceWithRawResponse:
518+
"""Operations for running and managing cloud agents"""
503519
return AsyncSessionsResourceWithRawResponse(self._agent.sessions)
504520

505521

@@ -519,14 +535,17 @@ def __init__(self, agent: AgentResource) -> None:
519535

520536
@cached_property
521537
def runs(self) -> RunsResourceWithStreamingResponse:
538+
"""Operations for running and managing cloud agents"""
522539
return RunsResourceWithStreamingResponse(self._agent.runs)
523540

524541
@cached_property
525542
def schedules(self) -> SchedulesResourceWithStreamingResponse:
543+
"""Operations for creating and managing scheduled agents"""
526544
return SchedulesResourceWithStreamingResponse(self._agent.schedules)
527545

528546
@cached_property
529547
def sessions(self) -> SessionsResourceWithStreamingResponse:
548+
"""Operations for running and managing cloud agents"""
530549
return SessionsResourceWithStreamingResponse(self._agent.sessions)
531550

532551

@@ -546,12 +565,15 @@ def __init__(self, agent: AsyncAgentResource) -> None:
546565

547566
@cached_property
548567
def runs(self) -> AsyncRunsResourceWithStreamingResponse:
568+
"""Operations for running and managing cloud agents"""
549569
return AsyncRunsResourceWithStreamingResponse(self._agent.runs)
550570

551571
@cached_property
552572
def schedules(self) -> AsyncSchedulesResourceWithStreamingResponse:
573+
"""Operations for creating and managing scheduled agents"""
553574
return AsyncSchedulesResourceWithStreamingResponse(self._agent.schedules)
554575

555576
@cached_property
556577
def sessions(self) -> AsyncSessionsResourceWithStreamingResponse:
578+
"""Operations for running and managing cloud agents"""
557579
return AsyncSessionsResourceWithStreamingResponse(self._agent.sessions)

src/oz_agent_sdk/resources/agent/runs.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@
2929

3030

3131
class RunsResource(SyncAPIResource):
32+
"""Operations for running and managing cloud agents"""
33+
3234
@cached_property
3335
def with_raw_response(self) -> RunsResourceWithRawResponse:
3436
"""
@@ -225,6 +227,8 @@ def cancel(
225227

226228

227229
class AsyncRunsResource(AsyncAPIResource):
230+
"""Operations for running and managing cloud agents"""
231+
228232
@cached_property
229233
def with_raw_response(self) -> AsyncRunsResourceWithRawResponse:
230234
"""

src/oz_agent_sdk/resources/agent/schedules.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525

2626

2727
class SchedulesResource(SyncAPIResource):
28+
"""Operations for creating and managing scheduled agents"""
29+
2830
@cached_property
2931
def with_raw_response(self) -> SchedulesResourceWithRawResponse:
3032
"""
@@ -332,6 +334,8 @@ def resume(
332334

333335

334336
class AsyncSchedulesResource(AsyncAPIResource):
337+
"""Operations for creating and managing scheduled agents"""
338+
335339
@cached_property
336340
def with_raw_response(self) -> AsyncSchedulesResourceWithRawResponse:
337341
"""

src/oz_agent_sdk/resources/agent/sessions.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020

2121

2222
class SessionsResource(SyncAPIResource):
23+
"""Operations for running and managing cloud agents"""
24+
2325
@cached_property
2426
def with_raw_response(self) -> SessionsResourceWithRawResponse:
2527
"""
@@ -76,6 +78,8 @@ def check_redirect(
7678

7779

7880
class AsyncSessionsResource(AsyncAPIResource):
81+
"""Operations for running and managing cloud agents"""
82+
7983
@cached_property
8084
def with_raw_response(self) -> AsyncSessionsResourceWithRawResponse:
8185
"""

0 commit comments

Comments
 (0)