func GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumStringValues() []string
GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumStringValues Enumerates the set of values in String for CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum
func GetInputLocationLocationTypeEnumStringValues() []string
GetInputLocationLocationTypeEnumStringValues Enumerates the set of values in String for InputLocationLocationTypeEnum
func GetListTranscriptionJobsSortByEnumStringValues() []string
GetListTranscriptionJobsSortByEnumStringValues Enumerates the set of values in String for ListTranscriptionJobsSortByEnum
func GetListTranscriptionJobsSortOrderEnumStringValues() []string
GetListTranscriptionJobsSortOrderEnumStringValues Enumerates the set of values in String for ListTranscriptionJobsSortOrderEnum
func GetListTranscriptionTasksSortByEnumStringValues() []string
GetListTranscriptionTasksSortByEnumStringValues Enumerates the set of values in String for ListTranscriptionTasksSortByEnum
func GetListTranscriptionTasksSortOrderEnumStringValues() []string
GetListTranscriptionTasksSortOrderEnumStringValues Enumerates the set of values in String for ListTranscriptionTasksSortOrderEnum
func GetProfanityTranscriptionFilterModeEnumStringValues() []string
GetProfanityTranscriptionFilterModeEnumStringValues Enumerates the set of values in String for ProfanityTranscriptionFilterModeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetTranscriptionFilterTypeEnumStringValues() []string
GetTranscriptionFilterTypeEnumStringValues Enumerates the set of values in String for TranscriptionFilterTypeEnum
func GetTranscriptionJobAdditionalTranscriptionFormatsEnumStringValues() []string
GetTranscriptionJobAdditionalTranscriptionFormatsEnumStringValues Enumerates the set of values in String for TranscriptionJobAdditionalTranscriptionFormatsEnum
func GetTranscriptionJobLifecycleStateEnumStringValues() []string
GetTranscriptionJobLifecycleStateEnumStringValues Enumerates the set of values in String for TranscriptionJobLifecycleStateEnum
func GetTranscriptionModelDetailsDomainEnumStringValues() []string
GetTranscriptionModelDetailsDomainEnumStringValues Enumerates the set of values in String for TranscriptionModelDetailsDomainEnum
func GetTranscriptionModelDetailsLanguageCodeEnumStringValues() []string
GetTranscriptionModelDetailsLanguageCodeEnumStringValues Enumerates the set of values in String for TranscriptionModelDetailsLanguageCodeEnum
func GetTranscriptionTaskLifecycleStateEnumStringValues() []string
GetTranscriptionTaskLifecycleStateEnumStringValues Enumerates the set of values in String for TranscriptionTaskLifecycleStateEnum
AIServiceSpeechClient a client for AIServiceSpeech
type AIServiceSpeechClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewAIServiceSpeechClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AIServiceSpeechClient, err error)
NewAIServiceSpeechClientWithConfigurationProvider Creates a new default AIServiceSpeech client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewAIServiceSpeechClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AIServiceSpeechClient, err error)
NewAIServiceSpeechClientWithOboToken Creates a new default AIServiceSpeech client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client AIServiceSpeechClient) CancelTranscriptionJob(ctx context.Context, request CancelTranscriptionJobRequest) (response CancelTranscriptionJobResponse, err error)
CancelTranscriptionJob Canceling the job cancels all the tasks under it.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/CancelTranscriptionJob.go.html to see an example of how to use CancelTranscriptionJob API.
func (client AIServiceSpeechClient) CancelTranscriptionTask(ctx context.Context, request CancelTranscriptionTaskRequest) (response CancelTranscriptionTaskResponse, err error)
CancelTranscriptionTask Cancel Transcription Task
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/CancelTranscriptionTask.go.html to see an example of how to use CancelTranscriptionTask API.
func (client AIServiceSpeechClient) ChangeTranscriptionJobCompartment(ctx context.Context, request ChangeTranscriptionJobCompartmentRequest) (response ChangeTranscriptionJobCompartmentResponse, err error)
ChangeTranscriptionJobCompartment Moves a transcription Job resource into a different compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/ChangeTranscriptionJobCompartment.go.html to see an example of how to use ChangeTranscriptionJobCompartment API.
func (client *AIServiceSpeechClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client AIServiceSpeechClient) CreateTranscriptionJob(ctx context.Context, request CreateTranscriptionJobRequest) (response CreateTranscriptionJobResponse, err error)
CreateTranscriptionJob Creates a new Transcription Job.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/CreateTranscriptionJob.go.html to see an example of how to use CreateTranscriptionJob API.
func (client AIServiceSpeechClient) GetTranscriptionJob(ctx context.Context, request GetTranscriptionJobRequest) (response GetTranscriptionJobResponse, err error)
GetTranscriptionJob Gets a Transcription Job by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/GetTranscriptionJob.go.html to see an example of how to use GetTranscriptionJob API.
func (client AIServiceSpeechClient) GetTranscriptionTask(ctx context.Context, request GetTranscriptionTaskRequest) (response GetTranscriptionTaskResponse, err error)
GetTranscriptionTask Gets a Transcription Task by identifier
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/GetTranscriptionTask.go.html to see an example of how to use GetTranscriptionTask API.
func (client AIServiceSpeechClient) ListTranscriptionJobs(ctx context.Context, request ListTranscriptionJobsRequest) (response ListTranscriptionJobsResponse, err error)
ListTranscriptionJobs Returns a list of Transcription Jobs.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/ListTranscriptionJobs.go.html to see an example of how to use ListTranscriptionJobs API.
func (client AIServiceSpeechClient) ListTranscriptionTasks(ctx context.Context, request ListTranscriptionTasksRequest) (response ListTranscriptionTasksResponse, err error)
ListTranscriptionTasks Returns a list of Transcription Tasks.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/ListTranscriptionTasks.go.html to see an example of how to use ListTranscriptionTasks API.
func (client *AIServiceSpeechClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client AIServiceSpeechClient) UpdateTranscriptionJob(ctx context.Context, request UpdateTranscriptionJobRequest) (response UpdateTranscriptionJobResponse, err error)
UpdateTranscriptionJob Updates the Transcription Job
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/UpdateTranscriptionJob.go.html to see an example of how to use UpdateTranscriptionJob API.
AudioFormatDetails Audio format details.
type AudioFormatDetails struct {
// Input file format. Example - WAV.
Format *string `mandatory:"false" json:"format"`
// Input file number of channels.
NumberOfChannels *int `mandatory:"false" json:"numberOfChannels"`
// Input file encoding. Example - PCM.
Encoding *string `mandatory:"false" json:"encoding"`
// Input file sampleRate. Example - 16000
SampleRateInHz *int `mandatory:"false" json:"sampleRateInHz"`
}
func (m AudioFormatDetails) String() string
func (m AudioFormatDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelTranscriptionJobRequest wrapper for the CancelTranscriptionJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/CancelTranscriptionJob.go.html to see an example of how to use CancelTranscriptionJobRequest.
type CancelTranscriptionJobRequest struct {
// Unique Transcription Job identifier.
TranscriptionJobId *string `mandatory:"true" contributesTo:"path" name:"transcriptionJobId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelTranscriptionJobRequest) String() string
func (request CancelTranscriptionJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelTranscriptionJobResponse wrapper for the CancelTranscriptionJob operation
type CancelTranscriptionJobResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelTranscriptionJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelTranscriptionJobResponse) String() string
CancelTranscriptionTaskRequest wrapper for the CancelTranscriptionTask operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/CancelTranscriptionTask.go.html to see an example of how to use CancelTranscriptionTaskRequest.
type CancelTranscriptionTaskRequest struct {
// Unique Transcription Job identifier.
TranscriptionJobId *string `mandatory:"true" contributesTo:"path" name:"transcriptionJobId"`
// Unique Transcription Task identifier.
TranscriptionTaskId *string `mandatory:"true" contributesTo:"path" name:"transcriptionTaskId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelTranscriptionTaskRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelTranscriptionTaskRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelTranscriptionTaskRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelTranscriptionTaskRequest) String() string
func (request CancelTranscriptionTaskRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelTranscriptionTaskResponse wrapper for the CancelTranscriptionTask operation
type CancelTranscriptionTaskResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelTranscriptionTaskResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelTranscriptionTaskResponse) String() string
ChangeTranscriptionJobCompartmentDetails Details for changing the compartment of a transcription job.
type ChangeTranscriptionJobCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
// where the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeTranscriptionJobCompartmentDetails) String() string
func (m ChangeTranscriptionJobCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeTranscriptionJobCompartmentRequest wrapper for the ChangeTranscriptionJobCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/ChangeTranscriptionJobCompartment.go.html to see an example of how to use ChangeTranscriptionJobCompartmentRequest.
type ChangeTranscriptionJobCompartmentRequest struct {
// Unique Transcription Job identifier.
TranscriptionJobId *string `mandatory:"true" contributesTo:"path" name:"transcriptionJobId"`
// Details for changing the compartment of a transcription Job.
ChangeTranscriptionJobCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeTranscriptionJobCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeTranscriptionJobCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeTranscriptionJobCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeTranscriptionJobCompartmentRequest) String() string
func (request ChangeTranscriptionJobCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeTranscriptionJobCompartmentResponse wrapper for the ChangeTranscriptionJobCompartment operation
type ChangeTranscriptionJobCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeTranscriptionJobCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeTranscriptionJobCompartmentResponse) String() string
CreateTranscriptionJobDetails The information about new Transcription Job.
type CreateTranscriptionJobDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
InputLocation InputLocation `mandatory:"true" json:"inputLocation"`
OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`
// A user-friendly display name for the job.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the job.
Description *string `mandatory:"false" json:"description"`
// Transcription Format. By default, the JSON format is used.
AdditionalTranscriptionFormats []CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum `mandatory:"false" json:"additionalTranscriptionFormats,omitempty"`
ModelDetails *TranscriptionModelDetails `mandatory:"false" json:"modelDetails"`
Normalization *TranscriptionNormalization `mandatory:"false" json:"normalization"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`.
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace-1": {"bar-key-1": "value-1", "bar-key-2": "value-2"}, "foo-namespace-2": {"bar-key-1": "value-1", "bar-key-2": "value-2"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateTranscriptionJobDetails) String() string
func (m *CreateTranscriptionJobDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateTranscriptionJobDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum Enum with underlying type: string
type CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum string
Set of constants representing the allowable values for CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum
const (
CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsSrt CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum = "SRT"
)
func GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumValues() []CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum
GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumValues Enumerates the set of values for CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum
func GetMappingCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum(val string) (CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum, bool)
GetMappingCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum performs case Insensitive comparison on enum value and return the desired enum
CreateTranscriptionJobRequest wrapper for the CreateTranscriptionJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/CreateTranscriptionJob.go.html to see an example of how to use CreateTranscriptionJobRequest.
type CreateTranscriptionJobRequest struct {
// Details for the new Transcription Job.
CreateTranscriptionJobDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTranscriptionJobRequest) String() string
func (request CreateTranscriptionJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateTranscriptionJobResponse wrapper for the CreateTranscriptionJob operation
type CreateTranscriptionJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The TranscriptionJob instance
TranscriptionJob `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateTranscriptionJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTranscriptionJobResponse) String() string
Diarization Speaker diarization is a combination of speaker segmentation and speaker clustering. Provide diarization details to enable this feature.
type Diarization struct {
// Set true to enable Speaker diarization and tag transcription with speaker tags. By default this is disabled.
IsDiarizationEnabled *bool `mandatory:"false" json:"isDiarizationEnabled"`
// Number of speakers in the audio provided. By default service will auto detect all speakers in audio file
NumberOfSpeakers *int `mandatory:"false" json:"numberOfSpeakers"`
}
func (m Diarization) String() string
func (m Diarization) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTranscriptionJobRequest wrapper for the GetTranscriptionJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/GetTranscriptionJob.go.html to see an example of how to use GetTranscriptionJobRequest.
type GetTranscriptionJobRequest struct {
// Unique Transcription Job identifier.
TranscriptionJobId *string `mandatory:"true" contributesTo:"path" name:"transcriptionJobId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTranscriptionJobRequest) String() string
func (request GetTranscriptionJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTranscriptionJobResponse wrapper for the GetTranscriptionJob operation
type GetTranscriptionJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The TranscriptionJob instance
TranscriptionJob `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetTranscriptionJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTranscriptionJobResponse) String() string
GetTranscriptionTaskRequest wrapper for the GetTranscriptionTask operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/GetTranscriptionTask.go.html to see an example of how to use GetTranscriptionTaskRequest.
type GetTranscriptionTaskRequest struct {
// Unique Transcription Job identifier.
TranscriptionJobId *string `mandatory:"true" contributesTo:"path" name:"transcriptionJobId"`
// Unique Transcription Task identifier.
TranscriptionTaskId *string `mandatory:"true" contributesTo:"path" name:"transcriptionTaskId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetTranscriptionTaskRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTranscriptionTaskRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTranscriptionTaskRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTranscriptionTaskRequest) String() string
func (request GetTranscriptionTaskRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTranscriptionTaskResponse wrapper for the GetTranscriptionTask operation
type GetTranscriptionTaskResponse struct {
// The underlying http response
RawResponse *http.Response
// The TranscriptionTask instance
TranscriptionTask `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetTranscriptionTaskResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTranscriptionTaskResponse) String() string
InputLocation The location of the input(s).
type InputLocation interface {
}
InputLocationLocationTypeEnum Enum with underlying type: string
type InputLocationLocationTypeEnum string
Set of constants representing the allowable values for InputLocationLocationTypeEnum
const (
InputLocationLocationTypeInlineInputLocation InputLocationLocationTypeEnum = "OBJECT_LIST_INLINE_INPUT_LOCATION"
InputLocationLocationTypeFileInputLocation InputLocationLocationTypeEnum = "OBJECT_LIST_FILE_INPUT_LOCATION"
)
func GetInputLocationLocationTypeEnumValues() []InputLocationLocationTypeEnum
GetInputLocationLocationTypeEnumValues Enumerates the set of values for InputLocationLocationTypeEnum
func GetMappingInputLocationLocationTypeEnum(val string) (InputLocationLocationTypeEnum, bool)
GetMappingInputLocationLocationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranscriptionJobsRequest wrapper for the ListTranscriptionJobs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/ListTranscriptionJobs.go.html to see an example of how to use ListTranscriptionJobsRequest.
type ListTranscriptionJobsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources whose lifecycleState matches the given lifecycleState.
LifecycleState TranscriptionJobLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Unique identifier(OCID).
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListTranscriptionJobsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListTranscriptionJobsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListTranscriptionJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTranscriptionJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTranscriptionJobsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTranscriptionJobsRequest) String() string
func (request ListTranscriptionJobsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTranscriptionJobsResponse wrapper for the ListTranscriptionJobs operation
type ListTranscriptionJobsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TranscriptionJobCollection instances
TranscriptionJobCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListTranscriptionJobsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTranscriptionJobsResponse) String() string
ListTranscriptionJobsSortByEnum Enum with underlying type: string
type ListTranscriptionJobsSortByEnum string
Set of constants representing the allowable values for ListTranscriptionJobsSortByEnum
const (
ListTranscriptionJobsSortByTimecreated ListTranscriptionJobsSortByEnum = "timeCreated"
ListTranscriptionJobsSortByDisplayname ListTranscriptionJobsSortByEnum = "displayName"
)
func GetListTranscriptionJobsSortByEnumValues() []ListTranscriptionJobsSortByEnum
GetListTranscriptionJobsSortByEnumValues Enumerates the set of values for ListTranscriptionJobsSortByEnum
func GetMappingListTranscriptionJobsSortByEnum(val string) (ListTranscriptionJobsSortByEnum, bool)
GetMappingListTranscriptionJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranscriptionJobsSortOrderEnum Enum with underlying type: string
type ListTranscriptionJobsSortOrderEnum string
Set of constants representing the allowable values for ListTranscriptionJobsSortOrderEnum
const (
ListTranscriptionJobsSortOrderAsc ListTranscriptionJobsSortOrderEnum = "ASC"
ListTranscriptionJobsSortOrderDesc ListTranscriptionJobsSortOrderEnum = "DESC"
)
func GetListTranscriptionJobsSortOrderEnumValues() []ListTranscriptionJobsSortOrderEnum
GetListTranscriptionJobsSortOrderEnumValues Enumerates the set of values for ListTranscriptionJobsSortOrderEnum
func GetMappingListTranscriptionJobsSortOrderEnum(val string) (ListTranscriptionJobsSortOrderEnum, bool)
GetMappingListTranscriptionJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranscriptionTasksRequest wrapper for the ListTranscriptionTasks operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/ListTranscriptionTasks.go.html to see an example of how to use ListTranscriptionTasksRequest.
type ListTranscriptionTasksRequest struct {
// Unique Transcription Job identifier.
TranscriptionJobId *string `mandatory:"true" contributesTo:"path" name:"transcriptionJobId"`
// A filter to return only resources whose lifecycleState matches the given lifecycleState.
LifecycleState TranscriptionTaskLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Unique identifier(OCID).
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListTranscriptionTasksSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListTranscriptionTasksSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListTranscriptionTasksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTranscriptionTasksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTranscriptionTasksRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTranscriptionTasksRequest) String() string
func (request ListTranscriptionTasksRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTranscriptionTasksResponse wrapper for the ListTranscriptionTasks operation
type ListTranscriptionTasksResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TranscriptionTaskCollection instances
TranscriptionTaskCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListTranscriptionTasksResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTranscriptionTasksResponse) String() string
ListTranscriptionTasksSortByEnum Enum with underlying type: string
type ListTranscriptionTasksSortByEnum string
Set of constants representing the allowable values for ListTranscriptionTasksSortByEnum
const (
ListTranscriptionTasksSortByTimecreated ListTranscriptionTasksSortByEnum = "timeCreated"
ListTranscriptionTasksSortByDisplayname ListTranscriptionTasksSortByEnum = "displayName"
)
func GetListTranscriptionTasksSortByEnumValues() []ListTranscriptionTasksSortByEnum
GetListTranscriptionTasksSortByEnumValues Enumerates the set of values for ListTranscriptionTasksSortByEnum
func GetMappingListTranscriptionTasksSortByEnum(val string) (ListTranscriptionTasksSortByEnum, bool)
GetMappingListTranscriptionTasksSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranscriptionTasksSortOrderEnum Enum with underlying type: string
type ListTranscriptionTasksSortOrderEnum string
Set of constants representing the allowable values for ListTranscriptionTasksSortOrderEnum
const (
ListTranscriptionTasksSortOrderAsc ListTranscriptionTasksSortOrderEnum = "ASC"
ListTranscriptionTasksSortOrderDesc ListTranscriptionTasksSortOrderEnum = "DESC"
)
func GetListTranscriptionTasksSortOrderEnumValues() []ListTranscriptionTasksSortOrderEnum
GetListTranscriptionTasksSortOrderEnumValues Enumerates the set of values for ListTranscriptionTasksSortOrderEnum
func GetMappingListTranscriptionTasksSortOrderEnum(val string) (ListTranscriptionTasksSortOrderEnum, bool)
GetMappingListTranscriptionTasksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ObjectListFileInputLocation Use this locationType when passing the location of the object storage in the request (where the WAV file is stored).
type ObjectListFileInputLocation struct {
ObjectLocation *ObjectLocation `mandatory:"true" json:"objectLocation"`
}
func (m ObjectListFileInputLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectListFileInputLocation) String() string
func (m ObjectListFileInputLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectListInlineInputLocation Use this locationType when passing the WAV file name in the request.
type ObjectListInlineInputLocation struct {
// A list of ObjectLocations.
ObjectLocations []ObjectLocation `mandatory:"true" json:"objectLocations"`
}
func (m ObjectListInlineInputLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectListInlineInputLocation) String() string
func (m ObjectListInlineInputLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectLocation A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.
type ObjectLocation struct {
// Object Storage namespace name.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// Object Storage object names.
ObjectNames []string `mandatory:"true" json:"objectNames"`
}
func (m ObjectLocation) String() string
func (m ObjectLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OutputLocation OCI Object Storage Location.
type OutputLocation struct {
// Object Storage namespace.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// Object Storage folder name.
Prefix *string `mandatory:"true" json:"prefix"`
}
func (m OutputLocation) String() string
func (m OutputLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProfanityTranscriptionFilter Profanity transcription filter to recognize profane words.
type ProfanityTranscriptionFilter struct {
// - `MASK`: Will mask detected profanity in transcription.
// - `REMOVE`: Will replace profane word with * in transcription.
// - `TAG`: Will tag profane word as profanity but will show actual word.
Mode ProfanityTranscriptionFilterModeEnum `mandatory:"true" json:"mode"`
}
func (m ProfanityTranscriptionFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ProfanityTranscriptionFilter) String() string
func (m ProfanityTranscriptionFilter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProfanityTranscriptionFilterModeEnum Enum with underlying type: string
type ProfanityTranscriptionFilterModeEnum string
Set of constants representing the allowable values for ProfanityTranscriptionFilterModeEnum
const (
ProfanityTranscriptionFilterModeMask ProfanityTranscriptionFilterModeEnum = "MASK"
ProfanityTranscriptionFilterModeRemove ProfanityTranscriptionFilterModeEnum = "REMOVE"
ProfanityTranscriptionFilterModeTag ProfanityTranscriptionFilterModeEnum = "TAG"
)
func GetMappingProfanityTranscriptionFilterModeEnum(val string) (ProfanityTranscriptionFilterModeEnum, bool)
GetMappingProfanityTranscriptionFilterModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProfanityTranscriptionFilterModeEnumValues() []ProfanityTranscriptionFilterModeEnum
GetProfanityTranscriptionFilterModeEnumValues Enumerates the set of values for ProfanityTranscriptionFilterModeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
TranscriptionFilter Transcription Filter.
type TranscriptionFilter interface {
}
TranscriptionFilterTypeEnum Enum with underlying type: string
type TranscriptionFilterTypeEnum string
Set of constants representing the allowable values for TranscriptionFilterTypeEnum
const (
TranscriptionFilterTypeProfanity TranscriptionFilterTypeEnum = "PROFANITY"
)
func GetMappingTranscriptionFilterTypeEnum(val string) (TranscriptionFilterTypeEnum, bool)
GetMappingTranscriptionFilterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTranscriptionFilterTypeEnumValues() []TranscriptionFilterTypeEnum
GetTranscriptionFilterTypeEnumValues Enumerates the set of values for TranscriptionFilterTypeEnum
TranscriptionJob Description of Transcription Job.
type TranscriptionJob struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ModelDetails *TranscriptionModelDetails `mandatory:"true" json:"modelDetails"`
InputLocation InputLocation `mandatory:"true" json:"inputLocation"`
OutputLocation *OutputLocation `mandatory:"true" json:"outputLocation"`
// A user-friendly display name for the job.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the job.
Description *string `mandatory:"false" json:"description"`
Normalization *TranscriptionNormalization `mandatory:"false" json:"normalization"`
// Job accepted time.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// Job started time.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Job finished time.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// Total tasks in a job.
TotalTasks *int `mandatory:"false" json:"totalTasks"`
// Total outstanding tasks in a job.
OutstandingTasks *int `mandatory:"false" json:"outstandingTasks"`
// Total successful tasks in a job.
SuccessfulTasks *int `mandatory:"false" json:"successfulTasks"`
// Time to live duration in days for Job. Job will be available till max 90 days.
TtlInDays *int `mandatory:"false" json:"ttlInDays"`
// How much progress the operation has made, vs the total amount of work that must be performed.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Transcription format. JSON format will always be provided in addition to any formats in this list.
AdditionalTranscriptionFormats []TranscriptionJobAdditionalTranscriptionFormatsEnum `mandatory:"false" json:"additionalTranscriptionFormats,omitempty"`
// The current state of the Job.
LifecycleState TranscriptionJobLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`.
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace-1": {"bar-key-1": "value-1", "bar-key-2": "value-2"}, "foo-namespace-2": {"bar-key-1": "value-1", "bar-key-2": "value-2"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m TranscriptionJob) String() string
func (m *TranscriptionJob) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TranscriptionJob) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionJobAdditionalTranscriptionFormatsEnum Enum with underlying type: string
type TranscriptionJobAdditionalTranscriptionFormatsEnum string
Set of constants representing the allowable values for TranscriptionJobAdditionalTranscriptionFormatsEnum
const (
TranscriptionJobAdditionalTranscriptionFormatsSrt TranscriptionJobAdditionalTranscriptionFormatsEnum = "SRT"
)
func GetMappingTranscriptionJobAdditionalTranscriptionFormatsEnum(val string) (TranscriptionJobAdditionalTranscriptionFormatsEnum, bool)
GetMappingTranscriptionJobAdditionalTranscriptionFormatsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTranscriptionJobAdditionalTranscriptionFormatsEnumValues() []TranscriptionJobAdditionalTranscriptionFormatsEnum
GetTranscriptionJobAdditionalTranscriptionFormatsEnumValues Enumerates the set of values for TranscriptionJobAdditionalTranscriptionFormatsEnum
TranscriptionJobCollection Results of a Transcription Job search. Contains both TranscriptionJobSummary items and other information, such as metadata.
type TranscriptionJobCollection struct {
// List of transcription jobs.
Items []TranscriptionJobSummary `mandatory:"true" json:"items"`
}
func (m TranscriptionJobCollection) String() string
func (m TranscriptionJobCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionJobLifecycleStateEnum Enum with underlying type: string
type TranscriptionJobLifecycleStateEnum string
Set of constants representing the allowable values for TranscriptionJobLifecycleStateEnum
const (
TranscriptionJobLifecycleStateAccepted TranscriptionJobLifecycleStateEnum = "ACCEPTED"
TranscriptionJobLifecycleStateInProgress TranscriptionJobLifecycleStateEnum = "IN_PROGRESS"
TranscriptionJobLifecycleStateSucceeded TranscriptionJobLifecycleStateEnum = "SUCCEEDED"
TranscriptionJobLifecycleStateFailed TranscriptionJobLifecycleStateEnum = "FAILED"
TranscriptionJobLifecycleStateCanceling TranscriptionJobLifecycleStateEnum = "CANCELING"
TranscriptionJobLifecycleStateCanceled TranscriptionJobLifecycleStateEnum = "CANCELED"
)
func GetMappingTranscriptionJobLifecycleStateEnum(val string) (TranscriptionJobLifecycleStateEnum, bool)
GetMappingTranscriptionJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTranscriptionJobLifecycleStateEnumValues() []TranscriptionJobLifecycleStateEnum
GetTranscriptionJobLifecycleStateEnumValues Enumerates the set of values for TranscriptionJobLifecycleStateEnum
TranscriptionJobSummary Summary of the Transcription Job.
type TranscriptionJobSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the job.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// How much progress the operation has made, vs the total amount of work that must be performed.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
// Job accepted time.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// Job started time.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Job finished time.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// Total number of tasks in a job.
TotalTasks *int `mandatory:"false" json:"totalTasks"`
// Total outstanding tasks in a job.
OutstandingTasks *int `mandatory:"false" json:"outstandingTasks"`
// Total successful tasks in a job.
SuccessfulTasks *int `mandatory:"false" json:"successfulTasks"`
// The current state of the Speech Job.
LifecycleState TranscriptionJobLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`.
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace-1": {"bar-key-1": "value-1", "bar-key-2": "value-2"}, "foo-namespace-2": {"bar-key-1": "value-1", "bar-key-2": "value-2"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m TranscriptionJobSummary) String() string
func (m TranscriptionJobSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionModelDetails Model details.
type TranscriptionModelDetails struct {
// Domain for input files.
Domain TranscriptionModelDetailsDomainEnum `mandatory:"false" json:"domain,omitempty"`
// Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].
// - en-US: English - United States
// - es-ES: Spanish - Spain
// - pt-BR: Portuguese - Brazil
// - en-GB: English - Great Britain
// - en-AU: English - Australia
// - en-IN: English - India
// - hi-IN: Hindi - India
// - fr-FR: French - France
// - de-DE: German - Germany
// - it-IT: Italian - Italy
LanguageCode TranscriptionModelDetailsLanguageCodeEnum `mandatory:"false" json:"languageCode,omitempty"`
TranscriptionSettings *TranscriptionSettings `mandatory:"false" json:"transcriptionSettings"`
}
func (m TranscriptionModelDetails) String() string
func (m TranscriptionModelDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionModelDetailsDomainEnum Enum with underlying type: string
type TranscriptionModelDetailsDomainEnum string
Set of constants representing the allowable values for TranscriptionModelDetailsDomainEnum
const (
TranscriptionModelDetailsDomainGeneric TranscriptionModelDetailsDomainEnum = "GENERIC"
)
func GetMappingTranscriptionModelDetailsDomainEnum(val string) (TranscriptionModelDetailsDomainEnum, bool)
GetMappingTranscriptionModelDetailsDomainEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTranscriptionModelDetailsDomainEnumValues() []TranscriptionModelDetailsDomainEnum
GetTranscriptionModelDetailsDomainEnumValues Enumerates the set of values for TranscriptionModelDetailsDomainEnum
TranscriptionModelDetailsLanguageCodeEnum Enum with underlying type: string
type TranscriptionModelDetailsLanguageCodeEnum string
Set of constants representing the allowable values for TranscriptionModelDetailsLanguageCodeEnum
const (
TranscriptionModelDetailsLanguageCodeEnUs TranscriptionModelDetailsLanguageCodeEnum = "en-US"
TranscriptionModelDetailsLanguageCodeEsEs TranscriptionModelDetailsLanguageCodeEnum = "es-ES"
TranscriptionModelDetailsLanguageCodePtBr TranscriptionModelDetailsLanguageCodeEnum = "pt-BR"
TranscriptionModelDetailsLanguageCodeEnGb TranscriptionModelDetailsLanguageCodeEnum = "en-GB"
TranscriptionModelDetailsLanguageCodeEnAu TranscriptionModelDetailsLanguageCodeEnum = "en-AU"
TranscriptionModelDetailsLanguageCodeEnIn TranscriptionModelDetailsLanguageCodeEnum = "en-IN"
TranscriptionModelDetailsLanguageCodeHiIn TranscriptionModelDetailsLanguageCodeEnum = "hi-IN"
TranscriptionModelDetailsLanguageCodeFrFr TranscriptionModelDetailsLanguageCodeEnum = "fr-FR"
TranscriptionModelDetailsLanguageCodeDeDe TranscriptionModelDetailsLanguageCodeEnum = "de-DE"
TranscriptionModelDetailsLanguageCodeItIt TranscriptionModelDetailsLanguageCodeEnum = "it-IT"
)
func GetMappingTranscriptionModelDetailsLanguageCodeEnum(val string) (TranscriptionModelDetailsLanguageCodeEnum, bool)
GetMappingTranscriptionModelDetailsLanguageCodeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTranscriptionModelDetailsLanguageCodeEnumValues() []TranscriptionModelDetailsLanguageCodeEnum
GetTranscriptionModelDetailsLanguageCodeEnumValues Enumerates the set of values for TranscriptionModelDetailsLanguageCodeEnum
TranscriptionNormalization Information to Normalize generated transcript.
type TranscriptionNormalization struct {
// Whether to add punctuation in the generated transcription. Enabled by default.
IsPunctuationEnabled *bool `mandatory:"false" json:"isPunctuationEnabled"`
// List of filters.
Filters []TranscriptionFilter `mandatory:"false" json:"filters"`
}
func (m TranscriptionNormalization) String() string
func (m *TranscriptionNormalization) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TranscriptionNormalization) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionSettings Processes to perform on the generated transcription.
type TranscriptionSettings struct {
Diarization *Diarization `mandatory:"false" json:"diarization"`
}
func (m TranscriptionSettings) String() string
func (m TranscriptionSettings) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionTask Description of Transcription Task.
type TranscriptionTask struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the task.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the task.
DisplayName *string `mandatory:"false" json:"displayName"`
// Task started time.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Task finished time.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// How much progress the operation has made, vs the total amount of work that must be performed.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
// Time to live duration in days for tasks. Task will be available till max 90 days.
TtlInDays *int `mandatory:"false" json:"ttlInDays"`
ModelDetails *TranscriptionModelDetails `mandatory:"false" json:"modelDetails"`
AudioFormatDetails *AudioFormatDetails `mandatory:"false" json:"audioFormatDetails"`
// Size of input file in Bytes.
FileSizeInBytes *int `mandatory:"false" json:"fileSizeInBytes"`
// Duration of input file in Seconds.
FileDurationInSeconds *int `mandatory:"false" json:"fileDurationInSeconds"`
// Task proccessing duration, which excludes waiting time in the system.
ProcessingDurationInSeconds *int `mandatory:"false" json:"processingDurationInSeconds"`
InputLocation *ObjectLocation `mandatory:"false" json:"inputLocation"`
OutputLocation *ObjectLocation `mandatory:"false" json:"outputLocation"`
// The current state of the Task.
LifecycleState TranscriptionTaskLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m TranscriptionTask) String() string
func (m TranscriptionTask) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionTaskCollection Results of a Transcription Task search. Contains both TranscriptionTaskSummary items and other information, such as metadata.
type TranscriptionTaskCollection struct {
// List of Transcription Task.
Items []TranscriptionTaskSummary `mandatory:"true" json:"items"`
}
func (m TranscriptionTaskCollection) String() string
func (m TranscriptionTaskCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TranscriptionTaskLifecycleStateEnum Enum with underlying type: string
type TranscriptionTaskLifecycleStateEnum string
Set of constants representing the allowable values for TranscriptionTaskLifecycleStateEnum
const (
TranscriptionTaskLifecycleStateAccepted TranscriptionTaskLifecycleStateEnum = "ACCEPTED"
TranscriptionTaskLifecycleStateInProgress TranscriptionTaskLifecycleStateEnum = "IN_PROGRESS"
TranscriptionTaskLifecycleStateSucceeded TranscriptionTaskLifecycleStateEnum = "SUCCEEDED"
TranscriptionTaskLifecycleStateFailed TranscriptionTaskLifecycleStateEnum = "FAILED"
TranscriptionTaskLifecycleStateCanceled TranscriptionTaskLifecycleStateEnum = "CANCELED"
)
func GetMappingTranscriptionTaskLifecycleStateEnum(val string) (TranscriptionTaskLifecycleStateEnum, bool)
GetMappingTranscriptionTaskLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTranscriptionTaskLifecycleStateEnumValues() []TranscriptionTaskLifecycleStateEnum
GetTranscriptionTaskLifecycleStateEnumValues Enumerates the set of values for TranscriptionTaskLifecycleStateEnum
TranscriptionTaskSummary Summary of the Transcription Task.
type TranscriptionTaskSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the task.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the task.
DisplayName *string `mandatory:"true" json:"displayName"`
// How much progress the operation has made, vs the total amount of work that must be performed.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
// Size of input file in Bytes.
FileSizeInBytes *int `mandatory:"false" json:"fileSizeInBytes"`
// Duration of input file in Seconds.
FileDurationInSeconds *int `mandatory:"false" json:"fileDurationInSeconds"`
// Task proccessing duration, which excludes waiting time in the system.
ProcessingDurationInSeconds *int `mandatory:"false" json:"processingDurationInSeconds"`
// Task started time
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Job finished time
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The current state of the Speech Job.
LifecycleState TranscriptionTaskLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m TranscriptionTaskSummary) String() string
func (m TranscriptionTaskSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateTranscriptionJobDetails The information to be updated.
type UpdateTranscriptionJobDetails struct {
// A user-friendly display name for the job.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the job.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`.
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace-1": {"bar-key-1": "value-1", "bar-key-2": "value-2"}, "foo-namespace-2": {"bar-key-1": "value-1", "bar-key-2": "value-2"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateTranscriptionJobDetails) String() string
func (m UpdateTranscriptionJobDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateTranscriptionJobRequest wrapper for the UpdateTranscriptionJob operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/aispeech/UpdateTranscriptionJob.go.html to see an example of how to use UpdateTranscriptionJobRequest.
type UpdateTranscriptionJobRequest struct {
// Unique Transcription Job identifier.
TranscriptionJobId *string `mandatory:"true" contributesTo:"path" name:"transcriptionJobId"`
// The information to be updated.
UpdateTranscriptionJobDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTranscriptionJobRequest) String() string
func (request UpdateTranscriptionJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateTranscriptionJobResponse wrapper for the UpdateTranscriptionJob operation
type UpdateTranscriptionJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The TranscriptionJob instance
TranscriptionJob `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateTranscriptionJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTranscriptionJobResponse) String() string