Skip to content

Commit 3e279c8

Browse files
authored
Add docstrings for _threads/domain.py - v4
1 parent ac4d784 commit 3e279c8

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

src/yandex_cloud_ml_sdk/_threads/domain.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@
1919

2020

2121
class BaseThreads(BaseDomain, Generic[ThreadTypeT]):
22-
"""A class for managing threads in a specific domain.
22+
"""A class for managing threads. It is a part of Assistants API.
2323
24-
This class provides methods to create, retrieve, and list threads. It acts as a foundation for
25-
thread implementations and requires a specific thread type to be defined.
24+
This class provides methods to create, retrieve, and list threads.
2625
"""
2726
_thread_impl: type[ThreadTypeT]
2827

@@ -45,7 +44,7 @@ async def _create(
4544
:param labels: a set of labels for the thread.
4645
:param ttl_days: time-to-live in days for the thread.
4746
:param expiration_policy: expiration policy for the file.
48-
Assepts for passing ``static`` or ``since_last_active`` `strings <https://yandex.cloud/docs/foundation-models/threads/api-ref/Message/create#yandex.cloud.ai.common.ExpirationConfig>`_. Should be defined if ``ttl_days`` has been defined, otherwise both parameters should be undefined.
47+
Assepts for passing ``static`` or ``since_last_active`` strings. Should be defined if ``ttl_days`` has been defined, otherwise both parameters should be undefined.
4948
:param timeout: timeout for the service call in seconds.
5049
Defaults to 60 seconds.
5150
"""
@@ -80,7 +79,7 @@ async def _get(
8079
) -> ThreadTypeT:
8180
"""Retrieve a thread by its id.
8281
83-
This method fetches a thread using its unique identifier.
82+
This method fetches an already created thread using its unique identifier.
8483
8584
:param thread_id: the unique identifier of the thread to retrieve.
8685
:param timeout: timeout for the service call in seconds.
@@ -108,7 +107,7 @@ async def _list(
108107
) -> AsyncIterator[ThreadTypeT]:
109108
"""List threads in the specified folder.
110109
111-
This method retrieves a list of threads, paginated by the specified page size. It continues
110+
This method retrieves a list of threads. It continues
112111
to fetch threads until there are no more available.
113112
114113
:param page_size: the maximum number of threads to return per page.

0 commit comments

Comments
 (0)