Class AIServiceSpeechClient
Service client instance for AIServiceSpeech.
Implements
Inherited Members
Namespace: Oci.AispeechService
Assembly: OCI.DotNetSDK.Aispeech.dll
Syntax
public class AIServiceSpeechClient : RegionalClientBase, IDisposable
Constructors
AIServiceSpeechClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public AIServiceSpeechClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public AIServiceSpeechPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
AIServiceSpeechPaginators |
Waiters
Declaration
public AIServiceSpeechWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
AIServiceSpeechWaiters |
Methods
CancelTranscriptionJob(CancelTranscriptionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Canceling the job cancels all the tasks under it.
Declaration
public Task<CancelTranscriptionJobResponse> CancelTranscriptionJob(CancelTranscriptionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelTranscriptionJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CancelTranscriptionJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelTranscriptionJob API.
CancelTranscriptionTask(CancelTranscriptionTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancel Transcription Task
Declaration
public Task<CancelTranscriptionTaskResponse> CancelTranscriptionTask(CancelTranscriptionTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelTranscriptionTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CancelTranscriptionTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelTranscriptionTask API.
ChangeCustomizationCompartment(ChangeCustomizationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Customization resource into a different compartment.
Declaration
public Task<ChangeCustomizationCompartmentResponse> ChangeCustomizationCompartment(ChangeCustomizationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCustomizationCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCustomizationCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCustomizationCompartment API.
ChangeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a transcription Job resource into a different compartment.
Declaration
public Task<ChangeTranscriptionJobCompartmentResponse> ChangeTranscriptionJobCompartment(ChangeTranscriptionJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeTranscriptionJobCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeTranscriptionJobCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeTranscriptionJobCompartment API.
CreateCustomization(CreateCustomizationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Customization.
Declaration
public Task<CreateCustomizationResponse> CreateCustomization(CreateCustomizationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCustomizationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCustomizationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCustomization API.
CreateRealtimeSessionToken(CreateRealtimeSessionTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns an authentication token to the user.
Declaration
public Task<CreateRealtimeSessionTokenResponse> CreateRealtimeSessionToken(CreateRealtimeSessionTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRealtimeSessionTokenRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateRealtimeSessionTokenResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRealtimeSessionToken API.
CreateTranscriptionJob(CreateTranscriptionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Transcription Job.
Declaration
public Task<CreateTranscriptionJobResponse> CreateTranscriptionJob(CreateTranscriptionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTranscriptionJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTranscriptionJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTranscriptionJob API.
DeleteCustomization(DeleteCustomizationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete Customization and its metadata from tenancy.
Declaration
public Task<DeleteCustomizationResponse> DeleteCustomization(DeleteCustomizationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCustomizationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCustomizationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCustomization API.
DeleteTranscriptionJob(DeleteTranscriptionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted.
Declaration
public Task<DeleteTranscriptionJobResponse> DeleteTranscriptionJob(DeleteTranscriptionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTranscriptionJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTranscriptionJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTranscriptionJob API.
GetCustomization(GetCustomizationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a Customization by identifier
Declaration
public Task<GetCustomizationResponse> GetCustomization(GetCustomizationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCustomizationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCustomizationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCustomization API.
GetTranscriptionJob(GetTranscriptionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a Transcription Job by identifier
Declaration
public Task<GetTranscriptionJobResponse> GetTranscriptionJob(GetTranscriptionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTranscriptionJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTranscriptionJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTranscriptionJob API.
GetTranscriptionTask(GetTranscriptionTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a Transcription Task by identifier
Declaration
public Task<GetTranscriptionTaskResponse> GetTranscriptionTask(GetTranscriptionTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTranscriptionTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTranscriptionTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTranscriptionTask API.
ListCustomizations(ListCustomizationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Customizations.
Declaration
public Task<ListCustomizationsResponse> ListCustomizations(ListCustomizationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCustomizationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCustomizationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCustomizations API.
ListTranscriptionJobs(ListTranscriptionJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Transcription Jobs.
Declaration
public Task<ListTranscriptionJobsResponse> ListTranscriptionJobs(ListTranscriptionJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTranscriptionJobsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTranscriptionJobsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTranscriptionJobs API.
ListTranscriptionTasks(ListTranscriptionTasksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Transcription Tasks.
Declaration
public Task<ListTranscriptionTasksResponse> ListTranscriptionTasks(ListTranscriptionTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTranscriptionTasksRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTranscriptionTasksResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTranscriptionTasks API.
UpdateCustomization(UpdateCustomizationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a Customization by identifier
Declaration
public Task<UpdateCustomizationResponse> UpdateCustomization(UpdateCustomizationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCustomizationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCustomizationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCustomization API.
UpdateTranscriptionJob(UpdateTranscriptionJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Transcription Job
Declaration
public Task<UpdateTranscriptionJobResponse> UpdateTranscriptionJob(UpdateTranscriptionJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTranscriptionJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTranscriptionJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTranscriptionJob API.