VoiceID

import { VoiceID } from "https://aws-api.deno.dev/v0.3/services/voiceid.ts?docs=full";

class VoiceID {

constructor(apiFactory: client.ApiFactory);

async createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResponse>;

async deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<void>;

async deleteFraudster(params: DeleteFraudsterRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSpeaker(params: DeleteSpeakerRequest, opts?: client.RequestOptions): Promise<void>;

async describeDomain(params: DescribeDomainRequest, opts?: client.RequestOptions): Promise<DescribeDomainResponse>;

async describeFraudster(params: DescribeFraudsterRequest, opts?: client.RequestOptions): Promise<DescribeFraudsterResponse>;

async describeFraudsterRegistrationJob(params: DescribeFraudsterRegistrationJobRequest, opts?: client.RequestOptions): Promise<DescribeFraudsterRegistrationJobResponse>;

async describeSpeaker(params: DescribeSpeakerRequest, opts?: client.RequestOptions): Promise<DescribeSpeakerResponse>;

async describeSpeakerEnrollmentJob(params: DescribeSpeakerEnrollmentJobRequest, opts?: client.RequestOptions): Promise<DescribeSpeakerEnrollmentJobResponse>;

async evaluateSession(params: EvaluateSessionRequest, opts?: client.RequestOptions): Promise<EvaluateSessionResponse>;

async listDomains(params?: ListDomainsRequest, opts?: client.RequestOptions): Promise<ListDomainsResponse>;

async listFraudsterRegistrationJobs(params: ListFraudsterRegistrationJobsRequest, opts?: client.RequestOptions): Promise<ListFraudsterRegistrationJobsResponse>;

async listSpeakerEnrollmentJobs(params: ListSpeakerEnrollmentJobsRequest, opts?: client.RequestOptions): Promise<ListSpeakerEnrollmentJobsResponse>;

async listSpeakers(params: ListSpeakersRequest, opts?: client.RequestOptions): Promise<ListSpeakersResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async optOutSpeaker(params: OptOutSpeakerRequest, opts?: client.RequestOptions): Promise<OptOutSpeakerResponse>;

async startFraudsterRegistrationJob(params: StartFraudsterRegistrationJobRequest, opts?: client.RequestOptions): Promise<StartFraudsterRegistrationJobResponse>;

async startSpeakerEnrollmentJob(params: StartSpeakerEnrollmentJobRequest, opts?: client.RequestOptions): Promise<StartSpeakerEnrollmentJobResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateDomain(params: UpdateDomainRequest, opts?: client.RequestOptions): Promise<UpdateDomainResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new VoiceID(apiFactory: client.ApiFactory)

[src]

§Methods

createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResponse>

[src]

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.

deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified domain from the Amazon Connect Voice ID system.

deleteFraudster(params: DeleteFraudsterRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified fraudster from the Amazon Connect Voice ID system.

deleteSpeaker(params: DeleteSpeakerRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified speaker from the Amazon Connect Voice ID system.

describeDomain(params: DescribeDomainRequest, opts?: client.RequestOptions): Promise<DescribeDomainResponse>

[src]

Describes the specified domain.

describeFraudster(params: DescribeFraudsterRequest, opts?: client.RequestOptions): Promise<DescribeFraudsterResponse>

[src]

Describes the specified fraudster.

describeFraudsterRegistrationJob(params: DescribeFraudsterRegistrationJobRequest, opts?: client.RequestOptions): Promise<DescribeFraudsterRegistrationJobResponse>

[src]

Describes the specified fraudster registration job.

describeSpeaker(params: DescribeSpeakerRequest, opts?: client.RequestOptions): Promise<DescribeSpeakerResponse>

[src]

Describes the specified speaker.

describeSpeakerEnrollmentJob(params: DescribeSpeakerEnrollmentJobRequest, opts?: client.RequestOptions): Promise<DescribeSpeakerEnrollmentJobResponse>

[src]

Describes the specified speaker enrollment job.

evaluateSession(params: EvaluateSessionRequest, opts?: client.RequestOptions): Promise<EvaluateSessionResponse>

[src]

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

listDomains(params?: ListDomainsRequest, opts?: client.RequestOptions): Promise<ListDomainsResponse>

[src]

Lists all the domains in the Amazon Web Services account.

listFraudsterRegistrationJobs(params: ListFraudsterRegistrationJobsRequest, opts?: client.RequestOptions): Promise<ListFraudsterRegistrationJobsResponse>

[src]

Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

listSpeakerEnrollmentJobs(params: ListSpeakerEnrollmentJobsRequest, opts?: client.RequestOptions): Promise<ListSpeakerEnrollmentJobsResponse>

[src]

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

listSpeakers(params: ListSpeakersRequest, opts?: client.RequestOptions): Promise<ListSpeakersResponse>

[src]

Lists all speakers in a specified domain.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists all tags associated with a specified Voice ID resource.

optOutSpeaker(params: OptOutSpeakerRequest, opts?: client.RequestOptions): Promise<OptOutSpeakerResponse>

[src]

Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in the system.

startFraudsterRegistrationJob(params: StartFraudsterRegistrationJobRequest, opts?: client.RequestOptions): Promise<StartFraudsterRegistrationJobResponse>

[src]

Starts a new batch fraudster registration job using provided details.

startSpeakerEnrollmentJob(params: StartSpeakerEnrollmentJobRequest, opts?: client.RequestOptions): Promise<StartSpeakerEnrollmentJobResponse>

[src]

Starts a new batch speaker enrollment job using specified details.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Tags an Amazon Connect Voice ID resource with the provided list of tags.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes specified tags from a specified Amazon Connect Voice ID resource.

updateDomain(params: UpdateDomainRequest, opts?: client.RequestOptions): Promise<UpdateDomainResponse>

[src]

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]