Package com.mypurecloud.sdk.v2.api

Class AIStudioApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.AIStudioApiAsync

public class AIStudioApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
AIStudioApiAsync()
AIStudioApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<Void>	deleteConversationsSummariesSettingAsync(DeleteConversationsSummariesSettingRequest request, AsyncApiCallback<Void> callback)	Delete a summary setting.
Future<ApiResponse<Void>>	deleteConversationsSummariesSettingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)	Delete a summary setting.
Future<GuideJob>	deleteGuideJobsAsync(DeleteGuideJobsRequest request, AsyncApiCallback<GuideJob> callback)	Start the deletion of a guide.
Future<ApiResponse<GuideJob>>	deleteGuideJobsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GuideJob>> callback)	Start the deletion of a guide.
Future<SummarySetting>	getConversationsSummariesSettingAsync(GetConversationsSummariesSettingRequest request, AsyncApiCallback<SummarySetting> callback)	Receive a summary setting.
Future<ApiResponse<SummarySetting>>	getConversationsSummariesSettingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<SummarySetting>> callback)	Receive a summary setting.
Future<SummarySettingEntityListing>	getConversationsSummariesSettingsAsync(GetConversationsSummariesSettingsRequest request, AsyncApiCallback<SummarySettingEntityListing> callback)	Get all summary settings.
Future<ApiResponse<SummarySettingEntityListing>>	getConversationsSummariesSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<SummarySettingEntityListing>> callback)	Get all summary settings.
Future<Guide>	getGuideAsync(GetGuideRequest request, AsyncApiCallback<Guide> callback)	Get guide.
Future<ApiResponse<Guide>>	getGuideAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Guide>> callback)	Get guide.
Future<GuideJob>	getGuideJobAsync(GetGuideJobRequest request, AsyncApiCallback<GuideJob> callback)	Get the specified guide deletion job.
Future<ApiResponse<GuideJob>>	getGuideJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GuideJob>> callback)	Get the specified guide deletion job.
Future<GuideEntityListing>	getGuidesAsync(GetGuidesRequest request, AsyncApiCallback<GuideEntityListing> callback)	Get all guides.
Future<ApiResponse<GuideEntityListing>>	getGuidesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GuideEntityListing>> callback)	Get all guides.
Future<GuideContentGenerationJob>	getGuidesJobAsync(GetGuidesJobRequest request, AsyncApiCallback<GuideContentGenerationJob> callback)	Get the status of the guide content generation job.
Future<ApiResponse<GuideContentGenerationJob>>	getGuidesJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GuideContentGenerationJob>> callback)	Get the status of the guide content generation job.
Future<GuideVersion>	getGuideVersionAsync(GetGuideVersionRequest request, AsyncApiCallback<GuideVersion> callback)	Get a guide version.
Future<ApiResponse<GuideVersion>>	getGuideVersionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GuideVersion>> callback)	Get a guide version.
Future<GuideVersionPublishJob>	getGuideVersionJobAsync(GetGuideVersionJobRequest request, AsyncApiCallback<GuideVersionPublishJob> callback)	Get the status of the publishing job for this guide version.
Future<ApiResponse<GuideVersionPublishJob>>	getGuideVersionJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<GuideVersionPublishJob>> callback)	Get the status of the publishing job for this guide version.
Future<Guide>	patchGuideAsync(PatchGuideRequest request, AsyncApiCallback<Guide> callback)	Update a guide.
Future<ApiResponse<Guide>>	patchGuideAsync(ApiRequest<UpdateGuide> request, AsyncApiCallback<ApiResponse<Guide>> callback)	Update a guide.
Future<GuideVersion>	patchGuideVersionAsync(PatchGuideVersionRequest request, AsyncApiCallback<GuideVersion> callback)	Update a guide version.
Future<ApiResponse<GuideVersion>>	patchGuideVersionAsync(ApiRequest<UpdateGuideVersion> request, AsyncApiCallback<ApiResponse<GuideVersion>> callback)	Update a guide version.
Future<Void>	postConversationsSummariesPreviewAsync(PostConversationsSummariesPreviewRequest request, AsyncApiCallback<Void> callback)	Trigger summary preview event generation.
Future<ApiResponse<Void>>	postConversationsSummariesPreviewAsync(ApiRequest<SummarySettingWithTranscript> request, AsyncApiCallback<ApiResponse<Void>> callback)	Trigger summary preview event generation.
Future<SummarySetting>	postConversationsSummariesSettingsAsync(PostConversationsSummariesSettingsRequest request, AsyncApiCallback<SummarySetting> callback)	Create a summary setting.
Future<ApiResponse<SummarySetting>>	postConversationsSummariesSettingsAsync(ApiRequest<SummarySetting> request, AsyncApiCallback<ApiResponse<SummarySetting>> callback)	Create a summary setting.
Future<Guide>	postGuidesAsync(PostGuidesRequest request, AsyncApiCallback<Guide> callback)	Create a guide.
Future<ApiResponse<Guide>>	postGuidesAsync(ApiRequest<CreateGuide> request, AsyncApiCallback<ApiResponse<Guide>> callback)	Create a guide.
Future<GuideSessionTurnResponse>	postGuideSessionTurnsAsync(PostGuideSessionTurnsRequest request, AsyncApiCallback<GuideSessionTurnResponse> callback)	Add a turn to a guide session.
Future<ApiResponse<GuideSessionTurnResponse>>	postGuideSessionTurnsAsync(ApiRequest<GuideSessionTurnRequest> request, AsyncApiCallback<ApiResponse<GuideSessionTurnResponse>> callback)	Add a turn to a guide session.
Future<GuideContentGenerationJob>	postGuidesJobsAsync(PostGuidesJobsRequest request, AsyncApiCallback<GuideContentGenerationJob> callback)	Start a guide content generation job.
Future<ApiResponse<GuideContentGenerationJob>>	postGuidesJobsAsync(ApiRequest<GenerateGuideContentRequest> request, AsyncApiCallback<ApiResponse<GuideContentGenerationJob>> callback)	Start a guide content generation job.
Future<UploadUrlResponse>	postGuidesUploadsAsync(PostGuidesUploadsRequest request, AsyncApiCallback<UploadUrlResponse> callback)	Generate presigned URL for uploading a file content to generate guide
Future<ApiResponse<UploadUrlResponse>>	postGuidesUploadsAsync(ApiRequest<UploadUrlRequest> request, AsyncApiCallback<ApiResponse<UploadUrlResponse>> callback)	Generate presigned URL for uploading a file content to generate guide
Future<GuideVersionPublishJob>	postGuideVersionJobsAsync(PostGuideVersionJobsRequest request, AsyncApiCallback<GuideVersionPublishJob> callback)	Start the publishing of a guide version.
Future<ApiResponse<GuideVersionPublishJob>>	postGuideVersionJobsAsync(ApiRequest<GuideVersionPublishJobRequest> request, AsyncApiCallback<ApiResponse<GuideVersionPublishJob>> callback)	Start the publishing of a guide version.
Future<GuideVersion>	postGuideVersionsAsync(PostGuideVersionsRequest request, AsyncApiCallback<GuideVersion> callback)	Create a guide version.
Future<ApiResponse<GuideVersion>>	postGuideVersionsAsync(ApiRequest<CreateGuideVersion> request, AsyncApiCallback<ApiResponse<GuideVersion>> callback)	Create a guide version.
Future<SummarySetting>	putConversationsSummariesSettingAsync(PutConversationsSummariesSettingRequest request, AsyncApiCallback<SummarySetting> callback)	Update a summary setting.
Future<ApiResponse<SummarySetting>>	putConversationsSummariesSettingAsync(ApiRequest<SummarySetting> request, AsyncApiCallback<ApiResponse<SummarySetting>> callback)	Update a summary setting.

Methods inherited from class java.lang.Object

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

Constructor Details

AIStudioApiAsync

public AIStudioApiAsync()

AIStudioApiAsync

public AIStudioApiAsync(ApiClient apiClient)

Method Details

deleteConversationsSummariesSettingAsync

public Future<Void> deleteConversationsSummariesSettingAsync(DeleteConversationsSummariesSettingRequest request,
 AsyncApiCallback<Void> callback)

Delete a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteConversationsSummariesSettingAsync

public Future<ApiResponse<Void>> deleteConversationsSummariesSettingAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Void>> callback)

Delete a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteGuideJobsAsync

public Future<GuideJob> deleteGuideJobsAsync(DeleteGuideJobsRequest request,
 AsyncApiCallback<GuideJob> callback)

Start the deletion of a guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

deleteGuideJobsAsync

public Future<ApiResponse<GuideJob>> deleteGuideJobsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<GuideJob>> callback)

Start the deletion of a guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getConversationsSummariesSettingAsync

public Future<SummarySetting> getConversationsSummariesSettingAsync(GetConversationsSummariesSettingRequest request,
 AsyncApiCallback<SummarySetting> callback)

Receive a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getConversationsSummariesSettingAsync

public Future<ApiResponse<SummarySetting>> getConversationsSummariesSettingAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<SummarySetting>> callback)

Receive a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getConversationsSummariesSettingsAsync

public Future<SummarySettingEntityListing> getConversationsSummariesSettingsAsync(GetConversationsSummariesSettingsRequest request,
 AsyncApiCallback<SummarySettingEntityListing> callback)

Get all summary settings.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getConversationsSummariesSettingsAsync

public Future<ApiResponse<SummarySettingEntityListing>> getConversationsSummariesSettingsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<SummarySettingEntityListing>> callback)

Get all summary settings.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideAsync

public Future<Guide> getGuideAsync(GetGuideRequest request,
 AsyncApiCallback<Guide> callback)

Get guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideAsync

public Future<ApiResponse<Guide>> getGuideAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<Guide>> callback)

Get guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideJobAsync

public Future<GuideJob> getGuideJobAsync(GetGuideJobRequest request,
 AsyncApiCallback<GuideJob> callback)

Get the specified guide deletion job.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideJobAsync

public Future<ApiResponse<GuideJob>> getGuideJobAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<GuideJob>> callback)

Get the specified guide deletion job.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideVersionAsync

public Future<GuideVersion> getGuideVersionAsync(GetGuideVersionRequest request,
 AsyncApiCallback<GuideVersion> callback)

Get a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideVersionAsync

public Future<ApiResponse<GuideVersion>> getGuideVersionAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<GuideVersion>> callback)

Get a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideVersionJobAsync

public Future<GuideVersionPublishJob> getGuideVersionJobAsync(GetGuideVersionJobRequest request,
 AsyncApiCallback<GuideVersionPublishJob> callback)

Get the status of the publishing job for this guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuideVersionJobAsync

public Future<ApiResponse<GuideVersionPublishJob>> getGuideVersionJobAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<GuideVersionPublishJob>> callback)

Get the status of the publishing job for this guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuidesAsync

public Future<GuideEntityListing> getGuidesAsync(GetGuidesRequest request,
 AsyncApiCallback<GuideEntityListing> callback)

Get all guides.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuidesAsync

public Future<ApiResponse<GuideEntityListing>> getGuidesAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<GuideEntityListing>> callback)

Get all guides.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuidesJobAsync

public Future<GuideContentGenerationJob> getGuidesJobAsync(GetGuidesJobRequest request,
 AsyncApiCallback<GuideContentGenerationJob> callback)

Get the status of the guide content generation job.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getGuidesJobAsync

public Future<ApiResponse<GuideContentGenerationJob>> getGuidesJobAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<GuideContentGenerationJob>> callback)

Get the status of the guide content generation job.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchGuideAsync

public Future<Guide> patchGuideAsync(PatchGuideRequest request,
 AsyncApiCallback<Guide> callback)

Update a guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchGuideAsync

public Future<ApiResponse<Guide>> patchGuideAsync(ApiRequest<UpdateGuide> request,
 AsyncApiCallback<ApiResponse<Guide>> callback)

Update a guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchGuideVersionAsync

public Future<GuideVersion> patchGuideVersionAsync(PatchGuideVersionRequest request,
 AsyncApiCallback<GuideVersion> callback)

Update a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

patchGuideVersionAsync

public Future<ApiResponse<GuideVersion>> patchGuideVersionAsync(ApiRequest<UpdateGuideVersion> request,
 AsyncApiCallback<ApiResponse<GuideVersion>> callback)

Update a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postConversationsSummariesPreviewAsync

public Future<Void> postConversationsSummariesPreviewAsync(PostConversationsSummariesPreviewRequest request,
 AsyncApiCallback<Void> callback)

Trigger summary preview event generation.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postConversationsSummariesPreviewAsync

public Future<ApiResponse<Void>> postConversationsSummariesPreviewAsync(ApiRequest<SummarySettingWithTranscript> request,
 AsyncApiCallback<ApiResponse<Void>> callback)

Trigger summary preview event generation.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postConversationsSummariesSettingsAsync

public Future<SummarySetting> postConversationsSummariesSettingsAsync(PostConversationsSummariesSettingsRequest request,
 AsyncApiCallback<SummarySetting> callback)

Create a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postConversationsSummariesSettingsAsync

public Future<ApiResponse<SummarySetting>> postConversationsSummariesSettingsAsync(ApiRequest<SummarySetting> request,
 AsyncApiCallback<ApiResponse<SummarySetting>> callback)

Create a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuideSessionTurnsAsync

public Future<GuideSessionTurnResponse> postGuideSessionTurnsAsync(PostGuideSessionTurnsRequest request,
 AsyncApiCallback<GuideSessionTurnResponse> callback)

Add a turn to a guide session. Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuideSessionTurnsAsync

public Future<ApiResponse<GuideSessionTurnResponse>> postGuideSessionTurnsAsync(ApiRequest<GuideSessionTurnRequest> request,
 AsyncApiCallback<ApiResponse<GuideSessionTurnResponse>> callback)

Add a turn to a guide session. Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuideVersionJobsAsync

public Future<GuideVersionPublishJob> postGuideVersionJobsAsync(PostGuideVersionJobsRequest request,
 AsyncApiCallback<GuideVersionPublishJob> callback)

Start the publishing of a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuideVersionJobsAsync

public Future<ApiResponse<GuideVersionPublishJob>> postGuideVersionJobsAsync(ApiRequest<GuideVersionPublishJobRequest> request,
 AsyncApiCallback<ApiResponse<GuideVersionPublishJob>> callback)

Start the publishing of a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuideVersionsAsync

public Future<GuideVersion> postGuideVersionsAsync(PostGuideVersionsRequest request,
 AsyncApiCallback<GuideVersion> callback)

Create a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuideVersionsAsync

public Future<ApiResponse<GuideVersion>> postGuideVersionsAsync(ApiRequest<CreateGuideVersion> request,
 AsyncApiCallback<ApiResponse<GuideVersion>> callback)

Create a guide version.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuidesAsync

public Future<Guide> postGuidesAsync(PostGuidesRequest request,
 AsyncApiCallback<Guide> callback)

Create a guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuidesAsync

public Future<ApiResponse<Guide>> postGuidesAsync(ApiRequest<CreateGuide> request,
 AsyncApiCallback<ApiResponse<Guide>> callback)

Create a guide.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuidesJobsAsync

public Future<GuideContentGenerationJob> postGuidesJobsAsync(PostGuidesJobsRequest request,
 AsyncApiCallback<GuideContentGenerationJob> callback)

Start a guide content generation job.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuidesJobsAsync

public Future<ApiResponse<GuideContentGenerationJob>> postGuidesJobsAsync(ApiRequest<GenerateGuideContentRequest> request,
 AsyncApiCallback<ApiResponse<GuideContentGenerationJob>> callback)

Start a guide content generation job.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuidesUploadsAsync

public Future<UploadUrlResponse> postGuidesUploadsAsync(PostGuidesUploadsRequest request,
 AsyncApiCallback<UploadUrlResponse> callback)

Generate presigned URL for uploading a file content to generate guide

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postGuidesUploadsAsync

public Future<ApiResponse<UploadUrlResponse>> postGuidesUploadsAsync(ApiRequest<UploadUrlRequest> request,
 AsyncApiCallback<ApiResponse<UploadUrlResponse>> callback)

Generate presigned URL for uploading a file content to generate guide

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putConversationsSummariesSettingAsync

public Future<SummarySetting> putConversationsSummariesSettingAsync(PutConversationsSummariesSettingRequest request,
 AsyncApiCallback<SummarySetting> callback)

Update a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

putConversationsSummariesSettingAsync

public Future<ApiResponse<SummarySetting>> putConversationsSummariesSettingAsync(ApiRequest<SummarySetting> request,
 AsyncApiCallback<ApiResponse<SummarySetting>> callback)

Update a summary setting.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed