Package com.google.genai.gaos.models.interactions

Class RetrievalResultStep

java.lang.Object

com.google.genai.gaos.models.interactions.RetrievalResultStep

All Implemented Interfaces:

Step

public class RetrievalResultStep
extends Object
implements Step

RetrievalResultStep

Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RetrievalResultStep.Builder

Constructor Summary

Constructors

Constructor	Description
RetrievalResultStep(String callId)
RetrievalResultStep(String callId, Boolean isError, String signature)

Method Summary

Modifier and Type	Method	Description
static RetrievalResultStep.Builder	builder()
Optional<String>	callId()	Required.
boolean	equals(Object o)
int	hashCode()
Optional<Boolean>	isError()	Whether the retrieval resulted in an error.
Optional<String>	signature()	A signature hash for backend validation.
String	toString()
String	type()
RetrievalResultStep	withCallId(String callId)	Required.
RetrievalResultStep	withIsError(Boolean isError)	Whether the retrieval resulted in an error.
RetrievalResultStep	withSignature(String signature)	A signature hash for backend validation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetrievalResultStep

public RetrievalResultStep(@Nonnull
 String callId,
 @Nullable
 Boolean isError,
 @Nullable
 String signature)

RetrievalResultStep

public RetrievalResultStep(@Nonnull
 String callId)

Method Details

callId

public Optional<String> callId()

Required. ID to match the ID from the function call block.

isError

public Optional<Boolean> isError()

Whether the retrieval resulted in an error.

signature

public Optional<String> signature()

A signature hash for backend validation.

type

public String type()

Specified by:

type in interface Step

builder

public static RetrievalResultStep.Builder builder()

withCallId

public RetrievalResultStep withCallId(@Nonnull
 String callId)

Required. ID to match the ID from the function call block.

withIsError

public RetrievalResultStep withIsError(@Nullable
 Boolean isError)

Whether the retrieval resulted in an error.

withSignature

public RetrievalResultStep withSignature(@Nullable
 String signature)

A signature hash for backend validation.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object