PlanningTrace¶

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

Bases: oci.generative_ai_agent_runtime.models.trace.Trace

Contains trace information related to planning at the platform.

Attributes

`TRACE_TYPE_ERROR_TRACE`	str(object=’’) -> str
`TRACE_TYPE_EXECUTION_TRACE`	str(object=’’) -> str
`TRACE_TYPE_GENERATION_TRACE`	str(object=’’) -> str
`TRACE_TYPE_PLANNING_TRACE`	str(object=’’) -> str
`TRACE_TYPE_RETRIEVAL_TRACE`	str(object=’’) -> str
`TRACE_TYPE_TOOL_INVOCATION_TRACE`	str(object=’’) -> str
`input`	Gets the input of this PlanningTrace.
`key`	Gets the key of this Trace.
`output`	Gets the output of this PlanningTrace.
`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.
`usage`	Gets the usage of this PlanningTrace.

Methods

`__init__`(**kwargs)	Initializes a new PlanningTrace 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'¶

TRACE_TYPE_EXECUTION_TRACE = 'EXECUTION_TRACE'¶

TRACE_TYPE_GENERATION_TRACE = 'GENERATION_TRACE'¶

TRACE_TYPE_PLANNING_TRACE = 'PLANNING_TRACE'¶

TRACE_TYPE_RETRIEVAL_TRACE = 'RETRIEVAL_TRACE'¶

TRACE_TYPE_TOOL_INVOCATION_TRACE = 'TOOL_INVOCATION_TRACE'¶

__init__(**kwargs)¶

Initializes a new PlanningTrace object with values from keyword arguments. The default value of the trace_type attribute of this class is PLANNING_TRACE and it should not be changed. 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 PlanningTrace.
parent_key (str) – The value to assign to the parent_key property of this PlanningTrace.
source (oci.generative_ai_agent_runtime.models.SourceDetails) – The value to assign to the source property of this PlanningTrace.
time_created (datetime) – The value to assign to the time_created property of this PlanningTrace.
time_finished (datetime) – The value to assign to the time_finished property of this PlanningTrace.
trace_type (str) – The value to assign to the trace_type property of this PlanningTrace. Allowed values for this property are: “ERROR_TRACE”, “RETRIEVAL_TRACE”, “GENERATION_TRACE”, “TOOL_INVOCATION_TRACE”, “PLANNING_TRACE”, “EXECUTION_TRACE”
input (str) – The value to assign to the input property of this PlanningTrace.
output (str) – The value to assign to the output property of this PlanningTrace.
usage (list[oci.generative_ai_agent_runtime.models.Usage]) – The value to assign to the usage property of this PlanningTrace.

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.

input¶

Gets the input of this PlanningTrace. Input prompt to planning LLM.

Returns:	The input of this PlanningTrace.
Return type:	str

key¶

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

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

output¶

Gets the output of this PlanningTrace. Output string from planning LLM.

Returns:	The output of this PlanningTrace.
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

usage¶

Gets the usage of this PlanningTrace. Details of model and its usage.

Returns:	The usage of this PlanningTrace.
Return type:	list[oci.generative_ai_agent_runtime.models.Usage]