Package com.ringcentral.paths.ai.audio.v1.enrollments

Class Index

java.lang.Object

com.ringcentral.paths.ai.audio.v1.enrollments.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	speakerId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String speakerId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Delete The Enrollment for the provided Speaker.
EnrollmentStatus	get()	Get The Status of Enrollment for the provided Speaker.
ListEnrolledSpeakers	list()
ListEnrolledSpeakers	list(CaiEnrollmentsListParameters queryParams)	Returns the List of Enrolled Speakers HTTP Method: get Endpoint: /ai/audio/v1/enrollments Rate Limit Group: Heavy App Permission: AI
EnrollmentStatus	patch(EnrollmentPatchInput enrollmentPatchInput)	Add newer audio data to improve an existing speaker enrollment HTTP Method: patch Endpoint: /ai/audio/v1/enrollments/{speakerId} Rate Limit Group: Heavy App Permission: AI
String	path()
String	path(Boolean withParameter)
EnrollmentStatus	post(EnrollmentInput enrollmentInput)	Creates Enrollment for the provided Speaker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

speakerId

public String speakerId

Constructor Details

Index

public Index(Index parent,
 String speakerId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public ListEnrolledSpeakers list(CaiEnrollmentsListParameters queryParams)
                          throws RestException,
IOException

Returns the List of Enrolled Speakers HTTP Method: get Endpoint: /ai/audio/v1/enrollments Rate Limit Group: Heavy App Permission: AI

Throws:

RestException

IOException

list

public ListEnrolledSpeakers list()
                          throws RestException,
IOException

Throws:

RestException

IOException

post

public EnrollmentStatus post(EnrollmentInput enrollmentInput)
                      throws RestException,
IOException

Creates Enrollment for the provided Speaker. HTTP Method: post Endpoint: /ai/audio/v1/enrollments Rate Limit Group: Heavy App Permission: AI

Throws:

RestException

IOException

get

public EnrollmentStatus get()
                     throws RestException,
IOException

Get The Status of Enrollment for the provided Speaker. HTTP Method: get Endpoint: /ai/audio/v1/enrollments/{speakerId} Rate Limit Group: Heavy App Permission: AI

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Delete The Enrollment for the provided Speaker. HTTP Method: delete Endpoint: /ai/audio/v1/enrollments/{speakerId} Rate Limit Group: Heavy App Permission: AI

Throws:

RestException

IOException

patch

public EnrollmentStatus patch(EnrollmentPatchInput enrollmentPatchInput)
                       throws RestException,
IOException

Add newer audio data to improve an existing speaker enrollment HTTP Method: patch Endpoint: /ai/audio/v1/enrollments/{speakerId} Rate Limit Group: Heavy App Permission: AI

Throws:

RestException

IOException