Class: Aws::BedrockAgentRuntime::Types::TracePart

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::TracePart

Defined in:

gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:collaborator_name, :trace]

Instance Attribute Summary

• #agent_alias_id ⇒ String

  The unique identifier of the alias of the agent.

• #agent_id ⇒ String

  The unique identifier of the agent.

• #agent_version ⇒ String

  The version of the agent.

• #caller_chain ⇒ Array<Types::Caller>

  The part's caller chain.

• #collaborator_name ⇒ String

  The part's collaborator name.

• #event_time ⇒ Time

  The time of the trace.

• #event_type ⇒ Object

  Returns the value of attribute event_type.

• #session_id ⇒ String

  The unique identifier of the session with the agent.

• #trace ⇒ Types::Trace

  Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases.

Instance Attribute Details

#agent_alias_id ⇒ String

The unique identifier of the alias of the agent.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#agent_id ⇒ String

The unique identifier of the agent.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#agent_version ⇒ String

The version of the agent.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#caller_chain ⇒ Array<Types::Caller>

The part's caller chain.

Returns:

• (Array<Types::Caller>)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#collaborator_name ⇒ String

The part's collaborator name.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#event_time ⇒ Time

The time of the trace.

Returns:

• (Time)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#event_type ⇒ Object

Returns the value of attribute event_type

Returns:

• (Object) —

  the current value of event_type

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

def event_type
  @event_type
end

#session_id ⇒ String

The unique identifier of the session with the agent.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end

#trace ⇒ Types::Trace

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

Returns:

• (Types::Trace)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 10430

class TracePart < Struct.new(
  :agent_alias_id,
  :agent_id,
  :agent_version,
  :caller_chain,
  :collaborator_name,
  :event_time,
  :session_id,
  :trace,
  :event_type)
  SENSITIVE = [:collaborator_name, :trace]
  include Aws::Structure
end