Skip to content

Commit aa00c5a

Browse files
authored
Stt replace links (#211)
1 parent a6301f8 commit aa00c5a

4 files changed

Lines changed: 35 additions & 34 deletions

File tree

src/yandex_ai_studio_sdk/_speechkit/speech_to_text/config.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,23 @@ class SpeechToTextConfig(BaseModelConfig):
2525
audio_format: EnumWithUnknownInput[AudioFormat]
2626

2727
#: The name of the STT model to use for recognition.
28-
#: Look for available model and versions `in documentation <https://yandex.cloud/docs/speechkit/stt/models>`_.
28+
#: Look for available model and versions
29+
#: `in documentation <https://aistudio.yandex.ru/docs/speechkit/stt/models>`_.
2930
model: str | None = None
3031

31-
#: The list of `language codes <https://yandex.cloud/docs/speechkit/stt/models>`_
32+
#: The list of `language codes <https://aistudio.yandex.ru/docs/speechkit/stt/models>`_
3233
#: to restrict recognition in the case of an auto model (or just one language code).
3334
language_codes: LanguageCodesInputType | None = None
3435

35-
#: `Text normalization options <https://yandex.cloud/docs/speechkit/stt/normalization>`_:
36+
#: `Text normalization options <https://aistudio.yandex.ru/docs/speechkit/stt/normalization>`_:
3637
#:
3738
#: * ``True`` for turning on text normalization with default parameters;
3839
#: * ``False`` for turning text normalization off;
3940
#: * :py:class:`~.TextNormalization` instance for text normaliztion with non-default parameters;
4041
#: * Nothing for server default.
4142
text_normalization: TextNormalization | bool | None = None
4243

43-
#: Configuration for an `end of utterance detection model <https://yandex.cloud/docs/speechkit/stt/eou>`_:
44+
#: Configuration for an `end of utterance detection model <https://aistudio.yandex.ru/docs/speechkit/stt/eou>`_:
4445
#:
4546
#: * ``True`` for default eou classifier;
4647
#: * ``False`` for no eou classifier (documentation describes it as "external eou classifier";
@@ -49,18 +50,18 @@ class SpeechToTextConfig(BaseModelConfig):
4950
eou_classifier: EndOfUtteranceClassifier | bool | None = None
5051

5152
#: Classifier or list of
52-
#: `classifiers over speech recognition <https://yandex.cloud/docs/speechkit/stt/analysis#classifier>`_.
53+
#: `classifiers over speech recognition <https://aistudio.yandex.ru/docs/speechkit/stt/analysis#classifier>`_.
5354
recognition_classifiers: RecognitionClassifiersInputType | None = None
5455

5556
#: Configuration for
56-
#: `speech analysis over speech recognition <https://yandex.cloud/docs/speechkit/stt/analysis#statistics>`_.
57+
#: `speech analysis over speech recognition <https://aistudio.yandex.ru/docs/speechkit/stt/analysis#statistics>`_.
5758
speech_analysis: SpeechAnalysis | None = None
5859

59-
#: Configuration for `speaker labeling <https://yandex.cloud/docs/speechkit/stt/speaker-labeling>`_.
60+
#: Configuration for `speaker labeling <https://aistudio.yandex.ru/docs/speechkit/stt/speaker-labeling>`_.
6061
speaker_labeling: bool | None = None
6162

6263
#: Configuration for
63-
#: `LLM recognition results processing <https://yandex.cloud/docs/speechkit/stt/llm-results>`_.
64+
#: `LLM recognition results processing <https://aistudio.yandex.ru/docs/speechkit/stt/llm-results>`_.
6465
#: At some point in history also known as ``Summarization``.
6566
llm_post_process: LLMPostProcessing | None = None
6667

src/yandex_ai_studio_sdk/_speechkit/speech_to_text/function.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,38 +53,38 @@ def __call__(
5353
5454
To learn more about parameters and their formats and possible values,
5555
refer to
56-
`STT docs <https://yandex.cloud/docs/speechkit/stt>`_
56+
`STT docs <https://aistudio.yandex.ru/docs/speechkit/stt>`_
5757
5858
:param audio_format: Specifies the input audio format.
5959
:param model: The name of the STT model to use for recognition.
6060
See the list of available models and versions in the
61-
`speech to text documentation <https://yandex.cloud/docs/speechkit/stt/models>`_.
62-
:param language_codes: The list of `language codes <https://yandex.cloud/docs/speechkit/stt/models>`_
61+
`speech to text documentation <https://aistudio.yandex.ru/docs/speechkit/stt/models>`_.
62+
:param language_codes: The list of `language codes <https://aistudio.yandex.ru/docs/speechkit/stt/models>`_
6363
to restrict recognition in the case of an automatic model, or a single language code.
6464
:param text_normalization:
65-
`Text normalization options <https://yandex.cloud/docs/speechkit/stt/normalization>`_:
65+
`Text normalization options <https://aistudio.yandex.ru/docs/speechkit/stt/normalization>`_:
6666
6767
* ``True`` — turn on text normalization with default parameters;
6868
* ``False`` — turn text normalization off;
6969
* :py:class:`yandex_ai_studio_sdk._speechkit.speech_to_text.structures.TextNormalization`
7070
instance — text normalization with custom parameters;
7171
* ``None`` — for server default.
7272
:param eou_classifier:
73-
Configuration for `end of utterance detection model <https://yandex.cloud/docs/speechkit/stt/eou>`_:
73+
Configuration for `end of utterance detection model <https://aistudio.yandex.ru/docs/speechkit/stt/eou>`_:
7474
7575
* ``True`` — use default EOU classifier;
7676
* ``False`` — disable EOU classifier ("external EOU classifier" in documentation);
7777
* :py:class:`yandex_ai_studio_sdk._speechkit.speech_to_text.structures.EndOfUtteranceClassifier`
7878
instance — use custom EOU classifier settings;
7979
* ``None`` — for server default.
8080
:param recognition_classifiers: Classifier or list of
81-
`classifiers for speech recognition <https://yandex.cloud/docs/speechkit/stt/analysis#classifier>`_.
81+
`classifiers for speech recognition <https://aistudio.yandex.ru/docs/speechkit/stt/analysis#classifier>`_.
8282
:param speech_analysis: Configuration for
83-
`speech analysis over speech recognition <https://yandex.cloud/docs/speechkit/stt/analysis#statistics>`_.
83+
`speech analysis over speech recognition <https://aistudio.yandex.ru/docs/speechkit/stt/analysis#statistics>`_.
8484
:param speaker_labeling: Configuration for
85-
`speaker labeling <https://yandex.cloud/docs/speechkit/stt/speaker-labeling>`_.
85+
`speaker labeling <https://aistudio.yandex.ru/docs/speechkit/stt/speaker-labeling>`_.
8686
:param llm_post_process: Configuration for
87-
`LLM recognition results processing <https://yandex.cloud/docs/speechkit/stt/llm-results>`_.
87+
`LLM recognition results processing <https://aistudio.yandex.ru/docs/speechkit/stt/llm-results>`_.
8888
(Also known as Summarization in earlier documentation.)
8989
"""
9090

src/yandex_ai_studio_sdk/_speechkit/speech_to_text/structures.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def _coerce(cls, value: Self | bool | None) -> Self | None:
4646

4747
@dataclass(frozen=True)
4848
class TextNormalization(ProtoBasedWithBoolDefault[ProtoTextNormalizationOptions]):
49-
"""Class which encapsulates `text normaliztion options <https://yandex.cloud/docs/speechkit/stt/normalization>`_.
49+
"""Class which encapsulates `text normaliztion options <https://aistudio.yandex.ru/docs/speechkit/stt/normalization>`_.
5050
5151
Usage of object of this class itself in speech to text configuration is turning on normalization.
5252
Options of this class have different defaults at backend, i.e. some options could turn on the feature
@@ -105,7 +105,7 @@ class EndOfUtteranceSensitivity(ProtoBasedEnum):
105105
@dataclass(frozen=True)
106106
class EndOfUtteranceClassifier(ProtoBasedWithBoolDefault[ProtoDefaultEouClassifier]):
107107
"""Class which encapsulates settings
108-
`end of utterance classifier <https://yandex.cloud/docs/speechkit/stt/eou>`_.
108+
`end of utterance classifier <https://aistudio.yandex.ru/docs/speechkit/stt/eou>`_.
109109
110110
Usage this class object in speech to text configuration turning on
111111
default end-of-utterance classification.
@@ -182,7 +182,7 @@ class RecognitionTriggerType(ProtoBasedEnum):
182182
class WellKnownRecognitionClassifiers(str, Enum):
183183
"""Well known names of recognition classifier triggers.
184184
185-
More on the topic in `article <https://yandex.cloud/docs/speechkit/stt/analysis#classifier>`_.
185+
More on the topic in `article <https://aistudio.yandex.ru/docs/speechkit/stt/analysis#classifier>`_.
186186
"""
187187

188188
formal_greeting = 'formal_greeting'
@@ -201,7 +201,7 @@ class RecognitionClassifier(ProtoSerializable[ProtoRecognitionClassifier]):
201201
"""Classifier to use in speech recognition.
202202
203203
For detailed information refer to `classification documentation
204-
<https://yandex.cloud/docs/speechkit/stt/analysis>`_.
204+
<https://aistudio.yandex.ru/docs/speechkit/stt/analysis>`_.
205205
206206
You can pass a string as a trigger:
207207
@@ -289,7 +289,7 @@ def on_partial(cls, name: str) -> Self:
289289
@dataclass(frozen=True)
290290
class SpeechAnalysis(ProtoSerializable[ProtoSpeechAnalysisOptions]):
291291
"""Class which encapsulates
292-
`speech analysis settings <https://yandex.cloud/docs/speechkit/stt/analysis>`_"""
292+
`speech analysis settings <https://aistudio.yandex.ru/docs/speechkit/stt/analysis>`_"""
293293

294294
#: Analyse speech for every speaker
295295
speaker_analysis: UndefinedOr[bool] = UNDEFINED
@@ -345,7 +345,7 @@ def _to_proto(self, sdk: SDKType) -> SummarizationProperty:
345345
class LLMPostProcessing(ProtoSerializable[ProtoSummarizationOptions]):
346346
"""Class for encapsulating
347347
`transcription llm post processing settings
348-
<https://yandex.cloud/docs/speechkit/stt/llm-results>`_
348+
<https://aistudio.yandex.ru/docs/speechkit/stt/llm-results>`_
349349
350350
You could pass a full model uri:
351351
@@ -379,7 +379,7 @@ class LLMPostProcessing(ProtoSerializable[ProtoSummarizationOptions]):
379379
380380
"""
381381

382-
#: The `ID of the model <https://yandex.cloud/docs/foundation-models/concepts/yandexgpt/models>`_
382+
#: The `ID of the model <https://aistudio.yandex.ru/docs/foundation-models/concepts/yandexgpt/models>`_
383383
#: Model name to be used for completion generation;
384384
#: If the name contains '://', it is treated as a full URI.
385385
#: Otherwise constructs a URI in the form 'gpt://<folder_id>/<model_name>/<model_version>'

src/yandex_ai_studio_sdk/_speechkit/speech_to_text/stt.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,38 +86,38 @@ def configure( # type: ignore[override]
8686
8787
To learn more about parameters and their formats and possible values,
8888
refer to
89-
`STT documentation <https://yandex.cloud/docs/speechkit/stt>`_
89+
`STT documentation <https://aistudio.yandex.ru/docs/speechkit/stt>`_
9090
9191
:param audio_format: Specifies the input audio format.
9292
:param model: The name of the STT model to use for recognition.
9393
See the list of available models and versions
94-
`in the documentation <https://yandex.cloud/docs/speechkit/stt/models>`_.
95-
:param language_codes: The list of `language codes <https://yandex.cloud/docs/speechkit/stt/models>`_
94+
`in the documentation <https://aistudio.yandex.ru/docs/speechkit/stt/models>`_.
95+
:param language_codes: The list of `language codes <https://aistudio.yandex.ru/docs/speechkit/stt/models>`_
9696
to restrict recognition in the case of an automatic model, or a single language code.
9797
:param text_normalization:
98-
`Text normalization options <https://yandex.cloud/docs/speechkit/stt/normalization>`_:
98+
`Text normalization options <https://aistudio.yandex.ru/docs/speechkit/stt/normalization>`_:
9999
100100
* ``True`` — turn on text normalization with default parameters;
101101
* ``False`` — turn text normalization off;
102102
* :py:class:`yandex_ai_studio_sdk._speechkit.speech_to_text.structures.TextNormalization`
103103
instance — text normalization with custom parameters;
104104
* ``None`` — for server default.
105105
:param eou_classifier:
106-
Configuration for `end of utterance detection model <https://yandex.cloud/docs/speechkit/stt/eou>`_:
106+
Configuration for `end of utterance detection model <https://aistudio.yandex.ru/docs/speechkit/stt/eou>`_:
107107
108108
* ``True`` — use default EOU classifier;
109109
* ``False`` — disable EOU classifier ("external EOU classifier" in documentation);
110110
* :py:class:`yandex_ai_studio_sdk._speechkit.speech_to_text.structures.EndOfUtteranceClassifier`
111111
instance — use custom EOU classifier settings;
112112
* ``None`` — for server default.
113113
:param recognition_classifiers: Classifier or list of
114-
`classifiers for speech recognition <https://yandex.cloud/docs/speechkit/stt/analysis#classifier>`_.
114+
`classifiers for speech recognition <https://aistudio.yandex.ru/docs/speechkit/stt/analysis#classifier>`_.
115115
:param speech_analysis: Configuration for
116-
`speech analysis over speech recognition <https://yandex.cloud/docs/speechkit/stt/analysis#statistics>`_.
116+
`speech analysis over speech recognition <https://aistudio.yandex.ru/docs/speechkit/stt/analysis#statistics>`_.
117117
:param speaker_labeling: Configuration for
118-
`speaker labeling <https://yandex.cloud/docs/speechkit/stt/speaker-labeling>`_.
118+
`speaker labeling <https://aistudio.yandex.ru/docs/speechkit/stt/speaker-labeling>`_.
119119
:param llm_post_process: Configuration for
120-
`LLM recognition results processing <https://yandex.cloud/docs/speechkit/stt/llm-results>`_.
120+
`LLM recognition results processing <https://aistudio.yandex.ru/docs/speechkit/stt/llm-results>`_.
121121
(Also known as Summarization in earlier documentation.)
122122
123123
"""
@@ -338,7 +338,7 @@ async def _run_stream(
338338

339339
def create_bistream(self, *, timeout: float = 10 * 60) -> STTBidirectionalStreamTypeT:
340340
"""Creates a bidirectional stream object for using
341-
`Yandex SpeechKit Streaming speech recognition <https://yandex.cloud/docs/speechkit/stt/streaming>`_.
341+
`Yandex SpeechKit Streaming speech recognition <https://aistudio.yandex.ru/docs/speechkit/stt/streaming>`_.
342342
343343
:param timeout: GRPC timeout in seconds that defines the maximum lifetime of the entire stream.
344344
The timeout countdown begins from the moment of the first stream interaction.

0 commit comments

Comments
 (0)