Uses of Class
com.google.genkit.ai.Document

Packages that use Document

Package	Description
com.google.genkit
com.google.genkit.ai
com.google.genkit.plugins.localvec

Uses of Document in com.google.genkit

Methods in com.google.genkit that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	Genkit.retrieve(String retrieverName, Document query)	Retrieves documents using a Document as the query.
List<Document>	Genkit.retrieve(String retrieverName, String query)	Retrieves documents using the specified retriever.
List<Document>	Genkit.retrieve(String retrieverName, String query, RetrieverRequest.RetrieverOptions options)	Retrieves documents using the specified retriever with options.

Methods in com.google.genkit with parameters of type Document

Modifier and Type	Method	Description
List<Document>	Genkit.retrieve(String retrieverName, Document query)	Retrieves documents using a Document as the query.

Method parameters in com.google.genkit with type arguments of type Document

Modifier and Type	Method	Description
EmbedResponse	Genkit.embed(String embedderName, List<Document> documents)	Generates a structured output from the model with a simple prompt.
void	Genkit.index(String indexerName, List<Document> documents)	Indexes documents using the specified indexer.

Uses of Document in com.google.genkit.ai

Methods in com.google.genkit.ai that return Document

Modifier and Type	Method	Description
static Document	Document.fromText(String text)	Creates a text Document.
static Document	Document.fromText(String text, Map<String,Object> metadata)	Creates a Document with text and metadata.
Document	RetrieverRequest.getQuery()
Document	Document.withMetadata(String key, Object value)	Adds metadata to this Document.

Methods in com.google.genkit.ai that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	ModelRequest.getContext()
List<Document>	GenerateAction.GenerateActionOptions.getDocs()
List<Document>	GenerateOptions.getDocs()	Gets the documents for context.
List<Document>	EmbedRequest.getDocuments()
List<Document>	IndexerRequest.getDocuments()	Gets the documents to index.
List<Document>	RetrieverResponse.getDocuments()

Methods in com.google.genkit.ai with parameters of type Document

Modifier and Type	Method	Description
void	RetrieverRequest.setQuery(Document query)

Method parameters in com.google.genkit.ai with type arguments of type Document

Modifier and Type	Method	Description
ModelRequest.Builder	ModelRequest.Builder.context(List<Document> context)
GenerateOptions.Builder<T>	GenerateOptions.Builder.docs(List<Document> docs)
void	ModelRequest.setContext(List<Document> context)
void	GenerateAction.GenerateActionOptions.setDocs(List<Document> docs)
void	EmbedRequest.setDocuments(List<Document> documents)
void	IndexerRequest.setDocuments(List<Document> documents)	Sets the documents to index.
void	RetrieverResponse.setDocuments(List<Document> documents)

Constructors in com.google.genkit.ai with parameters of type Document

Modifier	Constructor	Description
	RetrieverRequest(Document query)	Creates a RetrieverRequest with a query.

Constructor parameters in com.google.genkit.ai with type arguments of type Document

Modifier	Constructor	Description
	EmbedRequest(List<Document> documents)	Creates an EmbedRequest with documents.
	IndexerRequest(List<Document> documents)	Creates a request with documents.
	IndexerRequest(List<Document> documents, Object options)	Creates a request with documents and options.
	RetrieverResponse(List<Document> documents)	Creates a RetrieverResponse with documents.

Uses of Document in com.google.genkit.plugins.localvec

Methods in com.google.genkit.plugins.localvec that return Document

Modifier and Type	Method	Description
Document	DbValue.getDoc()	Gets the document.

Methods in com.google.genkit.plugins.localvec with parameters of type Document

Modifier and Type	Method	Description
void	DbValue.setDoc(Document doc)	Sets the document.

Method parameters in com.google.genkit.plugins.localvec with type arguments of type Document

Modifier and Type	Method	Description
void	LocalVecDocStore.index(ActionContext ctx, List<Document> documents)	Indexes documents with their embeddings.

Constructors in com.google.genkit.plugins.localvec with parameters of type Document

Modifier	Constructor	Description
	DbValue(Document doc, List<Float> embedding)	Creates a new DbValue.