GenerationTrace¶

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

Bases: oci.generative_ai_agent_runtime.models.trace.Trace

The trace information about the generated response.

Attributes

`TRACE_TYPE_ERROR_TRACE`	str(object=’’) -> str
`TRACE_TYPE_GENERATION_TRACE`	str(object=’’) -> str
`TRACE_TYPE_RETRIEVAL_TRACE`	str(object=’’) -> str
`generation`	Gets the generation of this GenerationTrace.
`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 GenerationTrace 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 GenerationTrace object with values from keyword arguments. The default value of the trace_type attribute of this class is GENERATION_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 GenerationTrace.
trace_type (str) – The value to assign to the trace_type property of this GenerationTrace. Allowed values for this property are: “ERROR_TRACE”, “RETRIEVAL_TRACE”, “GENERATION_TRACE”
generation (str) – The value to assign to the generation property of this GenerationTrace.

generation¶

Gets the generation of this GenerationTrace. The generated response that’s returned to the user.

Returns:	The generation of this GenerationTrace.
Return type:	str

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.

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