ModelSummary¶

class oci.ai_document.models.ModelSummary(**kwargs)¶

Bases: object

The metadata about the model.

Methods

__init__(**kwargs) Initializes a new ModelSummary object with values from keyword arguments.

Attributes

`alias_name`	Gets the alias_name of this ModelSummary.
`compartment_id`	[Required] Gets the compartment_id of this ModelSummary.
`component_models`	Gets the component_models of this ModelSummary.
`defined_tags`	Gets the defined_tags of this ModelSummary.
`description`	Gets the description of this ModelSummary.
`display_name`	Gets the display_name of this ModelSummary.
`freeform_tags`	Gets the freeform_tags of this ModelSummary.
`id`	[Required] Gets the id of this ModelSummary.
`is_composed_model`	Gets the is_composed_model of this ModelSummary.
`lifecycle_details`	Gets the lifecycle_details of this ModelSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ModelSummary.
`model_type`	[Required] Gets the model_type of this ModelSummary.
`model_version`	[Required] Gets the model_version of this ModelSummary.
`precision`	Gets the precision of this ModelSummary.
`project_id`	[Required] Gets the project_id of this ModelSummary.
`system_tags`	Gets the system_tags of this ModelSummary.
`tenancy_id`	Gets the tenancy_id of this ModelSummary.
`testing_dataset`	Gets the testing_dataset of this ModelSummary.
`time_created`	[Required] Gets the time_created of this ModelSummary.
`time_updated`	Gets the time_updated of this ModelSummary.
`training_dataset`	Gets the training_dataset of this ModelSummary.
`validation_dataset`	Gets the validation_dataset of this ModelSummary.

__init__(**kwargs)¶

Initializes a new ModelSummary 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 ModelSummary.
display_name (str) – The value to assign to the display_name property of this ModelSummary.
description (str) – The value to assign to the description property of this ModelSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ModelSummary.
model_type (str) – The value to assign to the model_type property of this ModelSummary.
model_version (str) – The value to assign to the model_version property of this ModelSummary.
project_id (str) – The value to assign to the project_id property of this ModelSummary.
time_created (datetime) – The value to assign to the time_created property of this ModelSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ModelSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ModelSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ModelSummary.
precision (float) – The value to assign to the precision property of this ModelSummary.
tenancy_id (str) – The value to assign to the tenancy_id property of this ModelSummary.
alias_name (str) – The value to assign to the alias_name property of this ModelSummary.
training_dataset (oci.ai_document.models.Dataset) – The value to assign to the training_dataset property of this ModelSummary.
testing_dataset (oci.ai_document.models.Dataset) – The value to assign to the testing_dataset property of this ModelSummary.
validation_dataset (oci.ai_document.models.Dataset) – The value to assign to the validation_dataset property of this ModelSummary.
component_models (list[oci.ai_document.models.ComponentModel]) – The value to assign to the component_models property of this ModelSummary.
is_composed_model (bool) – The value to assign to the is_composed_model property of this ModelSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ModelSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ModelSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ModelSummary.

alias_name¶

Gets the alias_name of this ModelSummary. the alias name of the model.

Returns:	The alias_name of this ModelSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ModelSummary. The compartment identifier.

Returns:	The compartment_id of this ModelSummary.
Return type:	str

component_models¶

Gets the component_models of this ModelSummary. The OCID list of active custom Key Value models that need to be composed.

Returns:	The component_models of this ModelSummary.
Return type:	list[oci.ai_document.models.ComponentModel]

defined_tags¶

Gets the defined_tags of this ModelSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ModelSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this ModelSummary. An optional description of the model.

Returns:	The description of this ModelSummary.
Return type:	str

display_name¶

Gets the display_name of this ModelSummary. A human-friendly name for the model, which can be changed.

Returns:	The display_name of this ModelSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ModelSummary. A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {“bar-key”: “value”}

Returns:	The freeform_tags of this ModelSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ModelSummary. A unique identifier that is immutable after creation.

Returns:	The id of this ModelSummary.
Return type:	str

is_composed_model¶

Gets the is_composed_model of this ModelSummary. Set to true when the model is created by using multiple key value extraction models.

Returns:	The is_composed_model of this ModelSummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this ModelSummary. A message describing the current state in more detail, that can provide actionable information if training failed.

Returns:	The lifecycle_details of this ModelSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ModelSummary. The current state of the model.

Returns:	The lifecycle_state of this ModelSummary.
Return type:	str

model_type¶

[Required] Gets the model_type of this ModelSummary. The type of the Document model.

Returns:	The model_type of this ModelSummary.
Return type:	str

model_version¶

[Required] Gets the model_version of this ModelSummary. The version of the model.

Returns:	The model_version of this ModelSummary.
Return type:	str

precision¶

Gets the precision of this ModelSummary. The precision of the trained model.

Returns:	The precision of this ModelSummary.
Return type:	float

project_id¶

[Required] Gets the project_id of this ModelSummary. The OCID of the project that contains the model.

Returns:	The project_id of this ModelSummary.
Return type:	str

system_tags¶

Gets the system_tags of this ModelSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ModelSummary.
Return type:	dict(str, dict(str, object))

tenancy_id¶

Gets the tenancy_id of this ModelSummary. The tenancy id of the model.

Returns:	The tenancy_id of this ModelSummary.
Return type:	str

testing_dataset¶

Gets the testing_dataset of this ModelSummary.

Returns:	The testing_dataset of this ModelSummary.
Return type:	oci.ai_document.models.Dataset

time_created¶

[Required] Gets the time_created of this ModelSummary. When the model was created, as an RFC3339 datetime string.

Returns:	The time_created of this ModelSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this ModelSummary. When the model was modified, as an RFC3339 datetime string.

Returns:	The time_updated of this ModelSummary.
Return type:	datetime

training_dataset¶

Gets the training_dataset of this ModelSummary.

Returns:	The training_dataset of this ModelSummary.
Return type:	oci.ai_document.models.Dataset

validation_dataset¶

Gets the validation_dataset of this ModelSummary.

Returns:	The validation_dataset of this ModelSummary.
Return type:	oci.ai_document.models.Dataset