Skip to content

Commit 0c18209

Browse files
committed
doc: update docstrings
1 parent d08c969 commit 0c18209

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

src/pyannoteai/sdk/client.py

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -340,21 +340,21 @@ def diarize(
340340
media_url : str
341341
media://{...} URL created with the `upload` method or
342342
any other public URL pointing to an audio file.
343-
model : str, optional
344-
Defaults to "precision-2"
345343
num_speakers : int, optional
346344
Force number of speakers to diarize. If not provided, the
347345
number of speakers will be determined automatically.
348346
min_speakers : int, optional
349-
Minimum number of speakers. Has no effect when `num_speakers` is provided.
347+
Minimum number of speakers.
350348
max_speakers : int, optional
351-
Maximum number of speakers. Has no effect when `num_speakers` is provided.
349+
Maximum number of speakers.
352350
confidence : bool, optional
353-
Defaults to False
351+
Enable confidence scores.
354352
turn_level_confidence: bool, optional
355-
Defaults to False
353+
Enable turn-based confidence scores.
356354
exclusive: bool, optional
357-
Defaults to False
355+
Enable exclusive speaker diarization.
356+
model : str, optional
357+
Defaults to "precision-2"
358358
**kwargs : optional
359359
Extra arguments to send in the body of the request.
360360
@@ -425,7 +425,6 @@ def identify(
425425
self,
426426
media_url: str,
427427
voiceprints: dict[str, str],
428-
model: str = "precision-2",
429428
exclusive_matching: bool = True,
430429
matching_threshold: float = 0.0,
431430
num_speakers: int | None = None,
@@ -434,6 +433,7 @@ def identify(
434433
confidence: bool = False,
435434
turn_level_confidence: bool = False,
436435
exclusive: bool = False,
436+
model: str = "precision-2",
437437
**kwargs,
438438
) -> str:
439439
"""Initiate an identification job on the pyannoteAI web API
@@ -444,8 +444,7 @@ def identify(
444444
media://{...} URL created with the `upload` method or
445445
any other public URL pointing to an audio file.
446446
voiceprints : dict
447-
model : str, optional
448-
Defaults to "precision-2".
447+
Voiceprints.
449448
exclusive_matching : bool, optional
450449
Prevent multiple speakers from being matched to the same voiceprint.
451450
Defaults to True.
@@ -456,11 +455,17 @@ def identify(
456455
Force number of speakers to diarize. If not provided, the
457456
number of speakers will be determined automatically.
458457
min_speakers : int, optional
459-
Minimum number of speakers. Has no effect when `num_speakers` is provided.
458+
Minimum number of speakers.
460459
max_speakers : int, optional
461-
Maximum number of speakers. Has no effect when `num_speakers` is provided.
460+
Maximum number of speakers.
462461
confidence : bool, optional
463-
Defaults to False
462+
Enable confidence scores.
463+
turn_level_confidence: bool, optional
464+
Enable turn-based confidence scores.
465+
exclusive: bool, optional
466+
Enable exclusive speaker diarization.
467+
model : str, optional
468+
Defaults to "precision-2"
464469
**kwargs : optional
465470
Extra arguments to send in the body of the request.
466471

0 commit comments

Comments
 (0)