Interface Observation.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Observation.Builder,Observation>, SdkBuilder<Observation.Builder,Observation>, SdkPojo

Enclosing class:

Observation

@Mutable
@NotThreadSafe
public static interface Observation.Builder
extends SdkPojo, CopyableBuilder<Observation.Builder,Observation>

Method Summary

Modifier and Type	Method	Description
default Observation.Builder	actionGroupInvocationOutput(Consumer<ActionGroupInvocationOutput.Builder> actionGroupInvocationOutput)	Contains the JSON-formatted string returned by the API invoked by the action group.
Observation.Builder	actionGroupInvocationOutput(ActionGroupInvocationOutput actionGroupInvocationOutput)	Contains the JSON-formatted string returned by the API invoked by the action group.
default Observation.Builder	agentCollaboratorInvocationOutput(Consumer<AgentCollaboratorInvocationOutput.Builder> agentCollaboratorInvocationOutput)	A collaborator's invocation output.
Observation.Builder	agentCollaboratorInvocationOutput(AgentCollaboratorInvocationOutput agentCollaboratorInvocationOutput)	A collaborator's invocation output.
default Observation.Builder	codeInterpreterInvocationOutput(Consumer<CodeInterpreterInvocationOutput.Builder> codeInterpreterInvocationOutput)	Contains the JSON-formatted string returned by the API invoked by the code interpreter.
Observation.Builder	codeInterpreterInvocationOutput(CodeInterpreterInvocationOutput codeInterpreterInvocationOutput)	Contains the JSON-formatted string returned by the API invoked by the code interpreter.
default Observation.Builder	finalResponse(Consumer<FinalResponse.Builder> finalResponse)	Contains details about the response to the user.
Observation.Builder	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.
Observation.Builder	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.
Observation.Builder	repromptResponse(RepromptResponse repromptResponse)	Contains details about the response to reprompt the input.
Observation.Builder	traceId(String traceId)	The unique identifier of the trace.
Observation.Builder	type(String type)	Specifies what kind of information the agent returns in the observation.
Observation.Builder	type(Type type)	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, sdkFieldNameToField, sdkFields

Method Details

traceId

Observation.Builder traceId(String 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

Observation.Builder type(String 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
• Type

type

Observation.Builder type(Type 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
• Type

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 the ActionGroupInvocationOutput.Builder avoiding the need to create one manually via ActionGroupInvocationOutput.builder().

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

Parameters:

actionGroupInvocationOutput - a consumer that will call methods on ActionGroupInvocationOutput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• actionGroupInvocationOutput(ActionGroupInvocationOutput)

agentCollaboratorInvocationOutput

Observation.Builder agentCollaboratorInvocationOutput(AgentCollaboratorInvocationOutput agentCollaboratorInvocationOutput)

A collaborator's invocation output.

Parameters:

agentCollaboratorInvocationOutput - A collaborator's invocation output.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentCollaboratorInvocationOutput

default Observation.Builder agentCollaboratorInvocationOutput(Consumer<AgentCollaboratorInvocationOutput.Builder> agentCollaboratorInvocationOutput)

A collaborator's invocation output.

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

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

Parameters:

agentCollaboratorInvocationOutput - a consumer that will call methods on AgentCollaboratorInvocationOutput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• agentCollaboratorInvocationOutput(AgentCollaboratorInvocationOutput)

knowledgeBaseLookupOutput

Observation.Builder knowledgeBaseLookupOutput(KnowledgeBaseLookupOutput 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 the KnowledgeBaseLookupOutput.Builder avoiding the need to create one manually via KnowledgeBaseLookupOutput.builder().

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

Parameters:

knowledgeBaseLookupOutput - a consumer that will call methods on KnowledgeBaseLookupOutput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• knowledgeBaseLookupOutput(KnowledgeBaseLookupOutput)

finalResponse

Observation.Builder finalResponse(FinalResponse 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

default Observation.Builder finalResponse(Consumer<FinalResponse.Builder> finalResponse)

Contains details about the response to the user.

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

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

Parameters:

finalResponse - a consumer that will call methods on FinalResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• finalResponse(FinalResponse)

repromptResponse

Observation.Builder repromptResponse(RepromptResponse 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

default Observation.Builder repromptResponse(Consumer<RepromptResponse.Builder> repromptResponse)

Contains details about the response to reprompt the input.

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

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

Parameters:

repromptResponse - a consumer that will call methods on RepromptResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• repromptResponse(RepromptResponse)

codeInterpreterInvocationOutput

Observation.Builder codeInterpreterInvocationOutput(CodeInterpreterInvocationOutput codeInterpreterInvocationOutput)

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

Parameters:

codeInterpreterInvocationOutput - Contains the JSON-formatted string returned by the API invoked by the code interpreter.

Returns:

Returns a reference to this object so that method calls can be chained together.

codeInterpreterInvocationOutput

default Observation.Builder codeInterpreterInvocationOutput(Consumer<CodeInterpreterInvocationOutput.Builder> codeInterpreterInvocationOutput)

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

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

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

Parameters:

codeInterpreterInvocationOutput - a consumer that will call methods on CodeInterpreterInvocationOutput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• codeInterpreterInvocationOutput(CodeInterpreterInvocationOutput)