AI Language Functions

BATCH_DETECT_DOMINANT_LANGUAGE Function

The API returns the detected language and a related confidence score (between 0 and 1). It supports passing a batch of records. List of supported languages. 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.

Syntax

FUNCTION batch_detect_dominant_language (
  batch_detect_dominant_language_details dbms_cloud_oci_ai_language_batch_detect_dominant_language_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_batch_detect_dominant_language_response_t;

Parameters

Parameter	Description
`batch_detect_dominant_language_details`	(required) The details to make a language detection detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BATCH_DETECT_LANGUAGE_ENTITIES Function

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

Syntax

FUNCTION batch_detect_language_entities (
  batch_detect_language_entities_details dbms_cloud_oci_ai_language_batch_detect_language_entities_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_batch_detect_language_entities_response_t;

Parameters

Parameter	Description
`batch_detect_language_entities_details`	(required) The details to make a Entity detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BATCH_DETECT_LANGUAGE_KEY_PHRASES Function

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.

Syntax

FUNCTION batch_detect_language_key_phrases (
  batch_detect_language_key_phrases_details dbms_cloud_oci_ai_language_batch_detect_language_key_phrases_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_batch_detect_language_key_phrases_response_t;

Parameters

Parameter	Description
`batch_detect_language_key_phrases_details`	(required) The details to make keyPhrase detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BATCH_DETECT_LANGUAGE_PII_ENTITIES Function

The API extracts pii entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records. Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

Syntax

FUNCTION batch_detect_language_pii_entities (
  batch_detect_language_pii_entities_details dbms_cloud_oci_ai_language_batch_detect_language_pii_entities_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_batch_detect_language_pii_entities_response_t;

Parameters

Parameter	Description
`batch_detect_language_pii_entities_details`	(required) The details to make a PII entity detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BATCH_DETECT_LANGUAGE_SENTIMENTS Function

The API extracts aspect-based and sentence level sentiment in text records. For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned for each record. Similarly, for sentence-level sentiment analysis, the sentiment is returned at the sentence level. For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed). Learn more about sentiment analysis here. 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.

Syntax

FUNCTION batch_detect_language_sentiments (
  batch_detect_language_sentiments_details dbms_cloud_oci_ai_language_batch_detect_language_sentiments_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  l_level dbms_cloud_oci_ai_language_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_batch_detect_language_sentiments_response_t;

Parameters

Parameter	Description
`batch_detect_language_sentiments_details`	(required) The details to make sentiment detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`l_level`	(optional) Set this parameter for sentence and aspect level sentiment analysis. Allowed values are: - ASPECT - SENTENCE Allowed values are: 'ASPECT', 'SENTENCE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BATCH_DETECT_LANGUAGE_TEXT_CLASSIFICATION Function

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

Syntax

FUNCTION batch_detect_language_text_classification (
  batch_detect_language_text_classification_details dbms_cloud_oci_ai_language_batch_detect_language_text_classification_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_batch_detect_language_text_classification_response_t;

Parameters

Parameter	Description
`batch_detect_language_text_classification_details`	(required) The details to make text classification detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BATCH_LANGUAGE_TRANSLATION Function

Translate text to other language over pre-deployed model. Use state of the art neural machine translation to translate text between more than 15 languages. 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.

Syntax

FUNCTION batch_language_translation (
  batch_language_translation_details dbms_cloud_oci_ai_language_batch_language_translation_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_batch_language_translation_response_t;

Parameters

Parameter	Description
`batch_language_translation_details`	(required) The details to make language translation call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_ENDPOINT_COMPARTMENT Function

Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_endpoint_compartment (
  endpoint_id varchar2,
  change_endpoint_compartment_details dbms_cloud_oci_ai_language_change_endpoint_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_change_endpoint_compartment_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`change_endpoint_compartment_details`	(required)
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MODEL_COMPARTMENT Function

Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_model_compartment (
  model_id varchar2,
  change_model_compartment_details dbms_cloud_oci_ai_language_change_model_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_change_model_compartment_response_t;

Parameters

Parameter	Description
`model_id`	(required) unique model OCID.
`change_model_compartment_details`	(required)
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PROJECT_COMPARTMENT Function

Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_project_compartment (
  project_id varchar2,
  change_project_compartment_details dbms_cloud_oci_ai_language_change_project_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_change_project_compartment_response_t;

Parameters

Parameter	Description
`project_id`	(required) The OCID of the project.
`change_project_compartment_details`	(required)
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ENDPOINT Function

Creates a new endpoint and deploy the trained model

Syntax

FUNCTION create_endpoint (
  create_endpoint_details dbms_cloud_oci_ai_language_create_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_create_endpoint_response_t;

Parameters

Parameter	Description
`create_endpoint_details`	(required) Details for the new endpoint.
`opc_retry_token`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MODEL Function

Creates a new model for training and train the model with date provided.

Syntax

FUNCTION create_model (
  create_model_details dbms_cloud_oci_ai_language_create_model_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_create_model_response_t;

Parameters

Parameter	Description
`create_model_details`	(required) Details for the new model.
`opc_retry_token`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PROJECT Function

Creates a new Project.

Syntax

FUNCTION create_project (
  create_project_details dbms_cloud_oci_ai_language_create_project_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_create_project_response_t;

Parameters

Parameter	Description
`create_project_details`	(required) Details for the new Project.
`opc_retry_token`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ENDPOINT Function

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.

Syntax

FUNCTION delete_endpoint (
  endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_delete_endpoint_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MODEL Function

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.

Syntax

FUNCTION delete_model (
  model_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_delete_model_response_t;

Parameters

Parameter	Description
`model_id`	(required) unique model OCID.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PROJECT Function

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.

Syntax

FUNCTION delete_project (
  project_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_delete_project_response_t;

Parameters

Parameter	Description
`project_id`	(required) The OCID of the project.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DETECT_DOMINANT_LANGUAGE Function

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. Limitations: - A record may be up to 1000 characters long.

Syntax

FUNCTION detect_dominant_language (
  detect_dominant_language_details dbms_cloud_oci_ai_language_detect_dominant_language_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_detect_dominant_language_response_t;

Parameters

Parameter	Description
`detect_dominant_language_details`	(required) The details to make a language detection detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DETECT_LANGUAGE_ENTITIES Function

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.

Syntax

FUNCTION detect_language_entities (
  detect_language_entities_details dbms_cloud_oci_ai_language_detect_language_entities_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  model_version varchar2 DEFAULT NULL,
  is_pii number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_detect_language_entities_response_t;

Parameters

Parameter	Description
`detect_language_entities_details`	(required) The details to make a Entity detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`model_version`	(optional) Named Entity Recognition model versions. By default user will get output from V2.1 implementation. Allowed values are: 'V2_1', 'V1_1'
`is_pii`	(optional) 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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DETECT_LANGUAGE_KEY_PHRASES Function

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.

Syntax

FUNCTION detect_language_key_phrases (
  detect_language_key_phrases_details dbms_cloud_oci_ai_language_detect_language_key_phrases_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_detect_language_key_phrases_response_t;

Parameters

Parameter	Description
`detect_language_key_phrases_details`	(required) The details to make keyPhrase detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DETECT_LANGUAGE_SENTIMENTS Function

This API will be retired on Monday, 10 Oct 2023 00:00:00 GMT The API extracts aspect-based in text records. For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned. For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral). Learn more about sentiment analysis here. Limitations: - A record may be up to 1000 characters long.

Syntax

FUNCTION detect_language_sentiments (
  detect_language_sentiments_details dbms_cloud_oci_ai_language_detect_language_sentiments_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_detect_language_sentiments_response_t;

Parameters

Parameter	Description
`detect_language_sentiments_details`	(required) The details to make sentiment detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DETECT_LANGUAGE_TEXT_CLASSIFICATION Function

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. Limitations: - A record may be up to 1000 characters long.

Syntax

FUNCTION detect_language_text_classification (
  detect_language_text_classification_details dbms_cloud_oci_ai_language_detect_language_text_classification_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_detect_language_text_classification_response_t;

Parameters

Parameter	Description
`detect_language_text_classification_details`	(required) The details to make text classification detect call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ENDPOINT Function

Gets an endpoint by identifier

Syntax

FUNCTION get_endpoint (
  endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_get_endpoint_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL Function

Gets a model by identifier

Syntax

FUNCTION get_model (
  model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_get_model_response_t;

Parameters

Parameter	Description
`model_id`	(required) unique model OCID.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL_TYPE Function

Gets model capabilities

Syntax

FUNCTION get_model_type (
  model_type varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_get_model_type_response_t;

Parameters

Parameter	Description
`model_type`	(required) Results like version and model supported info by specifying model type
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PROJECT Function

Gets a Project by identifier

Syntax

FUNCTION get_project (
  project_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_get_project_response_t;

Parameters

Parameter	Description
`project_id`	(required) The OCID of the project.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the status of the work request with the given ID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ENDPOINTS Function

Returns a list of Endpoints.

Syntax

FUNCTION list_endpoints (
  compartment_id varchar2,
  endpoint_id varchar2 DEFAULT NULL,
  project_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  model_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_list_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`endpoint_id`	(optional) The OCID of the endpoint.
`project_id`	(optional) The ID of the project for which to list the objects.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`model_id`	(optional) The ID of the trained model for which to list the endpoints.
`lifecycle_state`	(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) 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. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EVALUATION_RESULTS Function

Get a (paginated) list of evaluation results for a given model.

Syntax

FUNCTION list_evaluation_results (
  model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_list_evaluation_results_response_t;

Parameters

Parameter	Description
`model_id`	(required) unique model OCID.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODELS Function

Returns a list of models.

Syntax

FUNCTION list_models (
  compartment_id varchar2,
  model_id varchar2 DEFAULT NULL,
  project_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_list_models_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`model_id`	(optional) unique model OCID.
`project_id`	(optional) The ID of the project for which to list the objects.
`lifecycle_state`	(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) 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. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROJECTS Function

Returns a list of Projects.

Syntax

FUNCTION list_projects (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  project_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_list_projects_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`lifecycle_state`	(optional) <b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`project_id`	(optional) The ID of the project for which to list the objects.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) 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. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) 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. Allowed values are: 'timeCreated', 'displayName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Return a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) 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. Allowed values are: 'timeCreated', 'displayName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  work_request_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`work_request_id`	(optional) The ID of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`resource_id`	(optional) The ID of the resource for which list workrequests.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) 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. Allowed values are: 'timeCreated', 'displayName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ENDPOINT Function

Update the Endpoint identified by the id

Syntax

FUNCTION update_endpoint (
  endpoint_id varchar2,
  update_endpoint_details dbms_cloud_oci_ai_language_update_endpoint_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_update_endpoint_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`update_endpoint_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MODEL Function

Updates the model

Syntax

FUNCTION update_model (
  model_id varchar2,
  update_model_details dbms_cloud_oci_ai_language_update_model_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_update_model_response_t;

Parameters

Parameter	Description
`model_id`	(required) unique model OCID.
`update_model_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PROJECT Function

Updates the Project

Syntax

FUNCTION update_project (
  project_id varchar2,
  update_project_details dbms_cloud_oci_ai_language_update_project_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ail_ai_service_language_update_project_response_t;

Parameters

Parameter	Description
`project_id`	(required) The OCID of the project.
`update_project_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://language.aiservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

BATCH_DETECT_DOMINANT_LANGUAGE Function 🔗

BATCH_DETECT_LANGUAGE_ENTITIES Function 🔗

BATCH_DETECT_LANGUAGE_KEY_PHRASES Function 🔗

BATCH_DETECT_LANGUAGE_PII_ENTITIES Function 🔗

BATCH_DETECT_LANGUAGE_SENTIMENTS Function 🔗

BATCH_DETECT_LANGUAGE_TEXT_CLASSIFICATION Function 🔗

BATCH_LANGUAGE_TRANSLATION Function 🔗

CHANGE_ENDPOINT_COMPARTMENT Function 🔗

CHANGE_MODEL_COMPARTMENT Function 🔗

CHANGE_PROJECT_COMPARTMENT Function 🔗

CREATE_ENDPOINT Function 🔗

CREATE_MODEL Function 🔗

CREATE_PROJECT Function 🔗

DELETE_ENDPOINT Function 🔗

DELETE_MODEL Function 🔗

DELETE_PROJECT Function 🔗

DETECT_DOMINANT_LANGUAGE Function 🔗

DETECT_LANGUAGE_ENTITIES Function 🔗

DETECT_LANGUAGE_KEY_PHRASES Function 🔗

DETECT_LANGUAGE_SENTIMENTS Function 🔗

DETECT_LANGUAGE_TEXT_CLASSIFICATION Function 🔗

GET_ENDPOINT Function 🔗

GET_MODEL Function 🔗

GET_MODEL_TYPE Function 🔗

GET_PROJECT Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_ENDPOINTS Function 🔗

LIST_EVALUATION_RESULTS Function 🔗

LIST_MODELS Function 🔗

LIST_PROJECTS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_ENDPOINT Function 🔗

UPDATE_MODEL Function 🔗

UPDATE_PROJECT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

BATCH_DETECT_DOMINANT_LANGUAGE Function

BATCH_DETECT_LANGUAGE_ENTITIES Function

BATCH_DETECT_LANGUAGE_KEY_PHRASES Function

BATCH_DETECT_LANGUAGE_PII_ENTITIES Function

BATCH_DETECT_LANGUAGE_SENTIMENTS Function

BATCH_DETECT_LANGUAGE_TEXT_CLASSIFICATION Function

BATCH_LANGUAGE_TRANSLATION Function

CHANGE_ENDPOINT_COMPARTMENT Function

CHANGE_MODEL_COMPARTMENT Function

CHANGE_PROJECT_COMPARTMENT Function

CREATE_ENDPOINT Function

CREATE_MODEL Function

CREATE_PROJECT Function

DELETE_ENDPOINT Function

DELETE_MODEL Function

DELETE_PROJECT Function

DETECT_DOMINANT_LANGUAGE Function

DETECT_LANGUAGE_ENTITIES Function

DETECT_LANGUAGE_KEY_PHRASES Function

DETECT_LANGUAGE_SENTIMENTS Function

DETECT_LANGUAGE_TEXT_CLASSIFICATION Function

GET_ENDPOINT Function

GET_MODEL Function

GET_MODEL_TYPE Function

GET_PROJECT Function

GET_WORK_REQUEST Function

LIST_ENDPOINTS Function

LIST_EVALUATION_RESULTS Function

LIST_MODELS Function

LIST_PROJECTS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_ENDPOINT Function

UPDATE_MODEL Function

UPDATE_PROJECT Function