Class OrchestrationTrace
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionstatic OrchestrationTrace.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static OrchestrationTrace
fromInvocationInput
(Consumer<InvocationInput.Builder> invocationInput) Create an instance of this class withinvocationInput()
initialized to the given value.static OrchestrationTrace
fromInvocationInput
(InvocationInput invocationInput) Create an instance of this class withinvocationInput()
initialized to the given value.static OrchestrationTrace
fromModelInvocationInput
(Consumer<ModelInvocationInput.Builder> modelInvocationInput) Create an instance of this class withmodelInvocationInput()
initialized to the given value.static OrchestrationTrace
fromModelInvocationInput
(ModelInvocationInput modelInvocationInput) Create an instance of this class withmodelInvocationInput()
initialized to the given value.static OrchestrationTrace
fromObservation
(Consumer<Observation.Builder> observation) Create an instance of this class withobservation()
initialized to the given value.static OrchestrationTrace
fromObservation
(Observation observation) Create an instance of this class withobservation()
initialized to the given value.static OrchestrationTrace
fromRationale
(Consumer<Rationale.Builder> rationale) Create an instance of this class withrationale()
initialized to the given value.static OrchestrationTrace
fromRationale
(Rationale rationale) Create an instance of this class withrationale()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final InvocationInput
Contains information pertaining to the action group or knowledge base that is being invoked.final ModelInvocationInput
The input for the orchestration step.final Observation
Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.final 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.static Class
<? extends OrchestrationTrace.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The input for the orchestration step.
-
The
type
isORCHESTRATION
. -
The
text
contains the prompt. -
The
inferenceConfiguration
,parserMode
, andoverrideLambda
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
isORCHESTRATION
. -
The
text
contains the prompt. -
The
inferenceConfiguration
,parserMode
, andoverrideLambda
values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
-
-
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<OrchestrationTrace.Builder,
OrchestrationTrace> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromInvocationInput
Create an instance of this class withinvocationInput()
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 withinvocationInput()
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 withmodelInvocationInput()
initialized to the given value.The input for the orchestration step.
-
The
type
isORCHESTRATION
. -
The
text
contains the prompt. -
The
inferenceConfiguration
,parserMode
, andoverrideLambda
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
isORCHESTRATION
. -
The
text
contains the prompt. -
The
inferenceConfiguration
,parserMode
, andoverrideLambda
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 withmodelInvocationInput()
initialized to the given value.The input for the orchestration step.
-
The
type
isORCHESTRATION
. -
The
text
contains the prompt. -
The
inferenceConfiguration
,parserMode
, andoverrideLambda
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
isORCHESTRATION
. -
The
text
contains the prompt. -
The
inferenceConfiguration
,parserMode
, andoverrideLambda
values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
-
-
-
fromObservation
Create an instance of this class withobservation()
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
Create an instance of this class withobservation()
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
Create an instance of this class withrationale()
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
Create an instance of this class withrationale()
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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beOrchestrationTrace.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 beOrchestrationTrace.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-