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

Class Observation

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.Observation

All Implemented Interfaces:

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

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

Contains the result or output of an action group or knowledge base, or the response to the user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Observation.Builder

Method Summary

Modifier and Type	Method	Description
ActionGroupInvocationOutput	actionGroupInvocationOutput()	Contains the JSON-formatted string returned by the API invoked by the action group.
AgentCollaboratorInvocationOutput	agentCollaboratorInvocationOutput()	A collaborator's invocation output.
static Observation.Builder	builder()
CodeInterpreterInvocationOutput	codeInterpreterInvocationOutput()	Contains the JSON-formatted string returned by the API invoked by the code interpreter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FinalResponse	finalResponse()	Contains details about the response to the user.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KnowledgeBaseLookupOutput	knowledgeBaseLookupOutput()	Contains details about the results from looking up the knowledge base.
RepromptResponse	repromptResponse()	Contains details about the response to reprompt the input.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Observation.Builder>	serializableBuilderClass()
Observation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	traceId()	The unique identifier of the trace.
Type	type()	Specifies what kind of information the agent returns in the observation.
String	typeAsString()	Specifies what kind of information the agent returns in the observation.

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

actionGroupInvocationOutput

public final ActionGroupInvocationOutput actionGroupInvocationOutput()

Contains the JSON-formatted string returned by the API invoked by the action group.

Returns:

Contains the JSON-formatted string returned by the API invoked by the action group.

agentCollaboratorInvocationOutput

public final AgentCollaboratorInvocationOutput agentCollaboratorInvocationOutput()

A collaborator's invocation output.

Returns:

A collaborator's invocation output.

codeInterpreterInvocationOutput

public final CodeInterpreterInvocationOutput codeInterpreterInvocationOutput()

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

Returns:

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

finalResponse

public final FinalResponse finalResponse()

Contains details about the response to the user.

Returns:

Contains details about the response to the user.

knowledgeBaseLookupOutput

public final KnowledgeBaseLookupOutput knowledgeBaseLookupOutput()

Contains details about the results from looking up the knowledge base.

Returns:

Contains details about the results from looking up the knowledge base.

repromptResponse

public final RepromptResponse repromptResponse()

Contains details about the response to reprompt the input.

Returns:

Contains details about the response to reprompt the input.

traceId

public final String traceId()

The unique identifier of the trace.

Returns:

The unique identifier of the trace.

type

public final 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.

If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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.

See Also:

Type

typeAsString

public final String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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.

See Also:

Type

toBuilder

public Observation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Observation.Builder,Observation>

builder

public static Observation.Builder builder()

serializableBuilderClass

public static Class<? extends Observation.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)

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