Docs cleanup before 0.0.97 release
This commit is contained in:
@@ -160,7 +160,7 @@ def build_elevenlabs_voice_settings(
|
|||||||
class PronunciationDictionaryLocator(BaseModel):
|
class PronunciationDictionaryLocator(BaseModel):
|
||||||
"""Locator for a pronunciation dictionary.
|
"""Locator for a pronunciation dictionary.
|
||||||
|
|
||||||
Attributes:
|
Parameters:
|
||||||
pronunciation_dictionary_id: The ID of the pronunciation dictionary.
|
pronunciation_dictionary_id: The ID of the pronunciation dictionary.
|
||||||
version_id: The version ID of the pronunciation dictionary.
|
version_id: The version ID of the pronunciation dictionary.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -203,7 +203,7 @@ def parse_start_end_tags(
|
|||||||
class TextPartForConcatenation:
|
class TextPartForConcatenation:
|
||||||
"""Class representing a part of text for concatenation with concatenate_aggregated_text.
|
"""Class representing a part of text for concatenation with concatenate_aggregated_text.
|
||||||
|
|
||||||
Attributes:
|
Parameters:
|
||||||
text: The text content.
|
text: The text content.
|
||||||
includes_inter_part_spaces: Whether any necessary inter-frame
|
includes_inter_part_spaces: Whether any necessary inter-frame
|
||||||
(leading/trailing) spaces are already included in the text.
|
(leading/trailing) spaces are already included in the text.
|
||||||
|
|||||||
@@ -137,13 +137,11 @@ class PatternPairAggregator(SimpleTextAggregator):
|
|||||||
those are reserved for the default behavior.
|
those are reserved for the default behavior.
|
||||||
start_pattern: Pattern that marks the beginning of content.
|
start_pattern: Pattern that marks the beginning of content.
|
||||||
end_pattern: Pattern that marks the end of content.
|
end_pattern: Pattern that marks the end of content.
|
||||||
action: What to do when a complete pattern is matched:
|
action: What to do when a complete pattern is matched.
|
||||||
|
|
||||||
- MatchAction.REMOVE: Remove the matched pattern from the text.
|
- MatchAction.REMOVE: Remove the matched pattern from the text.
|
||||||
- MatchAction.KEEP: Keep the matched pattern in the text and treat it as
|
- MatchAction.KEEP: Keep the matched pattern in the text and treat it as normal text. This allows you to register handlers for the pattern without affecting the aggregation logic.
|
||||||
normal text. This allows you to register handlers for
|
- MatchAction.AGGREGATE: Return the matched pattern as a separate aggregation object.
|
||||||
the pattern without affecting the aggregation logic.
|
|
||||||
- MatchAction.AGGREGATE: Return the matched pattern as a separate
|
|
||||||
aggregation object.
|
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Self for method chaining.
|
Self for method chaining.
|
||||||
|
|||||||
Reference in New Issue
Block a user