Interface TracePart.Builder

    • Method Detail

      • agentAliasId

        TracePart.Builder agentAliasId​(String agentAliasId)

        The unique identifier of the alias of the agent.

        Parameters:
        agentAliasId - The unique identifier of the alias of the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • agentId

        TracePart.Builder agentId​(String agentId)

        The unique identifier of the agent.

        Parameters:
        agentId - The unique identifier of the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • agentVersion

        TracePart.Builder agentVersion​(String agentVersion)

        The version of the agent.

        Parameters:
        agentVersion - The version of the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • callerChain

        TracePart.Builder callerChain​(Collection<Caller> callerChain)

        The part's caller chain.

        Parameters:
        callerChain - The part's caller chain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • callerChain

        TracePart.Builder callerChain​(Caller... callerChain)

        The part's caller chain.

        Parameters:
        callerChain - The part's caller chain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • callerChain

        TracePart.Builder callerChain​(Consumer<Caller.Builder>... callerChain)

        The part's caller chain.

        This is a convenience method that creates an instance of the Caller.Builder avoiding the need to create one manually via Caller.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #callerChain(List).

        Parameters:
        callerChain - a consumer that will call methods on Caller.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #callerChain(java.util.Collection)
      • collaboratorName

        TracePart.Builder collaboratorName​(String collaboratorName)

        The part's collaborator name.

        Parameters:
        collaboratorName - The part's collaborator name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sessionId

        TracePart.Builder sessionId​(String sessionId)

        The unique identifier of the session with the agent.

        Parameters:
        sessionId - The unique identifier of the session with the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • trace

        TracePart.Builder trace​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • trace

        default TracePart.Builder trace​(Consumer<Trace.Builder> 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.

        This is a convenience method that creates an instance of the Trace.Builder avoiding the need to create one manually via Trace.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trace(Trace).

        Parameters:
        trace - a consumer that will call methods on Trace.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        trace(Trace)