Interface Observation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Observation.Builder,
,Observation> SdkBuilder<Observation.Builder,
,Observation> SdkPojo
- Enclosing class:
Observation
-
Method Summary
Modifier and TypeMethodDescriptiondefault Observation.Builder
actionGroupInvocationOutput
(Consumer<ActionGroupInvocationOutput.Builder> actionGroupInvocationOutput) Contains the JSON-formatted string returned by the API invoked by the action group.actionGroupInvocationOutput
(ActionGroupInvocationOutput actionGroupInvocationOutput) Contains the JSON-formatted string returned by the API invoked by the action group.default Observation.Builder
finalResponse
(Consumer<FinalResponse.Builder> finalResponse) Contains details about the response to the user.finalResponse
(FinalResponse finalResponse) Contains details about the response to the user.default Observation.Builder
knowledgeBaseLookupOutput
(Consumer<KnowledgeBaseLookupOutput.Builder> knowledgeBaseLookupOutput) Contains details about the results from looking up the knowledge base.knowledgeBaseLookupOutput
(KnowledgeBaseLookupOutput knowledgeBaseLookupOutput) Contains details about the results from looking up the knowledge base.default Observation.Builder
repromptResponse
(Consumer<RepromptResponse.Builder> repromptResponse) Contains details about the response to reprompt the input.repromptResponse
(RepromptResponse repromptResponse) Contains details about the response to reprompt the input.The unique identifier of the trace.Specifies what kind of information the agent returns in the observation.Specifies what kind of information the agent returns in the observation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
actionGroupInvocationOutput
Observation.Builder actionGroupInvocationOutput(ActionGroupInvocationOutput actionGroupInvocationOutput) Contains the JSON-formatted string returned by the API invoked by the action group.
- Parameters:
actionGroupInvocationOutput
- Contains the JSON-formatted string returned by the API invoked by the action group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionGroupInvocationOutput
default Observation.Builder actionGroupInvocationOutput(Consumer<ActionGroupInvocationOutput.Builder> actionGroupInvocationOutput) Contains the JSON-formatted string returned by the API invoked by the action group.
This is a convenience method that creates an instance of theActionGroupInvocationOutput.Builder
avoiding the need to create one manually viaActionGroupInvocationOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toactionGroupInvocationOutput(ActionGroupInvocationOutput)
.- Parameters:
actionGroupInvocationOutput
- a consumer that will call methods onActionGroupInvocationOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
finalResponse
Contains details about the response to the user.
- Parameters:
finalResponse
- Contains details about the response to the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
finalResponse
Contains details about the response to the user.
This is a convenience method that creates an instance of theFinalResponse.Builder
avoiding the need to create one manually viaFinalResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofinalResponse(FinalResponse)
.- Parameters:
finalResponse
- a consumer that will call methods onFinalResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
knowledgeBaseLookupOutput
Contains details about the results from looking up the knowledge base.
- Parameters:
knowledgeBaseLookupOutput
- Contains details about the results from looking up the knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBaseLookupOutput
default Observation.Builder knowledgeBaseLookupOutput(Consumer<KnowledgeBaseLookupOutput.Builder> knowledgeBaseLookupOutput) Contains details about the results from looking up the knowledge base.
This is a convenience method that creates an instance of theKnowledgeBaseLookupOutput.Builder
avoiding the need to create one manually viaKnowledgeBaseLookupOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toknowledgeBaseLookupOutput(KnowledgeBaseLookupOutput)
.- Parameters:
knowledgeBaseLookupOutput
- a consumer that will call methods onKnowledgeBaseLookupOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
repromptResponse
Contains details about the response to reprompt the input.
- Parameters:
repromptResponse
- Contains details about the response to reprompt the input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repromptResponse
Contains details about the response to reprompt the input.
This is a convenience method that creates an instance of theRepromptResponse.Builder
avoiding the need to create one manually viaRepromptResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torepromptResponse(RepromptResponse)
.- Parameters:
repromptResponse
- a consumer that will call methods onRepromptResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
traceId
The unique identifier of the trace.
- Parameters:
traceId
- The unique identifier of the trace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
Specifies what kind of information the agent returns in the observation. The following values are possible.
-
ACTION_GROUP
– The agent returns the result of an action group. -
KNOWLEDGE_BASE
– The agent returns information from a knowledge base. -
FINISH
– The agent returns a final response to the user with no follow-up. -
ASK_USER
– The agent asks the user a question. -
REPROMPT
– The agent prompts the user again for the same information.
- Parameters:
type
- Specifies what kind of information the agent returns in the observation. The following values are possible.-
ACTION_GROUP
– The agent returns the result of an action group. -
KNOWLEDGE_BASE
– The agent returns information from a knowledge base. -
FINISH
– The agent returns a final response to the user with no follow-up. -
ASK_USER
– The agent asks the user a question. -
REPROMPT
– The agent prompts the user again for the same information.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
type
Specifies what kind of information the agent returns in the observation. The following values are possible.
-
ACTION_GROUP
– The agent returns the result of an action group. -
KNOWLEDGE_BASE
– The agent returns information from a knowledge base. -
FINISH
– The agent returns a final response to the user with no follow-up. -
ASK_USER
– The agent asks the user a question. -
REPROMPT
– The agent prompts the user again for the same information.
- Parameters:
type
- Specifies what kind of information the agent returns in the observation. The following values are possible.-
ACTION_GROUP
– The agent returns the result of an action group. -
KNOWLEDGE_BASE
– The agent returns information from a knowledge base. -
FINISH
– The agent returns a final response to the user with no follow-up. -
ASK_USER
– The agent asks the user a question. -
REPROMPT
– The agent prompts the user again for the same information.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-