File size: 18,296 Bytes
9410704 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 | # This file was auto-generated by Fern from our API Definition.
import typing
from ....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ....core.request_options import RequestOptions
from ....types.dubbing_bulk_source_segment_update_response import DubbingBulkSourceSegmentUpdateResponse
from ....types.dubbing_segment_update_request import DubbingSegmentUpdateRequest
from ....types.dubbing_source_segment_update_response import DubbingSourceSegmentUpdateResponse
from ....types.dubbing_source_transcript_response import DubbingSourceTranscriptResponse
from ....types.dubbing_transcript_revision_response import DubbingTranscriptRevisionResponse
from .raw_client import AsyncRawTranscriptClient, RawTranscriptClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class TranscriptClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawTranscriptClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawTranscriptClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawTranscriptClient
"""
return self._raw_client
def get(
self, project_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> DubbingSourceTranscriptResponse:
"""
The project's source transcript, as editable segments. Available once the project is `ready`.
Parameters
----------
project_id : str
Identifier of the dubbing project.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingSourceTranscriptResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.dubbing.project.transcript.get(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
)
"""
_response = self._raw_client.get(project_id, request_options=request_options)
return _response.data
def delete_segment(
self, project_id: str, segment_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> DubbingTranscriptRevisionResponse:
"""
Enterprise only. Remove a source segment from the transcript so it is no longer dubbed. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
segment_id : str
Identifier of the segment to remove.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingTranscriptRevisionResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.dubbing.project.transcript.delete_segment(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
segment_id="0199a3f0-1c2d-7abc-8def-0123456789ab",
)
"""
_response = self._raw_client.delete_segment(project_id, segment_id, request_options=request_options)
return _response.data
def update_segment(
self,
project_id: str,
segment_id: str,
*,
request: DubbingSegmentUpdateRequest,
request_options: typing.Optional[RequestOptions] = None,
) -> DubbingSourceSegmentUpdateResponse:
"""
Enterprise only. Edit a source segment's text, speaker, or timing. Omitted fields are left unchanged. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
segment_id : str
Identifier of the segment to edit.
request : DubbingSegmentUpdateRequest
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingSourceSegmentUpdateResponse
Successful Response
Examples
--------
from elevenlabs import DubbingSegmentUpdateRequest, ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.dubbing.project.transcript.update_segment(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
segment_id="0199a3f0-1c2d-7abc-8def-0123456789ab",
request=DubbingSegmentUpdateRequest(
text="Welcome to our latest product demo.",
),
)
"""
_response = self._raw_client.update_segment(
project_id, segment_id, request=request, request_options=request_options
)
return _response.data
def update_segments(
self,
project_id: str,
*,
segments: typing.Dict[str, DubbingSegmentUpdateRequest],
request_options: typing.Optional[RequestOptions] = None,
) -> DubbingBulkSourceSegmentUpdateResponse:
"""
Enterprise only. Edit several source segments' text, speaker, or timing in one atomic request: every edit applies or none does. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
segments : typing.Dict[str, DubbingSegmentUpdateRequest]
Map of segment ID to the partial update to apply to that segment. At least one entry and at most 500.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingBulkSourceSegmentUpdateResponse
Successful Response
Examples
--------
from elevenlabs import DubbingSegmentUpdateRequest, ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.dubbing.project.transcript.update_segments(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
segments={
"0199a3f0-1c2d-7abc-8def-0123456789ab": DubbingSegmentUpdateRequest(
text="Welcome to our latest product demo.",
),
"0199a3f0-3e4f-7abc-8def-0123456789cd": DubbingSegmentUpdateRequest(
speaker_id="narrator",
),
},
)
"""
_response = self._raw_client.update_segments(project_id, segments=segments, request_options=request_options)
return _response.data
def create_segment(
self,
project_id: str,
*,
text: str,
speaker_id: str,
start_s: float,
end_s: float,
request_options: typing.Optional[RequestOptions] = None,
) -> DubbingSourceSegmentUpdateResponse:
"""
Enterprise only. Add a new source segment to the transcript. Its span must lie within the source media, last between 0.1 and 25 seconds, and not overlap another segment by the same speaker. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
text : str
The text of the new segment.
speaker_id : str
Identifier of the segment's speaker.
start_s : float
Start time of the segment, in seconds.
end_s : float
End time of the segment, in seconds.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingSourceSegmentUpdateResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.dubbing.project.transcript.create_segment(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
text="Thanks for watching.",
speaker_id="default_speaker",
start_s=42.0,
end_s=44.0,
)
"""
_response = self._raw_client.create_segment(
project_id, text=text, speaker_id=speaker_id, start_s=start_s, end_s=end_s, request_options=request_options
)
return _response.data
class AsyncTranscriptClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawTranscriptClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawTranscriptClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawTranscriptClient
"""
return self._raw_client
async def get(
self, project_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> DubbingSourceTranscriptResponse:
"""
The project's source transcript, as editable segments. Available once the project is `ready`.
Parameters
----------
project_id : str
Identifier of the dubbing project.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingSourceTranscriptResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.dubbing.project.transcript.get(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
)
asyncio.run(main())
"""
_response = await self._raw_client.get(project_id, request_options=request_options)
return _response.data
async def delete_segment(
self, project_id: str, segment_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> DubbingTranscriptRevisionResponse:
"""
Enterprise only. Remove a source segment from the transcript so it is no longer dubbed. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
segment_id : str
Identifier of the segment to remove.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingTranscriptRevisionResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.dubbing.project.transcript.delete_segment(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
segment_id="0199a3f0-1c2d-7abc-8def-0123456789ab",
)
asyncio.run(main())
"""
_response = await self._raw_client.delete_segment(project_id, segment_id, request_options=request_options)
return _response.data
async def update_segment(
self,
project_id: str,
segment_id: str,
*,
request: DubbingSegmentUpdateRequest,
request_options: typing.Optional[RequestOptions] = None,
) -> DubbingSourceSegmentUpdateResponse:
"""
Enterprise only. Edit a source segment's text, speaker, or timing. Omitted fields are left unchanged. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
segment_id : str
Identifier of the segment to edit.
request : DubbingSegmentUpdateRequest
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingSourceSegmentUpdateResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs, DubbingSegmentUpdateRequest
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.dubbing.project.transcript.update_segment(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
segment_id="0199a3f0-1c2d-7abc-8def-0123456789ab",
request=DubbingSegmentUpdateRequest(
text="Welcome to our latest product demo.",
),
)
asyncio.run(main())
"""
_response = await self._raw_client.update_segment(
project_id, segment_id, request=request, request_options=request_options
)
return _response.data
async def update_segments(
self,
project_id: str,
*,
segments: typing.Dict[str, DubbingSegmentUpdateRequest],
request_options: typing.Optional[RequestOptions] = None,
) -> DubbingBulkSourceSegmentUpdateResponse:
"""
Enterprise only. Edit several source segments' text, speaker, or timing in one atomic request: every edit applies or none does. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
segments : typing.Dict[str, DubbingSegmentUpdateRequest]
Map of segment ID to the partial update to apply to that segment. At least one entry and at most 500.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingBulkSourceSegmentUpdateResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs, DubbingSegmentUpdateRequest
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.dubbing.project.transcript.update_segments(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
segments={
"0199a3f0-1c2d-7abc-8def-0123456789ab": DubbingSegmentUpdateRequest(
text="Welcome to our latest product demo.",
),
"0199a3f0-3e4f-7abc-8def-0123456789cd": DubbingSegmentUpdateRequest(
speaker_id="narrator",
),
},
)
asyncio.run(main())
"""
_response = await self._raw_client.update_segments(
project_id, segments=segments, request_options=request_options
)
return _response.data
async def create_segment(
self,
project_id: str,
*,
text: str,
speaker_id: str,
start_s: float,
end_s: float,
request_options: typing.Optional[RequestOptions] = None,
) -> DubbingSourceSegmentUpdateResponse:
"""
Enterprise only. Add a new source segment to the transcript. Its span must lie within the source media, last between 0.1 and 25 seconds, and not overlap another segment by the same speaker. Bumps the project's `revision`, discards the affected translations in every language target, and marks any target that had already completed `stale`. No audio changes until you regenerate a target.
Parameters
----------
project_id : str
Identifier of the dubbing project.
text : str
The text of the new segment.
speaker_id : str
Identifier of the segment's speaker.
start_s : float
Start time of the segment, in seconds.
end_s : float
End time of the segment, in seconds.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DubbingSourceSegmentUpdateResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.dubbing.project.transcript.create_segment(
project_id="proj_1601kwkyxp0hfzvtmyxwqxx6mcy3",
text="Thanks for watching.",
speaker_id="default_speaker",
start_s=42.0,
end_s=44.0,
)
asyncio.run(main())
"""
_response = await self._raw_client.create_segment(
project_id, text=text, speaker_id=speaker_id, start_s=start_s, end_s=end_s, request_options=request_options
)
return _response.data
|