FileSyncIngestionLogs¶

class oci.generative_ai.models.FileSyncIngestionLogs(**kwargs)¶

Bases: object

A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector

Attributes

`STATUS_CANCELLED`	A constant which can be used with the status property of a FileSyncIngestionLogs.
`STATUS_COMPLETED`	A constant which can be used with the status property of a FileSyncIngestionLogs.
`STATUS_FAILED`	A constant which can be used with the status property of a FileSyncIngestionLogs.
`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a FileSyncIngestionLogs.
`STATUS_QUEUED`	A constant which can be used with the status property of a FileSyncIngestionLogs.
`defined_tags`	Gets the defined_tags of this FileSyncIngestionLogs.
`duration_in_seconds`	Gets the duration_in_seconds of this FileSyncIngestionLogs.
`file_id`	[Required] Gets the file_id of this FileSyncIngestionLogs.
`file_path`	[Required] Gets the file_path of this FileSyncIngestionLogs.
`file_size_in_bytes`	Gets the file_size_in_bytes of this FileSyncIngestionLogs.
`freeform_tags`	Gets the freeform_tags of this FileSyncIngestionLogs.
`status`	[Required] Gets the status of this FileSyncIngestionLogs.
`system_tags`	Gets the system_tags of this FileSyncIngestionLogs.
`total_chunks_created`	Gets the total_chunks_created of this FileSyncIngestionLogs.

Methods

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

STATUS_CANCELLED = 'CANCELLED'¶: A constant which can be used with the status property of a FileSyncIngestionLogs. This constant has a value of “CANCELLED”

STATUS_COMPLETED = 'COMPLETED'¶: A constant which can be used with the status property of a FileSyncIngestionLogs. This constant has a value of “COMPLETED”

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a FileSyncIngestionLogs. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a FileSyncIngestionLogs. This constant has a value of “IN_PROGRESS”

STATUS_QUEUED = 'QUEUED'¶: A constant which can be used with the status property of a FileSyncIngestionLogs. This constant has a value of “QUEUED”

__init__(**kwargs)¶

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

Parameters:

file_id (str) – The value to assign to the file_id property of this FileSyncIngestionLogs.
file_path (str) – The value to assign to the file_path property of this FileSyncIngestionLogs.
file_size_in_bytes (int) – The value to assign to the file_size_in_bytes property of this FileSyncIngestionLogs.
total_chunks_created (int) – The value to assign to the total_chunks_created property of this FileSyncIngestionLogs.
duration_in_seconds (int) – The value to assign to the duration_in_seconds property of this FileSyncIngestionLogs.
status (str) – The value to assign to the status property of this FileSyncIngestionLogs. Allowed values for this property are: “COMPLETED”, “CANCELLED”, “FAILED”, “QUEUED”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this FileSyncIngestionLogs.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this FileSyncIngestionLogs.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this FileSyncIngestionLogs.

defined_tags¶

Gets the defined_tags of this FileSyncIngestionLogs. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

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

duration_in_seconds¶

Gets the duration_in_seconds of this FileSyncIngestionLogs. The duration taken(in seconds) to ingest the File.

Returns:	The duration_in_seconds of this FileSyncIngestionLogs.
Return type:	int

file_id¶

[Required] Gets the file_id of this FileSyncIngestionLogs. An identifier that identifies a File ingested to a VectorStore.

Returns:	The file_id of this FileSyncIngestionLogs.
Return type:	str

file_path¶

[Required] Gets the file_path of this FileSyncIngestionLogs. The path where the file was located in the datasource.

Returns:	The file_path of this FileSyncIngestionLogs.
Return type:	str

file_size_in_bytes¶

Gets the file_size_in_bytes of this FileSyncIngestionLogs. The size of the file.

Returns:	The file_size_in_bytes of this FileSyncIngestionLogs.
Return type:	int

freeform_tags¶

Gets the freeform_tags of this FileSyncIngestionLogs. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

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

status¶

[Required] Gets the status of this FileSyncIngestionLogs. The current status of ingestion for the File

Allowed values for this property are: “COMPLETED”, “CANCELLED”, “FAILED”, “QUEUED”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this FileSyncIngestionLogs.
Return type:	str

system_tags¶

Gets the system_tags of this FileSyncIngestionLogs. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

total_chunks_created¶

Gets the total_chunks_created of this FileSyncIngestionLogs. The total number of chunks created from the File.

Returns:	The total_chunks_created of this FileSyncIngestionLogs.
Return type:	int