Package software.amazon.awssdk.services.bedrockagentruntime.model

Class OrchestrationTrace

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.OrchestrationTrace

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrchestrationTrace.Builder,OrchestrationTrace>

@Generated("software.amazon.awssdk:codegen")
public final class OrchestrationTrace
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OrchestrationTrace.Builder,OrchestrationTrace>

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OrchestrationTrace.Builder
static class	OrchestrationTrace.Type

Method Summary

Modifier and Type	Method	Description
static OrchestrationTrace.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static OrchestrationTrace	fromInvocationInput(Consumer<InvocationInput.Builder> invocationInput)	Create an instance of this class with invocationInput() initialized to the given value.
static OrchestrationTrace	fromInvocationInput(InvocationInput invocationInput)	Create an instance of this class with invocationInput() initialized to the given value.
static OrchestrationTrace	fromModelInvocationInput(Consumer<ModelInvocationInput.Builder> modelInvocationInput)	Create an instance of this class with modelInvocationInput() initialized to the given value.
static OrchestrationTrace	fromModelInvocationInput(ModelInvocationInput modelInvocationInput)	Create an instance of this class with modelInvocationInput() initialized to the given value.
static OrchestrationTrace	fromModelInvocationOutput(Consumer<OrchestrationModelInvocationOutput.Builder> modelInvocationOutput)	Create an instance of this class with modelInvocationOutput() initialized to the given value.
static OrchestrationTrace	fromModelInvocationOutput(OrchestrationModelInvocationOutput modelInvocationOutput)	Create an instance of this class with modelInvocationOutput() initialized to the given value.
static OrchestrationTrace	fromObservation(Consumer<Observation.Builder> observation)	Create an instance of this class with observation() initialized to the given value.
static OrchestrationTrace	fromObservation(Observation observation)	Create an instance of this class with observation() initialized to the given value.
static OrchestrationTrace	fromRationale(Consumer<Rationale.Builder> rationale)	Create an instance of this class with rationale() initialized to the given value.
static OrchestrationTrace	fromRationale(Rationale rationale)	Create an instance of this class with rationale() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InvocationInput	invocationInput()	Contains information pertaining to the action group or knowledge base that is being invoked.
ModelInvocationInput	modelInvocationInput()	The input for the orchestration step.
OrchestrationModelInvocationOutput	modelInvocationOutput()	Contains information pertaining to the output from the foundation model that is being invoked.
Observation	observation()	Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
Rationale	rationale()	Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OrchestrationTrace.Builder>	serializableBuilderClass()
OrchestrationTrace.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
OrchestrationTrace.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

invocationInput

public final InvocationInput invocationInput()

Contains information pertaining to the action group or knowledge base that is being invoked.

Returns:

Contains information pertaining to the action group or knowledge base that is being invoked.

modelInvocationInput

public final ModelInvocationInput modelInvocationInput()

The input for the orchestration step.

• The type is ORCHESTRATION.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

Returns:

The input for the orchestration step.

• The type is ORCHESTRATION.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

modelInvocationOutput

public final OrchestrationModelInvocationOutput modelInvocationOutput()

Contains information pertaining to the output from the foundation model that is being invoked.

Returns:

Contains information pertaining to the output from the foundation model that is being invoked.

observation

public final Observation observation()

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

Returns:

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

rationale

public final Rationale rationale()

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

Returns:

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

toBuilder

public OrchestrationTrace.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OrchestrationTrace.Builder,OrchestrationTrace>

builder

public static OrchestrationTrace.Builder builder()

serializableBuilderClass

public static Class<? extends OrchestrationTrace.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

fromInvocationInput

public static OrchestrationTrace fromInvocationInput(InvocationInput invocationInput)

Create an instance of this class with invocationInput() initialized to the given value.

Contains information pertaining to the action group or knowledge base that is being invoked.

Parameters:

invocationInput - Contains information pertaining to the action group or knowledge base that is being invoked.

fromInvocationInput

public static OrchestrationTrace fromInvocationInput(Consumer<InvocationInput.Builder> invocationInput)

Create an instance of this class with invocationInput() initialized to the given value.

Contains information pertaining to the action group or knowledge base that is being invoked.

Parameters:

invocationInput - Contains information pertaining to the action group or knowledge base that is being invoked.

fromModelInvocationInput

public static OrchestrationTrace fromModelInvocationInput(ModelInvocationInput modelInvocationInput)

Create an instance of this class with modelInvocationInput() initialized to the given value.

The input for the orchestration step.

• The type is ORCHESTRATION.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

Parameters:

modelInvocationInput - The input for the orchestration step.

• The type is ORCHESTRATION.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

fromModelInvocationInput

public static OrchestrationTrace fromModelInvocationInput(Consumer<ModelInvocationInput.Builder> modelInvocationInput)

Create an instance of this class with modelInvocationInput() initialized to the given value.

The input for the orchestration step.

• The type is ORCHESTRATION.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

Parameters:

modelInvocationInput - The input for the orchestration step.

• The type is ORCHESTRATION.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

fromModelInvocationOutput

public static OrchestrationTrace fromModelInvocationOutput(OrchestrationModelInvocationOutput modelInvocationOutput)

Create an instance of this class with modelInvocationOutput() initialized to the given value.

Contains information pertaining to the output from the foundation model that is being invoked.

Parameters:

modelInvocationOutput - Contains information pertaining to the output from the foundation model that is being invoked.

fromModelInvocationOutput

public static OrchestrationTrace fromModelInvocationOutput(Consumer<OrchestrationModelInvocationOutput.Builder> modelInvocationOutput)

Create an instance of this class with modelInvocationOutput() initialized to the given value.

Contains information pertaining to the output from the foundation model that is being invoked.

Parameters:

modelInvocationOutput - Contains information pertaining to the output from the foundation model that is being invoked.

fromObservation

public static OrchestrationTrace fromObservation(Observation observation)

Create an instance of this class with observation() initialized to the given value.

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

Parameters:

observation - Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

fromObservation

public static OrchestrationTrace fromObservation(Consumer<Observation.Builder> observation)

Create an instance of this class with observation() initialized to the given value.

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

Parameters:

observation - Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

fromRationale

public static OrchestrationTrace fromRationale(Rationale rationale)

Create an instance of this class with rationale() initialized to the given value.

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

Parameters:

rationale - Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

fromRationale

public static OrchestrationTrace fromRationale(Consumer<Rationale.Builder> rationale)

Create an instance of this class with rationale() initialized to the given value.

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

Parameters:

rationale - Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

type

public OrchestrationTrace.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be OrchestrationTrace.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be OrchestrationTrace.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo