Skip to content

SpeakerEnrollmentJobSummary

Source code in docs_src/capo_voice_id/types/speaker_enrollment_job_summary.py
class SpeakerEnrollmentJobSummary(TypedDict, closed=True):
    job_name: NotRequired["capo_voice_id.types.job_name.JobName"]
    """<p>The client-provided name for the speaker enrollment job.</p>"""
    job_id: NotRequired["capo_voice_id.types.job_id.JobId"]
    """<p>The service-generated identifier for the speaker enrollment job.</p>"""
    job_status: NotRequired[
        "capo_voice_id.types.speaker_enrollment_job_status.SpeakerEnrollmentJobStatus"
    ]
    """<p>The current status of the speaker enrollment job.</p>"""
    domain_id: NotRequired["capo_voice_id.types.domain_id.DomainId"]
    """<p>The identifier of the domain that contains the speaker enrollment job.</p>"""
    created_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>A timestamp of when of the speaker enrollment job was created.</p>"""
    ended_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>A timestamp of when the speaker enrollment job ended.</p>"""
    failure_details: NotRequired["capo_voice_id.types.failure_details.FailureDetails"]
    """<p>Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual registration requests that failed.</p>"""
    job_progress: NotRequired["capo_voice_id.types.job_progress.JobProgress"]
    """<p>Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.</p>"""

created_at instance-attribute

created_at: NotRequired[Timestamp]

A timestamp of when of the speaker enrollment job was created.

domain_id instance-attribute

domain_id: NotRequired[DomainId]

The identifier of the domain that contains the speaker enrollment job.

ended_at instance-attribute

ended_at: NotRequired[Timestamp]

A timestamp of when the speaker enrollment job ended.

failure_details instance-attribute

failure_details: NotRequired[FailureDetails]

Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

job_id instance-attribute

job_id: NotRequired[JobId]

The service-generated identifier for the speaker enrollment job.

job_name instance-attribute

job_name: NotRequired[JobName]

The client-provided name for the speaker enrollment job.

job_progress instance-attribute

job_progress: NotRequired[JobProgress]

Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.

job_status instance-attribute

job_status: NotRequired[SpeakerEnrollmentJobStatus]

The current status of the speaker enrollment job.