Oracle AI Service Language API

API operations for language(NLP)

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-aiservicelanguage-api-openapi.yml Raw ↑
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 Endpoint

# --- truncated at 32 KB (226 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-aiservicelanguage-api-openapi.yml