ToolInvocationTrace¶

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

Bases: oci.generative_ai_agent_runtime.models.trace.Trace

Pre-General Availability: 2024-01-24 |*Important*| |- |The following legal notice applies to Oracle pre-GA releases. For copyright and other applicable notices, see `Oracle Legal Notices`__.

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
`invocation_details`	Gets the invocation_details of this ToolInvocationTrace.
`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.
`tool_id`	Gets the tool_id of this ToolInvocationTrace.
`tool_name`	Gets the tool_name of this ToolInvocationTrace.
`trace_type`	[Required] Gets the trace_type of this Trace.

Methods

`__init__`(**kwargs)	Initializes a new ToolInvocationTrace 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.

|*Pre-General Availability Draft Documentation Notice*| |- |This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation. This documentation is not a commitment by Oracle to deliver any material, code, functionality or services. This documentation, and Oracle Pre-GA programs and services are subject to change at any time without notice and, accordingly, should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality for Oracle’s Pre-GA programs and services remains at the sole discretion of Oracle. All release dates or other predictions of future events are subject to change. The future availability of any future Oracle program or service should not be relied on in entering into any license or service agreement with Oracle. GenerationTrace

The trace information about the tool selection from multiple tools.

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 ToolInvocationTrace object with values from keyword arguments. The default value of the trace_type attribute of this class is TOOL_INVOCATION_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 ToolInvocationTrace.
parent_key (str) – The value to assign to the parent_key property of this ToolInvocationTrace.
source (oci.generative_ai_agent_runtime.models.SourceDetails) – The value to assign to the source property of this ToolInvocationTrace.
time_created (datetime) – The value to assign to the time_created property of this ToolInvocationTrace.
time_finished (datetime) – The value to assign to the time_finished property of this ToolInvocationTrace.
trace_type (str) – The value to assign to the trace_type property of this ToolInvocationTrace. Allowed values for this property are: “ERROR_TRACE”, “RETRIEVAL_TRACE”, “GENERATION_TRACE”, “TOOL_INVOCATION_TRACE”, “PLANNING_TRACE”, “EXECUTION_TRACE”
tool_id (str) – The value to assign to the tool_id property of this ToolInvocationTrace.
tool_name (str) – The value to assign to the tool_name property of this ToolInvocationTrace.
invocation_details (str) – The value to assign to the invocation_details property of this ToolInvocationTrace.

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.

invocation_details¶

Gets the invocation_details of this ToolInvocationTrace. The invocation details related to the selected tool.

Returns:	The invocation_details of this ToolInvocationTrace.
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

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

tool_id¶

Gets the tool_id of this ToolInvocationTrace. The ID of the selected tool based on the user query.

Returns:	The tool_id of this ToolInvocationTrace.
Return type:	str

tool_name¶

Gets the tool_name of this ToolInvocationTrace. The display name of the selected tool.

Returns:	The tool_name of this ToolInvocationTrace.
Return type:	str

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