AIServiceSpeech (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AIServiceSpeechClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220101")
public interface AIServiceSpeech
extends AutoCloseable
```
The OCI Speech Service harnesses the power of spoken language by allowing developers to easily convert file-based data containing human speech into highly accurate text transcriptions. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelTranscriptionJobResponse`	`cancelTranscriptionJob(CancelTranscriptionJobRequest request)` Canceling the job cancels all the tasks under it.
`CancelTranscriptionTaskResponse`	`cancelTranscriptionTask(CancelTranscriptionTaskRequest request)` Cancel Transcription Task
`ChangeCustomizationCompartmentResponse`	`changeCustomizationCompartment(ChangeCustomizationCompartmentRequest request)` Moves a Customization resource into a different compartment.
`ChangeTranscriptionJobCompartmentResponse`	`changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request)` Moves a transcription Job resource into a different compartment.
`CreateCustomizationResponse`	`createCustomization(CreateCustomizationRequest request)` Creates a new Customization.
`CreateRealtimeSessionTokenResponse`	`createRealtimeSessionToken(CreateRealtimeSessionTokenRequest request)` Returns an authentication token to the user.
`CreateTranscriptionJobResponse`	`createTranscriptionJob(CreateTranscriptionJobRequest request)` Creates a new Transcription Job.
`DeleteCustomizationResponse`	`deleteCustomization(DeleteCustomizationRequest request)` Delete Customization and its metadata from tenancy.
`DeleteTranscriptionJobResponse`	`deleteTranscriptionJob(DeleteTranscriptionJobRequest request)` Delete API cleans job, tasks and the related metadata.
`GetCustomizationResponse`	`getCustomization(GetCustomizationRequest request)` Gets a Customization by identifier
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`AIServiceSpeechPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetTranscriptionJobResponse`	`getTranscriptionJob(GetTranscriptionJobRequest request)` Gets a Transcription Job by identifier
`GetTranscriptionTaskResponse`	`getTranscriptionTask(GetTranscriptionTaskRequest request)` Gets a Transcription Task by identifier
`AIServiceSpeechWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListCustomizationsResponse`	`listCustomizations(ListCustomizationsRequest request)` Returns a list of Customizations.
`ListTranscriptionJobsResponse`	`listTranscriptionJobs(ListTranscriptionJobsRequest request)` Returns a list of Transcription Jobs.
`ListTranscriptionTasksResponse`	`listTranscriptionTasks(ListTranscriptionTasksRequest request)` Returns a list of Transcription Tasks.
`ListVoicesResponse`	`listVoices(ListVoicesRequest request)` Returns a list of speakers available to the user to choose from based on language code and voice type provided.
`void`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`SynthesizeSpeechResponse`	`synthesizeSpeech(SynthesizeSpeechRequest request)` Creates an audio for the given input text based on other input parameters like language, voice type, etc.
`UpdateCustomizationResponse`	`updateCustomization(UpdateCustomizationRequest request)` Updates a Customization by identifier
`UpdateTranscriptionJobResponse`	`updateTranscriptionJob(UpdateTranscriptionJobRequest request)` Updates the Transcription Job
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - cancelTranscriptionJob
```
CancelTranscriptionJobResponse cancelTranscriptionJob(CancelTranscriptionJobRequest request)
```
    Canceling the job cancels all the tasks under it.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CancelTranscriptionJob API.
  - cancelTranscriptionTask
```
CancelTranscriptionTaskResponse cancelTranscriptionTask(CancelTranscriptionTaskRequest request)
```
    Cancel Transcription Task
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CancelTranscriptionTask API.
  - changeCustomizationCompartment
```
ChangeCustomizationCompartmentResponse changeCustomizationCompartment(ChangeCustomizationCompartmentRequest request)
```
    Moves a Customization resource into a different compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeCustomizationCompartment API.
  - changeTranscriptionJobCompartment
```
ChangeTranscriptionJobCompartmentResponse changeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request)
```
    Moves a transcription Job resource into a different compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeTranscriptionJobCompartment API.
  - createCustomization
```
CreateCustomizationResponse createCustomization(CreateCustomizationRequest request)
```
    Creates a new Customization.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateCustomization API.
  - createRealtimeSessionToken
```
CreateRealtimeSessionTokenResponse createRealtimeSessionToken(CreateRealtimeSessionTokenRequest request)
```
    Returns an authentication token to the user.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateRealtimeSessionToken API.
  - createTranscriptionJob
```
CreateTranscriptionJobResponse createTranscriptionJob(CreateTranscriptionJobRequest request)
```
    Creates a new Transcription Job.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateTranscriptionJob API.
  - deleteCustomization
```
DeleteCustomizationResponse deleteCustomization(DeleteCustomizationRequest request)
```
    Delete Customization and its metadata from tenancy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteCustomization API.
  - deleteTranscriptionJob
```
DeleteTranscriptionJobResponse deleteTranscriptionJob(DeleteTranscriptionJobRequest request)
```
    Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteTranscriptionJob API.
  - getCustomization
```
GetCustomizationResponse getCustomization(GetCustomizationRequest request)
```
    Gets a Customization by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetCustomization API.
  - getTranscriptionJob
```
GetTranscriptionJobResponse getTranscriptionJob(GetTranscriptionJobRequest request)
```
    Gets a Transcription Job by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetTranscriptionJob API.
  - getTranscriptionTask
```
GetTranscriptionTaskResponse getTranscriptionTask(GetTranscriptionTaskRequest request)
```
    Gets a Transcription Task by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetTranscriptionTask API.
  - listCustomizations
```
ListCustomizationsResponse listCustomizations(ListCustomizationsRequest request)
```
    Returns a list of Customizations.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListCustomizations API.
  - listTranscriptionJobs
```
ListTranscriptionJobsResponse listTranscriptionJobs(ListTranscriptionJobsRequest request)
```
    Returns a list of Transcription Jobs.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListTranscriptionJobs API.
  - listTranscriptionTasks
```
ListTranscriptionTasksResponse listTranscriptionTasks(ListTranscriptionTasksRequest request)
```
    Returns a list of Transcription Tasks.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListTranscriptionTasks API.
  - listVoices
```
ListVoicesResponse listVoices(ListVoicesRequest request)
```
    Returns a list of speakers available to the user to choose from based on language code and voice type provided.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListVoices API.
  - synthesizeSpeech
```
SynthesizeSpeechResponse synthesizeSpeech(SynthesizeSpeechRequest request)
```
    Creates an audio for the given input text based on other input parameters like language, voice type, etc.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use SynthesizeSpeech API.
  - updateCustomization
```
UpdateCustomizationResponse updateCustomization(UpdateCustomizationRequest request)
```
    Updates a Customization by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateCustomization API.
  - updateTranscriptionJob
```
UpdateTranscriptionJobResponse updateTranscriptionJob(UpdateTranscriptionJobRequest request)
```
    Updates the Transcription Job
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateTranscriptionJob API.
  - getWaiters
```
AIServiceSpeechWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
AIServiceSpeechPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface AIServiceSpeech

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

cancelTranscriptionJob

cancelTranscriptionTask

changeCustomizationCompartment

changeTranscriptionJobCompartment

createCustomization

createRealtimeSessionToken

createTranscriptionJob

deleteCustomization

deleteTranscriptionJob

getCustomization

getTranscriptionJob

getTranscriptionTask

listCustomizations

listTranscriptionJobs

listTranscriptionTasks

listVoices

synthesizeSpeech

updateCustomization

updateTranscriptionJob

getWaiters

getPaginators