aispeech

package
v65.72.0 Latest Latest
Warning

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

 Go to latest Published: Aug 20, 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 GetCustomizationDatasetDetailsDatasetTypeEnumStringValues added in v65.70.0 

func GetCustomizationDatasetDetailsDatasetTypeEnumStringValues() []string

GetCustomizationDatasetDetailsDatasetTypeEnumStringValues Enumerates the set of values in String for CustomizationDatasetDetailsDatasetTypeEnum

func GetCustomizationLifecycleStateEnumStringValues added in v65.70.0 

func GetCustomizationLifecycleStateEnumStringValues() []string

GetCustomizationLifecycleStateEnumStringValues Enumerates the set of values in String for CustomizationLifecycleStateEnum

func GetCustomizationModelDetailsDomainEnumStringValues added in v65.70.0 

func GetCustomizationModelDetailsDomainEnumStringValues() []string

GetCustomizationModelDetailsDomainEnumStringValues Enumerates the set of values in String for CustomizationModelDetailsDomainEnum

func GetInputLocationLocationTypeEnumStringValues 

func GetInputLocationLocationTypeEnumStringValues() []string

GetInputLocationLocationTypeEnumStringValues Enumerates the set of values in String for InputLocationLocationTypeEnum

func GetListCustomizationsSortByEnumStringValues added in v65.70.0 

func GetListCustomizationsSortByEnumStringValues() []string

GetListCustomizationsSortByEnumStringValues Enumerates the set of values in String for ListCustomizationsSortByEnum

func GetListCustomizationsSortOrderEnumStringValues added in v65.70.0 

func GetListCustomizationsSortOrderEnumStringValues() []string

GetListCustomizationsSortOrderEnumStringValues Enumerates the set of values in String for ListCustomizationsSortOrderEnum

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 GetLocationDetailsLocationTypeEnumStringValues added in v65.70.0 

func GetLocationDetailsLocationTypeEnumStringValues() []string

GetLocationDetailsLocationTypeEnumStringValues Enumerates the set of values in String for LocationDetailsLocationTypeEnum

func GetProfanityTranscriptionFilterModeEnumStringValues 

func GetProfanityTranscriptionFilterModeEnumStringValues() []string

GetProfanityTranscriptionFilterModeEnumStringValues Enumerates the set of values in String for ProfanityTranscriptionFilterModeEnum

func GetRealtimeMessageAuthenticationAuthenticationTypeEnumStringValues added in v65.70.0 

func GetRealtimeMessageAuthenticationAuthenticationTypeEnumStringValues() []string

GetRealtimeMessageAuthenticationAuthenticationTypeEnumStringValues Enumerates the set of values in String for RealtimeMessageAuthenticationAuthenticationTypeEnum

func GetRealtimeMessageEventEnumStringValues added in v65.70.0 

func GetRealtimeMessageEventEnumStringValues() []string

GetRealtimeMessageEventEnumStringValues Enumerates the set of values in String for RealtimeMessageEventEnum

func GetRealtimeMessageOutEventEnumStringValues added in v65.70.0 

func GetRealtimeMessageOutEventEnumStringValues() []string

GetRealtimeMessageOutEventEnumStringValues Enumerates the set of values in String for RealtimeMessageOutEventEnum

func GetRealtimeMessageResultTranscriptionTokenTypeEnumStringValues added in v65.70.0 

func GetRealtimeMessageResultTranscriptionTokenTypeEnumStringValues() []string

GetRealtimeMessageResultTranscriptionTokenTypeEnumStringValues Enumerates the set of values in String for RealtimeMessageResultTranscriptionTokenTypeEnum

func GetRealtimeModelDetailsDomainEnumStringValues added in v65.70.0 

func GetRealtimeModelDetailsDomainEnumStringValues() []string

GetRealtimeModelDetailsDomainEnumStringValues Enumerates the set of values in String for RealtimeModelDetailsDomainEnum

func GetRealtimeParametersModelDomainEnumStringValues added in v65.70.0 

func GetRealtimeParametersModelDomainEnumStringValues() []string

GetRealtimeParametersModelDomainEnumStringValues Enumerates the set of values in String for RealtimeParametersModelDomainEnum

func GetRealtimeParametersStabilizePartialResultsEnumStringValues added in v65.70.0 

func GetRealtimeParametersStabilizePartialResultsEnumStringValues() []string

GetRealtimeParametersStabilizePartialResultsEnumStringValues Enumerates the set of values in String for RealtimeParametersStabilizePartialResultsEnum

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) ChangeCustomizationCompartment added in v65.70.0 

func (client AIServiceSpeechClient) ChangeCustomizationCompartment(ctx context.Context, request ChangeCustomizationCompartmentRequest) (response ChangeCustomizationCompartmentResponse, err error)

ChangeCustomizationCompartment Moves a Customization resource into a different compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/ChangeCustomizationCompartment.go.html to see an example of how to use ChangeCustomizationCompartment 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) CreateCustomization added in v65.70.0 

func (client AIServiceSpeechClient) CreateCustomization(ctx context.Context, request CreateCustomizationRequest) (response CreateCustomizationResponse, err error)

CreateCustomization Creates a new Customization.

See also

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

func (AIServiceSpeechClient) CreateRealtimeSessionToken added in v65.70.0 

func (client AIServiceSpeechClient) CreateRealtimeSessionToken(ctx context.Context, request CreateRealtimeSessionTokenRequest) (response CreateRealtimeSessionTokenResponse, err error)

CreateRealtimeSessionToken Returns an authentication token to the user.

See also

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

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) DeleteCustomization added in v65.70.0 

func (client AIServiceSpeechClient) DeleteCustomization(ctx context.Context, request DeleteCustomizationRequest) (response DeleteCustomizationResponse, err error)

DeleteCustomization Delete Customization and its metadata from tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/DeleteCustomization.go.html to see an example of how to use DeleteCustomization 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) GetCustomization added in v65.70.0 

func (client AIServiceSpeechClient) GetCustomization(ctx context.Context, request GetCustomizationRequest) (response GetCustomizationResponse, err error)

GetCustomization Gets a Customization by identifier

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/GetCustomization.go.html to see an example of how to use GetCustomization 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) ListCustomizations added in v65.70.0 

func (client AIServiceSpeechClient) ListCustomizations(ctx context.Context, request ListCustomizationsRequest) (response ListCustomizationsResponse, err error)

ListCustomizations Returns a list of Customizations.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/aispeech/ListCustomizations.go.html to see an example of how to use ListCustomizations 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) UpdateCustomization added in v65.70.0 

func (client AIServiceSpeechClient) UpdateCustomization(ctx context.Context, request UpdateCustomizationRequest) (response UpdateCustomizationResponse, err error)

UpdateCustomization Updates a Customization by identifier

See also

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

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 ChangeCustomizationCompartmentDetails added in v65.70.0 

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

ChangeCustomizationCompartmentDetails Details for changing the compartment of a Customization.

func (ChangeCustomizationCompartmentDetails) String added in v65.70.0 

func (m ChangeCustomizationCompartmentDetails) String() string

func (ChangeCustomizationCompartmentDetails) ValidateEnumValue added in v65.70.0 

func (m ChangeCustomizationCompartmentDetails) 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 ChangeCustomizationCompartmentRequest added in v65.70.0 

type ChangeCustomizationCompartmentRequest struct {

	// Unique Customization training Job identifier.
	CustomizationId *string `mandatory:"true" contributesTo:"path" name:"customizationId"`

	// Details for changing the compartment of a Customization.
	ChangeCustomizationCompartmentDetails `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
}

ChangeCustomizationCompartmentRequest wrapper for the ChangeCustomizationCompartment operation

See also

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

func (ChangeCustomizationCompartmentRequest) BinaryRequestBody added in v65.70.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeCustomizationCompartmentRequest) HTTPRequest added in v65.70.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeCustomizationCompartmentRequest) RetryPolicy added in v65.70.0 

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

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

func (ChangeCustomizationCompartmentRequest) String added in v65.70.0 

func (request ChangeCustomizationCompartmentRequest) String() string

func (ChangeCustomizationCompartmentRequest) ValidateEnumValue added in v65.70.0 

func (request ChangeCustomizationCompartmentRequest) 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 ChangeCustomizationCompartmentResponse added in v65.70.0 

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

ChangeCustomizationCompartmentResponse wrapper for the ChangeCustomizationCompartment operation

func (ChangeCustomizationCompartmentResponse) HTTPResponse added in v65.70.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeCustomizationCompartmentResponse) String added in v65.70.0 

func (response ChangeCustomizationCompartmentResponse) 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 (m ChangeTranscriptionJobCompartmentDetails) String() 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 

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

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 

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

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

func (ChangeTranscriptionJobCompartmentRequest) String 

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

func (response ChangeTranscriptionJobCompartmentResponse) String() string

type CreateCustomizationDetails added in v65.70.0 

type CreateCustomizationDetails 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"`

	ModelDetails *CustomizationModelDetails `mandatory:"true" json:"modelDetails"`

	TrainingDataset CustomizationDatasetDetails `mandatory:"true" json:"trainingDataset"`

	// Customization Details Alias
	Alias *string `mandatory:"false" json:"alias"`

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

CreateCustomizationDetails The information about the new Customization.

func (CreateCustomizationDetails) String added in v65.70.0 

func (m CreateCustomizationDetails) String() string

func (*CreateCustomizationDetails) UnmarshalJSON added in v65.70.0 

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

UnmarshalJSON unmarshals from json

func (CreateCustomizationDetails) ValidateEnumValue added in v65.70.0 

func (m CreateCustomizationDetails) 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 CreateCustomizationRequest added in v65.70.0 

type CreateCustomizationRequest struct {

	// Details for the new Customization.
	CreateCustomizationDetails `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
}

CreateCustomizationRequest wrapper for the CreateCustomization operation

See also

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

func (CreateCustomizationRequest) BinaryRequestBody added in v65.70.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateCustomizationRequest) HTTPRequest added in v65.70.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateCustomizationRequest) RetryPolicy added in v65.70.0 

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

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

func (CreateCustomizationRequest) String added in v65.70.0 

func (request CreateCustomizationRequest) String() string

func (CreateCustomizationRequest) ValidateEnumValue added in v65.70.0 

func (request CreateCustomizationRequest) 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 CreateCustomizationResponse added in v65.70.0 

type CreateCustomizationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Customization instance
	Customization `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"`
}

CreateCustomizationResponse wrapper for the CreateCustomization operation

func (CreateCustomizationResponse) HTTPResponse added in v65.70.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateCustomizationResponse) String added in v65.70.0 

func (response CreateCustomizationResponse) String() string

type CreateRealtimeSessionTokenDetails added in v65.70.0 

type CreateRealtimeSessionTokenDetails 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"`

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

CreateRealtimeSessionTokenDetails Request sent to the realtime authentication endpoint in order to obtain the auth token.

func (CreateRealtimeSessionTokenDetails) String added in v65.70.0 

func (m CreateRealtimeSessionTokenDetails) String() string

func (CreateRealtimeSessionTokenDetails) ValidateEnumValue added in v65.70.0 

func (m CreateRealtimeSessionTokenDetails) 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 CreateRealtimeSessionTokenRequest added in v65.70.0 

type CreateRealtimeSessionTokenRequest struct {

	// An object containing the compartment ID for authorization purposes.
	CreateRealtimeSessionTokenDetails `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
}

CreateRealtimeSessionTokenRequest wrapper for the CreateRealtimeSessionToken operation

See also

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

func (CreateRealtimeSessionTokenRequest) BinaryRequestBody added in v65.70.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateRealtimeSessionTokenRequest) HTTPRequest added in v65.70.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateRealtimeSessionTokenRequest) RetryPolicy added in v65.70.0 

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

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

func (CreateRealtimeSessionTokenRequest) String added in v65.70.0 

func (request CreateRealtimeSessionTokenRequest) String() string

func (CreateRealtimeSessionTokenRequest) ValidateEnumValue added in v65.70.0 

func (request CreateRealtimeSessionTokenRequest) 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 CreateRealtimeSessionTokenResponse added in v65.70.0 

type CreateRealtimeSessionTokenResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RealtimeSessionToken instance
	RealtimeSessionToken `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"`
}

CreateRealtimeSessionTokenResponse wrapper for the CreateRealtimeSessionToken operation

func (CreateRealtimeSessionTokenResponse) HTTPResponse added in v65.70.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateRealtimeSessionTokenResponse) String added in v65.70.0 

func (response CreateRealtimeSessionTokenResponse) String() 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 (m CreateTranscriptionJobDetails) String() 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 Customization added in v65.70.0 

type Customization 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 *CustomizationModelDetails `mandatory:"true" json:"modelDetails"`

	// A user-friendly display name for the job.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Customization Details Alias
	Alias *string `mandatory:"false" json:"alias"`

	// A short description of the job.
	Description *string `mandatory:"false" json:"description"`

	// The current state of the Job.
	LifecycleState CustomizationLifecycleStateEnum `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"`

	// Customization Created time. An RFC3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Customization Updated time. An RFC3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	TrainingDataset CustomizationDatasetDetails `mandatory:"false" json:"trainingDataset"`

	// array of referenced entities
	Entities []CustomizationReferencedEntities `mandatory:"false" json:"entities"`

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

Customization Description of a Customization.

func (Customization) String added in v65.70.0 

func (m Customization) String() string

func (*Customization) UnmarshalJSON added in v65.70.0 

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

UnmarshalJSON unmarshals from json

func (Customization) ValidateEnumValue added in v65.70.0 

func (m Customization) 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 CustomizationCollection added in v65.70.0 

type CustomizationCollection struct {

	// List of Customization training jobs.
	Items []CustomizationSummary `mandatory:"true" json:"items"`
}

CustomizationCollection Results of a Customization search. Contains both CustomizationSummary items and other information, such as metadata.

func (CustomizationCollection) String added in v65.70.0 

func (m CustomizationCollection) String() string

func (CustomizationCollection) ValidateEnumValue added in v65.70.0 

func (m CustomizationCollection) 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 CustomizationDatasetDetails added in v65.70.0 

type CustomizationDatasetDetails interface {
}

CustomizationDatasetDetails Customization Training Dataset

type CustomizationDatasetDetailsDatasetTypeEnum added in v65.70.0 

type CustomizationDatasetDetailsDatasetTypeEnum string

CustomizationDatasetDetailsDatasetTypeEnum Enum with underlying type: string 

const (
	CustomizationDatasetDetailsDatasetTypeObjectStorage CustomizationDatasetDetailsDatasetTypeEnum = "OBJECT_STORAGE"
	CustomizationDatasetDetailsDatasetTypeEntityList    CustomizationDatasetDetailsDatasetTypeEnum = "ENTITY_LIST"
)

Set of constants representing the allowable values for CustomizationDatasetDetailsDatasetTypeEnum

func GetCustomizationDatasetDetailsDatasetTypeEnumValues added in v65.70.0 

func GetCustomizationDatasetDetailsDatasetTypeEnumValues() []CustomizationDatasetDetailsDatasetTypeEnum

GetCustomizationDatasetDetailsDatasetTypeEnumValues Enumerates the set of values for CustomizationDatasetDetailsDatasetTypeEnum

func GetMappingCustomizationDatasetDetailsDatasetTypeEnum added in v65.70.0 

func GetMappingCustomizationDatasetDetailsDatasetTypeEnum(val string) (CustomizationDatasetDetailsDatasetTypeEnum, bool)

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

type CustomizationInference added in v65.70.0 

type CustomizationInference struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customization to use.
	CustomizationId *string `mandatory:"false" json:"customizationId"`

	// Alias of the customization
	CustomizationAlias *string `mandatory:"false" json:"customizationAlias"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where customization is present
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Entities present in the customization
	Entities []CustomizationInferenceEntity `mandatory:"false" json:"entities"`
}

CustomizationInference Inference payload for using Customization in Realtime Speech or Async Speech

func (CustomizationInference) String added in v65.70.0 

func (m CustomizationInference) String() string

func (CustomizationInference) ValidateEnumValue added in v65.70.0 

func (m CustomizationInference) 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 CustomizationInferenceEntity added in v65.70.0 

type CustomizationInferenceEntity struct {

	// Entity type
	EntityType *string `mandatory:"false" json:"entityType"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customization to use.
	CustomizationId *string `mandatory:"false" json:"customizationId"`

	// Alias of the customization
	CustomizationAlias *string `mandatory:"false" json:"customizationAlias"`
}

CustomizationInferenceEntity Entity Object for customization inference payload

func (CustomizationInferenceEntity) String added in v65.70.0 

func (m CustomizationInferenceEntity) String() string

func (CustomizationInferenceEntity) ValidateEnumValue added in v65.70.0 

func (m CustomizationInferenceEntity) 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 CustomizationLifecycleStateEnum added in v65.70.0 

type CustomizationLifecycleStateEnum string

CustomizationLifecycleStateEnum Enum with underlying type: string 

const (
	CustomizationLifecycleStateDeleting CustomizationLifecycleStateEnum = "DELETING"
	CustomizationLifecycleStateDeleted  CustomizationLifecycleStateEnum = "DELETED"
	CustomizationLifecycleStateFailed   CustomizationLifecycleStateEnum = "FAILED"
	CustomizationLifecycleStateUpdating CustomizationLifecycleStateEnum = "UPDATING"
	CustomizationLifecycleStateActive   CustomizationLifecycleStateEnum = "ACTIVE"
	CustomizationLifecycleStateCreating CustomizationLifecycleStateEnum = "CREATING"
)

Set of constants representing the allowable values for CustomizationLifecycleStateEnum

func GetCustomizationLifecycleStateEnumValues added in v65.70.0 

func GetCustomizationLifecycleStateEnumValues() []CustomizationLifecycleStateEnum

GetCustomizationLifecycleStateEnumValues Enumerates the set of values for CustomizationLifecycleStateEnum

func GetMappingCustomizationLifecycleStateEnum added in v65.70.0 

func GetMappingCustomizationLifecycleStateEnum(val string) (CustomizationLifecycleStateEnum, bool)

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

type CustomizationModelDetails added in v65.70.0 

type CustomizationModelDetails struct {

	// Customization Domain
	Domain CustomizationModelDetailsDomainEnum `mandatory:"false" json:"domain,omitempty"`

	// Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].
	// - en-US: English - United States
	// - es-ES: Spanish - Spain
	// - pt-BR: Portuguese - Brazil
	// - en-GB: English - Great Britain
	// - en-AU: English - Australia
	// - en-IN: English - India
	// - hi-IN: Hindi - India
	// - fr-FR: French - France
	// - de-DE: German - Germany
	// - it-IT: Italian - Italy
	LanguageCode *string `mandatory:"false" json:"languageCode"`
}

CustomizationModelDetails Customization details.

func (CustomizationModelDetails) String added in v65.70.0 

func (m CustomizationModelDetails) String() string

func (CustomizationModelDetails) ValidateEnumValue added in v65.70.0 

func (m CustomizationModelDetails) 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 CustomizationModelDetailsDomainEnum added in v65.70.0 

type CustomizationModelDetailsDomainEnum string

CustomizationModelDetailsDomainEnum Enum with underlying type: string 

const (
	CustomizationModelDetailsDomainGeneric CustomizationModelDetailsDomainEnum = "GENERIC"
	CustomizationModelDetailsDomainMedical CustomizationModelDetailsDomainEnum = "MEDICAL"
)

Set of constants representing the allowable values for CustomizationModelDetailsDomainEnum

func GetCustomizationModelDetailsDomainEnumValues added in v65.70.0 

func GetCustomizationModelDetailsDomainEnumValues() []CustomizationModelDetailsDomainEnum

GetCustomizationModelDetailsDomainEnumValues Enumerates the set of values for CustomizationModelDetailsDomainEnum

func GetMappingCustomizationModelDetailsDomainEnum added in v65.70.0 

func GetMappingCustomizationModelDetailsDomainEnum(val string) (CustomizationModelDetailsDomainEnum, bool)

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

type CustomizationReferencedEntities added in v65.70.0 

type CustomizationReferencedEntities struct {

	// Alias of default referenced Customization for given entityType
	Alias *string `mandatory:"false" json:"alias"`

	// Customization Id of default referenced Customization for given entityType
	Id *string `mandatory:"false" json:"id"`

	// Customization Entity Type
	EntityType *string `mandatory:"false" json:"entityType"`
}

CustomizationReferencedEntities Entities referenced by top level customization.

func (CustomizationReferencedEntities) String added in v65.70.0 

func (m CustomizationReferencedEntities) String() string

func (CustomizationReferencedEntities) ValidateEnumValue added in v65.70.0 

func (m CustomizationReferencedEntities) 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 CustomizationSummary added in v65.70.0 

type CustomizationSummary 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"`

	// Customization Summary Alias
	Alias *string `mandatory:"false" json:"alias"`

	// Customization Created time. An RFC3339 formatted datetime string.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Customization Updated time. An RFC3339 formatted datetime string.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// The current state of the Speech Job.
	LifecycleState CustomizationLifecycleStateEnum `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"`
}

CustomizationSummary Summary of the Customization.

func (CustomizationSummary) String added in v65.70.0 

func (m CustomizationSummary) String() string

func (CustomizationSummary) ValidateEnumValue added in v65.70.0 

func (m CustomizationSummary) 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 DeleteCustomizationRequest added in v65.70.0 

type DeleteCustomizationRequest struct {

	// Unique Customization training Job identifier.
	CustomizationId *string `mandatory:"true" contributesTo:"path" name:"customizationId"`

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

DeleteCustomizationRequest wrapper for the DeleteCustomization operation

See also

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

func (DeleteCustomizationRequest) BinaryRequestBody added in v65.70.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteCustomizationRequest) HTTPRequest added in v65.70.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteCustomizationRequest) RetryPolicy added in v65.70.0 

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

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

func (DeleteCustomizationRequest) String added in v65.70.0 

func (request DeleteCustomizationRequest) String() string

func (DeleteCustomizationRequest) ValidateEnumValue added in v65.70.0 

func (request DeleteCustomizationRequest) 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 DeleteCustomizationResponse added in v65.70.0 

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

DeleteCustomizationResponse wrapper for the DeleteCustomization operation

func (DeleteCustomizationResponse) HTTPResponse added in v65.70.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteCustomizationResponse) String added in v65.70.0 

func (response DeleteCustomizationResponse) 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 Entity added in v65.70.0 

type Entity struct {

	// Entity value
	EntityValue *string `mandatory:"true" json:"entityValue"`

	// List of pronunciations (minimum 1, maximum 255)
	Pronunciations []Pronunciation `mandatory:"false" json:"pronunciations"`

	// Entity weight
	Weight *float32 `mandatory:"false" json:"weight"`
}

Entity Entity Object Reference

func (Entity) String added in v65.70.0 

func (m Entity) String() string

func (Entity) ValidateEnumValue added in v65.70.0 

func (m Entity) 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 EntityList added in v65.70.0 

type EntityList struct {

	// Entity Type
	EntityType *string `mandatory:"true" json:"entityType"`

	// Alias of existing customization or to associate with new customization created from entityList.
	Alias *string `mandatory:"false" json:"alias"`

	// Entity type OCID
	Id *string `mandatory:"false" json:"id"`

	// List of entities such as names, words or phrases matching the given entityType to add recognition support for
	Entities []Entity `mandatory:"false" json:"entities"`
}

EntityList List of entities of a given type, to be used to train a customization. Note: If multiple EntityLists are provided, a separate Customization resource will be created for each EntityList.

func (EntityList) String added in v65.70.0 

func (m EntityList) String() string

func (EntityList) ValidateEnumValue added in v65.70.0 

func (m EntityList) 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 EntityListDataset added in v65.70.0 

type EntityListDataset struct {

	// List of sentences referencing 1 or more entityType matching those defined in the linked entityLists, used to improve accuracy by providing model training context of where/how an entity may appear in a sentence.
	// EntityTypes referenced in sentences should be written in all caps surrounded by angled braces (i.e "<PATIENT>" if entityType=patient)
	ReferenceExamples []string `mandatory:"false" json:"referenceExamples"`

	// Array of entityLists
	EntityList []EntityList `mandatory:"false" json:"entityList"`
}

EntityListDataset Entity List Dataset

func (EntityListDataset) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (EntityListDataset) String added in v65.70.0 

func (m EntityListDataset) String() string

func (EntityListDataset) ValidateEnumValue added in v65.70.0 

func (m EntityListDataset) 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 GetCustomizationRequest added in v65.70.0 

type GetCustomizationRequest struct {

	// Unique Customization training Job identifier.
	CustomizationId *string `mandatory:"true" contributesTo:"path" name:"customizationId"`

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

GetCustomizationRequest wrapper for the GetCustomization operation

See also

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

func (GetCustomizationRequest) BinaryRequestBody added in v65.70.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetCustomizationRequest) HTTPRequest added in v65.70.0 

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

HTTPRequest implements the OCIRequest interface

func (GetCustomizationRequest) RetryPolicy added in v65.70.0 

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

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

func (GetCustomizationRequest) String added in v65.70.0 

func (request GetCustomizationRequest) String() string

func (GetCustomizationRequest) ValidateEnumValue added in v65.70.0 

func (request GetCustomizationRequest) 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 GetCustomizationResponse added in v65.70.0 

type GetCustomizationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Customization instance
	Customization `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"`
}

GetCustomizationResponse wrapper for the GetCustomization operation

func (GetCustomizationResponse) HTTPResponse added in v65.70.0 

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

HTTPResponse implements the OCIResponse interface

func (GetCustomizationResponse) String added in v65.70.0 

func (response GetCustomizationResponse) String() string

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 ListCustomizationsRequest added in v65.70.0 

type ListCustomizationsRequest 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 CustomizationLifecycleStateEnum `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 ListCustomizationsSortOrderEnum `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 ListCustomizationsSortByEnum `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
}

ListCustomizationsRequest wrapper for the ListCustomizations operation

See also

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

func (ListCustomizationsRequest) BinaryRequestBody added in v65.70.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListCustomizationsRequest) HTTPRequest added in v65.70.0 

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

HTTPRequest implements the OCIRequest interface

func (ListCustomizationsRequest) RetryPolicy added in v65.70.0 

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

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

func (ListCustomizationsRequest) String added in v65.70.0 

func (request ListCustomizationsRequest) String() string

func (ListCustomizationsRequest) ValidateEnumValue added in v65.70.0 

func (request ListCustomizationsRequest) 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 ListCustomizationsResponse added in v65.70.0 

type ListCustomizationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of CustomizationCollection instances
	CustomizationCollection `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"`
}

ListCustomizationsResponse wrapper for the ListCustomizations operation

func (ListCustomizationsResponse) HTTPResponse added in v65.70.0 

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

HTTPResponse implements the OCIResponse interface

func (ListCustomizationsResponse) String added in v65.70.0 

func (response ListCustomizationsResponse) String() string

type ListCustomizationsSortByEnum added in v65.70.0 

type ListCustomizationsSortByEnum string

ListCustomizationsSortByEnum Enum with underlying type: string 

const (
	ListCustomizationsSortByTimecreated ListCustomizationsSortByEnum = "timeCreated"
	ListCustomizationsSortByDisplayname ListCustomizationsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListCustomizationsSortByEnum

func GetListCustomizationsSortByEnumValues added in v65.70.0 

func GetListCustomizationsSortByEnumValues() []ListCustomizationsSortByEnum

GetListCustomizationsSortByEnumValues Enumerates the set of values for ListCustomizationsSortByEnum

func GetMappingListCustomizationsSortByEnum added in v65.70.0 

func GetMappingListCustomizationsSortByEnum(val string) (ListCustomizationsSortByEnum, bool)

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

type ListCustomizationsSortOrderEnum added in v65.70.0 

type ListCustomizationsSortOrderEnum string

ListCustomizationsSortOrderEnum Enum with underlying type: string 

const (
	ListCustomizationsSortOrderAsc  ListCustomizationsSortOrderEnum = "ASC"
	ListCustomizationsSortOrderDesc ListCustomizationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListCustomizationsSortOrderEnum

func GetListCustomizationsSortOrderEnumValues added in v65.70.0 

func GetListCustomizationsSortOrderEnumValues() []ListCustomizationsSortOrderEnum

GetListCustomizationsSortOrderEnumValues Enumerates the set of values for ListCustomizationsSortOrderEnum

func GetMappingListCustomizationsSortOrderEnum added in v65.70.0 

func GetMappingListCustomizationsSortOrderEnum(val string) (ListCustomizationsSortOrderEnum, bool)

GetMappingListCustomizationsSortOrderEnum 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 LocationDetails added in v65.70.0 

type LocationDetails interface {
}

LocationDetails Possible object storage location types

type LocationDetailsLocationTypeEnum added in v65.70.0 

type LocationDetailsLocationTypeEnum string

LocationDetailsLocationTypeEnum Enum with underlying type: string 

const (
	LocationDetailsLocationTypeObjectList LocationDetailsLocationTypeEnum = "OBJECT_LIST"
)

Set of constants representing the allowable values for LocationDetailsLocationTypeEnum

func GetLocationDetailsLocationTypeEnumValues added in v65.70.0 

func GetLocationDetailsLocationTypeEnumValues() []LocationDetailsLocationTypeEnum

GetLocationDetailsLocationTypeEnumValues Enumerates the set of values for LocationDetailsLocationTypeEnum

func GetMappingLocationDetailsLocationTypeEnum added in v65.70.0 

func GetMappingLocationDetailsLocationTypeEnum(val string) (LocationDetailsLocationTypeEnum, bool)

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

type ObjectListDataset added in v65.70.0 

type ObjectListDataset struct {

	// Object storage bucket name
	BucketName *string `mandatory:"true" json:"bucketName"`

	// Object storage namespace
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// Array of files (minimum 1, maximum 1024) which need to be processed in the bucket
	ObjectNames []string `mandatory:"true" json:"objectNames"`
}

ObjectListDataset Data source details for object storage

func (ObjectListDataset) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (ObjectListDataset) String added in v65.70.0 

func (m ObjectListDataset) String() string

func (ObjectListDataset) ValidateEnumValue added in v65.70.0 

func (m ObjectListDataset) 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 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 (m ObjectListFileInputLocation) String() 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 (m ObjectListInlineInputLocation) String() 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 ObjectStorageDataset added in v65.70.0 

type ObjectStorageDataset struct {
	LocationDetails LocationDetails `mandatory:"true" json:"locationDetails"`

	// Entity Type categorizing the following list of words.
	EntityType *string `mandatory:"false" json:"entityType"`
}

ObjectStorageDataset Object Storage Dataset

func (ObjectStorageDataset) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (ObjectStorageDataset) String added in v65.70.0 

func (m ObjectStorageDataset) String() string

func (*ObjectStorageDataset) UnmarshalJSON added in v65.70.0 

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

UnmarshalJSON unmarshals from json

func (ObjectStorageDataset) ValidateEnumValue added in v65.70.0 

func (m ObjectStorageDataset) 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 (m ProfanityTranscriptionFilter) String() 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 Pronunciation added in v65.70.0 

type Pronunciation struct {

	// Written phonetic representation of entity value
	SoundsLike *string `mandatory:"false" json:"soundsLike"`

	Audio LocationDetails `mandatory:"false" json:"audio"`
}

Pronunciation Pronunciation Object Reference

func (Pronunciation) String added in v65.70.0 

func (m Pronunciation) String() string

func (*Pronunciation) UnmarshalJSON added in v65.70.0 

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

UnmarshalJSON unmarshals from json

func (Pronunciation) ValidateEnumValue added in v65.70.0 

func (m Pronunciation) 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 RealtimeMessage added in v65.70.0 

type RealtimeMessage interface {

	// Session ID for the connected session.
	GetSessionId() *string
}

RealtimeMessage Websocket messages sent between client and service.

type RealtimeMessageAckAudio added in v65.70.0 

type RealtimeMessageAckAudio struct {
	Details *RealtimeMessageAckAudioDetails `mandatory:"true" json:"details"`

	// Session ID for the connected session.
	SessionId *string `mandatory:"false" json:"sessionId"`
}

RealtimeMessageAckAudio The websocket ack message received from service.

func (RealtimeMessageAckAudio) GetSessionId added in v65.70.0 

func (m RealtimeMessageAckAudio) GetSessionId() *string

GetSessionId returns SessionId

func (RealtimeMessageAckAudio) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (RealtimeMessageAckAudio) String added in v65.70.0 

func (m RealtimeMessageAckAudio) String() string

func (RealtimeMessageAckAudio) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageAckAudio) 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 RealtimeMessageAckAudioDetails added in v65.70.0 

type RealtimeMessageAckAudioDetails struct {

	// Sequence number of the acknowledged packet.
	Number *int `mandatory:"true" json:"number"`

	// Offset of the acknowledged packet.
	Offset *int `mandatory:"true" json:"offset"`

	// Length in bytes of the acknowledged packet.
	Length *int `mandatory:"true" json:"length"`
}

RealtimeMessageAckAudioDetails Details object for the websocket ack message received from service.

func (RealtimeMessageAckAudioDetails) String added in v65.70.0 

func (m RealtimeMessageAckAudioDetails) String() string

func (RealtimeMessageAckAudioDetails) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageAckAudioDetails) 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 RealtimeMessageAuthentication added in v65.70.0 

type RealtimeMessageAuthentication interface {

	// Compartment ID to be used for authentication/authorization.
	GetCompartmentId() *string
}

RealtimeMessageAuthentication The payload for authentication.

type RealtimeMessageAuthenticationAuthenticationTypeEnum added in v65.70.0 

type RealtimeMessageAuthenticationAuthenticationTypeEnum string

RealtimeMessageAuthenticationAuthenticationTypeEnum Enum with underlying type: string 

const (
	RealtimeMessageAuthenticationAuthenticationTypeCredentials RealtimeMessageAuthenticationAuthenticationTypeEnum = "CREDENTIALS"
	RealtimeMessageAuthenticationAuthenticationTypeToken       RealtimeMessageAuthenticationAuthenticationTypeEnum = "TOKEN"
)

Set of constants representing the allowable values for RealtimeMessageAuthenticationAuthenticationTypeEnum

func GetMappingRealtimeMessageAuthenticationAuthenticationTypeEnum added in v65.70.0 

func GetMappingRealtimeMessageAuthenticationAuthenticationTypeEnum(val string) (RealtimeMessageAuthenticationAuthenticationTypeEnum, bool)

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

func GetRealtimeMessageAuthenticationAuthenticationTypeEnumValues added in v65.70.0 

func GetRealtimeMessageAuthenticationAuthenticationTypeEnumValues() []RealtimeMessageAuthenticationAuthenticationTypeEnum

GetRealtimeMessageAuthenticationAuthenticationTypeEnumValues Enumerates the set of values for RealtimeMessageAuthenticationAuthenticationTypeEnum

type RealtimeMessageAuthenticationCredentials added in v65.70.0 

type RealtimeMessageAuthenticationCredentials struct {

	// Compartment ID to be used for authentication/authorization.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The signed request header object.
	Headers map[string]string `mandatory:"true" json:"headers"`
}

RealtimeMessageAuthenticationCredentials The payload for credential-based authentication.

func (RealtimeMessageAuthenticationCredentials) GetCompartmentId added in v65.70.0 

func (m RealtimeMessageAuthenticationCredentials) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (RealtimeMessageAuthenticationCredentials) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (RealtimeMessageAuthenticationCredentials) String added in v65.70.0 

func (m RealtimeMessageAuthenticationCredentials) String() string

func (RealtimeMessageAuthenticationCredentials) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageAuthenticationCredentials) 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 RealtimeMessageAuthenticationToken added in v65.70.0 

type RealtimeMessageAuthenticationToken struct {

	// Compartment ID to be used for authentication/authorization.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The token (JWT) obtained from the realtime transcription session endpoint.
	Token *string `mandatory:"true" json:"token"`
}

RealtimeMessageAuthenticationToken The payload for JWT based authentication.

func (RealtimeMessageAuthenticationToken) GetCompartmentId added in v65.70.0 

func (m RealtimeMessageAuthenticationToken) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (RealtimeMessageAuthenticationToken) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (RealtimeMessageAuthenticationToken) String added in v65.70.0 

func (m RealtimeMessageAuthenticationToken) String() string

func (RealtimeMessageAuthenticationToken) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageAuthenticationToken) 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 RealtimeMessageConnect added in v65.70.0 

type RealtimeMessageConnect struct {

	// Session ID for the connected session.
	SessionId *string `mandatory:"false" json:"sessionId"`
}

RealtimeMessageConnect The websocket connection message received from service.

func (RealtimeMessageConnect) GetSessionId added in v65.70.0 

func (m RealtimeMessageConnect) GetSessionId() *string

GetSessionId returns SessionId

func (RealtimeMessageConnect) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (RealtimeMessageConnect) String added in v65.70.0 

func (m RealtimeMessageConnect) String() string

func (RealtimeMessageConnect) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageConnect) 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 RealtimeMessageError added in v65.70.0 

type RealtimeMessageError struct {

	// Error code.
	Code *int `mandatory:"true" json:"code"`

	// Error message.
	Message *string `mandatory:"true" json:"message"`

	// Session ID for the connected session.
	SessionId *string `mandatory:"false" json:"sessionId"`
}

RealtimeMessageError The websocket error message received from service.

func (RealtimeMessageError) GetSessionId added in v65.70.0 

func (m RealtimeMessageError) GetSessionId() *string

GetSessionId returns SessionId

func (RealtimeMessageError) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (RealtimeMessageError) String added in v65.70.0 

func (m RealtimeMessageError) String() string

func (RealtimeMessageError) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageError) 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 RealtimeMessageEventEnum added in v65.70.0 

type RealtimeMessageEventEnum string

RealtimeMessageEventEnum Enum with underlying type: string 

const (
	RealtimeMessageEventResult   RealtimeMessageEventEnum = "RESULT"
	RealtimeMessageEventAckaudio RealtimeMessageEventEnum = "ACKAUDIO"
	RealtimeMessageEventError    RealtimeMessageEventEnum = "ERROR"
	RealtimeMessageEventConnect  RealtimeMessageEventEnum = "CONNECT"
)

Set of constants representing the allowable values for RealtimeMessageEventEnum

func GetMappingRealtimeMessageEventEnum added in v65.70.0 

func GetMappingRealtimeMessageEventEnum(val string) (RealtimeMessageEventEnum, bool)

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

func GetRealtimeMessageEventEnumValues added in v65.70.0 

func GetRealtimeMessageEventEnumValues() []RealtimeMessageEventEnum

GetRealtimeMessageEventEnumValues Enumerates the set of values for RealtimeMessageEventEnum

type RealtimeMessageOut added in v65.70.0 

type RealtimeMessageOut interface {
}

RealtimeMessageOut Websocket messages sent by client to the service.

type RealtimeMessageOutEventEnum added in v65.70.0 

type RealtimeMessageOutEventEnum string

RealtimeMessageOutEventEnum Enum with underlying type: string 

const (
	RealtimeMessageOutEventSendFinalResult RealtimeMessageOutEventEnum = "SEND_FINAL_RESULT"
)

Set of constants representing the allowable values for RealtimeMessageOutEventEnum

func GetMappingRealtimeMessageOutEventEnum added in v65.70.0 

func GetMappingRealtimeMessageOutEventEnum(val string) (RealtimeMessageOutEventEnum, bool)

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

func GetRealtimeMessageOutEventEnumValues added in v65.70.0 

func GetRealtimeMessageOutEventEnumValues() []RealtimeMessageOutEventEnum

GetRealtimeMessageOutEventEnumValues Enumerates the set of values for RealtimeMessageOutEventEnum

type RealtimeMessageResult added in v65.70.0 

type RealtimeMessageResult struct {

	// List of transcription objects.
	Transcriptions []RealtimeMessageResultTranscription `mandatory:"true" json:"transcriptions"`

	// Session ID for the connected session.
	SessionId *string `mandatory:"false" json:"sessionId"`
}

RealtimeMessageResult The websocket result message received from service.

func (RealtimeMessageResult) GetSessionId added in v65.70.0 

func (m RealtimeMessageResult) GetSessionId() *string

GetSessionId returns SessionId

func (RealtimeMessageResult) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (RealtimeMessageResult) String added in v65.70.0 

func (m RealtimeMessageResult) String() string

func (RealtimeMessageResult) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageResult) 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 RealtimeMessageResultTranscription added in v65.70.0 

type RealtimeMessageResultTranscription struct {

	// Transcription text.
	Transcription *string `mandatory:"true" json:"transcription"`

	// Whether the transcription is final or partial.
	IsFinal *bool `mandatory:"true" json:"isFinal"`

	// Start time in milliseconds for the transcription text.
	StartTimeInMs *int `mandatory:"true" json:"startTimeInMs"`

	// End time in milliseconds for the transcription text.
	EndTimeInMs *int `mandatory:"true" json:"endTimeInMs"`

	// Confidence for the transcription text.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	// Trailing silence after the transcription text.
	TrailingSilence *int `mandatory:"true" json:"trailingSilence"`

	// Array of individual transcription tokens.
	Tokens []RealtimeMessageResultTranscriptionToken `mandatory:"true" json:"tokens"`
}

RealtimeMessageResultTranscription Transcription object.

func (RealtimeMessageResultTranscription) String added in v65.70.0 

func (m RealtimeMessageResultTranscription) String() string

func (RealtimeMessageResultTranscription) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageResultTranscription) 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 RealtimeMessageResultTranscriptionToken added in v65.70.0 

type RealtimeMessageResultTranscriptionToken struct {

	// Transcription token.
	Token *string `mandatory:"true" json:"token"`

	// Start time in milliseconds for the transcription token.
	StartTimeInMs *int `mandatory:"true" json:"startTimeInMs"`

	// End time in milliseconds for the transcription token.
	EndTimeInMs *int `mandatory:"true" json:"endTimeInMs"`

	// Confidence score for the transcription token.
	Confidence *float32 `mandatory:"true" json:"confidence"`

	// Type of the transcription token.
	Type RealtimeMessageResultTranscriptionTokenTypeEnum `mandatory:"true" json:"type"`
}

RealtimeMessageResultTranscriptionToken Individual transcription tokens.

func (RealtimeMessageResultTranscriptionToken) String added in v65.70.0 

func (m RealtimeMessageResultTranscriptionToken) String() string

func (RealtimeMessageResultTranscriptionToken) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageResultTranscriptionToken) 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 RealtimeMessageResultTranscriptionTokenTypeEnum added in v65.70.0 

type RealtimeMessageResultTranscriptionTokenTypeEnum string

RealtimeMessageResultTranscriptionTokenTypeEnum Enum with underlying type: string 

const (
	RealtimeMessageResultTranscriptionTokenTypeWord        RealtimeMessageResultTranscriptionTokenTypeEnum = "WORD"
	RealtimeMessageResultTranscriptionTokenTypePunctuation RealtimeMessageResultTranscriptionTokenTypeEnum = "PUNCTUATION"
)

Set of constants representing the allowable values for RealtimeMessageResultTranscriptionTokenTypeEnum

func GetMappingRealtimeMessageResultTranscriptionTokenTypeEnum added in v65.70.0 

func GetMappingRealtimeMessageResultTranscriptionTokenTypeEnum(val string) (RealtimeMessageResultTranscriptionTokenTypeEnum, bool)

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

func GetRealtimeMessageResultTranscriptionTokenTypeEnumValues added in v65.70.0 

func GetRealtimeMessageResultTranscriptionTokenTypeEnumValues() []RealtimeMessageResultTranscriptionTokenTypeEnum

GetRealtimeMessageResultTranscriptionTokenTypeEnumValues Enumerates the set of values for RealtimeMessageResultTranscriptionTokenTypeEnum

type RealtimeMessageSendFinalResult added in v65.70.0 

type RealtimeMessageSendFinalResult struct {
}

RealtimeMessageSendFinalResult Tell service to send final result

func (RealtimeMessageSendFinalResult) MarshalJSON added in v65.70.0 

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

MarshalJSON marshals to json representation

func (RealtimeMessageSendFinalResult) String added in v65.70.0 

func (m RealtimeMessageSendFinalResult) String() string

func (RealtimeMessageSendFinalResult) ValidateEnumValue added in v65.70.0 

func (m RealtimeMessageSendFinalResult) 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 RealtimeModelDetails added in v65.70.0 

type RealtimeModelDetails struct {

	// Model Domain.
	Domain RealtimeModelDetailsDomainEnum `mandatory:"false" json:"domain,omitempty"`

	// Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].
	// - en-US: English - United States
	// - es-ES: Spanish - Spain
	// - pt-BR: Portuguese - Brazil
	// - en-GB: English - Great Britain
	// - en-AU: English - Australia
	// - en-IN: English - India
	// - hi-IN: Hindi - India
	// - fr-FR: French - France
	// - de-DE: German - Germany
	// - it-IT: Italian - Italy
	LanguageCode *string `mandatory:"false" json:"languageCode"`
}

RealtimeModelDetails Details of the ASR model used by the realtime speech service.

func (RealtimeModelDetails) String added in v65.70.0 

func (m RealtimeModelDetails) String() string

func (RealtimeModelDetails) ValidateEnumValue added in v65.70.0 

func (m RealtimeModelDetails) 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 RealtimeModelDetailsDomainEnum added in v65.70.0 

type RealtimeModelDetailsDomainEnum string

RealtimeModelDetailsDomainEnum Enum with underlying type: string 

const (
	RealtimeModelDetailsDomainGeneric RealtimeModelDetailsDomainEnum = "GENERIC"
	RealtimeModelDetailsDomainMedical RealtimeModelDetailsDomainEnum = "MEDICAL"
)

Set of constants representing the allowable values for RealtimeModelDetailsDomainEnum

func GetMappingRealtimeModelDetailsDomainEnum added in v65.70.0 

func GetMappingRealtimeModelDetailsDomainEnum(val string) (RealtimeModelDetailsDomainEnum, bool)

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

func GetRealtimeModelDetailsDomainEnumValues added in v65.70.0 

func GetRealtimeModelDetailsDomainEnumValues() []RealtimeModelDetailsDomainEnum

GetRealtimeModelDetailsDomainEnumValues Enumerates the set of values for RealtimeModelDetailsDomainEnum

type RealtimeParameters added in v65.70.0 

type RealtimeParameters struct {

	// Audio encoding to use
	// - audio/raw;rate=16000
	// - audio/raw;rate=8000
	// - audio/raw;rate=8000;codec=mulaw
	// - audio/raw;rate=8000;codec=alaw
	Encoding *string `mandatory:"false" json:"encoding"`

	// Toggle for ack messages.
	IsAckEnabled *bool `mandatory:"false" json:"isAckEnabled"`

	// Silence threshold for Realtime Speech partial results in milliseconds.
	PartialSilenceThresholdInMs *int `mandatory:"false" json:"partialSilenceThresholdInMs"`

	// Silence threshold for Realtime Speech final results in milliseconds.
	FinalSilenceThresholdInMs *int `mandatory:"false" json:"finalSilenceThresholdInMs"`

	// When enabled sets the amount of confidence required for latest tokens before returning them as part of a new partial result
	StabilizePartialResults RealtimeParametersStabilizePartialResultsEnum `mandatory:"false" json:"stabilizePartialResults,omitempty"`

	// Model Domain.
	ModelDomain RealtimeParametersModelDomainEnum `mandatory:"false" json:"modelDomain,omitempty"`

	// Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].
	// - en-US: English - United States
	// - es-ES: Spanish - Spain
	// - pt-BR: Portuguese - Brazil
	// - en-GB: English - Great Britain
	// - en-AU: English - Australia
	// - en-IN: English - India
	// - hi-IN: Hindi - India
	// - fr-FR: French - France
	// - de-DE: German - Germany
	// - it-IT: Italian - Italy
	LanguageCode *string `mandatory:"false" json:"languageCode"`

	// If set to true, the service will not fail connection attempt if it encounters any issues that prevent the loading of all specified user customizations. Any invalid customizations will simply be ignored and connection will continue being established with the default base model and any remaining valid customizations.
	// If set to false,  if the service is unable to load any of the specified customizations, an error detailing why will be returned and the session will end.
	ShouldIgnoreInvalidCustomizations *bool `mandatory:"false" json:"shouldIgnoreInvalidCustomizations"`

	// Array of customization objects.
	Customizations []CustomizationInference `mandatory:"false" json:"customizations"`
}

RealtimeParameters Parameters to be sent to the realtime speech service over a websocket connection.

func (RealtimeParameters) String added in v65.70.0 

func (m RealtimeParameters) String() string

func (RealtimeParameters) ValidateEnumValue added in v65.70.0 

func (m RealtimeParameters) 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 RealtimeParametersModelDomainEnum added in v65.70.0 

type RealtimeParametersModelDomainEnum string

RealtimeParametersModelDomainEnum Enum with underlying type: string 

const (
	RealtimeParametersModelDomainGeneric RealtimeParametersModelDomainEnum = "GENERIC"
	RealtimeParametersModelDomainMedical RealtimeParametersModelDomainEnum = "MEDICAL"
)

Set of constants representing the allowable values for RealtimeParametersModelDomainEnum

func GetMappingRealtimeParametersModelDomainEnum added in v65.70.0 

func GetMappingRealtimeParametersModelDomainEnum(val string) (RealtimeParametersModelDomainEnum, bool)

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

func GetRealtimeParametersModelDomainEnumValues added in v65.70.0 

func GetRealtimeParametersModelDomainEnumValues() []RealtimeParametersModelDomainEnum

GetRealtimeParametersModelDomainEnumValues Enumerates the set of values for RealtimeParametersModelDomainEnum

type RealtimeParametersStabilizePartialResultsEnum added in v65.70.0 

type RealtimeParametersStabilizePartialResultsEnum string

RealtimeParametersStabilizePartialResultsEnum Enum with underlying type: string 

const (
	RealtimeParametersStabilizePartialResultsNone   RealtimeParametersStabilizePartialResultsEnum = "NONE"
	RealtimeParametersStabilizePartialResultsLow    RealtimeParametersStabilizePartialResultsEnum = "LOW"
	RealtimeParametersStabilizePartialResultsMedium RealtimeParametersStabilizePartialResultsEnum = "MEDIUM"
	RealtimeParametersStabilizePartialResultsHigh   RealtimeParametersStabilizePartialResultsEnum = "HIGH"
)

Set of constants representing the allowable values for RealtimeParametersStabilizePartialResultsEnum

func GetMappingRealtimeParametersStabilizePartialResultsEnum added in v65.70.0 

func GetMappingRealtimeParametersStabilizePartialResultsEnum(val string) (RealtimeParametersStabilizePartialResultsEnum, bool)

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

func GetRealtimeParametersStabilizePartialResultsEnumValues added in v65.70.0 

func GetRealtimeParametersStabilizePartialResultsEnumValues() []RealtimeParametersStabilizePartialResultsEnum

GetRealtimeParametersStabilizePartialResultsEnumValues Enumerates the set of values for RealtimeParametersStabilizePartialResultsEnum

type RealtimeSessionToken added in v65.70.0 

type RealtimeSessionToken struct {

	// The session token (JWT) to be consumed by the websocket server. The token contains the session/tenant ID, as well as the expiry time.
	Token *string `mandatory:"true" json:"token"`

	// The session ID this token corresponds to. Provided for convenience, the session ID is already present in the JWT token.
	SessionId *string `mandatory:"true" json:"sessionId"`

	// Compartment ID that was used to create the token.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

RealtimeSessionToken The response from the realtime session token endpoint that creates the auth token to be used with the realtime speech service.

func (RealtimeSessionToken) String added in v65.70.0 

func (m RealtimeSessionToken) String() string

func (RealtimeSessionToken) ValidateEnumValue added in v65.70.0 

func (m RealtimeSessionToken) 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 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 (m TranscriptionJobCollection) String() 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 (m TranscriptionNormalization) String() 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 (m TranscriptionTaskCollection) String() 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 UpdateCustomizationDetails added in v65.70.0 

type UpdateCustomizationDetails struct {

	// Customization Details Alias
	Alias *string `mandatory:"false" json:"alias"`

	// A user-friendly display name for the customization.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A short description of the customization.
	Description *string `mandatory:"false" json:"description"`

	ModelDetails *CustomizationModelDetails `mandatory:"false" json:"modelDetails"`

	TrainingDataset CustomizationDatasetDetails `mandatory:"false" json:"trainingDataset"`

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

UpdateCustomizationDetails The information to be updated.

func (UpdateCustomizationDetails) String added in v65.70.0 

func (m UpdateCustomizationDetails) String() string

func (*UpdateCustomizationDetails) UnmarshalJSON added in v65.70.0 

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

UnmarshalJSON unmarshals from json

func (UpdateCustomizationDetails) ValidateEnumValue added in v65.70.0 

func (m UpdateCustomizationDetails) 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 UpdateCustomizationRequest added in v65.70.0 

type UpdateCustomizationRequest struct {

	// Unique Customization training Job identifier.
	CustomizationId *string `mandatory:"true" contributesTo:"path" name:"customizationId"`

	// The information to be updated.
	UpdateCustomizationDetails `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
}

UpdateCustomizationRequest wrapper for the UpdateCustomization operation

See also

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

func (UpdateCustomizationRequest) BinaryRequestBody added in v65.70.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateCustomizationRequest) HTTPRequest added in v65.70.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateCustomizationRequest) RetryPolicy added in v65.70.0 

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

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

func (UpdateCustomizationRequest) String added in v65.70.0 

func (request UpdateCustomizationRequest) String() string

func (UpdateCustomizationRequest) ValidateEnumValue added in v65.70.0 

func (request UpdateCustomizationRequest) 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 UpdateCustomizationResponse added in v65.70.0 

type UpdateCustomizationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Customization instance
	Customization `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"`
}

UpdateCustomizationResponse wrapper for the UpdateCustomization operation

func (UpdateCustomizationResponse) HTTPResponse added in v65.70.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateCustomizationResponse) String added in v65.70.0 

func (response UpdateCustomizationResponse) String() string

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 (m UpdateTranscriptionJobDetails) String() 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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.