Oracle AI Service Language API
API operations for language(NLP)
Oracle AI Service Language API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AIServiceLanguage. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 44 operations across 32 paths, and defines 104 schemas. It is described by OpenAPI 3.2.0, at version 20221001.
Requests are made against 2 base URLs: http://127.0.0.1/20221001, https://127.0.0.1/20221001.
44 operations
32 paths
104 schemas
4 DELETE14 GET22 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 44
Across 32 paths, the API surfaces 44 operations — 4 DELETE, 14 GET, 22 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
AIServiceLanguage 44
API operations for language(NLP)
POST
/actions/batchDetectDominantLanguage
Batch detect dominant language over pre-deployed model.
POST
/actions/batchDetectHealthEntities
Batch detect health entities over pre-deployed model
POST
/actions/batchDetectLanguageEntities
Batch detect entities over pre-deployed model
POST
/actions/batchDetectLanguageKeyPhrases
Batch detect keyPhrase over pre-deployed model.
POST
/actions/batchDetectLanguagePiiEntities
Batch detect pii and phi entities over pre-deployed model
POST
/actions/batchDetectLanguageSentiments
Batch detect sentiments over pre-deployed model.
POST
/actions/batchDetectLanguageTextClassification
Batch detect text classification over pre-deployed model.
POST
/actions/batchLanguageTranslation
Batch translation for translate text to other language over pre-deployed model.
POST
/actions/detectDominantLanguagedeprecated
Detect dominant language over pre-deployed model.
POST
/actions/detectLanguageEntitiesdeprecated
Detect entities over pre-deployed model
POST
/actions/detectLanguageKeyPhrasesdeprecated
Detect keyPhrase over pre-deployed model.
POST
/actions/detectLanguageSentimentsdeprecated
Detect sentiments over pre-deployed model.
POST
/actions/detectLanguageTextClassificationdeprecated
Detect text classification over pre-deployed model.
GET
/endpoints
Gets a list of all Endpoints in a compartment
POST
/endpoints
Creates a new Endpoint and deploy the trained model
DELETE
/endpoints/{endpointId}
Delete a provisioned Endpoint
GET
/endpoints/{endpointId}
Get an Endpoint
PUT
/endpoints/{endpointId}
Updates the endpoint
POST
/endpoints/{endpointId}/actions/changeCompartment
Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
GET
/jobs
Gets a list of all language service async jobs in a compartment
POST
/jobs
Creates a new language service async job
DELETE
/jobs/{jobId}
Delete language service async Job identified by the id
GET
/jobs/{jobId}
Gets a language service async job
PUT
/jobs/{jobId}
Update language service async Job identified by the id
POST
/jobs/{jobId}/actions/cancel
Canceling the job cancels all the tasks under it.
POST
/jobs/{jobId}/actions/changeCompartment
Moves a Job into a different compartment. When provided, If-Match is checked against ETag values of the resource.
GET
/modelTypes/{modelType}
Retrieves model information like versions and capabilities
GET
/models
Gets a list of all models in a compartment
POST
/models
Creates a new Model for training and train the model with date provided.
DELETE
/models/{modelId}
Delete a provisioned model
GET
/models/{modelId}
Get a Model
PUT
/models/{modelId}
Update the Model identified by the id
POST
/models/{modelId}/actions/changeCompartment
Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource.
GET
/models/{modelId}/evaluationResults
Retrieves evaluation results for given model
GET
/projects
Gets a list of all Projects in a compartment.
POST
/projects
Creates a new Project in the compartment.
DELETE
/projects/{projectId}
Delete a provisioned Project
GET
/projects/{projectId}
Get Project
PUT
/projects/{projectId}
Update the Project identified by the id
POST
/projects/{projectId}/actions/changeCompartment
Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource.
GET
/workRequests
List Work Requests
GET
/workRequests/{workRequestId}
GET Work Request Status
GET
/workRequests/{workRequestId}/errors
Lists work request errors
GET
/workRequests/{workRequestId}/logs
Lists work request logs
Schemas 104
The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are Job (21 properties), Model (17 properties), JobSummary (16 properties), Endpoint (15 properties). Each schema is shown below with its type and property counts.
EvaluationResultCollection
object
Results of a model evaluation analysis search. Contains EvaluationResultSummary items.
1 property
1 required
DetectDominantLanguageResult
object
Result of language detect call.
1 property
1 required
DetectLanguageSentimentsDetails
object
The document details for sentiments detect call.
1 property
1 required
PiiEntityDocumentResult
object
The document response for batch detect personal identification and protected health information.
4 properties
4 required
UpdateProjectDetails
object
The information to be updated for the project.
4 properties
SentimentSentence
object
Sentiment sentence object.
5 properties
ChangeJobCompartmentDetails
object
Details for changing the compartment of a language job.
1 property
1 required
Error
object
Error information.
2 properties
2 required
CreateEndpointDetails
object
The information needed to create a new endpoint and expose to end users.
8 properties
2 required
ChangeProjectCompartmentDetails
object
Details for changing the compartment of a Project.
1 property
1 required
InputLocation
object
document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supporte…
1 property
1 required
BatchDetectLanguageTextClassificationResult
object
Result of text classification detect call.
2 properties
1 required
BatchDetectLanguagePiiEntitiesResult
object
Result of batch detect personal identification.
2 properties
1 required
DetectDominantLanguageDetails
object
The document details for language detect call.
1 property
1 required
MelConceptDetails
object
The MEL concepts details for health ner.
4 properties
3 required
BatchDetectLanguageTextClassificationDetails
object
The documents details for text classification call.
4 properties
1 required
PiiEntityMasking
object
Mask recognized PII entities with different modes.
3 properties
1 required
ModelCollection
object
Results of a model search. Contains ModelSummary items.
1 property
1 required
ResolvedEntities
object
Resolved entities.
1 property
1 required
TestStrategy
object
Possible strategy as testing and validation(optional) dataset.
1 property
1 required
WorkRequestSummaryCollection
object
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
1 property
1 required
JobSummary
object
sub set of Job details data which need returns in list API
16 properties
3 required
Model
object
Details of a Language service model.
17 properties
7 required
ModelSummary
object
Summary of the language Model.
13 properties
7 required
DominantLanguageDocument
object
The document details for language detect call.
2 properties
2 required
BatchDetectLanguageSentimentsDetails
object
The documents details for sentiment call.
4 properties
1 required
WorkRequestSummary
object
A summary of the status of a work request.
9 properties
6 required
KeyPhraseDocumentResult
object
The document response for keyPhrases detect call.
3 properties
3 required
ErrorDetails
object
Error Information.
2 properties
2 required
KeyPhrase
object
Key phrase for the given text.
2 properties
2 required
DocumentError
object
Error response for document.
2 properties
2 required
ModelTypeInfo
object
Model information like versions and capabilities
2 properties
1 required
ProjectCollection
object
Results of a Project List. Contains ProjectSummary items.
1 property
1 required
Capabilities
object
Capabilities supported
1 property
MetaInfo
object
MetaInfo of entity detected.
5 properties
DatasetDetails
object
Possible data set type
1 property
1 required
WorkRequestLogCollection
object
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
1 property
1 required
DetectLanguageSentimentsResult
object
Result of sentiments detect call.
1 property
1 required
BatchDetectLanguagePiiEntitiesDetails
object
The documents details to detect personal identification information and protected health information.
6 properties
1 required
DetectLanguageKeyPhrasesResult
object
Result of a language keyPhrases detect call.
1 property
1 required
Entity
object
entity object
6 properties
DetectLanguageEntitiesDetails
object
The document details for entities detect call.
1 property
1 required
BatchDetectLanguageEntitiesDetails
object
The documents details for entities detect call.
4 properties
1 required
BatchLanguageTranslationResult
object
Result of translation call.
2 properties
1 required
ProjectSummary
object
Summary of the project.
11 properties
5 required
AssertionDetails
object
The assertion details for health ner.
4 properties
4 required
BatchDetectLanguageKeyPhrasesResult
object
Result of keyPhrases detect call.
2 properties
1 required
DetectLanguageEntitiesResult
object
Result of entities detect call.
1 property
1 required
ObjectPrefixOutputLocation
object
Object storage output location to write inference results
3 properties
2 required
UpdateJobDetails
object
The information to be updated.
2 properties
ResolvedEntity
object
Resolved entity.
6 properties
6 required
HealthEntity
object
Health entity object
10 properties
6 required
TranslationDocumentResult
object
The document response for translation call.
4 properties
4 required
BatchDetectDominantLanguageResult
object
Result of language detect call.
2 properties
1 required
HierarchicalEntity
object
Hierarchical entity object
7 properties
ModelMetadataDetails
object
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…
5 properties
EndpointCollection
object
Results of an endpoint list. Contains EndpointSummary items.
1 property
1 required
WorkRequest
object
Details of a work request
9 properties
6 required
JobCollection
object
list of Jobs created in the compartment and/or after applying filters based on filters provided by user
1 property
1 required
InputConfiguration
object
input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
2 properties
BatchDetectLanguageEntitiesResult
object
Result of entities detect call.
2 properties
1 required
BatchLanguageTranslationDetails
object
The documents details for translation call.
5 properties
1 required
DetectLanguageKeyPhrasesDetails
object
The document details for a keyPhrases detect call.
1 property
1 required
BatchDetectLanguageSentimentsResult
object
Result of sentiments detect call.
2 properties
1 required
EndpointSummary
object
Summary of the language endpoint.
14 properties
7 required
Endpoint
object
Details of a model endpoint.
15 properties
7 required
DocumentsConfiguration
object
Input documents configuration
1 property
BatchDetectHealthEntityDetails
object
The documents details for health entities detect call.
7 properties
2 required
CreateModelDetails
object
The information needed to train a new model
9 properties
3 required
DetectLanguageTextClassificationDetails
object
The document details for text classification detect call.
1 property
1 required
ChangeEndpointCompartmentDetails
object
Details for changing the compartment of an Endpoint.
1 property
1 required
Capability
object
Capability supported
1 property
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties
3 required
UpdateModelDetails
object
The information to be updated.
4 properties
UpdateEndpointDetails
object
The information to be updated.
7 properties
Profile
object
Documents profile
3 properties
WorkRequestLog
object
A log message from the execution of a work request.
2 properties
2 required
DetectLanguageTextClassificationResult
object
Result of text classification detect call.
1 property
1 required
BatchDetectLanguageKeyPhrasesDetails
object
The documents details for keyPhrases call.
4 properties
1 required
SentimentAspect
object
Sentiment aspect object.
5 properties
WorkRequestError
object
An error encountered while executing a work request.
3 properties
3 required
CreateProjectDetails
object
Parameters needed to create a new project. Projects enable users to organise their language work.
5 properties
1 required
ModelDetails
object
Possible model types
2 properties
1 required
EntityDocumentResult
object
The document response for entities detect call.
3 properties
3 required
BatchDetectDominantLanguageDetails
object
The documents details for language detect call.
6 properties
1 required
EvaluationResults
object
model training results of different models
1 property
1 required
BatchDetectHealthEntityResult
object
Result of health entity detect call.
2 properties
1 required
RelationEntity
object
The relation entities details for health ner.
5 properties
5 required
TextClassificationDocumentResult
object
The document response for test classification detect call.
3 properties
3 required
Project
object
Details of a project.
11 properties
5 required
CreateJobDetails
object
Job creation detail which will have documents on which language services need to run prediction along with output folder
7 properties
4 required
Job
object
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 re…
21 properties
5 required
HealthEntityDocumentResult
object
The document response for health entity detect call.
5 properties
4 required
DetectedLanguage
object
Attributes to the detected language. Contains Language Name , Code, and Confidence Score.
3 properties
3 required
DominantLanguageDocumentResult
object
The document response for language detect call.
2 properties
2 required
SentimentDocumentResult
object
The document response for sentiment detect call.
6 properties
3 required
PiiEntity
object
PII entity object.
6 properties
5 required
WorkRequestErrorCollection
object
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
1 property
1 required
ChangeModelCompartmentDetails
object
Details for changing the compartment of an Model.
1 property
1 required
MelConcept
object
The MEL concepts details for health ner.
2 properties
2 required
EvaluationResultSummary
object
model evaluation analysis of different models
3 properties
1 required
TextClassification
object
Text label and score for the given text.
2 properties
2 required
TextDocument
object
The document details for language service call.
3 properties
2 required
ConfigurationDetails
object
training model details
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#AIServiceLanguage
Where this information came from
This is an independent, third-party profile of Oracle AI Service Language API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.