ODA Management Functions

Package: DBMS_CLOUD_OCI_ODA_MANAGEMENT

CHANGE_ODA_PRIVATE_ENDPOINT_COMPARTMENT Function

Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_oda_private_endpoint_compartment (
  oda_private_endpoint_id varchar2,
  change_oda_private_endpoint_compartment_details dbms_cloud_oci_oda_change_oda_private_endpoint_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id 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_oda_management_change_oda_private_endpoint_compartment_response_t;

Parameters

Parameter Description

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

change_oda_private_endpoint_compartment_details

(required) The compartment to which the Digital Assistant instance should be moved.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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.

CONFIGURE_DIGITAL_ASSISTANT_PARAMETERS Function

This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.

Syntax

FUNCTION configure_digital_assistant_parameters (
  oda_instance_id varchar2,
  configure_digital_assistant_parameters_details dbms_cloud_oci_oda_configure_digital_assistant_parameters_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_oda_management_configure_digital_assistant_parameters_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

configure_digital_assistant_parameters_details

(required) The parameter values to use.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_AUTHENTICATION_PROVIDER Function

Creates a new Authentication Provider

Syntax

FUNCTION create_authentication_provider (
  oda_instance_id varchar2,
  create_authentication_provider_details dbms_cloud_oci_oda_create_authentication_provider_details_t,
  opc_request_id 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_oda_management_create_authentication_provider_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

create_authentication_provider_details

(required) Property values required to create the new Authentication Provider.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_CHANNEL Function

Creates a new Channel.

Syntax

FUNCTION create_channel (
  oda_instance_id varchar2,
  create_channel_details dbms_cloud_oci_oda_create_channel_details_t,
  opc_request_id 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_oda_management_create_channel_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

create_channel_details

(required) Property values for creating the new Channel.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_DIGITAL_ASSISTANT Function

Creates a new Digital Assistant.

Syntax

FUNCTION create_digital_assistant (
  oda_instance_id varchar2,
  create_digital_assistant_details dbms_cloud_oci_oda_create_digital_assistant_details_t,
  opc_request_id 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_oda_management_create_digital_assistant_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

create_digital_assistant_details

(required) Property values for creating the new Digital Assistant.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT Function

Starts an asynchronous job to create an ODA Private Endpoint. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Syntax

FUNCTION create_oda_private_endpoint (
  create_oda_private_endpoint_details dbms_cloud_oci_oda_create_oda_private_endpoint_details_t,
  opc_request_id 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_oda_management_create_oda_private_endpoint_response_t;

Parameters

Parameter Description

create_oda_private_endpoint_details

(required) Details for the new ODA Private Endpoint.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_ATTACHMENT Function

Starts an asynchronous job to create an ODA Private Endpoint Attachment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Syntax

FUNCTION create_oda_private_endpoint_attachment (
  create_oda_private_endpoint_attachment_details dbms_cloud_oci_oda_create_oda_private_endpoint_attachment_details_t,
  opc_request_id 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_oda_management_create_oda_private_endpoint_attachment_response_t;

Parameters

Parameter Description

create_oda_private_endpoint_attachment_details

(required) Details for the new ODA Private Endpoint Attachment.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_SCAN_PROXY Function

Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Syntax

FUNCTION create_oda_private_endpoint_scan_proxy (
  create_oda_private_endpoint_scan_proxy_details dbms_cloud_oci_oda_create_oda_private_endpoint_scan_proxy_details_t,
  oda_private_endpoint_id varchar2,
  opc_request_id 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_oda_management_create_oda_private_endpoint_scan_proxy_response_t;

Parameters

Parameter Description

create_oda_private_endpoint_scan_proxy_details

(required) Details for the new ODA Private Endpoint Scan Proxy.

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_SKILL Function

Creates a new Skill from scratch.

Syntax

FUNCTION create_skill (
  oda_instance_id varchar2,
  create_skill_details dbms_cloud_oci_oda_create_skill_details_t,
  opc_request_id 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_oda_management_create_skill_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

create_skill_details

(required) Property values for creating the Skill.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_SKILL_PARAMETER Function

Creates a new Skill Parameter.

Syntax

FUNCTION create_skill_parameter (
  oda_instance_id varchar2,
  skill_id varchar2,
  create_skill_parameter_details dbms_cloud_oci_oda_create_skill_parameter_details_t,
  opc_request_id 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_oda_management_create_skill_parameter_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

create_skill_parameter_details

(required) Property values for creating the new Skill Parameter.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_TRANSLATOR Function

Creates a new Translator

Syntax

FUNCTION create_translator (
  oda_instance_id varchar2,
  create_translator_details dbms_cloud_oci_oda_create_translator_details_t,
  opc_request_id 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_oda_management_create_translator_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

create_translator_details

(required) Property values to create the new Translator.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_AUTHENTICATION_PROVIDER Function

Delete the specified Authentication Provider.

Syntax

FUNCTION delete_authentication_provider (
  oda_instance_id varchar2,
  authentication_provider_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_oda_management_delete_authentication_provider_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

authentication_provider_id

(required) Unique Authentication Provider identifier.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_CHANNEL Function

Delete the specified Channel.

Syntax

FUNCTION delete_channel (
  oda_instance_id varchar2,
  channel_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_oda_management_delete_channel_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

channel_id

(required) Unique Channel identifier.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_DIGITAL_ASSISTANT Function

Delete the specified Digital Assistant.

Syntax

FUNCTION delete_digital_assistant (
  oda_instance_id varchar2,
  digital_assistant_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_oda_management_delete_digital_assistant_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT Function

Starts an asynchronous job to delete the specified ODA Private Endpoint. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Syntax

FUNCTION delete_oda_private_endpoint (
  oda_private_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_oda_management_delete_oda_private_endpoint_response_t;

Parameters

Parameter Description

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_ATTACHMENT Function

Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Syntax

FUNCTION delete_oda_private_endpoint_attachment (
  oda_private_endpoint_attachment_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_oda_management_delete_oda_private_endpoint_attachment_response_t;

Parameters

Parameter Description

oda_private_endpoint_attachment_id

(required) The OCID of ODA Private Endpoint Attachment.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_SCAN_PROXY Function

Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

Syntax

FUNCTION delete_oda_private_endpoint_scan_proxy (
  oda_private_endpoint_scan_proxy_id varchar2,
  oda_private_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_oda_management_delete_oda_private_endpoint_scan_proxy_response_t;

Parameters

Parameter Description

oda_private_endpoint_scan_proxy_id

(required) Unique ODA Private Endpoint Scan Proxy identifier.

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILL Function

Delete the specified Skill.

Syntax

FUNCTION delete_skill (
  oda_instance_id varchar2,
  skill_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_oda_management_delete_skill_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILL_PARAMETER Function

Delete the specified Skill Parameter.

Syntax

FUNCTION delete_skill_parameter (
  oda_instance_id varchar2,
  skill_id varchar2,
  parameter_name 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_oda_management_delete_skill_parameter_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

parameter_name

(required) The name of a Skill Parameter.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_TRANSLATOR Function

Delete the specified Translator.

Syntax

FUNCTION delete_translator (
  oda_instance_id varchar2,
  translator_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_oda_management_delete_translator_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

translator_id

(required) Unique Translator identifier.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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.

EXPORT_DIGITAL_ASSISTANT Function

Exports the specified Digital Assistant as an archive to Object Storage.

Syntax

FUNCTION export_digital_assistant (
  oda_instance_id varchar2,
  digital_assistant_id varchar2,
  export_digital_assistant_details dbms_cloud_oci_oda_export_digital_assistant_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_oda_management_export_digital_assistant_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

export_digital_assistant_details

(required) Where in Object Storage to export the Digital Assistant to.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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.

EXPORT_SKILL Function

Exports the specified Skill as an archive to Object Storage.

Syntax

FUNCTION export_skill (
  oda_instance_id varchar2,
  skill_id varchar2,
  export_skill_details dbms_cloud_oci_oda_export_skill_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_oda_management_export_skill_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

export_skill_details

(required) Where in Object Storage to export the Skill to.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_AUTHENTICATION_PROVIDER Function

Gets the specified Authentication Provider.

Syntax

FUNCTION get_authentication_provider (
  oda_instance_id varchar2,
  authentication_provider_id varchar2,
  if_none_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_oda_management_get_authentication_provider_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

authentication_provider_id

(required) Unique Authentication Provider identifier.

if_none_match

(optional) The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_CHANNEL Function

Gets the specified Channel.

Syntax

FUNCTION get_channel (
  oda_instance_id varchar2,
  channel_id varchar2,
  if_none_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_oda_management_get_channel_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

channel_id

(required) Unique Channel identifier.

if_none_match

(optional) The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_DIGITAL_ASSISTANT Function

Gets the specified Digital Assistant.

Syntax

FUNCTION get_digital_assistant (
  oda_instance_id varchar2,
  digital_assistant_id varchar2,
  if_none_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_oda_management_get_digital_assistant_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

if_none_match

(optional) The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_DIGITAL_ASSISTANT_PARAMETER Function

Gets the specified Digital Assistant Parameter.

Syntax

FUNCTION get_digital_assistant_parameter (
  oda_instance_id varchar2,
  digital_assistant_id varchar2,
  parameter_name varchar2,
  if_none_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_oda_management_get_digital_assistant_parameter_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

parameter_name

(required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.

if_none_match

(optional) The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT Function

Gets the specified ODA Private Endpoint.

Syntax

FUNCTION get_oda_private_endpoint (
  oda_private_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_oda_management_get_oda_private_endpoint_response_t;

Parameters

Parameter Description

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_ATTACHMENT Function

Gets the specified ODA Private Endpoint Attachment.

Syntax

FUNCTION get_oda_private_endpoint_attachment (
  oda_private_endpoint_attachment_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_oda_management_get_oda_private_endpoint_attachment_response_t;

Parameters

Parameter Description

oda_private_endpoint_attachment_id

(required) The OCID of ODA Private Endpoint Attachment.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_SCAN_PROXY Function

Gets the specified ODA Private Endpoint Scan Proxy.

Syntax

FUNCTION get_oda_private_endpoint_scan_proxy (
  oda_private_endpoint_scan_proxy_id varchar2,
  oda_private_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_oda_management_get_oda_private_endpoint_scan_proxy_response_t;

Parameters

Parameter Description

oda_private_endpoint_scan_proxy_id

(required) Unique ODA Private Endpoint Scan Proxy identifier.

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILL Function

Gets the specified Skill.

Syntax

FUNCTION get_skill (
  oda_instance_id varchar2,
  skill_id varchar2,
  if_none_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_oda_management_get_skill_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

if_none_match

(optional) The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILL_PARAMETER Function

Gets the specified Skill Parameter.

Syntax

FUNCTION get_skill_parameter (
  oda_instance_id varchar2,
  skill_id varchar2,
  parameter_name varchar2,
  if_none_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_oda_management_get_skill_parameter_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

parameter_name

(required) The name of a Skill Parameter.

if_none_match

(optional) The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_TRANSLATOR Function

Gets the specified Translator.

Syntax

FUNCTION get_translator (
  oda_instance_id varchar2,
  translator_id varchar2,
  if_none_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_oda_management_get_translator_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

translator_id

(required) Unique Translator identifier.

if_none_match

(optional) The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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.

IMPORT_BOT Function

Import a Bot archive from Object Storage.

Syntax

FUNCTION import_bot (
  oda_instance_id varchar2,
  import_bot_details dbms_cloud_oci_oda_import_bot_details_t,
  opc_request_id 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_oda_management_import_bot_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

import_bot_details

(required) Properties for where in Object Storage to import the Bot archive from.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

opc_retry_token

(optional) A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again. Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

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://digitalassistant-api.{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_AUTHENTICATION_PROVIDERS Function

Returns a page of Authentication Providers that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_authentication_providers (
  oda_instance_id varchar2,
  id varchar2 DEFAULT NULL,
  identity_provider varchar2 DEFAULT NULL,
  name 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_oda_management_list_authentication_providers_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

id

(optional) Unique Authentication Provider identifier.

identity_provider

(optional) List only Authentication Providers for this Identity Provider.

Allowed values are: 'GENERIC', 'OAM', 'GOOGLE', 'MICROSOFT'

name

(optional) List only the information for Authentication Providers with this name. Authentication Provider names are unique and may not change. Example: `MyProvider`

lifecycle_state

(optional) List only the resources that are in this lifecycle state.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

Allowed values are: 'timeCreated', 'timeUpdated', 'name', 'identityProvider'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_CHANNELS Function

Returns a page of Channels that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_channels (
  oda_instance_id varchar2,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  category varchar2 DEFAULT NULL,
  l_type 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_oda_management_list_channels_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

id

(optional) Unique Channel identifier.

name

(optional) List only the information for Channels with this name. Channels names are unique and may not change. Example: `MyChannel`

category

(optional) List only Channels with this category.

Allowed values are: 'AGENT', 'APPLICATION', 'BOT', 'BOT_AS_AGENT', 'SYSTEM', 'EVENT'

l_type

(optional) List only Channels of this type.

Allowed values are: 'ANDROID', 'APPEVENT', 'APPLICATION', 'CORTANA', 'FACEBOOK', 'IOS', 'MSTEAMS', 'OSS', 'OSVC', 'SERVICECLOUD', 'SLACK', 'TEST', 'TWILIO', 'WEB', 'WEBHOOK'

lifecycle_state

(optional) List only the resources that are in this lifecycle state.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending, and the default sort order for `name` is ascending.

Allowed values are: 'timeCreated', 'timeUpdated', 'name'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_DIGITAL_ASSISTANT_PARAMETERS Function

Returns a page of Parameters that belong to the specified Digital Assistant. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_digital_assistant_parameters (
  oda_instance_id varchar2,
  digital_assistant_id varchar2,
  name 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_oda_management_list_digital_assistant_parameters_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

name

(optional) List only Parameters with this name.

lifecycle_state

(optional) List only the resources that are in this lifecycle state.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `name`. The default sort order is ascending.

Allowed values are: 'name', 'displayName', 'type'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_DIGITAL_ASSISTANTS Function

Returns a page of Digital Assistants that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_digital_assistants (
  oda_instance_id varchar2,
  id varchar2 DEFAULT NULL,
  category varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  version varchar2 DEFAULT NULL,
  namespace varchar2 DEFAULT NULL,
  platform_version varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  lifecycle_details 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_oda_management_list_digital_assistants_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

id

(optional) Unique Digital Assistant identifier.

category

(optional) List only Bot resources with this category.

name

(optional) List only Bot resources with this name. Names are unique and may not change. Example: `MySkill`

version

(optional) List only Bot resources with this version. Versions are unique and may not change. Example: `1.0`

namespace

(optional) List only Bot resources with this namespace. Namespaces may not change. Example: `MyNamespace`

platform_version

(optional) List only Bot resources with this platform version.

lifecycle_state

(optional) List only the resources that are in this lifecycle state.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) List only Bot resources with this lifecycle details.

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

Allowed values are: 'timeCreated', 'timeUpdated', 'name'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_ATTACHMENTS Function

Returns a page of ODA Instances attached to this ODA Private Endpoint. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_oda_private_endpoint_attachments (
  oda_private_endpoint_id varchar2,
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state 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_oda_management_list_oda_private_endpoint_attachments_response_t;

Parameters

Parameter Description

oda_private_endpoint_id

(required) The OCID of ODA Private Endpoint.

compartment_id

(required) List the ODA Private Endpoint Attachments that belong to this compartment.

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

lifecycle_state

(optional) List only the ODA Private Endpoint Attachments that are in this lifecycle state.

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`. The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.

Allowed values are: 'TIMECREATED', 'DISPLAYNAME'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT_SCAN_PROXIES Function

Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_oda_private_endpoint_scan_proxies (
  oda_private_endpoint_id varchar2,
  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_oda_management_list_oda_private_endpoint_scan_proxies_response_t;

Parameters

Parameter Description

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

lifecycle_state

(optional) List only the ODA Private Endpoint Scan Proxies that are in this lifecycle state.

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`. The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.

Allowed values are: 'TIMECREATED', 'DISPLAYNAME'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINTS Function

Returns a page of ODA Private Endpoints that belong to the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_oda_private_endpoints (
  compartment_id varchar2,
  display_name 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_oda_management_list_oda_private_endpoints_response_t;

Parameters

Parameter Description

compartment_id

(required) List the ODA Private Endpoints that belong to this compartment.

display_name

(optional) List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: `My new resource`

lifecycle_state

(optional) List only the ODA Private Endpoints that are in this lifecycle state.

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`. The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.

Allowed values are: 'TIMECREATED', 'DISPLAYNAME'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILL_PARAMETERS Function

Returns a page of Skill Parameters that belong to the specified Skill. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_skill_parameters (
  oda_instance_id varchar2,
  skill_id varchar2,
  name 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_oda_management_list_skill_parameters_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

name

(optional) List only Parameters with this name.

lifecycle_state

(optional) List only the resources that are in this lifecycle state.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `name`. The default sort order is ascending.

Allowed values are: 'name', 'displayName', 'type'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILLS Function

Returns a page of Skills that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_skills (
  oda_instance_id varchar2,
  id varchar2 DEFAULT NULL,
  category varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  version varchar2 DEFAULT NULL,
  namespace varchar2 DEFAULT NULL,
  platform_version varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  lifecycle_details 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_oda_management_list_skills_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

id

(optional) Unique Skill identifier.

category

(optional) List only Bot resources with this category.

name

(optional) List only Bot resources with this name. Names are unique and may not change. Example: `MySkill`

version

(optional) List only Bot resources with this version. Versions are unique and may not change. Example: `1.0`

namespace

(optional) List only Bot resources with this namespace. Namespaces may not change. Example: `MyNamespace`

platform_version

(optional) List only Bot resources with this platform version.

lifecycle_state

(optional) List only the resources that are in this lifecycle state.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) List only Bot resources with this lifecycle details.

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

Allowed values are: 'timeCreated', 'timeUpdated', 'name'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_TRANSLATORS Function

Returns a page of Translators that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Syntax

FUNCTION list_translators (
  oda_instance_id varchar2,
  id varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  name 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_oda_management_list_translators_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

id

(optional) Unique Translator identifier.

l_type

(optional) List only Translators of this type.

Allowed values are: 'GOOGLE', 'MICROSOFT'

name

(optional) List only Translators with this name. Translator names are unique and may not change. Example: `MyTranslator`

lifecycle_state

(optional) List only the resources that are in this lifecycle state.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'DELETING', 'DELETED', 'FAILED'

limit

(optional) The maximum number of items to return per page.

page

(optional) The page at which to start retrieving results. You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter. Example: `MToxMA==`

sort_order

(optional) Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`. The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

Allowed values are: 'timeCreated', 'timeUpdated', 'name', 'type'

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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.

PUBLISH_DIGITAL_ASSISTANT Function

Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified.

Syntax

FUNCTION publish_digital_assistant (
  oda_instance_id varchar2,
  digital_assistant_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_oda_management_publish_digital_assistant_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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.

PUBLISH_SKILL Function

Publish a draft Skill. Once published it cannot be modified.

Syntax

FUNCTION publish_skill (
  oda_instance_id varchar2,
  skill_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_oda_management_publish_skill_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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.

ROTATE_CHANNEL_KEYS Function

This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again.

Syntax

FUNCTION rotate_channel_keys (
  oda_instance_id varchar2,
  channel_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_management_rotate_channel_keys_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

channel_id

(required) Unique Channel identifier.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

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://digitalassistant-api.{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.

START_CHANNEL Function

Starts a Channel so that it will begin accepting messages.

Syntax

FUNCTION start_channel (
  oda_instance_id varchar2,
  channel_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_management_start_channel_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

channel_id

(required) Unique Channel identifier.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

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://digitalassistant-api.{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.

STOP_CHANNEL Function

Stops a Channel so that it will no longer accept messages.

Syntax

FUNCTION stop_channel (
  oda_instance_id varchar2,
  channel_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_oda_management_stop_channel_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

channel_id

(required) Unique Channel identifier.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

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://digitalassistant-api.{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_AUTHENTICATION_PROVIDER Function

Updates the specified Authentication Provider with the information in the request body.

Syntax

FUNCTION update_authentication_provider (
  oda_instance_id varchar2,
  authentication_provider_id varchar2,
  update_authentication_provider_details dbms_cloud_oci_oda_update_authentication_provider_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_oda_management_update_authentication_provider_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

authentication_provider_id

(required) Unique Authentication Provider identifier.

update_authentication_provider_details

(required) Property values to update the Authentication Provider.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_CHANNEL Function

Updates the specified Channel with the information in the request body.

Syntax

FUNCTION update_channel (
  oda_instance_id varchar2,
  channel_id varchar2,
  update_channel_details dbms_cloud_oci_oda_update_channel_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_oda_management_update_channel_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

channel_id

(required) Unique Channel identifier.

update_channel_details

(required) Property values to update the Channel.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_DIGITAL_ASSISTANT Function

Updates the specified Digital Assistant with the information in the request body.

Syntax

FUNCTION update_digital_assistant (
  oda_instance_id varchar2,
  digital_assistant_id varchar2,
  update_digital_assistant_details dbms_cloud_oci_oda_update_digital_assistant_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_oda_management_update_digital_assistant_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

update_digital_assistant_details

(required) Property values to update the Digital Assistant.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_DIGITAL_ASSISTANT_PARAMETER Function

Updates the specified Digital Assistant Parameter with the information in the request body.

Syntax

FUNCTION update_digital_assistant_parameter (
  oda_instance_id varchar2,
  digital_assistant_id varchar2,
  parameter_name varchar2,
  update_digital_assistant_parameter_details dbms_cloud_oci_oda_update_digital_assistant_parameter_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_oda_management_update_digital_assistant_parameter_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

digital_assistant_id

(required) Unique Digital Assistant identifier.

parameter_name

(required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.

update_digital_assistant_parameter_details

(required) Property values to update the Digital Assistant Parameter.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_ODA_PRIVATE_ENDPOINT Function

Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.

Syntax

FUNCTION update_oda_private_endpoint (
  oda_private_endpoint_id varchar2,
  update_oda_private_endpoint_details dbms_cloud_oci_oda_update_oda_private_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_oda_management_update_oda_private_endpoint_response_t;

Parameters

Parameter Description

oda_private_endpoint_id

(required) Unique ODA Private Endpoint identifier which is the OCID.

update_oda_private_endpoint_details

(required) The information to update.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILL Function

Updates the specified Skill with the information in the request body.

Syntax

FUNCTION update_skill (
  oda_instance_id varchar2,
  skill_id varchar2,
  update_skill_details dbms_cloud_oci_oda_update_skill_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_oda_management_update_skill_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

update_skill_details

(required) Property values to update the Skill.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_SKILL_PARAMETER Function

Updates the specified Skill Parameter with the information in the request body.

Syntax

FUNCTION update_skill_parameter (
  oda_instance_id varchar2,
  skill_id varchar2,
  parameter_name varchar2,
  update_skill_parameter_details dbms_cloud_oci_oda_update_skill_parameter_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_oda_management_update_skill_parameter_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

skill_id

(required) Unique Skill identifier.

parameter_name

(required) The name of a Skill Parameter.

update_skill_parameter_details

(required) Property values to update the Skill Parameter.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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_TRANSLATOR Function

Updates the specified Translator with the information in the request body.

Syntax

FUNCTION update_translator (
  oda_instance_id varchar2,
  translator_id varchar2,
  update_translator_details dbms_cloud_oci_oda_update_translator_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_oda_management_update_translator_response_t;

Parameters

Parameter Description

oda_instance_id

(required) Unique Digital Assistant instance identifier.

translator_id

(required) Unique Translator identifier.

update_translator_details

(required) Property values to update the Translator.

if_match

(optional) For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

opc_request_id

(optional) The client request ID for tracing. This value is included in the opc-request-id response header.

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://digitalassistant-api.{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.

Was this article helpful?