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_GENERATION_TRACE`	str(object=’’) -> str
`TRACE_TYPE_RETRIEVAL_TRACE`	str(object=’’) -> str
`citations`	Gets the citations of this RetrievalTrace.
`retrieval_input`	Gets the retrieval_input of this RetrievalTrace.
`time_created`	Gets the time_created of this Trace.
`trace_type`	[Required] Gets the trace_type of this Trace.

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_GENERATION_TRACE = 'GENERATION_TRACE'¶

TRACE_TYPE_RETRIEVAL_TRACE = 'RETRIEVAL_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:

time_created (datetime) – The value to assign to the time_created 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”
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.

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.

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

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

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”, ‘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