Class TracePart
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockagentruntime.model.TracePart
-
- All Implemented Interfaces:
Serializable,SdkPojo,ResponseStream,ToCopyableBuilder<TracePart.Builder,TracePart>
- Direct Known Subclasses:
DefaultTrace
@Generated("software.amazon.awssdk:codegen") public class TracePart extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TracePart.Builder,TracePart>, ResponseStream
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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceTracePart.Builderprotected static classTracePart.BuilderImpl-
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.ResponseStream
ResponseStream.EventType
-
-
Field Summary
-
Fields inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.ResponseStream
UNKNOWN
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedTracePart(TracePart.BuilderImpl builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(InvokeAgentResponseHandler.Visitor visitor)Calls the appropriate visit method depending on the subtype ofTracePart.StringagentAliasId()The unique identifier of the alias of the agent.StringagentId()The unique identifier of the agent.StringagentVersion()The version of the agent.static TracePart.Builderbuilder()List<Caller>callerChain()The part's caller chain.StringcollaboratorName()The part's collaborator name.TracePartcopy(Consumer<? super TracePart.Builder> modifier)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstanteventTime()The time of the trace.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCallerChain()For responses, this returns true if the service returned a value for the CallerChain property.inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends TracePart.Builder>serializableBuilderClass()StringsessionId()The unique identifier of the session with the agent.TracePart.BuildertoBuilder()StringtoString()Returns a string representation of this object.Tracetrace()Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.ResponseStream
sdkEventType
-
-
-
-
Constructor Detail
-
TracePart
protected TracePart(TracePart.BuilderImpl builder)
-
-
Method Detail
-
agentAliasId
public final String agentAliasId()
The unique identifier of the alias of the agent.
- Returns:
- The unique identifier of the alias of the agent.
-
agentId
public final String agentId()
The unique identifier of the agent.
- Returns:
- The unique identifier of the agent.
-
agentVersion
public final String agentVersion()
The version of the agent.
- Returns:
- The version of the agent.
-
hasCallerChain
public final boolean hasCallerChain()
For responses, this returns true if the service returned a value for the CallerChain property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
callerChain
public final List<Caller> callerChain()
The part's caller chain.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCallerChain()method.- Returns:
- The part's caller chain.
-
collaboratorName
public final String collaboratorName()
The part's collaborator name.
- Returns:
- The part's collaborator name.
-
eventTime
public final Instant eventTime()
The time of the trace.
- Returns:
- The time of the trace.
-
sessionId
public final String sessionId()
The unique identifier of the session with the agent.
- Returns:
- The unique identifier of the session with the agent.
-
trace
public final Trace 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:
- 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.
-
toBuilder
public TracePart.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<TracePart.Builder,TracePart>
-
builder
public static TracePart.Builder builder()
-
serializableBuilderClass
public static Class<? extends TracePart.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
copy
public final TracePart copy(Consumer<? super TracePart.Builder> modifier)
- Specified by:
copyin interfaceToCopyableBuilder<TracePart.Builder,TracePart>
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
accept
public void accept(InvokeAgentResponseHandler.Visitor visitor)
Calls the appropriate visit method depending on the subtype ofTracePart.- Specified by:
acceptin interfaceResponseStream- Parameters:
visitor- Visitor to invoke.
-
-