DigitalAssistant

class oci.oda.models.DigitalAssistant(**kwargs)

Bases: object

Digital Assistant metadata.

Attributes:

LIFECYCLE_DETAILS_DRAFT

A constant which can be used with the lifecycle_details property of a DigitalAssistant.

LIFECYCLE_DETAILS_PUBLISHED

A constant which can be used with the lifecycle_details property of a DigitalAssistant.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DigitalAssistant.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DigitalAssistant.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DigitalAssistant.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DigitalAssistant.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DigitalAssistant.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DigitalAssistant.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DigitalAssistant.

MULTILINGUAL_MODE_NATIVE

A constant which can be used with the multilingual_mode property of a DigitalAssistant.

MULTILINGUAL_MODE_TRANSLATION

A constant which can be used with the multilingual_mode property of a DigitalAssistant.

base_id

Gets the base_id of this DigitalAssistant.

category

Gets the category of this DigitalAssistant.

defined_tags

Gets the defined_tags of this DigitalAssistant.

description

Gets the description of this DigitalAssistant.

dialog_version

Gets the dialog_version of this DigitalAssistant.

display_name

[Required] Gets the display_name of this DigitalAssistant.

freeform_tags

Gets the freeform_tags of this DigitalAssistant.

id

[Required] Gets the id of this DigitalAssistant.

lifecycle_details

[Required] Gets the lifecycle_details of this DigitalAssistant.

lifecycle_state

[Required] Gets the lifecycle_state of this DigitalAssistant.

multilingual_mode

Gets the multilingual_mode of this DigitalAssistant.

name

[Required] Gets the name of this DigitalAssistant.

namespace

Gets the namespace of this DigitalAssistant.

native_language_tags

Gets the native_language_tags of this DigitalAssistant.

platform_version

[Required] Gets the platform_version of this DigitalAssistant.

primary_language_tag

Gets the primary_language_tag of this DigitalAssistant.

time_created

[Required] Gets the time_created of this DigitalAssistant.

time_updated

[Required] Gets the time_updated of this DigitalAssistant.

version

[Required] Gets the version of this DigitalAssistant.

Methods:

__init__(**kwargs)

Initializes a new DigitalAssistant object with values from keyword arguments.

LIFECYCLE_DETAILS_DRAFT = 'DRAFT'

A constant which can be used with the lifecycle_details property of a DigitalAssistant. This constant has a value of “DRAFT”

LIFECYCLE_DETAILS_PUBLISHED = 'PUBLISHED'

A constant which can be used with the lifecycle_details property of a DigitalAssistant. This constant has a value of “PUBLISHED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DigitalAssistant. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DigitalAssistant. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DigitalAssistant. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DigitalAssistant. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DigitalAssistant. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a DigitalAssistant. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a DigitalAssistant. This constant has a value of “UPDATING”

MULTILINGUAL_MODE_NATIVE = 'NATIVE'

A constant which can be used with the multilingual_mode property of a DigitalAssistant. This constant has a value of “NATIVE”

MULTILINGUAL_MODE_TRANSLATION = 'TRANSLATION'

A constant which can be used with the multilingual_mode property of a DigitalAssistant. This constant has a value of “TRANSLATION”

__init__(**kwargs)

Initializes a new DigitalAssistant object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this DigitalAssistant.

  • name (str) – The value to assign to the name property of this DigitalAssistant.

  • version (str) – The value to assign to the version property of this DigitalAssistant.

  • display_name (str) – The value to assign to the display_name property of this DigitalAssistant.

  • category (str) – The value to assign to the category property of this DigitalAssistant.

  • description (str) – The value to assign to the description property of this DigitalAssistant.

  • namespace (str) – The value to assign to the namespace property of this DigitalAssistant.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DigitalAssistant. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this DigitalAssistant. Allowed values for this property are: “PUBLISHED”, “DRAFT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • platform_version (str) – The value to assign to the platform_version property of this DigitalAssistant.

  • dialog_version (str) – The value to assign to the dialog_version property of this DigitalAssistant.

  • base_id (str) – The value to assign to the base_id property of this DigitalAssistant.

  • multilingual_mode (str) – The value to assign to the multilingual_mode property of this DigitalAssistant. Allowed values for this property are: “NATIVE”, “TRANSLATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • primary_language_tag (str) – The value to assign to the primary_language_tag property of this DigitalAssistant.

  • native_language_tags (list[str]) – The value to assign to the native_language_tags property of this DigitalAssistant.

  • time_created (datetime) – The value to assign to the time_created property of this DigitalAssistant.

  • time_updated (datetime) – The value to assign to the time_updated property of this DigitalAssistant.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DigitalAssistant.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DigitalAssistant.

property base_id

Gets the base_id of this DigitalAssistant. The unique identifier for the base reource (when this resource extends another).

Returns

The base_id of this DigitalAssistant.

Return type

str

property category

Gets the category of this DigitalAssistant. The resource’s category. This is used to group resource’s together.

Returns

The category of this DigitalAssistant.

Return type

str

property defined_tags

Gets the defined_tags of this DigitalAssistant. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this DigitalAssistant.

Return type

dict(str, dict(str, object))

property description

Gets the description of this DigitalAssistant. A short description of the resource.

Returns

The description of this DigitalAssistant.

Return type

str

property dialog_version

Gets the dialog_version of this DigitalAssistant. The resource’s dialog version.

Returns

The dialog_version of this DigitalAssistant.

Return type

str

property display_name

[Required] Gets the display_name of this DigitalAssistant. The resource’s display name.

Returns

The display_name of this DigitalAssistant.

Return type

str

property freeform_tags

Gets the freeform_tags of this DigitalAssistant. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this DigitalAssistant.

Return type

dict(str, str)

property id

[Required] Gets the id of this DigitalAssistant. Unique immutable identifier that was assigned when the resource was created.

Returns

The id of this DigitalAssistant.

Return type

str

property lifecycle_details

[Required] Gets the lifecycle_details of this DigitalAssistant. The resource’s publish state.

Allowed values for this property are: “PUBLISHED”, “DRAFT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_details of this DigitalAssistant.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DigitalAssistant. The resource’s current state.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this DigitalAssistant.

Return type

str

property multilingual_mode

Gets the multilingual_mode of this DigitalAssistant. The multilingual mode for the resource.

Allowed values for this property are: “NATIVE”, “TRANSLATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The multilingual_mode of this DigitalAssistant.

Return type

str

property name

[Required] Gets the name of this DigitalAssistant. The reource’s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

Returns

The name of this DigitalAssistant.

Return type

str

property namespace

Gets the namespace of this DigitalAssistant. The resource’s namespace.

Returns

The namespace of this DigitalAssistant.

Return type

str

property native_language_tags

Gets the native_language_tags of this DigitalAssistant. A list of native languages supported by this resource.

Returns

The native_language_tags of this DigitalAssistant.

Return type

list[str]

property platform_version

[Required] Gets the platform_version of this DigitalAssistant. The ODA Platform Version for this resource.

Returns

The platform_version of this DigitalAssistant.

Return type

str

property primary_language_tag

Gets the primary_language_tag of this DigitalAssistant. The primary language for the resource.

Returns

The primary_language_tag of this DigitalAssistant.

Return type

str

property time_created

[Required] Gets the time_created of this DigitalAssistant. When the resource was created. A date-time string as described in RFC 3339, section 14.29.

Returns

The time_created of this DigitalAssistant.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this DigitalAssistant. When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Returns

The time_updated of this DigitalAssistant.

Return type

datetime

property version

[Required] Gets the version of this DigitalAssistant. The resource’s version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.

Returns

The version of this DigitalAssistant.

Return type

str