RetrievalTrace¶

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

Bases: oci.generative_ai_agent_runtime.models.trace.Trace

The trace that displays the retrieval information.

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
`citations`	Gets the citations of this RetrievalTrace.
`key`	Gets the key of this Trace.
`parent_key`	Gets the parent_key of this Trace.
`retrieval_input`	Gets the retrieval_input of this RetrievalTrace.
`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 RetrievalTrace.

Methods

`__init__`(**kwargs)	Initializes a new RetrievalTrace 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 RetrievalTrace object with values from keyword arguments. The default value of the trace_type attribute of this class is RETRIEVAL_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 RetrievalTrace.
parent_key (str) – The value to assign to the parent_key property of this RetrievalTrace.
source (oci.generative_ai_agent_runtime.models.SourceDetails) – The value to assign to the source property of this RetrievalTrace.
time_created (datetime) – The value to assign to the time_created property of this RetrievalTrace.
time_finished (datetime) – The value to assign to the time_finished property of this RetrievalTrace.
trace_type (str) – The value to assign to the trace_type property of this RetrievalTrace. Allowed values for this property are: “ERROR_TRACE”, “RETRIEVAL_TRACE”, “GENERATION_TRACE”, “TOOL_INVOCATION_TRACE”, “PLANNING_TRACE”, “EXECUTION_TRACE”
retrieval_input (str) – The value to assign to the retrieval_input property of this RetrievalTrace.
citations (list[oci.generative_ai_agent_runtime.models.Citation]) – The value to assign to the citations property of this RetrievalTrace.
usage (list[oci.generative_ai_agent_runtime.models.Usage]) – The value to assign to the usage property of this RetrievalTrace.

citations¶

Gets the citations of this RetrievalTrace. A list of citations retrieved from data sources.

Returns:	The citations of this RetrievalTrace.
Return type:	list[oci.generative_ai_agent_runtime.models.Citation]

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

retrieval_input¶

Gets the retrieval_input of this RetrievalTrace. The agent’s search string for getting the displayed information.

Returns:	The retrieval_input of this RetrievalTrace.
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 RetrievalTrace. Details of model and its usage.

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