ailanguage

package
v65.71.1 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues added in v65.24.0 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetBatchDetectLanguageSentimentsLevelEnumStringValues 

func GetBatchDetectLanguageSentimentsLevelEnumStringValues() []string

GetBatchDetectLanguageSentimentsLevelEnumStringValues Enumerates the set of values in String for BatchDetectLanguageSentimentsLevelEnum

func GetClassificationTypeClassificationModeEnumStringValues added in v65.24.0 

func GetClassificationTypeClassificationModeEnumStringValues() []string

GetClassificationTypeClassificationModeEnumStringValues Enumerates the set of values in String for ClassificationTypeClassificationModeEnum

func GetDatasetDetailsDatasetTypeEnumStringValues added in v65.24.0 

func GetDatasetDetailsDatasetTypeEnumStringValues() []string

GetDatasetDetailsDatasetTypeEnumStringValues Enumerates the set of values in String for DatasetDetailsDatasetTypeEnum

func GetDetectLanguageEntitiesModelVersionEnumStringValues 

func GetDetectLanguageEntitiesModelVersionEnumStringValues() []string

GetDetectLanguageEntitiesModelVersionEnumStringValues Enumerates the set of values in String for DetectLanguageEntitiesModelVersionEnum

func GetEndpointLifecycleStateEnumStringValues added in v65.24.0 

func GetEndpointLifecycleStateEnumStringValues() []string

GetEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for EndpointLifecycleStateEnum

func GetInputLocationLocationTypeEnumStringValues added in v65.61.2 

func GetInputLocationLocationTypeEnumStringValues() []string

GetInputLocationLocationTypeEnumStringValues Enumerates the set of values in String for InputLocationLocationTypeEnum

func GetJobLifecycleStateEnumStringValues added in v65.61.2 

func GetJobLifecycleStateEnumStringValues() []string

GetJobLifecycleStateEnumStringValues Enumerates the set of values in String for JobLifecycleStateEnum

func GetListEndpointsSortByEnumStringValues added in v65.24.0 

func GetListEndpointsSortByEnumStringValues() []string

GetListEndpointsSortByEnumStringValues Enumerates the set of values in String for ListEndpointsSortByEnum

func GetListEndpointsSortOrderEnumStringValues added in v65.24.0 

func GetListEndpointsSortOrderEnumStringValues() []string

GetListEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListEndpointsSortOrderEnum

func GetListJobsSortByEnumStringValues added in v65.61.2 

func GetListJobsSortByEnumStringValues() []string

GetListJobsSortByEnumStringValues Enumerates the set of values in String for ListJobsSortByEnum

func GetListJobsSortOrderEnumStringValues added in v65.61.2 

func GetListJobsSortOrderEnumStringValues() []string

GetListJobsSortOrderEnumStringValues Enumerates the set of values in String for ListJobsSortOrderEnum

func GetListModelsSortByEnumStringValues added in v65.24.0 

func GetListModelsSortByEnumStringValues() []string

GetListModelsSortByEnumStringValues Enumerates the set of values in String for ListModelsSortByEnum

func GetListModelsSortOrderEnumStringValues added in v65.24.0 

func GetListModelsSortOrderEnumStringValues() []string

GetListModelsSortOrderEnumStringValues Enumerates the set of values in String for ListModelsSortOrderEnum

func GetListProjectsSortByEnumStringValues added in v65.24.0 

func GetListProjectsSortByEnumStringValues() []string

GetListProjectsSortByEnumStringValues Enumerates the set of values in String for ListProjectsSortByEnum

func GetListProjectsSortOrderEnumStringValues added in v65.24.0 

func GetListProjectsSortOrderEnumStringValues() []string

GetListProjectsSortOrderEnumStringValues Enumerates the set of values in String for ListProjectsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues added in v65.24.0 

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues added in v65.24.0 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues added in v65.24.0 

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues added in v65.24.0 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues added in v65.24.0 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues added in v65.24.0 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetLocationDetailsLocationTypeEnumStringValues added in v65.24.0 

func GetLocationDetailsLocationTypeEnumStringValues() []string

GetLocationDetailsLocationTypeEnumStringValues Enumerates the set of values in String for LocationDetailsLocationTypeEnum

func GetModelDetailsModelTypeEnumStringValues added in v65.24.0 

func GetModelDetailsModelTypeEnumStringValues() []string

GetModelDetailsModelTypeEnumStringValues Enumerates the set of values in String for ModelDetailsModelTypeEnum

func GetModelLifecycleStateEnumStringValues added in v65.24.0 

func GetModelLifecycleStateEnumStringValues() []string

GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum

func GetNerModelVersionEnumStringValues 

func GetNerModelVersionEnumStringValues() []string

GetNerModelVersionEnumStringValues Enumerates the set of values in String for NerModelVersionEnum

func GetOperationStatusEnumStringValues added in v65.24.0 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues added in v65.24.0 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPiiEntityMaskingModeEnumStringValues added in v65.28.2 

func GetPiiEntityMaskingModeEnumStringValues() []string

GetPiiEntityMaskingModeEnumStringValues Enumerates the set of values in String for PiiEntityMaskingModeEnum

func GetProjectLifecycleStateEnumStringValues added in v65.24.0 

func GetProjectLifecycleStateEnumStringValues() []string

GetProjectLifecycleStateEnumStringValues Enumerates the set of values in String for ProjectLifecycleStateEnum

func GetSortOrderEnumStringValues added in v65.24.0 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetTestStrategyStrategyTypeEnumStringValues added in v65.24.0 

func GetTestStrategyStrategyTypeEnumStringValues() []string

GetTestStrategyStrategyTypeEnumStringValues Enumerates the set of values in String for TestStrategyStrategyTypeEnum

Types

type AIServiceLanguageClient 

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

AIServiceLanguageClient a client for AIServiceLanguage

func NewAIServiceLanguageClientWithConfigurationProvider 

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 

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 (AIServiceLanguageClient) BatchDetectDominantLanguage 

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.cloud.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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) BatchDetectHealthEntity added in v65.63.2 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) BatchDetectLanguageEntities 

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.cloud.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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) BatchDetectLanguageKeyPhrases 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) BatchDetectLanguagePiiEntities added in v65.28.2 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) BatchDetectLanguageSentiments 

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.cloud.oracle.com/iaas/language/using/pretrain-models.htm#sentiment). 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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) BatchDetectLanguageTextClassification 

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.cloud.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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) BatchLanguageTranslation added in v65.24.0 

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:

  • up to 100 records.
  • documents length less than 5000 characters.
  • 20,000 characters in total as a sum of all documents length.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) CancelJob added in v65.61.2 

func (client AIServiceLanguageClient) CancelJob(ctx context.Context, request CancelJobRequest) (response CancelJobResponse, err error)

CancelJob Canceling the job cancels all the tasks under it.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ailanguage/CancelJob.go.html to see an example of how to use CancelJob API. A default retry strategy applies to this operation CancelJob()

func (AIServiceLanguageClient) ChangeEndpointCompartment added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ChangeJobCompartment added in v65.61.2 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ChangeModelCompartment added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ChangeProjectCompartment added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (*AIServiceLanguageClient) ConfigurationProvider 

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

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

func (AIServiceLanguageClient) CreateEndpoint added in v65.24.0 

func (client AIServiceLanguageClient) CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (response CreateEndpointResponse, err error)

CreateEndpoint Creates a new endpoint and deploy the trained model

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) CreateJob added in v65.61.2 

func (client AIServiceLanguageClient) CreateJob(ctx context.Context, request CreateJobRequest) (response CreateJobResponse, err error)

CreateJob Creates a new language service async job.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) CreateModel added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) CreateProject added in v65.24.0 

func (client AIServiceLanguageClient) CreateProject(ctx context.Context, request CreateProjectRequest) (response CreateProjectResponse, err error)

CreateProject Creates a new Project.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DeleteEndpoint added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DeleteJob added in v65.61.2 

func (client AIServiceLanguageClient) DeleteJob(ctx context.Context, request DeleteJobRequest) (response DeleteJobResponse, err error)

DeleteJob Deletes the language service async Job

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DeleteModel added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DeleteProject added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DetectDominantLanguage 

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.cloud.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.cloud.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect) Limitations: - A record may be up to 1000 characters long.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DetectLanguageEntities 

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.cloud.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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DetectLanguageKeyPhrases 

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.cloud.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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DetectLanguageSentiments 

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.cloud.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.cloud.oracle.com/iaas/language/using/pretrain-models.htm#sentiment). Limitations:

  • A record may be up to 1000 characters long.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) DetectLanguageTextClassification 

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.cloud.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.cloud.oracle.com/iaas/language/using/pretrain-models.htm#text-class). Limitations: - A record may be up to 1000 characters long.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) GetEndpoint added in v65.24.0 

func (client AIServiceLanguageClient) GetEndpoint(ctx context.Context, request GetEndpointRequest) (response GetEndpointResponse, err error)

GetEndpoint Gets an endpoint by identifier

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) GetJob added in v65.61.2 

func (client AIServiceLanguageClient) GetJob(ctx context.Context, request GetJobRequest) (response GetJobResponse, err error)

GetJob Gets a language service async job

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) GetModel added in v65.24.0 

func (client AIServiceLanguageClient) GetModel(ctx context.Context, request GetModelRequest) (response GetModelResponse, err error)

GetModel Gets a model by identifier

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) GetModelType added in v65.47.0 

func (client AIServiceLanguageClient) GetModelType(ctx context.Context, request GetModelTypeRequest) (response GetModelTypeResponse, err error)

GetModelType Gets model capabilities

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) GetProject added in v65.24.0 

func (client AIServiceLanguageClient) GetProject(ctx context.Context, request GetProjectRequest) (response GetProjectResponse, err error)

GetProject Gets a Project by identifier

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) GetWorkRequest added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListEndpoints added in v65.24.0 

func (client AIServiceLanguageClient) ListEndpoints(ctx context.Context, request ListEndpointsRequest) (response ListEndpointsResponse, err error)

ListEndpoints Returns a list of Endpoints.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListEvaluationResults added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListJobs added in v65.61.2 

func (client AIServiceLanguageClient) ListJobs(ctx context.Context, request ListJobsRequest) (response ListJobsResponse, err error)

ListJobs Returns a list of language service async Jobs.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListModels added in v65.24.0 

func (client AIServiceLanguageClient) ListModels(ctx context.Context, request ListModelsRequest) (response ListModelsResponse, err error)

ListModels Returns a list of models.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListProjects added in v65.24.0 

func (client AIServiceLanguageClient) ListProjects(ctx context.Context, request ListProjectsRequest) (response ListProjectsResponse, err error)

ListProjects Returns a list of Projects.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListWorkRequestErrors added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListWorkRequestLogs added in v65.24.0 

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.

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) ListWorkRequests added in v65.24.0 

func (client AIServiceLanguageClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.cloud.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 (*AIServiceLanguageClient) SetRegion 

func (client *AIServiceLanguageClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AIServiceLanguageClient) UpdateEndpoint added in v65.24.0 

func (client AIServiceLanguageClient) UpdateEndpoint(ctx context.Context, request UpdateEndpointRequest) (response UpdateEndpointResponse, err error)

UpdateEndpoint Update the Endpoint identified by the id

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) UpdateJob added in v65.61.2 

func (client AIServiceLanguageClient) UpdateJob(ctx context.Context, request UpdateJobRequest) (response UpdateJobResponse, err error)

UpdateJob Updates the language service async Job

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) UpdateModel added in v65.24.0 

func (client AIServiceLanguageClient) UpdateModel(ctx context.Context, request UpdateModelRequest) (response UpdateModelResponse, err error)

UpdateModel Updates the model

See also

Click https://docs.cloud.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 (AIServiceLanguageClient) UpdateProject added in v65.24.0 

func (client AIServiceLanguageClient) UpdateProject(ctx context.Context, request UpdateProjectRequest) (response UpdateProjectResponse, err error)

UpdateProject Updates the Project

See also

Click https://docs.cloud.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()

type ActionTypeEnum added in v65.24.0 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues added in v65.24.0 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum added in v65.24.0 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type AssertionDetails added in v65.63.2 

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

AssertionDetails The assertion details for health ner.

func (AssertionDetails) String added in v65.63.2 

func (m AssertionDetails) String() string

func (AssertionDetails) ValidateEnumValue added in v65.63.2 

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

type BatchDetectDominantLanguageDetails 

type BatchDetectDominantLanguageDetails struct {

	// List of Documents for detect language.
	Documents []DominantLanguageDocument `mandatory:"true" json:"documents"`

	// 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.cloud.oracle.com/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"`
}

BatchDetectDominantLanguageDetails The documents details for language detect call.

func (BatchDetectDominantLanguageDetails) String 

func (m BatchDetectDominantLanguageDetails) String() string

func (BatchDetectDominantLanguageDetails) ValidateEnumValue 

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

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

BatchDetectDominantLanguageRequest wrapper for the BatchDetectDominantLanguage operation

See also

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

func (BatchDetectDominantLanguageRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchDetectDominantLanguageRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (BatchDetectDominantLanguageRequest) RetryPolicy 

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

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

func (BatchDetectDominantLanguageRequest) String 

func (request BatchDetectDominantLanguageRequest) String() string

func (BatchDetectDominantLanguageRequest) ValidateEnumValue 

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

type BatchDetectDominantLanguageResponse 

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

BatchDetectDominantLanguageResponse wrapper for the BatchDetectDominantLanguage operation

func (BatchDetectDominantLanguageResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BatchDetectDominantLanguageResponse) String 

func (response BatchDetectDominantLanguageResponse) String() string

type BatchDetectDominantLanguageResult 

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

BatchDetectDominantLanguageResult Result of language detect call.

func (BatchDetectDominantLanguageResult) String 

func (m BatchDetectDominantLanguageResult) String() string

func (BatchDetectDominantLanguageResult) ValidateEnumValue 

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

type BatchDetectHealthEntityDetails added in v65.63.2 

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

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

BatchDetectHealthEntityDetails The documents details for health entities detect call.

func (BatchDetectHealthEntityDetails) String added in v65.63.2 

func (m BatchDetectHealthEntityDetails) String() string

func (BatchDetectHealthEntityDetails) ValidateEnumValue added in v65.63.2 

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

type BatchDetectHealthEntityRequest added in v65.63.2 

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
}

BatchDetectHealthEntityRequest wrapper for the BatchDetectHealthEntity operation

See also

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

func (BatchDetectHealthEntityRequest) BinaryRequestBody added in v65.63.2 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchDetectHealthEntityRequest) HTTPRequest added in v65.63.2 

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

HTTPRequest implements the OCIRequest interface

func (BatchDetectHealthEntityRequest) RetryPolicy added in v65.63.2 

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

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

func (BatchDetectHealthEntityRequest) String added in v65.63.2 

func (request BatchDetectHealthEntityRequest) String() string

func (BatchDetectHealthEntityRequest) ValidateEnumValue added in v65.63.2 

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

type BatchDetectHealthEntityResponse added in v65.63.2 

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

BatchDetectHealthEntityResponse wrapper for the BatchDetectHealthEntity operation

func (BatchDetectHealthEntityResponse) HTTPResponse added in v65.63.2 

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

HTTPResponse implements the OCIResponse interface

func (BatchDetectHealthEntityResponse) String added in v65.63.2 

func (response BatchDetectHealthEntityResponse) String() string

type BatchDetectHealthEntityResult added in v65.63.2 

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

BatchDetectHealthEntityResult Result of health entity detect call.

func (BatchDetectHealthEntityResult) String added in v65.63.2 

func (m BatchDetectHealthEntityResult) String() string

func (BatchDetectHealthEntityResult) ValidateEnumValue added in v65.63.2 

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

type BatchDetectLanguageEntitiesDetails 

type BatchDetectLanguageEntitiesDetails struct {

	// List of Documents for detect entities.
	Documents []TextDocument `mandatory:"true" json:"documents"`

	// The OCID (https://docs.cloud.oracle.com/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"`
}

BatchDetectLanguageEntitiesDetails The documents details for entities detect call.

func (BatchDetectLanguageEntitiesDetails) String 

func (m BatchDetectLanguageEntitiesDetails) String() string

func (BatchDetectLanguageEntitiesDetails) ValidateEnumValue 

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

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

BatchDetectLanguageEntitiesRequest wrapper for the BatchDetectLanguageEntities operation

See also

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

func (BatchDetectLanguageEntitiesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchDetectLanguageEntitiesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (BatchDetectLanguageEntitiesRequest) RetryPolicy 

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

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

func (BatchDetectLanguageEntitiesRequest) String 

func (request BatchDetectLanguageEntitiesRequest) String() string

func (BatchDetectLanguageEntitiesRequest) ValidateEnumValue 

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

type BatchDetectLanguageEntitiesResponse 

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

BatchDetectLanguageEntitiesResponse wrapper for the BatchDetectLanguageEntities operation

func (BatchDetectLanguageEntitiesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BatchDetectLanguageEntitiesResponse) String 

func (response BatchDetectLanguageEntitiesResponse) String() string

type BatchDetectLanguageEntitiesResult 

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

BatchDetectLanguageEntitiesResult Result of entities detect call.

func (BatchDetectLanguageEntitiesResult) String 

func (m BatchDetectLanguageEntitiesResult) String() string

func (BatchDetectLanguageEntitiesResult) ValidateEnumValue 

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

type BatchDetectLanguageKeyPhrasesDetails 

type BatchDetectLanguageKeyPhrasesDetails struct {

	// List of Documents for detect keyPhrases.
	Documents []TextDocument `mandatory:"true" json:"documents"`

	// 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.cloud.oracle.com/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"`
}

BatchDetectLanguageKeyPhrasesDetails The documents details for keyPhrases call.

func (BatchDetectLanguageKeyPhrasesDetails) String 

func (m BatchDetectLanguageKeyPhrasesDetails) String() string

func (BatchDetectLanguageKeyPhrasesDetails) ValidateEnumValue 

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

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

BatchDetectLanguageKeyPhrasesRequest wrapper for the BatchDetectLanguageKeyPhrases operation

See also

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

func (BatchDetectLanguageKeyPhrasesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchDetectLanguageKeyPhrasesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (BatchDetectLanguageKeyPhrasesRequest) RetryPolicy 

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

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

func (BatchDetectLanguageKeyPhrasesRequest) String 

func (request BatchDetectLanguageKeyPhrasesRequest) String() string

func (BatchDetectLanguageKeyPhrasesRequest) ValidateEnumValue 

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

type BatchDetectLanguageKeyPhrasesResponse 

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

BatchDetectLanguageKeyPhrasesResponse wrapper for the BatchDetectLanguageKeyPhrases operation

func (BatchDetectLanguageKeyPhrasesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BatchDetectLanguageKeyPhrasesResponse) String 

func (response BatchDetectLanguageKeyPhrasesResponse) String() string

type BatchDetectLanguageKeyPhrasesResult 

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

BatchDetectLanguageKeyPhrasesResult Result of keyPhrases detect call.

func (BatchDetectLanguageKeyPhrasesResult) String 

func (m BatchDetectLanguageKeyPhrasesResult) String() string

func (BatchDetectLanguageKeyPhrasesResult) ValidateEnumValue 

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

type BatchDetectLanguagePiiEntitiesDetails added in v65.28.2 

type BatchDetectLanguagePiiEntitiesDetails struct {

	// List of documents to detect personal identification information.
	Documents []TextDocument `mandatory:"true" json:"documents"`

	// 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.cloud.oracle.com/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"`
}

BatchDetectLanguagePiiEntitiesDetails The documents details to detect personal identification information.

func (BatchDetectLanguagePiiEntitiesDetails) String added in v65.28.2 

func (m BatchDetectLanguagePiiEntitiesDetails) String() string

func (*BatchDetectLanguagePiiEntitiesDetails) UnmarshalJSON added in v65.28.2 

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

UnmarshalJSON unmarshals from json

func (BatchDetectLanguagePiiEntitiesDetails) ValidateEnumValue added in v65.28.2 

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

type BatchDetectLanguagePiiEntitiesRequest added in v65.28.2 

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
}

BatchDetectLanguagePiiEntitiesRequest wrapper for the BatchDetectLanguagePiiEntities operation

See also

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

func (BatchDetectLanguagePiiEntitiesRequest) BinaryRequestBody added in v65.28.2 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchDetectLanguagePiiEntitiesRequest) HTTPRequest added in v65.28.2 

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

HTTPRequest implements the OCIRequest interface

func (BatchDetectLanguagePiiEntitiesRequest) RetryPolicy added in v65.28.2 

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

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

func (BatchDetectLanguagePiiEntitiesRequest) String added in v65.28.2 

func (request BatchDetectLanguagePiiEntitiesRequest) String() string

func (BatchDetectLanguagePiiEntitiesRequest) ValidateEnumValue added in v65.28.2 

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

type BatchDetectLanguagePiiEntitiesResponse added in v65.28.2 

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

BatchDetectLanguagePiiEntitiesResponse wrapper for the BatchDetectLanguagePiiEntities operation

func (BatchDetectLanguagePiiEntitiesResponse) HTTPResponse added in v65.28.2 

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

HTTPResponse implements the OCIResponse interface

func (BatchDetectLanguagePiiEntitiesResponse) String added in v65.28.2 

func (response BatchDetectLanguagePiiEntitiesResponse) String() string

type BatchDetectLanguagePiiEntitiesResult added in v65.28.2 

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

BatchDetectLanguagePiiEntitiesResult Result of batch detect personal identification.

func (BatchDetectLanguagePiiEntitiesResult) String added in v65.28.2 

func (m BatchDetectLanguagePiiEntitiesResult) String() string

func (BatchDetectLanguagePiiEntitiesResult) ValidateEnumValue added in v65.28.2 

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

type BatchDetectLanguageSentimentsDetails 

type BatchDetectLanguageSentimentsDetails struct {

	// List of Documents for detect sentiments.
	Documents []TextDocument `mandatory:"true" json:"documents"`

	// 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.cloud.oracle.com/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"`
}

BatchDetectLanguageSentimentsDetails The documents details for sentiment call.

func (BatchDetectLanguageSentimentsDetails) String 

func (m BatchDetectLanguageSentimentsDetails) String() string

func (BatchDetectLanguageSentimentsDetails) ValidateEnumValue 

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

type BatchDetectLanguageSentimentsLevelEnum 

type BatchDetectLanguageSentimentsLevelEnum string

BatchDetectLanguageSentimentsLevelEnum Enum with underlying type: string 

const (
	BatchDetectLanguageSentimentsLevelAspect   BatchDetectLanguageSentimentsLevelEnum = "ASPECT"
	BatchDetectLanguageSentimentsLevelSentence BatchDetectLanguageSentimentsLevelEnum = "SENTENCE"
)

Set of constants representing the allowable values for BatchDetectLanguageSentimentsLevelEnum

func GetBatchDetectLanguageSentimentsLevelEnumValues 

func GetBatchDetectLanguageSentimentsLevelEnumValues() []BatchDetectLanguageSentimentsLevelEnum

GetBatchDetectLanguageSentimentsLevelEnumValues Enumerates the set of values for BatchDetectLanguageSentimentsLevelEnum

func GetMappingBatchDetectLanguageSentimentsLevelEnum 

func GetMappingBatchDetectLanguageSentimentsLevelEnum(val string) (BatchDetectLanguageSentimentsLevelEnum, bool)

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

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

BatchDetectLanguageSentimentsRequest wrapper for the BatchDetectLanguageSentiments operation

See also

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

func (BatchDetectLanguageSentimentsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchDetectLanguageSentimentsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (BatchDetectLanguageSentimentsRequest) RetryPolicy 

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

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

func (BatchDetectLanguageSentimentsRequest) String 

func (request BatchDetectLanguageSentimentsRequest) String() string

func (BatchDetectLanguageSentimentsRequest) ValidateEnumValue 

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

type BatchDetectLanguageSentimentsResponse 

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

BatchDetectLanguageSentimentsResponse wrapper for the BatchDetectLanguageSentiments operation

func (BatchDetectLanguageSentimentsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BatchDetectLanguageSentimentsResponse) String 

func (response BatchDetectLanguageSentimentsResponse) String() string

type BatchDetectLanguageSentimentsResult 

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

BatchDetectLanguageSentimentsResult Result of sentiments detect call.

func (BatchDetectLanguageSentimentsResult) String 

func (m BatchDetectLanguageSentimentsResult) String() string

func (BatchDetectLanguageSentimentsResult) ValidateEnumValue 

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

type BatchDetectLanguageTextClassificationDetails 

type BatchDetectLanguageTextClassificationDetails struct {

	// List of Documents for detect text classification.
	Documents []TextDocument `mandatory:"true" json:"documents"`

	// The OCID (https://docs.cloud.oracle.com/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"`
}

BatchDetectLanguageTextClassificationDetails The documents details for text classification call.

func (BatchDetectLanguageTextClassificationDetails) String 

func (m BatchDetectLanguageTextClassificationDetails) String() string

func (BatchDetectLanguageTextClassificationDetails) ValidateEnumValue 

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

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

BatchDetectLanguageTextClassificationRequest wrapper for the BatchDetectLanguageTextClassification operation

See also

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

func (BatchDetectLanguageTextClassificationRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchDetectLanguageTextClassificationRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (BatchDetectLanguageTextClassificationRequest) RetryPolicy 

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

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

func (BatchDetectLanguageTextClassificationRequest) String 

func (request BatchDetectLanguageTextClassificationRequest) String() string

func (BatchDetectLanguageTextClassificationRequest) ValidateEnumValue 

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

type BatchDetectLanguageTextClassificationResponse 

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

BatchDetectLanguageTextClassificationResponse wrapper for the BatchDetectLanguageTextClassification operation

func (BatchDetectLanguageTextClassificationResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BatchDetectLanguageTextClassificationResponse) String 

func (response BatchDetectLanguageTextClassificationResponse) String() string

type BatchDetectLanguageTextClassificationResult 

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

BatchDetectLanguageTextClassificationResult Result of text classification detect call.

func (BatchDetectLanguageTextClassificationResult) String 

func (m BatchDetectLanguageTextClassificationResult) String() string

func (BatchDetectLanguageTextClassificationResult) ValidateEnumValue 

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

type BatchLanguageTranslationDetails added in v65.24.0 

type BatchLanguageTranslationDetails struct {

	// List of documents for translation.
	Documents []TextDocument `mandatory:"true" json:"documents"`

	// The OCID (https://docs.cloud.oracle.com/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"`
}

BatchLanguageTranslationDetails The documents details for translation call.

func (BatchLanguageTranslationDetails) String added in v65.24.0 

func (m BatchLanguageTranslationDetails) String() string

func (BatchLanguageTranslationDetails) ValidateEnumValue added in v65.24.0 

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

type BatchLanguageTranslationRequest added in v65.24.0 

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
}

BatchLanguageTranslationRequest wrapper for the BatchLanguageTranslation operation

See also

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

func (BatchLanguageTranslationRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (BatchLanguageTranslationRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (BatchLanguageTranslationRequest) RetryPolicy added in v65.24.0 

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

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

func (BatchLanguageTranslationRequest) String added in v65.24.0 

func (request BatchLanguageTranslationRequest) String() string

func (BatchLanguageTranslationRequest) ValidateEnumValue added in v65.24.0 

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

type BatchLanguageTranslationResponse added in v65.24.0 

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

BatchLanguageTranslationResponse wrapper for the BatchLanguageTranslation operation

func (BatchLanguageTranslationResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (BatchLanguageTranslationResponse) String added in v65.24.0 

func (response BatchLanguageTranslationResponse) String() string

type BatchLanguageTranslationResult added in v65.24.0 

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

BatchLanguageTranslationResult Result of translation call.

func (BatchLanguageTranslationResult) String added in v65.24.0 

func (m BatchLanguageTranslationResult) String() string

func (BatchLanguageTranslationResult) ValidateEnumValue added in v65.24.0 

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

type CancelJobRequest added in v65.61.2 

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
}

CancelJobRequest wrapper for the CancelJob operation

See also

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

func (CancelJobRequest) BinaryRequestBody added in v65.61.2 

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

BinaryRequestBody implements the OCIRequest interface

func (CancelJobRequest) HTTPRequest added in v65.61.2 

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

HTTPRequest implements the OCIRequest interface

func (CancelJobRequest) RetryPolicy added in v65.61.2 

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

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

func (CancelJobRequest) String added in v65.61.2 

func (request CancelJobRequest) String() string

func (CancelJobRequest) ValidateEnumValue added in v65.61.2 

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

type CancelJobResponse added in v65.61.2 

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

CancelJobResponse wrapper for the CancelJob operation

func (CancelJobResponse) HTTPResponse added in v65.61.2 

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

HTTPResponse implements the OCIResponse interface

func (CancelJobResponse) String added in v65.61.2 

func (response CancelJobResponse) String() string

type Capabilities added in v65.47.0 

type Capabilities struct {

	// Model information capabilities related to version
	Capability map[string]Capability `mandatory:"false" json:"capability"`
}

Capabilities Capabilities supported

func (Capabilities) String added in v65.47.0 

func (m Capabilities) String() string

func (Capabilities) ValidateEnumValue added in v65.47.0 

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

type Capability added in v65.47.0 

type Capability struct {

	// values
	Details []string `mandatory:"false" json:"details"`
}

Capability Capability supported

func (Capability) String added in v65.47.0 

func (m Capability) String() string

func (Capability) ValidateEnumValue added in v65.47.0 

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

type ChangeEndpointCompartmentDetails added in v65.24.0 

type ChangeEndpointCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeEndpointCompartmentDetails Details for changing the compartment of an Endpoint.

func (ChangeEndpointCompartmentDetails) String added in v65.24.0 

func (m ChangeEndpointCompartmentDetails) String() string

func (ChangeEndpointCompartmentDetails) ValidateEnumValue added in v65.24.0 

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

type ChangeEndpointCompartmentRequest added in v65.24.0 

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
}

ChangeEndpointCompartmentRequest wrapper for the ChangeEndpointCompartment operation

See also

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

func (ChangeEndpointCompartmentRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeEndpointCompartmentRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeEndpointCompartmentRequest) RetryPolicy added in v65.24.0 

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

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

func (ChangeEndpointCompartmentRequest) String added in v65.24.0 

func (request ChangeEndpointCompartmentRequest) String() string

func (ChangeEndpointCompartmentRequest) ValidateEnumValue added in v65.24.0 

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

type ChangeEndpointCompartmentResponse added in v65.24.0 

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

ChangeEndpointCompartmentResponse wrapper for the ChangeEndpointCompartment operation

func (ChangeEndpointCompartmentResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeEndpointCompartmentResponse) String added in v65.24.0 

func (response ChangeEndpointCompartmentResponse) String() string

type ChangeJobCompartmentDetails added in v65.61.2 

type ChangeJobCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
	// where the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeJobCompartmentDetails Details for changing the compartment of a language job.

func (ChangeJobCompartmentDetails) String added in v65.61.2 

func (m ChangeJobCompartmentDetails) String() string

func (ChangeJobCompartmentDetails) ValidateEnumValue added in v65.61.2 

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

type ChangeJobCompartmentRequest added in v65.61.2 

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
}

ChangeJobCompartmentRequest wrapper for the ChangeJobCompartment operation

See also

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

func (ChangeJobCompartmentRequest) BinaryRequestBody added in v65.61.2 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeJobCompartmentRequest) HTTPRequest added in v65.61.2 

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

HTTPRequest implements the OCIRequest interface

func (ChangeJobCompartmentRequest) RetryPolicy added in v65.61.2 

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

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

func (ChangeJobCompartmentRequest) String added in v65.61.2 

func (request ChangeJobCompartmentRequest) String() string

func (ChangeJobCompartmentRequest) ValidateEnumValue added in v65.61.2 

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

type ChangeJobCompartmentResponse added in v65.61.2 

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

ChangeJobCompartmentResponse wrapper for the ChangeJobCompartment operation

func (ChangeJobCompartmentResponse) HTTPResponse added in v65.61.2 

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

HTTPResponse implements the OCIResponse interface

func (ChangeJobCompartmentResponse) String added in v65.61.2 

func (response ChangeJobCompartmentResponse) String() string

type ChangeModelCompartmentDetails added in v65.24.0 

type ChangeModelCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeModelCompartmentDetails Details for changing the compartment of an Model.

func (ChangeModelCompartmentDetails) String added in v65.24.0 

func (m ChangeModelCompartmentDetails) String() string

func (ChangeModelCompartmentDetails) ValidateEnumValue added in v65.24.0 

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

type ChangeModelCompartmentRequest added in v65.24.0 

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
}

ChangeModelCompartmentRequest wrapper for the ChangeModelCompartment operation

See also

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

func (ChangeModelCompartmentRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeModelCompartmentRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeModelCompartmentRequest) RetryPolicy added in v65.24.0 

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

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

func (ChangeModelCompartmentRequest) String added in v65.24.0 

func (request ChangeModelCompartmentRequest) String() string

func (ChangeModelCompartmentRequest) ValidateEnumValue added in v65.24.0 

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

type ChangeModelCompartmentResponse added in v65.24.0 

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

ChangeModelCompartmentResponse wrapper for the ChangeModelCompartment operation

func (ChangeModelCompartmentResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeModelCompartmentResponse) String added in v65.24.0 

func (response ChangeModelCompartmentResponse) String() string

type ChangeProjectCompartmentDetails added in v65.24.0 

type ChangeProjectCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeProjectCompartmentDetails Details for changing the compartment of a Project.

func (ChangeProjectCompartmentDetails) String added in v65.24.0 

func (m ChangeProjectCompartmentDetails) String() string

func (ChangeProjectCompartmentDetails) ValidateEnumValue added in v65.24.0 

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

type ChangeProjectCompartmentRequest added in v65.24.0 

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
}

ChangeProjectCompartmentRequest wrapper for the ChangeProjectCompartment operation

See also

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

func (ChangeProjectCompartmentRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeProjectCompartmentRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeProjectCompartmentRequest) RetryPolicy added in v65.24.0 

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

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

func (ChangeProjectCompartmentRequest) String added in v65.24.0 

func (request ChangeProjectCompartmentRequest) String() string

func (ChangeProjectCompartmentRequest) ValidateEnumValue added in v65.24.0 

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

type ChangeProjectCompartmentResponse added in v65.24.0 

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

ChangeProjectCompartmentResponse wrapper for the ChangeProjectCompartment operation

func (ChangeProjectCompartmentResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeProjectCompartmentResponse) String added in v65.24.0 

func (response ChangeProjectCompartmentResponse) String() string

type ClassMetrics added in v65.24.0 

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

ClassMetrics class level Text Classification model metrics

func (ClassMetrics) String added in v65.24.0 

func (m ClassMetrics) String() string

func (ClassMetrics) ValidateEnumValue added in v65.24.0 

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

type ClassificationMultiClassModeDetails added in v65.24.0 

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

ClassificationMultiClassModeDetails Possible text classification multi class mode details

func (ClassificationMultiClassModeDetails) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (ClassificationMultiClassModeDetails) String added in v65.24.0 

func (m ClassificationMultiClassModeDetails) String() string

func (ClassificationMultiClassModeDetails) ValidateEnumValue added in v65.24.0 

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

type ClassificationMultiLabelModeDetails added in v65.24.0 

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

ClassificationMultiLabelModeDetails Possible text classification multi label mode details

func (ClassificationMultiLabelModeDetails) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (ClassificationMultiLabelModeDetails) String added in v65.24.0 

func (m ClassificationMultiLabelModeDetails) String() string

func (ClassificationMultiLabelModeDetails) ValidateEnumValue added in v65.24.0 

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

type ClassificationType added in v65.24.0 

type ClassificationType interface {
}

ClassificationType possible text classification modes

type ClassificationTypeClassificationModeEnum added in v65.24.0 

type ClassificationTypeClassificationModeEnum string

ClassificationTypeClassificationModeEnum Enum with underlying type: string 

const (
	ClassificationTypeClassificationModeClass ClassificationTypeClassificationModeEnum = "MULTI_CLASS"
	ClassificationTypeClassificationModeLabel ClassificationTypeClassificationModeEnum = "MULTI_LABEL"
)

Set of constants representing the allowable values for ClassificationTypeClassificationModeEnum

func GetClassificationTypeClassificationModeEnumValues added in v65.24.0 

func GetClassificationTypeClassificationModeEnumValues() []ClassificationTypeClassificationModeEnum

GetClassificationTypeClassificationModeEnumValues Enumerates the set of values for ClassificationTypeClassificationModeEnum

func GetMappingClassificationTypeClassificationModeEnum added in v65.24.0 

func GetMappingClassificationTypeClassificationModeEnum(val string) (ClassificationTypeClassificationModeEnum, bool)

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

type ConfigurationDetails added in v65.61.2 

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

ConfigurationDetails training model details

func (ConfigurationDetails) String added in v65.61.2 

func (m ConfigurationDetails) String() string

func (ConfigurationDetails) ValidateEnumValue added in v65.61.2 

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

type ConfusionMatrixDetails added in v65.24.0 

type ConfusionMatrixDetails struct {

	// confusion matrix data
	Matrix map[string]float64 `mandatory:"false" json:"matrix"`
}

ConfusionMatrixDetails confusion matrix details

func (ConfusionMatrixDetails) String added in v65.24.0 

func (m ConfusionMatrixDetails) String() string

func (ConfusionMatrixDetails) ValidateEnumValue added in v65.24.0 

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

type CreateEndpointDetails added in v65.24.0 

type CreateEndpointDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) compartment identifier for the endpoint
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.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"`

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

CreateEndpointDetails The information needed to create a new endpoint and expose to end users.

func (CreateEndpointDetails) String added in v65.24.0 

func (m CreateEndpointDetails) String() string

func (CreateEndpointDetails) ValidateEnumValue added in v65.24.0 

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

type CreateEndpointRequest added in v65.24.0 

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
}

CreateEndpointRequest wrapper for the CreateEndpoint operation

See also

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

func (CreateEndpointRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateEndpointRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateEndpointRequest) RetryPolicy added in v65.24.0 

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

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

func (CreateEndpointRequest) String added in v65.24.0 

func (request CreateEndpointRequest) String() string

func (CreateEndpointRequest) ValidateEnumValue added in v65.24.0 

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

type CreateEndpointResponse added in v65.24.0 

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

CreateEndpointResponse wrapper for the CreateEndpoint operation

func (CreateEndpointResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateEndpointResponse) String added in v65.24.0 

func (response CreateEndpointResponse) String() string

type CreateJobDetails added in v65.61.2 

type CreateJobDetails struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	InputLocation InputLocation `mandatory:"true" json:"inputLocation"`

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

CreateJobDetails Job creation detail which will have documents on which language services need to run prediction along with output folder

func (CreateJobDetails) String added in v65.61.2 

func (m CreateJobDetails) String() string

func (*CreateJobDetails) UnmarshalJSON added in v65.61.2 

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

UnmarshalJSON unmarshals from json

func (CreateJobDetails) ValidateEnumValue added in v65.61.2 

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

type CreateJobRequest added in v65.61.2 

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
}

CreateJobRequest wrapper for the CreateJob operation

See also

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

func (CreateJobRequest) BinaryRequestBody added in v65.61.2 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateJobRequest) HTTPRequest added in v65.61.2 

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

HTTPRequest implements the OCIRequest interface

func (CreateJobRequest) RetryPolicy added in v65.61.2 

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

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

func (CreateJobRequest) String added in v65.61.2 

func (request CreateJobRequest) String() string

func (CreateJobRequest) ValidateEnumValue added in v65.61.2 

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

type CreateJobResponse added in v65.61.2 

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

CreateJobResponse wrapper for the CreateJob operation

func (CreateJobResponse) HTTPResponse added in v65.61.2 

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

HTTPResponse implements the OCIResponse interface

func (CreateJobResponse) String added in v65.61.2 

func (response CreateJobResponse) String() string

type CreateModelDetails added in v65.24.0 

type CreateModelDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)  for the models compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.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"`
}

CreateModelDetails The information needed to train a new model

func (CreateModelDetails) String added in v65.24.0 

func (m CreateModelDetails) String() string

func (*CreateModelDetails) UnmarshalJSON added in v65.24.0 

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

UnmarshalJSON unmarshals from json

func (CreateModelDetails) ValidateEnumValue added in v65.24.0 

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

type CreateModelRequest added in v65.24.0 

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
}

CreateModelRequest wrapper for the CreateModel operation

See also

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

func (CreateModelRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateModelRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateModelRequest) RetryPolicy added in v65.24.0 

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

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

func (CreateModelRequest) String added in v65.24.0 

func (request CreateModelRequest) String() string

func (CreateModelRequest) ValidateEnumValue added in v65.24.0 

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

type CreateModelResponse added in v65.24.0 

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

CreateModelResponse wrapper for the CreateModel operation

func (CreateModelResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateModelResponse) String added in v65.24.0 

func (response CreateModelResponse) String() string

type CreateProjectDetails added in v65.24.0 

type CreateProjectDetails struct {

	// The OCID (https://docs.cloud.oracle.com/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"`
}

CreateProjectDetails Parameters needed to create a new project. Projects enable users to organise their language work.

func (CreateProjectDetails) String added in v65.24.0 

func (m CreateProjectDetails) String() string

func (CreateProjectDetails) ValidateEnumValue added in v65.24.0 

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

type CreateProjectRequest added in v65.24.0 

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
}

CreateProjectRequest wrapper for the CreateProject operation

See also

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

func (CreateProjectRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateProjectRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateProjectRequest) RetryPolicy added in v65.24.0 

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

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

func (CreateProjectRequest) String added in v65.24.0 

func (request CreateProjectRequest) String() string

func (CreateProjectRequest) ValidateEnumValue added in v65.24.0 

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

type CreateProjectResponse added in v65.24.0 

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

CreateProjectResponse wrapper for the CreateProject operation

func (CreateProjectResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateProjectResponse) String added in v65.24.0 

func (response CreateProjectResponse) String() string

type DataScienceLabelingDataset added in v65.24.0 

type DataScienceLabelingDataset struct {

	// Data Science Labelling Service OCID
	DatasetId *string `mandatory:"true" json:"datasetId"`
}

DataScienceLabelingDataset Dataset that uses data science labelling service as underlying data source.

func (DataScienceLabelingDataset) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (DataScienceLabelingDataset) String added in v65.24.0 

func (m DataScienceLabelingDataset) String() string

func (DataScienceLabelingDataset) ValidateEnumValue added in v65.24.0 

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

type DatasetDetails added in v65.24.0 

type DatasetDetails interface {
}

DatasetDetails Possible data set type

type DatasetDetailsDatasetTypeEnum added in v65.24.0 

type DatasetDetailsDatasetTypeEnum string

DatasetDetailsDatasetTypeEnum Enum with underlying type: string 

const (
	DatasetDetailsDatasetTypeObjectStorage       DatasetDetailsDatasetTypeEnum = "OBJECT_STORAGE"
	DatasetDetailsDatasetTypeDataScienceLabeling DatasetDetailsDatasetTypeEnum = "DATA_SCIENCE_LABELING"
)

Set of constants representing the allowable values for DatasetDetailsDatasetTypeEnum

func GetDatasetDetailsDatasetTypeEnumValues added in v65.24.0 

func GetDatasetDetailsDatasetTypeEnumValues() []DatasetDetailsDatasetTypeEnum

GetDatasetDetailsDatasetTypeEnumValues Enumerates the set of values for DatasetDetailsDatasetTypeEnum

func GetMappingDatasetDetailsDatasetTypeEnum added in v65.24.0 

func GetMappingDatasetDetailsDatasetTypeEnum(val string) (DatasetDetailsDatasetTypeEnum, bool)

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

type DeleteEndpointRequest added in v65.24.0 

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
}

DeleteEndpointRequest wrapper for the DeleteEndpoint operation

See also

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

func (DeleteEndpointRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteEndpointRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteEndpointRequest) RetryPolicy added in v65.24.0 

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

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

func (DeleteEndpointRequest) String added in v65.24.0 

func (request DeleteEndpointRequest) String() string

func (DeleteEndpointRequest) ValidateEnumValue added in v65.24.0 

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

type DeleteEndpointResponse added in v65.24.0 

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

DeleteEndpointResponse wrapper for the DeleteEndpoint operation

func (DeleteEndpointResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteEndpointResponse) String added in v65.24.0 

func (response DeleteEndpointResponse) String() string

type DeleteJobRequest added in v65.61.2 

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
}

DeleteJobRequest wrapper for the DeleteJob operation

See also

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

func (DeleteJobRequest) BinaryRequestBody added in v65.61.2 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteJobRequest) HTTPRequest added in v65.61.2 

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

HTTPRequest implements the OCIRequest interface

func (DeleteJobRequest) RetryPolicy added in v65.61.2 

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

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

func (DeleteJobRequest) String added in v65.61.2 

func (request DeleteJobRequest) String() string

func (DeleteJobRequest) ValidateEnumValue added in v65.61.2 

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

type DeleteJobResponse added in v65.61.2 

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

DeleteJobResponse wrapper for the DeleteJob operation

func (DeleteJobResponse) HTTPResponse added in v65.61.2 

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

HTTPResponse implements the OCIResponse interface

func (DeleteJobResponse) String added in v65.61.2 

func (response DeleteJobResponse) String() string

type DeleteModelRequest added in v65.24.0 

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
}

DeleteModelRequest wrapper for the DeleteModel operation

See also

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

func (DeleteModelRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteModelRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteModelRequest) RetryPolicy added in v65.24.0 

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

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

func (DeleteModelRequest) String added in v65.24.0 

func (request DeleteModelRequest) String() string

func (DeleteModelRequest) ValidateEnumValue added in v65.24.0 

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

type DeleteModelResponse added in v65.24.0 

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

DeleteModelResponse wrapper for the DeleteModel operation

func (DeleteModelResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteModelResponse) String added in v65.24.0 

func (response DeleteModelResponse) String() string

type DeleteProjectRequest added in v65.24.0 

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
}

DeleteProjectRequest wrapper for the DeleteProject operation

See also

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

func (DeleteProjectRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteProjectRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteProjectRequest) RetryPolicy added in v65.24.0 

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

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

func (DeleteProjectRequest) String added in v65.24.0 

func (request DeleteProjectRequest) String() string

func (DeleteProjectRequest) ValidateEnumValue added in v65.24.0 

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

type DeleteProjectResponse added in v65.24.0 

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

DeleteProjectResponse wrapper for the DeleteProject operation

func (DeleteProjectResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteProjectResponse) String added in v65.24.0 

func (response DeleteProjectResponse) String() string

type DetectDominantLanguageDetails 

type DetectDominantLanguageDetails struct {

	// Document text for detect language.
	Text *string `mandatory:"true" json:"text"`
}

DetectDominantLanguageDetails The document details for language detect call.

func (DetectDominantLanguageDetails) String 

func (m DetectDominantLanguageDetails) String() string

func (DetectDominantLanguageDetails) ValidateEnumValue 

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

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

DetectDominantLanguageRequest wrapper for the DetectDominantLanguage operation

See also

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

func (DetectDominantLanguageRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DetectDominantLanguageRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DetectDominantLanguageRequest) RetryPolicy 

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

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

func (DetectDominantLanguageRequest) String 

func (request DetectDominantLanguageRequest) String() string

func (DetectDominantLanguageRequest) ValidateEnumValue 

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

type DetectDominantLanguageResponse 

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

DetectDominantLanguageResponse wrapper for the DetectDominantLanguage operation

func (DetectDominantLanguageResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DetectDominantLanguageResponse) String 

func (response DetectDominantLanguageResponse) String() string

type DetectDominantLanguageResult 

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

DetectDominantLanguageResult Result of language detect call.

func (DetectDominantLanguageResult) String 

func (m DetectDominantLanguageResult) String() string

func (DetectDominantLanguageResult) ValidateEnumValue 

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

type DetectLanguageEntitiesDetails 

type DetectLanguageEntitiesDetails struct {

	// Document text for detect entities.
	Text *string `mandatory:"true" json:"text"`
}

DetectLanguageEntitiesDetails The document details for entities detect call.

func (DetectLanguageEntitiesDetails) String 

func (m DetectLanguageEntitiesDetails) String() string

func (DetectLanguageEntitiesDetails) ValidateEnumValue 

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

type DetectLanguageEntitiesModelVersionEnum 

type DetectLanguageEntitiesModelVersionEnum string

DetectLanguageEntitiesModelVersionEnum Enum with underlying type: string 

const (
	DetectLanguageEntitiesModelVersionV21 DetectLanguageEntitiesModelVersionEnum = "V2_1"
	DetectLanguageEntitiesModelVersionV11 DetectLanguageEntitiesModelVersionEnum = "V1_1"
)

Set of constants representing the allowable values for DetectLanguageEntitiesModelVersionEnum

func GetDetectLanguageEntitiesModelVersionEnumValues 

func GetDetectLanguageEntitiesModelVersionEnumValues() []DetectLanguageEntitiesModelVersionEnum

GetDetectLanguageEntitiesModelVersionEnumValues Enumerates the set of values for DetectLanguageEntitiesModelVersionEnum

func GetMappingDetectLanguageEntitiesModelVersionEnum 

func GetMappingDetectLanguageEntitiesModelVersionEnum(val string) (DetectLanguageEntitiesModelVersionEnum, bool)

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

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

DetectLanguageEntitiesRequest wrapper for the DetectLanguageEntities operation

See also

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

func (DetectLanguageEntitiesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DetectLanguageEntitiesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DetectLanguageEntitiesRequest) RetryPolicy 

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

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

func (DetectLanguageEntitiesRequest) String 

func (request DetectLanguageEntitiesRequest) String() string

func (DetectLanguageEntitiesRequest) ValidateEnumValue 

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

type DetectLanguageEntitiesResponse 

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

DetectLanguageEntitiesResponse wrapper for the DetectLanguageEntities operation

func (DetectLanguageEntitiesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DetectLanguageEntitiesResponse) String 

func (response DetectLanguageEntitiesResponse) String() string

type DetectLanguageEntitiesResult 

type DetectLanguageEntitiesResult struct {

	// List of detected entities.
	Entities []Entity `mandatory:"true" json:"entities"`
}

DetectLanguageEntitiesResult Result of entities detect call.

func (DetectLanguageEntitiesResult) String 

func (m DetectLanguageEntitiesResult) String() string

func (DetectLanguageEntitiesResult) ValidateEnumValue 

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

type DetectLanguageKeyPhrasesDetails 

type DetectLanguageKeyPhrasesDetails struct {

	// Document text for detect keyPhrases.
	Text *string `mandatory:"true" json:"text"`
}

DetectLanguageKeyPhrasesDetails The document details for a keyPhrases detect call.

func (DetectLanguageKeyPhrasesDetails) String 

func (m DetectLanguageKeyPhrasesDetails) String() string

func (DetectLanguageKeyPhrasesDetails) ValidateEnumValue 

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

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

DetectLanguageKeyPhrasesRequest wrapper for the DetectLanguageKeyPhrases operation

See also

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

func (DetectLanguageKeyPhrasesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DetectLanguageKeyPhrasesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DetectLanguageKeyPhrasesRequest) RetryPolicy 

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

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

func (DetectLanguageKeyPhrasesRequest) String 

func (request DetectLanguageKeyPhrasesRequest) String() string

func (DetectLanguageKeyPhrasesRequest) ValidateEnumValue 

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

type DetectLanguageKeyPhrasesResponse 

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

DetectLanguageKeyPhrasesResponse wrapper for the DetectLanguageKeyPhrases operation

func (DetectLanguageKeyPhrasesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DetectLanguageKeyPhrasesResponse) String 

func (response DetectLanguageKeyPhrasesResponse) String() string

type DetectLanguageKeyPhrasesResult 

type DetectLanguageKeyPhrasesResult struct {

	// List of detected keyPhrases.
	KeyPhrases []KeyPhrase `mandatory:"true" json:"keyPhrases"`
}

DetectLanguageKeyPhrasesResult Result of a language keyPhrases detect call.

func (DetectLanguageKeyPhrasesResult) String 

func (m DetectLanguageKeyPhrasesResult) String() string

func (DetectLanguageKeyPhrasesResult) ValidateEnumValue 

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

type DetectLanguageSentimentsDetails 

type DetectLanguageSentimentsDetails struct {

	// Document text for detect sentiments.
	Text *string `mandatory:"true" json:"text"`
}

DetectLanguageSentimentsDetails The document details for sentiments detect call.

func (DetectLanguageSentimentsDetails) String 

func (m DetectLanguageSentimentsDetails) String() string

func (DetectLanguageSentimentsDetails) ValidateEnumValue 

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

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

DetectLanguageSentimentsRequest wrapper for the DetectLanguageSentiments operation

See also

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

func (DetectLanguageSentimentsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DetectLanguageSentimentsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DetectLanguageSentimentsRequest) RetryPolicy 

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

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

func (DetectLanguageSentimentsRequest) String 

func (request DetectLanguageSentimentsRequest) String() string

func (DetectLanguageSentimentsRequest) ValidateEnumValue 

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

type DetectLanguageSentimentsResponse 

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

DetectLanguageSentimentsResponse wrapper for the DetectLanguageSentiments operation

func (DetectLanguageSentimentsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DetectLanguageSentimentsResponse) String 

func (response DetectLanguageSentimentsResponse) String() string

type DetectLanguageSentimentsResult 

type DetectLanguageSentimentsResult struct {

	// List of detected aspects.
	Aspects []SentimentAspect `mandatory:"true" json:"aspects"`
}

DetectLanguageSentimentsResult Result of sentiments detect call.

func (DetectLanguageSentimentsResult) String 

func (m DetectLanguageSentimentsResult) String() string

func (DetectLanguageSentimentsResult) ValidateEnumValue 

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

type DetectLanguageTextClassificationDetails 

type DetectLanguageTextClassificationDetails struct {

	// Document text for detect text classes.
	Text *string `mandatory:"true" json:"text"`
}

DetectLanguageTextClassificationDetails The document details for text classification detect call.

func (DetectLanguageTextClassificationDetails) String 

func (m DetectLanguageTextClassificationDetails) String() string

func (DetectLanguageTextClassificationDetails) ValidateEnumValue 

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

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

DetectLanguageTextClassificationRequest wrapper for the DetectLanguageTextClassification operation

See also

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

func (DetectLanguageTextClassificationRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DetectLanguageTextClassificationRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DetectLanguageTextClassificationRequest) RetryPolicy 

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

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

func (DetectLanguageTextClassificationRequest) String 

func (request DetectLanguageTextClassificationRequest) String() string

func (DetectLanguageTextClassificationRequest) ValidateEnumValue 

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

type DetectLanguageTextClassificationResponse 

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

DetectLanguageTextClassificationResponse wrapper for the DetectLanguageTextClassification operation

func (DetectLanguageTextClassificationResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DetectLanguageTextClassificationResponse) String 

func (response DetectLanguageTextClassificationResponse) String() string

type DetectLanguageTextClassificationResult 

type DetectLanguageTextClassificationResult struct {

	// List of detected text classes.
	TextClassification []TextClassification `mandatory:"true" json:"textClassification"`
}

DetectLanguageTextClassificationResult Result of text classification detect call.

func (DetectLanguageTextClassificationResult) String 

func (m DetectLanguageTextClassificationResult) String() string

func (DetectLanguageTextClassificationResult) ValidateEnumValue 

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

type DetectedLanguage 

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

DetectedLanguage Attributes to the detected language. Contains Language Name , Code, and Confidence Score.

func (DetectedLanguage) String 

func (m DetectedLanguage) String() string

func (DetectedLanguage) ValidateEnumValue 

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

type DocumentError 

type DocumentError struct {

	// Document unique identifier defined by the user.
	Key *string `mandatory:"true" json:"key"`

	Error *ErrorDetails `mandatory:"true" json:"error"`
}

DocumentError Error response for document.

func (DocumentError) String 

func (m DocumentError) String() string

func (DocumentError) ValidateEnumValue 

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

type DocumentsConfiguration added in v65.61.2 

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

DocumentsConfiguration Input documents configuration

func (DocumentsConfiguration) String added in v65.61.2 

func (m DocumentsConfiguration) String() string

func (DocumentsConfiguration) ValidateEnumValue added in v65.61.2 

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

type DominantLanguageDocument 

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

DominantLanguageDocument The document details for language detect call.

func (DominantLanguageDocument) String 

func (m DominantLanguageDocument) String() string

func (DominantLanguageDocument) ValidateEnumValue 

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

type DominantLanguageDocumentResult 

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

DominantLanguageDocumentResult The document response for language detect call.

func (DominantLanguageDocumentResult) String 

func (m DominantLanguageDocumentResult) String() string

func (DominantLanguageDocumentResult) ValidateEnumValue 

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

type Endpoint added in v65.24.0 

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.cloud.oracle.com/Content/General/Concepts/identifiers.htm) for the endpoint compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
	ModelId *string `mandatory:"true" json:"modelId"`

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

Endpoint Description of the endpoint.

func (Endpoint) String added in v65.24.0 

func (m Endpoint) String() string

func (Endpoint) ValidateEnumValue added in v65.24.0 

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

type EndpointCollection added in v65.24.0 

type EndpointCollection struct {

	// List of endpoints
	Items []EndpointSummary `mandatory:"true" json:"items"`
}

EndpointCollection Results of an endpoint list. Contains EndpointSummary items.

func (EndpointCollection) String added in v65.24.0 

func (m EndpointCollection) String() string

func (EndpointCollection) ValidateEnumValue added in v65.24.0 

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

type EndpointLifecycleStateEnum added in v65.24.0 

type EndpointLifecycleStateEnum string

EndpointLifecycleStateEnum Enum with underlying type: string 

const (
	EndpointLifecycleStateDeleting EndpointLifecycleStateEnum = "DELETING"
	EndpointLifecycleStateDeleted  EndpointLifecycleStateEnum = "DELETED"
	EndpointLifecycleStateFailed   EndpointLifecycleStateEnum = "FAILED"
	EndpointLifecycleStateCreating EndpointLifecycleStateEnum = "CREATING"
	EndpointLifecycleStateActive   EndpointLifecycleStateEnum = "ACTIVE"
	EndpointLifecycleStateUpdating EndpointLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for EndpointLifecycleStateEnum

func GetEndpointLifecycleStateEnumValues added in v65.24.0 

func GetEndpointLifecycleStateEnumValues() []EndpointLifecycleStateEnum

GetEndpointLifecycleStateEnumValues Enumerates the set of values for EndpointLifecycleStateEnum

func GetMappingEndpointLifecycleStateEnum added in v65.24.0 

func GetMappingEndpointLifecycleStateEnum(val string) (EndpointLifecycleStateEnum, bool)

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

type EndpointSummary added in v65.24.0 

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.cloud.oracle.com/Content/General/Concepts/identifiers.htm)  for the Endpoint compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
	ModelId *string `mandatory:"true" json:"modelId"`

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

EndpointSummary Summary of the language endpoint.

func (EndpointSummary) String added in v65.24.0 

func (m EndpointSummary) String() string

func (EndpointSummary) ValidateEnumValue added in v65.24.0 

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

type Entity 

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

Entity entity object

func (Entity) String 

func (m Entity) String() string

func (Entity) ValidateEnumValue 

func (m Entity) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type EntityDocumentResult 

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

EntityDocumentResult The document response for entities detect call.

func (EntityDocumentResult) String 

func (m EntityDocumentResult) String() string

func (EntityDocumentResult) ValidateEnumValue 

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

type EntityLabelErrorAnalysis added in v65.24.0 

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

EntityLabelErrorAnalysis Possible entity error label error details

func (EntityLabelErrorAnalysis) String added in v65.24.0 

func (m EntityLabelErrorAnalysis) String() string

func (EntityLabelErrorAnalysis) ValidateEnumValue added in v65.24.0 

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

type EntityMetrics added in v65.24.0 

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

EntityMetrics Entity level named entity recognition model metrics

func (EntityMetrics) String added in v65.24.0 

func (m EntityMetrics) String() string

func (EntityMetrics) ValidateEnumValue added in v65.24.0 

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

type ErrorDetails 

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

ErrorDetails Error Information.

func (ErrorDetails) String 

func (m ErrorDetails) String() string

func (ErrorDetails) ValidateEnumValue 

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

type EvaluationResultCollection added in v65.24.0 

type EvaluationResultCollection struct {

	// List of model evaluation analysis
	Items []EvaluationResultSummary `mandatory:"true" json:"items"`
}

EvaluationResultCollection Results of a model evaluation analysis search. Contains EvaluationResultSummary items.

func (EvaluationResultCollection) String added in v65.24.0 

func (m EvaluationResultCollection) String() string

func (*EvaluationResultCollection) UnmarshalJSON added in v65.24.0 

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

UnmarshalJSON unmarshals from json

func (EvaluationResultCollection) ValidateEnumValue added in v65.24.0 

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

type EvaluationResultSummary added in v65.24.0 

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

EvaluationResultSummary model evaluation analysis of different models

type EvaluationResults added in v65.24.0 

type EvaluationResults interface {
}

EvaluationResults model training results of different models

type GetEndpointRequest added in v65.24.0 

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
}

GetEndpointRequest wrapper for the GetEndpoint operation

See also

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

func (GetEndpointRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetEndpointRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (GetEndpointRequest) RetryPolicy added in v65.24.0 

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

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

func (GetEndpointRequest) String added in v65.24.0 

func (request GetEndpointRequest) String() string

func (GetEndpointRequest) ValidateEnumValue added in v65.24.0 

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

type GetEndpointResponse added in v65.24.0 

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

GetEndpointResponse wrapper for the GetEndpoint operation

func (GetEndpointResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (GetEndpointResponse) String added in v65.24.0 

func (response GetEndpointResponse) String() string

type GetJobRequest added in v65.61.2 

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
}

GetJobRequest wrapper for the GetJob operation

See also

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

func (GetJobRequest) BinaryRequestBody added in v65.61.2 

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

BinaryRequestBody implements the OCIRequest interface

func (GetJobRequest) HTTPRequest added in v65.61.2 

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

HTTPRequest implements the OCIRequest interface

func (GetJobRequest) RetryPolicy added in v65.61.2 

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

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

func (GetJobRequest) String added in v65.61.2 

func (request GetJobRequest) String() string

func (GetJobRequest) ValidateEnumValue added in v65.61.2 

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

type GetJobResponse added in v65.61.2 

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

GetJobResponse wrapper for the GetJob operation

func (GetJobResponse) HTTPResponse added in v65.61.2 

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

HTTPResponse implements the OCIResponse interface

func (GetJobResponse) String added in v65.61.2 

func (response GetJobResponse) String() string

type GetModelRequest added in v65.24.0 

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
}

GetModelRequest wrapper for the GetModel operation

See also

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

func (GetModelRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetModelRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (GetModelRequest) RetryPolicy added in v65.24.0 

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

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

func (GetModelRequest) String added in v65.24.0 

func (request GetModelRequest) String() string

func (GetModelRequest) ValidateEnumValue added in v65.24.0 

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

type GetModelResponse added in v65.24.0 

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

GetModelResponse wrapper for the GetModel operation

func (GetModelResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (GetModelResponse) String added in v65.24.0 

func (response GetModelResponse) String() string

type GetModelTypeRequest added in v65.47.0 

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
}

GetModelTypeRequest wrapper for the GetModelType operation

See also

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

func (GetModelTypeRequest) BinaryRequestBody added in v65.47.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetModelTypeRequest) HTTPRequest added in v65.47.0 

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

HTTPRequest implements the OCIRequest interface

func (GetModelTypeRequest) RetryPolicy added in v65.47.0 

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

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

func (GetModelTypeRequest) String added in v65.47.0 

func (request GetModelTypeRequest) String() string

func (GetModelTypeRequest) ValidateEnumValue added in v65.47.0 

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

type GetModelTypeResponse added in v65.47.0 

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

GetModelTypeResponse wrapper for the GetModelType operation

func (GetModelTypeResponse) HTTPResponse added in v65.47.0 

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

HTTPResponse implements the OCIResponse interface

func (GetModelTypeResponse) String added in v65.47.0 

func (response GetModelTypeResponse) String() string

type GetProjectRequest added in v65.24.0 

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
}

GetProjectRequest wrapper for the GetProject operation

See also

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

func (GetProjectRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetProjectRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (GetProjectRequest) RetryPolicy added in v65.24.0 

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

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

func (GetProjectRequest) String added in v65.24.0 

func (request GetProjectRequest) String() string

func (GetProjectRequest) ValidateEnumValue added in v65.24.0 

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

type GetProjectResponse added in v65.24.0 

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

GetProjectResponse wrapper for the GetProject operation

func (GetProjectResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (GetProjectResponse) String added in v65.24.0 

func (response GetProjectResponse) String() string

type GetWorkRequestRequest added in v65.24.0 

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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy added in v65.24.0 

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

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

func (GetWorkRequestRequest) String added in v65.24.0 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue added in v65.24.0 

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

type GetWorkRequestResponse added in v65.24.0 

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String added in v65.24.0 

func (response GetWorkRequestResponse) String() string

type HealthEntity added in v65.63.2 

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

HealthEntity Health entity object

func (HealthEntity) String added in v65.63.2 

func (m HealthEntity) String() string

func (HealthEntity) ValidateEnumValue added in v65.63.2 

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

type HealthEntityDocumentResult added in v65.63.2 

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

HealthEntityDocumentResult The document response for health entity detect call.

func (HealthEntityDocumentResult) String added in v65.63.2 

func (m HealthEntityDocumentResult) String() string

func (HealthEntityDocumentResult) ValidateEnumValue added in v65.63.2 

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

type HierarchicalEntity 

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

HierarchicalEntity Hierarchical entity object

func (HierarchicalEntity) String 

func (m HierarchicalEntity) String() string

func (HierarchicalEntity) ValidateEnumValue 

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

type InputConfiguration added in v65.61.2 

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

InputConfiguration input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types

func (InputConfiguration) String added in v65.61.2 

func (m InputConfiguration) String() string

func (InputConfiguration) ValidateEnumValue added in v65.61.2 

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

type InputLocation added in v65.61.2 

type InputLocation interface {
}

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 InputLocationLocationTypeEnum added in v65.61.2 

type InputLocationLocationTypeEnum string

InputLocationLocationTypeEnum Enum with underlying type: string 

const (
	InputLocationLocationTypePrefix   InputLocationLocationTypeEnum = "OBJECT_STORAGE_PREFIX"
	InputLocationLocationTypeFileList InputLocationLocationTypeEnum = "OBJECT_STORAGE_FILE_LIST"
)

Set of constants representing the allowable values for InputLocationLocationTypeEnum

func GetInputLocationLocationTypeEnumValues added in v65.61.2 

func GetInputLocationLocationTypeEnumValues() []InputLocationLocationTypeEnum

GetInputLocationLocationTypeEnumValues Enumerates the set of values for InputLocationLocationTypeEnum

func GetMappingInputLocationLocationTypeEnum added in v65.61.2 

func GetMappingInputLocationLocationTypeEnum(val string) (InputLocationLocationTypeEnum, bool)

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

type Job added in v65.61.2 

type Job struct {

	// The OCID (https://docs.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

func (Job) String added in v65.61.2 

func (m Job) String() string

func (*Job) UnmarshalJSON added in v65.61.2 

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

UnmarshalJSON unmarshals from json

func (Job) ValidateEnumValue added in v65.61.2 

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

type JobCollection added in v65.61.2 

type JobCollection struct {

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

JobCollection list of Jobs created in the compartment and/or after applying filters based on filters provided by user

func (JobCollection) String added in v65.61.2 

func (m JobCollection) String() string

func (JobCollection) ValidateEnumValue added in v65.61.2 

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

type JobLifecycleStateEnum added in v65.61.2 

type JobLifecycleStateEnum string

JobLifecycleStateEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for JobLifecycleStateEnum

func GetJobLifecycleStateEnumValues added in v65.61.2 

func GetJobLifecycleStateEnumValues() []JobLifecycleStateEnum

GetJobLifecycleStateEnumValues Enumerates the set of values for JobLifecycleStateEnum

func GetMappingJobLifecycleStateEnum added in v65.61.2 

func GetMappingJobLifecycleStateEnum(val string) (JobLifecycleStateEnum, bool)

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

type JobSummary added in v65.61.2 

type JobSummary struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.
	Id *string `mandatory:"true" json:"id"`

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

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

JobSummary sub set of Job details data which need returns in list API

func (JobSummary) String added in v65.61.2 

func (m JobSummary) String() string

func (JobSummary) ValidateEnumValue added in v65.61.2 

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

type KeyPhrase 

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

KeyPhrase Key phrase for the given text.

func (KeyPhrase) String 

func (m KeyPhrase) String() string

func (KeyPhrase) ValidateEnumValue 

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

type KeyPhraseDocumentResult 

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

KeyPhraseDocumentResult The document response for keyPhrases detect call.

func (KeyPhraseDocumentResult) String 

func (m KeyPhraseDocumentResult) String() string

func (KeyPhraseDocumentResult) ValidateEnumValue 

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

type ListEndpointsRequest added in v65.24.0 

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
}

ListEndpointsRequest wrapper for the ListEndpoints operation

See also

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

func (ListEndpointsRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListEndpointsRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ListEndpointsRequest) RetryPolicy added in v65.24.0 

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

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

func (ListEndpointsRequest) String added in v65.24.0 

func (request ListEndpointsRequest) String() string

func (ListEndpointsRequest) ValidateEnumValue added in v65.24.0 

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

type ListEndpointsResponse added in v65.24.0 

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

ListEndpointsResponse wrapper for the ListEndpoints operation

func (ListEndpointsResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ListEndpointsResponse) String added in v65.24.0 

func (response ListEndpointsResponse) String() string

type ListEndpointsSortByEnum added in v65.24.0 

type ListEndpointsSortByEnum string

ListEndpointsSortByEnum Enum with underlying type: string 

const (
	ListEndpointsSortByTimecreated ListEndpointsSortByEnum = "timeCreated"
	ListEndpointsSortByDisplayname ListEndpointsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListEndpointsSortByEnum

func GetListEndpointsSortByEnumValues added in v65.24.0 

func GetListEndpointsSortByEnumValues() []ListEndpointsSortByEnum

GetListEndpointsSortByEnumValues Enumerates the set of values for ListEndpointsSortByEnum

func GetMappingListEndpointsSortByEnum added in v65.24.0 

func GetMappingListEndpointsSortByEnum(val string) (ListEndpointsSortByEnum, bool)

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

type ListEndpointsSortOrderEnum added in v65.24.0 

type ListEndpointsSortOrderEnum string

ListEndpointsSortOrderEnum Enum with underlying type: string 

const (
	ListEndpointsSortOrderAsc  ListEndpointsSortOrderEnum = "ASC"
	ListEndpointsSortOrderDesc ListEndpointsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListEndpointsSortOrderEnum

func GetListEndpointsSortOrderEnumValues added in v65.24.0 

func GetListEndpointsSortOrderEnumValues() []ListEndpointsSortOrderEnum

GetListEndpointsSortOrderEnumValues Enumerates the set of values for ListEndpointsSortOrderEnum

func GetMappingListEndpointsSortOrderEnum added in v65.24.0 

func GetMappingListEndpointsSortOrderEnum(val string) (ListEndpointsSortOrderEnum, bool)

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

type ListEvaluationResultsRequest added in v65.24.0 

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
}

ListEvaluationResultsRequest wrapper for the ListEvaluationResults operation

See also

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

func (ListEvaluationResultsRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListEvaluationResultsRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ListEvaluationResultsRequest) RetryPolicy added in v65.24.0 

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

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

func (ListEvaluationResultsRequest) String added in v65.24.0 

func (request ListEvaluationResultsRequest) String() string

func (ListEvaluationResultsRequest) ValidateEnumValue added in v65.24.0 

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

type ListEvaluationResultsResponse added in v65.24.0 

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

ListEvaluationResultsResponse wrapper for the ListEvaluationResults operation

func (ListEvaluationResultsResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ListEvaluationResultsResponse) String added in v65.24.0 

func (response ListEvaluationResultsResponse) String() string

type ListJobsRequest added in v65.61.2 

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
}

ListJobsRequest wrapper for the ListJobs operation

See also

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

func (ListJobsRequest) BinaryRequestBody added in v65.61.2 

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

BinaryRequestBody implements the OCIRequest interface

func (ListJobsRequest) HTTPRequest added in v65.61.2 

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

HTTPRequest implements the OCIRequest interface

func (ListJobsRequest) RetryPolicy added in v65.61.2 

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

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

func (ListJobsRequest) String added in v65.61.2 

func (request ListJobsRequest) String() string

func (ListJobsRequest) ValidateEnumValue added in v65.61.2 

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

type ListJobsResponse added in v65.61.2 

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

ListJobsResponse wrapper for the ListJobs operation

func (ListJobsResponse) HTTPResponse added in v65.61.2 

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

HTTPResponse implements the OCIResponse interface

func (ListJobsResponse) String added in v65.61.2 

func (response ListJobsResponse) String() string

type ListJobsSortByEnum added in v65.61.2 

type ListJobsSortByEnum string

ListJobsSortByEnum Enum with underlying type: string 

const (
	ListJobsSortByTimecreated ListJobsSortByEnum = "timeCreated"
	ListJobsSortByDisplayname ListJobsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListJobsSortByEnum

func GetListJobsSortByEnumValues added in v65.61.2 

func GetListJobsSortByEnumValues() []ListJobsSortByEnum

GetListJobsSortByEnumValues Enumerates the set of values for ListJobsSortByEnum

func GetMappingListJobsSortByEnum added in v65.61.2 

func GetMappingListJobsSortByEnum(val string) (ListJobsSortByEnum, bool)

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

type ListJobsSortOrderEnum added in v65.61.2 

type ListJobsSortOrderEnum string

ListJobsSortOrderEnum Enum with underlying type: string 

const (
	ListJobsSortOrderAsc  ListJobsSortOrderEnum = "ASC"
	ListJobsSortOrderDesc ListJobsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListJobsSortOrderEnum

func GetListJobsSortOrderEnumValues added in v65.61.2 

func GetListJobsSortOrderEnumValues() []ListJobsSortOrderEnum

GetListJobsSortOrderEnumValues Enumerates the set of values for ListJobsSortOrderEnum

func GetMappingListJobsSortOrderEnum added in v65.61.2 

func GetMappingListJobsSortOrderEnum(val string) (ListJobsSortOrderEnum, bool)

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

type ListModelsRequest added in v65.24.0 

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
}

ListModelsRequest wrapper for the ListModels operation

See also

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

func (ListModelsRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListModelsRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ListModelsRequest) RetryPolicy added in v65.24.0 

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

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

func (ListModelsRequest) String added in v65.24.0 

func (request ListModelsRequest) String() string

func (ListModelsRequest) ValidateEnumValue added in v65.24.0 

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

type ListModelsResponse added in v65.24.0 

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

ListModelsResponse wrapper for the ListModels operation

func (ListModelsResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ListModelsResponse) String added in v65.24.0 

func (response ListModelsResponse) String() string

type ListModelsSortByEnum added in v65.24.0 

type ListModelsSortByEnum string

ListModelsSortByEnum Enum with underlying type: string 

const (
	ListModelsSortByTimecreated ListModelsSortByEnum = "timeCreated"
	ListModelsSortByDisplayname ListModelsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListModelsSortByEnum

func GetListModelsSortByEnumValues added in v65.24.0 

func GetListModelsSortByEnumValues() []ListModelsSortByEnum

GetListModelsSortByEnumValues Enumerates the set of values for ListModelsSortByEnum

func GetMappingListModelsSortByEnum added in v65.24.0 

func GetMappingListModelsSortByEnum(val string) (ListModelsSortByEnum, bool)

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

type ListModelsSortOrderEnum added in v65.24.0 

type ListModelsSortOrderEnum string

ListModelsSortOrderEnum Enum with underlying type: string 

const (
	ListModelsSortOrderAsc  ListModelsSortOrderEnum = "ASC"
	ListModelsSortOrderDesc ListModelsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListModelsSortOrderEnum

func GetListModelsSortOrderEnumValues added in v65.24.0 

func GetListModelsSortOrderEnumValues() []ListModelsSortOrderEnum

GetListModelsSortOrderEnumValues Enumerates the set of values for ListModelsSortOrderEnum

func GetMappingListModelsSortOrderEnum added in v65.24.0 

func GetMappingListModelsSortOrderEnum(val string) (ListModelsSortOrderEnum, bool)

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

type ListProjectsRequest added in v65.24.0 

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
}

ListProjectsRequest wrapper for the ListProjects operation

See also

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

func (ListProjectsRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListProjectsRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ListProjectsRequest) RetryPolicy added in v65.24.0 

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

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

func (ListProjectsRequest) String added in v65.24.0 

func (request ListProjectsRequest) String() string

func (ListProjectsRequest) ValidateEnumValue added in v65.24.0 

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

type ListProjectsResponse added in v65.24.0 

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

ListProjectsResponse wrapper for the ListProjects operation

func (ListProjectsResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ListProjectsResponse) String added in v65.24.0 

func (response ListProjectsResponse) String() string

type ListProjectsSortByEnum added in v65.24.0 

type ListProjectsSortByEnum string

ListProjectsSortByEnum Enum with underlying type: string 

const (
	ListProjectsSortByTimecreated ListProjectsSortByEnum = "timeCreated"
	ListProjectsSortByDisplayname ListProjectsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListProjectsSortByEnum

func GetListProjectsSortByEnumValues added in v65.24.0 

func GetListProjectsSortByEnumValues() []ListProjectsSortByEnum

GetListProjectsSortByEnumValues Enumerates the set of values for ListProjectsSortByEnum

func GetMappingListProjectsSortByEnum added in v65.24.0 

func GetMappingListProjectsSortByEnum(val string) (ListProjectsSortByEnum, bool)

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

type ListProjectsSortOrderEnum added in v65.24.0 

type ListProjectsSortOrderEnum string

ListProjectsSortOrderEnum Enum with underlying type: string 

const (
	ListProjectsSortOrderAsc  ListProjectsSortOrderEnum = "ASC"
	ListProjectsSortOrderDesc ListProjectsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListProjectsSortOrderEnum

func GetListProjectsSortOrderEnumValues added in v65.24.0 

func GetListProjectsSortOrderEnumValues() []ListProjectsSortOrderEnum

GetListProjectsSortOrderEnumValues Enumerates the set of values for ListProjectsSortOrderEnum

func GetMappingListProjectsSortOrderEnum added in v65.24.0 

func GetMappingListProjectsSortOrderEnum(val string) (ListProjectsSortOrderEnum, bool)

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

type ListWorkRequestErrorsRequest added in v65.24.0 

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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy added in v65.24.0 

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

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

func (ListWorkRequestErrorsRequest) String added in v65.24.0 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue added in v65.24.0 

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

type ListWorkRequestErrorsResponse added in v65.24.0 

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String added in v65.24.0 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum added in v65.24.0 

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
	ListWorkRequestErrorsSortByDisplayname ListWorkRequestErrorsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues added in v65.24.0 

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum added in v65.24.0 

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

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

type ListWorkRequestErrorsSortOrderEnum added in v65.24.0 

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues added in v65.24.0 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum added in v65.24.0 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest added in v65.24.0 

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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy added in v65.24.0 

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

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

func (ListWorkRequestLogsRequest) String added in v65.24.0 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue added in v65.24.0 

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

type ListWorkRequestLogsResponse added in v65.24.0 

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String added in v65.24.0 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum added in v65.24.0 

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
	ListWorkRequestLogsSortByDisplayname ListWorkRequestLogsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues added in v65.24.0 

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum added in v65.24.0 

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

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

type ListWorkRequestLogsSortOrderEnum added in v65.24.0 

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues added in v65.24.0 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum added in v65.24.0 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest added in v65.24.0 

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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy added in v65.24.0 

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

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

func (ListWorkRequestsRequest) String added in v65.24.0 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue added in v65.24.0 

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

type ListWorkRequestsResponse added in v65.24.0 

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String added in v65.24.0 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum added in v65.24.0 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortByTimecreated ListWorkRequestsSortByEnum = "timeCreated"
	ListWorkRequestsSortByDisplayname ListWorkRequestsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues added in v65.24.0 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum added in v65.24.0 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

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

type ListWorkRequestsSortOrderEnum added in v65.24.0 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues added in v65.24.0 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum added in v65.24.0 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

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

type LocationDetails added in v65.24.0 

type LocationDetails interface {
}

LocationDetails Possible object storage location types

type LocationDetailsLocationTypeEnum added in v65.24.0 

type LocationDetailsLocationTypeEnum string

LocationDetailsLocationTypeEnum Enum with underlying type: string 

const (
	LocationDetailsLocationTypeObjectList LocationDetailsLocationTypeEnum = "OBJECT_LIST"
)

Set of constants representing the allowable values for LocationDetailsLocationTypeEnum

func GetLocationDetailsLocationTypeEnumValues added in v65.24.0 

func GetLocationDetailsLocationTypeEnumValues() []LocationDetailsLocationTypeEnum

GetLocationDetailsLocationTypeEnumValues Enumerates the set of values for LocationDetailsLocationTypeEnum

func GetMappingLocationDetailsLocationTypeEnum added in v65.24.0 

func GetMappingLocationDetailsLocationTypeEnum(val string) (LocationDetailsLocationTypeEnum, bool)

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

type MelConcept added in v65.63.2 

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

MelConcept The MEL concepts details for health ner.

func (MelConcept) String added in v65.63.2 

func (m MelConcept) String() string

func (MelConcept) ValidateEnumValue added in v65.63.2 

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

type MelConceptDetails added in v65.63.2 

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

MelConceptDetails The MEL concepts details for health ner.

func (MelConceptDetails) String added in v65.63.2 

func (m MelConceptDetails) String() string

func (MelConceptDetails) ValidateEnumValue added in v65.63.2 

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

type Model added in v65.24.0 

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.cloud.oracle.com/Content/General/Concepts/identifiers.htm)  for the model's compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.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"`
}

Model Description of the a Model.

func (Model) String added in v65.24.0 

func (m Model) String() string

func (*Model) UnmarshalJSON added in v65.24.0 

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

UnmarshalJSON unmarshals from json

func (Model) ValidateEnumValue added in v65.24.0 

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

type ModelCollection added in v65.24.0 

type ModelCollection struct {

	// List of models
	Items []ModelSummary `mandatory:"true" json:"items"`
}

ModelCollection Results of a model search. Contains ModelSummary items.

func (ModelCollection) String added in v65.24.0 

func (m ModelCollection) String() string

func (ModelCollection) ValidateEnumValue added in v65.24.0 

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

type ModelDetails added in v65.24.0 

type ModelDetails interface {

	// supported language default value is en
	GetLanguageCode() *string
}

ModelDetails Possible model types

type ModelDetailsModelTypeEnum added in v65.24.0 

type ModelDetailsModelTypeEnum string

ModelDetailsModelTypeEnum Enum with underlying type: string 

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"
	ModelDetailsModelTypePreTrainedTranslation            ModelDetailsModelTypeEnum = "PRE_TRAINED_TRANSLATION"
	ModelDetailsModelTypePreTrainedHealthNlu              ModelDetailsModelTypeEnum = "PRE_TRAINED_HEALTH_NLU"
	ModelDetailsModelTypePreTrainedSummarization          ModelDetailsModelTypeEnum = "PRE_TRAINED_SUMMARIZATION"
	ModelDetailsModelTypePreTrainedUniversal              ModelDetailsModelTypeEnum = "PRE_TRAINED_UNIVERSAL"
	ModelDetailsModelTypePii                              ModelDetailsModelTypeEnum = "PII"
)

Set of constants representing the allowable values for ModelDetailsModelTypeEnum

func GetMappingModelDetailsModelTypeEnum added in v65.24.0 

func GetMappingModelDetailsModelTypeEnum(val string) (ModelDetailsModelTypeEnum, bool)

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

func GetModelDetailsModelTypeEnumValues added in v65.24.0 

func GetModelDetailsModelTypeEnumValues() []ModelDetailsModelTypeEnum

GetModelDetailsModelTypeEnumValues Enumerates the set of values for ModelDetailsModelTypeEnum

type ModelLifecycleStateEnum added in v65.24.0 

type ModelLifecycleStateEnum string

ModelLifecycleStateEnum Enum with underlying type: string 

const (
	ModelLifecycleStateDeleting ModelLifecycleStateEnum = "DELETING"
	ModelLifecycleStateDeleted  ModelLifecycleStateEnum = "DELETED"
	ModelLifecycleStateFailed   ModelLifecycleStateEnum = "FAILED"
	ModelLifecycleStateCreating ModelLifecycleStateEnum = "CREATING"
	ModelLifecycleStateActive   ModelLifecycleStateEnum = "ACTIVE"
	ModelLifecycleStateUpdating ModelLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ModelLifecycleStateEnum

func GetMappingModelLifecycleStateEnum added in v65.24.0 

func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool)

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

func GetModelLifecycleStateEnumValues added in v65.24.0 

func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum

GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum

type ModelMetadataDetails added in v65.61.2 

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

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

func (ModelMetadataDetails) String added in v65.61.2 

func (m ModelMetadataDetails) String() string

func (ModelMetadataDetails) ValidateEnumValue added in v65.61.2 

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

type ModelSummary added in v65.24.0 

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.cloud.oracle.com/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.cloud.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"`
}

ModelSummary Summary of the language Model.

func (ModelSummary) String added in v65.24.0 

func (m ModelSummary) String() string

func (*ModelSummary) UnmarshalJSON added in v65.24.0 

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

UnmarshalJSON unmarshals from json

func (ModelSummary) ValidateEnumValue added in v65.24.0 

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

type ModelTypeInfo added in v65.47.0 

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

ModelTypeInfo Model information like versions and capabilities

func (ModelTypeInfo) String added in v65.47.0 

func (m ModelTypeInfo) String() string

func (ModelTypeInfo) ValidateEnumValue added in v65.47.0 

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

type NamedEntityRecognitionEvaluationResult added in v65.24.0 

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

NamedEntityRecognitionEvaluationResult Possible NER model error analysis

func (NamedEntityRecognitionEvaluationResult) GetDefinedTags added in v65.24.0 

func (m NamedEntityRecognitionEvaluationResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (NamedEntityRecognitionEvaluationResult) GetFreeformTags added in v65.24.0 

func (m NamedEntityRecognitionEvaluationResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (NamedEntityRecognitionEvaluationResult) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (NamedEntityRecognitionEvaluationResult) String added in v65.24.0 

func (m NamedEntityRecognitionEvaluationResult) String() string

func (NamedEntityRecognitionEvaluationResult) ValidateEnumValue added in v65.24.0 

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

type NamedEntityRecognitionEvaluationResults added in v65.24.0 

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

NamedEntityRecognitionEvaluationResults Named entity recognition model testing and evaluation results

func (NamedEntityRecognitionEvaluationResults) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (NamedEntityRecognitionEvaluationResults) String added in v65.24.0 

func (m NamedEntityRecognitionEvaluationResults) String() string

func (NamedEntityRecognitionEvaluationResults) ValidateEnumValue added in v65.24.0 

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

type NamedEntityRecognitionModelDetails added in v65.24.0 

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

NamedEntityRecognitionModelDetails Possible NER model information

func (NamedEntityRecognitionModelDetails) GetLanguageCode added in v65.24.0 

func (m NamedEntityRecognitionModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (NamedEntityRecognitionModelDetails) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (NamedEntityRecognitionModelDetails) String added in v65.24.0 

func (m NamedEntityRecognitionModelDetails) String() string

func (NamedEntityRecognitionModelDetails) ValidateEnumValue added in v65.24.0 

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

type NamedEntityRecognitionModelMetrics added in v65.24.0 

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

NamedEntityRecognitionModelMetrics Model level named entity recognition metrics

func (NamedEntityRecognitionModelMetrics) String added in v65.24.0 

func (m NamedEntityRecognitionModelMetrics) String() string

func (NamedEntityRecognitionModelMetrics) ValidateEnumValue added in v65.24.0 

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

type NerModelVersionEnum 

type NerModelVersionEnum string

NerModelVersionEnum Enum with underlying type: string 

const (
	NerModelVersionV21 NerModelVersionEnum = "V2_1"
	NerModelVersionV11 NerModelVersionEnum = "V1_1"
)

Set of constants representing the allowable values for NerModelVersionEnum

func GetMappingNerModelVersionEnum 

func GetMappingNerModelVersionEnum(val string) (NerModelVersionEnum, bool)

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

func GetNerModelVersionEnumValues 

func GetNerModelVersionEnumValues() []NerModelVersionEnum

GetNerModelVersionEnumValues Enumerates the set of values for NerModelVersionEnum

type ObjectListDataset added in v65.24.0 

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

ObjectListDataset Data source details for object storage

func (ObjectListDataset) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (ObjectListDataset) String added in v65.24.0 

func (m ObjectListDataset) String() string

func (ObjectListDataset) ValidateEnumValue added in v65.24.0 

func (m ObjectListDataset) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ObjectPrefixOutputLocation added in v65.61.2 

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

ObjectPrefixOutputLocation Object storage output location to write inference results

func (ObjectPrefixOutputLocation) String added in v65.61.2 

func (m ObjectPrefixOutputLocation) String() string

func (ObjectPrefixOutputLocation) ValidateEnumValue added in v65.61.2 

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

type ObjectStorageDataset added in v65.24.0 

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

ObjectStorageDataset Different type of location types supported for object storage

func (ObjectStorageDataset) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (ObjectStorageDataset) String added in v65.24.0 

func (m ObjectStorageDataset) String() string

func (*ObjectStorageDataset) UnmarshalJSON added in v65.24.0 

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

UnmarshalJSON unmarshals from json

func (ObjectStorageDataset) ValidateEnumValue added in v65.24.0 

func (m ObjectStorageDataset) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ObjectStorageFileNameLocation added in v65.61.2 

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

ObjectStorageFileNameLocation list of text files need to be used for prediction

func (ObjectStorageFileNameLocation) MarshalJSON added in v65.61.2 

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

MarshalJSON marshals to json representation

func (ObjectStorageFileNameLocation) String added in v65.61.2 

func (m ObjectStorageFileNameLocation) String() string

func (ObjectStorageFileNameLocation) ValidateEnumValue added in v65.61.2 

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

type ObjectStoragePrefixLocation added in v65.61.2 

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

ObjectStoragePrefixLocation Properties specific to object storage prefix location

func (ObjectStoragePrefixLocation) MarshalJSON added in v65.61.2 

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

MarshalJSON marshals to json representation

func (ObjectStoragePrefixLocation) String added in v65.61.2 

func (m ObjectStoragePrefixLocation) String() string

func (ObjectStoragePrefixLocation) ValidateEnumValue added in v65.61.2 

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

type OperationStatusEnum added in v65.24.0 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum added in v65.24.0 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues added in v65.24.0 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum added in v65.24.0 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum added in v65.24.0 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues added in v65.24.0 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type PiiEntity added in v65.28.2 

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

PiiEntity PII entity object.

func (PiiEntity) String added in v65.28.2 

func (m PiiEntity) String() string

func (PiiEntity) ValidateEnumValue added in v65.28.2 

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

type PiiEntityDocumentResult added in v65.28.2 

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

PiiEntityDocumentResult The document response for batch detect personal identification.

func (PiiEntityDocumentResult) String added in v65.28.2 

func (m PiiEntityDocumentResult) String() string

func (PiiEntityDocumentResult) ValidateEnumValue added in v65.28.2 

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

type PiiEntityMask added in v65.28.2 

type PiiEntityMask struct {

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

PiiEntityMask Mask PII entities with the given masking character.

func (PiiEntityMask) MarshalJSON added in v65.28.2 

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

MarshalJSON marshals to json representation

func (PiiEntityMask) String added in v65.28.2 

func (m PiiEntityMask) String() string

func (PiiEntityMask) ValidateEnumValue added in v65.28.2 

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

type PiiEntityMasking added in v65.28.2 

type PiiEntityMasking interface {
}

PiiEntityMasking Mask recognized PII entities with different modes.

type PiiEntityMaskingModeEnum added in v65.28.2 

type PiiEntityMaskingModeEnum string

PiiEntityMaskingModeEnum Enum with underlying type: string 

const (
	PiiEntityMaskingModeReplace PiiEntityMaskingModeEnum = "REPLACE"
	PiiEntityMaskingModeMask    PiiEntityMaskingModeEnum = "MASK"
	PiiEntityMaskingModeRemove  PiiEntityMaskingModeEnum = "REMOVE"
)

Set of constants representing the allowable values for PiiEntityMaskingModeEnum

func GetMappingPiiEntityMaskingModeEnum added in v65.28.2 

func GetMappingPiiEntityMaskingModeEnum(val string) (PiiEntityMaskingModeEnum, bool)

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

func GetPiiEntityMaskingModeEnumValues added in v65.28.2 

func GetPiiEntityMaskingModeEnumValues() []PiiEntityMaskingModeEnum

GetPiiEntityMaskingModeEnumValues Enumerates the set of values for PiiEntityMaskingModeEnum

type PiiEntityRemove added in v65.28.2 

type PiiEntityRemove struct {
}

PiiEntityRemove Remove PII entities from output.

func (PiiEntityRemove) MarshalJSON added in v65.28.2 

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

MarshalJSON marshals to json representation

func (PiiEntityRemove) String added in v65.28.2 

func (m PiiEntityRemove) String() string

func (PiiEntityRemove) ValidateEnumValue added in v65.28.2 

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

type PiiEntityReplace added in v65.28.2 

type PiiEntityReplace struct {

	// Replace entities with given sequence of characters. By default PII entity will be replaced with <ENTITY_TYPE>.
	ReplaceWith *string `mandatory:"false" json:"replaceWith"`
}

PiiEntityReplace Replace PII entities with a given sequence of characters.

func (PiiEntityReplace) MarshalJSON added in v65.28.2 

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

MarshalJSON marshals to json representation

func (PiiEntityReplace) String added in v65.28.2 

func (m PiiEntityReplace) String() string

func (PiiEntityReplace) ValidateEnumValue added in v65.28.2 

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

type PiiModelDetails added in v65.63.2 

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

PiiModelDetails Possible Custom PII model information

func (PiiModelDetails) GetLanguageCode added in v65.63.2 

func (m PiiModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PiiModelDetails) MarshalJSON added in v65.63.2 

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

MarshalJSON marshals to json representation

func (PiiModelDetails) String added in v65.63.2 

func (m PiiModelDetails) String() string

func (PiiModelDetails) ValidateEnumValue added in v65.63.2 

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

type PreDeployedLanguageModels added in v65.24.0 

type PreDeployedLanguageModels struct {

	// Unique identifier that is immutable on creation
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) Compartment Identifier
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Language Entities Description
	Description *string `mandatory:"false" json:"description"`
}

PreDeployedLanguageModels Description of Language Entities.

func (PreDeployedLanguageModels) String added in v65.24.0 

func (m PreDeployedLanguageModels) String() string

func (PreDeployedLanguageModels) ValidateEnumValue added in v65.24.0 

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

type PreTrainedHealthNluModelDetails added in v65.47.0 

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

PreTrainedHealthNluModelDetails Possible pre trained health NLU model information

func (PreTrainedHealthNluModelDetails) GetLanguageCode added in v65.47.0 

func (m PreTrainedHealthNluModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedHealthNluModelDetails) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedHealthNluModelDetails) String added in v65.47.0 

func (m PreTrainedHealthNluModelDetails) String() string

func (PreTrainedHealthNluModelDetails) ValidateEnumValue added in v65.47.0 

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

type PreTrainedKeyPhraseExtractionModelDetails added in v65.47.0 

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

PreTrainedKeyPhraseExtractionModelDetails Possible pre trained TXT model information

func (PreTrainedKeyPhraseExtractionModelDetails) GetLanguageCode added in v65.47.0 

func (m PreTrainedKeyPhraseExtractionModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedKeyPhraseExtractionModelDetails) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedKeyPhraseExtractionModelDetails) String added in v65.47.0 

func (m PreTrainedKeyPhraseExtractionModelDetails) String() string

func (PreTrainedKeyPhraseExtractionModelDetails) ValidateEnumValue added in v65.47.0 

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

type PreTrainedLanguageDetectionModelDetails added in v65.47.0 

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

PreTrainedLanguageDetectionModelDetails Possible pre trained TXT model information

func (PreTrainedLanguageDetectionModelDetails) GetLanguageCode added in v65.47.0 

func (m PreTrainedLanguageDetectionModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedLanguageDetectionModelDetails) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedLanguageDetectionModelDetails) String added in v65.47.0 

func (m PreTrainedLanguageDetectionModelDetails) String() string

func (PreTrainedLanguageDetectionModelDetails) ValidateEnumValue added in v65.47.0 

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

type PreTrainedNamedEntityRecognitionModelDetails added in v65.47.0 

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

PreTrainedNamedEntityRecognitionModelDetails Possible pre trained NER model information

func (PreTrainedNamedEntityRecognitionModelDetails) GetLanguageCode added in v65.47.0 

func (m PreTrainedNamedEntityRecognitionModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedNamedEntityRecognitionModelDetails) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedNamedEntityRecognitionModelDetails) String added in v65.47.0 

func (m PreTrainedNamedEntityRecognitionModelDetails) String() string

func (PreTrainedNamedEntityRecognitionModelDetails) ValidateEnumValue added in v65.47.0 

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

type PreTrainedPiiModelDetails added in v65.47.0 

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

PreTrainedPiiModelDetails Possible pre trained PII model information

func (PreTrainedPiiModelDetails) GetLanguageCode added in v65.47.0 

func (m PreTrainedPiiModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedPiiModelDetails) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedPiiModelDetails) String added in v65.47.0 

func (m PreTrainedPiiModelDetails) String() string

func (PreTrainedPiiModelDetails) ValidateEnumValue added in v65.47.0 

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

type PreTrainedSentimentAnalysisModelDetails added in v65.47.0 

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

PreTrainedSentimentAnalysisModelDetails Possible pre trained TXT model information

func (PreTrainedSentimentAnalysisModelDetails) GetLanguageCode added in v65.47.0 

func (m PreTrainedSentimentAnalysisModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedSentimentAnalysisModelDetails) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedSentimentAnalysisModelDetails) String added in v65.47.0 

func (m PreTrainedSentimentAnalysisModelDetails) String() string

func (PreTrainedSentimentAnalysisModelDetails) ValidateEnumValue added in v65.47.0 

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

type PreTrainedSummarization added in v65.47.0 

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

PreTrainedSummarization Possible pre trained summarization information

func (PreTrainedSummarization) GetLanguageCode added in v65.47.0 

func (m PreTrainedSummarization) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedSummarization) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedSummarization) String added in v65.47.0 

func (m PreTrainedSummarization) String() string

func (PreTrainedSummarization) ValidateEnumValue added in v65.47.0 

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

type PreTrainedTextClassificationModelDetails added in v65.47.0 

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

PreTrainedTextClassificationModelDetails Possible pre trained TXT model information

func (PreTrainedTextClassificationModelDetails) GetLanguageCode added in v65.47.0 

func (m PreTrainedTextClassificationModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedTextClassificationModelDetails) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedTextClassificationModelDetails) String added in v65.47.0 

func (m PreTrainedTextClassificationModelDetails) String() string

func (PreTrainedTextClassificationModelDetails) ValidateEnumValue added in v65.47.0 

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

type PreTrainedUniversalModel added in v65.47.0 

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

PreTrainedUniversalModel Possible pre trained universal model information

func (PreTrainedUniversalModel) GetLanguageCode added in v65.47.0 

func (m PreTrainedUniversalModel) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (PreTrainedUniversalModel) MarshalJSON added in v65.47.0 

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

MarshalJSON marshals to json representation

func (PreTrainedUniversalModel) String added in v65.47.0 

func (m PreTrainedUniversalModel) String() string

func (PreTrainedUniversalModel) ValidateEnumValue added in v65.47.0 

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

type Profile added in v65.63.2 

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

Profile Documents profile

func (Profile) String added in v65.63.2 

func (m Profile) String() string

func (Profile) ValidateEnumValue added in v65.63.2 

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

type Project added in v65.24.0 

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.cloud.oracle.com/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"`
}

Project Project enable users to organize their project resources.

func (Project) String added in v65.24.0 

func (m Project) String() string

func (Project) ValidateEnumValue added in v65.24.0 

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

type ProjectCollection added in v65.24.0 

type ProjectCollection struct {

	// List of projects
	Items []ProjectSummary `mandatory:"true" json:"items"`
}

ProjectCollection Results of a Project List. Contains ProjectSummary items.

func (ProjectCollection) String added in v65.24.0 

func (m ProjectCollection) String() string

func (ProjectCollection) ValidateEnumValue added in v65.24.0 

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

type ProjectLifecycleStateEnum added in v65.24.0 

type ProjectLifecycleStateEnum string

ProjectLifecycleStateEnum Enum with underlying type: string 

const (
	ProjectLifecycleStateDeleting ProjectLifecycleStateEnum = "DELETING"
	ProjectLifecycleStateDeleted  ProjectLifecycleStateEnum = "DELETED"
	ProjectLifecycleStateFailed   ProjectLifecycleStateEnum = "FAILED"
	ProjectLifecycleStateCreating ProjectLifecycleStateEnum = "CREATING"
	ProjectLifecycleStateActive   ProjectLifecycleStateEnum = "ACTIVE"
	ProjectLifecycleStateUpdating ProjectLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ProjectLifecycleStateEnum

func GetMappingProjectLifecycleStateEnum added in v65.24.0 

func GetMappingProjectLifecycleStateEnum(val string) (ProjectLifecycleStateEnum, bool)

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

func GetProjectLifecycleStateEnumValues added in v65.24.0 

func GetProjectLifecycleStateEnumValues() []ProjectLifecycleStateEnum

GetProjectLifecycleStateEnumValues Enumerates the set of values for ProjectLifecycleStateEnum

type ProjectSummary added in v65.24.0 

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.cloud.oracle.com/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"`
}

ProjectSummary Summary of the project.

func (ProjectSummary) String added in v65.24.0 

func (m ProjectSummary) String() string

func (ProjectSummary) ValidateEnumValue added in v65.24.0 

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

type RelationEntity added in v65.63.2 

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

RelationEntity The relation entities details for health ner.

func (RelationEntity) String added in v65.63.2 

func (m RelationEntity) String() string

func (RelationEntity) ValidateEnumValue added in v65.63.2 

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

type ResolvedEntities added in v65.63.2 

type ResolvedEntities struct {

	// List of resolved entities
	Details []ResolvedEntity `mandatory:"true" json:"details"`
}

ResolvedEntities Resolved entities.

func (ResolvedEntities) String added in v65.63.2 

func (m ResolvedEntities) String() string

func (ResolvedEntities) ValidateEnumValue added in v65.63.2 

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

type ResolvedEntity added in v65.63.2 

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

ResolvedEntity Resolved entity.

func (ResolvedEntity) String added in v65.63.2 

func (m ResolvedEntity) String() string

func (ResolvedEntity) ValidateEnumValue added in v65.63.2 

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

type SentimentAspect 

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

SentimentAspect Sentiment aspect object.

func (SentimentAspect) String 

func (m SentimentAspect) String() string

func (SentimentAspect) ValidateEnumValue 

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

type SentimentDocumentResult 

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

SentimentDocumentResult The document response for sentiment detect call.

func (SentimentDocumentResult) String 

func (m SentimentDocumentResult) String() string

func (SentimentDocumentResult) ValidateEnumValue 

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

type SentimentSentence 

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

SentimentSentence Sentiment sentence object.

func (SentimentSentence) String 

func (m SentimentSentence) String() string

func (SentimentSentence) ValidateEnumValue 

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

type SortOrderEnum added in v65.24.0 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum added in v65.24.0 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues added in v65.24.0 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type TestAndValidationDatasetStrategy added in v65.24.0 

type TestAndValidationDatasetStrategy struct {
	TestingDataset DatasetDetails `mandatory:"true" json:"testingDataset"`

	ValidationDataset DatasetDetails `mandatory:"false" json:"validationDataset"`
}

TestAndValidationDatasetStrategy This information will be used capture training, testing and validation dataset.

func (TestAndValidationDatasetStrategy) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (TestAndValidationDatasetStrategy) String added in v65.24.0 

func (m TestAndValidationDatasetStrategy) String() string

func (*TestAndValidationDatasetStrategy) UnmarshalJSON added in v65.24.0 

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

UnmarshalJSON unmarshals from json

func (TestAndValidationDatasetStrategy) ValidateEnumValue added in v65.24.0 

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

type TestStrategy added in v65.24.0 

type TestStrategy interface {
}

TestStrategy Possible strategy as testing and validation(optional) dataset.

type TestStrategyStrategyTypeEnum added in v65.24.0 

type TestStrategyStrategyTypeEnum string

TestStrategyStrategyTypeEnum Enum with underlying type: string 

const (
	TestStrategyStrategyTypeTestAndValidationDataset TestStrategyStrategyTypeEnum = "TEST_AND_VALIDATION_DATASET"
)

Set of constants representing the allowable values for TestStrategyStrategyTypeEnum

func GetMappingTestStrategyStrategyTypeEnum added in v65.24.0 

func GetMappingTestStrategyStrategyTypeEnum(val string) (TestStrategyStrategyTypeEnum, bool)

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

func GetTestStrategyStrategyTypeEnumValues added in v65.24.0 

func GetTestStrategyStrategyTypeEnumValues() []TestStrategyStrategyTypeEnum

GetTestStrategyStrategyTypeEnumValues Enumerates the set of values for TestStrategyStrategyTypeEnum

type TextClassification 

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

TextClassification Text label and score for the given text.

func (TextClassification) String 

func (m TextClassification) String() string

func (TextClassification) ValidateEnumValue 

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

type TextClassificationDocumentResult 

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

TextClassificationDocumentResult The document response for test classification detect call.

func (TextClassificationDocumentResult) String 

func (m TextClassificationDocumentResult) String() string

func (TextClassificationDocumentResult) ValidateEnumValue 

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

type TextClassificationEvaluationResults added in v65.24.0 

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

TextClassificationEvaluationResults Text Classification model testing and evaluation results

func (TextClassificationEvaluationResults) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (TextClassificationEvaluationResults) String added in v65.24.0 

func (m TextClassificationEvaluationResults) String() string

func (TextClassificationEvaluationResults) ValidateEnumValue added in v65.24.0 

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

type TextClassificationModelDetails added in v65.24.0 

type TextClassificationModelDetails struct {

	// supported language default value is en
	LanguageCode *string `mandatory:"false" json:"languageCode"`

	ClassificationMode ClassificationType `mandatory:"false" json:"classificationMode"`
}

TextClassificationModelDetails Possible TextClassificationModelDetails

func (TextClassificationModelDetails) GetLanguageCode added in v65.24.0 

func (m TextClassificationModelDetails) GetLanguageCode() *string

GetLanguageCode returns LanguageCode

func (TextClassificationModelDetails) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (TextClassificationModelDetails) String added in v65.24.0 

func (m TextClassificationModelDetails) String() string

func (*TextClassificationModelDetails) UnmarshalJSON added in v65.24.0 

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

UnmarshalJSON unmarshals from json

func (TextClassificationModelDetails) ValidateEnumValue added in v65.24.0 

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

type TextClassificationModelEvaluationResult added in v65.24.0 

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

TextClassificationModelEvaluationResult Possible TXTC model error analysis

func (TextClassificationModelEvaluationResult) GetDefinedTags added in v65.24.0 

func (m TextClassificationModelEvaluationResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (TextClassificationModelEvaluationResult) GetFreeformTags added in v65.24.0 

func (m TextClassificationModelEvaluationResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (TextClassificationModelEvaluationResult) MarshalJSON added in v65.24.0 

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

MarshalJSON marshals to json representation

func (TextClassificationModelEvaluationResult) String added in v65.24.0 

func (m TextClassificationModelEvaluationResult) String() string

func (TextClassificationModelEvaluationResult) ValidateEnumValue added in v65.24.0 

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

type TextClassificationModelMetrics added in v65.24.0 

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

TextClassificationModelMetrics Model level text classification metrics

func (TextClassificationModelMetrics) String added in v65.24.0 

func (m TextClassificationModelMetrics) String() string

func (TextClassificationModelMetrics) ValidateEnumValue added in v65.24.0 

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

type TextDocument added in v65.24.0 

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.cloud.oracle.com/iaas/language/using/overview.htm) for supported languages.
	LanguageCode *string `mandatory:"false" json:"languageCode"`
}

TextDocument The document details for language service call.

func (TextDocument) String added in v65.24.0 

func (m TextDocument) String() string

func (TextDocument) ValidateEnumValue added in v65.24.0 

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

type TranslationDocumentResult added in v65.24.0 

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

TranslationDocumentResult The document response for translation call.

func (TranslationDocumentResult) String added in v65.24.0 

func (m TranslationDocumentResult) String() string

func (TranslationDocumentResult) ValidateEnumValue added in v65.24.0 

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

type UpdateEndpointDetails added in v65.24.0 

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

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

	// The OCID (https://docs.cloud.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"`
}

UpdateEndpointDetails The information to be updated.

func (UpdateEndpointDetails) String added in v65.24.0 

func (m UpdateEndpointDetails) String() string

func (UpdateEndpointDetails) ValidateEnumValue added in v65.24.0 

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

type UpdateEndpointRequest added in v65.24.0 

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
}

UpdateEndpointRequest wrapper for the UpdateEndpoint operation

See also

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

func (UpdateEndpointRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateEndpointRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateEndpointRequest) RetryPolicy added in v65.24.0 

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

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

func (UpdateEndpointRequest) String added in v65.24.0 

func (request UpdateEndpointRequest) String() string

func (UpdateEndpointRequest) ValidateEnumValue added in v65.24.0 

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

type UpdateEndpointResponse added in v65.24.0 

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

UpdateEndpointResponse wrapper for the UpdateEndpoint operation

func (UpdateEndpointResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateEndpointResponse) String added in v65.24.0 

func (response UpdateEndpointResponse) String() string

type UpdateJobDetails added in v65.61.2 

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

UpdateJobDetails The information to be updated.

func (UpdateJobDetails) String added in v65.61.2 

func (m UpdateJobDetails) String() string

func (UpdateJobDetails) ValidateEnumValue added in v65.61.2 

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

type UpdateJobRequest added in v65.61.2 

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
}

UpdateJobRequest wrapper for the UpdateJob operation

See also

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

func (UpdateJobRequest) BinaryRequestBody added in v65.61.2 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateJobRequest) HTTPRequest added in v65.61.2 

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

HTTPRequest implements the OCIRequest interface

func (UpdateJobRequest) RetryPolicy added in v65.61.2 

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

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

func (UpdateJobRequest) String added in v65.61.2 

func (request UpdateJobRequest) String() string

func (UpdateJobRequest) ValidateEnumValue added in v65.61.2 

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

type UpdateJobResponse added in v65.61.2 

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

UpdateJobResponse wrapper for the UpdateJob operation

func (UpdateJobResponse) HTTPResponse added in v65.61.2 

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

HTTPResponse implements the OCIResponse interface

func (UpdateJobResponse) String added in v65.61.2 

func (response UpdateJobResponse) String() string

type UpdateModelDetails added in v65.24.0 

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

UpdateModelDetails The information to be updated.

func (UpdateModelDetails) String added in v65.24.0 

func (m UpdateModelDetails) String() string

func (UpdateModelDetails) ValidateEnumValue added in v65.24.0 

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

type UpdateModelRequest added in v65.24.0 

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
}

UpdateModelRequest wrapper for the UpdateModel operation

See also

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

func (UpdateModelRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateModelRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateModelRequest) RetryPolicy added in v65.24.0 

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

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

func (UpdateModelRequest) String added in v65.24.0 

func (request UpdateModelRequest) String() string

func (UpdateModelRequest) ValidateEnumValue added in v65.24.0 

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

type UpdateModelResponse added in v65.24.0 

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

UpdateModelResponse wrapper for the UpdateModel operation

func (UpdateModelResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateModelResponse) String added in v65.24.0 

func (response UpdateModelResponse) String() string

type UpdateProjectDetails added in v65.24.0 

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

UpdateProjectDetails The information to be updated for the project.

func (UpdateProjectDetails) String added in v65.24.0 

func (m UpdateProjectDetails) String() string

func (UpdateProjectDetails) ValidateEnumValue added in v65.24.0 

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

type UpdateProjectRequest added in v65.24.0 

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
}

UpdateProjectRequest wrapper for the UpdateProject operation

See also

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

func (UpdateProjectRequest) BinaryRequestBody added in v65.24.0 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateProjectRequest) HTTPRequest added in v65.24.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateProjectRequest) RetryPolicy added in v65.24.0 

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

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

func (UpdateProjectRequest) String added in v65.24.0 

func (request UpdateProjectRequest) String() string

func (UpdateProjectRequest) ValidateEnumValue added in v65.24.0 

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

type UpdateProjectResponse added in v65.24.0 

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

UpdateProjectResponse wrapper for the UpdateProject operation

func (UpdateProjectResponse) HTTPResponse added in v65.24.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateProjectResponse) String added in v65.24.0 

func (response UpdateProjectResponse) String() string

type WorkRequest added in v65.24.0 

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.cloud.oracle.com/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"`
}

WorkRequest A description of workrequest status

func (WorkRequest) String added in v65.24.0 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue added in v65.24.0 

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

type WorkRequestError added in v65.24.0 

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed on
	// (https://docs.cloud.oracle.com/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"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String added in v65.24.0 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue added in v65.24.0 

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

type WorkRequestErrorCollection added in v65.24.0 

type WorkRequestErrorCollection struct {

	// List of workRequestError objects.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

func (WorkRequestErrorCollection) String added in v65.24.0 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue added in v65.24.0 

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

type WorkRequestLog added in v65.24.0 

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

WorkRequestLog A log message from the execution of a work request.

func (WorkRequestLog) String added in v65.24.0 

func (m WorkRequestLog) String() string

func (WorkRequestLog) ValidateEnumValue added in v65.24.0 

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

type WorkRequestLogCollection added in v65.24.0 

type WorkRequestLogCollection struct {

	// List of workRequestLogEntries.
	Items []WorkRequestLog `mandatory:"true" json:"items"`
}

WorkRequestLogCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

func (WorkRequestLogCollection) String added in v65.24.0 

func (m WorkRequestLogCollection) String() string

func (WorkRequestLogCollection) ValidateEnumValue added in v65.24.0 

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

type WorkRequestResource added in v65.24.0 

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

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String added in v65.24.0 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue added in v65.24.0 

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

type WorkRequestSummary added in v65.24.0 

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.cloud.oracle.com/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"`
}

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String added in v65.24.0 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue added in v65.24.0 

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

type WorkRequestSummaryCollection added in v65.24.0 

type WorkRequestSummaryCollection struct {

	// List of workRequestSummary objects.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

func (WorkRequestSummaryCollection) String added in v65.24.0 

func (m WorkRequestSummaryCollection) String() string

func (WorkRequestSummaryCollection) ValidateEnumValue added in v65.24.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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