ManagementClient

class oci.oda.ManagementClient(config, **kwargs)

API to create and maintain Oracle Digital Assistant service instances.

Methods

__init__(config, **kwargs) Creates a new service client
configure_digital_assistant_parameters(…) This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.
create_authentication_provider(…) Creates a new Authentication Provider
create_channel(oda_instance_id, …) Creates a new Channel.
create_digital_assistant(oda_instance_id, …) Creates a new Digital Assistant.
create_skill(oda_instance_id, …) Creates a new Skill from scratch.
create_skill_parameter(oda_instance_id, …) Creates a new Skill Parameter.
create_translator(oda_instance_id, …) Creates a new Translator
delete_authentication_provider(…) Delete the specified Authentication Provider.
delete_channel(oda_instance_id, channel_id, …) Delete the specified Channel.
delete_digital_assistant(oda_instance_id, …) Delete the specified Digital Assistant.
delete_skill(oda_instance_id, skill_id, **kwargs) Delete the specified Skill.
delete_skill_parameter(oda_instance_id, …) Delete the specified Skill Parameter.
delete_translator(oda_instance_id, …) Delete the specified Translator.
export_digital_assistant(oda_instance_id, …) Exports the specified Digital Assistant as an archive to Object Storage.
export_skill(oda_instance_id, skill_id, …) Exports the specified Skill as an archive to Object Storage.
get_authentication_provider(oda_instance_id, …) Gets the specified Authentication Provider.
get_channel(oda_instance_id, channel_id, …) Gets the specified Channel.
get_digital_assistant(oda_instance_id, …) Gets the specified Digital Assistant.
get_digital_assistant_parameter(…) Gets the specified Digital Assistant Parameter.
get_skill(oda_instance_id, skill_id, **kwargs) Gets the specified Skill.
get_skill_parameter(oda_instance_id, …) Gets the specified Skill Parameter.
get_translator(oda_instance_id, …) Gets the specified Translator.
import_bot(oda_instance_id, …) Import a Bot archive from Object Storage.
list_authentication_providers(…) Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.
list_channels(oda_instance_id, **kwargs) Returns a page of Channels that belong to the specified Digital Assistant instance.
list_digital_assistant_parameters(…) Returns a page of Parameters that belong to the specified Digital Assistant.
list_digital_assistants(oda_instance_id, …) Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.
list_skill_parameters(oda_instance_id, …) Returns a page of Skill Parameters that belong to the specified Skill.
list_skills(oda_instance_id, **kwargs) Returns a page of Skills that belong to the specified Digital Assistant instance.
list_translators(oda_instance_id, **kwargs) Returns a page of Translators that belong to the specified Digital Assistant instance.
publish_digital_assistant(oda_instance_id, …) Publish a draft Digital Assistant.
publish_skill(oda_instance_id, skill_id, …) Publish a draft Skill.
rotate_channel_keys(oda_instance_id, …) This will generate new keys for any generated keys in the Channel (eg.
start_channel(oda_instance_id, channel_id, …) Starts a Channel so that it will begin accepting messages.
stop_channel(oda_instance_id, channel_id, …) Stops a Channel so that it will no longer accept messages.
update_authentication_provider(…) Updates the specified Authentication Provider with the information in the request body.
update_channel(oda_instance_id, channel_id, …) Updates the specified Channel with the information in the request body.
update_digital_assistant(oda_instance_id, …) Updates the specified Digital Assistant with the information in the request body.
update_digital_assistant_parameter(…) Updates the specified Digital Assistant Parameter with the information in the request body.
update_skill(oda_instance_id, skill_id, …) Updates the specified Skill with the information in the request body.
update_skill_parameter(oda_instance_id, …) Updates the specified Skill Parameter with the information in the request body.
update_translator(oda_instance_id, …) Updates the specified Translator with the information in the request body.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
configure_digital_assistant_parameters(oda_instance_id, configure_digital_assistant_parameters_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • configure_digital_assistant_parameters_details (oci.oda.models.ConfigureDigitalAssistantParametersDetails) – (required) The parameter values to use.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use configure_digital_assistant_parameters API.

create_authentication_provider(oda_instance_id, create_authentication_provider_details, **kwargs)

Creates a new Authentication Provider

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_authentication_provider_details (oci.oda.models.CreateAuthenticationProviderDetails) – (required) Property values required to create the new Authentication Provider.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuthenticationProvider

Return type:

Response

Example:

Click here to see an example of how to use create_authentication_provider API.

create_channel(oda_instance_id, create_channel_details, **kwargs)

Creates a new Channel.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_channel_details (oci.oda.models.CreateChannelDetails) – (required) Property values for creating the new Channel.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CreateChannelResult

Return type:

Response

Example:

Click here to see an example of how to use create_channel API.

create_digital_assistant(oda_instance_id, create_digital_assistant_details, **kwargs)

Creates a new Digital Assistant.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_digital_assistant_details (oci.oda.models.CreateDigitalAssistantDetails) – (required) Property values for creating the new Digital Assistant.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use create_digital_assistant API.

create_skill(oda_instance_id, create_skill_details, **kwargs)

Creates a new Skill from scratch.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_skill_details (oci.oda.models.CreateSkillDetails) – (required) Property values for creating the Skill.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use create_skill API.

create_skill_parameter(oda_instance_id, skill_id, create_skill_parameter_details, **kwargs)

Creates a new Skill Parameter.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • create_skill_parameter_details (oci.oda.models.CreateSkillParameterDetails) – (required) Property values for creating the new Skill Parameter.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SkillParameter

Return type:

Response

Example:

Click here to see an example of how to use create_skill_parameter API.

create_translator(oda_instance_id, create_translator_details, **kwargs)

Creates a new Translator

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_translator_details (oci.oda.models.CreateTranslatorDetails) – (required) Property values to create the new Translator.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Translator

Return type:

Response

Example:

Click here to see an example of how to use create_translator API.

delete_authentication_provider(oda_instance_id, authentication_provider_id, **kwargs)

Delete the specified Authentication Provider.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • authentication_provider_id (str) – (required) Unique Authentication Provider identifier.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_authentication_provider API.

delete_channel(oda_instance_id, channel_id, **kwargs)

Delete the specified Channel.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_channel API.

delete_digital_assistant(oda_instance_id, digital_assistant_id, **kwargs)

Delete the specified Digital Assistant.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_digital_assistant API.

delete_skill(oda_instance_id, skill_id, **kwargs)

Delete the specified Skill.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_skill API.

delete_skill_parameter(oda_instance_id, skill_id, parameter_name, **kwargs)

Delete the specified Skill Parameter.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • parameter_name (str) – (required) The name of a Skill Parameter.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_skill_parameter API.

delete_translator(oda_instance_id, translator_id, **kwargs)

Delete the specified Translator.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • translator_id (str) – (required) Unique Translator identifier.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_translator API.

export_digital_assistant(oda_instance_id, digital_assistant_id, export_digital_assistant_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • export_digital_assistant_details (oci.oda.models.ExportDigitalAssistantDetails) – (required) Where in Object Storage to export the Digital Assistant to.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use export_digital_assistant API.

export_skill(oda_instance_id, skill_id, export_skill_details, **kwargs)

Exports the specified Skill as an archive to Object Storage.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • export_skill_details (oci.oda.models.ExportSkillDetails) – (required) Where in Object Storage to export the Skill to.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use export_skill API.

get_authentication_provider(oda_instance_id, authentication_provider_id, **kwargs)

Gets the specified Authentication Provider.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • authentication_provider_id (str) – (required) Unique Authentication Provider identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuthenticationProvider

Return type:

Response

Example:

Click here to see an example of how to use get_authentication_provider API.

get_channel(oda_instance_id, channel_id, **kwargs)

Gets the specified Channel.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Channel

Return type:

Response

Example:

Click here to see an example of how to use get_channel API.

get_digital_assistant(oda_instance_id, digital_assistant_id, **kwargs)

Gets the specified Digital Assistant.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DigitalAssistant

Return type:

Response

Example:

Click here to see an example of how to use get_digital_assistant API.

get_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, **kwargs)

Gets the specified Digital Assistant Parameter.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • parameter_name (str) – (required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DigitalAssistantParameter

Return type:

Response

Example:

Click here to see an example of how to use get_digital_assistant_parameter API.

get_skill(oda_instance_id, skill_id, **kwargs)

Gets the specified Skill.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Skill

Return type:

Response

Example:

Click here to see an example of how to use get_skill API.

get_skill_parameter(oda_instance_id, skill_id, parameter_name, **kwargs)

Gets the specified Skill Parameter.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • parameter_name (str) – (required) The name of a Skill Parameter.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SkillParameter

Return type:

Response

Example:

Click here to see an example of how to use get_skill_parameter API.

get_translator(oda_instance_id, translator_id, **kwargs)

Gets the specified Translator.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • translator_id (str) – (required) Unique Translator identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Translator

Return type:

Response

Example:

Click here to see an example of how to use get_translator API.

import_bot(oda_instance_id, import_bot_details, **kwargs)

Import a Bot archive from Object Storage.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • import_bot_details (oci.oda.models.ImportBotDetails) – (required) Properties for where in Object Storage to import the Bot archive from.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • opc_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use import_bot API.

list_authentication_providers(oda_instance_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • id (str) – (optional) Unique Authentication Provider identifier.
  • identity_provider (str) –

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

    Allowed values are: “GENERIC”, “OAM”, “GOOGLE”, “MICROSOFT”

  • name (str) –

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

    Example: MyProvider

  • lifecycle_state (str) –

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

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

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) –

    (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 (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuthenticationProviderCollection

Return type:

Response

Example:

Click here to see an example of how to use list_authentication_providers API.

list_channels(oda_instance_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • id (str) – (optional) Unique Channel identifier.
  • name (str) –

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

    Example: MyChannel

  • category (str) –

    (optional) List only Channels with this category.

    Allowed values are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”

  • type (str) –

    (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 (str) –

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

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

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) –

    (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 (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ChannelCollection

Return type:

Response

Example:

Click here to see an example of how to use list_channels API.

list_digital_assistant_parameters(oda_instance_id, digital_assistant_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • name (str) – (optional) List only Parameters with this name.
  • lifecycle_state (str) –

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

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

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) –

    (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 (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DigitalAssistantParameterCollection

Return type:

Response

Example:

Click here to see an example of how to use list_digital_assistant_parameters API.

list_digital_assistants(oda_instance_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (optional) Unique Digital Assistant identifier.
  • category (str) – (optional) List only Bot resources with this category.
  • name (str) –

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

    Example: MySkill

  • version (str) –

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

    Example: 1.0

  • namespace (str) –

    (optional) List only Bot resources with this namespace. Namespaces may not change.

    Example: MyNamespace

  • platform_version (str) – (optional) List only Bot resources with this platform version.
  • lifecycle_state (str) –

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

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

  • lifecycle_details (str) – (optional) List only Bot resources with this lifecycle details.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) –

    (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 (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DigitalAssistantCollection

Return type:

Response

Example:

Click here to see an example of how to use list_digital_assistants API.

list_skill_parameters(oda_instance_id, skill_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • name (str) – (optional) List only Parameters with this name.
  • lifecycle_state (str) –

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

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

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) –

    (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 (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SkillParameterCollection

Return type:

Response

Example:

Click here to see an example of how to use list_skill_parameters API.

list_skills(oda_instance_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (optional) Unique Skill identifier.
  • category (str) – (optional) List only Bot resources with this category.
  • name (str) –

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

    Example: MySkill

  • version (str) –

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

    Example: 1.0

  • namespace (str) –

    (optional) List only Bot resources with this namespace. Namespaces may not change.

    Example: MyNamespace

  • platform_version (str) – (optional) List only Bot resources with this platform version.
  • lifecycle_state (str) –

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

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

  • lifecycle_details (str) – (optional) List only Bot resources with this lifecycle details.
  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) –

    (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 (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SkillCollection

Return type:

Response

Example:

Click here to see an example of how to use list_skills API.

list_translators(oda_instance_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • id (str) – (optional) Unique Translator identifier.
  • type (str) –

    (optional) List only Translators of this type.

    Allowed values are: “GOOGLE”, “MICROSOFT”

  • name (str) –

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

    Example: MyTranslator

  • lifecycle_state (str) –

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

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

  • limit (int) – (optional) The maximum number of items to return per page.
  • page (str) –

    (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 (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type TranslatorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_translators API.

publish_digital_assistant(oda_instance_id, digital_assistant_id, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DigitalAssistant

Return type:

Response

Example:

Click here to see an example of how to use publish_digital_assistant API.

publish_skill(oda_instance_id, skill_id, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Skill

Return type:

Response

Example:

Click here to see an example of how to use publish_skill API.

rotate_channel_keys(oda_instance_id, channel_id, **kwargs)

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.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • if_match (str) – (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_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CreateChannelResult

Return type:

Response

Example:

Click here to see an example of how to use rotate_channel_keys API.

start_channel(oda_instance_id, channel_id, **kwargs)

Starts a Channel so that it will begin accepting messages.

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • if_match (str) – (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_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Channel

Return type:

Response

Example:

Click here to see an example of how to use start_channel API.

stop_channel(oda_instance_id, channel_id, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • opc_request_id (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • if_match (str) – (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_retry_token (str) –

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

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Channel

Return type:

Response

Example:

Click here to see an example of how to use stop_channel API.

update_authentication_provider(oda_instance_id, authentication_provider_id, update_authentication_provider_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • authentication_provider_id (str) – (required) Unique Authentication Provider identifier.
  • update_authentication_provider_details (oci.oda.models.UpdateAuthenticationProviderDetails) – (required) Property values to update the Authentication Provider.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AuthenticationProvider

Return type:

Response

Example:

Click here to see an example of how to use update_authentication_provider API.

update_channel(oda_instance_id, channel_id, update_channel_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • update_channel_details (oci.oda.models.UpdateChannelDetails) – (required) Property values to update the Channel.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Channel

Return type:

Response

Example:

Click here to see an example of how to use update_channel API.

update_digital_assistant(oda_instance_id, digital_assistant_id, update_digital_assistant_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • update_digital_assistant_details (oci.oda.models.UpdateDigitalAssistantDetails) – (required) Property values to update the Digital Assistant.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DigitalAssistant

Return type:

Response

Example:

Click here to see an example of how to use update_digital_assistant API.

update_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, update_digital_assistant_parameter_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • parameter_name (str) – (required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.
  • update_digital_assistant_parameter_details (oci.oda.models.UpdateDigitalAssistantParameterDetails) – (required) Property values to update the Digital Assistant Parameter.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type DigitalAssistantParameter

Return type:

Response

Example:

Click here to see an example of how to use update_digital_assistant_parameter API.

update_skill(oda_instance_id, skill_id, update_skill_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • update_skill_details (oci.oda.models.UpdateSkillDetails) – (required) Property values to update the Skill.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Skill

Return type:

Response

Example:

Click here to see an example of how to use update_skill API.

update_skill_parameter(oda_instance_id, skill_id, parameter_name, update_skill_parameter_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • parameter_name (str) – (required) The name of a Skill Parameter.
  • update_skill_parameter_details (oci.oda.models.UpdateSkillParameterDetails) – (required) Property values to update the Skill Parameter.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type SkillParameter

Return type:

Response

Example:

Click here to see an example of how to use update_skill_parameter API.

update_translator(oda_instance_id, translator_id, update_translator_details, **kwargs)

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • translator_id (str) – (required) Unique Translator identifier.
  • update_translator_details (oci.oda.models.UpdateTranslatorDetails) – (required) Property values to update the Translator.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing. This value is included in the opc-request-id response header.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Translator

Return type:

Response

Example:

Click here to see an example of how to use update_translator API.