Skip to content

Commit 02fdd15

Browse files
authored
Merge branch 'master' into Add-docstring-for_types
2 parents 289e45f + d41771e commit 02fdd15

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+2655
-136
lines changed

docs/async/chat/completions.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Domain
2+
------
3+
4+
.. autoclass:: yandex_cloud_ml_sdk._chat.completions.function.AsyncChatCompletions
5+
6+
Model
7+
-----
8+
9+
.. autoclass:: yandex_cloud_ml_sdk._chat.completions.model.AsyncChatModel
10+
:undoc-members:

docs/async/chat/domain.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Chat domain
2+
===========
3+
4+
.. autoclass:: yandex_cloud_ml_sdk._chat.AsyncChat
5+
:undoc-members:
6+
7+
.. toctree::
8+
:hidden:
9+
10+
completions

docs/async/sdk.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ Async SDK
1919
datasets
2020
tuning
2121
batch
22+
chat/domain

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@
6868
('py:class', 'yandex_cloud_ml_sdk._client._D'),
6969
('py:class', 'google.protobuf.message.Message'),
7070
('py:class', 'httpx.AsyncClient'),
71+
('py:class', 'httpx_sse._models.ServerSentEvent'),
7172
# It creates a ton of langchain refs I want to pass right now
7273
('py:class', 'yandex_cloud_ml_sdk._types.langchain.BaseYandexLanguageModel'),
7374
('py:class', 'BaseYandexLanguageModel'),

docs/internals/bases.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,9 @@ Base classes
7777

7878
.. autoclass:: yandex_cloud_ml_sdk._types.batch.operation.BaseBatchTaskOperation
7979
:undoc-members:
80+
81+
.. autoclass:: yandex_cloud_ml_sdk._chat.BaseChat
82+
83+
.. autoclass:: yandex_cloud_ml_sdk._chat.completions.function.BaseChatCompletions
84+
85+
.. autoclass:: yandex_cloud_ml_sdk._chat.completions.model.BaseChatModel

docs/sync/chat/completions.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Domain
2+
------
3+
4+
.. autoclass:: yandex_cloud_ml_sdk._chat.completions.function.ChatCompletions
5+
6+
Model
7+
-----
8+
9+
.. autoclass:: yandex_cloud_ml_sdk._chat.completions.model.ChatModel
10+
:undoc-members:

docs/sync/chat/domain.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Chat domain
2+
===========
3+
4+
.. autoclass:: yandex_cloud_ml_sdk._chat.Chat
5+
:undoc-members:
6+
7+
.. toctree::
8+
:hidden:
9+
10+
completions

docs/sync/sdk.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@
1919
datasets
2020
tuning
2121
batch
22+
chat/domain

docs/types/message.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ Completions-related message types
4343
.. autoclass:: yandex_cloud_ml_sdk._models.completions.token.Token
4444
:undoc-members:
4545

46+
Chat completions related message types
47+
--------------------------------------
48+
49+
.. autotypeddict:: yandex_cloud_ml_sdk._chat.completions.message.ChatFunctionResultMessageDict
50+
4651

4752
Image generation messages
4853
-------------------------

docs/types/model_results.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,20 @@ Image generation
5555

5656
.. autoclass:: yandex_cloud_ml_sdk._models.image_generation.result.ImageGenerationModelResult
5757
:undoc-members:
58+
59+
Chat completions
60+
----------------
61+
62+
.. currentmodule:: yandex_cloud_ml_sdk._chat.completions.result
63+
64+
.. autoclass:: ChatModelResult
65+
:undoc-members:
66+
67+
.. autoclass:: ChatChoice
68+
:undoc-members:
69+
70+
.. autoclass:: FinishReason
71+
:undoc-members:
72+
73+
.. autoclass:: ChatUsage
74+
:undoc-members:

0 commit comments

Comments
 (0)