openapi: 3.2.0
info:
description: 'OCI Language Service solutions can help enterprise customers integrate AI into their products immediately using our proven,
pre-trained and custom models or containers, without a need to set up an house team of AI and ML experts.
This allows enterprises to focus on business drivers and development work rather than AI and ML operations, which shortens the time to market.
'
title: Language AI Service Language API
version: '20221001'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/adb3a186e5819a0420c88de5187f9efa91a143c6564545e588f0adf493273cae.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Language API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/adb3a186e5819a0420c88de5187f9efa91a143c6564545e588f0adf493273cae.yaml
what: the harvested document for Language API
servers:
- url: http://127.0.0.1/20221001
- url: https://127.0.0.1/20221001
tags:
- description: API operations for language(NLP)
name: AIServiceLanguage
paths:
/actions/batchDetectDominantLanguage:
post:
description: 'The API returns the detected language and a related confidence score (between 0 and 1). 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.
'
operationId: BatchDetectDominantLanguage
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected language.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectDominantLanguageResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Batch detect dominant language over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchDetectDominantLanguage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectDominantLanguageDetails'
description: 'The details to make a language detection detect call.
'
required: true
/actions/batchDetectHealthEntities:
post:
description: '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.
'
operationId: BatchDetectHealthEntity
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: 'The model has successfully detected health entities.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectHealthEntityResult'
summary: Batch detect health entities over pre-deployed model
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchDetectHealthEntityDetails'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectHealthEntityDetails'
description: 'The details to make a health entity detect call.
'
required: true
/actions/batchDetectLanguageEntities:
post:
description: '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.](/iaas/language/using/ner.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.
'
operationId: BatchDetectLanguageEntities
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected entities.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageEntitiesResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Batch detect entities over pre-deployed model
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchDetectLanguageEntities'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageEntitiesDetails'
description: 'The details to make a Entity detect call.
'
required: true
/actions/batchDetectLanguageKeyPhrases:
post:
description: '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.
'
operationId: BatchDetectLanguageKeyPhrases
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected keyPhrases.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageKeyPhrasesResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Batch detect keyPhrase over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchDetectLanguageKeyPhrases'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageKeyPhrasesDetails'
description: 'The details to make keyPhrase detect call.
'
required: true
/actions/batchDetectLanguagePiiEntities:
post:
description: 'The API extracts pii and phi 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.
'
operationId: BatchDetectLanguagePiiEntities
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: 'The model has successfully detected pii and phi entities.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguagePiiEntitiesResult'
summary: Batch detect pii and phi entities over pre-deployed model
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchDetectLanguagePiiEntities'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguagePiiEntitiesDetails'
description: 'The details to make a PII and PHI entity detect call.
'
required: true
/actions/batchDetectLanguageSentiments:
post:
description: "The API extracts aspect-based and sentence level sentiment in text records.\nThe text provided must have aspects for the model to detect otherwise the response is a blank array.\n\nFor 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.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed).\n\nLearn more about sentiment analysis [here](/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A batch may have up to 100 records.\n - A record may be up to 5000 characters long.\n - The total of characters to process in a request can be up to 20,000 characters.\n"
operationId: BatchDetectLanguageSentiments
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- description: "Set this parameter for sentence and aspect level sentiment analysis.\nAllowed values are:\n - ASPECT\n - SENTENCE\n"
in: query
name: level
x-default-description: ASPECT.
style: form
explode: true
schema:
type: array
items:
enum:
- ASPECT
- SENTENCE
type: string
responses:
200:
description: 'The model has successfully detected sentiments.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageSentimentsResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Batch detect sentiments over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchDetectLanguageSentiments'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageSentimentsDetails'
description: 'The details to make sentiment detect call.
'
required: true
/actions/batchDetectLanguageTextClassification:
post:
description: '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](/iaas/language/using/text-class.htm).
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.
'
operationId: BatchDetectLanguageTextClassification
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected text labels.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageTextClassificationResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Batch detect text classification over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchDetectLanguageTextClassification'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDetectLanguageTextClassificationDetails'
description: 'The details to make text classification detect call.
'
required: true
/actions/batchLanguageTranslation:
post:
description: "Translates a batch of text documents from source to target language.\nA batch can contain:\n - up to 100 records.\n - documents length less than 5000 characters.\n - 20,000 characters in total as a sum of all documents length.\n"
operationId: BatchLanguageTranslation
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: 'The model has successfully translation.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BatchLanguageTranslationResult'
summary: Batch translation for translate text to other language over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/BatchLanguageTranslation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchLanguageTranslationDetails'
description: 'The details to make language translation call.
'
required: true
/actions/detectDominantLanguage:
post:
deprecated: true
description: 'We don''t recommend using this API as deprecation is planned instead use the BatchDetectDominantLanguage API.
This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
The API returns the detected language and a related confidence score (between 0 and 1).
[List of supported languages.](/iaas/language/using/pretrain-models.htm#lang-detect)
Limitations:
- A record may be up to 1000 characters long.
'
operationId: DetectDominantLanguage
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected language.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
sunset:
description: 'This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DetectDominantLanguageResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Detect dominant language over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/DetectDominantLanguage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DetectDominantLanguageDetails'
description: 'The details to make a language detection detect call.
'
required: true
/actions/detectLanguageEntities:
post:
deprecated: true
description: 'We don''t recommend using this API as deprecation is planned instead use the BatchDetectLanguageEntities API.
This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
The 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.
'
operationId: DetectLanguageEntities
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NerModelVersionQueryParam'
- description: '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.
'
in: query
name: isPii
schema:
type: boolean
default: false
responses:
200:
description: 'The model has successfully detected entities.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
sunset:
description: 'This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageEntitiesResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Detect entities over pre-deployed model
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/DetectLanguageEntities'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageEntitiesDetails'
description: 'The details to make a Entity detect call.
'
required: true
/actions/detectLanguageKeyPhrases:
post:
deprecated: true
description: 'We don''t recommend using this API as deprecation is planned instead use the BatchDetectLanguageKeyPhrases API.
This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
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.
Limitations:
- A record may be up to 1000 characters long.
'
operationId: DetectLanguageKeyPhrases
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected keyPhrases.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
sunset:
description: 'This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageKeyPhrasesResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Detect keyPhrase over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/DetectLanguageKeyPhrases'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageKeyPhrasesDetails'
description: 'The details to make keyPhrase detect call.
'
required: true
/actions/detectLanguageSentiments:
post:
deprecated: true
description: "We don't recommend using this API as deprecation is planned instead use the BatchDetectLanguageSentiments API.\nThis API will be retired on Monday, 10 Oct 2023 00:00:00 GMT\nThe API extracts aspect-based in text records.\nThe text provided must have aspects for the model to detect otherwise the response is a blank array.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral).\n\nLearn more about sentiment analysis [here](/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A record may be up to 1000 characters long.\n"
operationId: DetectLanguageSentiments
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected sentiments.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
sunset:
description: 'This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageSentimentsResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Detect sentiments over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/DetectLanguageSentiments'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageSentimentsDetails'
description: 'The details to make sentiment detect call.
'
required: true
/actions/detectLanguageTextClassification:
post:
deprecated: true
description: 'We don''t recommend using this API as deprecation is planned instead use the BatchDetectLanguageTextClassification API.
This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
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.
Learn more about text classification [here](/iaas/language/using/pretrain-models.htm#text-class).
Limitations:
- A record may be up to 1000 characters long.
'
operationId: DetectLanguageTextClassification
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The model has successfully detected text labels.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
sunset:
description: 'This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageTextClassificationResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Detect text classification over pre-deployed model.
tags:
- AIServiceLanguage
x-related-resource: '#/definitions/DetectLanguageTextClassification'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DetectLanguageTextClassificationDetails'
description: 'The details to make text classification detect call.
'
required: true
/endpoints:
get:
description: 'Returns a list of Endpoints.
'
operationId: ListEndpoints
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/EndpointIdentifierQueryParam'
- $ref: '#/components/parameters/EndpointProjectIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/EndpointModelIdQueryParam'
- $ref: '#/components/parameters/EndpointLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/EndpointSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: A page of ModelEndpointSummary objects.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointCollection'
summary: Gets a list of all Endpoints in a compartment
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Endpoint'
post:
description: 'Creates a new endpoint and deploy the trained model
'
operationId: CreateEndpoint
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
201:
description: Accepted the request. Endpoint will be created and trained model will be deployed
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'The URI that identifies the entity described in the response body.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Endpoint'
summary: Creates a new Endpoint and deploy the trained model
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Endpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEndpointDetails'
description: Details for the new endpoint.
required: true
/endpoints/{endpointId}:
delete:
description: 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.
operationId: DeleteEndpoint
parameters:
- $ref: '#/components/parameters/EndpointIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The endpoint will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
summary: Delete a provisioned Endpoint
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Endpoint'
get:
description: Gets an endpoint by identifier
operationId: GetEndpoint
parameters:
- $ref: '#/components/parameters/EndpointIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: Retrieves the endpoint with the given id
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Endpoint'
summary: Get an Endpoint
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
put:
description: Update the Endpoint identified by the id
operationId: UpdateEndpoint
parameters:
- $ref: '#/components/parameters/EndpointIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The endpoint resource is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
summary: Updates the endpoint
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Endpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEndpointDetails'
description: The information to be updated.
required: true
/endpoints/{endpointId}/actions/changeCompartment:
post:
description: Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
operationId: ChangeEndpointCompartment
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: '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.
'
in: header
name: if-match
required: false
schema:
type: string
- description: '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).
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
- $ref: '#/components/parameters/EndpointIdentifierPathParam'
responses:
204:
description: The Endpoint was moved to the compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Endpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEndpointCompartmentDetails'
required: true
/jobs:
get:
description: 'Returns a list of language service async Jobs.
'
operationId: ListJobs
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/JobLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/IdentifierQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: A page of JobSummary objects.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JobCollection'
summary: Gets a list of all language service async jobs in a compartment
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Job'
post:
description: 'Creates a new language service async job.
'
operationId: CreateJob
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
201:
description: The language service async Job is accepted.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
summary: Creates a new language service async job
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Job'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJobDetails'
description: Details for the new job.
required: true
/jobs/{jobId}:
delete:
description: Deletes the language service async Job
operationId: DeleteJob
parameters:
- $ref: '#/components/parameters/JobIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The model will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
summary: Delete language service async Job identified by the id
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Job'
get:
description: Gets a language service async job
operationId: GetJob
parameters:
- $ref: '#/components/parameters/JobIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: Retrieves the language service async Job with the given id
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
summary: Gets a language service async job
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Job'
put:
description: Updates the language service async Job
operationId: UpdateJob
parameters:
- $ref: '#/components/parameters/JobIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: Updated the request. The language service async Job is updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
summary: Update language service async Job identified by the id
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Job'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJobDetails'
description: The information to be updated.
required: true
/jobs/{jobId}/actions/cancel:
post:
description: Canceling the job cancels all the tasks under it.
operationId: CancelJob
parameters:
- $ref: '#/components/parameters/JobIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The Job resource will be canceled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
summary: Canceling the job cancels all the tasks under it.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Job'
/jobs/{jobId}/actions/changeCompartment:
post:
description: Moves a Job into a different compartment. When provided, If-Match is checked against ETag values of the resource.
operationId: ChangeJobCompartment
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: '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.
'
in: header
name: if-match
required: false
schema:
type: string
- description: '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).
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
- $ref: '#/components/parameters/JobIdentifierPathParam'
responses:
204:
description: The Job was moved to the compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Moves a Job into a different compartment. When provided, If-Match is checked against ETag values of the resource.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Job'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeJobCompartmentDetails'
required: true
/modelTypes/{modelType}:
get:
description: Gets model capabilities and results like version and model supported info by specifying model type.
operationId: GetModelType
parameters:
- $ref: '#/components/parameters/ModelTypePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: Model versions along with their capabilities
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ModelTypeInfo'
summary: Retrieves model information like versions and capabilities
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ModelTypeInfo'
/models:
get:
description: 'Returns a list of models.
'
operationId: ListModels
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ModelIdentifierQueryParam'
- $ref: '#/components/parameters/ModelProjectIdQueryParam'
- $ref: '#/components/parameters/ModelLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ModelSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: A page of ModelSummary objects.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ModelCollection'
summary: Gets a list of all models in a compartment
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Model'
post:
description: 'Creates a new model for training and train the model with date provided.
'
operationId: CreateModel
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
201:
description: Accepted the request. model will be created and trained
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'The URI that identifies the entity described in the response body.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Model'
summary: Creates a new Model for training and train the model with date provided.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Model'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateModelDetails'
description: Details for the new model.
required: true
/models/{modelId}:
delete:
description: 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.
operationId: DeleteModel
parameters:
- $ref: '#/components/parameters/ModelIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The model will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
summary: Delete a provisioned model
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Model'
get:
description: Gets a model by identifier
operationId: GetModel
parameters:
- $ref: '#/components/parameters/ModelIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: Retrieves the model with the given id
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Model'
summary: Get a Model
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
put:
description: Updates the model
operationId: UpdateModel
parameters:
- $ref: '#/components/parameters/ModelIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The model resource is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
summary: Update the Model identified by the id
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Model'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateModelDetails'
description: The information to be updated.
required: true
/models/{modelId}/actions/changeCompartment:
post:
description: Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource.
operationId: ChangeModelCompartment
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: '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.
'
in: header
name: if-match
required: false
schema:
type: string
- description: '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).
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
- $ref: '#/components/parameters/ModelIdentifierPathParam'
responses:
204:
description: The Model was moved to the compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Model'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeModelCompartmentDetails'
required: true
/models/{modelId}/evaluationResults:
get:
description: Get a (paginated) list of evaluation results for a given model.
operationId: ListEvaluationResults
parameters:
- $ref: '#/components/parameters/ModelIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: Get a (paginated) list of error analysis results for a given model.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluationResultCollection'
summary: Retrieves evaluation results for given model
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/EvaluationResultCollection'
/projects:
get:
description: 'Returns a list of Projects.
'
operationId: ListProjects
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ProjectLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/ProjectIdentifierQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ProjectSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: A page of Project Summary objects.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCollection'
summary: Gets a list of all Projects in a compartment.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Project'
post:
description: 'Creates a new Project.
'
operationId: CreateProject
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
201:
description: Accepted the request. The Project will be created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
summary: Creates a new Project in the compartment.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Project'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectDetails'
description: Details for the new Project.
required: true
/projects/{projectId}:
delete:
description: 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.
operationId: DeleteProject
parameters:
- $ref: '#/components/parameters/ProjectIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The Project will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
summary: Delete a provisioned Project
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Project'
get:
description: Gets a Project by identifier
operationId: GetProject
parameters:
- $ref: '#/components/parameters/ProjectIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: Retrieves the Project with the given id
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
summary: Get Project
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
put:
description: Updates the Project
operationId: UpdateProject
parameters:
- $ref: '#/components/parameters/ProjectIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
202:
description: Accepted the request. The Project will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
summary: Update the Project identified by the id
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Project'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectDetails'
description: The information to be updated.
required: true
/projects/{projectId}/actions/changeCompartment:
post:
description: Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource.
operationId: ChangeProjectCompartment
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: '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.
'
in: header
name: if-match
required: false
schema:
type: string
- description: '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).
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
- $ref: '#/components/parameters/ProjectIdentifierPathParam'
responses:
204:
description: The Project was moved to the compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource.
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Project'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeProjectCompartmentDetails'
required: true
/workRequests:
get:
description: 'Lists the work requests in a compartment.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/WorkRequestIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/ResourceIdQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestSummaryCollection'
summary: List Work Requests
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}:
get:
description: Gets the status of the work request with the given ID.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: The detail of the work request.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequest'
summary: GET Work Request Status
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}/errors:
get:
description: 'Return a (paginated) list of errors for a given work request.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: List of work request errors.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestErrorCollection'
summary: Lists work request errors
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequestError'
/workRequests/{workRequestId}/logs:
get:
description: 'Return a (paginated) list of logs for a given work request.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
200:
description: List of work request logs.
headers:
opc-next-page:
description: '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.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestLogCollection'
summary: Lists work request logs
tags:
- AIServiceLanguage
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequestLog'
components:
parameters:
ProjectLifecycleStateQueryParam:
description: 'Filter results by the specified lifecycle state. Must be a valid
state for the resource type.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Project/lifecycleState'
schema:
type: string
IfMatchHeader:
description: '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.
'
in: header
name: if-match
required: false
schema:
type: string
ModelLifecycleStateQueryParam:
description: 'Filter results by the specified lifecycle state. Must be a valid
state for the resource type.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Model/lifecycleState'
schema:
type: string
SortOrderQueryParam:
description: The sort order to use, either 'asc' or 'desc'.
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: ASC
ModelIdentifierQueryParam:
description: unique model OCID.
in: query
name: modelId
required: false
schema:
type: string
EndpointLifecycleStateQueryParam:
description: 'Filter results by the specified lifecycle state. Must be a valid
state for the resource type.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Endpoint/lifecycleState'
schema:
type: string
ModelProjectIdQueryParam:
description: The ID of the project for which to list the objects.
in: query
name: projectId
required: false
schema:
type: string
maxLength: 255
minLength: 1
JobIdentifierPathParam:
description: unique job OCID.
in: path
name: jobId
required: true
schema:
type: string
EndpointProjectIdQueryParam:
description: The ID of the project for which to list the objects.
in: query
name: projectId
required: false
schema:
type: string
maxLength: 255
minLength: 1
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
IdentifierQueryParam:
description: Unique identifier(OCID).
in: query
name: id
x-default-description: 'null'
schema:
type: string
SortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
ProjectSortByQueryParam:
description: '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.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
NerModelVersionQueryParam:
description: Named Entity Recognition model versions. By default user will get output from V2.1 implementation.
in: query
name: modelVersion
x-obmcs-top-level-enum: '#/definitions/NerModelVersion'
schema:
type: string
enum:
- V2_1
- V1_1
default: V2_1
ProjectIdentifierPathParam:
description: The OCID of the project.
in: path
name: projectId
required: true
schema:
type: string
WorkRequestIdPathParam:
description: The ID of the asynchronous request.
in: path
name: workRequestId
required: true
schema:
type: string
ModelIdentifierPathParam:
description: unique model OCID.
in: path
name: modelId
required: true
schema:
type: string
EndpointSortByQueryParam:
description: '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.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
ProjectIdentifierQueryParam:
description: The ID of the project for which to list the objects.
in: query
name: projectId
required: false
schema:
type: string
maxLength: 255
minLength: 1
DisplayNameQueryParam:
description: A filter to return only resources that match the entire display name given.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
JobLifecycleStateQueryParam:
description: A filter to return only resources whose lifecycleState matches the given lifecycleState.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Job/lifecycleState'
schema:
type: string
PaginationTokenQueryParam:
description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
in: query
name: page
schema:
type: string
minLength: 1
JobIdPathParam:
description: Unique Transcription Job identifier.
in: path
name: jobId
required: true
schema:
type: string
WorkRequestIdQueryParam:
description: The ID of the asynchronous work request.
in: query
name: workRequestId
x-default-description: 'null'
schema:
type: string
ModelTypePathParam:
description: 'Allowed values are :
NAMED_ENTITY_RECOGNITION
TEXT_CLASSIFICATION
PRE_TRAINED_NAMED_ENTITY_RECOGNITION
PRE_TRAINED_TEXT_CLASSIFICATION
PRE_TRAINED_SENTIMENT_ANALYSIS
PRE_TRAINED_KEYPHRASE_EXTRACTION
PRE_TRAINED_LANGUAGE_DETECTION
PRE_TRAINED_PII
'
in: path
name: modelType
required: true
schema:
type: string
RetryTokenHeader:
description: '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.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
WorkRequestSortByQueryParam:
description: '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.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
ModelSortByQueryParam:
description: '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.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
EndpointModelIdQueryParam:
description: The ID of the trained model for which to list the endpoints.
in: query
name: modelId
required: false
schema:
type: string
maxLength: 255
minLength: 1
CompartmentIdQueryParam:
description: The ID of the compartment in which to list resources.
in: query
name: compartmentId
required: true
schema:
type: string
PaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
default: 10
maximum: 100
minimum: 1
ResourceIdQueryParam:
description: The ID of the resource for which list workrequests.
in: query
name: resourceId
required: false
schema:
type: string
EndpointIdentifierQueryParam:
description: The OCID of the endpoint.
in: query
name: endpointId
required: false
schema:
type: string
EndpointIdentifierPathParam:
description: The OCID of the endpoint.
in: path
name: endpointId
required: true
schema:
type: string
schemas:
EvaluationResultCollection:
description: Results of a model evaluation analysis search. Contains EvaluationResultSummary items.
properties:
items:
description: List of model evaluation analysis
items:
$ref: '#/components/schemas/EvaluationResultSummary'
type: array
required:
- items
type: object
DetectDominantLanguageResult:
description: Result of language detect call.
properties:
languages:
description: 'List of detected languages with results sorted in descending order of the scores. Most likely language is on top.
'
items:
$ref: '#/components/schemas/DetectedLanguage'
type: array
required:
- languages
type: object
x-example: "{\n \"languages\":[\n {\n \"name\":\"Bosnian\",\n \"code\":\"bs\",\n \"score\":0.6942308391868572\n },\n {\n \"name\":\"Croatian\",\n \"code\":\"hr\",\n \"score\":0.15768701487872652\n },\n {\n \"name\":\"Serbo-Croatian\",\n \"code\":\"sh\",\n \"score\":0.1480651612334694\n }\n ]\n}\n"
DetectLanguageSentimentsDetails:
description: The document details for sentiments detect call.
properties:
text:
description: Document text for detect sentiments.
type: string
required:
- text
type: object
x-example: "{\n \"text\": \"If an emerging growth company, indicate by check mark if the registrant has elected not to use the extended transition period for complying\"\n}\n"
PiiEntityDocumentResult:
description: The document response for batch detect personal identification and protected health information.
properties:
entities:
description: List of batch detect personal identification.
items:
$ref: '#/components/schemas/PiiEntity'
type: array
key:
description: Document unique identifier defined by the user.
type: string
languageCode:
description: "Language code supported\n- auto : Automatically detect language\n- ar : Arabic\n- pt-BR : Brazilian Portuguese \n- cs : Czech\n- da : Danish\n- nl : Dutch\n- en : English\n- fi : Finnish\n- fr : French\n- fr-CA : Canadian French \n- de : German\n- it : Italian\n- ja : Japanese\n- ko : Korean\n- no : Norwegian\n- pl : Polish\n- ro : Romanian\n- zh-CN : Simplified Chinese\n- es : Spanish\n- sv : Swedish\n- zh-TW : Traditional Chinese\n- tr : Turkish\n- el : Greek\n- he : Hebrew\n"
maxLength: 5
type: string
maskedText:
description: Masked text per given mask mode.
type: string
required:
- key
- entities
- maskedText
- languageCode
type: object
UpdateProjectDetails:
description: The information to be updated for the project.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the project.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type: object
SentimentSentence:
description: Sentiment sentence object.
properties:
length:
description: Length of sentence text.
type: integer
offset:
description: The number of Unicode code points preceding this entity in the submitted text.
type: integer
scores:
additionalProperties:
format: double
type: number
description: 'Scores or confidences for each sentiment.
Example: `{"positive": 1.0, "negative": 0.0}`
'
type: object
sentiment:
description: The highest-score sentiment for the sentence text.
type: string
text:
description: Sentence text.
type: string
type: object
ChangeJobCompartmentDetails:
description: Details for changing the compartment of a language job.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
where the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
Error:
description: Error information.
properties:
code:
description: A short error code that defines the error, meant for programmatic parsing.
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
CreateEndpointDetails:
description: The information needed to create a new endpoint and expose to end users.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) compartment identifier for the endpoint
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the an endpoint.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
inferenceUnits:
description: Number of replicas required for this endpoint. This will be optional parameter. Default will be 1.
maximum: 10
minimum: 1
type: integer
x-default-description: When unspecified, the number of replicas for the endpoint will be set to 1
modelId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- modelId
type: object
ChangeProjectCompartmentDetails:
description: Details for changing the compartment of a Project.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
InputLocation:
description: '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
'
discriminator:
propertyName: locationType
properties:
locationType:
description: 'locationType
'
enum:
- OBJECT_STORAGE_PREFIX
- OBJECT_STORAGE_FILE_LIST
type: string
required:
- locationType
type: object
BatchDetectLanguageTextClassificationResult:
description: Result of text classification detect call.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/TextClassificationDocumentResult'
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"doc1\",\n \"textClassification\":[\n {\n \"label\":\"Computer and Electronics/Software\",\n \"score\":0.499205887\n }\n ],\n \"languageCode\":\"en\"\n },\n {\n \"key\":\"doc2\",\n \"textClassification\":[\n {\n \"label\":\"Health and Medical/Conditions and Disease\",\n \"score\":1.0\n }\n ],\n \"languageCode\":\"en\"\n }\n ],\n \"errors\":[\n\n ]\n}\n"
BatchDetectLanguagePiiEntitiesResult:
description: Result of batch detect personal identification.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/PiiEntityDocumentResult'
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
DetectDominantLanguageDetails:
description: The document details for language detect call.
properties:
text:
description: Document text for detect language.
maxLength: 1000
minLength: 1
type: string
required:
- text
type: object
x-example: "{\n \"text\": \"If an emerging growth company, indicate by check mark if the registrant has elected not to use the extended transition period for complying\"\n}\n"
MelConceptDetails:
description: The MEL concepts details for health ner.
properties:
attributes:
additionalProperties:
type: string
description: additional attribute values specific to ontology for ex. for SNOMED semantic_type and for for ICD-10 default_charge_code etc.
type: object
id:
description: id of the relation
maxLength: 255
minLength: 1
type: string
name:
description: The matched concept name/description on the ontology
maxLength: 255
minLength: 1
type: string
score:
description: The relevant score between the concept and the input text
format: double
maximum: 1.0
minimum: 0.0
type: number
required:
- id
- name
- score
type: object
BatchDetectLanguageTextClassificationDetails:
description: The documents details for text classification call.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
maxLength: 255
minLength: 1
type: string
documents:
description: List of Documents for detect text classification.
items:
$ref: '#/components/schemas/TextDocument'
type: array
endpointId:
description: 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.
maxLength: 255
minLength: 1
type: string
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"doc1\",\n \"text\":\"Zoom interface is really simple and easy to conduct virtual meetings. It is very easy to share the Zoom link to join the video conference.\",\n \"languageCode\":\"en\"\n },\n {\n \"key\":\"doc2\",\n \"text\":\"In 2020 people worldwide moved to working remotely because of the COVID-19 pandemic.\",\n \"languageCode\":\"en\"\n }\n ]\n}\n"
PiiEntityMasking:
description: Mask recognized PII entities with different modes.
discriminator:
propertyName: mode
properties:
exclude:
description: "List of offsets/entities to be excluded from anonymization\n Entities - From entity [list](/iaas/language/using/pii.htm)\n Offsets - have to match to the offset of a detected entity (Otherwise, would be ignored)\n"
items:
type: string
type: array
mode:
description: The type of masking mode.
enum:
- REPLACE
- MASK
- REMOVE
minLength: 1
type: string
shouldDetect:
default: true
description: Specified entities ('Exclude' attribute) will be detected and will be excluded from output text only.
type: boolean
required:
- mode
type: object
ModelCollection:
description: Results of a model search. Contains ModelSummary items.
properties:
items:
description: List of models
items:
$ref: '#/components/schemas/ModelSummary'
type: array
required:
- items
type: object
ResolvedEntities:
description: Resolved entities.
properties:
details:
description: List of resolved entities
items:
$ref: '#/components/schemas/ResolvedEntity'
type: array
required:
- details
type: object
TestStrategy:
description: 'Possible strategy as testing and validation(optional) dataset.
'
discriminator:
propertyName: strategyType
properties:
strategyType:
description: 'This information will define the test strategy
different datasets for test and validation(optional) dataset.
'
enum:
- TEST_AND_VALIDATION_DATASET
type: string
x-default-description: 'If no value provided for TestStrategy then 20% of data in training dataset
used for testing and 80% of data in training dataset for training.
'
required:
- strategyType
type: object
WorkRequestSummaryCollection:
description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
properties:
items:
description: List of workRequestSummary objects.
items:
$ref: '#/components/schemas/WorkRequestSummary'
type: array
required:
- items
type: object
JobSummary:
description: sub set of Job details data which need returns in list API
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
type: string
completedDocuments:
description: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
createdBy:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.
type: string
description:
description: A short description of the job.
type: string
displayName:
description: A user-friendly display name for the job.
type: string
failedDocuments:
description: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job.
type: string
lifecycleDetails:
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.
type: string
lifecycleState:
description: The current state of the Speech Job.
type: string
x-obmcs-enumref: '#/definitions/Job/lifecycleState'
pendingDocuments:
description: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
percentComplete:
description: How much progress the operation has made, vs the total amount of work that must be performed.
maximum: 100
minimum: 0
type: integer
timeAccepted:
description: Job accepted time.
format: date-time
type: string
timeCompleted:
description: Job finished time.
format: date-time
type: string
timeStarted:
description: Job started time.
format: date-time
type: string
totalDocuments:
description: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
warningsCount:
description: warnings count
type: integer
required:
- id
- displayName
- compartmentId
type: object
Model:
description: Details of a Language service model.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the model's compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the Model.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
evaluationResults:
$ref: '#/components/schemas/EvaluationResults'
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Unique identifier model OCID of a model that is immutable on creation
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
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.
maxLength: 400
minLength: 1
type: string
lifecycleState:
description: The state of the model.
enum:
- DELETING
- DELETED
- FAILED
- CREATING
- ACTIVE
- UPDATING
maxLength: 25
minLength: 1
type: string
modelDetails:
$ref: '#/components/schemas/ModelDetails'
projectId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
testStrategy:
$ref: '#/components/schemas/TestStrategy'
timeCreated:
description: The time the the model was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the model was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
trainingDataset:
$ref: '#/components/schemas/DatasetDetails'
version:
description: '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
<>::<>_<>::<>
ex: ai-lang::NER_V1::CUSTOM-V0
'
maxLength: 255
minLength: 1
type: string
required:
- id
- compartmentId
- projectId
- displayName
- timeCreated
- lifecycleState
- modelDetails
type: object
ModelSummary:
description: Summary of the language Model.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the model's compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the Model.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Unique identifier model OCID of a model that is immutable on creation
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
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.
maxLength: 400
minLength: 1
type: string
lifecycleState:
description: The state of the model.
type: string
x-obmcs-enumref: '#/definitions/Model/lifecycleState'
modelDetails:
$ref: '#/components/schemas/ModelDetails'
projectId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
timeCreated:
description: The time the the Model was created. An RFC3339 formatted datetime string.
format: date-time
type: string
version:
description: '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
<>::<>_<>::<>
ex: ai-lang::NER_V1::CUSTOM-V0
'
maxLength: 255
minLength: 1
type: string
required:
- id
- compartmentId
- timeCreated
- lifecycleState
- projectId
- modelDetails
- displayName
type: object
DominantLanguageDocument:
description: The document details for language detect call.
properties:
key:
description: Document unique identifier defined by the user.
maxLength: 255
minLength: 1
type: string
text:
description: Document text for detect language.
maxLength: 5000
minLength: 1
type: string
required:
- key
- text
type: object
BatchDetectLanguageSentimentsDetails:
description: The documents details for sentiment call.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
maxLength: 255
minLength: 1
type: string
documents:
description: List of Documents for detect sentiments.
items:
$ref: '#/components/schemas/TextDocument'
type: array
endpointId:
description: 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.
maxLength: 255
minLength: 1
type: string
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"doc1\",\n \"text\":\"Zoom interface is really simple and easy to conduct virtual meetings. It is very easy to share the Zoom link to join the video conference.\",\n \"languageCode\":\"en\"\n },\n {\n \"key\":\"doc2\",\n \"text\":\"In 2020 people worldwide moved to working remotely because of the COVID-19 pandemic.\",\n \"languageCode\":\"en\"\n }\n ]\n}\n"
WorkRequestSummary:
description: A summary of the status of a work request.
properties:
compartmentId:
description: 'The [OCID](/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
'
type: string
id:
description: Unique identifier work request OCID of work request that is immutable on creation
type: string
operationType:
description: Type of the work request.
enum:
- CREATE_MODEL
- UPDATE_MODEL
- DELETE_MODEL
- CREATE_PROJECT
- UPDATE_PROJECT
- DELETE_PROJECT
- CREATE_ENDPOINT
- UPDATE_ENDPOINT
- DELETE_ENDPOINT
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
maximum: 100
minimum: 0
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: Status of current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- WAITING
- SUCCEEDED
- CANCELING
- CANCELED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
section 14.29.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- percentComplete
- timeAccepted
KeyPhraseDocumentResult:
description: The document response for keyPhrases detect call.
properties:
key:
description: Document unique identifier defined by the user.
type: string
keyPhrases:
description: List of detected keyPhrases.
items:
$ref: '#/components/schemas/KeyPhrase'
type: array
languageCode:
description: "Language code supported\n- auto : Automatically detect language\n- ar : Arabic\n- pt-BR : Brazilian Portuguese \n- cs : Czech\n- da : Danish\n- nl : Dutch\n- en : English\n- fi : Finnish\n- fr : French\n- fr-CA : Canadian French \n- de : German\n- it : Italian\n- ja : Japanese\n- ko : Korean\n- no : Norwegian\n- pl : Polish\n- ro : Romanian\n- zh-CN : Simplified Chinese\n- es : Spanish\n- sv : Swedish\n- zh-TW : Traditional Chinese\n- tr : Turkish\n- el : Greek\n- he : Hebrew\n"
maxLength: 5
type: string
required:
- key
- keyPhrases
- languageCode
type: object
ErrorDetails:
description: Error Information.
properties:
code:
description: A short error code that defines the error, meant for programmatic parsing.
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
KeyPhrase:
description: Key phrase for the given text.
properties:
score:
description: 'Score or confidence of the key phrase.
Example: `0.9999856066867399`
'
format: double
maximum: 1.0
minimum: 0.0
type: number
text:
description: Key phrase exreacted from given text.
type: string
required:
- text
- score
type: object
DocumentError:
description: Error response for document.
properties:
error:
$ref: '#/components/schemas/ErrorDetails'
key:
description: Document unique identifier defined by the user.
maxLength: 255
minLength: 1
type: string
required:
- key
- error
type: object
ModelTypeInfo:
description: Model information like versions and capabilities
properties:
capabilities:
additionalProperties:
$ref: '#/components/schemas/Capabilities'
description: Model information capabilities related to version
type: object
versions:
description: Model versions available for this model type
items:
maxLength: 1024
minLength: 1
type: string
maxItems: 500
minItems: 1
type: array
required:
- capabilities
type: object
ProjectCollection:
description: Results of a Project List. Contains ProjectSummary items.
properties:
items:
description: List of projects
items:
$ref: '#/components/schemas/ProjectSummary'
type: array
required:
- items
type: object
Capabilities:
description: Capabilities supported
properties:
capability:
additionalProperties:
$ref: '#/components/schemas/Capability'
description: Model information capabilities related to version
type: object
type: object
MetaInfo:
description: MetaInfo of entity detected.
properties:
length:
description: Length of entity text.
type: integer
offset:
description: The number of Unicode code points preceding this entity in the submitted text.
type: integer
score:
description: Score or confidence for detected entity.
format: double
maximum: 1.0
minimum: 0.0
type: number
subType:
description: Sub-type of entity text like GPE for LOCATION type.
type: string
text:
description: Entity text like name of person, location, and so on.
type: string
type: object
DatasetDetails:
description: Possible data set type
discriminator:
propertyName: datasetType
properties:
datasetType:
description: Possible data sets
enum:
- OBJECT_STORAGE
- DATA_SCIENCE_LABELING
maxLength: 25
minLength: 1
type: string
required:
- datasetType
type: object
WorkRequestLogCollection:
description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
properties:
items:
description: List of workRequestLogEntries.
items:
$ref: '#/components/schemas/WorkRequestLog'
type: array
required:
- items
type: object
DetectLanguageSentimentsResult:
description: Result of sentiments detect call.
properties:
aspects:
description: List of detected aspects.
items:
$ref: '#/components/schemas/SentimentAspect'
type: array
required:
- aspects
type: object
x-example: "{\n \"aspects\": [\n {\n \"offset\": 23,\n \"length\": 8,\n \"text\": \"services\",\n \"sentiment\": \"Positive\",\n \"scores\": {\n \"Positive\": 0.9997686743736267,\n \"Negative\": 0.00023133518698159605,\n \"Neutral\": 0\n }\n }\n ]\n}\n"
BatchDetectLanguagePiiEntitiesDetails:
description: The documents details to detect personal identification information and protected health information.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
maxLength: 255
minLength: 1
type: string
documents:
description: List of documents to detect personal identification information.
items:
$ref: '#/components/schemas/TextDocument'
type: array
endpointId:
description: 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.
maxLength: 255
minLength: 1
type: string
masking:
additionalProperties:
$ref: '#/components/schemas/PiiEntityMasking'
description: Mask recognized PII entities with different modes.
type: object
profile:
$ref: '#/components/schemas/Profile'
required:
- documents
type: object
DetectLanguageKeyPhrasesResult:
description: Result of a language keyPhrases detect call.
properties:
keyPhrases:
description: List of detected keyPhrases.
items:
$ref: '#/components/schemas/KeyPhrase'
type: array
required:
- keyPhrases
type: object
x-example: "{\n \"keyPhrases\":[\n {\n \"text\":\"key Phrase 1\",\n \"score\":0.98765654\n }\n ]\n}\n"
Entity:
description: entity object
properties:
isPii:
description: This flag is to indicate if it is PII entity or not.
type: boolean
length:
description: Length of entity text
type: integer
offset:
description: The number of Unicode code points preceding this entity in the submitted text.
type: integer
score:
description: 'Score or confidence of extracted entity type.
Example: `0.9999856066867399`
'
format: double
maximum: 1.0
minimum: 0.0
type: number
text:
description: Entity text like name of person, location, and so on.
type: string
type:
description: Type of entity text like PER, LOC, GPE and NOPE.
type: string
type: object
DetectLanguageEntitiesDetails:
description: The document details for entities detect call.
properties:
text:
description: Document text for detect entities.
maxLength: 1000
minLength: 1
type: string
required:
- text
type: object
x-example: "{\n \"text\": \"If an emerging growth company, indicate by check mark if the registrant has elected not to use the extended transition period for complying\"\n}\n"
BatchDetectLanguageEntitiesDetails:
description: The documents details for entities detect call.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
maxLength: 255
minLength: 1
type: string
documents:
description: List of Documents for detect entities.
items:
$ref: '#/components/schemas/TextDocument'
type: array
endpointId:
description: 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.
maxLength: 255
minLength: 1
type: string
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"doc1\",\n \"text\":\"Zoom interface is really simple and easy to conduct virtual meetings. It is very easy to share the Zoom link to join the video conference.\",\n \"languageCode\":\"en\"\n },\n {\n \"key\":\"doc2\",\n \"text\":\"In 2020 people worldwide moved to working remotely because of the COVID-19 pandemic.\",\n \"languageCode\":\"en\"\n }\n ]\n}\n"
BatchLanguageTranslationResult:
description: Result of translation call.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/TranslationDocumentResult'
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"translatedText\":\"Une bonne gestion des déchets est essentielle à la santé de tous les systèmes de vie. Nos bénéficiaires comprennent les Wecyclers, une entreprise sociale à Lagos, au Nigéria, qui incite le recyclage des déchets dans les quartiers urbains densément peuplés, et le Centre WEEE à Nairobi, au Kenya, qui encourage la sensibilisation du public aux risques environnementaux et sanitaires des déchets électroniques et éduque le public sur la réutilisation, le recyclage et l'élimination sûre. Oracle est également l'un des sponsors fondateurs de l'événement California Coastal Cleanup Day, qui a supprimé des centaines de milliers de livres de déchets de cours d'eau californiens chaque année depuis 1995.\",\n \"sourceLanguageCode\":\"en\",\n \"targetLanguageCode\":\"fr\"\n }\n ],\n \"errors\":[\n\n ]\n}\n"
ProjectSummary:
description: Summary of the project.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the project's compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the project.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Unique identifier OCID of a project
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The state of the project.
type: string
x-obmcs-enumref: '#/definitions/Project/lifecycleState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
timeCreated:
description: The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
example: 2019-08-25 21:10:29.410000+00:00
format: date-time
type: string
timeUpdated:
description: The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
example: 2019-08-25 21:10:29.410000+00:00
format: date-time
type: string
required:
- id
- compartmentId
- timeCreated
- lifecycleState
- displayName
type: object
AssertionDetails:
description: The assertion details for health ner.
properties:
id:
description: id of the relation
maxLength: 255
minLength: 1
type: string
score:
description: Score or confidence for health detected entity.
format: double
maximum: 1.0
minimum: 0.0
type: number
type:
description: type of assertion ex, Status, Certainty, Temporality, Actor, etc.
maxLength: 255
minLength: 1
type: string
value:
description: Possible value for assertion type
maxLength: 255
minLength: 1
type: string
required:
- id
- type
- value
- score
type: object
BatchDetectLanguageKeyPhrasesResult:
description: Result of keyPhrases detect call.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/KeyPhraseDocumentResult'
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"1\",\n \"keyPhrases\":[\n {\n \"text\":\"key Phrase 1\",\n \"score\":0.98765654\n }\n ]\n }\n ],\n \"errors\":[\n\n ]\n}\n"
DetectLanguageEntitiesResult:
description: Result of entities detect call.
properties:
entities:
description: List of detected entities.
items:
$ref: '#/components/schemas/Entity'
type: array
required:
- entities
type: object
x-example: "{\n \"entities\":[\n {\n \"offset\":0,\n \"length\":4,\n \"text\":\"John\",\n \"type\":\"PERSON\"\n \"score\":0.6942308391868572\n }\n ]\n}\n"
ObjectPrefixOutputLocation:
description: Object storage output location to write inference results
properties:
bucketName:
description: Object Storage bucket name.
maxLength: 256
minLength: 1
type: string
namespaceName:
description: Object Storage namespace name.
maxLength: 1024
minLength: 1
type: string
prefix:
description: The prefix (directory) in an Object Storage bucket.
maxLength: 1024
minLength: 0
type: string
required:
- namespaceName
- bucketName
type: object
UpdateJobDetails:
description: The information to be updated.
properties:
description:
description: A short description of the job.
maxLength: 255
minLength: 1
type: string
displayName:
description: A user-friendly display name for the job.
maxLength: 255
minLength: 1
type: string
type: object
ResolvedEntity:
description: Resolved entity.
properties:
id:
description: id of the resolved entity in input
type: string
length:
description: length of resolved entity in input
type: integer
offset:
description: offset of resolved entity in input
type: integer
text:
description: Entity text like name of person, location, and so on.
type: string
type:
description: Type of entity text like PER, LOC.
type: string
value:
additionalProperties:
type: string
description: 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.
type: object
required:
- id
- offset
- length
- text
- type
- value
type: object
HealthEntity:
description: Health entity object
properties:
assertions:
description: list of all assertions associated with this entity.
items:
$ref: '#/components/schemas/AssertionDetails'
type: array
category:
description: Entity category e.g, MEDICAL_CONDITION, MEDICATION, GENERAL, ANATOMY
type: string
id:
description: Unique id of the entity
type: string
length:
description: Length of entity text
type: integer
matchedConcepts:
description: This contains the list of matched concepts which are ranked by the relevant score with the input text
items:
$ref: '#/components/schemas/MelConcept'
type: array
offset:
description: The number of Unicode code points preceding this entity in the submitted text.
type: integer
score:
description: Score or confidence for detected entity.
format: double
maximum: 1.0
minimum: 0.0
type: number
subType:
description: Sub-type of entity text like GPE for LOCATION type
type: string
text:
description: Entity text like name of person, location, and so on.
type: string
type:
description: Type of entity text like PER, LOC.
type: string
required:
- id
- offset
- length
- text
- type
- score
type: object
TranslationDocumentResult:
description: The document response for translation call.
properties:
key:
description: Document unique identifier defined by the user.
type: string
sourceLanguageCode:
description: '[List of supported languages](/language/using/translate-text.htm)
'
maxLength: 5
type: string
targetLanguageCode:
description: '[List of supported languages](/language/using/translate-text.htm)
'
maxLength: 5
type: string
translatedText:
description: Translated text in selected target language.
type: string
required:
- key
- translatedText
- sourceLanguageCode
- targetLanguageCode
type: object
BatchDetectDominantLanguageResult:
description: Result of language detect call.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/DominantLanguageDocumentResult'
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"doc1\",\n \"languages\":[\n {\n \"code\":\"en\",\n \"name\":\"English\",\n \"score\":0.9999427012000235\n }\n ]\n },\n {\n \"key\":\"doc2\",\n \"languages\":[\n {\n \"code\":\"en\",\n \"name\":\"English\",\n \"score\":0.9998800392452564\n }\n ]\n }\n ],\n \"errors\":[\n\n ]\n}\n"
HierarchicalEntity:
description: Hierarchical entity object
properties:
length:
description: Length of entity text
type: integer
metaInfo:
$ref: '#/components/schemas/MetaInfo'
offset:
description: The number of Unicode code points preceding this entity in the submitted text.
type: integer
score:
description: Score or confidence for detected entity.
format: double
maximum: 1.0
minimum: 0.0
type: number
subType:
description: Sub-type of entity text like GPE for LOCATION type
type: string
text:
description: Entity text like name of person, location, and so on.
type: string
type:
description: Type of entity text like PER, LOC.
type: string
type: object
ModelMetadataDetails:
description: '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
'
properties:
configuration:
additionalProperties:
$ref: '#/components/schemas/ConfigurationDetails'
description: 'model configuration details
For PII : < ENTITY_TYPE , ConfigurationDetails>
ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true }
For language translation : { "targetLanguageCodes" : ConfigurationDetails}
'
type: object
endpointId:
description: Unique identifier endpoint OCID that should be used for inference
maxLength: 255
minLength: 1
type: string
languageCode:
description: '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
'
maxLength: 5
type: string
modelId:
description: Unique identifier model OCID that should be used for inference
maxLength: 255
minLength: 1
type: string
modelType:
description: 'model type to used for inference allowed values are
- PRE_TRAINED_NAMED_ENTITY_RECOGNITION
- PRE_TRAINED_TEXT_CLASSIFICATION
- PRE_TRAINED_SENTIMENT_ANALYSIS
- PRE_TRAINED_KEYPHRASE_EXTRACTION
- PRE_TRAINED_LANGUAGE_DETECTION
- PRE_TRAINED_PII
- PRE_TRAINED_TRANSLATION
- TEXT_CLASSIFICATION
- NAMED_ENTITY_RECOGNITION
'
maxLength: 255
minLength: 1
type: string
type: object
EndpointCollection:
description: Results of an endpoint list. Contains EndpointSummary items.
properties:
items:
description: List of endpoints
items:
$ref: '#/components/schemas/EndpointSummary'
type: array
required:
- items
type: object
WorkRequest:
description: Details of a work request
properties:
compartmentId:
description: 'The [OCID](/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
'
type: string
id:
description: Unique identifier work request OCID of work request that is immutable on creation
type: string
operationType:
description: Type of the work request.
enum:
- CREATE_MODEL
- UPDATE_MODEL
- DELETE_MODEL
- CREATE_PROJECT
- UPDATE_PROJECT
- DELETE_PROJECT
- CREATE_ENDPOINT
- UPDATE_ENDPOINT
- DELETE_ENDPOINT
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
maximum: 100
minimum: 0
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: Status of current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- WAITING
- SUCCEEDED
- CANCELING
- CANCELED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
section 14.29.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- percentComplete
- timeAccepted
JobCollection:
description: list of Jobs created in the compartment and/or after applying filters based on filters provided by user
properties:
items:
description: List of jobs.
items:
$ref: '#/components/schemas/JobSummary'
type: array
required:
- items
type: object
InputConfiguration:
description: 'input documents configuration
by default TXT files will be processed and this behaviour will not change in future after adding new types
'
properties:
configuration:
additionalProperties:
$ref: '#/components/schemas/DocumentsConfiguration'
description: "meta data about documents\n For CSV valid JSON format is {\"CSV\" :{inputColumn: \"reviewDetails\", rowId: \"reviewId\", copyColumnsToOutput: [\"reviewId\" \"userId\"] , delimiter: \",\"}\nNote: In future if new file types added we will update here in documentation about input file meta data\n"
type: object
documentTypes:
description: 'Type of documents supported
for this release only TXT,CSV and one element is allowed here.
for future scope this is marked as list
'
items:
type: string
minItems: 1
type: array
type: object
BatchDetectLanguageEntitiesResult:
description: Result of entities detect call.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/EntityDocumentResult'
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
x-example: "{\n \"documents\": [\n {\n \"key\": \"doc1\",\n \"entities\": [\n {\n \"offset\": 0,\n \"length\": 4,\n \"text\": \"Zoom\",\n \"type\": \"PRODUCT\",\n \"subType\": null,\n \"score\": 0.7535847425460815\n },\n {\n \"offset\": 121,\n \"length\": 16,\n \"text\": \"video conference\",\n \"type\": \"EVENT\",\n \"subType\": null,\n \"score\": 0.9675780832767487\n }\n ],\n \"languageCode\": \"en\"\n },\n {\n \"key\": \"doc2\",\n \"entities\": [\n {\n \"offset\": 3,\n \"length\": 4,\n \"text\": \"2020\",\n \"type\": \"DATETIME\",\n \"subType\": \"DATE\",\n \"score\": 1.0\n },\n {\n \"offset\": 66,\n \"length\": 17,\n \"text\": \"COVID-19 pandemic\",\n \"type\": \"EVENT\",\n \"subType\": null,\n \"score\": 1.0\n }\n ],\n \"languageCode\": \"en\"\n }\n ],\n \"errors\": []\n}\n"
BatchLanguageTranslationDetails:
description: The documents details for translation call.
properties:
alias:
description: Unique name to identify an endpoint to be used for inferencing
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
maxLength: 255
minLength: 1
type: string
documents:
description: List of documents for translation.
items:
$ref: '#/components/schemas/TextDocument'
type: array
endpointId:
description: The endpoint that has to be used for inferencing.
maxLength: 255
minLength: 1
type: string
targetLanguageCode:
description: '[List of supported languages](/iaas/language/using/translate-text.htm)
'
maxLength: 5
type: string
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"1\",\n \"text\":\"Proper waste management is essential to the health of all living systems. Our grantees include Wecyclers, a social enterprise in Lagos, Nigeria, that incentives waste recycling in densely populated urban neighbourhoods, and the WEEE Centre in Nairobi, Kenya, which promotes public awareness of the environmental and health hazards of e-waste and educates the public about reuse, recycling, and safe disposal. Oracle is also a founding sponsor of California Coastal Cleanup Day, which has removed hundreds of thousands of pounds of trash from California waterways each year since 1995.\",\n \"languageCode\":\"en\"\n }\n ]\n}\n"
DetectLanguageKeyPhrasesDetails:
description: The document details for a keyPhrases detect call.
properties:
text:
description: Document text for detect keyPhrases.
type: string
required:
- text
type: object
x-example: "{\n \"text\": \"If an emerging growth company, indicate by check mark if the registrant has elected not to use the extended transition period for complying\"\n}\n"
BatchDetectLanguageSentimentsResult:
description: Result of sentiments detect call.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/SentimentDocumentResult'
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"doc1\",\n \"documentSentiment\":\"positive\",\n \"documentScores\":{\n \"negative\":0.26855493,\n \"positive\":0.5751328,\n \"mixed\":0.09402271,\n \"neutral\":0.062289584\n },\n \"sentences\":[\n {\n \"text\":\"Zoom interface is really simple and easy to conduct virtual meetings.\",\n \"sentiment\":\"positive\",\n \"scores\":{\n \"negative\":0.23868282,\n \"mixed\":0.09472137,\n \"neutral\":0.06964111,\n \"positive\":0.5969547\n }\n },\n {\n \"text\":\"It is very easy to share the Zoom link to join the video conference.\",\n \"sentiment\":\"positive\",\n \"scores\":{\n \"neutral\":0.05493805,\n \"mixed\":0.09332405,\n \"positive\":0.5533109,\n \"negative\":0.29842702\n }\n }\n ],\n \"aspects\":[\n {\n \"offset\":0,\n \"length\":14,\n \"text\":\"Zoom interface\",\n \"sentiment\":\"Positive\",\n \"scores\":{\n \"Positive\":0.9999999995248146,\n \"Negative\":2.817161593827863E-10,\n \"Neutral\":0.0,\n \"Mixed\":1.934692218890011E-10\n }\n },\n {\n \"offset\":89,\n \"length\":5,\n \"text\":\"share\",\n \"sentiment\":\"Positive\",\n \"scores\":{\n \"Positive\":0.999999993683772,\n \"Negative\":6.183472706922923E-9,\n \"Neutral\":1.327550304715308E-10,\n \"Mixed\":0.0\n }\n },\n {\n \"offset\":99,\n \"length\":9,\n \"text\":\"Zoom link\",\n \"sentiment\":\"Positive\",\n \"scores\":{\n \"Positive\":0.9999999308450377,\n \"Negative\":6.643560728745649E-8,\n \"Neutral\":2.719355103288736E-9,\n \"Mixed\":0.0\n }\n }\n ],\n \"languageCode\":\"en\"\n },\n {\n \"key\":\"doc2\",\n \"documentSentiment\":\"negative\",\n \"documentScores\":{\n \"negative\":0.6570408,\n \"neutral\":0.043848336,\n \"positive\":0.24361026,\n \"mixed\":0.055500623\n },\n \"sentences\":[\n {\n \"text\":\"In 2020 people worldwide moved to working remotely because of the COVID-19 pandemic.\",\n \"sentiment\":\"negative\",\n \"scores\":{\n \"neutral\":0.043848336,\n \"mixed\":0.055500623,\n \"positive\":0.24361026,\n \"negative\":0.6570408\n }\n }\n ],\n \"aspects\":[\n\n ],\n \"languageCode\":\"en\"\n }\n ],\n \"errors\":[\n\n ]\n}\n"
EndpointSummary:
description: Summary of the language endpoint.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the Endpoint compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the endpoint.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
maxLength: 255
minLength: 1
type: string
inferenceUnits:
description: Number of replicas required for this endpoint. This will be optional parameter. Default will be 1.
maximum: 10
minimum: 1
type: integer
x-default-description: Number of replicas required for this endpoint
lifecycleDetails:
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.
maxLength: 400
minLength: 1
type: string
lifecycleState:
description: The state of the endpoint.
type: string
x-obmcs-enumref: '#/definitions/Endpoint/lifecycleState'
modelId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
maxLength: 255
minLength: 1
type: string
projectId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the endpoint.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
timeCreated:
description: The time the the endpoint was created. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- id
- compartmentId
- projectId
- modelId
- timeCreated
- lifecycleState
- displayName
type: object
Endpoint:
description: Details of a model endpoint.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the endpoint compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the endpoint.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
maxLength: 255
minLength: 1
type: string
inferenceUnits:
description: Number of replicas required for this endpoint.
maximum: 10
minimum: 1
type: integer
lifecycleDetails:
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.
maxLength: 400
minLength: 1
type: string
lifecycleState:
description: The state of the endpoint.
enum:
- DELETING
- DELETED
- FAILED
- CREATING
- ACTIVE
- UPDATING
maxLength: 25
minLength: 1
type: string
modelId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
maxLength: 255
minLength: 1
type: string
projectId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the Endpoint.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
timeCreated:
description: The time the the endpoint was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the endpoint was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- id
- compartmentId
- projectId
- modelId
- timeCreated
- lifecycleState
- displayName
type: object
DocumentsConfiguration:
description: 'Input documents configuration
'
properties:
config:
additionalProperties:
type: string
description: "meta data about documents\n For CSV valid JSON format is {\"CSV\" :{inputColumn: \"reviewDetails\", rowId: \"reviewId\", copyColumnsToOutput: [\"reviewId\" \"userId\"] , delimiter: \",\"}\nNote: In future if new file types added we will update here in documentation about input file meta data\n"
type: object
type: object
BatchDetectHealthEntityDetails:
description: The documents details for health entities detect call.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
documents:
description: List of Documents for detect health entities.
items:
$ref: '#/components/schemas/TextDocument'
maxItems: 100
type: array
endpointId:
description: The endpoint which have to be used for inferencing.
maxLength: 255
minLength: 1
type: string
isDetectAssertions:
default: false
description: is assertion on input text required. default value true.
type: boolean
isDetectRelationships:
default: false
description: is relationship on input text required. default value true.
type: boolean
linkOntologies:
description: List of NLP health ontologies to be linked
items:
maxLength: 1024
minLength: 1
type: string
maxItems: 100
minItems: 1
type: array
profile:
$ref: '#/components/schemas/Profile'
required:
- documents
- endpointId
type: object
CreateModelDetails:
description: The information needed to train a new model
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the models compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the a model.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
modelDetails:
$ref: '#/components/schemas/ModelDetails'
projectId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project to associate with the model.
maxLength: 255
minLength: 1
type: string
testStrategy:
$ref: '#/components/schemas/TestStrategy'
trainingDataset:
$ref: '#/components/schemas/DatasetDetails'
required:
- compartmentId
- projectId
- modelDetails
type: object
DetectLanguageTextClassificationDetails:
description: The document details for text classification detect call.
properties:
text:
description: Document text for detect text classes.
type: string
required:
- text
type: object
x-example: "{\n \"text\": \"If an emerging growth company, indicate by check mark if the registrant has elected not to use the extended transition period for complying\"\n}\n"
ChangeEndpointCompartmentDetails:
description: Details for changing the compartment of an Endpoint.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
Capability:
description: Capability supported
properties:
details:
description: values
items:
maxLength: 1024
minLength: 1
type: string
maxItems: 1000
minItems: 1
type: array
type: object
WorkRequestResource:
description: A resource created or operated on by a work request.
properties:
actionType:
description: '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.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
type: string
x-obmcs-top-level-enum: '#/definitions/ActionType'
entityType:
description: The resource type the work request affects.
type: string
entityUri:
description: The URI path that the user can do a GET on to access the resource metadata
type: string
identifier:
description: The identifier of the resource the work request affects.
type: string
required:
- actionType
- entityType
- identifier
UpdateModelDetails:
description: The information to be updated.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the a model.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type: object
UpdateEndpointDetails:
description: The information to be updated.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the endpoint.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
inferenceUnits:
description: Number of replicas required for this endpoint. This will be optional parameter.
maximum: 10
minimum: 1
type: integer
modelId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model to associate with the endpoint.
maxLength: 255
minLength: 1
type: string
type: object
Profile:
description: Documents profile
properties:
documentType:
description: Document type EHR Or Utterance
maxLength: 255
minLength: 1
type: string
domain:
description: For PHI API this field can be PII/PHI/ALL and by default PII will be used. For other APIs Healthcare or Financial etc.
maxLength: 255
minLength: 1
type: string
speciality:
description: Document speciality like paediatrics, internal medicine etc.
maxLength: 255
minLength: 1
type: string
type: object
x-obmcs-cli-param: profile-name
WorkRequestLog:
description: A log message from the execution of a work request.
properties:
message:
description: Human-readable log message.
type: string
timestamp:
description: The time the log message was written. An RFC3339 formatted datetime string
format: date-time
type: string
required:
- message
- timestamp
DetectLanguageTextClassificationResult:
description: Result of text classification detect call.
properties:
textClassification:
description: List of detected text classes.
items:
$ref: '#/components/schemas/TextClassification'
type: array
required:
- textClassification
type: object
x-example: "{\n \"textClassification\":[\n {\n \"label\":\"Education Distance Learning\",\n \"score\":0.2522229675877731\n }\n ]\n}\n"
BatchDetectLanguageKeyPhrasesDetails:
description: The documents details for keyPhrases call.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
maxLength: 255
minLength: 1
type: string
documents:
description: List of Documents for detect keyPhrases.
items:
$ref: '#/components/schemas/TextDocument'
type: array
endpointId:
description: 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.
maxLength: 255
minLength: 1
type: string
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"1\",\n \"text\":\"If an emerging growth company, indicate by check mark if the registrant has elected not to use the extended transition period for complying.\",\n \"languageCode\":\"en\"\n }\n ]\n}\n"
SentimentAspect:
description: Sentiment aspect object.
properties:
length:
description: Length of aspect text.
type: integer
offset:
description: The number of Unicode code points preceding this entity in the submitted text.
type: integer
scores:
additionalProperties:
format: double
type: number
description: 'Scores or confidences for each sentiment.
Example: `{"positive": 1.0, "negative": 0.0}`
'
type: object
sentiment:
description: The highest-score sentiment for the aspect text.
type: string
text:
description: Aspect text.
type: string
type: object
WorkRequestError:
description: An error encountered while executing a work request.
properties:
code:
description: 'A machine-usable code for the error that occured. Error codes are listed on
(https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
'
type: string
message:
description: A human readable description of the issue encountered.
type: string
timestamp:
description: The time the error occured. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- code
- message
- timestamp
CreateProjectDetails:
description: 'Parameters needed to create a new project. Projects enable users to organise their language work.
'
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the project's compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of the project.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
required:
- compartmentId
type: object
ModelDetails:
description: Possible model types
discriminator:
propertyName: modelType
properties:
languageCode:
description: supported language default value is en
maxLength: 2
minLength: 1
type: string
modelType:
description: Model type
enum:
- NAMED_ENTITY_RECOGNITION
- TEXT_CLASSIFICATION
- PRE_TRAINED_NAMED_ENTITY_RECOGNITION
- PRE_TRAINED_TEXT_CLASSIFICATION
- PRE_TRAINED_SENTIMENT_ANALYSIS
- PRE_TRAINED_KEYPHRASE_EXTRACTION
- PRE_TRAINED_LANGUAGE_DETECTION
- PRE_TRAINED_PII
- PRE_TRAINED_TRANSLATION
maxLength: 25
minLength: 1
type: string
required:
- modelType
type: object
EntityDocumentResult:
description: The document response for entities detect call.
properties:
entities:
description: List of detected entities.
items:
$ref: '#/components/schemas/HierarchicalEntity'
type: array
key:
description: Document unique identifier defined by the user.
type: string
languageCode:
description: "Language code supported\n- auto : Automatically detect language\n- ar : Arabic\n- pt-BR : Brazilian Portuguese \n- cs : Czech\n- da : Danish\n- nl : Dutch\n- en : English\n- fi : Finnish\n- fr : French\n- fr-CA : Canadian French \n- de : German\n- it : Italian\n- ja : Japanese\n- ko : Korean\n- no : Norwegian\n- pl : Polish\n- ro : Romanian\n- zh-CN : Simplified Chinese\n- es : Spanish\n- sv : Swedish\n- zh-TW : Traditional Chinese\n- tr : Turkish\n- el : Greek\n- he : Hebrew\n"
maxLength: 5
type: string
required:
- key
- entities
- languageCode
type: object
BatchDetectDominantLanguageDetails:
description: The documents details for language detect call.
properties:
alias:
description: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
maxLength: 255
minLength: 1
type: string
charsToConsider:
description: '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.
'
type: integer
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that calls the API, inference will be served from pre trained model
maxLength: 255
minLength: 1
type: string
documents:
description: List of Documents for detect language.
items:
$ref: '#/components/schemas/DominantLanguageDocument'
type: array
endpointId:
description: 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.
maxLength: 255
minLength: 1
type: string
shouldIgnoreTransliteration:
default: false
description: 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.
type: boolean
required:
- documents
type: object
x-example: "{\n \"documents\":[\n {\n \"key\":\"doc1\",\n \"text\":\"Zoom interface is really simple and easy to conduct virtual meetings. It is very easy to share the Zoom link to join the video conference.\"\n },\n {\n \"key\":\"doc2\",\n \"text\":\"In 2020 people worldwide moved to working remotely because of the COVID-19 pandemic.\"\n }\n ]\n}\n"
EvaluationResults:
description: model training results of different models
discriminator:
propertyName: modelType
properties:
modelType:
description: Model type
type: string
x-obmcs-enumref: '#/definitions/ModelDetails/modelType'
required:
- modelType
type: object
BatchDetectHealthEntityResult:
description: Result of health entity detect call.
properties:
documents:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/HealthEntityDocumentResult'
maxItems: 100
type: array
errors:
description: List of failed document response.
items:
$ref: '#/components/schemas/DocumentError'
type: array
required:
- documents
type: object
RelationEntity:
description: The relation entities details for health ner.
properties:
id:
description: id of the relation
maxLength: 255
minLength: 1
type: string
objectId:
description: Object entity of the relation. eg, MEDICINE_DOSAGE, MEDICINE_DURATION, MEASUREMENT
maxLength: 255
minLength: 1
type: string
score:
description: Score or confidence for detected entity.
format: double
maximum: 1.0
minimum: 0.0
type: number
subjectId:
description: Subject entity of the relation. eg,MEDICINE_NAME, EXAMINATION
maxLength: 255
minLength: 1
type: string
type:
description: Type of relation between subject entity and object entity. eg,EXAMINATION_MEASUREMENT, FREQUENCY, DOSAGE
maxLength: 255
minLength: 1
type: string
required:
- id
- subjectId
- objectId
- type
- score
type: object
TextClassificationDocumentResult:
description: The document response for test classification detect call.
properties:
key:
description: Document unique identifier defined by the user.
type: string
languageCode:
description: "Language code supported\n- auto : Automatically detect language\n- ar : Arabic\n- pt-BR : Brazilian Portuguese \n- cs : Czech\n- da : Danish\n- nl : Dutch\n- en : English\n- fi : Finnish\n- fr : French\n- fr-CA : Canadian French \n- de : German\n- it : Italian\n- ja : Japanese\n- ko : Korean\n- no : Norwegian\n- pl : Polish\n- ro : Romanian\n- zh-CN : Simplified Chinese\n- es : Spanish\n- sv : Swedish\n- zh-TW : Traditional Chinese\n- tr : Turkish\n- el : Greek\n- he : Hebrew\n"
maxLength: 5
type: string
textClassification:
description: List of detected text classes.
items:
$ref: '#/components/schemas/TextClassification'
type: array
required:
- key
- textClassification
- languageCode
type: object
Project:
description: Details of a project.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) for the project's compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A short description of a project.
maxLength: 400
minLength: 1
type: string
displayName:
description: A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: Unique identifier OCID of the project
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The state of the project.
enum:
- DELETING
- DELETED
- FAILED
- CREATING
- ACTIVE
- UPDATING
maxLength: 25
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
timeCreated:
description: The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
example: 2019-08-25 21:10:29.410000+00:00
format: date-time
type: string
timeUpdated:
description: The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
example: 2019-08-25 21:10:29.410000+00:00
format: date-time
type: string
required:
- id
- compartmentId
- timeCreated
- lifecycleState
- displayName
type: object
CreateJobDetails:
description: Job creation detail which will have documents on which language services need to run prediction along with output folder
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
maxLength: 255
minLength: 1
type: string
description:
description: A short description of the job.
maxLength: 255
type: string
displayName:
description: A user-friendly display name for the job.
maxLength: 255
type: string
inputConfiguration:
$ref: '#/components/schemas/InputConfiguration'
inputLocation:
$ref: '#/components/schemas/InputLocation'
modelMetadataDetails:
description: '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
'
items:
$ref: '#/components/schemas/ModelMetadataDetails'
maxItems: 50
minItems: 1
type: array
outputLocation:
$ref: '#/components/schemas/ObjectPrefixOutputLocation'
required:
- compartmentId
- inputLocation
- modelMetadataDetails
- outputLocation
type: object
Job:
description: 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
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.
type: string
completedDocuments:
description: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
createdBy:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.
type: string
description:
description: A short description of the job.
type: string
displayName:
description: A user-friendly display name for the job.
type: string
failedDocuments:
description: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job.
type: string
inputConfiguration:
$ref: '#/components/schemas/InputConfiguration'
inputLocation:
$ref: '#/components/schemas/InputLocation'
lifecycleDetails:
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.
type: string
lifecycleState:
description: The current state of the Job.
enum:
- ACCEPTED
- IN_PROGRESS
- SUCCEEDED
- FAILED
- CANCELING
- CANCELED
- DELETING
- DELETED
type: string
modelMetadataDetails:
description: '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
'
items:
$ref: '#/components/schemas/ModelMetadataDetails'
maxItems: 50
minItems: 1
type: array
outputLocation:
$ref: '#/components/schemas/ObjectPrefixOutputLocation'
pendingDocuments:
description: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
percentComplete:
description: How much progress the operation has made, vs the total amount of work that must be performed.
maximum: 100
minimum: 0
type: integer
timeAccepted:
description: Job accepted time.
format: date-time
type: string
timeCompleted:
description: Job finished time.
format: date-time
type: string
timeStarted:
description: Job started time.
format: date-time
type: string
totalDocuments:
description: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
type: integer
ttlInDays:
description: Time to live duration in days for Job. Job will be available till max 90 days.
type: integer
warningsCount:
description: warnings count
type: integer
required:
- id
- compartmentId
- inputLocation
- modelMetadataDetails
- outputLocation
type: object
HealthEntityDocumentResult:
description: The document response for health entity detect call.
properties:
entities:
description: List of detected entities.
items:
$ref: '#/components/schemas/HealthEntity'
type: array
key:
description: Document unique identifier defined by the user.
type: string
languageCode:
description: Language code of the document. Please refer to respective model [API documentation](/iaas/language/using/overview.htm) for supported languages.
maxLength: 5
type: string
relations:
description: List of succeeded document response.
items:
$ref: '#/components/schemas/RelationEntity'
type: array
resolvedEntities:
additionalProperties:
$ref: '#/components/schemas/ResolvedEntities'
description: Map of resolved entities by entity type
type: object
required:
- key
- entities
- languageCode
- resolvedEntities
type: object
DetectedLanguage:
description: Attributes to the detected language. Contains Language Name , Code, and Confidence Score.
properties:
code:
description: '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`.
'
type: string
name:
description: 'Full language name.
Example: `English, Hindi, and so on`
'
type: string
score:
description: 'Score or confidence of detected language code.
Example: `0.9999856066867399`
'
format: double
maximum: 1.0
minimum: 0.0
type: number
required:
- name
- code
- score
type: object
DominantLanguageDocumentResult:
description: The document response for language detect call.
properties:
key:
description: Document unique identifier defined by the user.
type: string
languages:
description: 'List of detected languages with results sorted in descending order of the scores. Most likely language is on top.
'
items:
$ref: '#/components/schemas/DetectedLanguage'
type: array
required:
- key
- languages
type: object
SentimentDocumentResult:
description: The document response for sentiment detect call.
properties:
aspects:
description: List of detected aspects sentiment.
items:
$ref: '#/components/schemas/SentimentAspect'
type: array
documentScores:
additionalProperties:
format: double
type: number
description: 'Scores for each sentiment.
Example: {"positive": 1.0, "negative": 0.0}
'
type: object
documentSentiment:
description: Document level sentiment.
type: string
key:
description: Document unique identifier defined by the user.
type: string
languageCode:
description: "Language code supported\n- auto : Automatically detect language\n- ar : Arabic\n- pt-BR : Brazilian Portuguese \n- cs : Czech\n- da : Danish\n- nl : Dutch\n- en : English\n- fi : Finnish\n- fr : French\n- fr-CA : Canadian French \n- de : German\n- it : Italian\n- ja : Japanese\n- ko : Korean\n- no : Norwegian\n- pl : Polish\n- ro : Romanian\n- zh-CN : Simplified Chinese\n- es : Spanish\n- sv : Swedish\n- zh-TW : Traditional Chinese\n- tr : Turkish\n- el : Greek\n- he : Hebrew\n"
maxLength: 5
type: string
sentences:
description: List of detected sentences sentiment.
items:
$ref: '#/components/schemas/SentimentSentence'
type: array
required:
- key
- aspects
- languageCode
type: object
PiiEntity:
description: PII entity object.
properties:
id:
description: Unique id of the entity.
maxLength: 255
minLength: 1
type: string
length:
description: Length of PII entity text.
type: integer
offset:
description: The number of Unicode code points preceding this entity in the submitted text.
type: integer
score:
description: Score or confidence for detected PII entity.
format: double
maximum: 1.0
minimum: 0.0
type: number
text:
description: Entity text like name of person, Organization and so on.
type: string
type:
description: '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
required:
- offset
- length
- text
- type
- score
type: object
WorkRequestErrorCollection:
description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
properties:
items:
description: List of workRequestError objects.
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
ChangeModelCompartmentDetails:
description: Details for changing the compartment of an Model.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
MelConcept:
description: The MEL concepts details for health ner.
properties:
concepts:
description: This contains the list of matched concepts which are ranked by the relevant score with the input text
items:
$ref: '#/components/schemas/MelConceptDetails'
type: array
ontologyName:
description: Name of the ontology to which the Entity is mapped
maxLength: 255
minLength: 1
type: string
required:
- ontologyName
- concepts
type: object
EvaluationResultSummary:
description: model evaluation analysis of different models
discriminator:
propertyName: modelType
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
modelType:
description: Model type
type: string
x-obmcs-enumref: '#/definitions/ModelDetails/modelType'
required:
- modelType
type: object
TextClassification:
description: Text label and score for the given text.
properties:
label:
description: Label of the the given text.
type: string
score:
description: 'Score or confidence of extracted text label.
Example: `0.9999856066867399`
'
format: double
maximum: 1.0
minimum: 0.0
type: number
required:
- label
- score
type: object
TextDocument:
description: The document details for language service call.
properties:
key:
description: Document unique identifier defined by the user.
maxLength: 255
minLength: 1
type: string
languageCode:
description: Language code of the document. Please refer to respective model [API documentation](/iaas/language/using/overview.htm) for supported languages.
maxLength: 5
type: string
text:
description: Document text for language service call.
maxLength: 20000
minLength: 1
type: string
required:
- key
- text
type: object
x-example: "{\n \"key\":\"doc1\",\n \"text\":\"Zoom interface is really simple and easy to conduct virtual meetings. It is very easy to share the Zoom link to join the video conference.\",\n \"languageCode\":\"en\"\n}\n"
ConfigurationDetails:
description: 'training model details
'
properties:
configurationMap:
additionalProperties:
type: string
description: "model configuration details\nFor PII : ConfigurationDetails will be PiiEntityMasking can be anyone of the following\nex.{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"&\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true }\n { \"mode\" : \"MASK\",\"replaceWith\" : \"&\" }\n { \"mode\" : \"REPLACE\" }\nFor language translation : { \"languageCodes\" : [\"cs\", \"ar\"]}\nLanguage code supported\n- Automatically detect language - auto\n- Arabic - ar\n- Brazilian Portuguese - pt-BR\n- Czech - cs\n- Danish - da\n- Dutch - nl\n- English - en\n- Finnish - fi\n- French - fr\n- Canadian French - fr-CA\n- German - de\n- Italian - it\n- Japanese - ja\n- Korean - ko\n- Norwegian - no\n- Polish - pl\n- Romanian - ro\n- Simplified Chinese - zh-CN\n- Spanish - es\n- Swedish - sv\n- Traditional Chinese - zh-TW\n- Turkish - tr\n- Greek - el\n- Hebrew - he\n"
type: object
type: object
responses:
default:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
location:
description: 'The URI that identifies the entity described in the response body.
'
type: string
opc-next-page:
description: '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.
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
type: string
ref-sunset:
description: 'This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT
'
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
format: float
type: number
x-headers: null
x-httpStatuses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
x-properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
x-oracle-package: com.oracle.pic.ocas