func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetBatchDetectLanguageSentimentsLevelEnumStringValues() []string
GetBatchDetectLanguageSentimentsLevelEnumStringValues Enumerates the set of values in String for BatchDetectLanguageSentimentsLevelEnum
func GetClassificationTypeClassificationModeEnumStringValues() []string
GetClassificationTypeClassificationModeEnumStringValues Enumerates the set of values in String for ClassificationTypeClassificationModeEnum
func GetCreateEndpointDetailsComputeTypeEnumStringValues() []string
GetCreateEndpointDetailsComputeTypeEnumStringValues Enumerates the set of values in String for CreateEndpointDetailsComputeTypeEnum
func GetDatasetDetailsDatasetTypeEnumStringValues() []string
GetDatasetDetailsDatasetTypeEnumStringValues Enumerates the set of values in String for DatasetDetailsDatasetTypeEnum
func GetDetectLanguageEntitiesModelVersionEnumStringValues() []string
GetDetectLanguageEntitiesModelVersionEnumStringValues Enumerates the set of values in String for DetectLanguageEntitiesModelVersionEnum
func GetEndpointComputeTypeEnumStringValues() []string
GetEndpointComputeTypeEnumStringValues Enumerates the set of values in String for EndpointComputeTypeEnum
func GetEndpointLifecycleStateEnumStringValues() []string
GetEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for EndpointLifecycleStateEnum
func GetEndpointSummaryComputeTypeEnumStringValues() []string
GetEndpointSummaryComputeTypeEnumStringValues Enumerates the set of values in String for EndpointSummaryComputeTypeEnum
func GetInputLocationLocationTypeEnumStringValues() []string
GetInputLocationLocationTypeEnumStringValues Enumerates the set of values in String for InputLocationLocationTypeEnum
func GetJobLifecycleStateEnumStringValues() []string
GetJobLifecycleStateEnumStringValues Enumerates the set of values in String for JobLifecycleStateEnum
func GetListEndpointsSortByEnumStringValues() []string
GetListEndpointsSortByEnumStringValues Enumerates the set of values in String for ListEndpointsSortByEnum
func GetListEndpointsSortOrderEnumStringValues() []string
GetListEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListEndpointsSortOrderEnum
func GetListJobsSortByEnumStringValues() []string
GetListJobsSortByEnumStringValues Enumerates the set of values in String for ListJobsSortByEnum
func GetListJobsSortOrderEnumStringValues() []string
GetListJobsSortOrderEnumStringValues Enumerates the set of values in String for ListJobsSortOrderEnum
func GetListModelsSortByEnumStringValues() []string
GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum
func GetListModelsSortOrderEnumStringValues() []string
GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum
func GetListProjectsSortByEnumStringValues() []string
GetListProjectsSortByEnumStringValues Enumerates the set of values in String for ListProjectsSortByEnum
func GetListProjectsSortOrderEnumStringValues() []string
GetListProjectsSortOrderEnumStringValues Enumerates the set of values in String for ListProjectsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetLocationDetailsLocationTypeEnumStringValues() []string
GetLocationDetailsLocationTypeEnumStringValues Enumerates the set of values in String for LocationDetailsLocationTypeEnum
func GetModelDetailsModelTypeEnumStringValues() []string
GetModelDetailsModelTypeEnumStringValues Enumerates the set of values in String for ModelDetailsModelTypeEnum
func GetModelLifecycleStateEnumStringValues() []string
GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum
func GetNerModelVersionEnumStringValues() []string
GetNerModelVersionEnumStringValues Enumerates the set of values in String for NerModelVersionEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPiiEntityMaskingModeEnumStringValues() []string
GetPiiEntityMaskingModeEnumStringValues Enumerates the set of values in String for PiiEntityMaskingModeEnum
func GetProjectLifecycleStateEnumStringValues() []string
GetProjectLifecycleStateEnumStringValues Enumerates the set of values in String for ProjectLifecycleStateEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetTestStrategyStrategyTypeEnumStringValues() []string
GetTestStrategyStrategyTypeEnumStringValues Enumerates the set of values in String for TestStrategyStrategyTypeEnum
AIServiceLanguageClient a client for AIServiceLanguage
type AIServiceLanguageClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewAIServiceLanguageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AIServiceLanguageClient, err error)
NewAIServiceLanguageClientWithConfigurationProvider Creates a new default AIServiceLanguage client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewAIServiceLanguageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AIServiceLanguageClient, err error)
NewAIServiceLanguageClientWithOboToken Creates a new default AIServiceLanguage client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client AIServiceLanguageClient) BatchDetectDominantLanguage(ctx context.Context, request BatchDetectDominantLanguageRequest) (response BatchDetectDominantLanguageResponse, err error)
BatchDetectDominantLanguage The API returns the detected language and a related confidence score (between 0 and 1). It supports passing a batch of records. List of supported languages. (https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect) Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectDominantLanguage.go.html to see an example of how to use BatchDetectDominantLanguage API.
func (client AIServiceLanguageClient) BatchDetectHealthEntity(ctx context.Context, request BatchDetectHealthEntityRequest) (response BatchDetectHealthEntityResponse, err error)
BatchDetectHealthEntity The API extracts health entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records. Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectHealthEntity.go.html to see an example of how to use BatchDetectHealthEntity API.
func (client AIServiceLanguageClient) BatchDetectLanguageEntities(ctx context.Context, request BatchDetectLanguageEntitiesRequest) (response BatchDetectLanguageEntitiesResponse, err error)
BatchDetectLanguageEntities The API extracts entities in text records. For each entity, its type/subtype and confidence score (between 0 and 1) is returned. It supports passing a batch of records. List of supported entities. (https://docs.oracle.com/iaas/language/using/pretrain-models.htm#ner__sup-ner-entity) Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageEntities.go.html to see an example of how to use BatchDetectLanguageEntities API.
func (client AIServiceLanguageClient) BatchDetectLanguageKeyPhrases(ctx context.Context, request BatchDetectLanguageKeyPhrasesRequest) (response BatchDetectLanguageKeyPhrasesResponse, err error)
BatchDetectLanguageKeyPhrases The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text. It supports passing a batch of records. Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageKeyPhrases.go.html to see an example of how to use BatchDetectLanguageKeyPhrases API.
func (client AIServiceLanguageClient) BatchDetectLanguagePiiEntities(ctx context.Context, request BatchDetectLanguagePiiEntitiesRequest) (response BatchDetectLanguagePiiEntitiesResponse, err error)
BatchDetectLanguagePiiEntities The API extracts pii entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records. Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguagePiiEntities.go.html to see an example of how to use BatchDetectLanguagePiiEntities API.
func (client AIServiceLanguageClient) BatchDetectLanguageSentiments(ctx context.Context, request BatchDetectLanguageSentimentsRequest) (response BatchDetectLanguageSentimentsResponse, err error)
BatchDetectLanguageSentiments The API extracts aspect-based and sentence level sentiment in text records. For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned for each record. Similarly, for sentence-level sentiment analysis, the sentiment is returned at the sentence level. For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed). Learn more about sentiment analysis here (https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment). Limitations:
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageSentiments.go.html to see an example of how to use BatchDetectLanguageSentiments API.
func (client AIServiceLanguageClient) BatchDetectLanguageTextClassification(ctx context.Context, request BatchDetectLanguageTextClassificationRequest) (response BatchDetectLanguageTextClassificationResponse, err error)
BatchDetectLanguageTextClassification The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified. It supports passing a batch of records. Learn more about text classification here (https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class). Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageTextClassification.go.html to see an example of how to use BatchDetectLanguageTextClassification API.
func (client AIServiceLanguageClient) BatchLanguageTranslation(ctx context.Context, request BatchLanguageTranslationRequest) (response BatchLanguageTranslationResponse, err error)
BatchLanguageTranslation Translates a batch of text documents from source to target language. A batch can contain:
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchLanguageTranslation.go.html to see an example of how to use BatchLanguageTranslation API.
func (client AIServiceLanguageClient) CancelJob(ctx context.Context, request CancelJobRequest) (response CancelJobResponse, err error)
CancelJob Canceling the job cancels all the tasks under it.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CancelJob.go.html to see an example of how to use CancelJob API. A default retry strategy applies to this operation CancelJob()
func (client AIServiceLanguageClient) ChangeEndpointCompartment(ctx context.Context, request ChangeEndpointCompartmentRequest) (response ChangeEndpointCompartmentResponse, err error)
ChangeEndpointCompartment Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeEndpointCompartment.go.html to see an example of how to use ChangeEndpointCompartment API. A default retry strategy applies to this operation ChangeEndpointCompartment()
func (client AIServiceLanguageClient) ChangeJobCompartment(ctx context.Context, request ChangeJobCompartmentRequest) (response ChangeJobCompartmentResponse, err error)
ChangeJobCompartment Moves a Job into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeJobCompartment.go.html to see an example of how to use ChangeJobCompartment API. A default retry strategy applies to this operation ChangeJobCompartment()
func (client AIServiceLanguageClient) ChangeModelCompartment(ctx context.Context, request ChangeModelCompartmentRequest) (response ChangeModelCompartmentResponse, err error)
ChangeModelCompartment Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartment API. A default retry strategy applies to this operation ChangeModelCompartment()
func (client AIServiceLanguageClient) ChangeProjectCompartment(ctx context.Context, request ChangeProjectCompartmentRequest) (response ChangeProjectCompartmentResponse, err error)
ChangeProjectCompartment Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeProjectCompartment.go.html to see an example of how to use ChangeProjectCompartment API. A default retry strategy applies to this operation ChangeProjectCompartment()
func (client *AIServiceLanguageClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client AIServiceLanguageClient) CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (response CreateEndpointResponse, err error)
CreateEndpoint Creates a new endpoint and deploy the trained model
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateEndpoint.go.html to see an example of how to use CreateEndpoint API. A default retry strategy applies to this operation CreateEndpoint()
func (client AIServiceLanguageClient) CreateJob(ctx context.Context, request CreateJobRequest) (response CreateJobResponse, err error)
CreateJob Creates a new language service async job.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateJob.go.html to see an example of how to use CreateJob API. A default retry strategy applies to this operation CreateJob()
func (client AIServiceLanguageClient) CreateModel(ctx context.Context, request CreateModelRequest) (response CreateModelResponse, err error)
CreateModel Creates a new model for training and train the model with date provided.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateModel.go.html to see an example of how to use CreateModel API. A default retry strategy applies to this operation CreateModel()
func (client AIServiceLanguageClient) CreateProject(ctx context.Context, request CreateProjectRequest) (response CreateProjectResponse, err error)
CreateProject Creates a new Project.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateProject.go.html to see an example of how to use CreateProject API. A default retry strategy applies to this operation CreateProject()
func (client AIServiceLanguageClient) DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) (response DeleteEndpointResponse, err error)
DeleteEndpoint Deletes a provisioned endpoint resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteEndpoint.go.html to see an example of how to use DeleteEndpoint API. A default retry strategy applies to this operation DeleteEndpoint()
func (client AIServiceLanguageClient) DeleteJob(ctx context.Context, request DeleteJobRequest) (response DeleteJobResponse, err error)
DeleteJob Deletes the language service async Job
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteJob.go.html to see an example of how to use DeleteJob API. A default retry strategy applies to this operation DeleteJob()
func (client AIServiceLanguageClient) DeleteModel(ctx context.Context, request DeleteModelRequest) (response DeleteModelResponse, err error)
DeleteModel Deletes a provisioned model resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteModel.go.html to see an example of how to use DeleteModel API. A default retry strategy applies to this operation DeleteModel()
func (client AIServiceLanguageClient) DeleteProject(ctx context.Context, request DeleteProjectRequest) (response DeleteProjectResponse, err error)
DeleteProject Deletes a Project resource by identifier. This operation fails with a 409 error unless all associated resources (models deployments or data assets) are in a DELETED state. You must delete all associated resources before deleting a project.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteProject.go.html to see an example of how to use DeleteProject API. A default retry strategy applies to this operation DeleteProject()
func (client AIServiceLanguageClient) DetectDominantLanguage(ctx context.Context, request DetectDominantLanguageRequest) (response DetectDominantLanguageResponse, err error)
DetectDominantLanguage **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT. We recommend you replace this API with the batch API, BatchDetectDominantLanguage (https://docs.oracle.com/iaas/api/#/en/language/20221001/BatchDetectDominantLanguage/BatchDetectDominantLanguage). The DetectDominantLanguage API returns the detected language and a related confidence score (between 0 and 1). List of supported languages (https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect) Limitations: - A record may be up to 1000 characters long.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectDominantLanguage.go.html to see an example of how to use DetectDominantLanguage API.
func (client AIServiceLanguageClient) DetectLanguageEntities(ctx context.Context, request DetectLanguageEntitiesRequest) (response DetectLanguageEntitiesResponse, err error)
DetectLanguageEntities **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT. We recommend you replace this API with the batch API, BatchDetectLanguageEntities (https://docs.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageEntities/BatchDetectLanguageEntities). The DetectLanguageEntities API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. Limitations: - A text may be up to 1000 characters long.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageEntities.go.html to see an example of how to use DetectLanguageEntities API.
func (client AIServiceLanguageClient) DetectLanguageKeyPhrases(ctx context.Context, request DetectLanguageKeyPhrasesRequest) (response DetectLanguageKeyPhrasesResponse, err error)
DetectLanguageKeyPhrases **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
We recommend you replace this API with the batch API, BatchDetectLanguageKeyPhrases (https://docs.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageKeyPhrases/BatchDetectLanguageKeyPhrases). The DetectLanguageKeyPhrases API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text.
Limitations: - A record may be up to 1000 characters long.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageKeyPhrases.go.html to see an example of how to use DetectLanguageKeyPhrases API.
func (client AIServiceLanguageClient) DetectLanguageSentiments(ctx context.Context, request DetectLanguageSentimentsRequest) (response DetectLanguageSentimentsResponse, err error)
DetectLanguageSentiments **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT. We recommend you replace this API with the batch API, BatchDetectLanguageSentiments (https://docs.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageSentiments/BatchDetectLanguageSentiments). The DetectLanguageSentiments API extracts aspect-based in text records. For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned. For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral). Learn more about sentiment analysis here (https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment). Limitations:
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageSentiments.go.html to see an example of how to use DetectLanguageSentiments API.
func (client AIServiceLanguageClient) DetectLanguageTextClassification(ctx context.Context, request DetectLanguageTextClassificationRequest) (response DetectLanguageTextClassificationResponse, err error)
DetectLanguageTextClassification **Deprecated**: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT. We recommend you replace this API with the batch API, BatchDetectLanguageTextClassification (https://docs.oracle.com/iaas/api/#/en/language/20221001/BatchDetectLanguageTextClassification/BatchDetectLanguageTextClassification). The DetectLanguageTextClassification API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified. Learn more about text classification here (https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class). Limitations: - A record may be up to 1000 characters long.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageTextClassification.go.html to see an example of how to use DetectLanguageTextClassification API.
func (client AIServiceLanguageClient) GetEndpoint(ctx context.Context, request GetEndpointRequest) (response GetEndpointResponse, err error)
GetEndpoint Gets an endpoint by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetEndpoint.go.html to see an example of how to use GetEndpoint API. A default retry strategy applies to this operation GetEndpoint()
func (client AIServiceLanguageClient) GetJob(ctx context.Context, request GetJobRequest) (response GetJobResponse, err error)
GetJob Gets a language service async job
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetJob.go.html to see an example of how to use GetJob API. A default retry strategy applies to this operation GetJob()
func (client AIServiceLanguageClient) GetModel(ctx context.Context, request GetModelRequest) (response GetModelResponse, err error)
GetModel Gets a model by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetModel.go.html to see an example of how to use GetModel API. A default retry strategy applies to this operation GetModel()
func (client AIServiceLanguageClient) GetModelType(ctx context.Context, request GetModelTypeRequest) (response GetModelTypeResponse, err error)
GetModelType Gets model capabilities
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetModelType.go.html to see an example of how to use GetModelType API. A default retry strategy applies to this operation GetModelType()
func (client AIServiceLanguageClient) GetProject(ctx context.Context, request GetProjectRequest) (response GetProjectResponse, err error)
GetProject Gets a Project by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetProject.go.html to see an example of how to use GetProject API. A default retry strategy applies to this operation GetProject()
func (client AIServiceLanguageClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client AIServiceLanguageClient) ListEndpoints(ctx context.Context, request ListEndpointsRequest) (response ListEndpointsResponse, err error)
ListEndpoints Returns a list of Endpoints.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListEndpoints.go.html to see an example of how to use ListEndpoints API. A default retry strategy applies to this operation ListEndpoints()
func (client AIServiceLanguageClient) ListEvaluationResults(ctx context.Context, request ListEvaluationResultsRequest) (response ListEvaluationResultsResponse, err error)
ListEvaluationResults Get a (paginated) list of evaluation results for a given model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListEvaluationResults.go.html to see an example of how to use ListEvaluationResults API. A default retry strategy applies to this operation ListEvaluationResults()
func (client AIServiceLanguageClient) ListJobs(ctx context.Context, request ListJobsRequest) (response ListJobsResponse, err error)
ListJobs Returns a list of language service async Jobs.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListJobs.go.html to see an example of how to use ListJobs API. A default retry strategy applies to this operation ListJobs()
func (client AIServiceLanguageClient) ListModels(ctx context.Context, request ListModelsRequest) (response ListModelsResponse, err error)
ListModels Returns a list of models.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListModels.go.html to see an example of how to use ListModels API. A default retry strategy applies to this operation ListModels()
func (client AIServiceLanguageClient) ListProjects(ctx context.Context, request ListProjectsRequest) (response ListProjectsResponse, err error)
ListProjects Returns a list of Projects.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListProjects.go.html to see an example of how to use ListProjects API. A default retry strategy applies to this operation ListProjects()
func (client AIServiceLanguageClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client AIServiceLanguageClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client AIServiceLanguageClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *AIServiceLanguageClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client AIServiceLanguageClient) UpdateEndpoint(ctx context.Context, request UpdateEndpointRequest) (response UpdateEndpointResponse, err error)
UpdateEndpoint Update the Endpoint identified by the id
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateEndpoint.go.html to see an example of how to use UpdateEndpoint API. A default retry strategy applies to this operation UpdateEndpoint()
func (client AIServiceLanguageClient) UpdateJob(ctx context.Context, request UpdateJobRequest) (response UpdateJobResponse, err error)
UpdateJob Updates the language service async Job
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateJob.go.html to see an example of how to use UpdateJob API. A default retry strategy applies to this operation UpdateJob()
func (client AIServiceLanguageClient) UpdateModel(ctx context.Context, request UpdateModelRequest) (response UpdateModelResponse, err error)
UpdateModel Updates the model
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateModel.go.html to see an example of how to use UpdateModel API. A default retry strategy applies to this operation UpdateModel()
func (client AIServiceLanguageClient) UpdateProject(ctx context.Context, request UpdateProjectRequest) (response UpdateProjectResponse, err error)
UpdateProject Updates the Project
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateProject.go.html to see an example of how to use UpdateProject API. A default retry strategy applies to this operation UpdateProject()
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AssertionDetails The assertion details for health ner.
type AssertionDetails struct {
// id of the relation
Id *string `mandatory:"true" json:"id"`
// type of assertion ex, Status, Certainty, Temporality, Actor, etc.
Type *string `mandatory:"true" json:"type"`
// Possible value for assertion type
Value *string `mandatory:"true" json:"value"`
// Score or confidence for health detected entity.
Score *float64 `mandatory:"true" json:"score"`
}
func (m AssertionDetails) String() string
func (m AssertionDetails) 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
BatchDetectDominantLanguageDetails The documents details for language detect call.
type BatchDetectDominantLanguageDetails struct {
// List of Documents for detect language.
Documents []DominantLanguageDocument `mandatory:"true" json:"documents"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// Specifies whether to consider or ignore transliteration. For example "hi, aap kaise ho? sab kuch teek hai? I will call you tomorrow." would be detected as English when ignore transliteration=true, Hindi when ignoreTransliteration=false.
ShouldIgnoreTransliteration *bool `mandatory:"false" json:"shouldIgnoreTransliteration"`
// default value is None.
// Specifies maximum number of characters to consider for determining the dominant language.
// If unspecified, then optimum number characters will be considered.
// If 0 is specified then all the characters are used to determine the language.
// If the value is greater than 0, then specified number of characters will be considered from the beginning of the text.
CharsToConsider *int `mandatory:"false" json:"charsToConsider"`
// The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.
EndpointId *string `mandatory:"false" json:"endpointId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
CompartmentId *string `mandatory:"false" json:"compartmentId"`
}
func (m BatchDetectDominantLanguageDetails) String() string
func (m BatchDetectDominantLanguageDetails) 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
BatchDetectDominantLanguageRequest wrapper for the BatchDetectDominantLanguage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectDominantLanguage.go.html to see an example of how to use BatchDetectDominantLanguageRequest.
type BatchDetectDominantLanguageRequest struct {
// The details to make a language detection detect call.
BatchDetectDominantLanguageDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchDetectDominantLanguageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchDetectDominantLanguageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchDetectDominantLanguageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchDetectDominantLanguageRequest) String() string
func (request BatchDetectDominantLanguageRequest) 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
BatchDetectDominantLanguageResponse wrapper for the BatchDetectDominantLanguage operation
type BatchDetectDominantLanguageResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchDetectDominantLanguageResult instance
BatchDetectDominantLanguageResult `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"`
}
func (response BatchDetectDominantLanguageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchDetectDominantLanguageResponse) String() string
BatchDetectDominantLanguageResult Result of language detect call.
type BatchDetectDominantLanguageResult struct {
// List of succeeded document response.
Documents []DominantLanguageDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchDetectDominantLanguageResult) String() string
func (m BatchDetectDominantLanguageResult) 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
BatchDetectHealthEntityDetails The documents details for health entities detect call.
type BatchDetectHealthEntityDetails struct {
// The endpoint which have to be used for inferencing.
EndpointId *string `mandatory:"true" json:"endpointId"`
// List of Documents for detect health entities.
Documents []TextDocument `mandatory:"true" json:"documents"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// List of NLP health ontologies to be linked
LinkOntologies []string `mandatory:"false" json:"linkOntologies"`
// is assertion on input text required. default value true.
IsDetectAssertions *bool `mandatory:"false" json:"isDetectAssertions"`
// is relationship on input text required. default value true.
IsDetectRelationships *bool `mandatory:"false" json:"isDetectRelationships"`
Profile *Profile `mandatory:"false" json:"profile"`
}
func (m BatchDetectHealthEntityDetails) String() string
func (m BatchDetectHealthEntityDetails) 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
BatchDetectHealthEntityRequest wrapper for the BatchDetectHealthEntity operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectHealthEntity.go.html to see an example of how to use BatchDetectHealthEntityRequest.
type BatchDetectHealthEntityRequest struct {
// The details to make a health entity detect call.
BatchDetectHealthEntityDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchDetectHealthEntityRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchDetectHealthEntityRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchDetectHealthEntityRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchDetectHealthEntityRequest) String() string
func (request BatchDetectHealthEntityRequest) 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
BatchDetectHealthEntityResponse wrapper for the BatchDetectHealthEntity operation
type BatchDetectHealthEntityResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchDetectHealthEntityResult instance
BatchDetectHealthEntityResult `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"`
}
func (response BatchDetectHealthEntityResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchDetectHealthEntityResponse) String() string
BatchDetectHealthEntityResult Result of health entity detect call.
type BatchDetectHealthEntityResult struct {
// List of succeeded document response.
Documents []HealthEntityDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchDetectHealthEntityResult) String() string
func (m BatchDetectHealthEntityResult) 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
BatchDetectLanguageEntitiesDetails The documents details for entities detect call.
type BatchDetectLanguageEntitiesDetails struct {
// List of Documents for detect entities.
Documents []TextDocument `mandatory:"true" json:"documents"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.
EndpointId *string `mandatory:"false" json:"endpointId"`
}
func (m BatchDetectLanguageEntitiesDetails) String() string
func (m BatchDetectLanguageEntitiesDetails) 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
BatchDetectLanguageEntitiesRequest wrapper for the BatchDetectLanguageEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageEntities.go.html to see an example of how to use BatchDetectLanguageEntitiesRequest.
type BatchDetectLanguageEntitiesRequest struct {
// The details to make a Entity detect call.
BatchDetectLanguageEntitiesDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchDetectLanguageEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchDetectLanguageEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchDetectLanguageEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchDetectLanguageEntitiesRequest) String() string
func (request BatchDetectLanguageEntitiesRequest) 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
BatchDetectLanguageEntitiesResponse wrapper for the BatchDetectLanguageEntities operation
type BatchDetectLanguageEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchDetectLanguageEntitiesResult instance
BatchDetectLanguageEntitiesResult `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"`
}
func (response BatchDetectLanguageEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchDetectLanguageEntitiesResponse) String() string
BatchDetectLanguageEntitiesResult Result of entities detect call.
type BatchDetectLanguageEntitiesResult struct {
// List of succeeded document response.
Documents []EntityDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchDetectLanguageEntitiesResult) String() string
func (m BatchDetectLanguageEntitiesResult) 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
BatchDetectLanguageKeyPhrasesDetails The documents details for keyPhrases call.
type BatchDetectLanguageKeyPhrasesDetails struct {
// List of Documents for detect keyPhrases.
Documents []TextDocument `mandatory:"true" json:"documents"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.
EndpointId *string `mandatory:"false" json:"endpointId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
CompartmentId *string `mandatory:"false" json:"compartmentId"`
}
func (m BatchDetectLanguageKeyPhrasesDetails) String() string
func (m BatchDetectLanguageKeyPhrasesDetails) 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
BatchDetectLanguageKeyPhrasesRequest wrapper for the BatchDetectLanguageKeyPhrases operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageKeyPhrases.go.html to see an example of how to use BatchDetectLanguageKeyPhrasesRequest.
type BatchDetectLanguageKeyPhrasesRequest struct {
// The details to make keyPhrase detect call.
BatchDetectLanguageKeyPhrasesDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchDetectLanguageKeyPhrasesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchDetectLanguageKeyPhrasesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchDetectLanguageKeyPhrasesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchDetectLanguageKeyPhrasesRequest) String() string
func (request BatchDetectLanguageKeyPhrasesRequest) 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
BatchDetectLanguageKeyPhrasesResponse wrapper for the BatchDetectLanguageKeyPhrases operation
type BatchDetectLanguageKeyPhrasesResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchDetectLanguageKeyPhrasesResult instance
BatchDetectLanguageKeyPhrasesResult `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"`
}
func (response BatchDetectLanguageKeyPhrasesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchDetectLanguageKeyPhrasesResponse) String() string
BatchDetectLanguageKeyPhrasesResult Result of keyPhrases detect call.
type BatchDetectLanguageKeyPhrasesResult struct {
// List of succeeded document response.
Documents []KeyPhraseDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchDetectLanguageKeyPhrasesResult) String() string
func (m BatchDetectLanguageKeyPhrasesResult) 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
BatchDetectLanguagePiiEntitiesDetails The documents details to detect personal identification information.
type BatchDetectLanguagePiiEntitiesDetails struct {
// List of documents to detect personal identification information.
Documents []TextDocument `mandatory:"true" json:"documents"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.
EndpointId *string `mandatory:"false" json:"endpointId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Mask recognized PII entities with different modes.
Masking map[string]PiiEntityMasking `mandatory:"false" json:"masking"`
Profile *Profile `mandatory:"false" json:"profile"`
}
func (m BatchDetectLanguagePiiEntitiesDetails) String() string
func (m *BatchDetectLanguagePiiEntitiesDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m BatchDetectLanguagePiiEntitiesDetails) 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
BatchDetectLanguagePiiEntitiesRequest wrapper for the BatchDetectLanguagePiiEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguagePiiEntities.go.html to see an example of how to use BatchDetectLanguagePiiEntitiesRequest.
type BatchDetectLanguagePiiEntitiesRequest struct {
// The details to make a PII entity detect call.
BatchDetectLanguagePiiEntitiesDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchDetectLanguagePiiEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchDetectLanguagePiiEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchDetectLanguagePiiEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchDetectLanguagePiiEntitiesRequest) String() string
func (request BatchDetectLanguagePiiEntitiesRequest) 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
BatchDetectLanguagePiiEntitiesResponse wrapper for the BatchDetectLanguagePiiEntities operation
type BatchDetectLanguagePiiEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchDetectLanguagePiiEntitiesResult instance
BatchDetectLanguagePiiEntitiesResult `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"`
}
func (response BatchDetectLanguagePiiEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchDetectLanguagePiiEntitiesResponse) String() string
BatchDetectLanguagePiiEntitiesResult Result of batch detect personal identification.
type BatchDetectLanguagePiiEntitiesResult struct {
// List of succeeded document response.
Documents []PiiEntityDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchDetectLanguagePiiEntitiesResult) String() string
func (m BatchDetectLanguagePiiEntitiesResult) 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
BatchDetectLanguageSentimentsDetails The documents details for sentiment call.
type BatchDetectLanguageSentimentsDetails struct {
// List of Documents for detect sentiments.
Documents []TextDocument `mandatory:"true" json:"documents"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.
EndpointId *string `mandatory:"false" json:"endpointId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
CompartmentId *string `mandatory:"false" json:"compartmentId"`
}
func (m BatchDetectLanguageSentimentsDetails) String() string
func (m BatchDetectLanguageSentimentsDetails) 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
BatchDetectLanguageSentimentsLevelEnum Enum with underlying type: string
type BatchDetectLanguageSentimentsLevelEnum string
Set of constants representing the allowable values for BatchDetectLanguageSentimentsLevelEnum
const (
BatchDetectLanguageSentimentsLevelAspect BatchDetectLanguageSentimentsLevelEnum = "ASPECT"
BatchDetectLanguageSentimentsLevelSentence BatchDetectLanguageSentimentsLevelEnum = "SENTENCE"
)
func GetBatchDetectLanguageSentimentsLevelEnumValues() []BatchDetectLanguageSentimentsLevelEnum
GetBatchDetectLanguageSentimentsLevelEnumValues Enumerates the set of values for BatchDetectLanguageSentimentsLevelEnum
func GetMappingBatchDetectLanguageSentimentsLevelEnum(val string) (BatchDetectLanguageSentimentsLevelEnum, bool)
GetMappingBatchDetectLanguageSentimentsLevelEnum performs case Insensitive comparison on enum value and return the desired enum
BatchDetectLanguageSentimentsRequest wrapper for the BatchDetectLanguageSentiments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageSentiments.go.html to see an example of how to use BatchDetectLanguageSentimentsRequest.
type BatchDetectLanguageSentimentsRequest struct {
// The details to make sentiment detect call.
BatchDetectLanguageSentimentsDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Set this parameter for sentence and aspect level sentiment analysis.
// Allowed values are:
// - ASPECT
// - SENTENCE
Level []BatchDetectLanguageSentimentsLevelEnum `contributesTo:"query" name:"level" omitEmpty:"true" collectionFormat:"multi"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchDetectLanguageSentimentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchDetectLanguageSentimentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchDetectLanguageSentimentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchDetectLanguageSentimentsRequest) String() string
func (request BatchDetectLanguageSentimentsRequest) 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
BatchDetectLanguageSentimentsResponse wrapper for the BatchDetectLanguageSentiments operation
type BatchDetectLanguageSentimentsResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchDetectLanguageSentimentsResult instance
BatchDetectLanguageSentimentsResult `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"`
}
func (response BatchDetectLanguageSentimentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchDetectLanguageSentimentsResponse) String() string
BatchDetectLanguageSentimentsResult Result of sentiments detect call.
type BatchDetectLanguageSentimentsResult struct {
// List of succeeded document response.
Documents []SentimentDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchDetectLanguageSentimentsResult) String() string
func (m BatchDetectLanguageSentimentsResult) 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
BatchDetectLanguageTextClassificationDetails The documents details for text classification call.
type BatchDetectLanguageTextClassificationDetails struct {
// List of Documents for detect text classification.
Documents []TextDocument `mandatory:"true" json:"documents"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.
EndpointId *string `mandatory:"false" json:"endpointId"`
}
func (m BatchDetectLanguageTextClassificationDetails) String() string
func (m BatchDetectLanguageTextClassificationDetails) 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
BatchDetectLanguageTextClassificationRequest wrapper for the BatchDetectLanguageTextClassification operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchDetectLanguageTextClassification.go.html to see an example of how to use BatchDetectLanguageTextClassificationRequest.
type BatchDetectLanguageTextClassificationRequest struct {
// The details to make text classification detect call.
BatchDetectLanguageTextClassificationDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchDetectLanguageTextClassificationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchDetectLanguageTextClassificationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchDetectLanguageTextClassificationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchDetectLanguageTextClassificationRequest) String() string
func (request BatchDetectLanguageTextClassificationRequest) 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
BatchDetectLanguageTextClassificationResponse wrapper for the BatchDetectLanguageTextClassification operation
type BatchDetectLanguageTextClassificationResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchDetectLanguageTextClassificationResult instance
BatchDetectLanguageTextClassificationResult `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"`
}
func (response BatchDetectLanguageTextClassificationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchDetectLanguageTextClassificationResponse) String() string
BatchDetectLanguageTextClassificationResult Result of text classification detect call.
type BatchDetectLanguageTextClassificationResult struct {
// List of succeeded document response.
Documents []TextClassificationDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchDetectLanguageTextClassificationResult) String() string
func (m BatchDetectLanguageTextClassificationResult) 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
BatchLanguageTranslationDetails The documents details for translation call.
type BatchLanguageTranslationDetails struct {
// List of documents for translation.
Documents []TextDocument `mandatory:"true" json:"documents"`
// Unique name to identify an endpoint to be used for inferencing
Alias *string `mandatory:"false" json:"alias"`
// The endpoint that has to be used for inferencing.
EndpointId *string `mandatory:"false" json:"endpointId"`
// List of words not to be translated
NoTranslate []string `mandatory:"false" json:"noTranslate"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Language code supported
// Arabic - ar
// Brazilian Portuguese - pt-BR
// Canadian French - fr-CA
// Croatian - hr
// Czech - cs
// Danish - da
// Dutch - nl
// English - en
// Finnish - fi
// French - fr
// German - de
// Greek - el
// Hebrew - he
// Hungarian - hu
// Italian - it
// Japanese - ja
// Korean - ko
// Norwegian - no
// Polish - pl
// Portuguese - pt
// Romanian - ro
// Russian - ru
// Simplified Chinese - zh-CN
// Slovak - sk
// Slovenian - sl
// Spanish - es
// Swedish - sv
// Thai - th
// Traditional Chinese - zh-TW
// Turkish - tr
// Vietnamese - vi
TargetLanguageCode *string `mandatory:"false" json:"targetLanguageCode"`
}
func (m BatchLanguageTranslationDetails) String() string
func (m BatchLanguageTranslationDetails) 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
BatchLanguageTranslationRequest wrapper for the BatchLanguageTranslation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/BatchLanguageTranslation.go.html to see an example of how to use BatchLanguageTranslationRequest.
type BatchLanguageTranslationRequest struct {
// The details to make language translation call.
BatchLanguageTranslationDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BatchLanguageTranslationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BatchLanguageTranslationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BatchLanguageTranslationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BatchLanguageTranslationRequest) String() string
func (request BatchLanguageTranslationRequest) 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
BatchLanguageTranslationResponse wrapper for the BatchLanguageTranslation operation
type BatchLanguageTranslationResponse struct {
// The underlying http response
RawResponse *http.Response
// The BatchLanguageTranslationResult instance
BatchLanguageTranslationResult `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"`
}
func (response BatchLanguageTranslationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BatchLanguageTranslationResponse) String() string
BatchLanguageTranslationResult Result of translation call.
type BatchLanguageTranslationResult struct {
// List of succeeded document response.
Documents []TranslationDocumentResult `mandatory:"true" json:"documents"`
// List of failed document response.
Errors []DocumentError `mandatory:"false" json:"errors"`
}
func (m BatchLanguageTranslationResult) String() string
func (m BatchLanguageTranslationResult) 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
CancelJobRequest wrapper for the CancelJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CancelJob.go.html to see an example of how to use CancelJobRequest.
type CancelJobRequest struct {
// Unique Transcription Job identifier.
JobId *string `mandatory:"true" contributesTo:"path" name:"jobId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelJobRequest) String() string
func (request CancelJobRequest) 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
CancelJobResponse wrapper for the CancelJob operation
type CancelJobResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelJobResponse) String() string
Capabilities Capabilities supported
type Capabilities struct {
// Model information capabilities related to version
Capability map[string]Capability `mandatory:"false" json:"capability"`
}
func (m Capabilities) String() string
func (m Capabilities) 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
Capability Capability supported
type Capability struct {
// values
Details []string `mandatory:"false" json:"details"`
}
func (m Capability) String() string
func (m Capability) 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
ChangeEndpointCompartmentDetails Details for changing the compartment of an Endpoint.
type ChangeEndpointCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeEndpointCompartmentDetails) String() string
func (m ChangeEndpointCompartmentDetails) 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
ChangeEndpointCompartmentRequest wrapper for the ChangeEndpointCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeEndpointCompartment.go.html to see an example of how to use ChangeEndpointCompartmentRequest.
type ChangeEndpointCompartmentRequest struct {
// The OCID of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
ChangeEndpointCompartmentDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// 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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeEndpointCompartmentRequest) String() string
func (request ChangeEndpointCompartmentRequest) 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
ChangeEndpointCompartmentResponse wrapper for the ChangeEndpointCompartment operation
type ChangeEndpointCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeEndpointCompartmentResponse) String() string
ChangeJobCompartmentDetails Details for changing the compartment of a language job.
type ChangeJobCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// where the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeJobCompartmentDetails) String() string
func (m ChangeJobCompartmentDetails) 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
ChangeJobCompartmentRequest wrapper for the ChangeJobCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeJobCompartment.go.html to see an example of how to use ChangeJobCompartmentRequest.
type ChangeJobCompartmentRequest struct {
// unique job OCID.
JobId *string `mandatory:"true" contributesTo:"path" name:"jobId"`
ChangeJobCompartmentDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// 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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeJobCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeJobCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeJobCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeJobCompartmentRequest) String() string
func (request ChangeJobCompartmentRequest) 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
ChangeJobCompartmentResponse wrapper for the ChangeJobCompartment operation
type ChangeJobCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeJobCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeJobCompartmentResponse) String() string
ChangeModelCompartmentDetails Details for changing the compartment of an Model.
type ChangeModelCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeModelCompartmentDetails) String() string
func (m ChangeModelCompartmentDetails) 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
ChangeModelCompartmentRequest wrapper for the ChangeModelCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeModelCompartment.go.html to see an example of how to use ChangeModelCompartmentRequest.
type ChangeModelCompartmentRequest struct {
// unique model OCID.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
ChangeModelCompartmentDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// 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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeModelCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeModelCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeModelCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeModelCompartmentRequest) String() string
func (request ChangeModelCompartmentRequest) 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
ChangeModelCompartmentResponse wrapper for the ChangeModelCompartment operation
type ChangeModelCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeModelCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeModelCompartmentResponse) String() string
ChangeProjectCompartmentDetails Details for changing the compartment of a Project.
type ChangeProjectCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeProjectCompartmentDetails) String() string
func (m ChangeProjectCompartmentDetails) 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
ChangeProjectCompartmentRequest wrapper for the ChangeProjectCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ChangeProjectCompartment.go.html to see an example of how to use ChangeProjectCompartmentRequest.
type ChangeProjectCompartmentRequest struct {
// The OCID of the project.
ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`
ChangeProjectCompartmentDetails `contributesTo:"body"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// 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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeProjectCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeProjectCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeProjectCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeProjectCompartmentRequest) String() string
func (request ChangeProjectCompartmentRequest) 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
ChangeProjectCompartmentResponse wrapper for the ChangeProjectCompartment operation
type ChangeProjectCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeProjectCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeProjectCompartmentResponse) String() string
ClassMetrics class level Text Classification model metrics
type ClassMetrics struct {
// Text classification label
Label *string `mandatory:"true" json:"label"`
// F1-score, is a measure of a model’s accuracy on a dataset
F1 *float32 `mandatory:"true" json:"f1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
Precision *float32 `mandatory:"true" json:"precision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
Recall *float32 `mandatory:"true" json:"recall"`
// number of samples in the test set
Support *float32 `mandatory:"false" json:"support"`
}
func (m ClassMetrics) String() string
func (m ClassMetrics) 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
ClassificationMultiClassModeDetails Possible text classification multi class mode details
type ClassificationMultiClassModeDetails struct {
// Optional if nothing specified latest base model will be used for training. Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m ClassificationMultiClassModeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ClassificationMultiClassModeDetails) String() string
func (m ClassificationMultiClassModeDetails) 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
ClassificationMultiLabelModeDetails Possible text classification multi label mode details
type ClassificationMultiLabelModeDetails struct {
// Optional if nothing specified latest base model will be used for training. Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m ClassificationMultiLabelModeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ClassificationMultiLabelModeDetails) String() string
func (m ClassificationMultiLabelModeDetails) 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
ClassificationType possible text classification modes
type ClassificationType interface {
}
ClassificationTypeClassificationModeEnum Enum with underlying type: string
type ClassificationTypeClassificationModeEnum string
Set of constants representing the allowable values for ClassificationTypeClassificationModeEnum
const (
ClassificationTypeClassificationModeClass ClassificationTypeClassificationModeEnum = "MULTI_CLASS"
ClassificationTypeClassificationModeLabel ClassificationTypeClassificationModeEnum = "MULTI_LABEL"
)
func GetClassificationTypeClassificationModeEnumValues() []ClassificationTypeClassificationModeEnum
GetClassificationTypeClassificationModeEnumValues Enumerates the set of values for ClassificationTypeClassificationModeEnum
func GetMappingClassificationTypeClassificationModeEnum(val string) (ClassificationTypeClassificationModeEnum, bool)
GetMappingClassificationTypeClassificationModeEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationDetails training model details
type ConfigurationDetails struct {
// model configuration details
// For PII : ConfigurationDetails will be PiiEntityMasking can be anyone of the following
// ex.{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true }
// { "mode" : "MASK","replaceWith" : "&" }
// { "mode" : "REPLACE" }
// For language translation : { "languageCodes" : ["cs", "ar"]}
// Language code supported
// Automatically detect language - auto
// Arabic - ar
// Brazilian Portuguese - pt-BR
// Czech - cs
// Danish - da
// Dutch - nl
// English - en
// Finnish - fi
// French - fr
// Canadian French - fr-CA
// German - de
// Italian - it
// Japanese - ja
// Korean - ko
// Norwegian - no
// Polish - pl
// Romanian - ro
// Simplified Chinese - zh-CN
// Spanish - es
// Swedish - sv
// Traditional Chinese - zh-TW
// Turkish - tr
// Greek - el
// Hebrew - he
ConfigurationMap map[string]string `mandatory:"false" json:"configurationMap"`
}
func (m ConfigurationDetails) String() string
func (m ConfigurationDetails) 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
ConfusionMatrixDetails confusion matrix details
type ConfusionMatrixDetails struct {
// confusion matrix data
Matrix map[string]float64 `mandatory:"false" json:"matrix"`
}
func (m ConfusionMatrixDetails) String() string
func (m ConfusionMatrixDetails) 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
CreateEndpointDetails The information needed to create a new endpoint and expose to end users.
type CreateEndpointDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) compartment identifier for the endpoint
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
ModelId *string `mandatory:"true" json:"modelId"`
// A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Compute infra type for endpoint.
ComputeType CreateEndpointDetailsComputeTypeEnum `mandatory:"false" json:"computeType,omitempty"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// A short description of the an endpoint.
Description *string `mandatory:"false" json:"description"`
// Number of replicas required for this endpoint. This will be optional parameter. Default will be 1.
InferenceUnits *int `mandatory:"false" json:"inferenceUnits"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateEndpointDetails) String() string
func (m CreateEndpointDetails) 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
CreateEndpointDetailsComputeTypeEnum Enum with underlying type: string
type CreateEndpointDetailsComputeTypeEnum string
Set of constants representing the allowable values for CreateEndpointDetailsComputeTypeEnum
const (
CreateEndpointDetailsComputeTypeCpu CreateEndpointDetailsComputeTypeEnum = "CPU"
CreateEndpointDetailsComputeTypeGpu CreateEndpointDetailsComputeTypeEnum = "GPU"
)
func GetCreateEndpointDetailsComputeTypeEnumValues() []CreateEndpointDetailsComputeTypeEnum
GetCreateEndpointDetailsComputeTypeEnumValues Enumerates the set of values for CreateEndpointDetailsComputeTypeEnum
func GetMappingCreateEndpointDetailsComputeTypeEnum(val string) (CreateEndpointDetailsComputeTypeEnum, bool)
GetMappingCreateEndpointDetailsComputeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateEndpointRequest wrapper for the CreateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateEndpoint.go.html to see an example of how to use CreateEndpointRequest.
type CreateEndpointRequest struct {
// Details for the new endpoint.
CreateEndpointDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateEndpointRequest) String() string
func (request CreateEndpointRequest) 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
CreateEndpointResponse wrapper for the CreateEndpoint operation
type CreateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The Endpoint instance
Endpoint `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The URI that identifies the entity described in the response body.
Location *string `presentIn:"header" name:"location"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateEndpointResponse) String() string
CreateJobDetails Job creation detail which will have documents on which language services need to run prediction along with output folder
type CreateJobDetails struct {
// The OCID (https://docs.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"`
// training model details
// For this release only one model is allowed to be input here.
// One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
ModelMetadataDetails []ModelMetadataDetails `mandatory:"true" json:"modelMetadataDetails"`
OutputLocation *ObjectPrefixOutputLocation `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"`
InputConfiguration *InputConfiguration `mandatory:"false" json:"inputConfiguration"`
}
func (m CreateJobDetails) String() string
func (m *CreateJobDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateJobDetails) 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
CreateJobRequest wrapper for the CreateJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateJob.go.html to see an example of how to use CreateJobRequest.
type CreateJobRequest struct {
// Details for the new job.
CreateJobDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateJobRequest) String() string
func (request CreateJobRequest) 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
CreateJobResponse wrapper for the CreateJob operation
type CreateJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The Job instance
Job `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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateJobResponse) String() string
CreateModelDetails The information needed to train a new model
type CreateModelDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the models compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model.
ProjectId *string `mandatory:"true" json:"projectId"`
ModelDetails ModelDetails `mandatory:"true" json:"modelDetails"`
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the a model.
Description *string `mandatory:"false" json:"description"`
TrainingDataset DatasetDetails `mandatory:"false" json:"trainingDataset"`
TestStrategy TestStrategy `mandatory:"false" json:"testStrategy"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateModelDetails) String() string
func (m *CreateModelDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateModelDetails) 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
CreateModelRequest wrapper for the CreateModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateModel.go.html to see an example of how to use CreateModelRequest.
type CreateModelRequest struct {
// Details for the new model.
CreateModelDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateModelRequest) String() string
func (request CreateModelRequest) 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
CreateModelResponse wrapper for the CreateModel operation
type CreateModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Model instance
Model `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The URI that identifies the entity described in the response body.
Location *string `presentIn:"header" name:"location"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateModelResponse) String() string
CreateProjectDetails Parameters needed to create a new project. Projects enable users to organise their language work.
type CreateProjectDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the project's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the project.
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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateProjectDetails) String() string
func (m CreateProjectDetails) 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
CreateProjectRequest wrapper for the CreateProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CreateProject.go.html to see an example of how to use CreateProjectRequest.
type CreateProjectRequest struct {
// Details for the new Project.
CreateProjectDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateProjectRequest) String() string
func (request CreateProjectRequest) 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
CreateProjectResponse wrapper for the CreateProject operation
type CreateProjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The Project instance
Project `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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateProjectResponse) String() string
DataScienceLabelingDataset Dataset that uses data science labelling service as underlying data source.
type DataScienceLabelingDataset struct {
// Data Science Labelling Service OCID
DatasetId *string `mandatory:"true" json:"datasetId"`
}
func (m DataScienceLabelingDataset) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DataScienceLabelingDataset) String() string
func (m DataScienceLabelingDataset) 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
DatasetDetails Possible data set type
type DatasetDetails interface {
}
DatasetDetailsDatasetTypeEnum Enum with underlying type: string
type DatasetDetailsDatasetTypeEnum string
Set of constants representing the allowable values for DatasetDetailsDatasetTypeEnum
const (
DatasetDetailsDatasetTypeObjectStorage DatasetDetailsDatasetTypeEnum = "OBJECT_STORAGE"
DatasetDetailsDatasetTypeDataScienceLabeling DatasetDetailsDatasetTypeEnum = "DATA_SCIENCE_LABELING"
)
func GetDatasetDetailsDatasetTypeEnumValues() []DatasetDetailsDatasetTypeEnum
GetDatasetDetailsDatasetTypeEnumValues Enumerates the set of values for DatasetDetailsDatasetTypeEnum
func GetMappingDatasetDetailsDatasetTypeEnum(val string) (DatasetDetailsDatasetTypeEnum, bool)
GetMappingDatasetDetailsDatasetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteEndpointRequest wrapper for the DeleteEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteEndpoint.go.html to see an example of how to use DeleteEndpointRequest.
type DeleteEndpointRequest struct {
// The OCID of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteEndpointRequest) String() string
func (request DeleteEndpointRequest) 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
DeleteEndpointResponse wrapper for the DeleteEndpoint operation
type DeleteEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteEndpointResponse) String() string
DeleteJobRequest wrapper for the DeleteJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteJob.go.html to see an example of how to use DeleteJobRequest.
type DeleteJobRequest struct {
// Unique Transcription Job identifier.
JobId *string `mandatory:"true" contributesTo:"path" name:"jobId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteJobRequest) String() string
func (request DeleteJobRequest) 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
DeleteJobResponse wrapper for the DeleteJob operation
type DeleteJobResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteJobResponse) String() string
DeleteModelRequest wrapper for the DeleteModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteModel.go.html to see an example of how to use DeleteModelRequest.
type DeleteModelRequest struct {
// unique model OCID.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteModelRequest) String() string
func (request DeleteModelRequest) 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
DeleteModelResponse wrapper for the DeleteModel operation
type DeleteModelResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteModelResponse) String() string
DeleteProjectRequest wrapper for the DeleteProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DeleteProject.go.html to see an example of how to use DeleteProjectRequest.
type DeleteProjectRequest struct {
// The OCID of the project.
ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteProjectRequest) String() string
func (request DeleteProjectRequest) 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
DeleteProjectResponse wrapper for the DeleteProject operation
type DeleteProjectResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteProjectResponse) String() string
DetectDominantLanguageDetails The document details for language detect call.
type DetectDominantLanguageDetails struct {
// Document text for detect language.
Text *string `mandatory:"true" json:"text"`
}
func (m DetectDominantLanguageDetails) String() string
func (m DetectDominantLanguageDetails) 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
DetectDominantLanguageRequest wrapper for the DetectDominantLanguage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectDominantLanguage.go.html to see an example of how to use DetectDominantLanguageRequest.
type DetectDominantLanguageRequest struct {
// The details to make a language detection detect call.
DetectDominantLanguageDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DetectDominantLanguageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetectDominantLanguageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetectDominantLanguageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetectDominantLanguageRequest) String() string
func (request DetectDominantLanguageRequest) 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
DetectDominantLanguageResponse wrapper for the DetectDominantLanguage operation
type DetectDominantLanguageResponse struct {
// The underlying http response
RawResponse *http.Response
// The DetectDominantLanguageResult instance
DetectDominantLanguageResult `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"`
// This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response DetectDominantLanguageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetectDominantLanguageResponse) String() string
DetectDominantLanguageResult Result of language detect call.
type DetectDominantLanguageResult struct {
// List of detected languages with results sorted in descending order of the scores. Most likely language is on top.
Languages []DetectedLanguage `mandatory:"true" json:"languages"`
}
func (m DetectDominantLanguageResult) String() string
func (m DetectDominantLanguageResult) 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
DetectLanguageEntitiesDetails The document details for entities detect call.
type DetectLanguageEntitiesDetails struct {
// Document text for detect entities.
Text *string `mandatory:"true" json:"text"`
}
func (m DetectLanguageEntitiesDetails) String() string
func (m DetectLanguageEntitiesDetails) 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
DetectLanguageEntitiesModelVersionEnum Enum with underlying type: string
type DetectLanguageEntitiesModelVersionEnum string
Set of constants representing the allowable values for DetectLanguageEntitiesModelVersionEnum
const (
DetectLanguageEntitiesModelVersionV21 DetectLanguageEntitiesModelVersionEnum = "V2_1"
DetectLanguageEntitiesModelVersionV11 DetectLanguageEntitiesModelVersionEnum = "V1_1"
)
func GetDetectLanguageEntitiesModelVersionEnumValues() []DetectLanguageEntitiesModelVersionEnum
GetDetectLanguageEntitiesModelVersionEnumValues Enumerates the set of values for DetectLanguageEntitiesModelVersionEnum
func GetMappingDetectLanguageEntitiesModelVersionEnum(val string) (DetectLanguageEntitiesModelVersionEnum, bool)
GetMappingDetectLanguageEntitiesModelVersionEnum performs case Insensitive comparison on enum value and return the desired enum
DetectLanguageEntitiesRequest wrapper for the DetectLanguageEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageEntities.go.html to see an example of how to use DetectLanguageEntitiesRequest.
type DetectLanguageEntitiesRequest struct {
// The details to make a Entity detect call.
DetectLanguageEntitiesDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Named Entity Recognition model versions. By default user will get output from V2.1 implementation.
ModelVersion DetectLanguageEntitiesModelVersionEnum `mandatory:"false" contributesTo:"query" name:"modelVersion" omitEmpty:"true"`
// If this parameter is set to true, you only get PII (Personally identifiable information) entities
// like PhoneNumber, Email, Person, and so on. Default value is false.
IsPii *bool `mandatory:"false" contributesTo:"query" name:"isPii"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DetectLanguageEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetectLanguageEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetectLanguageEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetectLanguageEntitiesRequest) String() string
func (request DetectLanguageEntitiesRequest) 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
DetectLanguageEntitiesResponse wrapper for the DetectLanguageEntities operation
type DetectLanguageEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// The DetectLanguageEntitiesResult instance
DetectLanguageEntitiesResult `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"`
// This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response DetectLanguageEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetectLanguageEntitiesResponse) String() string
DetectLanguageEntitiesResult Result of entities detect call.
type DetectLanguageEntitiesResult struct {
// List of detected entities.
Entities []Entity `mandatory:"true" json:"entities"`
}
func (m DetectLanguageEntitiesResult) String() string
func (m DetectLanguageEntitiesResult) 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
DetectLanguageKeyPhrasesDetails The document details for a keyPhrases detect call.
type DetectLanguageKeyPhrasesDetails struct {
// Document text for detect keyPhrases.
Text *string `mandatory:"true" json:"text"`
}
func (m DetectLanguageKeyPhrasesDetails) String() string
func (m DetectLanguageKeyPhrasesDetails) 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
DetectLanguageKeyPhrasesRequest wrapper for the DetectLanguageKeyPhrases operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageKeyPhrases.go.html to see an example of how to use DetectLanguageKeyPhrasesRequest.
type DetectLanguageKeyPhrasesRequest struct {
// The details to make keyPhrase detect call.
DetectLanguageKeyPhrasesDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DetectLanguageKeyPhrasesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetectLanguageKeyPhrasesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetectLanguageKeyPhrasesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetectLanguageKeyPhrasesRequest) String() string
func (request DetectLanguageKeyPhrasesRequest) 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
DetectLanguageKeyPhrasesResponse wrapper for the DetectLanguageKeyPhrases operation
type DetectLanguageKeyPhrasesResponse struct {
// The underlying http response
RawResponse *http.Response
// The DetectLanguageKeyPhrasesResult instance
DetectLanguageKeyPhrasesResult `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"`
// This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response DetectLanguageKeyPhrasesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetectLanguageKeyPhrasesResponse) String() string
DetectLanguageKeyPhrasesResult Result of a language keyPhrases detect call.
type DetectLanguageKeyPhrasesResult struct {
// List of detected keyPhrases.
KeyPhrases []KeyPhrase `mandatory:"true" json:"keyPhrases"`
}
func (m DetectLanguageKeyPhrasesResult) String() string
func (m DetectLanguageKeyPhrasesResult) 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
DetectLanguageSentimentsDetails The document details for sentiments detect call.
type DetectLanguageSentimentsDetails struct {
// Document text for detect sentiments.
Text *string `mandatory:"true" json:"text"`
}
func (m DetectLanguageSentimentsDetails) String() string
func (m DetectLanguageSentimentsDetails) 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
DetectLanguageSentimentsRequest wrapper for the DetectLanguageSentiments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageSentiments.go.html to see an example of how to use DetectLanguageSentimentsRequest.
type DetectLanguageSentimentsRequest struct {
// The details to make sentiment detect call.
DetectLanguageSentimentsDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DetectLanguageSentimentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetectLanguageSentimentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetectLanguageSentimentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetectLanguageSentimentsRequest) String() string
func (request DetectLanguageSentimentsRequest) 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
DetectLanguageSentimentsResponse wrapper for the DetectLanguageSentiments operation
type DetectLanguageSentimentsResponse struct {
// The underlying http response
RawResponse *http.Response
// The DetectLanguageSentimentsResult instance
DetectLanguageSentimentsResult `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"`
// This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response DetectLanguageSentimentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetectLanguageSentimentsResponse) String() string
DetectLanguageSentimentsResult Result of sentiments detect call.
type DetectLanguageSentimentsResult struct {
// List of detected aspects.
Aspects []SentimentAspect `mandatory:"true" json:"aspects"`
}
func (m DetectLanguageSentimentsResult) String() string
func (m DetectLanguageSentimentsResult) 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
DetectLanguageTextClassificationDetails The document details for text classification detect call.
type DetectLanguageTextClassificationDetails struct {
// Document text for detect text classes.
Text *string `mandatory:"true" json:"text"`
}
func (m DetectLanguageTextClassificationDetails) String() string
func (m DetectLanguageTextClassificationDetails) 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
DetectLanguageTextClassificationRequest wrapper for the DetectLanguageTextClassification operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/DetectLanguageTextClassification.go.html to see an example of how to use DetectLanguageTextClassificationRequest.
type DetectLanguageTextClassificationRequest struct {
// The details to make text classification detect call.
DetectLanguageTextClassificationDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DetectLanguageTextClassificationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DetectLanguageTextClassificationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DetectLanguageTextClassificationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DetectLanguageTextClassificationRequest) String() string
func (request DetectLanguageTextClassificationRequest) 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
DetectLanguageTextClassificationResponse wrapper for the DetectLanguageTextClassification operation
type DetectLanguageTextClassificationResponse struct {
// The underlying http response
RawResponse *http.Response
// The DetectLanguageTextClassificationResult instance
DetectLanguageTextClassificationResult `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"`
// This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
Sunset *string `presentIn:"header" name:"sunset"`
}
func (response DetectLanguageTextClassificationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DetectLanguageTextClassificationResponse) String() string
DetectLanguageTextClassificationResult Result of text classification detect call.
type DetectLanguageTextClassificationResult struct {
// List of detected text classes.
TextClassification []TextClassification `mandatory:"true" json:"textClassification"`
}
func (m DetectLanguageTextClassificationResult) String() string
func (m DetectLanguageTextClassificationResult) 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
DetectedLanguage Attributes to the detected language. Contains Language Name , Code, and Confidence Score.
type DetectedLanguage struct {
// Full language name.
// Example: `English, Hindi, and so on`
Name *string `mandatory:"true" json:"name"`
// Detected language code as per ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) standard.
// Example: `en, fr, hi etc`.
Code *string `mandatory:"true" json:"code"`
// Score or confidence of detected language code.
// Example: `0.9999856066867399`
Score *float64 `mandatory:"true" json:"score"`
}
func (m DetectedLanguage) String() string
func (m DetectedLanguage) 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
DocumentError Error response for document.
type DocumentError struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
Error *ErrorDetails `mandatory:"true" json:"error"`
}
func (m DocumentError) String() string
func (m DocumentError) 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
DocumentsConfiguration Input documents configuration
type DocumentsConfiguration struct {
// meta data about documents
// For CSV valid JSON format is {"CSV" :{inputColumn: "reviewDetails", rowId: "reviewId", copyColumnsToOutput: ["reviewId" "userId"] , delimiter: ","}
// Note: In future if new file types added we will update here in documentation about input file meta data
Config map[string]string `mandatory:"false" json:"config"`
}
func (m DocumentsConfiguration) String() string
func (m DocumentsConfiguration) 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
DominantLanguageDocument The document details for language detect call.
type DominantLanguageDocument struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// Document text for detect language.
Text *string `mandatory:"true" json:"text"`
}
func (m DominantLanguageDocument) String() string
func (m DominantLanguageDocument) 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
DominantLanguageDocumentResult The document response for language detect call.
type DominantLanguageDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// List of detected languages with results sorted in descending order of the scores. Most likely language is on top.
Languages []DetectedLanguage `mandatory:"true" json:"languages"`
}
func (m DominantLanguageDocumentResult) String() string
func (m DominantLanguageDocumentResult) 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
Endpoint Description of the endpoint.
type Endpoint struct {
// Unique identifier endpoint OCID of an endpoint that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the endpoint compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the Endpoint.
ProjectId *string `mandatory:"true" json:"projectId"`
// The time the the endpoint was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the endpoint.
LifecycleState EndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
ModelId *string `mandatory:"true" json:"modelId"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// Compute infra type for endpoint.
ComputeType EndpointComputeTypeEnum `mandatory:"false" json:"computeType,omitempty"`
// A short description of the endpoint.
Description *string `mandatory:"false" json:"description"`
// The time the endpoint was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
// Number of replicas required for this endpoint.
InferenceUnits *int `mandatory:"false" json:"inferenceUnits"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Endpoint) String() string
func (m Endpoint) 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
EndpointCollection Results of an endpoint list. Contains EndpointSummary items.
type EndpointCollection struct {
// List of endpoints
Items []EndpointSummary `mandatory:"true" json:"items"`
}
func (m EndpointCollection) String() string
func (m EndpointCollection) 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
EndpointComputeTypeEnum Enum with underlying type: string
type EndpointComputeTypeEnum string
Set of constants representing the allowable values for EndpointComputeTypeEnum
const (
EndpointComputeTypeCpu EndpointComputeTypeEnum = "CPU"
EndpointComputeTypeGpu EndpointComputeTypeEnum = "GPU"
)
func GetEndpointComputeTypeEnumValues() []EndpointComputeTypeEnum
GetEndpointComputeTypeEnumValues Enumerates the set of values for EndpointComputeTypeEnum
func GetMappingEndpointComputeTypeEnum(val string) (EndpointComputeTypeEnum, bool)
GetMappingEndpointComputeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
EndpointLifecycleStateEnum Enum with underlying type: string
type EndpointLifecycleStateEnum string
Set of constants representing the allowable values for EndpointLifecycleStateEnum
const (
EndpointLifecycleStateDeleting EndpointLifecycleStateEnum = "DELETING"
EndpointLifecycleStateDeleted EndpointLifecycleStateEnum = "DELETED"
EndpointLifecycleStateFailed EndpointLifecycleStateEnum = "FAILED"
EndpointLifecycleStateCreating EndpointLifecycleStateEnum = "CREATING"
EndpointLifecycleStateActive EndpointLifecycleStateEnum = "ACTIVE"
EndpointLifecycleStateUpdating EndpointLifecycleStateEnum = "UPDATING"
)
func GetEndpointLifecycleStateEnumValues() []EndpointLifecycleStateEnum
GetEndpointLifecycleStateEnumValues Enumerates the set of values for EndpointLifecycleStateEnum
func GetMappingEndpointLifecycleStateEnum(val string) (EndpointLifecycleStateEnum, bool)
GetMappingEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
EndpointSummary Summary of the language endpoint.
type EndpointSummary struct {
// Unique identifier endpoint OCID of an endpoint that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Endpoint compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the endpoint.
ProjectId *string `mandatory:"true" json:"projectId"`
// The time the the endpoint was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the endpoint.
LifecycleState EndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
ModelId *string `mandatory:"true" json:"modelId"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// Compute infra type for endpoint.
ComputeType EndpointSummaryComputeTypeEnum `mandatory:"false" json:"computeType,omitempty"`
// A short description of the endpoint.
Description *string `mandatory:"false" json:"description"`
// 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"`
// Number of replicas required for this endpoint. This will be optional parameter. Default will be 1.
InferenceUnits *int `mandatory:"false" json:"inferenceUnits"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m EndpointSummary) String() string
func (m EndpointSummary) 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
EndpointSummaryComputeTypeEnum Enum with underlying type: string
type EndpointSummaryComputeTypeEnum string
Set of constants representing the allowable values for EndpointSummaryComputeTypeEnum
const (
EndpointSummaryComputeTypeCpu EndpointSummaryComputeTypeEnum = "CPU"
EndpointSummaryComputeTypeGpu EndpointSummaryComputeTypeEnum = "GPU"
)
func GetEndpointSummaryComputeTypeEnumValues() []EndpointSummaryComputeTypeEnum
GetEndpointSummaryComputeTypeEnumValues Enumerates the set of values for EndpointSummaryComputeTypeEnum
func GetMappingEndpointSummaryComputeTypeEnum(val string) (EndpointSummaryComputeTypeEnum, bool)
GetMappingEndpointSummaryComputeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Entity entity object
type Entity struct {
// The number of Unicode code points preceding this entity in the submitted text.
Offset *int `mandatory:"false" json:"offset"`
// Length of entity text
Length *int `mandatory:"false" json:"length"`
// Entity text like name of person, location, and so on.
Text *string `mandatory:"false" json:"text"`
// Type of entity text like PER, LOC, GPE and NOPE.
Type *string `mandatory:"false" json:"type"`
// This flag is to indicate if it is PII entity or not.
IsPii *bool `mandatory:"false" json:"isPii"`
// Score or confidence of extracted entity type.
// Example: `0.9999856066867399`
Score *float64 `mandatory:"false" json:"score"`
}
func (m Entity) String() string
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
EntityDocumentResult The document response for entities detect call.
type EntityDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// List of detected entities.
Entities []HierarchicalEntity `mandatory:"true" json:"entities"`
// Language code supported
// - auto : Automatically detect language
// - ar : Arabic
// - pt-BR : Brazilian Portuguese
// - cs : Czech
// - da : Danish
// - nl : Dutch
// - en : English
// - fi : Finnish
// - fr : French
// - fr-CA : Canadian French
// - de : German
// - it : Italian
// - ja : Japanese
// - ko : Korean
// - no : Norwegian
// - pl : Polish
// - ro : Romanian
// - zh-CN : Simplified Chinese
// - es : Spanish
// - sv : Swedish
// - zh-TW : Traditional Chinese
// - tr : Turkish
// - el : Greek
// - he : Hebrew
LanguageCode *string `mandatory:"true" json:"languageCode"`
}
func (m EntityDocumentResult) String() string
func (m EntityDocumentResult) 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
EntityLabelErrorAnalysis Possible entity error label error details
type EntityLabelErrorAnalysis struct {
// Type of entity text like PER, LOC, GPE, NOPE etc.
Type *string `mandatory:"true" json:"type"`
// Starting index on text.
Offset *int `mandatory:"true" json:"offset"`
// Length of text
Length *int `mandatory:"true" json:"length"`
}
func (m EntityLabelErrorAnalysis) String() string
func (m EntityLabelErrorAnalysis) 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
EntityMetrics Entity level named entity recognition model metrics
type EntityMetrics struct {
// Entity label
Label *string `mandatory:"true" json:"label"`
// F1-score, is a measure of a model’s accuracy on a dataset
F1 *float32 `mandatory:"true" json:"f1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
Precision *float32 `mandatory:"true" json:"precision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
Recall *float32 `mandatory:"true" json:"recall"`
}
func (m EntityMetrics) String() string
func (m EntityMetrics) 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
ErrorDetails Error Information.
type ErrorDetails struct {
// A short error code that defines the error, meant for programmatic parsing.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
}
func (m ErrorDetails) String() string
func (m ErrorDetails) 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
EvaluationResultCollection Results of a model evaluation analysis search. Contains EvaluationResultSummary items.
type EvaluationResultCollection struct {
// List of model evaluation analysis
Items []EvaluationResultSummary `mandatory:"true" json:"items"`
}
func (m EvaluationResultCollection) String() string
func (m *EvaluationResultCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m EvaluationResultCollection) 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
EvaluationResultSummary model evaluation analysis of different models
type EvaluationResultSummary interface {
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
EvaluationResults model training results of different models
type EvaluationResults interface {
}
GetEndpointRequest wrapper for the GetEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetEndpoint.go.html to see an example of how to use GetEndpointRequest.
type GetEndpointRequest struct {
// The OCID of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEndpointRequest) String() string
func (request GetEndpointRequest) 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
GetEndpointResponse wrapper for the GetEndpoint operation
type GetEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The Endpoint instance
Endpoint `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEndpointResponse) String() string
GetJobRequest wrapper for the GetJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetJob.go.html to see an example of how to use GetJobRequest.
type GetJobRequest struct {
// Unique Transcription Job identifier.
JobId *string `mandatory:"true" contributesTo:"path" name:"jobId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetJobRequest) String() string
func (request GetJobRequest) 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
GetJobResponse wrapper for the GetJob operation
type GetJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The Job instance
Job `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetJobResponse) String() string
GetModelRequest wrapper for the GetModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetModel.go.html to see an example of how to use GetModelRequest.
type GetModelRequest struct {
// unique model OCID.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetModelRequest) String() string
func (request GetModelRequest) 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
GetModelResponse wrapper for the GetModel operation
type GetModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Model instance
Model `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetModelResponse) String() string
GetModelTypeRequest wrapper for the GetModelType operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetModelType.go.html to see an example of how to use GetModelTypeRequest.
type GetModelTypeRequest struct {
// Results like version and model supported info by specifying model type
ModelType *string `mandatory:"true" contributesTo:"path" name:"modelType"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetModelTypeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetModelTypeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetModelTypeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetModelTypeRequest) String() string
func (request GetModelTypeRequest) 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
GetModelTypeResponse wrapper for the GetModelType operation
type GetModelTypeResponse struct {
// The underlying http response
RawResponse *http.Response
// The ModelTypeInfo instance
ModelTypeInfo `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"`
}
func (response GetModelTypeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetModelTypeResponse) String() string
GetProjectRequest wrapper for the GetProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetProject.go.html to see an example of how to use GetProjectRequest.
type GetProjectRequest struct {
// The OCID of the project.
ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProjectRequest) String() string
func (request GetProjectRequest) 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
GetProjectResponse wrapper for the GetProject operation
type GetProjectResponse struct {
// The underlying http response
RawResponse *http.Response
// The Project instance
Project `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProjectResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) 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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HealthEntity Health entity object
type HealthEntity struct {
// The number of Unicode code points preceding this entity in the submitted text.
Offset *int `mandatory:"true" json:"offset"`
// Length of entity text
Length *int `mandatory:"true" json:"length"`
// Entity text like name of person, location, and so on.
Text *string `mandatory:"true" json:"text"`
// Type of entity text like PER, LOC.
Type *string `mandatory:"true" json:"type"`
// Score or confidence for detected entity.
Score *float64 `mandatory:"true" json:"score"`
// Unique id of the entity
Id *string `mandatory:"true" json:"id"`
// Sub-type of entity text like GPE for LOCATION type
SubType *string `mandatory:"false" json:"subType"`
// Entity category e.g, MEDICAL_CONDITION, MEDICATION, GENERAL, ANATOMY
Category *string `mandatory:"false" json:"category"`
// list of all assertions associated with this entity.
Assertions []AssertionDetails `mandatory:"false" json:"assertions"`
// This contains the list of matched concepts which are ranked by the relevant score with the input text
MatchedConcepts []MelConcept `mandatory:"false" json:"matchedConcepts"`
}
func (m HealthEntity) String() string
func (m HealthEntity) 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
HealthEntityDocumentResult The document response for health entity detect call.
type HealthEntityDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// List of detected entities.
Entities []HealthEntity `mandatory:"true" json:"entities"`
// Map of resolved entities by entity type
ResolvedEntities map[string]ResolvedEntities `mandatory:"true" json:"resolvedEntities"`
// Language code of the document. Please refer to respective model API documentation (https://docs.oracle.com/iaas/language/using/overview.htm) for supported languages.
LanguageCode *string `mandatory:"true" json:"languageCode"`
// List of succeeded document response.
Relations []RelationEntity `mandatory:"false" json:"relations"`
}
func (m HealthEntityDocumentResult) String() string
func (m HealthEntityDocumentResult) 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
HealthNluModelDetails Possible health NLU model information.
type HealthNluModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. If nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m HealthNluModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m HealthNluModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m HealthNluModelDetails) String() string
func (m HealthNluModelDetails) 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
HierarchicalEntity Hierarchical entity object
type HierarchicalEntity struct {
MetaInfo *MetaInfo `mandatory:"false" json:"metaInfo"`
// The number of Unicode code points preceding this entity in the submitted text.
Offset *int `mandatory:"false" json:"offset"`
// Length of entity text
Length *int `mandatory:"false" json:"length"`
// Entity text like name of person, location, and so on.
Text *string `mandatory:"false" json:"text"`
// Type of entity text like PER, LOC.
Type *string `mandatory:"false" json:"type"`
// Sub-type of entity text like GPE for LOCATION type
SubType *string `mandatory:"false" json:"subType"`
// Score or confidence for detected entity.
Score *float64 `mandatory:"false" json:"score"`
}
func (m HierarchicalEntity) String() string
func (m HierarchicalEntity) 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
InputConfiguration input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
type InputConfiguration struct {
// Type of documents supported
// for this release only TXT,CSV and one element is allowed here.
// for future scope this is marked as list
DocumentTypes []string `mandatory:"false" json:"documentTypes"`
// meta data about documents
// For CSV valid JSON format is {"CSV" :{inputColumn: "reviewDetails", rowId: "reviewId", copyColumnsToOutput: ["reviewId" "userId"] , delimiter: ","}
// Note: In future if new file types added we will update here in documentation about input file meta data
Configuration map[string]DocumentsConfiguration `mandatory:"false" json:"configuration"`
}
func (m InputConfiguration) String() string
func (m InputConfiguration) 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
InputLocation document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
type InputLocation interface {
}
InputLocationLocationTypeEnum Enum with underlying type: string
type InputLocationLocationTypeEnum string
Set of constants representing the allowable values for InputLocationLocationTypeEnum
const (
InputLocationLocationTypePrefix InputLocationLocationTypeEnum = "OBJECT_STORAGE_PREFIX"
InputLocationLocationTypeFileList InputLocationLocationTypeEnum = "OBJECT_STORAGE_FILE_LIST"
)
func GetInputLocationLocationTypeEnumValues() []InputLocationLocationTypeEnum
GetInputLocationLocationTypeEnumValues Enumerates the set of values for InputLocationLocationTypeEnum
func GetMappingInputLocationLocationTypeEnum(val string) (InputLocationLocationTypeEnum, bool)
GetMappingInputLocationLocationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Job Job details which contain input document details on which prediction need to run, features (which and all language services ) need to run and where to store results
type Job struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.
Id *string `mandatory:"true" json:"id"`
InputLocation InputLocation `mandatory:"true" json:"inputLocation"`
// training model details
// For this release only one model is allowed to be input here.
// One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
ModelMetadataDetails []ModelMetadataDetails `mandatory:"true" json:"modelMetadataDetails"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
OutputLocation *ObjectPrefixOutputLocation `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"`
InputConfiguration *InputConfiguration `mandatory:"false" json:"inputConfiguration"`
// The current state of the Job.
LifecycleState JobLifecycleStateEnum `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"`
// How much progress the operation has made, vs the total amount of work that must be performed.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
// Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
TotalDocuments *int `mandatory:"false" json:"totalDocuments"`
// Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
PendingDocuments *int `mandatory:"false" json:"pendingDocuments"`
// Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
CompletedDocuments *int `mandatory:"false" json:"completedDocuments"`
// Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
FailedDocuments *int `mandatory:"false" json:"failedDocuments"`
// warnings count
WarningsCount *int `mandatory:"false" json:"warningsCount"`
// Time to live duration in days for Job. Job will be available till max 90 days.
TtlInDays *int `mandatory:"false" json:"ttlInDays"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Job accepted time.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// Job started time.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Job finished time.
TimeCompleted *common.SDKTime `mandatory:"false" json:"timeCompleted"`
}
func (m Job) String() string
func (m *Job) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Job) 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
JobCollection list of Jobs created in the compartment and/or after applying filters based on filters provided by user
type JobCollection struct {
// List of jobs.
Items []JobSummary `mandatory:"true" json:"items"`
}
func (m JobCollection) String() string
func (m JobCollection) 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
JobLifecycleStateEnum Enum with underlying type: string
type JobLifecycleStateEnum string
Set of constants representing the allowable values for JobLifecycleStateEnum
const (
JobLifecycleStateAccepted JobLifecycleStateEnum = "ACCEPTED"
JobLifecycleStateInProgress JobLifecycleStateEnum = "IN_PROGRESS"
JobLifecycleStateSucceeded JobLifecycleStateEnum = "SUCCEEDED"
JobLifecycleStateFailed JobLifecycleStateEnum = "FAILED"
JobLifecycleStateCanceling JobLifecycleStateEnum = "CANCELING"
JobLifecycleStateCanceled JobLifecycleStateEnum = "CANCELED"
JobLifecycleStateDeleting JobLifecycleStateEnum = "DELETING"
JobLifecycleStateDeleted JobLifecycleStateEnum = "DELETED"
)
func GetJobLifecycleStateEnumValues() []JobLifecycleStateEnum
GetJobLifecycleStateEnumValues Enumerates the set of values for JobLifecycleStateEnum
func GetMappingJobLifecycleStateEnum(val string) (JobLifecycleStateEnum, bool)
GetMappingJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
JobSummary sub set of Job details data which need returns in list API
type JobSummary struct {
// The OCID (https://docs.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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A short description of the job.
Description *string `mandatory:"false" json:"description"`
// The current state of the Speech Job.
LifecycleState JobLifecycleStateEnum `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"`
// How much progress the operation has made, vs the total amount of work that must be performed.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
// Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
TotalDocuments *int `mandatory:"false" json:"totalDocuments"`
// Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
PendingDocuments *int `mandatory:"false" json:"pendingDocuments"`
// Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
CompletedDocuments *int `mandatory:"false" json:"completedDocuments"`
// Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
FailedDocuments *int `mandatory:"false" json:"failedDocuments"`
// warnings count
WarningsCount *int `mandatory:"false" json:"warningsCount"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Job accepted time.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// Job started time.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Job finished time.
TimeCompleted *common.SDKTime `mandatory:"false" json:"timeCompleted"`
}
func (m JobSummary) String() string
func (m JobSummary) 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
KeyPhrase Key phrase for the given text.
type KeyPhrase struct {
// Key phrase exreacted from given text.
Text *string `mandatory:"true" json:"text"`
// Score or confidence of the key phrase.
// Example: `0.9999856066867399`
Score *float64 `mandatory:"true" json:"score"`
}
func (m KeyPhrase) String() string
func (m KeyPhrase) 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
KeyPhraseDocumentResult The document response for keyPhrases detect call.
type KeyPhraseDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// List of detected keyPhrases.
KeyPhrases []KeyPhrase `mandatory:"true" json:"keyPhrases"`
// Language code supported
// - auto : Automatically detect language
// - ar : Arabic
// - pt-BR : Brazilian Portuguese
// - cs : Czech
// - da : Danish
// - nl : Dutch
// - en : English
// - fi : Finnish
// - fr : French
// - fr-CA : Canadian French
// - de : German
// - it : Italian
// - ja : Japanese
// - ko : Korean
// - no : Norwegian
// - pl : Polish
// - ro : Romanian
// - zh-CN : Simplified Chinese
// - es : Spanish
// - sv : Swedish
// - zh-TW : Traditional Chinese
// - tr : Turkish
// - el : Greek
// - he : Hebrew
LanguageCode *string `mandatory:"true" json:"languageCode"`
}
func (m KeyPhraseDocumentResult) String() string
func (m KeyPhraseDocumentResult) 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
ListEndpointsRequest wrapper for the ListEndpoints operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListEndpoints.go.html to see an example of how to use ListEndpointsRequest.
type ListEndpointsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID of the endpoint.
EndpointId *string `mandatory:"false" contributesTo:"query" name:"endpointId"`
// The ID of the project for which to list the objects.
ProjectId *string `mandatory:"false" contributesTo:"query" name:"projectId"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The ID of the trained model for which to list the endpoints.
ModelId *string `mandatory:"false" contributesTo:"query" name:"modelId"`
// <b>Filter</b> results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState EndpointLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the field to sort by. Accepts only one field.
// By default, when you sort by `timeCreated`, the results are shown
// in descending order. When you sort by `displayName`, the results are
// shown in ascending order. Sort order for the `displayName` field is case sensitive.
SortBy ListEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEndpointsRequest) String() string
func (request ListEndpointsRequest) 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
ListEndpointsResponse wrapper for the ListEndpoints operation
type ListEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EndpointCollection instances
EndpointCollection `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"`
}
func (response ListEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEndpointsResponse) String() string
ListEndpointsSortByEnum Enum with underlying type: string
type ListEndpointsSortByEnum string
Set of constants representing the allowable values for ListEndpointsSortByEnum
const (
ListEndpointsSortByTimecreated ListEndpointsSortByEnum = "timeCreated"
ListEndpointsSortByDisplayname ListEndpointsSortByEnum = "displayName"
)
func GetListEndpointsSortByEnumValues() []ListEndpointsSortByEnum
GetListEndpointsSortByEnumValues Enumerates the set of values for ListEndpointsSortByEnum
func GetMappingListEndpointsSortByEnum(val string) (ListEndpointsSortByEnum, bool)
GetMappingListEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEndpointsSortOrderEnum Enum with underlying type: string
type ListEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListEndpointsSortOrderEnum
const (
ListEndpointsSortOrderAsc ListEndpointsSortOrderEnum = "ASC"
ListEndpointsSortOrderDesc ListEndpointsSortOrderEnum = "DESC"
)
func GetListEndpointsSortOrderEnumValues() []ListEndpointsSortOrderEnum
GetListEndpointsSortOrderEnumValues Enumerates the set of values for ListEndpointsSortOrderEnum
func GetMappingListEndpointsSortOrderEnum(val string) (ListEndpointsSortOrderEnum, bool)
GetMappingListEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEvaluationResultsRequest wrapper for the ListEvaluationResults operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListEvaluationResults.go.html to see an example of how to use ListEvaluationResultsRequest.
type ListEvaluationResultsRequest struct {
// unique model OCID.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListEvaluationResultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEvaluationResultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEvaluationResultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEvaluationResultsRequest) String() string
func (request ListEvaluationResultsRequest) 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
ListEvaluationResultsResponse wrapper for the ListEvaluationResults operation
type ListEvaluationResultsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EvaluationResultCollection instances
EvaluationResultCollection `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"`
}
func (response ListEvaluationResultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEvaluationResultsResponse) String() string
ListJobsRequest wrapper for the ListJobs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListJobs.go.html to see an example of how to use ListJobsRequest.
type ListJobsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources whose lifecycleState matches the given lifecycleState.
LifecycleState JobLifecycleStateEnum `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"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListJobsSortOrderEnum `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 ListJobsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListJobsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListJobsRequest) String() string
func (request ListJobsRequest) 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
ListJobsResponse wrapper for the ListJobs operation
type ListJobsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of JobCollection instances
JobCollection `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"`
}
func (response ListJobsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListJobsResponse) String() string
ListJobsSortByEnum Enum with underlying type: string
type ListJobsSortByEnum string
Set of constants representing the allowable values for ListJobsSortByEnum
const (
ListJobsSortByTimecreated ListJobsSortByEnum = "timeCreated"
ListJobsSortByDisplayname ListJobsSortByEnum = "displayName"
)
func GetListJobsSortByEnumValues() []ListJobsSortByEnum
GetListJobsSortByEnumValues Enumerates the set of values for ListJobsSortByEnum
func GetMappingListJobsSortByEnum(val string) (ListJobsSortByEnum, bool)
GetMappingListJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListJobsSortOrderEnum Enum with underlying type: string
type ListJobsSortOrderEnum string
Set of constants representing the allowable values for ListJobsSortOrderEnum
const (
ListJobsSortOrderAsc ListJobsSortOrderEnum = "ASC"
ListJobsSortOrderDesc ListJobsSortOrderEnum = "DESC"
)
func GetListJobsSortOrderEnumValues() []ListJobsSortOrderEnum
GetListJobsSortOrderEnumValues Enumerates the set of values for ListJobsSortOrderEnum
func GetMappingListJobsSortOrderEnum(val string) (ListJobsSortOrderEnum, bool)
GetMappingListJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListModelsRequest wrapper for the ListModels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListModels.go.html to see an example of how to use ListModelsRequest.
type ListModelsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// unique model OCID.
ModelId *string `mandatory:"false" contributesTo:"query" name:"modelId"`
// The ID of the project for which to list the objects.
ProjectId *string `mandatory:"false" contributesTo:"query" name:"projectId"`
// <b>Filter</b> results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ModelLifecycleStateEnum `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"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListModelsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the field to sort by. Accepts only one field.
// By default, when you sort by `timeCreated`, the results are shown
// in descending order. When you sort by `displayName`, the results are
// shown in ascending order. Sort order for the `displayName` field is case sensitive.
SortBy ListModelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListModelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListModelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListModelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListModelsRequest) String() string
func (request ListModelsRequest) 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
ListModelsResponse wrapper for the ListModels operation
type ListModelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ModelCollection instances
ModelCollection `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"`
}
func (response ListModelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListModelsResponse) String() string
ListModelsSortByEnum Enum with underlying type: string
type ListModelsSortByEnum string
Set of constants representing the allowable values for ListModelsSortByEnum
const (
ListModelsSortByTimecreated ListModelsSortByEnum = "timeCreated"
ListModelsSortByDisplayname ListModelsSortByEnum = "displayName"
)
func GetListModelsSortByEnumValues() []ListModelsSortByEnum
GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum
func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)
GetMappingListModelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListModelsSortOrderEnum Enum with underlying type: string
type ListModelsSortOrderEnum string
Set of constants representing the allowable values for ListModelsSortOrderEnum
const (
ListModelsSortOrderAsc ListModelsSortOrderEnum = "ASC"
ListModelsSortOrderDesc ListModelsSortOrderEnum = "DESC"
)
func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum
GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum
func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)
GetMappingListModelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListProjectsRequest wrapper for the ListProjects operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListProjects.go.html to see an example of how to use ListProjectsRequest.
type ListProjectsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// <b>Filter</b> results by the specified lifecycle state. Must be a valid
// state for the resource type.
LifecycleState ProjectLifecycleStateEnum `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"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The ID of the project for which to list the objects.
ProjectId *string `mandatory:"false" contributesTo:"query" name:"projectId"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListProjectsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the field to sort by. Accepts only one field.
// By default, when you sort by `timeCreated`, the results are shown
// in descending order. When you sort by `displayName`, the results are
// shown in ascending order. Sort order for the `displayName` field is case sensitive.
SortBy ListProjectsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListProjectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProjectsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProjectsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProjectsRequest) String() string
func (request ListProjectsRequest) 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
ListProjectsResponse wrapper for the ListProjects operation
type ListProjectsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProjectCollection instances
ProjectCollection `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"`
}
func (response ListProjectsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProjectsResponse) String() string
ListProjectsSortByEnum Enum with underlying type: string
type ListProjectsSortByEnum string
Set of constants representing the allowable values for ListProjectsSortByEnum
const (
ListProjectsSortByTimecreated ListProjectsSortByEnum = "timeCreated"
ListProjectsSortByDisplayname ListProjectsSortByEnum = "displayName"
)
func GetListProjectsSortByEnumValues() []ListProjectsSortByEnum
GetListProjectsSortByEnumValues Enumerates the set of values for ListProjectsSortByEnum
func GetMappingListProjectsSortByEnum(val string) (ListProjectsSortByEnum, bool)
GetMappingListProjectsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListProjectsSortOrderEnum Enum with underlying type: string
type ListProjectsSortOrderEnum string
Set of constants representing the allowable values for ListProjectsSortOrderEnum
const (
ListProjectsSortOrderAsc ListProjectsSortOrderEnum = "ASC"
ListProjectsSortOrderDesc ListProjectsSortOrderEnum = "DESC"
)
func GetListProjectsSortOrderEnumValues() []ListProjectsSortOrderEnum
GetListProjectsSortOrderEnumValues Enumerates the set of values for ListProjectsSortOrderEnum
func GetMappingListProjectsSortOrderEnum(val string) (ListProjectsSortOrderEnum, bool)
GetMappingListProjectsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestErrorsSortOrderEnum `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. If no value is specified timeCreated is default.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) 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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
ListWorkRequestErrorsSortByDisplayname ListWorkRequestErrorsSortByEnum = "displayName"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestLogsSortOrderEnum `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. If no value is specified timeCreated is default.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) 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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogCollection instances
WorkRequestLogCollection `presentIn:"body"`
// 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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
ListWorkRequestLogsSortByDisplayname ListWorkRequestLogsSortByEnum = "displayName"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The ID of the resource for which list workrequests.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestsSortOrderEnum `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. If no value is specified timeCreated is default.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) 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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimecreated ListWorkRequestsSortByEnum = "timeCreated"
ListWorkRequestsSortByDisplayname ListWorkRequestsSortByEnum = "displayName"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
LocationDetails Possible object storage location types
type LocationDetails interface {
}
LocationDetailsLocationTypeEnum Enum with underlying type: string
type LocationDetailsLocationTypeEnum string
Set of constants representing the allowable values for LocationDetailsLocationTypeEnum
const (
LocationDetailsLocationTypeObjectList LocationDetailsLocationTypeEnum = "OBJECT_LIST"
)
func GetLocationDetailsLocationTypeEnumValues() []LocationDetailsLocationTypeEnum
GetLocationDetailsLocationTypeEnumValues Enumerates the set of values for LocationDetailsLocationTypeEnum
func GetMappingLocationDetailsLocationTypeEnum(val string) (LocationDetailsLocationTypeEnum, bool)
GetMappingLocationDetailsLocationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
MelConcept The MEL concepts details for health ner.
type MelConcept struct {
// Name of the ontology to which the Entity is mapped
OntologyName *string `mandatory:"true" json:"ontologyName"`
// This contains the list of matched concepts which are ranked by the relevant score with the input text
Concepts []MelConceptDetails `mandatory:"true" json:"concepts"`
}
func (m MelConcept) String() string
func (m MelConcept) 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
MelConceptDetails The MEL concepts details for health ner.
type MelConceptDetails struct {
// id of the relation
Id *string `mandatory:"true" json:"id"`
// The matched concept name/description on the ontology
Name *string `mandatory:"true" json:"name"`
// The relevant score between the concept and the input text
Score *float64 `mandatory:"true" json:"score"`
// additional attribute values specific to ontology for ex. for SNOMED semantic_type and for for ICD-10 default_charge_code etc.
Attributes map[string]string `mandatory:"false" json:"attributes"`
}
func (m MelConceptDetails) String() string
func (m MelConceptDetails) 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
MetaInfo MetaInfo of entity detected.
type MetaInfo struct {
// The number of Unicode code points preceding this entity in the submitted text.
Offset *int `mandatory:"false" json:"offset"`
// Length of entity text.
Length *int `mandatory:"false" json:"length"`
// Entity text like name of person, location, and so on.
Text *string `mandatory:"false" json:"text"`
// Sub-type of entity text like GPE for LOCATION type.
SubType *string `mandatory:"false" json:"subType"`
// Score or confidence for detected entity.
Score *float64 `mandatory:"false" json:"score"`
}
func (m MetaInfo) String() string
func (m MetaInfo) 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
Model Description of the a Model.
type Model struct {
// Unique identifier model OCID of a model that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the model's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model.
ProjectId *string `mandatory:"true" json:"projectId"`
ModelDetails ModelDetails `mandatory:"true" json:"modelDetails"`
// The time the the model was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the model.
LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A short description of the Model.
Description *string `mandatory:"false" json:"description"`
// The time the model was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
TrainingDataset DatasetDetails `mandatory:"false" json:"trainingDataset"`
EvaluationResults EvaluationResults `mandatory:"false" json:"evaluationResults"`
TestStrategy TestStrategy `mandatory:"false" json:"testStrategy"`
// For pre trained models this will identify model type version used for model creation
// For custom this will identify model type version used for model creation and custom model on which training has to be done
// <<service>>::<<service-name>>_<<model-type-version>>::<<custom model on which this training has to be done>>
// ex: ai-lang::NER_V1::CUSTOM-V0
Version *string `mandatory:"false" json:"version"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Model) String() string
func (m *Model) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Model) 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
ModelCollection Results of a model search. Contains ModelSummary items.
type ModelCollection struct {
// List of models
Items []ModelSummary `mandatory:"true" json:"items"`
}
func (m ModelCollection) String() string
func (m ModelCollection) 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
ModelDetails Possible model types
type ModelDetails interface {
// supported language default value is en
GetLanguageCode() *string
}
ModelDetailsModelTypeEnum Enum with underlying type: string
type ModelDetailsModelTypeEnum string
Set of constants representing the allowable values for ModelDetailsModelTypeEnum
const (
ModelDetailsModelTypeNamedEntityRecognition ModelDetailsModelTypeEnum = "NAMED_ENTITY_RECOGNITION"
ModelDetailsModelTypeTextClassification ModelDetailsModelTypeEnum = "TEXT_CLASSIFICATION"
ModelDetailsModelTypePreTrainedNamedEntityRecognition ModelDetailsModelTypeEnum = "PRE_TRAINED_NAMED_ENTITY_RECOGNITION"
ModelDetailsModelTypePreTrainedTextClassification ModelDetailsModelTypeEnum = "PRE_TRAINED_TEXT_CLASSIFICATION"
ModelDetailsModelTypePreTrainedSentimentAnalysis ModelDetailsModelTypeEnum = "PRE_TRAINED_SENTIMENT_ANALYSIS"
ModelDetailsModelTypePreTrainedKeyphraseExtraction ModelDetailsModelTypeEnum = "PRE_TRAINED_KEYPHRASE_EXTRACTION"
ModelDetailsModelTypePreTrainedLanguageDetection ModelDetailsModelTypeEnum = "PRE_TRAINED_LANGUAGE_DETECTION"
ModelDetailsModelTypePreTrainedPii ModelDetailsModelTypeEnum = "PRE_TRAINED_PII"
ModelDetailsModelTypePreTrainedHealthNlu ModelDetailsModelTypeEnum = "PRE_TRAINED_HEALTH_NLU"
ModelDetailsModelTypePreTrainedSummarization ModelDetailsModelTypeEnum = "PRE_TRAINED_SUMMARIZATION"
ModelDetailsModelTypePreTrainedUniversal ModelDetailsModelTypeEnum = "PRE_TRAINED_UNIVERSAL"
ModelDetailsModelTypePii ModelDetailsModelTypeEnum = "PII"
ModelDetailsModelTypePreTrainedTranslation ModelDetailsModelTypeEnum = "PRE_TRAINED_TRANSLATION"
ModelDetailsModelTypeHealthNlu ModelDetailsModelTypeEnum = "HEALTH_NLU"
)
func GetMappingModelDetailsModelTypeEnum(val string) (ModelDetailsModelTypeEnum, bool)
GetMappingModelDetailsModelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelDetailsModelTypeEnumValues() []ModelDetailsModelTypeEnum
GetModelDetailsModelTypeEnumValues Enumerates the set of values for ModelDetailsModelTypeEnum
ModelLifecycleStateEnum Enum with underlying type: string
type ModelLifecycleStateEnum string
Set of constants representing the allowable values for ModelLifecycleStateEnum
const (
ModelLifecycleStateDeleting ModelLifecycleStateEnum = "DELETING"
ModelLifecycleStateDeleted ModelLifecycleStateEnum = "DELETED"
ModelLifecycleStateFailed ModelLifecycleStateEnum = "FAILED"
ModelLifecycleStateCreating ModelLifecycleStateEnum = "CREATING"
ModelLifecycleStateActive ModelLifecycleStateEnum = "ACTIVE"
ModelLifecycleStateUpdating ModelLifecycleStateEnum = "UPDATING"
)
func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)
GetMappingModelLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum
GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum
ModelMetadataDetails training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
type ModelMetadataDetails struct {
// model type to used for inference allowed values are
// - LANGUAGE_SENTIMENT_ANALYSIS
// - LANGUAGE_DETECTION
// - TEXT_CLASSIFICATION
// - NAMED_ENTITY_RECOGNITION
// - KEY_PHRASE_EXTRACTION
// - LANGUAGE_PII_ENTITIES
// - LANGUAGE_TRANSLATION
ModelType *string `mandatory:"false" json:"modelType"`
// Unique identifier model OCID that should be used for inference
ModelId *string `mandatory:"false" json:"modelId"`
// Unique identifier endpoint OCID that should be used for inference
EndpointId *string `mandatory:"false" json:"endpointId"`
// Language code supported
// - auto : Automatically detect language
// - ar : Arabic
// - pt-BR : Brazilian Portuguese
// - cs : Czech
// - da : Danish
// - nl : Dutch
// - en : English
// - fi : Finnish
// - fr : French
// - fr-CA : Canadian French
// - de : German
// - it : Italian
// - ja : Japanese
// - ko : Korean
// - no : Norwegian
// - pl : Polish
// - ro : Romanian
// - zh-CN : Simplified Chinese
// - es : Spanish
// - sv : Swedish
// - zh-TW : Traditional Chinese
// - tr : Turkish
// - el : Greek
// - he : Hebrew
LanguageCode *string `mandatory:"false" json:"languageCode"`
// model configuration details
// For PII : < ENTITY_TYPE , ConfigurationDetails>
// ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true }
// For language translation : { "targetLanguageCodes" : ConfigurationDetails}
Configuration map[string]ConfigurationDetails `mandatory:"false" json:"configuration"`
}
func (m ModelMetadataDetails) String() string
func (m ModelMetadataDetails) 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
ModelSummary Summary of the language Model.
type ModelSummary struct {
// Unique identifier model OCID of a model that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the model's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ModelDetails ModelDetails `mandatory:"true" json:"modelDetails"`
// The time the the Model was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the model.
LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model.
ProjectId *string `mandatory:"true" json:"projectId"`
// A short description of the Model.
Description *string `mandatory:"false" json:"description"`
// 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"`
// For pre trained models this will identify model type version used for model creation
// For custom this will identify model type version used for model creation and custom model on which training has to be done
// <<service>>::<<service-name>>_<<model-type-version>>::<<custom model on which this training has to be done>>
// ex: ai-lang::NER_V1::CUSTOM-V0
Version *string `mandatory:"false" json:"version"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ModelSummary) String() string
func (m *ModelSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ModelSummary) 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
ModelTypeInfo Model information like versions and capabilities
type ModelTypeInfo struct {
// Model information capabilities related to version
Capabilities map[string]Capabilities `mandatory:"true" json:"capabilities"`
// Model versions available for this model type
Versions []string `mandatory:"false" json:"versions"`
}
func (m ModelTypeInfo) String() string
func (m ModelTypeInfo) 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
NamedEntityRecognitionEvaluationResult Possible NER model error analysis
type NamedEntityRecognitionEvaluationResult struct {
// For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata)
Record *string `mandatory:"true" json:"record"`
// List of true(actual) entities in test data for NER model
TrueEntities []EntityLabelErrorAnalysis `mandatory:"true" json:"trueEntities"`
// List of true(actual) entities in test data for NER model
PredictedEntities []EntityLabelErrorAnalysis `mandatory:"true" json:"predictedEntities"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m NamedEntityRecognitionEvaluationResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m NamedEntityRecognitionEvaluationResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m NamedEntityRecognitionEvaluationResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NamedEntityRecognitionEvaluationResult) String() string
func (m NamedEntityRecognitionEvaluationResult) 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
NamedEntityRecognitionEvaluationResults Named entity recognition model testing and evaluation results
type NamedEntityRecognitionEvaluationResults struct {
Metrics *NamedEntityRecognitionModelMetrics `mandatory:"false" json:"metrics"`
// List of entity metrics
EntityMetrics []EntityMetrics `mandatory:"false" json:"entityMetrics"`
// class level confusion matrix
ConfusionMatrix map[string]ConfusionMatrixDetails `mandatory:"false" json:"confusionMatrix"`
// labels
Labels []string `mandatory:"false" json:"labels"`
}
func (m NamedEntityRecognitionEvaluationResults) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NamedEntityRecognitionEvaluationResults) String() string
func (m NamedEntityRecognitionEvaluationResults) 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
NamedEntityRecognitionModelDetails Possible NER model information
type NamedEntityRecognitionModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional if nothing specified latest base model will be used for training. Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m NamedEntityRecognitionModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m NamedEntityRecognitionModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NamedEntityRecognitionModelDetails) String() string
func (m NamedEntityRecognitionModelDetails) 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
NamedEntityRecognitionModelMetrics Model level named entity recognition metrics
type NamedEntityRecognitionModelMetrics struct {
// F1-score, is a measure of a model’s accuracy on a dataset
MicroF1 *float32 `mandatory:"true" json:"microF1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
MicroPrecision *float32 `mandatory:"true" json:"microPrecision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
MicroRecall *float32 `mandatory:"true" json:"microRecall"`
// F1-score, is a measure of a model’s accuracy on a dataset
MacroF1 *float32 `mandatory:"true" json:"macroF1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
MacroPrecision *float32 `mandatory:"true" json:"macroPrecision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
MacroRecall *float32 `mandatory:"true" json:"macroRecall"`
// F1-score, is a measure of a model’s accuracy on a dataset
WeightedF1 *float32 `mandatory:"false" json:"weightedF1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
WeightedPrecision *float32 `mandatory:"false" json:"weightedPrecision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
WeightedRecall *float32 `mandatory:"false" json:"weightedRecall"`
}
func (m NamedEntityRecognitionModelMetrics) String() string
func (m NamedEntityRecognitionModelMetrics) 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
NerModelVersionEnum Enum with underlying type: string
type NerModelVersionEnum string
Set of constants representing the allowable values for NerModelVersionEnum
const (
NerModelVersionV21 NerModelVersionEnum = "V2_1"
NerModelVersionV11 NerModelVersionEnum = "V1_1"
)
func GetMappingNerModelVersionEnum(val string) (NerModelVersionEnum, bool)
GetMappingNerModelVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNerModelVersionEnumValues() []NerModelVersionEnum
GetNerModelVersionEnumValues Enumerates the set of values for NerModelVersionEnum
ObjectListDataset Data source details for object storage
type ObjectListDataset struct {
// Object storage namespace
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Object storage bucket name
BucketName *string `mandatory:"true" json:"bucketName"`
// Array of files which need to be processed in the bucket
ObjectNames []string `mandatory:"true" json:"objectNames"`
}
func (m ObjectListDataset) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectListDataset) String() string
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
ObjectPrefixOutputLocation Object storage output location to write inference results
type ObjectPrefixOutputLocation struct {
// Object Storage namespace name.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// The prefix (directory) in an Object Storage bucket.
Prefix *string `mandatory:"false" json:"prefix"`
}
func (m ObjectPrefixOutputLocation) String() string
func (m ObjectPrefixOutputLocation) 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
ObjectStorageDataset Different type of location types supported for object storage
type ObjectStorageDataset struct {
LocationDetails LocationDetails `mandatory:"true" json:"locationDetails"`
}
func (m ObjectStorageDataset) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageDataset) String() string
func (m *ObjectStorageDataset) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
ObjectStorageFileNameLocation list of text files need to be used for prediction
type ObjectStorageFileNameLocation struct {
// Object Storage namespace name.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// List of objects to be processed
ObjectNames []string `mandatory:"true" json:"objectNames"`
}
func (m ObjectStorageFileNameLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageFileNameLocation) String() string
func (m ObjectStorageFileNameLocation) 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
ObjectStoragePrefixLocation Properties specific to object storage prefix location
type ObjectStoragePrefixLocation struct {
// Object Storage namespace name.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// Object Storage bucket name.
BucketName *string `mandatory:"true" json:"bucketName"`
// The prefix (directory) in an Object Storage bucket.
Prefix *string `mandatory:"false" json:"prefix"`
}
func (m ObjectStoragePrefixLocation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStoragePrefixLocation) String() string
func (m ObjectStoragePrefixLocation) 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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateModel OperationTypeEnum = "CREATE_MODEL"
OperationTypeUpdateModel OperationTypeEnum = "UPDATE_MODEL"
OperationTypeDeleteModel OperationTypeEnum = "DELETE_MODEL"
OperationTypeCreateProject OperationTypeEnum = "CREATE_PROJECT"
OperationTypeUpdateProject OperationTypeEnum = "UPDATE_PROJECT"
OperationTypeDeleteProject OperationTypeEnum = "DELETE_PROJECT"
OperationTypeCreateEndpoint OperationTypeEnum = "CREATE_ENDPOINT"
OperationTypeUpdateEndpoint OperationTypeEnum = "UPDATE_ENDPOINT"
OperationTypeDeleteEndpoint OperationTypeEnum = "DELETE_ENDPOINT"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PiiEntity PII entity object.
type PiiEntity struct {
// The number of Unicode code points preceding this entity in the submitted text.
Offset *int `mandatory:"true" json:"offset"`
// Length of PII entity text.
Length *int `mandatory:"true" json:"length"`
// Entity text like name of person, Organization and so on.
Text *string `mandatory:"true" json:"text"`
// Entity type supported
// PERSON
// ADDRESS
// AGE
// DATE_TIME
// SSN_OR_TAXPAYER
// EMAIL
// PASSPORT_NUMBER_US
// TELEPHONE_NUMBER
// DRIVER_ID_US
// BANK_ACCOUNT_NUMBER
// BANK_SWIFT
// BANK_ROUTING
// CREDIT_DEBIT_NUMBER
// IP_ADDRESS
// MAC_ADDRESS
// COOKIE
// XSRF_TOKEN
// AUTH_BASIC
// AUTH_BEARER
// JSON_WEB_TOKEN
// PRIVATE_KEY
// PUBLIC_KEY
// OCI_OCID_USER
// OCI_OCID_TENANCY
// OCI_SMTP_USERNAME
// OCI_OCID_REFERENCE
// OCI_FINGERPRINT
// OCI_CREDENTIAL
// OCI_PRE_AUTH_REQUEST
// OCI_STORAGE_SIGNED_URL
// OCI_CUSTOMER_SECRET_KEY
// OCI_ACCESS_KEy
// MEDICAL_RECORD_NUMBER
// HEALTH_PLAN_ID
// URL
// CERTIFICATE_NUMBER
// FIN
// GUIDs
// VEHICLE_LICENSE_PLATE_US
// VEHICLE_IDENTIFIER_US
Type *string `mandatory:"true" json:"type"`
// Score or confidence for detected PII entity.
Score *float64 `mandatory:"true" json:"score"`
// Unique id of the entity.
Id *string `mandatory:"false" json:"id"`
}
func (m PiiEntity) String() string
func (m PiiEntity) 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
PiiEntityDocumentResult The document response for batch detect personal identification.
type PiiEntityDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// List of batch detect personal identification.
Entities []PiiEntity `mandatory:"true" json:"entities"`
// Masked text per given mask mode.
MaskedText *string `mandatory:"true" json:"maskedText"`
// Language code supported
// - auto : Automatically detect language
// - ar : Arabic
// - pt-BR : Brazilian Portuguese
// - cs : Czech
// - da : Danish
// - nl : Dutch
// - en : English
// - fi : Finnish
// - fr : French
// - fr-CA : Canadian French
// - de : German
// - it : Italian
// - ja : Japanese
// - ko : Korean
// - no : Norwegian
// - pl : Polish
// - ro : Romanian
// - zh-CN : Simplified Chinese
// - es : Spanish
// - sv : Swedish
// - zh-TW : Traditional Chinese
// - tr : Turkish
// - el : Greek
// - he : Hebrew
LanguageCode *string `mandatory:"true" json:"languageCode"`
}
func (m PiiEntityDocumentResult) String() string
func (m PiiEntityDocumentResult) 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
PiiEntityMask Mask PII entities with the given masking character.
type PiiEntityMask struct {
// List of offsets/entities to be removed from anonymization.
Exclude []string `mandatory:"false" json:"exclude"`
// To include excluded entities from masking in detected entities or not.
ShouldDetect *bool `mandatory:"false" json:"shouldDetect"`
// Masking character. By default, the character is an asterisk (*)
MaskingCharacter *string `mandatory:"false" json:"maskingCharacter"`
// Number of characters to leave unmasked. By default, the whole entity is masked.
LeaveCharactersUnmasked *int `mandatory:"false" json:"leaveCharactersUnmasked"`
// Unmask from the end. By default, the whole entity is masked. This field works in concert with
// leaveCharactersUnmasked. For example, leaveCharactersUnmasked is 3 and isUnmaskedFromEnd is true,
// then if the entity is India the masked entity/result is **dia.
IsUnmaskedFromEnd *bool `mandatory:"false" json:"isUnmaskedFromEnd"`
}
func (m PiiEntityMask) GetExclude() []string
GetExclude returns Exclude
func (m PiiEntityMask) GetShouldDetect() *bool
GetShouldDetect returns ShouldDetect
func (m PiiEntityMask) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PiiEntityMask) String() string
func (m PiiEntityMask) 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
PiiEntityMasking Mask recognized PII entities with different modes.
type PiiEntityMasking interface {
// List of offsets/entities to be removed from anonymization.
GetExclude() []string
// To include excluded entities from masking in detected entities or not.
GetShouldDetect() *bool
}
PiiEntityMaskingModeEnum Enum with underlying type: string
type PiiEntityMaskingModeEnum string
Set of constants representing the allowable values for PiiEntityMaskingModeEnum
const (
PiiEntityMaskingModeReplace PiiEntityMaskingModeEnum = "REPLACE"
PiiEntityMaskingModeMask PiiEntityMaskingModeEnum = "MASK"
PiiEntityMaskingModeRemove PiiEntityMaskingModeEnum = "REMOVE"
)
func GetMappingPiiEntityMaskingModeEnum(val string) (PiiEntityMaskingModeEnum, bool)
GetMappingPiiEntityMaskingModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPiiEntityMaskingModeEnumValues() []PiiEntityMaskingModeEnum
GetPiiEntityMaskingModeEnumValues Enumerates the set of values for PiiEntityMaskingModeEnum
PiiEntityRemove Remove PII entities from output.
type PiiEntityRemove struct {
// List of offsets/entities to be removed from anonymization.
Exclude []string `mandatory:"false" json:"exclude"`
// To include excluded entities from masking in detected entities or not.
ShouldDetect *bool `mandatory:"false" json:"shouldDetect"`
}
func (m PiiEntityRemove) GetExclude() []string
GetExclude returns Exclude
func (m PiiEntityRemove) GetShouldDetect() *bool
GetShouldDetect returns ShouldDetect
func (m PiiEntityRemove) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PiiEntityRemove) String() string
func (m PiiEntityRemove) 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
PiiEntityReplace Replace PII entities with a given sequence of characters.
type PiiEntityReplace struct {
// List of offsets/entities to be removed from anonymization.
Exclude []string `mandatory:"false" json:"exclude"`
// To include excluded entities from masking in detected entities or not.
ShouldDetect *bool `mandatory:"false" json:"shouldDetect"`
// Replace entities with given sequence of characters. By default PII entity will be replaced with <ENTITY_TYPE>.
ReplaceWith *string `mandatory:"false" json:"replaceWith"`
}
func (m PiiEntityReplace) GetExclude() []string
GetExclude returns Exclude
func (m PiiEntityReplace) GetShouldDetect() *bool
GetShouldDetect returns ShouldDetect
func (m PiiEntityReplace) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PiiEntityReplace) String() string
func (m PiiEntityReplace) 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
PiiModelDetails Possible Custom PII model information
type PiiModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PiiModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PiiModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PiiModelDetails) String() string
func (m PiiModelDetails) 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
PreDeployedLanguageModels Description of Language Entities.
type PreDeployedLanguageModels struct {
// Unique identifier that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Language Entities Description
Description *string `mandatory:"false" json:"description"`
}
func (m PreDeployedLanguageModels) String() string
func (m PreDeployedLanguageModels) 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
PreTrainedHealthNluModelDetails Possible pre trained health NLU model information
type PreTrainedHealthNluModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedHealthNluModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedHealthNluModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedHealthNluModelDetails) String() string
func (m PreTrainedHealthNluModelDetails) 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
PreTrainedKeyPhraseExtractionModelDetails Possible pre trained TXT model information
type PreTrainedKeyPhraseExtractionModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedKeyPhraseExtractionModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedKeyPhraseExtractionModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedKeyPhraseExtractionModelDetails) String() string
func (m PreTrainedKeyPhraseExtractionModelDetails) 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
PreTrainedLanguageDetectionModelDetails Possible pre trained TXT model information
type PreTrainedLanguageDetectionModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedLanguageDetectionModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedLanguageDetectionModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedLanguageDetectionModelDetails) String() string
func (m PreTrainedLanguageDetectionModelDetails) 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
PreTrainedNamedEntityRecognitionModelDetails Possible pre trained NER model information
type PreTrainedNamedEntityRecognitionModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedNamedEntityRecognitionModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedNamedEntityRecognitionModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedNamedEntityRecognitionModelDetails) String() string
func (m PreTrainedNamedEntityRecognitionModelDetails) 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
PreTrainedPiiModelDetails Possible pre trained PII model information
type PreTrainedPiiModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedPiiModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedPiiModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedPiiModelDetails) String() string
func (m PreTrainedPiiModelDetails) 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
PreTrainedSentimentAnalysisModelDetails Possible pre trained TXT model information
type PreTrainedSentimentAnalysisModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedSentimentAnalysisModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedSentimentAnalysisModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedSentimentAnalysisModelDetails) String() string
func (m PreTrainedSentimentAnalysisModelDetails) 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
PreTrainedSummarization Possible pre trained summarization information
type PreTrainedSummarization struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedSummarization) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedSummarization) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedSummarization) String() string
func (m PreTrainedSummarization) 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
PreTrainedTextClassificationModelDetails Possible pre trained TXT model information
type PreTrainedTextClassificationModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedTextClassificationModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedTextClassificationModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedTextClassificationModelDetails) String() string
func (m PreTrainedTextClassificationModelDetails) 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
PreTrainedTranslationModelDetails Possible pre trained translation model information.
type PreTrainedTranslationModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. If nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedTranslationModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedTranslationModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedTranslationModelDetails) String() string
func (m PreTrainedTranslationModelDetails) 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
PreTrainedUniversalModel Possible pre trained universal model information
type PreTrainedUniversalModel struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
// Optional pre trained model version. if nothing specified latest pre trained model will be used.
// Supported versions can be found at /modelTypes/{modelType}
Version *string `mandatory:"false" json:"version"`
}
func (m PreTrainedUniversalModel) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m PreTrainedUniversalModel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreTrainedUniversalModel) String() string
func (m PreTrainedUniversalModel) 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
Profile Documents profile
type Profile struct {
// For PHI API this field can be PII/PHI/ALL and by default PII will be used. For other APIs Healthcare or Financial etc.
Domain *string `mandatory:"false" json:"domain"`
// Document type EHR Or Utterance
DocumentType *string `mandatory:"false" json:"documentType"`
// Document speciality like paediatrics, internal medicine etc.
Speciality *string `mandatory:"false" json:"speciality"`
}
func (m Profile) String() string
func (m Profile) 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
Project Project enable users to organize their project resources.
type Project struct {
// Unique identifier OCID of the project
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the project's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the resource was created in the timestamp format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the project.
LifecycleState ProjectLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A short description of a project.
Description *string `mandatory:"false" json:"description"`
// The date and time the resource was updated in the timestamp format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail.
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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Project) String() string
func (m Project) 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
ProjectCollection Results of a Project List. Contains ProjectSummary items.
type ProjectCollection struct {
// List of projects
Items []ProjectSummary `mandatory:"true" json:"items"`
}
func (m ProjectCollection) String() string
func (m ProjectCollection) 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
ProjectLifecycleStateEnum Enum with underlying type: string
type ProjectLifecycleStateEnum string
Set of constants representing the allowable values for ProjectLifecycleStateEnum
const (
ProjectLifecycleStateDeleting ProjectLifecycleStateEnum = "DELETING"
ProjectLifecycleStateDeleted ProjectLifecycleStateEnum = "DELETED"
ProjectLifecycleStateFailed ProjectLifecycleStateEnum = "FAILED"
ProjectLifecycleStateCreating ProjectLifecycleStateEnum = "CREATING"
ProjectLifecycleStateActive ProjectLifecycleStateEnum = "ACTIVE"
ProjectLifecycleStateUpdating ProjectLifecycleStateEnum = "UPDATING"
)
func GetMappingProjectLifecycleStateEnum(val string) (ProjectLifecycleStateEnum, bool)
GetMappingProjectLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProjectLifecycleStateEnumValues() []ProjectLifecycleStateEnum
GetProjectLifecycleStateEnumValues Enumerates the set of values for ProjectLifecycleStateEnum
ProjectSummary Summary of the project.
type ProjectSummary struct {
// Unique identifier OCID of a project
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the project's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the resource was created in the timestamp format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the project.
LifecycleState ProjectLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A short description of the project.
Description *string `mandatory:"false" json:"description"`
// The date and time the resource was updated in the timestamp format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail.
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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ProjectSummary) String() string
func (m ProjectSummary) 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
RelationEntity The relation entities details for health ner.
type RelationEntity struct {
// id of the relation
Id *string `mandatory:"true" json:"id"`
// Subject entity of the relation. eg,MEDICINE_NAME, EXAMINATION
SubjectId *string `mandatory:"true" json:"subjectId"`
// Object entity of the relation. eg, MEDICINE_DOSAGE, MEDICINE_DURATION, MEASUREMENT
ObjectId *string `mandatory:"true" json:"objectId"`
// Type of relation between subject entity and object entity. eg,EXAMINATION_MEASUREMENT, FREQUENCY, DOSAGE
Type *string `mandatory:"true" json:"type"`
// Score or confidence for detected entity.
Score *float64 `mandatory:"true" json:"score"`
}
func (m RelationEntity) String() string
func (m RelationEntity) 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
ResolvedEntities Resolved entities.
type ResolvedEntities struct {
// List of resolved entities
Details []ResolvedEntity `mandatory:"true" json:"details"`
}
func (m ResolvedEntities) String() string
func (m ResolvedEntities) 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
ResolvedEntity Resolved entity.
type ResolvedEntity struct {
// id of the resolved entity in input
Id *string `mandatory:"true" json:"id"`
// offset of resolved entity in input
Offset *int `mandatory:"true" json:"offset"`
// length of resolved entity in input
Length *int `mandatory:"true" json:"length"`
// Entity text like name of person, location, and so on.
Text *string `mandatory:"true" json:"text"`
// Type of entity text like PER, LOC.
Type *string `mandatory:"true" json:"type"`
// key and value pair for resolved entities. keys can be specific for each type of resolved entity. Values can be instances of resolvedEntity, arrays of resolvedEntities, primitives, or custom JSON.
Value map[string]string `mandatory:"true" json:"value"`
}
func (m ResolvedEntity) String() string
func (m ResolvedEntity) 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
SentimentAspect Sentiment aspect object.
type SentimentAspect struct {
// The number of Unicode code points preceding this entity in the submitted text.
Offset *int `mandatory:"false" json:"offset"`
// Length of aspect text.
Length *int `mandatory:"false" json:"length"`
// Aspect text.
Text *string `mandatory:"false" json:"text"`
// The highest-score sentiment for the aspect text.
Sentiment *string `mandatory:"false" json:"sentiment"`
// Scores or confidences for each sentiment.
// Example: `{"positive": 1.0, "negative": 0.0}`
Scores map[string]float64 `mandatory:"false" json:"scores"`
}
func (m SentimentAspect) String() string
func (m SentimentAspect) 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
SentimentDocumentResult The document response for sentiment detect call.
type SentimentDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// List of detected aspects sentiment.
Aspects []SentimentAspect `mandatory:"true" json:"aspects"`
// Language code supported
// - auto : Automatically detect language
// - ar : Arabic
// - pt-BR : Brazilian Portuguese
// - cs : Czech
// - da : Danish
// - nl : Dutch
// - en : English
// - fi : Finnish
// - fr : French
// - fr-CA : Canadian French
// - de : German
// - it : Italian
// - ja : Japanese
// - ko : Korean
// - no : Norwegian
// - pl : Polish
// - ro : Romanian
// - zh-CN : Simplified Chinese
// - es : Spanish
// - sv : Swedish
// - zh-TW : Traditional Chinese
// - tr : Turkish
// - el : Greek
// - he : Hebrew
LanguageCode *string `mandatory:"true" json:"languageCode"`
// Document level sentiment.
DocumentSentiment *string `mandatory:"false" json:"documentSentiment"`
// Scores for each sentiment.
// Example: {"positive": 1.0, "negative": 0.0}
DocumentScores map[string]float64 `mandatory:"false" json:"documentScores"`
// List of detected sentences sentiment.
Sentences []SentimentSentence `mandatory:"false" json:"sentences"`
}
func (m SentimentDocumentResult) String() string
func (m SentimentDocumentResult) 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
SentimentSentence Sentiment sentence object.
type SentimentSentence struct {
// The number of Unicode code points preceding this entity in the submitted text.
Offset *int `mandatory:"false" json:"offset"`
// Length of sentence text.
Length *int `mandatory:"false" json:"length"`
// Sentence text.
Text *string `mandatory:"false" json:"text"`
// The highest-score sentiment for the sentence text.
Sentiment *string `mandatory:"false" json:"sentiment"`
// Scores or confidences for each sentiment.
// Example: `{"positive": 1.0, "negative": 0.0}`
Scores map[string]float64 `mandatory:"false" json:"scores"`
}
func (m SentimentSentence) String() string
func (m SentimentSentence) 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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
TestAndValidationDatasetStrategy This information will be used capture training, testing and validation dataset.
type TestAndValidationDatasetStrategy struct {
TestingDataset DatasetDetails `mandatory:"true" json:"testingDataset"`
ValidationDataset DatasetDetails `mandatory:"false" json:"validationDataset"`
}
func (m TestAndValidationDatasetStrategy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TestAndValidationDatasetStrategy) String() string
func (m *TestAndValidationDatasetStrategy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TestAndValidationDatasetStrategy) 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
TestStrategy Possible strategy as testing and validation(optional) dataset.
type TestStrategy interface {
}
TestStrategyStrategyTypeEnum Enum with underlying type: string
type TestStrategyStrategyTypeEnum string
Set of constants representing the allowable values for TestStrategyStrategyTypeEnum
const (
TestStrategyStrategyTypeTestAndValidationDataset TestStrategyStrategyTypeEnum = "TEST_AND_VALIDATION_DATASET"
)
func GetMappingTestStrategyStrategyTypeEnum(val string) (TestStrategyStrategyTypeEnum, bool)
GetMappingTestStrategyStrategyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTestStrategyStrategyTypeEnumValues() []TestStrategyStrategyTypeEnum
GetTestStrategyStrategyTypeEnumValues Enumerates the set of values for TestStrategyStrategyTypeEnum
TextClassification Text label and score for the given text.
type TextClassification struct {
// Label of the the given text.
Label *string `mandatory:"true" json:"label"`
// Score or confidence of extracted text label.
// Example: `0.9999856066867399`
Score *float64 `mandatory:"true" json:"score"`
}
func (m TextClassification) String() string
func (m TextClassification) 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
TextClassificationDocumentResult The document response for test classification detect call.
type TextClassificationDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// List of detected text classes.
TextClassification []TextClassification `mandatory:"true" json:"textClassification"`
// Language code supported
// - auto : Automatically detect language
// - ar : Arabic
// - pt-BR : Brazilian Portuguese
// - cs : Czech
// - da : Danish
// - nl : Dutch
// - en : English
// - fi : Finnish
// - fr : French
// - fr-CA : Canadian French
// - de : German
// - it : Italian
// - ja : Japanese
// - ko : Korean
// - no : Norwegian
// - pl : Polish
// - ro : Romanian
// - zh-CN : Simplified Chinese
// - es : Spanish
// - sv : Swedish
// - zh-TW : Traditional Chinese
// - tr : Turkish
// - el : Greek
// - he : Hebrew
LanguageCode *string `mandatory:"true" json:"languageCode"`
}
func (m TextClassificationDocumentResult) String() string
func (m TextClassificationDocumentResult) 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
TextClassificationEvaluationResults Text Classification model testing and evaluation results
type TextClassificationEvaluationResults struct {
Metrics *TextClassificationModelMetrics `mandatory:"false" json:"metrics"`
// List of text classification metrics
ClassMetrics []ClassMetrics `mandatory:"false" json:"classMetrics"`
// class level confusion matrix
ConfusionMatrix map[string]ConfusionMatrixDetails `mandatory:"false" json:"confusionMatrix"`
// labels
Labels []string `mandatory:"false" json:"labels"`
}
func (m TextClassificationEvaluationResults) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextClassificationEvaluationResults) String() string
func (m TextClassificationEvaluationResults) 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
TextClassificationModelDetails Possible TextClassificationModelDetails
type TextClassificationModelDetails struct {
// supported language default value is en
LanguageCode *string `mandatory:"false" json:"languageCode"`
ClassificationMode ClassificationType `mandatory:"false" json:"classificationMode"`
}
func (m TextClassificationModelDetails) GetLanguageCode() *string
GetLanguageCode returns LanguageCode
func (m TextClassificationModelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextClassificationModelDetails) String() string
func (m *TextClassificationModelDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TextClassificationModelDetails) 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
TextClassificationModelEvaluationResult Possible TXTC model error analysis
type TextClassificationModelEvaluationResult struct {
// For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata)
Location *string `mandatory:"true" json:"location"`
// List of true(actual) labels in test data for multi class or multi label TextClassification
TrueLabels []string `mandatory:"true" json:"trueLabels"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// List of predicted labels by custom multi class or multi label TextClassification model
PredictedLabels []string `mandatory:"false" json:"predictedLabels"`
}
func (m TextClassificationModelEvaluationResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m TextClassificationModelEvaluationResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m TextClassificationModelEvaluationResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextClassificationModelEvaluationResult) String() string
func (m TextClassificationModelEvaluationResult) 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
TextClassificationModelMetrics Model level text classification metrics
type TextClassificationModelMetrics struct {
// F1-score, is a measure of a model’s accuracy on a dataset
MicroF1 *float32 `mandatory:"true" json:"microF1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
MicroPrecision *float32 `mandatory:"true" json:"microPrecision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
MicroRecall *float32 `mandatory:"true" json:"microRecall"`
// F1-score, is a measure of a model’s accuracy on a dataset
MacroF1 *float32 `mandatory:"true" json:"macroF1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
MacroPrecision *float32 `mandatory:"true" json:"macroPrecision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
MacroRecall *float32 `mandatory:"true" json:"macroRecall"`
// The fraction of the labels that were correctly recognised .
Accuracy *float32 `mandatory:"true" json:"accuracy"`
// F1-score, is a measure of a model’s accuracy on a dataset
WeightedF1 *float32 `mandatory:"false" json:"weightedF1"`
// Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
WeightedPrecision *float32 `mandatory:"false" json:"weightedPrecision"`
// Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.
WeightedRecall *float32 `mandatory:"false" json:"weightedRecall"`
}
func (m TextClassificationModelMetrics) String() string
func (m TextClassificationModelMetrics) 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
TextDocument The document details for language service call.
type TextDocument struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// Document text for language service call.
Text *string `mandatory:"true" json:"text"`
// Language code of the document. Please refer to respective model API documentation (https://docs.oracle.com/iaas/language/using/overview.htm) for supported languages.
LanguageCode *string `mandatory:"false" json:"languageCode"`
}
func (m TextDocument) String() string
func (m TextDocument) 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
TranslationDocumentResult The document response for translation call.
type TranslationDocumentResult struct {
// Document unique identifier defined by the user.
Key *string `mandatory:"true" json:"key"`
// Translated text in selected target language.
TranslatedText *string `mandatory:"true" json:"translatedText"`
// Language code supported
// Automatically detect language - auto
// Arabic - ar
// Brazilian Portuguese - pt-BR
// Canadian French - fr-CA
// Croatian - hr
// Czech - cs
// Danish - da
// Dutch - nl
// English - en
// Finnish - fi
// French - fr
// German - de
// Greek - el
// Hebrew - he
// Hungarian - hu
// Italian - it
// Japanese - ja
// Korean - ko
// Norwegian - no
// Polish - pl
// Portuguese - pt
// Romanian - ro
// Russian - ru
// Simplified Chinese - zh-CN
// Slovak - sk
// Slovenian - sl
// Spanish - es
// Swedish - sv
// Thai - th
// Traditional Chinese - zh-TW
// Turkish - tr
// Vietnamese - vi
SourceLanguageCode *string `mandatory:"true" json:"sourceLanguageCode"`
// Language code supported
// Arabic - ar
// Brazilian Portuguese - pt-BR
// Canadian French - fr-CA
// Croatian - hr
// Czech - cs
// Danish - da
// Dutch - nl
// English - en
// Finnish - fi
// French - fr
// German - de
// Greek - el
// Hebrew - he
// Hungarian - hu
// Italian - it
// Japanese - ja
// Korean - ko
// Norwegian - no
// Polish - pl
// Portuguese - pt
// Romanian - ro
// Russian - ru
// Simplified Chinese - zh-CN
// Slovak - sk
// Slovenian - sl
// Spanish - es
// Swedish - sv
// Thai - th
// Traditional Chinese - zh-TW
// Turkish - tr
// Vietnamese - vi
TargetLanguageCode *string `mandatory:"true" json:"targetLanguageCode"`
}
func (m TranslationDocumentResult) String() string
func (m TranslationDocumentResult) 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
UpdateEndpointDetails The information to be updated.
type UpdateEndpointDetails struct {
// A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
Alias *string `mandatory:"false" json:"alias"`
// A short description of the endpoint.
Description *string `mandatory:"false" json:"description"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
ModelId *string `mandatory:"false" json:"modelId"`
// Number of replicas required for this endpoint. This will be optional parameter.
InferenceUnits *int `mandatory:"false" json:"inferenceUnits"`
// 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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateEndpointDetails) String() string
func (m UpdateEndpointDetails) 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
UpdateEndpointRequest wrapper for the UpdateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateEndpoint.go.html to see an example of how to use UpdateEndpointRequest.
type UpdateEndpointRequest struct {
// The OCID of the endpoint.
EndpointId *string `mandatory:"true" contributesTo:"path" name:"endpointId"`
// The information to be updated.
UpdateEndpointDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateEndpointRequest) String() string
func (request UpdateEndpointRequest) 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
UpdateEndpointResponse wrapper for the UpdateEndpoint operation
type UpdateEndpointResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateEndpointResponse) String() string
UpdateJobDetails The information to be updated.
type UpdateJobDetails 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"`
}
func (m UpdateJobDetails) String() string
func (m UpdateJobDetails) 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
UpdateJobRequest wrapper for the UpdateJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateJob.go.html to see an example of how to use UpdateJobRequest.
type UpdateJobRequest struct {
// Unique Transcription Job identifier.
JobId *string `mandatory:"true" contributesTo:"path" name:"jobId"`
// The information to be updated.
UpdateJobDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateJobRequest) String() string
func (request UpdateJobRequest) 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
UpdateJobResponse wrapper for the UpdateJob operation
type UpdateJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The Job instance
Job `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateJobResponse) String() string
UpdateModelDetails The information to be updated.
type UpdateModelDetails struct {
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the a model.
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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateModelDetails) String() string
func (m UpdateModelDetails) 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
UpdateModelRequest wrapper for the UpdateModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateModel.go.html to see an example of how to use UpdateModelRequest.
type UpdateModelRequest struct {
// unique model OCID.
ModelId *string `mandatory:"true" contributesTo:"path" name:"modelId"`
// The information to be updated.
UpdateModelDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateModelRequest) String() string
func (request UpdateModelRequest) 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
UpdateModelResponse wrapper for the UpdateModel operation
type UpdateModelResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateModelResponse) String() string
UpdateProjectDetails The information to be updated for the project.
type UpdateProjectDetails struct {
// A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the project.
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": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateProjectDetails) String() string
func (m UpdateProjectDetails) 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
UpdateProjectRequest wrapper for the UpdateProject operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/UpdateProject.go.html to see an example of how to use UpdateProjectRequest.
type UpdateProjectRequest struct {
// The OCID of the project.
ProjectId *string `mandatory:"true" contributesTo:"path" name:"projectId"`
// The information to be updated.
UpdateProjectDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateProjectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateProjectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateProjectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateProjectRequest) String() string
func (request UpdateProjectRequest) 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
UpdateProjectResponse wrapper for the UpdateProject operation
type UpdateProjectResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateProjectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateProjectResponse) String() string
WorkRequest A description of workrequest status
type WorkRequest struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// Unique identifier work request OCID of work request that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) 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
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) 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
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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
WorkRequestLog A log message from the execution of a work request.
type WorkRequestLog struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLog) String() string
func (m WorkRequestLog) 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
WorkRequestLogCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLog `mandatory:"true" json:"items"`
}
func (m WorkRequestLogCollection) String() string
func (m WorkRequestLogCollection) 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
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) 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
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// Unique identifier work request OCID of work request that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) 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
WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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