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

Class RetrievalCallStep

java.lang.Object

com.google.genai.gaos.models.interactions.RetrievalCallStep

All Implemented Interfaces:

Step

public class RetrievalCallStep
extends Object
implements Step

RetrievalCallStep

Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RetrievalCallStep.Builder

Constructor Summary

Constructors

Constructor	Description
RetrievalCallStep(RetrievalCallArguments arguments, String id)
RetrievalCallStep(RetrievalCallArguments arguments, String id, RetrievalCallStepRetrievalType retrievalType, String signature)

Method Summary

Modifier and Type	Method	Description
Optional<RetrievalCallArguments>	arguments()	The arguments to pass to Retrieval tools.
static RetrievalCallStep.Builder	builder()
boolean	equals(Object o)
int	hashCode()
Optional<String>	id()	Required.
Optional<RetrievalCallStepRetrievalType>	retrievalType()	The type of retrieval tools.
Optional<String>	signature()	A signature hash for backend validation.
String	toString()
String	type()
RetrievalCallStep	withArguments(RetrievalCallArguments arguments)	The arguments to pass to Retrieval tools.
RetrievalCallStep	withId(String id)	Required.
RetrievalCallStep	withRetrievalType(RetrievalCallStepRetrievalType retrievalType)	The type of retrieval tools.
RetrievalCallStep	withSignature(String signature)	A signature hash for backend validation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetrievalCallStep

public RetrievalCallStep(@Nonnull
 RetrievalCallArguments arguments,
 @Nonnull
 String id,
 @Nullable
 RetrievalCallStepRetrievalType retrievalType,
 @Nullable
 String signature)

RetrievalCallStep

public RetrievalCallStep(@Nonnull
 RetrievalCallArguments arguments,
 @Nonnull
 String id)

Method Details

arguments

public Optional<RetrievalCallArguments> arguments()

The arguments to pass to Retrieval tools.

id

public Optional<String> id()

Required. A unique ID for this specific tool call.

retrievalType

public Optional<RetrievalCallStepRetrievalType> retrievalType()

The type of retrieval tools.

signature

public Optional<String> signature()

A signature hash for backend validation.

type

public String type()

Specified by:

type in interface Step

builder

public static RetrievalCallStep.Builder builder()

withArguments

public RetrievalCallStep withArguments(@Nonnull
 RetrievalCallArguments arguments)

The arguments to pass to Retrieval tools.

withId

public RetrievalCallStep withId(@Nonnull
 String id)

Required. A unique ID for this specific tool call.

withRetrievalType

public RetrievalCallStep withRetrievalType(@Nullable
 RetrievalCallStepRetrievalType retrievalType)

The type of retrieval tools.

withSignature

public RetrievalCallStep 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