Trace¶

class oci.generative_ai_agent_runtime.models.Trace(**kwargs)¶

Bases: object

The trace that displays the internal progression, such as reasoning and actions during an execution.

Attributes

`TRACE_TYPE_ERROR_TRACE`	A constant which can be used with the trace_type property of a Trace.
`TRACE_TYPE_EXECUTION_TRACE`	A constant which can be used with the trace_type property of a Trace.
`TRACE_TYPE_GENERATION_TRACE`	A constant which can be used with the trace_type property of a Trace.
`TRACE_TYPE_PLANNING_TRACE`	A constant which can be used with the trace_type property of a Trace.
`TRACE_TYPE_RETRIEVAL_TRACE`	A constant which can be used with the trace_type property of a Trace.
`TRACE_TYPE_TOOL_INVOCATION_TRACE`	A constant which can be used with the trace_type property of a Trace.
`key`	Gets the key of this Trace.
`parent_key`	Gets the parent_key of this Trace.
`source`	Gets the source of this Trace.
`time_created`	Gets the time_created of this Trace.
`time_finished`	Gets the time_finished of this Trace.
`trace_type`	[Required] Gets the trace_type of this Trace.

Methods

`__init__`(**kwargs)	Initializes a new Trace object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TRACE_TYPE_ERROR_TRACE = 'ERROR_TRACE'¶: A constant which can be used with the trace_type property of a Trace. This constant has a value of “ERROR_TRACE”

TRACE_TYPE_EXECUTION_TRACE = 'EXECUTION_TRACE'¶: A constant which can be used with the trace_type property of a Trace. This constant has a value of “EXECUTION_TRACE”

TRACE_TYPE_GENERATION_TRACE = 'GENERATION_TRACE'¶: A constant which can be used with the trace_type property of a Trace. This constant has a value of “GENERATION_TRACE”

TRACE_TYPE_PLANNING_TRACE = 'PLANNING_TRACE'¶: A constant which can be used with the trace_type property of a Trace. This constant has a value of “PLANNING_TRACE”

TRACE_TYPE_RETRIEVAL_TRACE = 'RETRIEVAL_TRACE'¶: A constant which can be used with the trace_type property of a Trace. This constant has a value of “RETRIEVAL_TRACE”

TRACE_TYPE_TOOL_INVOCATION_TRACE = 'TOOL_INVOCATION_TRACE'¶: A constant which can be used with the trace_type property of a Trace. This constant has a value of “TOOL_INVOCATION_TRACE”

__init__(**kwargs)¶

Initializes a new Trace object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key (str) – The value to assign to the key property of this Trace.
parent_key (str) – The value to assign to the parent_key property of this Trace.
source (oci.generative_ai_agent_runtime.models.SourceDetails) – The value to assign to the source property of this Trace.
time_created (datetime) – The value to assign to the time_created property of this Trace.
time_finished (datetime) – The value to assign to the time_finished property of this Trace.
trace_type (str) – The value to assign to the trace_type property of this Trace. Allowed values for this property are: “ERROR_TRACE”, “RETRIEVAL_TRACE”, “GENERATION_TRACE”, “TOOL_INVOCATION_TRACE”, “PLANNING_TRACE”, “EXECUTION_TRACE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

key¶

Gets the key of this Trace. Unique identifier for the event (UUID).

Returns:	The key of this Trace.
Return type:	str

parent_key¶

Gets the parent_key of this Trace. Identifier of the parent event, if applicable (UUID).

Returns:	The parent_key of this Trace.
Return type:	str

source¶

Gets the source of this Trace.

Returns:	The source of this Trace.
Return type:	oci.generative_ai_agent_runtime.models.SourceDetails

time_created¶

Gets the time_created of this Trace. The date and time that the trace was created in the format of an RFC3339 datetime string.

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

time_finished¶

Gets the time_finished of this Trace. Timestamp for when the event ended (In RFC 3339).

Returns:	The time_finished of this Trace.
Return type:	datetime

trace_type¶

[Required] Gets the trace_type of this Trace. The type of the trace.

Allowed values for this property are: “ERROR_TRACE”, “RETRIEVAL_TRACE”, “GENERATION_TRACE”, “TOOL_INVOCATION_TRACE”, “PLANNING_TRACE”, “EXECUTION_TRACE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The trace_type of this Trace.
Return type:	str