Package com.google.genkit.ai

Class RetrieverRequest

java.lang.Object

com.google.genkit.ai.RetrieverRequest

public class RetrieverRequest
extends Object

RetrieverRequest contains a query for document retrieval.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RetrieverRequest.RetrieverOptions	RetrieverOptions contains options for retrieval.

Constructor Summary

Constructors

Constructor	Description
RetrieverRequest()	Default constructor.
RetrieverRequest(Document query)	Creates a RetrieverRequest with a query.

Method Summary

Modifier and Type	Method	Description
static RetrieverRequest	fromText(String queryText)	Creates a RetrieverRequest with a text query.
RetrieverRequest.RetrieverOptions	getOptions()
Document	getQuery()
void	setOptions(RetrieverRequest.RetrieverOptions options)
void	setQuery(Document query)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RetrieverRequest

public RetrieverRequest()

Default constructor.

RetrieverRequest

public RetrieverRequest(Document query)

Creates a RetrieverRequest with a query.

Parameters:

query - the query document

Method Details

fromText

public static RetrieverRequest fromText(String queryText)

Creates a RetrieverRequest with a text query.

Parameters:

queryText - the query text

Returns:

a RetrieverRequest

getQuery

public Document getQuery()

setQuery

public void setQuery(Document query)

getOptions

public RetrieverRequest.RetrieverOptions getOptions()

setOptions

public void setOptions(RetrieverRequest.RetrieverOptions options)