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
`bulk_create_skill_entities`(oda_instance_id, …)	Bulk create composite and value list entities into a skill.
`cascading_delete_skill_custom_entities`(…)	Cascading delete of the custom entities in a skill.
`change_oda_private_endpoint_compartment`(…)	Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment.
`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_oda_private_endpoint`(…)	Starts an asynchronous job to create an ODA Private Endpoint.
`create_oda_private_endpoint_attachment`(…)	Starts an asynchronous job to create an ODA Private Endpoint Attachment.
`create_oda_private_endpoint_scan_proxy`(…)	Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy.
`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_oda_private_endpoint`(…)	Starts an asynchronous job to delete the specified ODA Private Endpoint.
`delete_oda_private_endpoint_attachment`(…)	Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment.
`delete_oda_private_endpoint_scan_proxy`(…)	Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy.
`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_oda_private_endpoint`(…)	Gets the specified ODA Private Endpoint.
`get_oda_private_endpoint_attachment`(…)	Gets the specified ODA Private Endpoint Attachment.
`get_oda_private_endpoint_scan_proxy`(…)	Gets the specified ODA Private Endpoint Scan Proxy.
`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_oda_private_endpoint_attachments`(…)	Returns a page of ODA Instances attached to this ODA Private Endpoint.
`list_oda_private_endpoint_scan_proxies`(…)	Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint.
`list_oda_private_endpoints`(compartment_id, …)	Returns a page of ODA Private Endpoints that belong to the specified compartment.
`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.
`train_skill`(oda_instance_id, skill_id, …)	Train a skill.
`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_oda_private_endpoint`(…)	Starts an asynchronous job to update the specified ODA Private Endpoint 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.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
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.

bulk_create_skill_entities(oda_instance_id, skill_id, bulk_create_skill_entities_details, **kwargs)¶

Bulk create composite and value list entities into a skill.

Parameters:	oda_instance_id (str) – (required) Unique Digital Assistant instance identifier. skill_id (str) – (required) Unique Skill identifier. bulk_create_skill_entities_details (oci.oda.models.BulkCreateSkillEntitiesDetails) – (required) Property values for bulk creating a list of skill entities. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 bulk_create_skill_entities API.

cascading_delete_skill_custom_entities(oda_instance_id, skill_id, **kwargs)¶

Cascading delete of the custom entities in a 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 cascading_delete_skill_custom_entities API.

change_oda_private_endpoint_compartment(oda_private_endpoint_id, change_oda_private_endpoint_compartment_details, **kwargs)¶

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.

Parameters:	oda_private_endpoint_id (str) – (required) Unique ODA Private Endpoint identifier which is the OCID. change_oda_private_endpoint_compartment_details (oci.oda.models.ChangeOdaPrivateEndpointCompartmentDetails) – (required) The compartment to which the Digital Assistant instance should be moved. 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 change_oda_private_endpoint_compartment API.

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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_oda_private_endpoint(create_oda_private_endpoint_details, **kwargs)¶

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

Parameters:	create_oda_private_endpoint_details (oci.oda.models.CreateOdaPrivateEndpointDetails) – (required) Details for the new ODA Private Endpoint. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `OdaPrivateEndpoint`
Return type:	`Response`
Example:

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

create_oda_private_endpoint_attachment(create_oda_private_endpoint_attachment_details, **kwargs)¶

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

Parameters:	create_oda_private_endpoint_attachment_details (oci.oda.models.CreateOdaPrivateEndpointAttachmentDetails) – (required) Details for the new ODA Private Endpoint Attachment. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `OdaPrivateEndpointAttachment`
Return type:	`Response`
Example:

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

create_oda_private_endpoint_scan_proxy(create_oda_private_endpoint_scan_proxy_details, oda_private_endpoint_id, **kwargs)¶

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

Parameters:	create_oda_private_endpoint_scan_proxy_details (oci.oda.models.CreateOdaPrivateEndpointScanProxyDetails) – (required) Details for the new ODA Private Endpoint Scan Proxy. oda_private_endpoint_id (str) – (required) Unique ODA Private Endpoint identifier which is the OCID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `OdaPrivateEndpointScanProxy`
Return type:	`Response`
Example:

Click here to see an example of how to use create_oda_private_endpoint_scan_proxy 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_oda_private_endpoint(oda_private_endpoint_id, **kwargs)¶

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

Parameters:	oda_private_endpoint_id (str) – (required) Unique ODA Private Endpoint identifier which is the OCID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_oda_private_endpoint API.

delete_oda_private_endpoint_attachment(oda_private_endpoint_attachment_id, **kwargs)¶

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

Parameters:	oda_private_endpoint_attachment_id (str) – (required) The OCID of ODA Private Endpoint Attachment. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_oda_private_endpoint_attachment API.

delete_oda_private_endpoint_scan_proxy(oda_private_endpoint_scan_proxy_id, oda_private_endpoint_id, **kwargs)¶

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

Parameters:	oda_private_endpoint_scan_proxy_id (str) – (required) Unique ODA Private Endpoint Scan Proxy identifier. oda_private_endpoint_id (str) – (required) Unique ODA Private Endpoint identifier which is the OCID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_oda_private_endpoint_scan_proxy 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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. if_none_match (str) – (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 (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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. if_none_match (str) – (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 (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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. if_none_match (str) – (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 (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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. if_none_match (str) – (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 (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_oda_private_endpoint(oda_private_endpoint_id, **kwargs)¶

Gets the specified ODA Private Endpoint.

Parameters:	oda_private_endpoint_id (str) – (required) Unique ODA Private Endpoint identifier which is the OCID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `OdaPrivateEndpoint`
Return type:	`Response`
Example:

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

get_oda_private_endpoint_attachment(oda_private_endpoint_attachment_id, **kwargs)¶

Gets the specified ODA Private Endpoint Attachment.

Parameters:	oda_private_endpoint_attachment_id (str) – (required) The OCID of ODA Private Endpoint Attachment. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `OdaPrivateEndpointAttachment`
Return type:	`Response`
Example:

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

get_oda_private_endpoint_scan_proxy(oda_private_endpoint_scan_proxy_id, oda_private_endpoint_id, **kwargs)¶

Gets the specified ODA Private Endpoint Scan Proxy.

Parameters:	oda_private_endpoint_scan_proxy_id (str) – (required) Unique ODA Private Endpoint Scan Proxy identifier. oda_private_endpoint_id (str) – (required) Unique ODA Private Endpoint identifier which is the OCID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `OdaPrivateEndpointScanProxy`
Return type:	`Response`
Example:

Click here to see an example of how to use get_oda_private_endpoint_scan_proxy 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. if_none_match (str) – (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 (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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. if_none_match (str) – (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 (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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. if_none_match (str) – (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 (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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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.