aispeech

package
v65.63.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumStringValues added in v65.3.0

func GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumStringValues() []string

GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumStringValues Enumerates the set of values in String for CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum

func GetInputLocationLocationTypeEnumStringValues

func GetInputLocationLocationTypeEnumStringValues() []string

GetInputLocationLocationTypeEnumStringValues Enumerates the set of values in String for InputLocationLocationTypeEnum

func GetListTranscriptionJobsSortByEnumStringValues

func GetListTranscriptionJobsSortByEnumStringValues() []string

GetListTranscriptionJobsSortByEnumStringValues Enumerates the set of values in String for ListTranscriptionJobsSortByEnum

func GetListTranscriptionJobsSortOrderEnumStringValues

func GetListTranscriptionJobsSortOrderEnumStringValues() []string

GetListTranscriptionJobsSortOrderEnumStringValues Enumerates the set of values in String for ListTranscriptionJobsSortOrderEnum

func GetListTranscriptionTasksSortByEnumStringValues

func GetListTranscriptionTasksSortByEnumStringValues() []string

GetListTranscriptionTasksSortByEnumStringValues Enumerates the set of values in String for ListTranscriptionTasksSortByEnum

func GetListTranscriptionTasksSortOrderEnumStringValues

func GetListTranscriptionTasksSortOrderEnumStringValues() []string

GetListTranscriptionTasksSortOrderEnumStringValues Enumerates the set of values in String for ListTranscriptionTasksSortOrderEnum

func GetProfanityTranscriptionFilterModeEnumStringValues

func GetProfanityTranscriptionFilterModeEnumStringValues() []string

GetProfanityTranscriptionFilterModeEnumStringValues Enumerates the set of values in String for ProfanityTranscriptionFilterModeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetTranscriptionFilterTypeEnumStringValues

func GetTranscriptionFilterTypeEnumStringValues() []string

GetTranscriptionFilterTypeEnumStringValues Enumerates the set of values in String for TranscriptionFilterTypeEnum

func GetTranscriptionJobAdditionalTranscriptionFormatsEnumStringValues added in v65.3.0

func GetTranscriptionJobAdditionalTranscriptionFormatsEnumStringValues() []string

GetTranscriptionJobAdditionalTranscriptionFormatsEnumStringValues Enumerates the set of values in String for TranscriptionJobAdditionalTranscriptionFormatsEnum

func GetTranscriptionJobLifecycleStateEnumStringValues

func GetTranscriptionJobLifecycleStateEnumStringValues() []string

GetTranscriptionJobLifecycleStateEnumStringValues Enumerates the set of values in String for TranscriptionJobLifecycleStateEnum

func GetTranscriptionModelDetailsDomainEnumStringValues

func GetTranscriptionModelDetailsDomainEnumStringValues() []string

GetTranscriptionModelDetailsDomainEnumStringValues Enumerates the set of values in String for TranscriptionModelDetailsDomainEnum

func GetTranscriptionModelDetailsLanguageCodeEnumStringValues

func GetTranscriptionModelDetailsLanguageCodeEnumStringValues() []string

GetTranscriptionModelDetailsLanguageCodeEnumStringValues Enumerates the set of values in String for TranscriptionModelDetailsLanguageCodeEnum

func GetTranscriptionTaskLifecycleStateEnumStringValues

func GetTranscriptionTaskLifecycleStateEnumStringValues() []string

GetTranscriptionTaskLifecycleStateEnumStringValues Enumerates the set of values in String for TranscriptionTaskLifecycleStateEnum

Types

type AIServiceSpeechClient

type AIServiceSpeechClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

AIServiceSpeechClient a client for AIServiceSpeech

func NewAIServiceSpeechClientWithConfigurationProvider

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

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 (AIServiceSpeechClient) CancelTranscriptionJob

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/latest/aispeech/CancelTranscriptionJob.go.html to see an example of how to use CancelTranscriptionJob API.

func (AIServiceSpeechClient) CancelTranscriptionTask

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/latest/aispeech/CancelTranscriptionTask.go.html to see an example of how to use CancelTranscriptionTask API.

func (AIServiceSpeechClient) ChangeTranscriptionJobCompartment

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/latest/aispeech/ChangeTranscriptionJobCompartment.go.html to see an example of how to use ChangeTranscriptionJobCompartment API.

func (*AIServiceSpeechClient) ConfigurationProvider

func (client *AIServiceSpeechClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (AIServiceSpeechClient) CreateTranscriptionJob

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/latest/aispeech/CreateTranscriptionJob.go.html to see an example of how to use CreateTranscriptionJob API.

func (AIServiceSpeechClient) DeleteTranscriptionJob added in v65.61.0

func (client AIServiceSpeechClient) DeleteTranscriptionJob(ctx context.Context, request DeleteTranscriptionJobRequest) (response DeleteTranscriptionJobResponse, err error)

DeleteTranscriptionJob Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/DeleteTranscriptionJob.go.html to see an example of how to use DeleteTranscriptionJob API.

func (AIServiceSpeechClient) GetTranscriptionJob

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/latest/aispeech/GetTranscriptionJob.go.html to see an example of how to use GetTranscriptionJob API.

func (AIServiceSpeechClient) GetTranscriptionTask

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/latest/aispeech/GetTranscriptionTask.go.html to see an example of how to use GetTranscriptionTask API.

func (AIServiceSpeechClient) ListTranscriptionJobs

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/latest/aispeech/ListTranscriptionJobs.go.html to see an example of how to use ListTranscriptionJobs API.

func (AIServiceSpeechClient) ListTranscriptionTasks

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/latest/aispeech/ListTranscriptionTasks.go.html to see an example of how to use ListTranscriptionTasks API.

func (*AIServiceSpeechClient) SetRegion

func (client *AIServiceSpeechClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AIServiceSpeechClient) UpdateTranscriptionJob

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/latest/aispeech/UpdateTranscriptionJob.go.html to see an example of how to use UpdateTranscriptionJob API.

type AudioFormatDetails

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"`
}

AudioFormatDetails Audio format details.

func (AudioFormatDetails) String

func (m AudioFormatDetails) String() string

func (AudioFormatDetails) ValidateEnumValue

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

type 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
}

CancelTranscriptionJobRequest wrapper for the CancelTranscriptionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/CancelTranscriptionJob.go.html to see an example of how to use CancelTranscriptionJobRequest.

func (CancelTranscriptionJobRequest) BinaryRequestBody

func (request CancelTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelTranscriptionJobRequest) HTTPRequest

func (request CancelTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelTranscriptionJobRequest) RetryPolicy

func (request CancelTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelTranscriptionJobRequest) String

func (request CancelTranscriptionJobRequest) String() string

func (CancelTranscriptionJobRequest) ValidateEnumValue

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

type CancelTranscriptionJobResponse

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"`
}

CancelTranscriptionJobResponse wrapper for the CancelTranscriptionJob operation

func (CancelTranscriptionJobResponse) HTTPResponse

func (response CancelTranscriptionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelTranscriptionJobResponse) String

func (response CancelTranscriptionJobResponse) String() string

type 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
}

CancelTranscriptionTaskRequest wrapper for the CancelTranscriptionTask operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/CancelTranscriptionTask.go.html to see an example of how to use CancelTranscriptionTaskRequest.

func (CancelTranscriptionTaskRequest) BinaryRequestBody

func (request CancelTranscriptionTaskRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelTranscriptionTaskRequest) HTTPRequest

func (request CancelTranscriptionTaskRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelTranscriptionTaskRequest) RetryPolicy

func (request CancelTranscriptionTaskRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelTranscriptionTaskRequest) String

func (request CancelTranscriptionTaskRequest) String() string

func (CancelTranscriptionTaskRequest) ValidateEnumValue

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

type CancelTranscriptionTaskResponse

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"`
}

CancelTranscriptionTaskResponse wrapper for the CancelTranscriptionTask operation

func (CancelTranscriptionTaskResponse) HTTPResponse

func (response CancelTranscriptionTaskResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelTranscriptionTaskResponse) String

func (response CancelTranscriptionTaskResponse) String() string

type ChangeTranscriptionJobCompartmentDetails

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"`
}

ChangeTranscriptionJobCompartmentDetails Details for changing the compartment of a transcription job.

func (ChangeTranscriptionJobCompartmentDetails) String

func (ChangeTranscriptionJobCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangeTranscriptionJobCompartmentRequest wrapper for the ChangeTranscriptionJobCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/ChangeTranscriptionJobCompartment.go.html to see an example of how to use ChangeTranscriptionJobCompartmentRequest.

func (ChangeTranscriptionJobCompartmentRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangeTranscriptionJobCompartmentRequest) HTTPRequest

func (request ChangeTranscriptionJobCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeTranscriptionJobCompartmentRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeTranscriptionJobCompartmentRequest) String

func (ChangeTranscriptionJobCompartmentRequest) ValidateEnumValue

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

type ChangeTranscriptionJobCompartmentResponse

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"`
}

ChangeTranscriptionJobCompartmentResponse wrapper for the ChangeTranscriptionJobCompartment operation

func (ChangeTranscriptionJobCompartmentResponse) HTTPResponse

func (response ChangeTranscriptionJobCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeTranscriptionJobCompartmentResponse) String

type CreateTranscriptionJobDetails

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"`
}

CreateTranscriptionJobDetails The information about new Transcription Job.

func (CreateTranscriptionJobDetails) String

func (*CreateTranscriptionJobDetails) UnmarshalJSON

func (m *CreateTranscriptionJobDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateTranscriptionJobDetails) ValidateEnumValue

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

type CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum added in v65.3.0

type CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum string

CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum Enum with underlying type: string

const (
	CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsSrt CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum = "SRT"
)

Set of constants representing the allowable values for CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum

func GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumValues added in v65.3.0

func GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumValues() []CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum

GetCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnumValues Enumerates the set of values for CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum

func GetMappingCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum added in v65.3.0

func GetMappingCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum(val string) (CreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum, bool)

GetMappingCreateTranscriptionJobDetailsAdditionalTranscriptionFormatsEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

CreateTranscriptionJobRequest wrapper for the CreateTranscriptionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/CreateTranscriptionJob.go.html to see an example of how to use CreateTranscriptionJobRequest.

func (CreateTranscriptionJobRequest) BinaryRequestBody

func (request CreateTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateTranscriptionJobRequest) HTTPRequest

func (request CreateTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTranscriptionJobRequest) RetryPolicy

func (request CreateTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateTranscriptionJobRequest) String

func (request CreateTranscriptionJobRequest) String() string

func (CreateTranscriptionJobRequest) ValidateEnumValue

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

type CreateTranscriptionJobResponse

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"`
}

CreateTranscriptionJobResponse wrapper for the CreateTranscriptionJob operation

func (CreateTranscriptionJobResponse) HTTPResponse

func (response CreateTranscriptionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateTranscriptionJobResponse) String

func (response CreateTranscriptionJobResponse) String() string

type DeleteTranscriptionJobRequest added in v65.61.0

type DeleteTranscriptionJobRequest 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
}

DeleteTranscriptionJobRequest wrapper for the DeleteTranscriptionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/DeleteTranscriptionJob.go.html to see an example of how to use DeleteTranscriptionJobRequest.

func (DeleteTranscriptionJobRequest) BinaryRequestBody added in v65.61.0

func (request DeleteTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteTranscriptionJobRequest) HTTPRequest added in v65.61.0

func (request DeleteTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTranscriptionJobRequest) RetryPolicy added in v65.61.0

func (request DeleteTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteTranscriptionJobRequest) String added in v65.61.0

func (request DeleteTranscriptionJobRequest) String() string

func (DeleteTranscriptionJobRequest) ValidateEnumValue added in v65.61.0

func (request DeleteTranscriptionJobRequest) 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

type DeleteTranscriptionJobResponse added in v65.61.0

type DeleteTranscriptionJobResponse 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"`
}

DeleteTranscriptionJobResponse wrapper for the DeleteTranscriptionJob operation

func (DeleteTranscriptionJobResponse) HTTPResponse added in v65.61.0

func (response DeleteTranscriptionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteTranscriptionJobResponse) String added in v65.61.0

func (response DeleteTranscriptionJobResponse) String() string

type Diarization added in v65.53.0

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"`
}

Diarization Speaker diarization is a combination of speaker segmentation and speaker clustering. Provide diarization details to enable this feature.

func (Diarization) String added in v65.53.0

func (m Diarization) String() string

func (Diarization) ValidateEnumValue added in v65.53.0

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

type 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
}

GetTranscriptionJobRequest wrapper for the GetTranscriptionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/GetTranscriptionJob.go.html to see an example of how to use GetTranscriptionJobRequest.

func (GetTranscriptionJobRequest) BinaryRequestBody

func (request GetTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTranscriptionJobRequest) HTTPRequest

func (request GetTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTranscriptionJobRequest) RetryPolicy

func (request GetTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTranscriptionJobRequest) String

func (request GetTranscriptionJobRequest) String() string

func (GetTranscriptionJobRequest) ValidateEnumValue

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

type GetTranscriptionJobResponse

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"`
}

GetTranscriptionJobResponse wrapper for the GetTranscriptionJob operation

func (GetTranscriptionJobResponse) HTTPResponse

func (response GetTranscriptionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTranscriptionJobResponse) String

func (response GetTranscriptionJobResponse) String() string

type 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
}

GetTranscriptionTaskRequest wrapper for the GetTranscriptionTask operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/GetTranscriptionTask.go.html to see an example of how to use GetTranscriptionTaskRequest.

func (GetTranscriptionTaskRequest) BinaryRequestBody

func (request GetTranscriptionTaskRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTranscriptionTaskRequest) HTTPRequest

func (request GetTranscriptionTaskRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTranscriptionTaskRequest) RetryPolicy

func (request GetTranscriptionTaskRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTranscriptionTaskRequest) String

func (request GetTranscriptionTaskRequest) String() string

func (GetTranscriptionTaskRequest) ValidateEnumValue

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

type GetTranscriptionTaskResponse

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"`
}

GetTranscriptionTaskResponse wrapper for the GetTranscriptionTask operation

func (GetTranscriptionTaskResponse) HTTPResponse

func (response GetTranscriptionTaskResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTranscriptionTaskResponse) String

func (response GetTranscriptionTaskResponse) String() string

type InputLocation

type InputLocation interface {
}

InputLocation The location of the input(s).

type InputLocationLocationTypeEnum

type InputLocationLocationTypeEnum string

InputLocationLocationTypeEnum Enum with underlying type: string

const (
	InputLocationLocationTypeInlineInputLocation InputLocationLocationTypeEnum = "OBJECT_LIST_INLINE_INPUT_LOCATION"
	InputLocationLocationTypeFileInputLocation   InputLocationLocationTypeEnum = "OBJECT_LIST_FILE_INPUT_LOCATION"
)

Set of constants representing the allowable values for InputLocationLocationTypeEnum

func GetInputLocationLocationTypeEnumValues

func GetInputLocationLocationTypeEnumValues() []InputLocationLocationTypeEnum

GetInputLocationLocationTypeEnumValues Enumerates the set of values for InputLocationLocationTypeEnum

func GetMappingInputLocationLocationTypeEnum

func GetMappingInputLocationLocationTypeEnum(val string) (InputLocationLocationTypeEnum, bool)

GetMappingInputLocationLocationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListTranscriptionJobsRequest wrapper for the ListTranscriptionJobs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/ListTranscriptionJobs.go.html to see an example of how to use ListTranscriptionJobsRequest.

func (ListTranscriptionJobsRequest) BinaryRequestBody

func (request ListTranscriptionJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTranscriptionJobsRequest) HTTPRequest

func (request ListTranscriptionJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTranscriptionJobsRequest) RetryPolicy

func (request ListTranscriptionJobsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTranscriptionJobsRequest) String

func (request ListTranscriptionJobsRequest) String() string

func (ListTranscriptionJobsRequest) ValidateEnumValue

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

type ListTranscriptionJobsResponse

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"`
}

ListTranscriptionJobsResponse wrapper for the ListTranscriptionJobs operation

func (ListTranscriptionJobsResponse) HTTPResponse

func (response ListTranscriptionJobsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTranscriptionJobsResponse) String

func (response ListTranscriptionJobsResponse) String() string

type ListTranscriptionJobsSortByEnum

type ListTranscriptionJobsSortByEnum string

ListTranscriptionJobsSortByEnum Enum with underlying type: string

const (
	ListTranscriptionJobsSortByTimecreated ListTranscriptionJobsSortByEnum = "timeCreated"
	ListTranscriptionJobsSortByDisplayname ListTranscriptionJobsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListTranscriptionJobsSortByEnum

func GetListTranscriptionJobsSortByEnumValues

func GetListTranscriptionJobsSortByEnumValues() []ListTranscriptionJobsSortByEnum

GetListTranscriptionJobsSortByEnumValues Enumerates the set of values for ListTranscriptionJobsSortByEnum

func GetMappingListTranscriptionJobsSortByEnum

func GetMappingListTranscriptionJobsSortByEnum(val string) (ListTranscriptionJobsSortByEnum, bool)

GetMappingListTranscriptionJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListTranscriptionJobsSortOrderEnum

type ListTranscriptionJobsSortOrderEnum string

ListTranscriptionJobsSortOrderEnum Enum with underlying type: string

const (
	ListTranscriptionJobsSortOrderAsc  ListTranscriptionJobsSortOrderEnum = "ASC"
	ListTranscriptionJobsSortOrderDesc ListTranscriptionJobsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListTranscriptionJobsSortOrderEnum

func GetListTranscriptionJobsSortOrderEnumValues

func GetListTranscriptionJobsSortOrderEnumValues() []ListTranscriptionJobsSortOrderEnum

GetListTranscriptionJobsSortOrderEnumValues Enumerates the set of values for ListTranscriptionJobsSortOrderEnum

func GetMappingListTranscriptionJobsSortOrderEnum

func GetMappingListTranscriptionJobsSortOrderEnum(val string) (ListTranscriptionJobsSortOrderEnum, bool)

GetMappingListTranscriptionJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListTranscriptionTasksRequest wrapper for the ListTranscriptionTasks operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/ListTranscriptionTasks.go.html to see an example of how to use ListTranscriptionTasksRequest.

func (ListTranscriptionTasksRequest) BinaryRequestBody

func (request ListTranscriptionTasksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTranscriptionTasksRequest) HTTPRequest

func (request ListTranscriptionTasksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTranscriptionTasksRequest) RetryPolicy

func (request ListTranscriptionTasksRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTranscriptionTasksRequest) String

func (request ListTranscriptionTasksRequest) String() string

func (ListTranscriptionTasksRequest) ValidateEnumValue

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

type ListTranscriptionTasksResponse

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"`
}

ListTranscriptionTasksResponse wrapper for the ListTranscriptionTasks operation

func (ListTranscriptionTasksResponse) HTTPResponse

func (response ListTranscriptionTasksResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTranscriptionTasksResponse) String

func (response ListTranscriptionTasksResponse) String() string

type ListTranscriptionTasksSortByEnum

type ListTranscriptionTasksSortByEnum string

ListTranscriptionTasksSortByEnum Enum with underlying type: string

const (
	ListTranscriptionTasksSortByTimecreated ListTranscriptionTasksSortByEnum = "timeCreated"
	ListTranscriptionTasksSortByDisplayname ListTranscriptionTasksSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListTranscriptionTasksSortByEnum

func GetListTranscriptionTasksSortByEnumValues

func GetListTranscriptionTasksSortByEnumValues() []ListTranscriptionTasksSortByEnum

GetListTranscriptionTasksSortByEnumValues Enumerates the set of values for ListTranscriptionTasksSortByEnum

func GetMappingListTranscriptionTasksSortByEnum

func GetMappingListTranscriptionTasksSortByEnum(val string) (ListTranscriptionTasksSortByEnum, bool)

GetMappingListTranscriptionTasksSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListTranscriptionTasksSortOrderEnum

type ListTranscriptionTasksSortOrderEnum string

ListTranscriptionTasksSortOrderEnum Enum with underlying type: string

const (
	ListTranscriptionTasksSortOrderAsc  ListTranscriptionTasksSortOrderEnum = "ASC"
	ListTranscriptionTasksSortOrderDesc ListTranscriptionTasksSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListTranscriptionTasksSortOrderEnum

func GetListTranscriptionTasksSortOrderEnumValues

func GetListTranscriptionTasksSortOrderEnumValues() []ListTranscriptionTasksSortOrderEnum

GetListTranscriptionTasksSortOrderEnumValues Enumerates the set of values for ListTranscriptionTasksSortOrderEnum

func GetMappingListTranscriptionTasksSortOrderEnum

func GetMappingListTranscriptionTasksSortOrderEnum(val string) (ListTranscriptionTasksSortOrderEnum, bool)

GetMappingListTranscriptionTasksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ObjectListFileInputLocation

type ObjectListFileInputLocation struct {
	ObjectLocation *ObjectLocation `mandatory:"true" json:"objectLocation"`
}

ObjectListFileInputLocation Use this locationType when passing the location of the object storage in the request (where the WAV file is stored).

func (ObjectListFileInputLocation) MarshalJSON

func (m ObjectListFileInputLocation) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ObjectListFileInputLocation) String

func (ObjectListFileInputLocation) ValidateEnumValue

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

type ObjectListInlineInputLocation

type ObjectListInlineInputLocation struct {

	// A list of ObjectLocations.
	ObjectLocations []ObjectLocation `mandatory:"true" json:"objectLocations"`
}

ObjectListInlineInputLocation Use this locationType when passing the WAV file name in the request.

func (ObjectListInlineInputLocation) MarshalJSON

func (m ObjectListInlineInputLocation) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ObjectListInlineInputLocation) String

func (ObjectListInlineInputLocation) ValidateEnumValue

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

type ObjectLocation

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"`
}

ObjectLocation A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.

func (ObjectLocation) String

func (m ObjectLocation) String() string

func (ObjectLocation) ValidateEnumValue

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

type OutputLocation

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"`
}

OutputLocation OCI Object Storage Location.

func (OutputLocation) String

func (m OutputLocation) String() string

func (OutputLocation) ValidateEnumValue

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

type ProfanityTranscriptionFilter

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"`
}

ProfanityTranscriptionFilter Profanity transcription filter to recognize profane words.

func (ProfanityTranscriptionFilter) MarshalJSON

func (m ProfanityTranscriptionFilter) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ProfanityTranscriptionFilter) String

func (ProfanityTranscriptionFilter) ValidateEnumValue

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

type ProfanityTranscriptionFilterModeEnum

type ProfanityTranscriptionFilterModeEnum string

ProfanityTranscriptionFilterModeEnum Enum with underlying type: string

const (
	ProfanityTranscriptionFilterModeMask   ProfanityTranscriptionFilterModeEnum = "MASK"
	ProfanityTranscriptionFilterModeRemove ProfanityTranscriptionFilterModeEnum = "REMOVE"
	ProfanityTranscriptionFilterModeTag    ProfanityTranscriptionFilterModeEnum = "TAG"
)

Set of constants representing the allowable values for ProfanityTranscriptionFilterModeEnum

func GetMappingProfanityTranscriptionFilterModeEnum

func GetMappingProfanityTranscriptionFilterModeEnum(val string) (ProfanityTranscriptionFilterModeEnum, bool)

GetMappingProfanityTranscriptionFilterModeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetProfanityTranscriptionFilterModeEnumValues

func GetProfanityTranscriptionFilterModeEnumValues() []ProfanityTranscriptionFilterModeEnum

GetProfanityTranscriptionFilterModeEnumValues Enumerates the set of values for ProfanityTranscriptionFilterModeEnum

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type TranscriptionFilter

type TranscriptionFilter interface {
}

TranscriptionFilter Transcription Filter.

type TranscriptionFilterTypeEnum

type TranscriptionFilterTypeEnum string

TranscriptionFilterTypeEnum Enum with underlying type: string

const (
	TranscriptionFilterTypeProfanity TranscriptionFilterTypeEnum = "PROFANITY"
)

Set of constants representing the allowable values for TranscriptionFilterTypeEnum

func GetMappingTranscriptionFilterTypeEnum

func GetMappingTranscriptionFilterTypeEnum(val string) (TranscriptionFilterTypeEnum, bool)

GetMappingTranscriptionFilterTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTranscriptionFilterTypeEnumValues

func GetTranscriptionFilterTypeEnumValues() []TranscriptionFilterTypeEnum

GetTranscriptionFilterTypeEnumValues Enumerates the set of values for TranscriptionFilterTypeEnum

type TranscriptionJob

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"`
}

TranscriptionJob Description of Transcription Job.

func (TranscriptionJob) String

func (m TranscriptionJob) String() string

func (*TranscriptionJob) UnmarshalJSON

func (m *TranscriptionJob) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (TranscriptionJob) ValidateEnumValue

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

type TranscriptionJobAdditionalTranscriptionFormatsEnum added in v65.3.0

type TranscriptionJobAdditionalTranscriptionFormatsEnum string

TranscriptionJobAdditionalTranscriptionFormatsEnum Enum with underlying type: string

const (
	TranscriptionJobAdditionalTranscriptionFormatsSrt TranscriptionJobAdditionalTranscriptionFormatsEnum = "SRT"
)

Set of constants representing the allowable values for TranscriptionJobAdditionalTranscriptionFormatsEnum

func GetMappingTranscriptionJobAdditionalTranscriptionFormatsEnum added in v65.3.0

func GetMappingTranscriptionJobAdditionalTranscriptionFormatsEnum(val string) (TranscriptionJobAdditionalTranscriptionFormatsEnum, bool)

GetMappingTranscriptionJobAdditionalTranscriptionFormatsEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTranscriptionJobAdditionalTranscriptionFormatsEnumValues added in v65.3.0

func GetTranscriptionJobAdditionalTranscriptionFormatsEnumValues() []TranscriptionJobAdditionalTranscriptionFormatsEnum

GetTranscriptionJobAdditionalTranscriptionFormatsEnumValues Enumerates the set of values for TranscriptionJobAdditionalTranscriptionFormatsEnum

type TranscriptionJobCollection

type TranscriptionJobCollection struct {

	// List of transcription jobs.
	Items []TranscriptionJobSummary `mandatory:"true" json:"items"`
}

TranscriptionJobCollection Results of a Transcription Job search. Contains both TranscriptionJobSummary items and other information, such as metadata.

func (TranscriptionJobCollection) String

func (TranscriptionJobCollection) ValidateEnumValue

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

type TranscriptionJobLifecycleStateEnum

type TranscriptionJobLifecycleStateEnum string

TranscriptionJobLifecycleStateEnum Enum with underlying type: string

const (
	TranscriptionJobLifecycleStateAccepted   TranscriptionJobLifecycleStateEnum = "ACCEPTED"
	TranscriptionJobLifecycleStateInProgress TranscriptionJobLifecycleStateEnum = "IN_PROGRESS"
	TranscriptionJobLifecycleStateSucceeded  TranscriptionJobLifecycleStateEnum = "SUCCEEDED"
	TranscriptionJobLifecycleStateFailed     TranscriptionJobLifecycleStateEnum = "FAILED"
	TranscriptionJobLifecycleStateCanceling  TranscriptionJobLifecycleStateEnum = "CANCELING"
	TranscriptionJobLifecycleStateCanceled   TranscriptionJobLifecycleStateEnum = "CANCELED"
)

Set of constants representing the allowable values for TranscriptionJobLifecycleStateEnum

func GetMappingTranscriptionJobLifecycleStateEnum

func GetMappingTranscriptionJobLifecycleStateEnum(val string) (TranscriptionJobLifecycleStateEnum, bool)

GetMappingTranscriptionJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTranscriptionJobLifecycleStateEnumValues

func GetTranscriptionJobLifecycleStateEnumValues() []TranscriptionJobLifecycleStateEnum

GetTranscriptionJobLifecycleStateEnumValues Enumerates the set of values for TranscriptionJobLifecycleStateEnum

type TranscriptionJobSummary

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"`
}

TranscriptionJobSummary Summary of the Transcription Job.

func (TranscriptionJobSummary) String

func (m TranscriptionJobSummary) String() string

func (TranscriptionJobSummary) ValidateEnumValue

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

type TranscriptionModelDetails

type TranscriptionModelDetails struct {

	// Select a model to use for generating transcriptions. Currently supported models are:
	// - ORACLE
	// - WHISPER_MEDIUM
	// - WHISPER_LARGE_V2 (upon service request)
	ModelType *string `mandatory:"false" json:"modelType"`

	// Domain for input files.
	Domain TranscriptionModelDetailsDomainEnum `mandatory:"false" json:"domain,omitempty"`

	//
	// Oracle supported language codes are (Oracle models are locale specific).
	// - en-US: English - United States (default)
	// - 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
	// Whisper supported language codes are (Whisper models are locale agnostic).
	// - af: Afrikaans
	// - ar: Arabic
	// - az: Azerbaijani
	// - be: Belarusian
	// - bg: Bulgarian
	// - bs: Bosnian
	// - ca: Catalan
	// - cs: Czech
	// - cy: Welsh
	// - da: Danish
	// - de: German
	// - el: Greek
	// - en: English (default)
	// - es: Spanish
	// - et: Estonian
	// - fa: Persian
	// - fi: Finnish
	// - fr: French
	// - gl: Galician
	// - he: Hebrew
	// - hi: Hindi
	// - hr: Croatian
	// - hu: Hungarian
	// - hy: Armenian
	// - id: Indonesian
	// - is: Icelandic
	// - it: Italian
	// - ja: Japanese
	// - kk: Kazakh
	// - kn: Kannada
	// - ko: Korean
	// - lt: Lithuanian
	// - lv: Latvian
	// - mi: Maori
	// - mk: Macedonian
	// - mr: Marathi
	// - ms: Malay
	// - ne: Nepali
	// - nl: Dutch
	// - no: Norwegian
	// - pl: Polish
	// - pt: Portuguese
	// - ro: Romanian
	// - ru: Russian
	// - sk: Slovak
	// - sl: Slovenian
	// - sr: Serbian
	// - sv: Swedish
	// - sw: Swahili
	// - ta: Tamil
	// - th: Thai
	// - tl: Tagalog
	// - tr: Turkish
	// - uk: Ukrainian
	// - ur: Urdu
	// - vi: Vietnamese
	// - zh: Chinese
	LanguageCode TranscriptionModelDetailsLanguageCodeEnum `mandatory:"false" json:"languageCode,omitempty"`

	TranscriptionSettings *TranscriptionSettings `mandatory:"false" json:"transcriptionSettings"`
}

TranscriptionModelDetails Model details.

func (TranscriptionModelDetails) String

func (m TranscriptionModelDetails) String() string

func (TranscriptionModelDetails) ValidateEnumValue

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

type TranscriptionModelDetailsDomainEnum

type TranscriptionModelDetailsDomainEnum string

TranscriptionModelDetailsDomainEnum Enum with underlying type: string

const (
	TranscriptionModelDetailsDomainGeneric TranscriptionModelDetailsDomainEnum = "GENERIC"
)

Set of constants representing the allowable values for TranscriptionModelDetailsDomainEnum

func GetMappingTranscriptionModelDetailsDomainEnum

func GetMappingTranscriptionModelDetailsDomainEnum(val string) (TranscriptionModelDetailsDomainEnum, bool)

GetMappingTranscriptionModelDetailsDomainEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTranscriptionModelDetailsDomainEnumValues

func GetTranscriptionModelDetailsDomainEnumValues() []TranscriptionModelDetailsDomainEnum

GetTranscriptionModelDetailsDomainEnumValues Enumerates the set of values for TranscriptionModelDetailsDomainEnum

type TranscriptionModelDetailsLanguageCodeEnum

type TranscriptionModelDetailsLanguageCodeEnum string

TranscriptionModelDetailsLanguageCodeEnum Enum with underlying type: string

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"
	TranscriptionModelDetailsLanguageCodeAf   TranscriptionModelDetailsLanguageCodeEnum = "af"
	TranscriptionModelDetailsLanguageCodeAr   TranscriptionModelDetailsLanguageCodeEnum = "ar"
	TranscriptionModelDetailsLanguageCodeAz   TranscriptionModelDetailsLanguageCodeEnum = "az"
	TranscriptionModelDetailsLanguageCodeBe   TranscriptionModelDetailsLanguageCodeEnum = "be"
	TranscriptionModelDetailsLanguageCodeBg   TranscriptionModelDetailsLanguageCodeEnum = "bg"
	TranscriptionModelDetailsLanguageCodeBs   TranscriptionModelDetailsLanguageCodeEnum = "bs"
	TranscriptionModelDetailsLanguageCodeCa   TranscriptionModelDetailsLanguageCodeEnum = "ca"
	TranscriptionModelDetailsLanguageCodeCs   TranscriptionModelDetailsLanguageCodeEnum = "cs"
	TranscriptionModelDetailsLanguageCodeCy   TranscriptionModelDetailsLanguageCodeEnum = "cy"
	TranscriptionModelDetailsLanguageCodeDa   TranscriptionModelDetailsLanguageCodeEnum = "da"
	TranscriptionModelDetailsLanguageCodeDe   TranscriptionModelDetailsLanguageCodeEnum = "de"
	TranscriptionModelDetailsLanguageCodeEl   TranscriptionModelDetailsLanguageCodeEnum = "el"
	TranscriptionModelDetailsLanguageCodeEn   TranscriptionModelDetailsLanguageCodeEnum = "en"
	TranscriptionModelDetailsLanguageCodeEs   TranscriptionModelDetailsLanguageCodeEnum = "es"
	TranscriptionModelDetailsLanguageCodeEt   TranscriptionModelDetailsLanguageCodeEnum = "et"
	TranscriptionModelDetailsLanguageCodeFa   TranscriptionModelDetailsLanguageCodeEnum = "fa"
	TranscriptionModelDetailsLanguageCodeFi   TranscriptionModelDetailsLanguageCodeEnum = "fi"
	TranscriptionModelDetailsLanguageCodeFr   TranscriptionModelDetailsLanguageCodeEnum = "fr"
	TranscriptionModelDetailsLanguageCodeGl   TranscriptionModelDetailsLanguageCodeEnum = "gl"
	TranscriptionModelDetailsLanguageCodeHe   TranscriptionModelDetailsLanguageCodeEnum = "he"
	TranscriptionModelDetailsLanguageCodeHi   TranscriptionModelDetailsLanguageCodeEnum = "hi"
	TranscriptionModelDetailsLanguageCodeHr   TranscriptionModelDetailsLanguageCodeEnum = "hr"
	TranscriptionModelDetailsLanguageCodeHu   TranscriptionModelDetailsLanguageCodeEnum = "hu"
	TranscriptionModelDetailsLanguageCodeHy   TranscriptionModelDetailsLanguageCodeEnum = "hy"
	TranscriptionModelDetailsLanguageCodeId   TranscriptionModelDetailsLanguageCodeEnum = "id"
	TranscriptionModelDetailsLanguageCodeIs   TranscriptionModelDetailsLanguageCodeEnum = "is"
	TranscriptionModelDetailsLanguageCodeIt   TranscriptionModelDetailsLanguageCodeEnum = "it"
	TranscriptionModelDetailsLanguageCodeJa   TranscriptionModelDetailsLanguageCodeEnum = "ja"
	TranscriptionModelDetailsLanguageCodeKk   TranscriptionModelDetailsLanguageCodeEnum = "kk"
	TranscriptionModelDetailsLanguageCodeKn   TranscriptionModelDetailsLanguageCodeEnum = "kn"
	TranscriptionModelDetailsLanguageCodeKo   TranscriptionModelDetailsLanguageCodeEnum = "ko"
	TranscriptionModelDetailsLanguageCodeLt   TranscriptionModelDetailsLanguageCodeEnum = "lt"
	TranscriptionModelDetailsLanguageCodeLv   TranscriptionModelDetailsLanguageCodeEnum = "lv"
	TranscriptionModelDetailsLanguageCodeMi   TranscriptionModelDetailsLanguageCodeEnum = "mi"
	TranscriptionModelDetailsLanguageCodeMk   TranscriptionModelDetailsLanguageCodeEnum = "mk"
	TranscriptionModelDetailsLanguageCodeMr   TranscriptionModelDetailsLanguageCodeEnum = "mr"
	TranscriptionModelDetailsLanguageCodeMs   TranscriptionModelDetailsLanguageCodeEnum = "ms"
	TranscriptionModelDetailsLanguageCodeNe   TranscriptionModelDetailsLanguageCodeEnum = "ne"
	TranscriptionModelDetailsLanguageCodeNl   TranscriptionModelDetailsLanguageCodeEnum = "nl"
	TranscriptionModelDetailsLanguageCodeNo   TranscriptionModelDetailsLanguageCodeEnum = "no"
	TranscriptionModelDetailsLanguageCodePl   TranscriptionModelDetailsLanguageCodeEnum = "pl"
	TranscriptionModelDetailsLanguageCodePt   TranscriptionModelDetailsLanguageCodeEnum = "pt"
	TranscriptionModelDetailsLanguageCodeRo   TranscriptionModelDetailsLanguageCodeEnum = "ro"
	TranscriptionModelDetailsLanguageCodeRu   TranscriptionModelDetailsLanguageCodeEnum = "ru"
	TranscriptionModelDetailsLanguageCodeSk   TranscriptionModelDetailsLanguageCodeEnum = "sk"
	TranscriptionModelDetailsLanguageCodeSl   TranscriptionModelDetailsLanguageCodeEnum = "sl"
	TranscriptionModelDetailsLanguageCodeSr   TranscriptionModelDetailsLanguageCodeEnum = "sr"
	TranscriptionModelDetailsLanguageCodeSv   TranscriptionModelDetailsLanguageCodeEnum = "sv"
	TranscriptionModelDetailsLanguageCodeSw   TranscriptionModelDetailsLanguageCodeEnum = "sw"
	TranscriptionModelDetailsLanguageCodeTa   TranscriptionModelDetailsLanguageCodeEnum = "ta"
	TranscriptionModelDetailsLanguageCodeTh   TranscriptionModelDetailsLanguageCodeEnum = "th"
	TranscriptionModelDetailsLanguageCodeTl   TranscriptionModelDetailsLanguageCodeEnum = "tl"
	TranscriptionModelDetailsLanguageCodeTr   TranscriptionModelDetailsLanguageCodeEnum = "tr"
	TranscriptionModelDetailsLanguageCodeUk   TranscriptionModelDetailsLanguageCodeEnum = "uk"
	TranscriptionModelDetailsLanguageCodeUr   TranscriptionModelDetailsLanguageCodeEnum = "ur"
	TranscriptionModelDetailsLanguageCodeVi   TranscriptionModelDetailsLanguageCodeEnum = "vi"
	TranscriptionModelDetailsLanguageCodeZh   TranscriptionModelDetailsLanguageCodeEnum = "zh"
)

Set of constants representing the allowable values for TranscriptionModelDetailsLanguageCodeEnum

func GetMappingTranscriptionModelDetailsLanguageCodeEnum

func GetMappingTranscriptionModelDetailsLanguageCodeEnum(val string) (TranscriptionModelDetailsLanguageCodeEnum, bool)

GetMappingTranscriptionModelDetailsLanguageCodeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTranscriptionModelDetailsLanguageCodeEnumValues

func GetTranscriptionModelDetailsLanguageCodeEnumValues() []TranscriptionModelDetailsLanguageCodeEnum

GetTranscriptionModelDetailsLanguageCodeEnumValues Enumerates the set of values for TranscriptionModelDetailsLanguageCodeEnum

type TranscriptionNormalization

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"`
}

TranscriptionNormalization Information to Normalize generated transcript.

func (TranscriptionNormalization) String

func (*TranscriptionNormalization) UnmarshalJSON

func (m *TranscriptionNormalization) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (TranscriptionNormalization) ValidateEnumValue

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

type TranscriptionSettings added in v65.53.0

type TranscriptionSettings struct {
	Diarization *Diarization `mandatory:"false" json:"diarization"`
}

TranscriptionSettings Processes to perform on the generated transcription.

func (TranscriptionSettings) String added in v65.53.0

func (m TranscriptionSettings) String() string

func (TranscriptionSettings) ValidateEnumValue added in v65.53.0

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

type TranscriptionTask

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"`
}

TranscriptionTask Description of Transcription Task.

func (TranscriptionTask) String

func (m TranscriptionTask) String() string

func (TranscriptionTask) ValidateEnumValue

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

type TranscriptionTaskCollection

type TranscriptionTaskCollection struct {

	// List of Transcription Task.
	Items []TranscriptionTaskSummary `mandatory:"true" json:"items"`
}

TranscriptionTaskCollection Results of a Transcription Task search. Contains both TranscriptionTaskSummary items and other information, such as metadata.

func (TranscriptionTaskCollection) String

func (TranscriptionTaskCollection) ValidateEnumValue

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

type TranscriptionTaskLifecycleStateEnum

type TranscriptionTaskLifecycleStateEnum string

TranscriptionTaskLifecycleStateEnum Enum with underlying type: string

const (
	TranscriptionTaskLifecycleStateAccepted   TranscriptionTaskLifecycleStateEnum = "ACCEPTED"
	TranscriptionTaskLifecycleStateInProgress TranscriptionTaskLifecycleStateEnum = "IN_PROGRESS"
	TranscriptionTaskLifecycleStateSucceeded  TranscriptionTaskLifecycleStateEnum = "SUCCEEDED"
	TranscriptionTaskLifecycleStateFailed     TranscriptionTaskLifecycleStateEnum = "FAILED"
	TranscriptionTaskLifecycleStateCanceled   TranscriptionTaskLifecycleStateEnum = "CANCELED"
)

Set of constants representing the allowable values for TranscriptionTaskLifecycleStateEnum

func GetMappingTranscriptionTaskLifecycleStateEnum

func GetMappingTranscriptionTaskLifecycleStateEnum(val string) (TranscriptionTaskLifecycleStateEnum, bool)

GetMappingTranscriptionTaskLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTranscriptionTaskLifecycleStateEnumValues

func GetTranscriptionTaskLifecycleStateEnumValues() []TranscriptionTaskLifecycleStateEnum

GetTranscriptionTaskLifecycleStateEnumValues Enumerates the set of values for TranscriptionTaskLifecycleStateEnum

type TranscriptionTaskSummary

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"`
}

TranscriptionTaskSummary Summary of the Transcription Task.

func (TranscriptionTaskSummary) String

func (m TranscriptionTaskSummary) String() string

func (TranscriptionTaskSummary) ValidateEnumValue

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

type UpdateTranscriptionJobDetails

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"`
}

UpdateTranscriptionJobDetails The information to be updated.

func (UpdateTranscriptionJobDetails) String

func (UpdateTranscriptionJobDetails) ValidateEnumValue

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

type 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
}

UpdateTranscriptionJobRequest wrapper for the UpdateTranscriptionJob operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/UpdateTranscriptionJob.go.html to see an example of how to use UpdateTranscriptionJobRequest.

func (UpdateTranscriptionJobRequest) BinaryRequestBody

func (request UpdateTranscriptionJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateTranscriptionJobRequest) HTTPRequest

func (request UpdateTranscriptionJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTranscriptionJobRequest) RetryPolicy

func (request UpdateTranscriptionJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTranscriptionJobRequest) String

func (request UpdateTranscriptionJobRequest) String() string

func (UpdateTranscriptionJobRequest) ValidateEnumValue

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

type UpdateTranscriptionJobResponse

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"`
}

UpdateTranscriptionJobResponse wrapper for the UpdateTranscriptionJob operation

func (UpdateTranscriptionJobResponse) HTTPResponse

func (response UpdateTranscriptionJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTranscriptionJobResponse) String

func (response UpdateTranscriptionJobResponse) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL