Namespace Oci.AilanguageService.Models
Classes
AssertionDetails
The assertion details for health ner.
BatchDetectDominantLanguageDetails
The documents details for language detect call.
BatchDetectDominantLanguageResult
Result of language detect call.
BatchDetectHealthEntityDetails
The documents details for health entities detect call.
BatchDetectHealthEntityResult
Result of health entity detect call.
BatchDetectLanguageEntitiesDetails
The documents details for entities detect call.
BatchDetectLanguageEntitiesResult
Result of entities detect call.
BatchDetectLanguageKeyPhrasesDetails
The documents details for keyPhrases call.
BatchDetectLanguageKeyPhrasesResult
Result of keyPhrases detect call.
BatchDetectLanguagePiiEntitiesDetails
The documents details to detect personal identification information.
BatchDetectLanguagePiiEntitiesResult
Result of batch detect personal identification.
BatchDetectLanguageSentimentsDetails
The documents details for sentiment call.
BatchDetectLanguageSentimentsResult
Result of sentiments detect call.
BatchDetectLanguageTextClassificationDetails
The documents details for text classification call.
BatchDetectLanguageTextClassificationResult
Result of text classification detect call.
BatchLanguageTranslationDetails
The documents details for translation call.
BatchLanguageTranslationResult
Result of translation call.
Capabilities
Capabilities supported
Capability
Capability supported
ChangeEndpointCompartmentDetails
Details for changing the compartment of an Endpoint.
ChangeJobCompartmentDetails
Details for changing the compartment of a language job.
ChangeModelCompartmentDetails
Details for changing the compartment of an Model.
ChangeProjectCompartmentDetails
Details for changing the compartment of a Project.
ClassMetrics
class level Text Classification model metrics
ClassificationMultiClassModeDetails
Possible text classification multi class mode details
ClassificationMultiLabelModeDetails
Possible text classification multi label mode details
ClassificationType
possible text classification modes
ClassificationTypeModelConverter
ConfigurationDetails
training model details
ConfusionMatrixDetails
confusion matrix details
CreateEndpointDetails
The information needed to create a new endpoint and expose to end users.
CreateJobDetails
Job creation detail which will have documents on which language services need to run prediction along with output folder
CreateModelDetails
The information needed to train a new model
CreateProjectDetails
Parameters needed to create a new project. Projects enable users to organise their language work.
DataScienceLabelingDataset
Dataset that uses data science labelling service as underlying data source.
DatasetDetails
Possible data set type
DatasetDetailsModelConverter
DetectDominantLanguageDetails
The document details for language detect call.
DetectDominantLanguageResult
Result of language detect call.
DetectLanguageEntitiesDetails
The document details for entities detect call.
DetectLanguageEntitiesResult
Result of entities detect call.
DetectLanguageKeyPhrasesDetails
The document details for a keyPhrases detect call.
DetectLanguageKeyPhrasesResult
Result of a language keyPhrases detect call.
DetectLanguageSentimentsDetails
The document details for sentiments detect call.
DetectLanguageSentimentsResult
Result of sentiments detect call.
DetectLanguageTextClassificationDetails
The document details for text classification detect call.
DetectLanguageTextClassificationResult
Result of text classification detect call.
DetectedLanguage
Attributes to the detected language. Contains Language Name , Code, and Confidence Score.
DocumentError
Error response for document.
DocumentsConfiguration
Input documents configuration
DominantLanguageDocument
The document details for language detect call.
DominantLanguageDocumentResult
The document response for language detect call.
Endpoint
Description of the endpoint.
EndpointCollection
Results of an endpoint list. Contains EndpointSummary items.
EndpointSummary
Summary of the language endpoint.
Entity
entity object
EntityDocumentResult
The document response for entities detect call.
EntityLabelErrorAnalysis
Possible entity error label error details
EntityMetrics
Entity level named entity recognition model metrics
ErrorDetails
Error Information.
EvaluationResultCollection
Results of a model evaluation analysis search. Contains EvaluationResultSummary items.
EvaluationResultSummary
model evaluation analysis of different models
EvaluationResultSummaryModelConverter
EvaluationResults
model training results of different models
EvaluationResultsModelConverter
HealthEntity
Health entity object
HealthEntityDocumentResult
The document response for health entity detect call.
HierarchicalEntity
Hierarchical entity object
InputConfiguration
input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
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
InputLocationModelConverter
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
JobCollection
list of Jobs created in the compartment and/or after applying filters based on filters provided by user
JobSummary
sub set of Job details data which need returns in list API
KeyPhrase
Key phrase for the given text.
KeyPhraseDocumentResult
The document response for keyPhrases detect call.
LocationDetails
Possible object storage location types
LocationDetailsModelConverter
MelConcept
The MEL concepts details for health ner.
MelConceptDetails
The MEL concepts details for health ner.
Model
Description of the a Model.
ModelCollection
Results of a model search. Contains ModelSummary items.
ModelDetails
Possible model types
ModelDetailsModelConverter
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
ModelSummary
Summary of the language Model.
ModelTypeInfo
Model information like versions and capabilities
NamedEntityRecognitionEvaluationResult
Possible NER model error analysis
NamedEntityRecognitionEvaluationResults
Named entity recognition model testing and evaluation results
NamedEntityRecognitionModelDetails
Possible NER model information
NamedEntityRecognitionModelMetrics
Model level named entity recognition metrics
ObjectListDataset
Data source details for object storage
ObjectPrefixOutputLocation
Object storage output location to write inference results
ObjectStorageDataset
Different type of location types supported for object storage
ObjectStorageFileNameLocation
list of text files need to be used for prediction
ObjectStoragePrefixLocation
Properties specific to object storage prefix location
PiiEntity
PII entity object.
PiiEntityDocumentResult
The document response for batch detect personal identification.
PiiEntityMask
Mask PII entities with the given masking character.
PiiEntityMasking
Mask recognized PII entities with different modes.
PiiEntityMaskingModelConverter
PiiEntityRemove
Remove PII entities from output.
PiiEntityReplace
Replace PII entities with a given sequence of characters.
PiiModelDetails
Possible Custom PII model information
PreDeployedLanguageModels
Description of Language Entities.
PreTrainedHealthNluModelDetails
Possible pre trained health NLU model information
PreTrainedKeyPhraseExtractionModelDetails
Possible pre trained TXT model information
PreTrainedLanguageDetectionModelDetails
Possible pre trained TXT model information
PreTrainedNamedEntityRecognitionModelDetails
Possible pre trained NER model information
PreTrainedPiiModelDetails
Possible pre trained PII model information
PreTrainedSentimentAnalysisModelDetails
Possible pre trained TXT model information
PreTrainedSummarization
Possible pre trained summarization information
PreTrainedTextClassificationModelDetails
Possible pre trained TXT model information
PreTrainedUniversalModel
Possible pre trained universal model information
Profile
Documents profile
Project
Project enable users to organize their project resources.
ProjectCollection
Results of a Project List. Contains ProjectSummary items.
ProjectSummary
Summary of the project.
RelationEntity
The relation entities details for health ner.
ResolvedEntities
Resolved entities.
ResolvedEntity
Resolved entity.
SentimentAspect
Sentiment aspect object.
SentimentDocumentResult
The document response for sentiment detect call.
SentimentSentence
Sentiment sentence object.
TestAndValidationDatasetStrategy
This information will be used capture training, testing and validation dataset.
TestStrategy
Possible strategy as testing and validation(optional) dataset.
TestStrategyModelConverter
TextClassification
Text label and score for the given text.
TextClassificationDocumentResult
The document response for test classification detect call.
TextClassificationEvaluationResults
Text Classification model testing and evaluation results
TextClassificationModelDetails
Possible TextClassificationModelDetails
TextClassificationModelEvaluationResult
Possible TXTC model error analysis
TextClassificationModelMetrics
Model level text classification metrics
TextDocument
The document details for language service call.
TranslationDocumentResult
The document response for translation call.
UpdateEndpointDetails
The information to be updated.
UpdateJobDetails
The information to be updated.
UpdateModelDetails
The information to be updated.
UpdateProjectDetails
The information to be updated for the project.
WorkRequest
A description of workrequest status
WorkRequestError
An error encountered while executing a work request.
WorkRequestErrorCollection
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
WorkRequestLog
A log message from the execution of a work request.
WorkRequestLogCollection
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
WorkRequestResource
A resource created or operated on by a work request.
WorkRequestSummary
A summary of the status of a work request.
WorkRequestSummaryCollection
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
Enums
ActionType
Possible types of actions.
ClassificationType.ClassificationModeEnum
DatasetDetails.DatasetTypeEnum
Endpoint.LifecycleStateEnum
InputLocation.LocationTypeEnum
Job.LifecycleStateEnum
LocationDetails.LocationTypeEnum
Model.LifecycleStateEnum
ModelDetails.ModelTypeEnum
NerModelVersion
Posible Named Entity Recognition versions.
OperationStatus
Possible operation status.
OperationType
Possible operation types.
PiiEntityMasking.ModeEnum
Project.LifecycleStateEnum
SortOrder
Sort orders.